diff --git a/.buildkite/ftr_configs.yml b/.buildkite/ftr_configs.yml index fcba384a9844d..4ce6ea8ec59d9 100644 --- a/.buildkite/ftr_configs.yml +++ b/.buildkite/ftr_configs.yml @@ -236,6 +236,7 @@ enabled: - x-pack/test/detection_engine_api_integration/security_and_spaces/prebuilt_rules/config.ts - x-pack/test/detection_engine_api_integration/security_and_spaces/bundled_prebuilt_rules_package/config.ts - x-pack/test/detection_engine_api_integration/security_and_spaces/large_prebuilt_rules_package/config.ts + - x-pack/test/detection_engine_api_integration/security_and_spaces/update_prebuilt_rules_package/config.ts - x-pack/test/encrypted_saved_objects_api_integration/config.ts - x-pack/test/examples/config.ts - x-pack/test/fleet_api_integration/config.agent.ts diff --git a/.buildkite/pipelines/on_merge.yml b/.buildkite/pipelines/on_merge.yml index 2ea182a76c615..521a0c76317a0 100644 --- a/.buildkite/pipelines/on_merge.yml +++ b/.buildkite/pipelines/on_merge.yml @@ -139,7 +139,7 @@ steps: - command: .buildkite/scripts/steps/storybooks/build_and_upload.sh label: 'Build Storybooks' agents: - queue: n2-4-spot + queue: n2-8-spot key: storybooks timeout_in_minutes: 60 retry: diff --git a/.buildkite/scripts/steps/artifacts/docker_image.sh b/.buildkite/scripts/steps/artifacts/docker_image.sh index 1968f095853ed..6c68f616c23c6 100755 --- a/.buildkite/scripts/steps/artifacts/docker_image.sh +++ b/.buildkite/scripts/steps/artifacts/docker_image.sh @@ -89,7 +89,7 @@ steps: trigger: gpctl-promote build: env: - SERVICE_COMMIT_HASH: $GIT_ABBREV_COMMIT + SERVICE_COMMIT_HASH: "$GIT_ABBREV_COMMIT" REMOTE_SERVICE_CONFIG: https://raw.githubusercontent.com/elastic/serverless-gitops/main/gen/gpctl/kibana/config.yaml EOF diff --git a/.buildkite/scripts/steps/storybooks/build_and_upload.ts b/.buildkite/scripts/steps/storybooks/build_and_upload.ts index 82640969a832a..ce4f2f8263520 100644 --- a/.buildkite/scripts/steps/storybooks/build_and_upload.ts +++ b/.buildkite/scripts/steps/storybooks/build_and_upload.ts @@ -44,7 +44,7 @@ const STORYBOOKS = [ 'lists', 'observability', 'presentation', - 'security_solution', + // 'security_solution', => This build is error out and failing CI. SEE: https://github.com/elastic/kibana/issues/162290 'security_solution_packages', 'serverless', 'shared_ux', diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index ddb6770c6a756..ecca6d3ad332b 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -330,6 +330,7 @@ examples/discover_customization_examples @elastic/kibana-data-discovery x-pack/plugins/discover_enhanced @elastic/kibana-data-discovery x-pack/plugins/discover_log_explorer @elastic/infra-monitoring-ui src/plugins/discover @elastic/kibana-data-discovery +packages/kbn-discover-utils @elastic/kibana-data-discovery packages/kbn-doc-links @elastic/docs packages/kbn-docs-utils @elastic/kibana-operations packages/kbn-dom-drag-drop @elastic/kibana-visualizations @elastic/kibana-data-discovery @@ -359,6 +360,8 @@ packages/kbn-eslint-plugin-eslint @elastic/kibana-operations packages/kbn-eslint-plugin-imports @elastic/kibana-operations packages/kbn-eslint-plugin-telemetry @elastic/actionable-observability x-pack/test/encrypted_saved_objects_api_integration/plugins/api_consumer_plugin @elastic/kibana-security +packages/kbn-event-annotation-common @elastic/kibana-visualizations +packages/kbn-event-annotation-components @elastic/kibana-visualizations src/plugins/event_annotation @elastic/kibana-visualizations x-pack/test/plugin_api_integration/plugins/event_log @elastic/response-ops x-pack/plugins/event_log @elastic/response-ops @@ -400,6 +403,7 @@ src/plugins/ftr_apis @elastic/kibana-core packages/kbn-ftr-common-functional-services @elastic/kibana-operations @elastic/appex-qa packages/kbn-ftr-screenshot-filename @elastic/kibana-operations @elastic/appex-qa x-pack/test/functional_with_es_ssl/plugins/cases @elastic/response-ops +x-pack/examples/gen_ai_streaming_response_example @elastic/response-ops packages/kbn-generate @elastic/kibana-operations packages/kbn-generate-console-definitions @elastic/platform-deployment-management packages/kbn-generate-csv @elastic/appex-sharedux @@ -482,6 +486,7 @@ x-pack/plugins/maps @elastic/kibana-gis x-pack/packages/maps/vector_tile_utils @elastic/kibana-gis x-pack/packages/ml/agg_utils @elastic/ml-ui x-pack/packages/ml/anomaly_utils @elastic/ml-ui +x-pack/packages/ml/category_validator @elastic/ml-ui x-pack/packages/ml/data_frame_analytics_utils @elastic/ml-ui x-pack/packages/ml/data_grid @elastic/ml-ui x-pack/packages/ml/date_picker @elastic/ml-ui @@ -759,7 +764,7 @@ src/plugins/vis_types/timeseries @elastic/kibana-visualizations src/plugins/vis_types/vega @elastic/kibana-visualizations src/plugins/vis_types/vislib @elastic/kibana-visualizations src/plugins/vis_types/xy @elastic/kibana-visualizations -src/plugins/visualization_ui_components @elastic/kibana-visualizations +packages/kbn-visualization-ui-components @elastic/kibana-visualizations src/plugins/visualizations @elastic/kibana-visualizations x-pack/plugins/watcher @elastic/platform-deployment-management packages/kbn-web-worker-stub @elastic/kibana-operations @@ -874,7 +879,6 @@ x-pack/plugins/infra/server/lib/alerting @elastic/actionable-observability /x-pack/test/alerting_api_integration/observability/synthetics_rule.ts @elastic/uptime /x-pack/test/alerting_api_integration/observability/index.ts @elastic/uptime - # Client Side Monitoring / Uptime (lives in APM directories but owned by Uptime) /x-pack/plugins/apm/public/application/uxApp.tsx @elastic/uptime /x-pack/plugins/apm/public/components/app/rum_dashboard @elastic/uptime @@ -884,6 +888,9 @@ x-pack/plugins/infra/server/lib/alerting @elastic/actionable-observability /x-pack/plugins/observability_shared/public/components/tour @elastic/platform-onboarding /x-pack/test/functional/apps/infra/tour.ts @elastic/platform-onboarding +# Observability settings +/x-pack/plugins/observability/server/ui_settings.ts @elastic/obs-docs + ### END Observability Plugins # Presentation @@ -895,7 +902,6 @@ x-pack/plugins/infra/server/lib/alerting @elastic/actionable-observability #CC# /src/plugins/kibana_react/public/code_editor/ @elastic/kibana-presentation # Machine Learning -/x-pack/plugins/ml/common/openapi/ @elastic/mlr-docs /x-pack/test/accessibility/apps/ml.ts @elastic/ml-ui /x-pack/test/accessibility/apps/ml_embeddables_in_dashboard.ts @elastic/ml-ui /x-pack/test/api_integration/apis/ml/ @elastic/ml-ui @@ -909,7 +915,6 @@ x-pack/plugins/infra/server/lib/alerting @elastic/actionable-observability /x-pack/test/alerting_api_integration/spaces_only/tests/alerting/transform_rule_types/ @elastic/ml-ui /x-pack/test/screenshot_creation/apps/ml_docs @elastic/ml-ui /x-pack/test/screenshot_creation/services/ml_screenshots.ts @elastic/ml-ui -/docs/api/machine-learning/ @elastic/mlr-docs # Additional plugins and packages maintained by the ML team. /x-pack/test/accessibility/apps/transform.ts @elastic/ml-ui @@ -1018,10 +1023,6 @@ x-pack/plugins/cloud_integrations/cloud_full_story/server/config.ts @elastic/kib /x-pack/test/functional/services/cases/ @elastic/response-ops /x-pack/test/functional_with_es_ssl/apps/cases/ @elastic/response-ops /x-pack/test/api_integration/apis/cases/ @elastic/response-ops -/docs/api/actions-and-connectors @elastic/mlr-docs -/docs/api/alerting @elastic/mlr-docs -/docs/api/cases @elastic/mlr-docs -/x-pack/plugins/cases/docs/openapi @elastic/mlr-docs # Enterprise Search /x-pack/test/functional_enterprise_search/ @elastic/enterprise-search-frontend @@ -1113,11 +1114,16 @@ x-pack/plugins/cloud_integrations/cloud_full_story/server/config.ts @elastic/kib /x-pack/plugins/stack_connectors/common/gen_ai @elastic/security-threat-hunting-explore ## Security Solution sub teams - Detection Rule Management +/x-pack/plugins/security_solution/common/api/detection_engine/fleet_integrations @elastic/security-detection-rule-management +/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules @elastic/security-detection-rule-management +/x-pack/plugins/security_solution/common/api/detection_engine/rule_management @elastic/security-detection-rule-management +/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring @elastic/security-detection-rule-management +/x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema @elastic/security-detection-rule-management @elastic/security-detection-engine + /x-pack/plugins/security_solution/common/detection_engine/fleet_integrations @elastic/security-detection-rule-management /x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules @elastic/security-detection-rule-management /x-pack/plugins/security_solution/common/detection_engine/rule_management @elastic/security-detection-rule-management /x-pack/plugins/security_solution/common/detection_engine/rule_monitoring @elastic/security-detection-rule-management -/x-pack/plugins/security_solution/common/detection_engine/rule_schema @elastic/security-detection-rule-management @elastic/security-detection-engine /x-pack/plugins/security_solution/docs/testing/test_plans/detection_response/prebuilt_rules @elastic/security-detection-rule-management /x-pack/plugins/security_solution/docs/testing/test_plans/detection_response/rule_management @elastic/security-detection-rule-management @@ -1152,7 +1158,7 @@ x-pack/plugins/cloud_integrations/cloud_full_story/server/config.ts @elastic/kib ## Security Solution sub teams - Detection Engine -/x-pack/plugins/security_solution/common/detection_engine/schemas/alerts @elastic/security-detection-engine +/x-pack/plugins/security_solution/common/api/detection_engine @elastic/security-detection-engine /x-pack/plugins/security_solution/common/field_maps @elastic/security-detection-engine /x-pack/plugins/security_solution/public/detection_engine/rule_creation_ui @elastic/security-detection-engine diff --git a/.gitignore b/.gitignore index 4999eb2fb5a17..86a789a1cfb5f 100644 --- a/.gitignore +++ b/.gitignore @@ -99,6 +99,12 @@ x-pack/plugins/fleet/cypress.config.d.ts x-pack/plugins/fleet/cypress.config.js x-pack/plugins/osquery/cypress.config.d.ts x-pack/plugins/osquery/cypress.config.js +x-pack/plugins/enterprise_search/cypress.config.d.ts +x-pack/plugins/enterprise_search/cypress.config.js +x-pack/plugins/security_solution/public/management/cypress.config.d.ts +x-pack/plugins/security_solution/public/management/cypress.config.js +x-pack/plugins/security_solution/public/management/cypress_endpoint.config.d.ts +x-pack/plugins/security_solution/public/management/cypress_endpoint.config.js # release notes script output report.csv diff --git a/.i18nrc.json b/.i18nrc.json index db0b984b8eb23..694397503bf97 100644 --- a/.i18nrc.json +++ b/.i18nrc.json @@ -22,6 +22,7 @@ "defaultNavigation": "packages/default-nav", "devTools": "src/plugins/dev_tools", "discover": "src/plugins/discover", + "discover-utils": "packages/kbn-discover-utils", "savedSearch": "src/plugins/saved_search", "embeddableApi": "src/plugins/embeddable", "embeddableExamples": "examples/embeddable_examples", @@ -43,6 +44,8 @@ "expressionShape": "src/plugins/expression_shape", "expressionTagcloud": "src/plugins/chart_expressions/expression_tagcloud", "eventAnnotation": "src/plugins/event_annotation", + "eventAnnotationCommon": "packages/kbn-event-annotation-common", + "eventAnnotationComponents": "packages/kbn-event-annotation-components", "fieldFormats": "src/plugins/field_formats", "files": "src/plugins/files", "filesManagement": "src/plugins/files_management", @@ -71,7 +74,11 @@ "kibanaOverview": "src/plugins/kibana_overview", "lists": "packages/kbn-securitysolution-list-utils/src", "exceptionList-components": "packages/kbn-securitysolution-exception-list-components/src", - "management": ["src/legacy/core_plugins/management", "src/plugins/management", "packages/kbn-management"], + "management": [ + "src/legacy/core_plugins/management", + "src/plugins/management", + "packages/kbn-management" + ], "monaco": "packages/kbn-monaco/src", "navigation": "src/plugins/navigation", "newsfeed": "src/plugins/newsfeed", @@ -112,7 +119,7 @@ "visTypeVislib": "src/plugins/vis_types/vislib", "visTypeXy": "src/plugins/vis_types/xy", "visualizations": "src/plugins/visualizations", - "visualizationUiComponents": "src/plugins/visualization_ui_components", + "visualizationUiComponents": "packages/kbn-visualization-ui-components", "unifiedSearch": "src/plugins/unified_search", "unifiedFieldList": "packages/kbn-unified-field-list", "unifiedHistogram": "src/plugins/unified_histogram" diff --git a/api_docs/actions.mdx b/api_docs/actions.mdx index 9f12661e7ff19..2048fec8ba7e0 100644 --- a/api_docs/actions.mdx +++ b/api_docs/actions.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/actions title: "actions" image: https://source.unsplash.com/400x175/?github description: API docs for the actions plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions'] --- import actionsObj from './actions.devdocs.json'; diff --git a/api_docs/advanced_settings.mdx b/api_docs/advanced_settings.mdx index f5278b36aef3c..43f1c5991d66f 100644 --- a/api_docs/advanced_settings.mdx +++ b/api_docs/advanced_settings.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/advancedSettings title: "advancedSettings" image: https://source.unsplash.com/400x175/?github description: API docs for the advancedSettings plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings'] --- import advancedSettingsObj from './advanced_settings.devdocs.json'; diff --git a/api_docs/aiops.devdocs.json b/api_docs/aiops.devdocs.json index 1dd5d9bd6345a..b6491d9149a17 100644 --- a/api_docs/aiops.devdocs.json +++ b/api_docs/aiops.devdocs.json @@ -58,12 +58,12 @@ }, { "parentPluginId": "aiops", - "id": "def-public.ExplainLogRateSpikes", + "id": "def-public.LogCategorization", "type": "Function", "tags": [], - "label": "ExplainLogRateSpikes", + "label": "LogCategorization", "description": [ - "\nLazy-wrapped ExplainLogRateSpikesAppState React component" + "\nLazy-wrapped LogCategorizationAppStateProps React component" ], "signature": [ "(props: React.PropsWithChildren<", @@ -71,8 +71,8 @@ "pluginId": "aiops", "scope": "public", "docId": "kibAiopsPluginApi", - "section": "def-public.ExplainLogRateSpikesAppStateProps", - "text": "ExplainLogRateSpikesAppStateProps" + "section": "def-public.LogCategorizationAppStateProps", + "text": "LogCategorizationAppStateProps" }, ">) => JSX.Element" ], @@ -82,7 +82,7 @@ "children": [ { "parentPluginId": "aiops", - "id": "def-public.ExplainLogRateSpikes.$1", + "id": "def-public.LogCategorization.$1", "type": "CompoundType", "tags": [], "label": "props", @@ -95,8 +95,8 @@ "pluginId": "aiops", "scope": "public", "docId": "kibAiopsPluginApi", - "section": "def-public.ExplainLogRateSpikesAppStateProps", - "text": "ExplainLogRateSpikesAppStateProps" + "section": "def-public.LogCategorizationAppStateProps", + "text": "LogCategorizationAppStateProps" }, ">" ], @@ -111,16 +111,22 @@ }, { "parentPluginId": "aiops", - "id": "def-public.ExplainLogRateSpikesContent", + "id": "def-public.LogRateAnalysis", "type": "Function", "tags": [], - "label": "ExplainLogRateSpikesContent", + "label": "LogRateAnalysis", "description": [ - "\nLazy-wrapped ExplainLogRateSpikesContentWrapperReact component" + "\nLazy-wrapped LogRateAnalysisAppState React component" ], "signature": [ "(props: React.PropsWithChildren<", - "ExplainLogRateSpikesContentWrapperProps", + { + "pluginId": "aiops", + "scope": "public", + "docId": "kibAiopsPluginApi", + "section": "def-public.LogRateAnalysisAppStateProps", + "text": "LogRateAnalysisAppStateProps" + }, ">) => JSX.Element" ], "path": "x-pack/plugins/aiops/public/shared_lazy_components.tsx", @@ -129,7 +135,7 @@ "children": [ { "parentPluginId": "aiops", - "id": "def-public.ExplainLogRateSpikesContent.$1", + "id": "def-public.LogRateAnalysis.$1", "type": "CompoundType", "tags": [], "label": "props", @@ -138,7 +144,13 @@ ], "signature": [ "React.PropsWithChildren<", - "ExplainLogRateSpikesContentWrapperProps", + { + "pluginId": "aiops", + "scope": "public", + "docId": "kibAiopsPluginApi", + "section": "def-public.LogRateAnalysisAppStateProps", + "text": "LogRateAnalysisAppStateProps" + }, ">" ], "path": "x-pack/plugins/aiops/public/shared_lazy_components.tsx", @@ -152,22 +164,16 @@ }, { "parentPluginId": "aiops", - "id": "def-public.LogCategorization", + "id": "def-public.LogRateAnalysisContent", "type": "Function", "tags": [], - "label": "LogCategorization", + "label": "LogRateAnalysisContent", "description": [ - "\nLazy-wrapped LogCategorizationAppStateProps React component" + "\nLazy-wrapped LogRateAnalysisContentWrapperReact component" ], "signature": [ "(props: React.PropsWithChildren<", - { - "pluginId": "aiops", - "scope": "public", - "docId": "kibAiopsPluginApi", - "section": "def-public.LogCategorizationAppStateProps", - "text": "LogCategorizationAppStateProps" - }, + "LogRateAnalysisContentWrapperProps", ">) => JSX.Element" ], "path": "x-pack/plugins/aiops/public/shared_lazy_components.tsx", @@ -176,7 +182,7 @@ "children": [ { "parentPluginId": "aiops", - "id": "def-public.LogCategorization.$1", + "id": "def-public.LogRateAnalysisContent.$1", "type": "CompoundType", "tags": [], "label": "props", @@ -185,13 +191,7 @@ ], "signature": [ "React.PropsWithChildren<", - { - "pluginId": "aiops", - "scope": "public", - "docId": "kibAiopsPluginApi", - "section": "def-public.LogCategorizationAppStateProps", - "text": "LogCategorizationAppStateProps" - }, + "LogRateAnalysisContentWrapperProps", ">" ], "path": "x-pack/plugins/aiops/public/shared_lazy_components.tsx", @@ -630,54 +630,73 @@ }, { "parentPluginId": "aiops", - "id": "def-public.ExplainLogRateSpikesAnalysisResults", + "id": "def-public.LogCategorizationAppStateProps", "type": "Interface", "tags": [], - "label": "ExplainLogRateSpikesAnalysisResults", + "label": "LogCategorizationAppStateProps", "description": [], - "path": "x-pack/plugins/aiops/public/components/explain_log_rate_spikes/explain_log_rate_spikes_analysis.tsx", + "path": "x-pack/plugins/aiops/public/components/log_categorization/log_categorization_app_state.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "aiops", - "id": "def-public.ExplainLogRateSpikesAnalysisResults.significantTerms", - "type": "Array", + "id": "def-public.LogCategorizationAppStateProps.dataView", + "type": "Object", "tags": [], - "label": "significantTerms", + "label": "dataView", "description": [], "signature": [ { - "pluginId": "@kbn/ml-agg-utils", + "pluginId": "dataViews", "scope": "common", - "docId": "kibKbnMlAggUtilsPluginApi", - "section": "def-common.SignificantTerm", - "text": "SignificantTerm" - }, - "[]" + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + } ], - "path": "x-pack/plugins/aiops/public/components/explain_log_rate_spikes/explain_log_rate_spikes_analysis.tsx", + "path": "x-pack/plugins/aiops/public/components/log_categorization/log_categorization_app_state.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "aiops", - "id": "def-public.ExplainLogRateSpikesAnalysisResults.significantTermsGroups", - "type": "Array", + "id": "def-public.LogCategorizationAppStateProps.savedSearch", + "type": "CompoundType", "tags": [], - "label": "significantTermsGroups", + "label": "savedSearch", "description": [], "signature": [ { - "pluginId": "@kbn/ml-agg-utils", - "scope": "common", - "docId": "kibKbnMlAggUtilsPluginApi", - "section": "def-common.SignificantTermGroup", - "text": "SignificantTermGroup" + "pluginId": "savedSearch", + "scope": "public", + "docId": "kibSavedSearchPluginApi", + "section": "def-public.SavedSearch", + "text": "SavedSearch" }, - "[]" + " | null" + ], + "path": "x-pack/plugins/aiops/public/components/log_categorization/log_categorization_app_state.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "aiops", + "id": "def-public.LogCategorizationAppStateProps.appDependencies", + "type": "Object", + "tags": [], + "label": "appDependencies", + "description": [], + "signature": [ + { + "pluginId": "aiops", + "scope": "public", + "docId": "kibAiopsPluginApi", + "section": "def-public.AiopsAppDependencies", + "text": "AiopsAppDependencies" + } ], - "path": "x-pack/plugins/aiops/public/components/explain_log_rate_spikes/explain_log_rate_spikes_analysis.tsx", + "path": "x-pack/plugins/aiops/public/components/log_categorization/log_categorization_app_state.tsx", "deprecated": false, "trackAdoption": false } @@ -686,18 +705,18 @@ }, { "parentPluginId": "aiops", - "id": "def-public.ExplainLogRateSpikesAppStateProps", + "id": "def-public.LogRateAnalysisAppStateProps", "type": "Interface", "tags": [], - "label": "ExplainLogRateSpikesAppStateProps", + "label": "LogRateAnalysisAppStateProps", "description": [], - "path": "x-pack/plugins/aiops/public/components/explain_log_rate_spikes/explain_log_rate_spikes_app_state.tsx", + "path": "x-pack/plugins/aiops/public/components/log_rate_analysis/log_rate_analysis_app_state.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "aiops", - "id": "def-public.ExplainLogRateSpikesAppStateProps.dataView", + "id": "def-public.LogRateAnalysisAppStateProps.dataView", "type": "Object", "tags": [], "label": "dataView", @@ -713,13 +732,13 @@ "text": "DataView" } ], - "path": "x-pack/plugins/aiops/public/components/explain_log_rate_spikes/explain_log_rate_spikes_app_state.tsx", + "path": "x-pack/plugins/aiops/public/components/log_rate_analysis/log_rate_analysis_app_state.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "aiops", - "id": "def-public.ExplainLogRateSpikesAppStateProps.savedSearch", + "id": "def-public.LogRateAnalysisAppStateProps.savedSearch", "type": "CompoundType", "tags": [], "label": "savedSearch", @@ -736,13 +755,13 @@ }, " | null" ], - "path": "x-pack/plugins/aiops/public/components/explain_log_rate_spikes/explain_log_rate_spikes_app_state.tsx", + "path": "x-pack/plugins/aiops/public/components/log_rate_analysis/log_rate_analysis_app_state.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "aiops", - "id": "def-public.ExplainLogRateSpikesAppStateProps.appDependencies", + "id": "def-public.LogRateAnalysisAppStateProps.appDependencies", "type": "Object", "tags": [], "label": "appDependencies", @@ -758,13 +777,13 @@ "text": "AiopsAppDependencies" } ], - "path": "x-pack/plugins/aiops/public/components/explain_log_rate_spikes/explain_log_rate_spikes_app_state.tsx", + "path": "x-pack/plugins/aiops/public/components/log_rate_analysis/log_rate_analysis_app_state.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "aiops", - "id": "def-public.ExplainLogRateSpikesAppStateProps.stickyHistogram", + "id": "def-public.LogRateAnalysisAppStateProps.stickyHistogram", "type": "CompoundType", "tags": [], "label": "stickyHistogram", @@ -774,7 +793,7 @@ "signature": [ "boolean | undefined" ], - "path": "x-pack/plugins/aiops/public/components/explain_log_rate_spikes/explain_log_rate_spikes_app_state.tsx", + "path": "x-pack/plugins/aiops/public/components/log_rate_analysis/log_rate_analysis_app_state.tsx", "deprecated": false, "trackAdoption": false } @@ -783,73 +802,54 @@ }, { "parentPluginId": "aiops", - "id": "def-public.LogCategorizationAppStateProps", + "id": "def-public.LogRateAnalysisResultsData", "type": "Interface", "tags": [], - "label": "LogCategorizationAppStateProps", + "label": "LogRateAnalysisResultsData", "description": [], - "path": "x-pack/plugins/aiops/public/components/log_categorization/log_categorization_app_state.tsx", + "path": "x-pack/plugins/aiops/public/components/log_rate_analysis/log_rate_analysis_results.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "aiops", - "id": "def-public.LogCategorizationAppStateProps.dataView", - "type": "Object", + "id": "def-public.LogRateAnalysisResultsData.significantTerms", + "type": "Array", "tags": [], - "label": "dataView", + "label": "significantTerms", "description": [], "signature": [ { - "pluginId": "dataViews", + "pluginId": "@kbn/ml-agg-utils", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - } - ], - "path": "x-pack/plugins/aiops/public/components/log_categorization/log_categorization_app_state.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "aiops", - "id": "def-public.LogCategorizationAppStateProps.savedSearch", - "type": "CompoundType", - "tags": [], - "label": "savedSearch", - "description": [], - "signature": [ - { - "pluginId": "savedSearch", - "scope": "public", - "docId": "kibSavedSearchPluginApi", - "section": "def-public.SavedSearch", - "text": "SavedSearch" + "docId": "kibKbnMlAggUtilsPluginApi", + "section": "def-common.SignificantTerm", + "text": "SignificantTerm" }, - " | null" + "[]" ], - "path": "x-pack/plugins/aiops/public/components/log_categorization/log_categorization_app_state.tsx", + "path": "x-pack/plugins/aiops/public/components/log_rate_analysis/log_rate_analysis_results.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "aiops", - "id": "def-public.LogCategorizationAppStateProps.appDependencies", - "type": "Object", + "id": "def-public.LogRateAnalysisResultsData.significantTermsGroups", + "type": "Array", "tags": [], - "label": "appDependencies", + "label": "significantTermsGroups", "description": [], "signature": [ { - "pluginId": "aiops", - "scope": "public", - "docId": "kibAiopsPluginApi", - "section": "def-public.AiopsAppDependencies", - "text": "AiopsAppDependencies" - } + "pluginId": "@kbn/ml-agg-utils", + "scope": "common", + "docId": "kibKbnMlAggUtilsPluginApi", + "section": "def-common.SignificantTermGroup", + "text": "SignificantTermGroup" + }, + "[]" ], - "path": "x-pack/plugins/aiops/public/components/log_categorization/log_categorization_app_state.tsx", + "path": "x-pack/plugins/aiops/public/components/log_rate_analysis/log_rate_analysis_results.tsx", "deprecated": false, "trackAdoption": false } @@ -907,23 +907,6 @@ "interfaces": [], "enums": [], "misc": [ - { - "parentPluginId": "aiops", - "id": "def-common.AIOPS_ENABLED", - "type": "boolean", - "tags": [], - "label": "AIOPS_ENABLED", - "description": [ - "\nThis is an internal hard coded feature flag so we can easily turn on/off the\n\"Explain log rate spikes UI\" during development until the first release." - ], - "signature": [ - "true" - ], - "path": "x-pack/plugins/aiops/common/index.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, { "parentPluginId": "aiops", "id": "def-common.CHANGE_POINT_DETECTION_ENABLED", diff --git a/api_docs/aiops.mdx b/api_docs/aiops.mdx index 15dfa7ff4439d..7c81d94bec9a1 100644 --- a/api_docs/aiops.mdx +++ b/api_docs/aiops.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/aiops title: "aiops" image: https://source.unsplash.com/400x175/?github description: API docs for the aiops plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops'] --- import aiopsObj from './aiops.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) for questi | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 45 | 0 | 27 | 1 | +| 44 | 0 | 27 | 1 | ## Client diff --git a/api_docs/alerting.mdx b/api_docs/alerting.mdx index ad4805be0cf52..e4381d9cf14e4 100644 --- a/api_docs/alerting.mdx +++ b/api_docs/alerting.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/alerting title: "alerting" image: https://source.unsplash.com/400x175/?github description: API docs for the alerting plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting'] --- import alertingObj from './alerting.devdocs.json'; diff --git a/api_docs/apm.devdocs.json b/api_docs/apm.devdocs.json index c0a2cf1ec5e30..fb9e44cb2f915 100644 --- a/api_docs/apm.devdocs.json +++ b/api_docs/apm.devdocs.json @@ -81,7 +81,7 @@ "label": "featureFlags", "description": [], "signature": [ - "{ agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; }" + "{ agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; fastRefreshAvailable: boolean; }" ], "path": "x-pack/plugins/apm/public/index.ts", "deprecated": false, @@ -265,7 +265,7 @@ "Observable", "; enabled: boolean; autoCreateApmDataView: boolean; serviceMapEnabled: boolean; serviceMapFingerprintBucketSize: number; serviceMapFingerprintGlobalBucketSize: number; serviceMapTraceIdBucketSize: number; serviceMapTraceIdGlobalBucketSize: number; serviceMapMaxTracesPerRequest: number; serviceMapTerminateAfter: number; serviceMapMaxTraces: number; ui: Readonly<{} & { enabled: boolean; maxTraceItems: number; }>; searchAggregatedTransactions: ", "SearchAggregatedTransactionSetting", - "; telemetryCollectionEnabled: boolean; metricsInterval: number; agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; forceSyntheticSource: boolean; latestAgentVersionsUrl: string; serverlessOnboarding: boolean; serverless: Readonly<{} & { enabled: true; }>; managedServiceUrl: string; featureFlags: Readonly<{} & { agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; }>; }>>; getApmIndices: () => Promise>; createApmEventClient: ({ request, context, debug, }: { debug?: boolean | undefined; request: ", + "; telemetryCollectionEnabled: boolean; metricsInterval: number; agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; forceSyntheticSource: boolean; latestAgentVersionsUrl: string; serverlessOnboarding: boolean; serverless: Readonly<{} & { enabled: true; }>; managedServiceUrl: string; featureFlags: Readonly<{} & { agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; fastRefreshAvailable: boolean; }>; }>>; getApmIndices: () => Promise>; createApmEventClient: ({ request, context, debug, }: { debug?: boolean | undefined; request: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -495,7 +495,7 @@ "label": "params", "description": [], "signature": [ - "{ query: { _inspect: boolean; start?: number | undefined; end?: number | undefined; }; }" + "{ query: { _inspect: boolean; }; }" ], "path": "x-pack/plugins/apm/server/routes/typings.ts", "deprecated": false, @@ -511,7 +511,7 @@ "signature": [ "{ readonly indices: Readonly<{} & { error: string; metric: string; span: string; transaction: string; onboarding: string; }>; readonly enabled: boolean; readonly autoCreateApmDataView: boolean; readonly serviceMapEnabled: boolean; readonly serviceMapFingerprintBucketSize: number; readonly serviceMapFingerprintGlobalBucketSize: number; readonly serviceMapTraceIdBucketSize: number; readonly serviceMapTraceIdGlobalBucketSize: number; readonly serviceMapMaxTracesPerRequest: number; readonly serviceMapTerminateAfter: number; readonly serviceMapMaxTraces: number; readonly ui: Readonly<{} & { enabled: boolean; maxTraceItems: number; }>; readonly searchAggregatedTransactions: ", "SearchAggregatedTransactionSetting", - "; readonly telemetryCollectionEnabled: boolean; readonly metricsInterval: number; readonly agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; readonly forceSyntheticSource: boolean; readonly latestAgentVersionsUrl: string; readonly serverlessOnboarding: boolean; readonly serverless: Readonly<{} & { enabled: true; }>; readonly managedServiceUrl: string; readonly featureFlags: Readonly<{} & { agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; }>; }" + "; readonly telemetryCollectionEnabled: boolean; readonly metricsInterval: number; readonly agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; readonly forceSyntheticSource: boolean; readonly latestAgentVersionsUrl: string; readonly serverlessOnboarding: boolean; readonly serverless: Readonly<{} & { enabled: true; }>; readonly managedServiceUrl: string; readonly featureFlags: Readonly<{} & { agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; fastRefreshAvailable: boolean; }>; }" ], "path": "x-pack/plugins/apm/server/routes/typings.ts", "deprecated": false, @@ -525,7 +525,7 @@ "label": "featureFlags", "description": [], "signature": [ - "{ agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; }" + "{ agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; fastRefreshAvailable: boolean; }" ], "path": "x-pack/plugins/apm/server/routes/typings.ts", "deprecated": false, @@ -965,7 +965,7 @@ "signature": [ "{ readonly indices: Readonly<{} & { error: string; metric: string; span: string; transaction: string; onboarding: string; }>; readonly enabled: boolean; readonly autoCreateApmDataView: boolean; readonly serviceMapEnabled: boolean; readonly serviceMapFingerprintBucketSize: number; readonly serviceMapFingerprintGlobalBucketSize: number; readonly serviceMapTraceIdBucketSize: number; readonly serviceMapTraceIdGlobalBucketSize: number; readonly serviceMapMaxTracesPerRequest: number; readonly serviceMapTerminateAfter: number; readonly serviceMapMaxTraces: number; readonly ui: Readonly<{} & { enabled: boolean; maxTraceItems: number; }>; readonly searchAggregatedTransactions: ", "SearchAggregatedTransactionSetting", - "; readonly telemetryCollectionEnabled: boolean; readonly metricsInterval: number; readonly agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; readonly forceSyntheticSource: boolean; readonly latestAgentVersionsUrl: string; readonly serverlessOnboarding: boolean; readonly serverless: Readonly<{} & { enabled: true; }>; readonly managedServiceUrl: string; readonly featureFlags: Readonly<{} & { agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; }>; }" + "; readonly telemetryCollectionEnabled: boolean; readonly metricsInterval: number; readonly agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; readonly forceSyntheticSource: boolean; readonly latestAgentVersionsUrl: string; readonly serverlessOnboarding: boolean; readonly serverless: Readonly<{} & { enabled: true; }>; readonly managedServiceUrl: string; readonly featureFlags: Readonly<{} & { agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; fastRefreshAvailable: boolean; }>; }" ], "path": "x-pack/plugins/apm/server/index.ts", "deprecated": false, @@ -1021,7 +1021,9 @@ "IndicesGetResponse", "; ingestPipelines: ", "IngestGetPipelineResponse", - "; }; apmIndices: Readonly<{ error: string; onboarding: string; span: string; transaction: string; metric: string; }>; apmIndexTemplates: { name: string; isNonStandard: boolean; exists: boolean; }[]; fleetPackageInfo: { isInstalled: boolean; version?: string | undefined; }; kibanaVersion: string; elasticsearchVersion: string; apmEvents: ", + "; }; diagnosticsPrivileges: { index: Record; cluster: Record; hasAllClusterPrivileges: boolean; hasAllIndexPrivileges: boolean; hasAllPrivileges: boolean; }; apmIndices: Readonly<{ error: string; onboarding: string; span: string; transaction: string; metric: string; }>; apmIndexTemplates: { name: string; isNonStandard: boolean; exists: boolean; }[]; fleetPackageInfo: { isInstalled: boolean; version?: string | undefined; }; kibanaVersion: string; elasticsearchVersion: string; apmEvents: ", "ApmEvent", "[]; invalidIndices: ", "IndiciesItem", @@ -5232,6 +5234,14 @@ "; spanId: ", "StringC", "; }>; query: ", + "IntersectionC", + "<[", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>, ", "UnionC", "<[", "PartialC", @@ -5239,7 +5249,7 @@ "StringC", "; }>, ", "UndefinedC", - "]>; }> | undefined; handler: ({}: ", + "]>]>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -5247,7 +5257,7 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - " & { params: { path: { traceId: string; spanId: string; }; query: { parentTransactionId?: string | undefined; } | undefined; }; }) => Promise<{ span?: ", + " & { params: { path: { traceId: string; spanId: string; }; query: { start: number; end: number; } & { parentTransactionId?: string | undefined; }; }; }) => Promise<{ span?: ", "Span", " | undefined; parentTransaction?: ", "Transaction", @@ -5261,7 +5271,13 @@ "StringC", "; transactionId: ", "StringC", - "; }>; }> | undefined; handler: ({}: ", + "; }>; query: ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -5269,7 +5285,7 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - " & { params: { path: { traceId: string; transactionId: string; }; }; }) => Promise<", + " & { params: { path: { traceId: string; transactionId: string; }; query: { start: number; end: number; }; }; }) => Promise<", "Transaction", ">; } & ", "APMRouteCreateOptions", @@ -5427,7 +5443,13 @@ "TypeC", "<{ transactionId: ", "StringC", - "; }>; }> | undefined; handler: ({}: ", + "; }>; query: ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -5435,7 +5457,7 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - " & { params: { path: { transactionId: string; }; }; }) => Promise<{ transaction: ", + " & { params: { path: { transactionId: string; }; query: { start: number; end: number; }; }; }) => Promise<{ transaction: ", "Transaction", "; }>; } & ", "APMRouteCreateOptions", @@ -5445,7 +5467,13 @@ "TypeC", "<{ traceId: ", "StringC", - "; }>; }> | undefined; handler: ({}: ", + "; }>; query: ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>; }> | undefined; handler: ({}: ", { "pluginId": "apm", "scope": "server", @@ -5453,7 +5481,7 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - " & { params: { path: { traceId: string; }; }; }) => Promise<{ transaction: ", + " & { params: { path: { traceId: string; }; query: { start: number; end: number; }; }; }) => Promise<{ transaction: ", "Transaction", "; }>; } & ", "APMRouteCreateOptions", @@ -8056,7 +8084,7 @@ "Observable", "; enabled: boolean; autoCreateApmDataView: boolean; serviceMapEnabled: boolean; serviceMapFingerprintBucketSize: number; serviceMapFingerprintGlobalBucketSize: number; serviceMapTraceIdBucketSize: number; serviceMapTraceIdGlobalBucketSize: number; serviceMapMaxTracesPerRequest: number; serviceMapTerminateAfter: number; serviceMapMaxTraces: number; ui: Readonly<{} & { enabled: boolean; maxTraceItems: number; }>; searchAggregatedTransactions: ", "SearchAggregatedTransactionSetting", - "; telemetryCollectionEnabled: boolean; metricsInterval: number; agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; forceSyntheticSource: boolean; latestAgentVersionsUrl: string; serverlessOnboarding: boolean; serverless: Readonly<{} & { enabled: true; }>; managedServiceUrl: string; featureFlags: Readonly<{} & { agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; }>; }>>" + "; telemetryCollectionEnabled: boolean; metricsInterval: number; agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; forceSyntheticSource: boolean; latestAgentVersionsUrl: string; serverlessOnboarding: boolean; serverless: Readonly<{} & { enabled: true; }>; managedServiceUrl: string; featureFlags: Readonly<{} & { agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; fastRefreshAvailable: boolean; }>; }>>" ], "path": "x-pack/plugins/apm/server/types.ts", "deprecated": false, diff --git a/api_docs/apm.mdx b/api_docs/apm.mdx index ae8e773311363..a9e0d44d03be5 100644 --- a/api_docs/apm.mdx +++ b/api_docs/apm.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/apm title: "apm" image: https://source.unsplash.com/400x175/?github description: API docs for the apm plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm'] --- import apmObj from './apm.devdocs.json'; diff --git a/api_docs/asset_manager.mdx b/api_docs/asset_manager.mdx index ed8b3e1f1ed8c..70c7918017723 100644 --- a/api_docs/asset_manager.mdx +++ b/api_docs/asset_manager.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/assetManager title: "assetManager" image: https://source.unsplash.com/400x175/?github description: API docs for the assetManager plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'assetManager'] --- import assetManagerObj from './asset_manager.devdocs.json'; diff --git a/api_docs/banners.mdx b/api_docs/banners.mdx index 76c5159216a35..b95fb8060c194 100644 --- a/api_docs/banners.mdx +++ b/api_docs/banners.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/banners title: "banners" image: https://source.unsplash.com/400x175/?github description: API docs for the banners plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners'] --- import bannersObj from './banners.devdocs.json'; diff --git a/api_docs/bfetch.mdx b/api_docs/bfetch.mdx index 8052e456920be..f4a262d90f70b 100644 --- a/api_docs/bfetch.mdx +++ b/api_docs/bfetch.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/bfetch title: "bfetch" image: https://source.unsplash.com/400x175/?github description: API docs for the bfetch plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch'] --- import bfetchObj from './bfetch.devdocs.json'; diff --git a/api_docs/canvas.mdx b/api_docs/canvas.mdx index a1735de3babc1..8861ec6416901 100644 --- a/api_docs/canvas.mdx +++ b/api_docs/canvas.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/canvas title: "canvas" image: https://source.unsplash.com/400x175/?github description: API docs for the canvas plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas'] --- import canvasObj from './canvas.devdocs.json'; diff --git a/api_docs/cases.devdocs.json b/api_docs/cases.devdocs.json index e7eb980f3c683..c66153d2d2fb2 100644 --- a/api_docs/cases.devdocs.json +++ b/api_docs/cases.devdocs.json @@ -1390,7 +1390,7 @@ "tags": [], "label": "ConnectorTypes", "description": [], - "path": "x-pack/plugins/cases/common/api/connectors/connector.ts", + "path": "x-pack/plugins/cases/common/types/domain/connector/v1.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false diff --git a/api_docs/cases.mdx b/api_docs/cases.mdx index 95743d690468f..f65136d52c4cf 100644 --- a/api_docs/cases.mdx +++ b/api_docs/cases.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cases title: "cases" image: https://source.unsplash.com/400x175/?github description: API docs for the cases plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases'] --- import casesObj from './cases.devdocs.json'; diff --git a/api_docs/charts.mdx b/api_docs/charts.mdx index d03065155b01f..0c637a287e8a9 100644 --- a/api_docs/charts.mdx +++ b/api_docs/charts.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/charts title: "charts" image: https://source.unsplash.com/400x175/?github description: API docs for the charts plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts'] --- import chartsObj from './charts.devdocs.json'; diff --git a/api_docs/cloud.devdocs.json b/api_docs/cloud.devdocs.json index bf2875c387ff7..728a017d66d72 100644 --- a/api_docs/cloud.devdocs.json +++ b/api_docs/cloud.devdocs.json @@ -113,6 +113,34 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "cloud", + "id": "def-public.CloudConfigType.users_and_roles_url", + "type": "string", + "tags": [], + "label": "users_and_roles_url", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/cloud/public/plugin.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloud", + "id": "def-public.CloudConfigType.performance_url", + "type": "string", + "tags": [], + "label": "performance_url", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/cloud/public/plugin.tsx", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "cloud", "id": "def-public.CloudConfigType.trial_end_date", @@ -140,6 +168,20 @@ "path": "x-pack/plugins/cloud/public/plugin.tsx", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "cloud", + "id": "def-public.CloudConfigType.serverless", + "type": "Object", + "tags": [], + "label": "serverless", + "description": [], + "signature": [ + "{ project_id: string; } | undefined" + ], + "path": "x-pack/plugins/cloud/public/plugin.tsx", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -295,6 +337,38 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "cloud", + "id": "def-public.CloudStart.performanceUrl", + "type": "string", + "tags": [], + "label": "performanceUrl", + "description": [ + "\nThe full URL to the performance page on Elastic Cloud. Undefined if not running on Cloud." + ], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/cloud/public/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloud", + "id": "def-public.CloudStart.usersAndRolesUrl", + "type": "string", + "tags": [], + "label": "usersAndRolesUrl", + "description": [ + "\nThe full URL to the users and roles page on Elastic Cloud. Undefined if not running on Cloud." + ], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/cloud/public/types.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "cloud", "id": "def-public.CloudStart.elasticsearchUrl", @@ -326,6 +400,35 @@ "path": "x-pack/plugins/cloud/public/types.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "cloud", + "id": "def-public.CloudStart.isServerlessEnabled", + "type": "boolean", + "tags": [], + "label": "isServerlessEnabled", + "description": [ + "\n`true` when running on Serverless Elastic Cloud\nNote that `isCloudEnabled` will always be true when `isServerlessEnabled` is." + ], + "path": "x-pack/plugins/cloud/public/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloud", + "id": "def-public.CloudStart.serverless", + "type": "Object", + "tags": [], + "label": "serverless", + "description": [ + "\nServerless configuration" + ], + "signature": [ + "{ projectId?: string | undefined; }" + ], + "path": "x-pack/plugins/cloud/public/types.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -617,6 +720,35 @@ } ], "returnComment": [] + }, + { + "parentPluginId": "cloud", + "id": "def-public.CloudSetup.isServerlessEnabled", + "type": "boolean", + "tags": [], + "label": "isServerlessEnabled", + "description": [ + "\n`true` when running on Serverless Elastic Cloud\nNote that `isCloudEnabled` will always be true when `isServerlessEnabled` is." + ], + "path": "x-pack/plugins/cloud/public/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloud", + "id": "def-public.CloudSetup.serverless", + "type": "Object", + "tags": [], + "label": "serverless", + "description": [ + "\nServerless configuration" + ], + "signature": [ + "{ projectId?: string | undefined; }" + ], + "path": "x-pack/plugins/cloud/public/types.ts", + "deprecated": false, + "trackAdoption": false } ], "lifecycle": "setup", @@ -815,6 +947,35 @@ "path": "x-pack/plugins/cloud/server/plugin.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "cloud", + "id": "def-server.CloudSetup.isServerlessEnabled", + "type": "boolean", + "tags": [], + "label": "isServerlessEnabled", + "description": [ + "\n`true` when running on Serverless Elastic Cloud\nNote that `isCloudEnabled` will always be true when `isServerlessEnabled` is." + ], + "path": "x-pack/plugins/cloud/server/plugin.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloud", + "id": "def-server.CloudSetup.serverless", + "type": "Object", + "tags": [], + "label": "serverless", + "description": [ + "\nServerless configuration" + ], + "signature": [ + "{ projectId?: string | undefined; }" + ], + "path": "x-pack/plugins/cloud/server/plugin.ts", + "deprecated": false, + "trackAdoption": false } ], "lifecycle": "setup", diff --git a/api_docs/cloud.mdx b/api_docs/cloud.mdx index e222daeb0d63b..d30a00ae27b64 100644 --- a/api_docs/cloud.mdx +++ b/api_docs/cloud.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloud title: "cloud" image: https://source.unsplash.com/400x175/?github description: API docs for the cloud plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud'] --- import cloudObj from './cloud.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 54 | 0 | 12 | 0 | +| 65 | 0 | 15 | 0 | ## Client diff --git a/api_docs/cloud_chat.mdx b/api_docs/cloud_chat.mdx index d6b8d2cdc8a0e..05c4db0220071 100644 --- a/api_docs/cloud_chat.mdx +++ b/api_docs/cloud_chat.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudChat title: "cloudChat" image: https://source.unsplash.com/400x175/?github description: API docs for the cloudChat plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudChat'] --- import cloudChatObj from './cloud_chat.devdocs.json'; diff --git a/api_docs/cloud_chat_provider.mdx b/api_docs/cloud_chat_provider.mdx index 36de0f67b98e9..32fc5aeffcb4f 100644 --- a/api_docs/cloud_chat_provider.mdx +++ b/api_docs/cloud_chat_provider.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudChatProvider title: "cloudChatProvider" image: https://source.unsplash.com/400x175/?github description: API docs for the cloudChatProvider plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudChatProvider'] --- import cloudChatProviderObj from './cloud_chat_provider.devdocs.json'; diff --git a/api_docs/cloud_data_migration.mdx b/api_docs/cloud_data_migration.mdx index e44f3096a919a..b8481afe75876 100644 --- a/api_docs/cloud_data_migration.mdx +++ b/api_docs/cloud_data_migration.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudDataMigration title: "cloudDataMigration" image: https://source.unsplash.com/400x175/?github description: API docs for the cloudDataMigration plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDataMigration'] --- import cloudDataMigrationObj from './cloud_data_migration.devdocs.json'; diff --git a/api_docs/cloud_defend.devdocs.json b/api_docs/cloud_defend.devdocs.json index a2aa026ef923c..77489db1f3f8c 100644 --- a/api_docs/cloud_defend.devdocs.json +++ b/api_docs/cloud_defend.devdocs.json @@ -335,6 +335,360 @@ } ], "initialIsOpen": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Response", + "type": "Interface", + "tags": [], + "label": "Response", + "description": [], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "cloudDefend", + "id": "def-common.Response.match", + "type": "Array", + "tags": [], + "label": "match", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Response.exclude", + "type": "Array", + "tags": [], + "label": "exclude", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Response.actions", + "type": "Array", + "tags": [], + "label": "actions", + "description": [], + "signature": [ + { + "pluginId": "cloudDefend", + "scope": "common", + "docId": "kibCloudDefendPluginApi", + "section": "def-common.ResponseAction", + "text": "ResponseAction" + }, + "[]" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Response.type", + "type": "CompoundType", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"file\" | \"process\"" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Response.hasErrors", + "type": "CompoundType", + "tags": [], + "label": "hasErrors", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector", + "type": "Interface", + "tags": [], + "label": "Selector", + "description": [], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector.operation", + "type": "Array", + "tags": [], + "label": "operation", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector.containerImageFullName", + "type": "Array", + "tags": [], + "label": "containerImageFullName", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector.containerImageName", + "type": "Array", + "tags": [], + "label": "containerImageName", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector.containerImageTag", + "type": "Array", + "tags": [], + "label": "containerImageTag", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector.kubernetesClusterId", + "type": "Array", + "tags": [], + "label": "kubernetesClusterId", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector.kubernetesClusterName", + "type": "Array", + "tags": [], + "label": "kubernetesClusterName", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector.kubernetesNamespace", + "type": "Array", + "tags": [], + "label": "kubernetesNamespace", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector.kubernetesPodLabel", + "type": "Array", + "tags": [], + "label": "kubernetesPodLabel", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector.kubernetesPodName", + "type": "Array", + "tags": [], + "label": "kubernetesPodName", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector.targetFilePath", + "type": "Array", + "tags": [], + "label": "targetFilePath", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector.ignoreVolumeFiles", + "type": "CompoundType", + "tags": [], + "label": "ignoreVolumeFiles", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector.ignoreVolumeMounts", + "type": "CompoundType", + "tags": [], + "label": "ignoreVolumeMounts", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector.processExecutable", + "type": "Array", + "tags": [], + "label": "processExecutable", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector.processName", + "type": "Array", + "tags": [], + "label": "processName", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector.sessionLeaderInteractive", + "type": "CompoundType", + "tags": [], + "label": "sessionLeaderInteractive", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector.type", + "type": "CompoundType", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"file\" | \"process\"" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.Selector.hasErrors", + "type": "CompoundType", + "tags": [], + "label": "hasErrors", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false } ], "enums": [], @@ -421,6 +775,53 @@ "deprecated": false, "trackAdoption": false, "initialIsOpen": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.ResponseAction", + "type": "Type", + "tags": [], + "label": "ResponseAction", + "description": [], + "signature": [ + "\"log\" | \"alert\" | \"block\"" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.SelectorCondition", + "type": "Type", + "tags": [], + "label": "SelectorCondition", + "description": [], + "signature": [ + "\"containerImageFullName\" | \"containerImageName\" | \"containerImageTag\" | \"kubernetesClusterId\" | \"kubernetesClusterName\" | \"kubernetesNamespace\" | \"kubernetesPodLabel\" | \"kubernetesPodName\" | \"targetFilePath\" | \"ignoreVolumeFiles\" | \"ignoreVolumeMounts\" | \"operation\" | \"processExecutable\" | \"processName\" | \"sessionLeaderInteractive\"" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cloudDefend", + "id": "def-common.SelectorType", + "type": "Type", + "tags": [], + "label": "SelectorType", + "description": [ + "\ncloud_defend/control types" + ], + "signature": [ + "\"file\" | \"process\"" + ], + "path": "x-pack/plugins/cloud_defend/common/v1.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false } ], "objects": [ diff --git a/api_docs/cloud_defend.mdx b/api_docs/cloud_defend.mdx index d54ef4ce06e7d..ef7240b7ebab2 100644 --- a/api_docs/cloud_defend.mdx +++ b/api_docs/cloud_defend.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudDefend title: "cloudDefend" image: https://source.unsplash.com/400x175/?github description: API docs for the cloudDefend plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDefend'] --- import cloudDefendObj from './cloud_defend.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/sec-cloudnative-integrations](https://github.com/orgs/elastic/ | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 24 | 0 | 16 | 2 | +| 52 | 0 | 43 | 2 | ## Client diff --git a/api_docs/cloud_experiments.mdx b/api_docs/cloud_experiments.mdx index 116caa6814780..0835bf263ffd2 100644 --- a/api_docs/cloud_experiments.mdx +++ b/api_docs/cloud_experiments.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudExperiments title: "cloudExperiments" image: https://source.unsplash.com/400x175/?github description: API docs for the cloudExperiments plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudExperiments'] --- import cloudExperimentsObj from './cloud_experiments.devdocs.json'; diff --git a/api_docs/cloud_security_posture.mdx b/api_docs/cloud_security_posture.mdx index 0c1b2133ba6d3..e02df17f4797d 100644 --- a/api_docs/cloud_security_posture.mdx +++ b/api_docs/cloud_security_posture.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudSecurityPosture title: "cloudSecurityPosture" image: https://source.unsplash.com/400x175/?github description: API docs for the cloudSecurityPosture plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture'] --- import cloudSecurityPostureObj from './cloud_security_posture.devdocs.json'; diff --git a/api_docs/console.devdocs.json b/api_docs/console.devdocs.json index 7deaeedae3f87..35dfc2c7cf34a 100644 --- a/api_docs/console.devdocs.json +++ b/api_docs/console.devdocs.json @@ -265,22 +265,6 @@ "enums": [], "misc": [], "objects": [], - "setup": { - "parentPluginId": "console", - "id": "def-server.ConsoleSetup", - "type": "Type", - "tags": [], - "label": "ConsoleSetup", - "description": [], - "signature": [ - "{ addExtensionSpecFilePath: (path: string) => void; }" - ], - "path": "src/plugins/console/server/types.ts", - "deprecated": false, - "trackAdoption": false, - "lifecycle": "setup", - "initialIsOpen": true - }, "start": { "parentPluginId": "console", "id": "def-server.ConsoleStart", diff --git a/api_docs/console.mdx b/api_docs/console.mdx index 89a40411b80d1..c7e84450d194e 100644 --- a/api_docs/console.mdx +++ b/api_docs/console.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/console title: "console" image: https://source.unsplash.com/400x175/?github description: API docs for the console plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console'] --- import consoleObj from './console.devdocs.json'; @@ -33,9 +33,6 @@ Contact [@elastic/platform-deployment-management](https://github.com/orgs/elasti ## Server -### Setup - - ### Start diff --git a/api_docs/content_management.mdx b/api_docs/content_management.mdx index 067e817d560c8..7d0477849e4c3 100644 --- a/api_docs/content_management.mdx +++ b/api_docs/content_management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/contentManagement title: "contentManagement" image: https://source.unsplash.com/400x175/?github description: API docs for the contentManagement plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'contentManagement'] --- import contentManagementObj from './content_management.devdocs.json'; diff --git a/api_docs/controls.mdx b/api_docs/controls.mdx index ff947b5a790b0..bccec634a4f4b 100644 --- a/api_docs/controls.mdx +++ b/api_docs/controls.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/controls title: "controls" image: https://source.unsplash.com/400x175/?github description: API docs for the controls plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls'] --- import controlsObj from './controls.devdocs.json'; diff --git a/api_docs/custom_integrations.mdx b/api_docs/custom_integrations.mdx index 726fe75c64c81..e760e0ec452fe 100644 --- a/api_docs/custom_integrations.mdx +++ b/api_docs/custom_integrations.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/customIntegrations title: "customIntegrations" image: https://source.unsplash.com/400x175/?github description: API docs for the customIntegrations plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'customIntegrations'] --- import customIntegrationsObj from './custom_integrations.devdocs.json'; diff --git a/api_docs/dashboard.mdx b/api_docs/dashboard.mdx index 1c446d0c9b28e..8c774bf13f54d 100644 --- a/api_docs/dashboard.mdx +++ b/api_docs/dashboard.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dashboard title: "dashboard" image: https://source.unsplash.com/400x175/?github description: API docs for the dashboard plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard'] --- import dashboardObj from './dashboard.devdocs.json'; diff --git a/api_docs/dashboard_enhanced.mdx b/api_docs/dashboard_enhanced.mdx index 55d48f0ca2f48..b1423ae688dc6 100644 --- a/api_docs/dashboard_enhanced.mdx +++ b/api_docs/dashboard_enhanced.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dashboardEnhanced title: "dashboardEnhanced" image: https://source.unsplash.com/400x175/?github description: API docs for the dashboardEnhanced plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced'] --- import dashboardEnhancedObj from './dashboard_enhanced.devdocs.json'; diff --git a/api_docs/data.devdocs.json b/api_docs/data.devdocs.json index 8caf2b094d26d..3e0a959a7938c 100644 --- a/api_docs/data.devdocs.json +++ b/api_docs/data.devdocs.json @@ -8815,6 +8815,10 @@ "plugin": "fleet", "path": "x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts" }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts" + }, { "plugin": "graph", "path": "x-pack/plugins/graph/server/sample_data/logs.ts" @@ -13249,8 +13253,8 @@ "path": "packages/kbn-es-query/src/es_query/types.ts" }, { - "plugin": "visualizationUiComponents", - "path": "src/plugins/visualization_ui_components/public/components/query_input/filter_query_input.tsx" + "plugin": "@kbn/visualization-ui-components", + "path": "packages/kbn-visualization-ui-components/components/query_input/filter_query_input.tsx" }, { "plugin": "observability", @@ -13270,7 +13274,7 @@ }, { "plugin": "observability", - "path": "x-pack/plugins/observability/public/components/threshold/components/expression.tsx" + "path": "x-pack/plugins/observability/public/components/threshold/threshold_rule_expression.tsx" }, { "plugin": "observability", @@ -13537,12 +13541,12 @@ "path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts" }, { - "plugin": "eventAnnotation", - "path": "src/plugins/event_annotation/public/components/group_editor_controls/group_editor_controls.tsx" + "plugin": "@kbn/event-annotation-components", + "path": "packages/kbn-event-annotation-components/components/group_editor_controls/group_editor_controls.tsx" }, { - "plugin": "eventAnnotation", - "path": "src/plugins/event_annotation/public/components/table_list.tsx" + "plugin": "@kbn/event-annotation-components", + "path": "packages/kbn-event-annotation-components/components/table_list.tsx" }, { "plugin": "lens", @@ -20912,8 +20916,8 @@ "path": "packages/kbn-es-query/src/es_query/types.ts" }, { - "plugin": "visualizationUiComponents", - "path": "src/plugins/visualization_ui_components/public/components/query_input/filter_query_input.tsx" + "plugin": "@kbn/visualization-ui-components", + "path": "packages/kbn-visualization-ui-components/components/query_input/filter_query_input.tsx" }, { "plugin": "observability", @@ -20933,7 +20937,7 @@ }, { "plugin": "observability", - "path": "x-pack/plugins/observability/public/components/threshold/components/expression.tsx" + "path": "x-pack/plugins/observability/public/components/threshold/threshold_rule_expression.tsx" }, { "plugin": "observability", @@ -21200,12 +21204,12 @@ "path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts" }, { - "plugin": "eventAnnotation", - "path": "src/plugins/event_annotation/public/components/group_editor_controls/group_editor_controls.tsx" + "plugin": "@kbn/event-annotation-components", + "path": "packages/kbn-event-annotation-components/components/group_editor_controls/group_editor_controls.tsx" }, { - "plugin": "eventAnnotation", - "path": "src/plugins/event_annotation/public/components/table_list.tsx" + "plugin": "@kbn/event-annotation-components", + "path": "packages/kbn-event-annotation-components/components/table_list.tsx" }, { "plugin": "lens", @@ -27649,6 +27653,10 @@ "plugin": "fleet", "path": "x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts" }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts" + }, { "plugin": "graph", "path": "x-pack/plugins/graph/server/sample_data/logs.ts" @@ -28706,6 +28714,21 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "data", + "id": "def-common.KQL_TELEMETRY_ROUTE_LATEST_VERSION", + "type": "string", + "tags": [], + "label": "KQL_TELEMETRY_ROUTE_LATEST_VERSION", + "description": [], + "signature": [ + "\"1\"" + ], + "path": "src/plugins/data/common/constants.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "data", "id": "def-common.META_FIELDS", @@ -28738,6 +28761,21 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "data", + "id": "def-common.SCRIPT_LANGUAGES_ROUTE_LATEST_VERSION", + "type": "string", + "tags": [], + "label": "SCRIPT_LANGUAGES_ROUTE_LATEST_VERSION", + "description": [], + "signature": [ + "\"1\"" + ], + "path": "src/plugins/data/common/constants.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "data", "id": "def-common.SourceFilter", diff --git a/api_docs/data.mdx b/api_docs/data.mdx index 3cc21f11e7d86..ce191aa1123f9 100644 --- a/api_docs/data.mdx +++ b/api_docs/data.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data title: "data" image: https://source.unsplash.com/400x175/?github description: API docs for the data plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data'] --- import dataObj from './data.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 3291 | 119 | 2571 | 27 | +| 3293 | 119 | 2573 | 27 | ## Client diff --git a/api_docs/data_query.mdx b/api_docs/data_query.mdx index ea37083c9666a..6cb7028cdec01 100644 --- a/api_docs/data_query.mdx +++ b/api_docs/data_query.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data-query title: "data.query" image: https://source.unsplash.com/400x175/?github description: API docs for the data.query plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query'] --- import dataQueryObj from './data_query.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 3291 | 119 | 2571 | 27 | +| 3293 | 119 | 2573 | 27 | ## Client diff --git a/api_docs/data_search.mdx b/api_docs/data_search.mdx index 1d31279da0b48..3059eb4875ec3 100644 --- a/api_docs/data_search.mdx +++ b/api_docs/data_search.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data-search title: "data.search" image: https://source.unsplash.com/400x175/?github description: API docs for the data.search plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search'] --- import dataSearchObj from './data_search.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 3291 | 119 | 2571 | 27 | +| 3293 | 119 | 2573 | 27 | ## Client diff --git a/api_docs/data_view_editor.mdx b/api_docs/data_view_editor.mdx index 593b3d7e16e2b..2842eb4a16a62 100644 --- a/api_docs/data_view_editor.mdx +++ b/api_docs/data_view_editor.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewEditor title: "dataViewEditor" image: https://source.unsplash.com/400x175/?github description: API docs for the dataViewEditor plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewEditor'] --- import dataViewEditorObj from './data_view_editor.devdocs.json'; diff --git a/api_docs/data_view_field_editor.mdx b/api_docs/data_view_field_editor.mdx index a85ad030751b8..72c3aba8853cd 100644 --- a/api_docs/data_view_field_editor.mdx +++ b/api_docs/data_view_field_editor.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewFieldEditor title: "dataViewFieldEditor" image: https://source.unsplash.com/400x175/?github description: API docs for the dataViewFieldEditor plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewFieldEditor'] --- import dataViewFieldEditorObj from './data_view_field_editor.devdocs.json'; diff --git a/api_docs/data_view_management.mdx b/api_docs/data_view_management.mdx index 4acf03b61b04d..8fcd6ca096a5e 100644 --- a/api_docs/data_view_management.mdx +++ b/api_docs/data_view_management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewManagement title: "dataViewManagement" image: https://source.unsplash.com/400x175/?github description: API docs for the dataViewManagement plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement'] --- import dataViewManagementObj from './data_view_management.devdocs.json'; diff --git a/api_docs/data_views.devdocs.json b/api_docs/data_views.devdocs.json index f25ea1813e233..58b8178867120 100644 --- a/api_docs/data_views.devdocs.json +++ b/api_docs/data_views.devdocs.json @@ -68,8 +68,8 @@ "path": "packages/kbn-es-query/src/es_query/types.ts" }, { - "plugin": "visualizationUiComponents", - "path": "src/plugins/visualization_ui_components/public/components/query_input/filter_query_input.tsx" + "plugin": "@kbn/visualization-ui-components", + "path": "packages/kbn-visualization-ui-components/components/query_input/filter_query_input.tsx" }, { "plugin": "observability", @@ -89,7 +89,7 @@ }, { "plugin": "observability", - "path": "x-pack/plugins/observability/public/components/threshold/components/expression.tsx" + "path": "x-pack/plugins/observability/public/components/threshold/threshold_rule_expression.tsx" }, { "plugin": "observability", @@ -360,12 +360,12 @@ "path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts" }, { - "plugin": "eventAnnotation", - "path": "src/plugins/event_annotation/public/components/group_editor_controls/group_editor_controls.tsx" + "plugin": "@kbn/event-annotation-components", + "path": "packages/kbn-event-annotation-components/components/group_editor_controls/group_editor_controls.tsx" }, { - "plugin": "eventAnnotation", - "path": "src/plugins/event_annotation/public/components/table_list.tsx" + "plugin": "@kbn/event-annotation-components", + "path": "packages/kbn-event-annotation-components/components/table_list.tsx" }, { "plugin": "lens", @@ -7904,8 +7904,8 @@ "path": "packages/kbn-es-query/src/es_query/types.ts" }, { - "plugin": "visualizationUiComponents", - "path": "src/plugins/visualization_ui_components/public/components/query_input/filter_query_input.tsx" + "plugin": "@kbn/visualization-ui-components", + "path": "packages/kbn-visualization-ui-components/components/query_input/filter_query_input.tsx" }, { "plugin": "observability", @@ -7925,7 +7925,7 @@ }, { "plugin": "observability", - "path": "x-pack/plugins/observability/public/components/threshold/components/expression.tsx" + "path": "x-pack/plugins/observability/public/components/threshold/threshold_rule_expression.tsx" }, { "plugin": "observability", @@ -8196,12 +8196,12 @@ "path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts" }, { - "plugin": "eventAnnotation", - "path": "src/plugins/event_annotation/public/components/group_editor_controls/group_editor_controls.tsx" + "plugin": "@kbn/event-annotation-components", + "path": "packages/kbn-event-annotation-components/components/group_editor_controls/group_editor_controls.tsx" }, { - "plugin": "eventAnnotation", - "path": "src/plugins/event_annotation/public/components/table_list.tsx" + "plugin": "@kbn/event-annotation-components", + "path": "packages/kbn-event-annotation-components/components/table_list.tsx" }, { "plugin": "lens", @@ -14859,8 +14859,8 @@ "path": "packages/kbn-es-query/src/es_query/types.ts" }, { - "plugin": "visualizationUiComponents", - "path": "src/plugins/visualization_ui_components/public/components/query_input/filter_query_input.tsx" + "plugin": "@kbn/visualization-ui-components", + "path": "packages/kbn-visualization-ui-components/components/query_input/filter_query_input.tsx" }, { "plugin": "observability", @@ -14880,7 +14880,7 @@ }, { "plugin": "observability", - "path": "x-pack/plugins/observability/public/components/threshold/components/expression.tsx" + "path": "x-pack/plugins/observability/public/components/threshold/threshold_rule_expression.tsx" }, { "plugin": "observability", @@ -15151,12 +15151,12 @@ "path": "packages/kbn-unified-field-list/src/hooks/use_existing_fields.ts" }, { - "plugin": "eventAnnotation", - "path": "src/plugins/event_annotation/public/components/group_editor_controls/group_editor_controls.tsx" + "plugin": "@kbn/event-annotation-components", + "path": "packages/kbn-event-annotation-components/components/group_editor_controls/group_editor_controls.tsx" }, { - "plugin": "eventAnnotation", - "path": "src/plugins/event_annotation/public/components/table_list.tsx" + "plugin": "@kbn/event-annotation-components", + "path": "packages/kbn-event-annotation-components/components/table_list.tsx" }, { "plugin": "lens", @@ -24086,6 +24086,10 @@ "plugin": "fleet", "path": "x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts" }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts" + }, { "plugin": "graph", "path": "x-pack/plugins/graph/server/sample_data/logs.ts" diff --git a/api_docs/data_views.mdx b/api_docs/data_views.mdx index ec8b6df08a684..c9fe8fb21f8cb 100644 --- a/api_docs/data_views.mdx +++ b/api_docs/data_views.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViews title: "dataViews" image: https://source.unsplash.com/400x175/?github description: API docs for the dataViews plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews'] --- import dataViewsObj from './data_views.devdocs.json'; diff --git a/api_docs/data_visualizer.mdx b/api_docs/data_visualizer.mdx index 217b6c9b73aec..adfbbe0b931e2 100644 --- a/api_docs/data_visualizer.mdx +++ b/api_docs/data_visualizer.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataVisualizer title: "dataVisualizer" image: https://source.unsplash.com/400x175/?github description: API docs for the dataVisualizer plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataVisualizer'] --- import dataVisualizerObj from './data_visualizer.devdocs.json'; diff --git a/api_docs/deprecations_by_api.mdx b/api_docs/deprecations_by_api.mdx index 469a2054c6296..7b775c10b6a39 100644 --- a/api_docs/deprecations_by_api.mdx +++ b/api_docs/deprecations_by_api.mdx @@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByApi slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-api title: Deprecated API usage by API description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by. -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana'] --- @@ -21,14 +21,14 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | stackAlerts, alerting, securitySolution, inputControlVis | - | | | stackAlerts, infra, graph, inputControlVis, securitySolution, savedObjects | - | | | dashboard, stackAlerts, dataVisualizer, expressionPartitionVis | - | -| | @kbn/es-query, visualizationUiComponents, observability, securitySolution, timelines, lists, threatIntelligence, savedSearch, dataViews, savedObjectsManagement, unifiedSearch, controls, @kbn/unified-field-list, eventAnnotation, lens, aiops, ml, logsShared, visTypeTimeseries, apm, triggersActionsUi, exploratoryView, stackAlerts, fleet, dataVisualizer, infra, canvas, enterpriseSearch, graph, transform, upgradeAssistant, uptime, ux, maps, dataViewManagement, inputControlVis, visDefaultEditor, presentationUtil, visTypeTimelion, visTypeVega, data | - | +| | @kbn/es-query, @kbn/visualization-ui-components, observability, securitySolution, timelines, lists, threatIntelligence, savedSearch, dataViews, savedObjectsManagement, unifiedSearch, controls, @kbn/unified-field-list, @kbn/event-annotation-components, lens, aiops, ml, logsShared, visTypeTimeseries, apm, triggersActionsUi, exploratoryView, stackAlerts, fleet, dataVisualizer, infra, canvas, enterpriseSearch, graph, transform, upgradeAssistant, uptime, ux, maps, dataViewManagement, inputControlVis, visDefaultEditor, presentationUtil, visTypeTimelion, visTypeVega, data | - | | | stackAlerts, alerting, securitySolution, inputControlVis | - | -| | @kbn/es-query, visualizationUiComponents, observability, securitySolution, timelines, lists, threatIntelligence, savedSearch, dataViews, savedObjectsManagement, unifiedSearch, controls, @kbn/unified-field-list, eventAnnotation, lens, aiops, ml, logsShared, visTypeTimeseries, apm, triggersActionsUi, exploratoryView, stackAlerts, fleet, dataVisualizer, infra, canvas, enterpriseSearch, graph, transform, upgradeAssistant, uptime, ux, maps, dataViewManagement, inputControlVis, visDefaultEditor, presentationUtil, visTypeTimelion, visTypeVega, data | - | -| | @kbn/es-query, visualizationUiComponents, observability, securitySolution, timelines, lists, threatIntelligence, savedSearch, data, savedObjectsManagement, unifiedSearch, controls, @kbn/unified-field-list, eventAnnotation, lens, aiops, ml, logsShared, visTypeTimeseries, apm, triggersActionsUi, exploratoryView, stackAlerts, fleet, dataVisualizer, infra, canvas, enterpriseSearch, graph, transform, upgradeAssistant, uptime, ux, maps, dataViewManagement, inputControlVis, visDefaultEditor, presentationUtil, visTypeTimelion, visTypeVega | - | +| | @kbn/es-query, @kbn/visualization-ui-components, observability, securitySolution, timelines, lists, threatIntelligence, savedSearch, dataViews, savedObjectsManagement, unifiedSearch, controls, @kbn/unified-field-list, @kbn/event-annotation-components, lens, aiops, ml, logsShared, visTypeTimeseries, apm, triggersActionsUi, exploratoryView, stackAlerts, fleet, dataVisualizer, infra, canvas, enterpriseSearch, graph, transform, upgradeAssistant, uptime, ux, maps, dataViewManagement, inputControlVis, visDefaultEditor, presentationUtil, visTypeTimelion, visTypeVega, data | - | +| | @kbn/es-query, @kbn/visualization-ui-components, observability, securitySolution, timelines, lists, threatIntelligence, savedSearch, data, savedObjectsManagement, unifiedSearch, controls, @kbn/unified-field-list, @kbn/event-annotation-components, lens, aiops, ml, logsShared, visTypeTimeseries, apm, triggersActionsUi, exploratoryView, stackAlerts, fleet, dataVisualizer, infra, canvas, enterpriseSearch, graph, transform, upgradeAssistant, uptime, ux, maps, dataViewManagement, inputControlVis, visDefaultEditor, presentationUtil, visTypeTimelion, visTypeVega | - | | | home, data, esUiShared, savedObjectsManagement, exploratoryView, fleet, observability, ml, apm, indexLifecycleManagement, observabilityOnboarding, synthetics, upgradeAssistant, uptime, ux, kibanaOverview | - | | | encryptedSavedObjects, actions, data, ml, logstash, securitySolution, cloudChat | - | | | actions, ml, savedObjectsTagging, enterpriseSearch | - | -| | @kbn/core-saved-objects-browser-internal, @kbn/core, savedObjects, embeddable, presentationUtil, visualizations, aiops, ml, dataVisualizer, dashboardEnhanced, graph, uptime, lens, securitySolution, eventAnnotation, @kbn/core-saved-objects-browser-mocks | - | +| | @kbn/core-saved-objects-browser-internal, @kbn/core, savedObjects, presentationUtil, visualizations, aiops, ml, dataVisualizer, dashboardEnhanced, graph, uptime, lens, securitySolution, eventAnnotation, @kbn/core-saved-objects-browser-mocks | - | | | @kbn/core, savedObjects, embeddable, visualizations, canvas, graph, ml, @kbn/core-saved-objects-common, @kbn/core-saved-objects-server, actions, alerting, savedSearch, enterpriseSearch, securitySolution, taskManager, @kbn/core-saved-objects-server-internal, @kbn/core-saved-objects-api-server | - | | | observability, @kbn/securitysolution-data-table, securitySolution | - | | | @kbn/core-saved-objects-api-browser, @kbn/core, savedObjects, savedObjectsManagement, visualizations, savedObjectsTagging, eventAnnotation, lens, graph, dashboard, savedObjectsTaggingOss, kibanaUtils, expressions, data, embeddable, controls, uiActionsEnhanced, cases, maps, canvas, dashboardEnhanced, globalSearchProviders, infra | - | diff --git a/api_docs/deprecations_by_plugin.mdx b/api_docs/deprecations_by_plugin.mdx index 418fbd650446d..f192aa1f735d8 100644 --- a/api_docs/deprecations_by_plugin.mdx +++ b/api_docs/deprecations_by_plugin.mdx @@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByPlugin slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-plugin title: Deprecated API usage by plugin description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by. -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana'] --- @@ -304,6 +304,16 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] +## @kbn/event-annotation-components + +| Deprecated API | Reference location(s) | Remove By | +| ---------------|-----------|-----------| +| | [group_editor_controls.tsx](https://github.com/elastic/kibana/tree/main/packages/kbn-event-annotation-components/components/group_editor_controls/group_editor_controls.tsx#:~:text=title), [table_list.tsx](https://github.com/elastic/kibana/tree/main/packages/kbn-event-annotation-components/components/table_list.tsx#:~:text=title), [group_editor_controls.tsx](https://github.com/elastic/kibana/tree/main/packages/kbn-event-annotation-components/components/group_editor_controls/group_editor_controls.tsx#:~:text=title), [table_list.tsx](https://github.com/elastic/kibana/tree/main/packages/kbn-event-annotation-components/components/table_list.tsx#:~:text=title) | - | +| | [group_editor_controls.tsx](https://github.com/elastic/kibana/tree/main/packages/kbn-event-annotation-components/components/group_editor_controls/group_editor_controls.tsx#:~:text=title), [table_list.tsx](https://github.com/elastic/kibana/tree/main/packages/kbn-event-annotation-components/components/table_list.tsx#:~:text=title), [group_editor_controls.tsx](https://github.com/elastic/kibana/tree/main/packages/kbn-event-annotation-components/components/group_editor_controls/group_editor_controls.tsx#:~:text=title), [table_list.tsx](https://github.com/elastic/kibana/tree/main/packages/kbn-event-annotation-components/components/table_list.tsx#:~:text=title) | - | +| | [group_editor_controls.tsx](https://github.com/elastic/kibana/tree/main/packages/kbn-event-annotation-components/components/group_editor_controls/group_editor_controls.tsx#:~:text=title), [table_list.tsx](https://github.com/elastic/kibana/tree/main/packages/kbn-event-annotation-components/components/table_list.tsx#:~:text=title) | - | + + + ## @kbn/securitysolution-data-table | Deprecated API | Reference location(s) | Remove By | @@ -335,6 +345,16 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] +## @kbn/visualization-ui-components + +| Deprecated API | Reference location(s) | Remove By | +| ---------------|-----------|-----------| +| | [filter_query_input.tsx](https://github.com/elastic/kibana/tree/main/packages/kbn-visualization-ui-components/components/query_input/filter_query_input.tsx#:~:text=title), [filter_query_input.tsx](https://github.com/elastic/kibana/tree/main/packages/kbn-visualization-ui-components/components/query_input/filter_query_input.tsx#:~:text=title) | - | +| | [filter_query_input.tsx](https://github.com/elastic/kibana/tree/main/packages/kbn-visualization-ui-components/components/query_input/filter_query_input.tsx#:~:text=title), [filter_query_input.tsx](https://github.com/elastic/kibana/tree/main/packages/kbn-visualization-ui-components/components/query_input/filter_query_input.tsx#:~:text=title) | - | +| | [filter_query_input.tsx](https://github.com/elastic/kibana/tree/main/packages/kbn-visualization-ui-components/components/query_input/filter_query_input.tsx#:~:text=title) | - | + + + ## actions | Deprecated API | Reference location(s) | Remove By | @@ -605,8 +625,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | ---------------|-----------|-----------| | | [attribute_service.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#:~:text=SavedObjectSaveModal), [attribute_service.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 | | | [container.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/tests/container.test.ts#:~:text=executeTriggerActions), [container.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/tests/container.test.ts#:~:text=executeTriggerActions), [container.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/tests/container.test.ts#:~:text=executeTriggerActions), [container.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/tests/container.test.ts#:~:text=executeTriggerActions), [explicit_input.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/tests/explicit_input.test.ts#:~:text=executeTriggerActions) | - | -| | [add_panel_flyout.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx#:~:text=SimpleSavedObject), [add_panel_flyout.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx#:~:text=SimpleSavedObject), [add_panel_flyout.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx#:~:text=SimpleSavedObject) | - | -| | [add_panel_flyout.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx#:~:text=SavedObjectAttributes), [add_panel_flyout.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx#:~:text=SavedObjectAttributes), [add_panel_flyout.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx#:~:text=SavedObjectAttributes), [default_embeddable_factory_provider.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts#:~:text=SavedObjectAttributes), [default_embeddable_factory_provider.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/types.ts#:~:text=SavedObjectAttributes) | - | +| | [default_embeddable_factory_provider.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts#:~:text=SavedObjectAttributes), [default_embeddable_factory_provider.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/types.ts#:~:text=SavedObjectAttributes) | - | | | [migrate_base_input.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/common/lib/migrate_base_input.ts#:~:text=SavedObjectReference), [migrate_base_input.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/common/lib/migrate_base_input.ts#:~:text=SavedObjectReference), [migrate_base_input.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/common/lib/migrate_base_input.ts#:~:text=SavedObjectReference), [inject.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/common/lib/inject.ts#:~:text=SavedObjectReference), [inject.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/common/lib/inject.ts#:~:text=SavedObjectReference) | - | @@ -645,9 +664,6 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [group_editor_controls.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/event_annotation/public/components/group_editor_controls/group_editor_controls.tsx#:~:text=title), [table_list.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/event_annotation/public/components/table_list.tsx#:~:text=title), [group_editor_controls.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/event_annotation/public/components/group_editor_controls/group_editor_controls.tsx#:~:text=title), [table_list.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/event_annotation/public/components/table_list.tsx#:~:text=title) | - | -| | [group_editor_controls.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/event_annotation/public/components/group_editor_controls/group_editor_controls.tsx#:~:text=title), [table_list.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/event_annotation/public/components/table_list.tsx#:~:text=title), [group_editor_controls.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/event_annotation/public/components/group_editor_controls/group_editor_controls.tsx#:~:text=title), [table_list.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/event_annotation/public/components/table_list.tsx#:~:text=title) | - | -| | [group_editor_controls.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/event_annotation/public/components/group_editor_controls/group_editor_controls.tsx#:~:text=title), [table_list.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/event_annotation/public/components/table_list.tsx#:~:text=title) | - | | | [service.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/event_annotation/public/event_annotation_service/service.test.ts#:~:text=SimpleSavedObject), [service.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/event_annotation/public/event_annotation_service/service.test.ts#:~:text=SimpleSavedObject) | - | | | [service.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/event_annotation/public/event_annotation_service/service.tsx#:~:text=SavedObjectReference), [service.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/event_annotation/public/event_annotation_service/service.tsx#:~:text=SavedObjectReference), [service.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/event_annotation/public/event_annotation_service/service.tsx#:~:text=SavedObjectReference) | - | @@ -702,8 +718,8 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [install.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion) | - | -| | [install.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [install.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion)+ 10 more | - | +| | [install.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts#:~:text=migrationVersion), [install.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion) | - | +| | [install.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts#:~:text=migrationVersion), [install.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [install.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts#:~:text=migrationVersion), [install.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion), [get.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/services/epm/packages/get.test.ts#:~:text=migrationVersion)+ 14 more | - | | | [query_bar.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/query_bar.tsx#:~:text=title), [query_bar.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/query_bar.tsx#:~:text=title) | - | | | [query_bar.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/query_bar.tsx#:~:text=title), [query_bar.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/query_bar.tsx#:~:text=title) | - | | | [query_bar.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/query_bar.tsx#:~:text=title) | - | @@ -951,9 +967,9 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| | | [executor.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/server/lib/rules/slo_burn_rate/executor.ts#:~:text=alertFactory), [threshold_executor.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/server/lib/rules/threshold/threshold_executor.ts#:~:text=alertFactory), [executor.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/server/lib/rules/slo_burn_rate/executor.test.ts#:~:text=alertFactory) | - | -| | [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [expression.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/components/expression.tsx#:~:text=title), [alert_details_app_section.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/components/alert_details_app_section.tsx#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title)+ 2 more | - | -| | [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [expression.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/components/expression.tsx#:~:text=title), [alert_details_app_section.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/components/alert_details_app_section.tsx#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title)+ 2 more | - | -| | [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [expression.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/components/expression.tsx#:~:text=title), [alert_details_app_section.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/components/alert_details_app_section.tsx#:~:text=title) | - | +| | [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [threshold_rule_expression.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/threshold_rule_expression.tsx#:~:text=title), [alert_details_app_section.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/components/alert_details_app_section.tsx#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title)+ 2 more | - | +| | [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [threshold_rule_expression.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/threshold_rule_expression.tsx#:~:text=title), [alert_details_app_section.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/components/alert_details_app_section.tsx#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title)+ 2 more | - | +| | [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [use_metrics_explorer_data.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/hooks/use_metrics_explorer_data.ts#:~:text=title), [threshold_rule_expression.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/threshold_rule_expression.tsx#:~:text=title), [alert_details_app_section.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/threshold/components/alert_details_app_section.tsx#:~:text=title) | - | | | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/application/index.tsx#:~:text=RedirectAppLinks), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/application/index.tsx#:~:text=RedirectAppLinks), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/application/index.tsx#:~:text=RedirectAppLinks) | - | | | [render_cell_value.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/alerts_table/render_cell_value.tsx#:~:text=DeprecatedCellValueElementProps), [render_cell_value.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/observability/public/components/alerts_table/render_cell_value.tsx#:~:text=DeprecatedCellValueElementProps) | - | @@ -1400,16 +1416,6 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ -## visualizationUiComponents - -| Deprecated API | Reference location(s) | Remove By | -| ---------------|-----------|-----------| -| | [filter_query_input.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualization_ui_components/public/components/query_input/filter_query_input.tsx#:~:text=title), [filter_query_input.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualization_ui_components/public/components/query_input/filter_query_input.tsx#:~:text=title) | - | -| | [filter_query_input.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualization_ui_components/public/components/query_input/filter_query_input.tsx#:~:text=title), [filter_query_input.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualization_ui_components/public/components/query_input/filter_query_input.tsx#:~:text=title) | - | -| | [filter_query_input.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualization_ui_components/public/components/query_input/filter_query_input.tsx#:~:text=title) | - | - - - ## visualizations | Deprecated API | Reference location(s) | Remove By | diff --git a/api_docs/deprecations_by_team.mdx b/api_docs/deprecations_by_team.mdx index 96988b210d293..8271eb633113a 100644 --- a/api_docs/deprecations_by_team.mdx +++ b/api_docs/deprecations_by_team.mdx @@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsDueByTeam slug: /kibana-dev-docs/api-meta/deprecations-due-by-team title: Deprecated APIs due to be removed, by team description: Lists the teams that are referencing deprecated APIs with a remove by date. -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana'] --- diff --git a/api_docs/dev_tools.mdx b/api_docs/dev_tools.mdx index 114ff24510c73..a9f88dc247093 100644 --- a/api_docs/dev_tools.mdx +++ b/api_docs/dev_tools.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/devTools title: "devTools" image: https://source.unsplash.com/400x175/?github description: API docs for the devTools plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools'] --- import devToolsObj from './dev_tools.devdocs.json'; diff --git a/api_docs/discover.mdx b/api_docs/discover.mdx index 5b4f2716b00cb..cd4cfc1d0e892 100644 --- a/api_docs/discover.mdx +++ b/api_docs/discover.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/discover title: "discover" image: https://source.unsplash.com/400x175/?github description: API docs for the discover plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover'] --- import discoverObj from './discover.devdocs.json'; diff --git a/api_docs/discover_enhanced.mdx b/api_docs/discover_enhanced.mdx index 48dda991d719b..98015a77d4a98 100644 --- a/api_docs/discover_enhanced.mdx +++ b/api_docs/discover_enhanced.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/discoverEnhanced title: "discoverEnhanced" image: https://source.unsplash.com/400x175/?github description: API docs for the discoverEnhanced plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced'] --- import discoverEnhancedObj from './discover_enhanced.devdocs.json'; diff --git a/api_docs/ecs_data_quality_dashboard.mdx b/api_docs/ecs_data_quality_dashboard.mdx index 22c335a6bdabf..1301dc7a2a4f8 100644 --- a/api_docs/ecs_data_quality_dashboard.mdx +++ b/api_docs/ecs_data_quality_dashboard.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/ecsDataQualityDashboard title: "ecsDataQualityDashboard" image: https://source.unsplash.com/400x175/?github description: API docs for the ecsDataQualityDashboard plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ecsDataQualityDashboard'] --- import ecsDataQualityDashboardObj from './ecs_data_quality_dashboard.devdocs.json'; diff --git a/api_docs/embeddable.devdocs.json b/api_docs/embeddable.devdocs.json index 0c37b31929ff6..a3efb8ed05233 100644 --- a/api_docs/embeddable.devdocs.json +++ b/api_docs/embeddable.devdocs.json @@ -4,64 +4,28 @@ "classes": [ { "parentPluginId": "embeddable", - "id": "def-public.AddPanelAction", + "id": "def-public.AttributeService", "type": "Class", "tags": [], - "label": "AddPanelAction", + "label": "AttributeService", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.AddPanelAction", - "text": "AddPanelAction" - }, - " implements ", - { - "pluginId": "uiActions", - "scope": "public", - "docId": "kibUiActionsPluginApi", - "section": "def-public.Action", - "text": "Action" + "section": "def-public.AttributeService", + "text": "AttributeService" }, - "" + "" ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.AddPanelAction.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"ACTION_ADD_PANEL\"" - ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.AddPanelAction.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "\"ACTION_ADD_PANEL\"" - ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.AddPanelAction.Unnamed", + "id": "def-public.AttributeService.Unnamed", "type": "Function", "tags": [], "label": "Constructor", @@ -69,90 +33,71 @@ "signature": [ "any" ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.AddPanelAction.Unnamed.$1", - "type": "Function", + "id": "def-public.AttributeService.Unnamed.$1", + "type": "string", "tags": [], - "label": "getFactory", + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "embeddable", + "id": "def-public.AttributeService.Unnamed.$2", + "type": "Object", + "tags": [], + "label": "toasts", "description": [], "signature": [ - " = ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - ">(embeddableFactoryId: string) => ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableFactory", - "text": "EmbeddableFactory" - }, - " | undefined" + "docId": "kibKbnCoreNotificationsBrowserPluginApi", + "section": "def-common.IToasts", + "text": "IToasts" + } + ], + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "embeddable", + "id": "def-public.AttributeService.Unnamed.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "AttributeServiceOptions", + "" ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "embeddable", - "id": "def-public.AddPanelAction.Unnamed.$2", + "id": "def-public.AttributeService.Unnamed.$4", "type": "Function", "tags": [], - "label": "getAllFactories", + "label": "getEmbeddableFactory", "description": [], "signature": [ - "() => IterableIterator<", + "((embeddableFactoryId: string) => ", { "pluginId": "embeddable", "scope": "public", @@ -200,102 +145,105 @@ "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, - ", any>, unknown>>" - ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "embeddable", - "id": "def-public.AddPanelAction.Unnamed.$3", - "type": "Object", - "tags": [], - "label": "overlays", - "description": [], - "signature": [ - { - "pluginId": "@kbn/core-overlays-browser", - "scope": "common", - "docId": "kibKbnCoreOverlaysBrowserPluginApi", - "section": "def-common.OverlayStart", - "text": "OverlayStart" - } + ", any>, unknown>) | undefined" ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "deprecated": false, "trackAdoption": false, - "isRequired": true - }, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "embeddable", + "id": "def-public.AttributeService.unwrapAttributes", + "type": "Function", + "tags": [], + "label": "unwrapAttributes", + "description": [], + "signature": [ + "(input: ValType | RefType) => Promise<", + "AttributeServiceUnwrapResult", + ">" + ], + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "embeddable", - "id": "def-public.AddPanelAction.Unnamed.$4", - "type": "Object", + "id": "def-public.AttributeService.unwrapAttributes.$1", + "type": "CompoundType", "tags": [], - "label": "notifications", + "label": "input", "description": [], "signature": [ - { - "pluginId": "@kbn/core-notifications-browser", - "scope": "common", - "docId": "kibKbnCoreNotificationsBrowserPluginApi", - "section": "def-common.NotificationsStart", - "text": "NotificationsStart" - } + "ValType | RefType" ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true - }, + } + ], + "returnComment": [] + }, + { + "parentPluginId": "embeddable", + "id": "def-public.AttributeService.wrapAttributes", + "type": "Function", + "tags": [], + "label": "wrapAttributes", + "description": [], + "signature": [ + "(newAttributes: SavedObjectAttributes, useRefType: boolean, input?: ValType | RefType | undefined) => Promise>" + ], + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "embeddable", - "id": "def-public.AddPanelAction.Unnamed.$5", - "type": "CompoundType", + "id": "def-public.AttributeService.wrapAttributes.$1", + "type": "Uncategorized", "tags": [], - "label": "SavedObjectFinder", + "label": "newAttributes", "description": [], "signature": [ - "React.ComponentType" + "SavedObjectAttributes" ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "embeddable", - "id": "def-public.AddPanelAction.Unnamed.$6", - "type": "Object", + "id": "def-public.AttributeService.wrapAttributes.$2", + "type": "boolean", "tags": [], - "label": "theme", + "label": "useRefType", "description": [], "signature": [ - { - "pluginId": "@kbn/core-theme-browser", - "scope": "common", - "docId": "kibKbnCoreThemeBrowserPluginApi", - "section": "def-common.ThemeServiceStart", - "text": "ThemeServiceStart" - } + "boolean" ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "embeddable", - "id": "def-public.AddPanelAction.Unnamed.$7", - "type": "Function", + "id": "def-public.AttributeService.wrapAttributes.$3", + "type": "CompoundType", "tags": [], - "label": "reportUiCounter", + "label": "input", "description": [], "signature": [ - "((appName: string, type: string, eventNames: string | string[], count?: number | undefined) => void) | undefined" + "ValType | RefType | undefined" ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "deprecated": false, "trackAdoption": false, "isRequired": false @@ -305,76 +253,61 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.AddPanelAction.getDisplayName", + "id": "def-public.AttributeService.inputIsRefType", "type": "Function", "tags": [], - "label": "getDisplayName", + "label": "inputIsRefType", "description": [], "signature": [ - "() => any" + "(input: ValType | RefType) => input is RefType" ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "deprecated": false, "trackAdoption": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "embeddable", - "id": "def-public.AddPanelAction.getIconType", - "type": "Function", - "tags": [], - "label": "getIconType", - "description": [], - "signature": [ - "() => string" + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.AttributeService.inputIsRefType.$1", + "type": "CompoundType", + "tags": [], + "label": "input", + "description": [], + "signature": [ + "ValType | RefType" + ], + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", - "deprecated": false, - "trackAdoption": false, - "children": [], "returnComment": [] }, { "parentPluginId": "embeddable", - "id": "def-public.AddPanelAction.isCompatible", + "id": "def-public.AttributeService.getInputAsValueType", "type": "Function", "tags": [], - "label": "isCompatible", + "label": "getInputAsValueType", "description": [], "signature": [ - "(context: ", - { - "pluginId": "uiActions", - "scope": "public", - "docId": "kibUiActionsPluginApi", - "section": "def-public.ActionExecutionContext", - "text": "ActionExecutionContext" - }, - ") => Promise" + "(input: ValType | RefType) => Promise" ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.AddPanelAction.isCompatible.$1", + "id": "def-public.AttributeService.getInputAsValueType.$1", "type": "CompoundType", "tags": [], - "label": "context", + "label": "input", "description": [], "signature": [ - { - "pluginId": "uiActions", - "scope": "public", - "docId": "kibUiActionsPluginApi", - "section": "def-public.ActionExecutionContext", - "text": "ActionExecutionContext" - }, - "" + "ValType | RefType" ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -384,47 +317,47 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.AddPanelAction.execute", + "id": "def-public.AttributeService.getInputAsRefType", "type": "Function", "tags": [], - "label": "execute", + "label": "getInputAsRefType", "description": [], "signature": [ - "(context: ", - { - "pluginId": "uiActions", - "scope": "public", - "docId": "kibUiActionsPluginApi", - "section": "def-public.ActionExecutionContext", - "text": "ActionExecutionContext" - }, - ") => Promise" + "(input: ValType | RefType, saveOptions?: { showSaveModal: boolean; saveModalTitle?: string | undefined; } | { title: string; } | undefined) => Promise" ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.AddPanelAction.execute.$1", + "id": "def-public.AttributeService.getInputAsRefType.$1", "type": "CompoundType", "tags": [], - "label": "context", + "label": "input", "description": [], "signature": [ - { - "pluginId": "uiActions", - "scope": "public", - "docId": "kibUiActionsPluginApi", - "section": "def-public.ActionExecutionContext", - "text": "ActionExecutionContext" - }, - "" + "ValType | RefType" ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true + }, + { + "parentPluginId": "embeddable", + "id": "def-public.AttributeService.getInputAsRefType.$2", + "type": "CompoundType", + "tags": [], + "label": "saveOptions", + "description": [], + "signature": [ + "{ showSaveModal: boolean; saveModalTitle?: string | undefined; } | { title: string; } | undefined" + ], + "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": false } ], "returnComment": [] @@ -434,28 +367,67 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.AttributeService", + "id": "def-public.Container", "type": "Class", "tags": [], - "label": "AttributeService", + "label": "Container", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.AttributeService", - "text": "AttributeService" + "section": "def-public.Container", + "text": "Container" }, - "" + " extends ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.Embeddable", + "text": "Embeddable" + }, + " implements ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IContainer", + "text": "IContainer" + }, + "" ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.AttributeService.Unnamed", + "id": "def-public.Container.isContainer", + "type": "boolean", + "tags": [], + "label": "isContainer", + "description": [], + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.Container.children", + "type": "Object", + "tags": [], + "label": "children", + "description": [], + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "deprecated": false, + "trackAdoption": false, + "children": [] + }, + { + "parentPluginId": "embeddable", + "id": "def-public.Container.Unnamed", "type": "Function", "tags": [], "label": "Constructor", @@ -463,79 +435,57 @@ "signature": [ "any" ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.AttributeService.Unnamed.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "embeddable", - "id": "def-public.AttributeService.Unnamed.$2", - "type": "Object", + "id": "def-public.Container.Unnamed.$1", + "type": "Uncategorized", "tags": [], - "label": "toasts", + "label": "input", "description": [], "signature": [ - { - "pluginId": "@kbn/core-notifications-browser", - "scope": "common", - "docId": "kibKbnCoreNotificationsBrowserPluginApi", - "section": "def-common.IToasts", - "text": "IToasts" - } + "TContainerInput" ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "embeddable", - "id": "def-public.AttributeService.Unnamed.$3", - "type": "Object", + "id": "def-public.Container.Unnamed.$2", + "type": "Uncategorized", "tags": [], - "label": "options", + "label": "output", "description": [], "signature": [ - "AttributeServiceOptions", - "" + "TContainerOutput" ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "embeddable", - "id": "def-public.AttributeService.Unnamed.$4", + "id": "def-public.Container.Unnamed.$3", "type": "Function", "tags": [], - "label": "getEmbeddableFactory", + "label": "getFactory", "description": [], "signature": [ - "((embeddableFactoryId: string) => ", + " = ", { "pluginId": "embeddable", - "scope": "common", + "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" }, - ", ", + ">(embeddableFactoryId: string) => ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" + "section": "def-public.EmbeddableFactory", + "text": "EmbeddableFactory" }, - ", any>, unknown>) | undefined" + " | undefined" ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, "trackAdoption": false, - "isRequired": false - } - ], - "returnComment": [] - }, - { - "parentPluginId": "embeddable", - "id": "def-public.AttributeService.unwrapAttributes", - "type": "Function", - "tags": [], - "label": "unwrapAttributes", - "description": [], - "signature": [ - "(input: ValType | RefType) => Promise<", - "AttributeServiceUnwrapResult", - ">" - ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ + "isRequired": true + }, { "parentPluginId": "embeddable", - "id": "def-public.AttributeService.unwrapAttributes.$1", - "type": "CompoundType", + "id": "def-public.Container.Unnamed.$4", + "type": "Object", "tags": [], - "label": "input", + "label": "parent", "description": [], "signature": [ - "ValType | RefType" - ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "embeddable", - "id": "def-public.AttributeService.wrapAttributes", - "type": "Function", - "tags": [], - "label": "wrapAttributes", - "description": [], - "signature": [ - "(newAttributes: SavedObjectAttributes, useRefType: boolean, input?: ValType | RefType | undefined) => Promise>" - ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.AttributeService.wrapAttributes.$1", - "type": "Uncategorized", - "tags": [], - "label": "newAttributes", - "description": [], - "signature": [ - "SavedObjectAttributes" - ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "embeddable", - "id": "def-public.AttributeService.wrapAttributes.$2", - "type": "boolean", - "tags": [], - "label": "useRefType", - "description": [], - "signature": [ - "boolean" + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IContainer", + "text": "IContainer" + }, + "<{}, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerInput", + "text": "ContainerInput" + }, + "<{}>, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerOutput", + "text": "ContainerOutput" + }, + "> | undefined" ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, "trackAdoption": false, - "isRequired": true + "isRequired": false }, { "parentPluginId": "embeddable", - "id": "def-public.AttributeService.wrapAttributes.$3", - "type": "CompoundType", + "id": "def-public.Container.Unnamed.$5", + "type": "Object", "tags": [], - "label": "input", + "label": "settings", "description": [], "signature": [ - "ValType | RefType | undefined" + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableContainerSettings", + "text": "EmbeddableContainerSettings" + }, + " | undefined" ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, "trackAdoption": false, "isRequired": false @@ -683,61 +605,76 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.AttributeService.inputIsRefType", + "id": "def-public.Container.setChildLoaded", "type": "Function", "tags": [], - "label": "inputIsRefType", + "label": "setChildLoaded", "description": [], "signature": [ - "(input: ValType | RefType) => input is RefType" - ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ + "(embeddable: ", { - "parentPluginId": "embeddable", - "id": "def-public.AttributeService.inputIsRefType.$1", - "type": "CompoundType", - "tags": [], - "label": "input", - "description": [], - "signature": [ - "ValType | RefType" - ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "embeddable", - "id": "def-public.AttributeService.getInputAsValueType", - "type": "Function", - "tags": [], - "label": "getInputAsValueType", - "description": [], - "signature": [ - "(input: ValType | RefType) => Promise" + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + }, + ", any>) => void" ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.AttributeService.getInputAsValueType.$1", - "type": "CompoundType", + "id": "def-public.Container.setChildLoaded.$1", + "type": "Object", "tags": [], - "label": "input", + "label": "embeddable", "description": [], "signature": [ - "ValType | RefType" + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + }, + ", any>" ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -747,123 +684,148 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.AttributeService.getInputAsRefType", + "id": "def-public.Container.updateInputForChild", "type": "Function", "tags": [], - "label": "getInputAsRefType", + "label": "updateInputForChild", "description": [], "signature": [ - "(input: ValType | RefType, saveOptions?: { showSaveModal: boolean; saveModalTitle?: string | undefined; } | { title: string; } | undefined) => Promise" + "(id: string, changes: Partial) => void" ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.AttributeService.getInputAsRefType.$1", - "type": "CompoundType", + "id": "def-public.Container.updateInputForChild.$1", + "type": "string", "tags": [], - "label": "input", + "label": "id", "description": [], "signature": [ - "ValType | RefType" + "string" ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "embeddable", - "id": "def-public.AttributeService.getInputAsRefType.$2", - "type": "CompoundType", + "id": "def-public.Container.updateInputForChild.$2", + "type": "Object", "tags": [], - "label": "saveOptions", + "label": "changes", "description": [], "signature": [ - "{ showSaveModal: boolean; saveModalTitle?: string | undefined; } | { title: string; } | undefined" + "Partial" ], - "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", + "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, "trackAdoption": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Container", - "type": "Class", - "tags": [], - "label": "Container", - "description": [], - "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.Container", - "text": "Container" }, - " extends ", { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.Embeddable", - "text": "Embeddable" - }, - " implements ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IContainer", - "text": "IContainer" - }, - "" - ], - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.Container.isContainer", - "type": "boolean", - "tags": [], - "label": "isContainer", - "description": [], - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Container.children", - "type": "Object", - "tags": [], - "label": "children", - "description": [], - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "deprecated": false, - "trackAdoption": false, - "children": [] + "parentPluginId": "embeddable", + "id": "def-public.Container.reload", + "type": "Function", + "tags": [], + "label": "reload", + "description": [], + "signature": [ + "() => void" + ], + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "embeddable", - "id": "def-public.Container.Unnamed", + "id": "def-public.Container.addNewEmbeddable", "type": "Function", "tags": [], - "label": "Constructor", + "label": "addNewEmbeddable", "description": [], "signature": [ - "any" + " = ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + ">(type: string, explicitInput: Partial) => Promise<", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ErrorEmbeddable", + "text": "ErrorEmbeddable" + }, + " | E>" ], "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, @@ -871,13 +833,13 @@ "children": [ { "parentPluginId": "embeddable", - "id": "def-public.Container.Unnamed.$1", - "type": "Uncategorized", + "id": "def-public.Container.addNewEmbeddable.$1", + "type": "string", "tags": [], - "label": "input", + "label": "type", "description": [], "signature": [ - "TContainerInput" + "string" ], "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, @@ -886,84 +848,93 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.Container.Unnamed.$2", - "type": "Uncategorized", + "id": "def-public.Container.addNewEmbeddable.$2", + "type": "Object", "tags": [], - "label": "output", + "label": "explicitInput", "description": [], "signature": [ - "TContainerOutput" + "Partial" ], "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, "trackAdoption": false, "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "embeddable", + "id": "def-public.Container.replaceEmbeddable", + "type": "Function", + "tags": [], + "label": "replaceEmbeddable", + "description": [], + "signature": [ + " = ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" }, + ">(id: string, newExplicitInput: Partial, newType?: string | undefined) => Promise" + ], + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "embeddable", - "id": "def-public.Container.Unnamed.$3", - "type": "Function", + "id": "def-public.Container.replaceEmbeddable.$1", + "type": "string", "tags": [], - "label": "getFactory", + "label": "id", "description": [], "signature": [ - " = ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - ">(embeddableFactoryId: string) => ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableFactory", - "text": "EmbeddableFactory" - }, - " | undefined" + "string" ], "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, @@ -972,58 +943,28 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.Container.Unnamed.$4", + "id": "def-public.Container.replaceEmbeddable.$2", "type": "Object", "tags": [], - "label": "parent", + "label": "newExplicitInput", "description": [], "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IContainer", - "text": "IContainer" - }, - "<{}, ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerInput", - "text": "ContainerInput" - }, - "<{}>, ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerOutput", - "text": "ContainerOutput" - }, - "> | undefined" + "Partial" ], "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, "trackAdoption": false, - "isRequired": false + "isRequired": true }, { "parentPluginId": "embeddable", - "id": "def-public.Container.Unnamed.$5", - "type": "Object", + "id": "def-public.Container.replaceEmbeddable.$3", + "type": "string", "tags": [], - "label": "settings", + "label": "newType", "description": [], "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableContainerSettings", - "text": "EmbeddableContainerSettings" - }, - " | undefined" + "string | undefined" ], "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, @@ -1035,37 +976,13 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.Container.setChildLoaded", + "id": "def-public.Container.removeEmbeddable", "type": "Function", "tags": [], - "label": "setChildLoaded", + "label": "removeEmbeddable", "description": [], "signature": [ - "(embeddable: ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - "<", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - }, - ", ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" - }, - ", any>) => void" + "(embeddableId: string) => void" ], "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, @@ -1073,36 +990,13 @@ "children": [ { "parentPluginId": "embeddable", - "id": "def-public.Container.setChildLoaded.$1", - "type": "Object", + "id": "def-public.Container.removeEmbeddable.$1", + "type": "string", "tags": [], - "label": "embeddable", + "label": "embeddableId", "description": [], "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - "<", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - }, - ", ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" - }, - ", any>" + "string" ], "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, @@ -1114,21 +1008,23 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.Container.updateInputForChild", + "id": "def-public.Container.onRemoveEmbeddable", "type": "Function", "tags": [], - "label": "updateInputForChild", - "description": [], + "label": "onRemoveEmbeddable", + "description": [ + "\nControl the panels that are pushed to the input stream when an embeddable is\nremoved. This can be used if removing one embeddable has knock-on effects, like\nre-ordering embeddables that come after it." + ], "signature": [ - " { [key: string]: ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" + "section": "def-common.PanelState", + "text": "PanelState" }, - " = ", + "<", { "pluginId": "embeddable", "scope": "common", @@ -1136,7 +1032,7 @@ "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, - ">(id: string, changes: Partial) => void" + " & { id: string; }>; }" ], "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, @@ -1144,10 +1040,10 @@ "children": [ { "parentPluginId": "embeddable", - "id": "def-public.Container.updateInputForChild.$1", + "id": "def-public.Container.onRemoveEmbeddable.$1", "type": "string", "tags": [], - "label": "id", + "label": "embeddableId", "description": [], "signature": [ "string" @@ -1156,34 +1052,19 @@ "deprecated": false, "trackAdoption": false, "isRequired": true - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Container.updateInputForChild.$2", - "type": "Object", - "tags": [], - "label": "changes", - "description": [], - "signature": [ - "Partial" - ], - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "embeddable", - "id": "def-public.Container.reload", + "id": "def-public.Container.getChildIds", "type": "Function", "tags": [], - "label": "reload", + "label": "getChildIds", "description": [], "signature": [ - "() => void" + "() => string[]" ], "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, @@ -1193,21 +1074,21 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.Container.addNewEmbeddable", + "id": "def-public.Container.getChild", "type": "Function", "tags": [], - "label": "addNewEmbeddable", + "label": "getChild", "description": [], "signature": [ - " = ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - ">(type: string, explicitInput: Partial) => Promise<", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ErrorEmbeddable", - "text": "ErrorEmbeddable" - }, - " | E>" + ", any>>(id: string) => E" ], "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, @@ -1263,10 +1112,10 @@ "children": [ { "parentPluginId": "embeddable", - "id": "def-public.Container.addNewEmbeddable.$1", + "id": "def-public.Container.getChild.$1", "type": "string", "tags": [], - "label": "type", + "label": "id", "description": [], "signature": [ "string" @@ -1275,34 +1124,19 @@ "deprecated": false, "trackAdoption": false, "isRequired": true - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Container.addNewEmbeddable.$2", - "type": "Object", - "tags": [], - "label": "explicitInput", - "description": [], - "signature": [ - "Partial" - ], - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "embeddable", - "id": "def-public.Container.replaceEmbeddable", + "id": "def-public.Container.getInputForChild", "type": "Function", "tags": [], - "label": "replaceEmbeddable", + "label": "getInputForChild", "description": [], "signature": [ - " = ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - ">(id: string, newExplicitInput: Partial, newType?: string | undefined) => Promise" + ">(embeddableId: string) => TEmbeddableInput" ], "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, @@ -1358,242 +1160,10 @@ "children": [ { "parentPluginId": "embeddable", - "id": "def-public.Container.replaceEmbeddable.$1", + "id": "def-public.Container.getInputForChild.$1", "type": "string", "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Container.replaceEmbeddable.$2", - "type": "Object", - "tags": [], - "label": "newExplicitInput", - "description": [], - "signature": [ - "Partial" - ], - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Container.replaceEmbeddable.$3", - "type": "string", - "tags": [], - "label": "newType", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": false - } - ], - "returnComment": [] - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Container.removeEmbeddable", - "type": "Function", - "tags": [], - "label": "removeEmbeddable", - "description": [], - "signature": [ - "(embeddableId: string) => void" - ], - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.Container.removeEmbeddable.$1", - "type": "string", - "tags": [], - "label": "embeddableId", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Container.onRemoveEmbeddable", - "type": "Function", - "tags": [], - "label": "onRemoveEmbeddable", - "description": [ - "\nControl the panels that are pushed to the input stream when an embeddable is\nremoved. This can be used if removing one embeddable has knock-on effects, like\nre-ordering embeddables that come after it." - ], - "signature": [ - "(embeddableId: string) => { [key: string]: ", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.PanelState", - "text": "PanelState" - }, - "<", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - }, - " & { id: string; }>; }" - ], - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.Container.onRemoveEmbeddable.$1", - "type": "string", - "tags": [], - "label": "embeddableId", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Container.getChildIds", - "type": "Function", - "tags": [], - "label": "getChildIds", - "description": [], - "signature": [ - "() => string[]" - ], - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Container.getChild", - "type": "Function", - "tags": [], - "label": "getChild", - "description": [], - "signature": [ - ">(id: string) => E" - ], - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.Container.getChild.$1", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Container.getInputForChild", - "type": "Function", - "tags": [], - "label": "getInputForChild", - "description": [], - "signature": [ - "(embeddableId: string) => TEmbeddableInput" - ], - "path": "src/plugins/embeddable/public/lib/containers/container.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.Container.getInputForChild.$1", - "type": "string", - "tags": [], - "label": "embeddableId", + "label": "embeddableId", "description": [], "signature": [ "string" @@ -2035,18 +1605,18 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction", + "id": "def-public.CustomizePanelAction", "type": "Class", "tags": [], - "label": "EditPanelAction", + "label": "CustomizePanelAction", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.EditPanelAction", - "text": "EditPanelAction" + "section": "def-public.CustomizePanelAction", + "text": "CustomizePanelAction" }, " implements ", { @@ -2056,204 +1626,130 @@ "section": "def-public.Action", "text": "Action" }, - "" + "<", + "CustomizePanelActionContext", + ">" ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.type", + "id": "def-public.CustomizePanelAction.type", "type": "string", "tags": [], "label": "type", "description": [], - "signature": [ - "\"editPanel\"" - ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.id", + "id": "def-public.CustomizePanelAction.id", "type": "string", "tags": [], "label": "id", "description": [], - "signature": [ - "\"editPanel\"" - ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.order", + "id": "def-public.CustomizePanelAction.order", "type": "number", "tags": [], "label": "order", "description": [], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.currentAppId", - "type": "string", + "id": "def-public.CustomizePanelAction.Unnamed", + "type": "Function", "tags": [], - "label": "currentAppId", + "label": "Constructor", "description": [], "signature": [ - "string | undefined" + "any" ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.Unnamed.$1", - "type": "Function", + "id": "def-public.CustomizePanelAction.Unnamed.$1", + "type": "Object", "tags": [], - "label": "getEmbeddableFactory", + "label": "overlays", "description": [], "signature": [ - " = ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - ">(embeddableFactoryId: string) => ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableFactory", - "text": "EmbeddableFactory" - }, - " | undefined" + "docId": "kibKbnCoreOverlaysBrowserPluginApi", + "section": "def-common.OverlayStart", + "text": "OverlayStart" + } ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.Unnamed.$2", + "id": "def-public.CustomizePanelAction.Unnamed.$2", "type": "Object", "tags": [], - "label": "application", + "label": "theme", "description": [], "signature": [ { - "pluginId": "@kbn/core-application-browser", + "pluginId": "@kbn/core-theme-browser", "scope": "common", - "docId": "kibKbnCoreApplicationBrowserPluginApi", - "section": "def-common.ApplicationStart", - "text": "ApplicationStart" + "docId": "kibKbnCoreThemeBrowserPluginApi", + "section": "def-common.ThemeServiceStart", + "text": "ThemeServiceStart" } ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.Unnamed.$3", - "type": "Object", + "id": "def-public.CustomizePanelAction.Unnamed.$3", + "type": "Array", "tags": [], - "label": "stateTransfer", + "label": "commonlyUsedRanges", "description": [], "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableStateTransfer", - "text": "EmbeddableStateTransfer" - }, - " | undefined" + "CommonlyUsedRange", + "[] | undefined" ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false, "isRequired": false }, { "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.Unnamed.$4", - "type": "Function", + "id": "def-public.CustomizePanelAction.Unnamed.$4", + "type": "string", "tags": [], - "label": "getOriginatingPath", + "label": "dateFormat", "description": [], "signature": [ - "(() => string) | undefined" + "string | undefined" ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false, "isRequired": false @@ -2263,29 +1759,31 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.getDisplayName", + "id": "def-public.CustomizePanelAction.isTimeRangeCompatible", "type": "Function", "tags": [], - "label": "getDisplayName", + "label": "isTimeRangeCompatible", "description": [], "signature": [ - "({ embeddable }: ActionContext) => any" + "({ embeddable }: ", + "CustomizePanelActionContext", + ") => boolean" ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.getDisplayName.$1", + "id": "def-public.CustomizePanelAction.isTimeRangeCompatible.$1", "type": "Object", "tags": [], "label": "{ embeddable }", "description": [], "signature": [ - "ActionContext" + "CustomizePanelActionContext" ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -2295,45 +1793,31 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.getIconType", - "type": "Function", - "tags": [], - "label": "getIconType", - "description": [], - "signature": [ - "() => string" - ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", - "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.isCompatible", + "id": "def-public.CustomizePanelAction.getDisplayName", "type": "Function", "tags": [], - "label": "isCompatible", + "label": "getDisplayName", "description": [], "signature": [ - "({ embeddable }: ActionContext) => Promise" + "({ embeddable }: ", + "CustomizePanelActionContext", + ") => string" ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.isCompatible.$1", + "id": "def-public.CustomizePanelAction.getDisplayName.$1", "type": "Object", "tags": [], "label": "{ embeddable }", "description": [], "signature": [ - "ActionContext" + "CustomizePanelActionContext" ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -2343,61 +1827,47 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.execute", + "id": "def-public.CustomizePanelAction.getIconType", "type": "Function", "tags": [], - "label": "execute", + "label": "getIconType", "description": [], "signature": [ - "(context: ActionContext) => Promise" + "() => string" ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false, - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.execute.$1", - "type": "Object", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "ActionContext" - ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], + "children": [], "returnComment": [] }, { "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.getAppTarget", + "id": "def-public.CustomizePanelAction.isCompatible", "type": "Function", "tags": [], - "label": "getAppTarget", + "label": "isCompatible", "description": [], "signature": [ - "({ embeddable }: ActionContext) => NavigationContext | undefined" + "({ embeddable }: ", + "CustomizePanelActionContext", + ") => Promise" ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.getAppTarget.$1", + "id": "def-public.CustomizePanelAction.isCompatible.$1", "type": "Object", "tags": [], "label": "{ embeddable }", "description": [], "signature": [ - "ActionContext" + "CustomizePanelActionContext" ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -2407,29 +1877,31 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.getHref", + "id": "def-public.CustomizePanelAction.execute", "type": "Function", "tags": [], - "label": "getHref", + "label": "execute", "description": [], "signature": [ - "({ embeddable }: ActionContext) => Promise" + "({ embeddable }: ", + "CustomizePanelActionContext", + ") => Promise" ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.EditPanelAction.getHref.$1", + "id": "def-public.CustomizePanelAction.execute.$1", "type": "Object", "tags": [], "label": "{ embeddable }", "description": [], "signature": [ - "ActionContext" + "CustomizePanelActionContext" ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -2442,287 +1914,225 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable", + "id": "def-public.EditPanelAction", "type": "Class", "tags": [], - "label": "Embeddable", + "label": "EditPanelAction", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.Embeddable", - "text": "Embeddable" + "section": "def-public.EditPanelAction", + "text": "EditPanelAction" }, - " implements ", + " implements ", { - "pluginId": "embeddable", + "pluginId": "uiActions", "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" + "docId": "kibUiActionsPluginApi", + "section": "def-public.Action", + "text": "Action" }, - "" + "" ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.runtimeId", - "type": "number", - "tags": [], - "label": "runtimeId", - "description": [], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Embeddable.runtimeId", - "type": "number", + "id": "def-public.EditPanelAction.type", + "type": "string", "tags": [], - "label": "runtimeId", + "label": "type", "description": [], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "signature": [ + "\"editPanel\"" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.parent", - "type": "Object", + "id": "def-public.EditPanelAction.id", + "type": "string", "tags": [], - "label": "parent", + "label": "id", "description": [], "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IContainer", - "text": "IContainer" - }, - "<{}, ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerInput", - "text": "ContainerInput" - }, - "<{}>, ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerOutput", - "text": "ContainerOutput" - }, - "> | undefined" + "\"editPanel\"" ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.isContainer", - "type": "boolean", + "id": "def-public.EditPanelAction.order", + "type": "number", "tags": [], - "label": "isContainer", + "label": "order", "description": [], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.deferEmbeddableLoad", - "type": "boolean", + "id": "def-public.EditPanelAction.currentAppId", + "type": "string", "tags": [], - "label": "deferEmbeddableLoad", + "label": "currentAppId", "description": [], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "signature": [ + "string | undefined" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Embeddable.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Embeddable.fatalError", - "type": "Object", - "tags": [], - "label": "fatalError", - "description": [], - "signature": [ - "Error | undefined" - ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Embeddable.output", - "type": "Uncategorized", - "tags": [], - "label": "output", - "description": [], - "signature": [ - "TEmbeddableOutput" - ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Embeddable.input", - "type": "Uncategorized", - "tags": [], - "label": "input", - "description": [], - "signature": [ - "TEmbeddableInput" - ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Embeddable.renderComplete", - "type": "Object", - "tags": [], - "label": "renderComplete", - "description": [], - "signature": [ - { - "pluginId": "kibanaUtils", - "scope": "public", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-public.RenderCompleteDispatcher", - "text": "RenderCompleteDispatcher" - } - ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Embeddable.destroyed", - "type": "boolean", - "tags": [], - "label": "destroyed", - "description": [], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Embeddable.Unnamed", - "type": "Function", + "id": "def-public.EditPanelAction.Unnamed", + "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.Unnamed.$1", - "type": "Uncategorized", + "id": "def-public.EditPanelAction.Unnamed.$1", + "type": "Function", "tags": [], - "label": "input", + "label": "getEmbeddableFactory", "description": [], "signature": [ - "TEmbeddableInput" + " = ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + ">(embeddableFactoryId: string) => ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableFactory", + "text": "EmbeddableFactory" + }, + " | undefined" ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.Unnamed.$2", - "type": "Uncategorized", + "id": "def-public.EditPanelAction.Unnamed.$2", + "type": "Object", "tags": [], - "label": "output", + "label": "application", "description": [], "signature": [ - "TEmbeddableOutput" + { + "pluginId": "@kbn/core-application-browser", + "scope": "common", + "docId": "kibKbnCoreApplicationBrowserPluginApi", + "section": "def-common.ApplicationStart", + "text": "ApplicationStart" + } ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.Unnamed.$3", + "id": "def-public.EditPanelAction.Unnamed.$3", "type": "Object", "tags": [], - "label": "parent", + "label": "stateTransfer", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.IContainer", - "text": "IContainer" - }, - "<{}, ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerInput", - "text": "ContainerInput" - }, - "<{}>, ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerOutput", - "text": "ContainerOutput" + "section": "def-public.EmbeddableStateTransfer", + "text": "EmbeddableStateTransfer" }, - "> | undefined" + " | undefined" ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.EditPanelAction.Unnamed.$4", + "type": "Function", + "tags": [], + "label": "getOriginatingPath", + "description": [], + "signature": [ + "(() => string) | undefined" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", "deprecated": false, "trackAdoption": false, "isRequired": false @@ -2732,31 +2142,47 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.reportsEmbeddableLoad", + "id": "def-public.EditPanelAction.getDisplayName", "type": "Function", "tags": [], - "label": "reportsEmbeddableLoad", + "label": "getDisplayName", "description": [], "signature": [ - "() => boolean" + "({ embeddable }: ActionContext) => any" ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", "deprecated": false, "trackAdoption": false, - "children": [], + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.EditPanelAction.getDisplayName.$1", + "type": "Object", + "tags": [], + "label": "{ embeddable }", + "description": [], + "signature": [ + "ActionContext" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], "returnComment": [] }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.refreshInputFromParent", + "id": "def-public.EditPanelAction.getIconType", "type": "Function", "tags": [], - "label": "refreshInputFromParent", + "label": "getIconType", "description": [], "signature": [ - "() => void" + "() => string" ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", "deprecated": false, "trackAdoption": false, "children": [], @@ -2764,451 +2190,349 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.getIsContainer", + "id": "def-public.EditPanelAction.isCompatible", "type": "Function", "tags": [], - "label": "getIsContainer", + "label": "isCompatible", "description": [], "signature": [ - "() => this is ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IContainer", - "text": "IContainer" - }, - "<{}, ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerInput", - "text": "ContainerInput" - }, - "<{}>, ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerOutput", - "text": "ContainerOutput" - }, - ">" - ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Embeddable.reload", - "type": "Function", - "tags": [], - "label": "reload", - "description": [ - "\nReload will be called when there is a request to refresh the data or view, even if the\ninput data did not change.\n\nIn case if input data did change and reload is requested input$ and output$ would still emit before `reload` is called\n\nThe order would be as follows:\ninput$\noutput$\nreload()\n----\nupdated$" - ], - "signature": [ - "() => void" + "({ embeddable }: ActionContext) => Promise" ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", "deprecated": false, "trackAdoption": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Embeddable.getUpdated$", - "type": "Function", - "tags": [], - "label": "getUpdated$", - "description": [ - "\nMerges input$ and output$ streams and debounces emit till next macro-task.\nCould be useful to batch reactions to input$ and output$ updates that happen separately but synchronously.\nIn case corresponding state change triggered `reload` this stream is guarantied to emit later,\nwhich allows to skip state handling in case `reload` already handled it." - ], - "signature": [ - "() => Readonly<", - "Observable", - ">" + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.EditPanelAction.isCompatible.$1", + "type": "Object", + "tags": [], + "label": "{ embeddable }", + "description": [], + "signature": [ + "ActionContext" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [], "returnComment": [] }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.getInput$", + "id": "def-public.EditPanelAction.execute", "type": "Function", "tags": [], - "label": "getInput$", + "label": "execute", "description": [], "signature": [ - "() => Readonly<", - "Observable", - ">" + "(context: ActionContext) => Promise" ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", "deprecated": false, "trackAdoption": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Embeddable.getOutput$", - "type": "Function", - "tags": [], - "label": "getOutput$", - "description": [], - "signature": [ - "() => Readonly<", - "Observable", - ">" + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.EditPanelAction.execute.$1", + "type": "Object", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "ActionContext" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [], "returnComment": [] }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.getOutput", + "id": "def-public.EditPanelAction.getAppTarget", "type": "Function", "tags": [], - "label": "getOutput", + "label": "getAppTarget", "description": [], "signature": [ - "() => Readonly" + "({ embeddable }: ActionContext) => NavigationContext | undefined" ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", "deprecated": false, "trackAdoption": false, - "children": [], + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.EditPanelAction.getAppTarget.$1", + "type": "Object", + "tags": [], + "label": "{ embeddable }", + "description": [], + "signature": [ + "ActionContext" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], "returnComment": [] }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.getExplicitInputIsEqual", + "id": "def-public.EditPanelAction.getHref", "type": "Function", "tags": [], - "label": "getExplicitInputIsEqual", + "label": "getHref", "description": [], "signature": [ - "(lastExplicitInput: Partial) => Promise" + "({ embeddable }: ActionContext) => Promise" ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.getExplicitInputIsEqual.$1", + "id": "def-public.EditPanelAction.getHref.$1", "type": "Object", "tags": [], - "label": "lastExplicitInput", + "label": "{ embeddable }", "description": [], "signature": [ - "Partial" + "ActionContext" ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.Embeddable", + "type": "Class", + "tags": [], + "label": "Embeddable", + "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.Embeddable", + "text": "Embeddable" + }, + " implements ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" }, + "" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.getExplicitInput", - "type": "Function", + "id": "def-public.Embeddable.runtimeId", + "type": "number", "tags": [], - "label": "getExplicitInput", + "label": "runtimeId", "description": [], - "signature": [ - "() => TEmbeddableInput" - ], "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [] + "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.getPersistableInput", - "type": "Function", + "id": "def-public.Embeddable.runtimeId", + "type": "number", "tags": [], - "label": "getPersistableInput", + "label": "runtimeId", "description": [], - "signature": [ - "() => TEmbeddableInput" - ], "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [] + "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.getInput", - "type": "Function", + "id": "def-public.Embeddable.parent", + "type": "Object", "tags": [], - "label": "getInput", + "label": "parent", "description": [], "signature": [ - "() => Readonly" + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IContainer", + "text": "IContainer" + }, + "<{}, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerInput", + "text": "ContainerInput" + }, + "<{}>, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerOutput", + "text": "ContainerOutput" + }, + "> | undefined" ], "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [] + "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.getTitle", - "type": "Function", + "id": "def-public.Embeddable.isContainer", + "type": "boolean", "tags": [], - "label": "getTitle", + "label": "isContainer", "description": [], - "signature": [ - "() => string" - ], "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [] + "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.getDescription", - "type": "Function", + "id": "def-public.Embeddable.deferEmbeddableLoad", + "type": "boolean", "tags": [], - "label": "getDescription", + "label": "deferEmbeddableLoad", "description": [], - "signature": [ - "() => string" - ], "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [] + "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.getRoot", - "type": "Function", + "id": "def-public.Embeddable.type", + "type": "string", "tags": [], - "label": "getRoot", - "description": [ - "\nReturns the top most parent embeddable, or itself if this embeddable\nis not within a parent." - ], - "signature": [ - "() => ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - "<", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - }, - ", ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" - }, - ", any> | ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IContainer", - "text": "IContainer" - }, - "<{}, ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerInput", - "text": "ContainerInput" - }, - "<{}>, ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerOutput", - "text": "ContainerOutput" - }, - ">" - ], + "label": "type", + "description": [], "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [] + "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.updateInput", - "type": "Function", + "id": "def-public.Embeddable.id", + "type": "string", "tags": [], - "label": "updateInput", + "label": "id", "description": [], - "signature": [ - "(changes: Partial) => void" - ], "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.Embeddable.updateInput.$1", - "type": "Object", - "tags": [], - "label": "changes", - "description": [], - "signature": [ - "Partial" - ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] + "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.render", - "type": "Function", + "id": "def-public.Embeddable.fatalError", + "type": "Object", "tags": [], - "label": "render", + "label": "fatalError", "description": [], "signature": [ - "(el: HTMLElement) => void | TNode" + "Error | undefined" ], "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.Embeddable.render.$1", - "type": "Object", - "tags": [], - "label": "el", - "description": [], - "signature": [ - "HTMLElement" - ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] + "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.getInspectorAdapters", - "type": "Function", - "tags": [ - "return" - ], - "label": "getInspectorAdapters", - "description": [ - "\nAn embeddable can return inspector adapters if it want the inspector to be\navailable via the context menu of that panel." - ], + "id": "def-public.Embeddable.output", + "type": "Uncategorized", + "tags": [], + "label": "output", + "description": [], "signature": [ - "() => ", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" - }, - " | undefined" + "TEmbeddableOutput" ], "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [ - "Inspector adapters that will be used to open an inspector for." - ] + "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.destroy", - "type": "Function", + "id": "def-public.Embeddable.input", + "type": "Uncategorized", "tags": [], - "label": "destroy", - "description": [ - "\nCalled when this embeddable is no longer used, this should be the place for\nimplementors to add additional clean up tasks, like un-mounting and unsubscribing." - ], + "label": "input", + "description": [], "signature": [ - "() => void" + "TEmbeddableInput" ], "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [] + "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.setInitializationFinished", - "type": "Function", + "id": "def-public.Embeddable.renderComplete", + "type": "Object", "tags": [], - "label": "setInitializationFinished", - "description": [ - "\ncommunicate to the parent embeddable that this embeddable's initialization is finished.\nThis only applies to embeddables which defer their loading state with deferEmbeddableLoad." - ], + "label": "renderComplete", + "description": [], "signature": [ - "() => void" + { + "pluginId": "kibanaUtils", + "scope": "public", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-public.RenderCompleteDispatcher", + "text": "RenderCompleteDispatcher" + } ], "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [] + "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.updateOutput", + "id": "def-public.Embeddable.destroyed", + "type": "boolean", + "tags": [], + "label": "destroyed", + "description": [], + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.Embeddable.Unnamed", "type": "Function", "tags": [], - "label": "updateOutput", + "label": "Constructor", "description": [], "signature": [ - "(outputChanges: Partial) => void" + "any" ], "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, @@ -3216,212 +2540,180 @@ "children": [ { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.updateOutput.$1", - "type": "Object", + "id": "def-public.Embeddable.Unnamed.$1", + "type": "Uncategorized", "tags": [], - "label": "outputChanges", + "label": "input", "description": [], "signature": [ - "Partial" + "TEmbeddableInput" ], "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "embeddable", - "id": "def-public.Embeddable.onFatalError", - "type": "Function", - "tags": [], - "label": "onFatalError", - "description": [ - "\nCall this **only** when your embeddable has encountered a non-recoverable error; recoverable errors\nshould be handled by the individual embeddable types" - ], - "signature": [ - "(e: Error) => void" - ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ + }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.onFatalError.$1", - "type": "Object", + "id": "def-public.Embeddable.Unnamed.$2", + "type": "Uncategorized", "tags": [], - "label": "e", - "description": [ - "The fatal, unrecoverable Error that was thrown" - ], + "label": "output", + "description": [], "signature": [ - "Error" + "TEmbeddableOutput" ], "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true + }, + { + "parentPluginId": "embeddable", + "id": "def-public.Embeddable.Unnamed.$3", + "type": "Object", + "tags": [], + "label": "parent", + "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IContainer", + "text": "IContainer" + }, + "<{}, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerInput", + "text": "ContainerInput" + }, + "<{}>, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerOutput", + "text": "ContainerOutput" + }, + "> | undefined" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "embeddable", - "id": "def-public.Embeddable.supportedTriggers", + "id": "def-public.Embeddable.reportsEmbeddableLoad", "type": "Function", "tags": [], - "label": "supportedTriggers", + "label": "reportsEmbeddableLoad", "description": [], "signature": [ - "() => string[]" + "() => boolean" ], "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddableChildPanel", - "type": "Class", - "tags": [], - "label": "EmbeddableChildPanel", - "description": [ - "\nThis component can be used by embeddable containers using react to easily render children. It waits\nfor the child to be initialized, showing a loading indicator until that is complete." - ], - "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableChildPanel", - "text": "EmbeddableChildPanel" - }, - " extends React.Component<", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableChildPanelProps", - "text": "EmbeddableChildPanelProps" }, - ", State, any>" - ], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ { "parentPluginId": "embeddable", - "id": "def-public.EmbeddableChildPanel.mounted", - "type": "boolean", + "id": "def-public.Embeddable.refreshInputFromParent", + "type": "Function", "tags": [], - "label": "mounted", + "label": "refreshInputFromParent", "description": [], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "signature": [ + "() => void" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "embeddable", - "id": "def-public.EmbeddableChildPanel.embeddable", - "type": "CompoundType", + "id": "def-public.Embeddable.getIsContainer", + "type": "Function", "tags": [], - "label": "embeddable", + "label": "getIsContainer", "description": [], "signature": [ + "() => this is ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - "<", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" + "section": "def-public.IContainer", + "text": "IContainer" }, - ", ", + "<{}, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" + "section": "def-public.ContainerInput", + "text": "ContainerInput" }, - ", any> | ", + "<{}>, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.ErrorEmbeddable", - "text": "ErrorEmbeddable" - } + "section": "def-public.ContainerOutput", + "text": "ContainerOutput" + }, + ">" ], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "embeddable", - "id": "def-public.EmbeddableChildPanel.Unnamed", + "id": "def-public.Embeddable.reload", "type": "Function", "tags": [], - "label": "Constructor", - "description": [], + "label": "reload", + "description": [ + "\nReload will be called when there is a request to refresh the data or view, even if the\ninput data did not change.\n\nIn case if input data did change and reload is requested input$ and output$ would still emit before `reload` is called\n\nThe order would be as follows:\ninput$\noutput$\nreload()\n----\nupdated$" + ], "signature": [ - "any" + "() => void" ], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddableChildPanel.Unnamed.$1", - "type": "Object", - "tags": [], - "label": "props", - "description": [], - "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableChildPanelProps", - "text": "EmbeddableChildPanelProps" - } - ], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], + "children": [], "returnComment": [] }, { "parentPluginId": "embeddable", - "id": "def-public.EmbeddableChildPanel.componentDidMount", + "id": "def-public.Embeddable.getUpdated$", "type": "Function", "tags": [], - "label": "componentDidMount", - "description": [], + "label": "getUpdated$", + "description": [ + "\nMerges input$ and output$ streams and debounces emit till next macro-task.\nCould be useful to batch reactions to input$ and output$ updates that happen separately but synchronously.\nIn case corresponding state change triggered `reload` this stream is guarantied to emit later,\nwhich allows to skip state handling in case `reload` already handled it." + ], "signature": [ - "() => Promise" + "() => Readonly<", + "Observable", + ">" ], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "children": [], @@ -3429,15 +2721,17 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.EmbeddableChildPanel.componentWillUnmount", + "id": "def-public.Embeddable.getInput$", "type": "Function", "tags": [], - "label": "componentWillUnmount", + "label": "getInput$", "description": [], "signature": [ - "() => void" + "() => Readonly<", + "Observable", + ">" ], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "children": [], @@ -3445,154 +2739,129 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.EmbeddableChildPanel.render", + "id": "def-public.Embeddable.getOutput$", "type": "Function", "tags": [], - "label": "render", + "label": "getOutput$", "description": [], "signature": [ - "() => JSX.Element" + "() => Readonly<", + "Observable", + ">" ], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddableFactoryNotFoundError", - "type": "Class", - "tags": [], - "label": "EmbeddableFactoryNotFoundError", - "description": [], - "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableFactoryNotFoundError", - "text": "EmbeddableFactoryNotFoundError" }, - " extends Error" - ], - "path": "src/plugins/embeddable/public/lib/errors.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ { "parentPluginId": "embeddable", - "id": "def-public.EmbeddableFactoryNotFoundError.code", - "type": "string", + "id": "def-public.Embeddable.getOutput", + "type": "Function", "tags": [], - "label": "code", + "label": "getOutput", "description": [], - "path": "src/plugins/embeddable/public/lib/errors.ts", + "signature": [ + "() => Readonly" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, - "trackAdoption": false + "trackAdoption": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "embeddable", - "id": "def-public.EmbeddableFactoryNotFoundError.Unnamed", + "id": "def-public.Embeddable.getExplicitInputIsEqual", "type": "Function", "tags": [], - "label": "Constructor", + "label": "getExplicitInputIsEqual", "description": [], "signature": [ - "any" + "(lastExplicitInput: Partial) => Promise" ], - "path": "src/plugins/embeddable/public/lib/errors.ts", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.EmbeddableFactoryNotFoundError.Unnamed.$1", - "type": "string", + "id": "def-public.Embeddable.getExplicitInputIsEqual.$1", + "type": "Object", "tags": [], - "label": "type", + "label": "lastExplicitInput", "description": [], "signature": [ - "string" + "Partial" ], - "path": "src/plugins/embeddable/public/lib/errors.ts", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddablePanel", - "type": "Class", - "tags": [], - "label": "EmbeddablePanel", - "description": [], - "signature": [ + }, { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddablePanel", - "text": "EmbeddablePanel" + "parentPluginId": "embeddable", + "id": "def-public.Embeddable.getExplicitInput", + "type": "Function", + "tags": [], + "label": "getExplicitInput", + "description": [], + "signature": [ + "() => TEmbeddableInput" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] }, - " extends React.Component" - ], - "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ { "parentPluginId": "embeddable", - "id": "def-public.EmbeddablePanel.Unnamed", + "id": "def-public.Embeddable.getPersistableInput", "type": "Function", "tags": [], - "label": "Constructor", + "label": "getPersistableInput", "description": [], "signature": [ - "any" + "() => TEmbeddableInput" ], - "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddablePanel.Unnamed.$1", - "type": "Object", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "Props" - ], - "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "embeddable", + "id": "def-public.Embeddable.getInput", + "type": "Function", + "tags": [], + "label": "getInput", + "description": [], + "signature": [ + "() => Readonly" ], + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [], "returnComment": [] }, { "parentPluginId": "embeddable", - "id": "def-public.EmbeddablePanel.UNSAFE_componentWillMount", + "id": "def-public.Embeddable.getTitle", "type": "Function", "tags": [], - "label": "UNSAFE_componentWillMount", + "label": "getTitle", "description": [], "signature": [ - "() => void" + "() => string" ], - "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "children": [], @@ -3600,15 +2869,81 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.EmbeddablePanel.componentWillUnmount", + "id": "def-public.Embeddable.getDescription", "type": "Function", "tags": [], - "label": "componentWillUnmount", + "label": "getDescription", "description": [], "signature": [ - "() => void" + "() => string" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "embeddable", + "id": "def-public.Embeddable.getRoot", + "type": "Function", + "tags": [], + "label": "getRoot", + "description": [ + "\nReturns the top most parent embeddable, or itself if this embeddable\nis not within a parent." + ], + "signature": [ + "() => ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + }, + ", any> | ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IContainer", + "text": "IContainer" + }, + "<{}, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerInput", + "text": "ContainerInput" + }, + "<{}>, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerOutput", + "text": "ContainerOutput" + }, + ">" ], - "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "children": [], @@ -3616,29 +2951,29 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.EmbeddablePanel.onFocus", + "id": "def-public.Embeddable.updateInput", "type": "Function", "tags": [], - "label": "onFocus", + "label": "updateInput", "description": [], "signature": [ - "(focusedPanelIndex: string) => void" + "(changes: Partial) => void" ], - "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.EmbeddablePanel.onFocus.$1", - "type": "string", + "id": "def-public.Embeddable.updateInput.$1", + "type": "Object", "tags": [], - "label": "focusedPanelIndex", + "label": "changes", "description": [], "signature": [ - "string" + "Partial" ], - "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -3648,29 +2983,29 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.EmbeddablePanel.onBlur", + "id": "def-public.Embeddable.render", "type": "Function", "tags": [], - "label": "onBlur", + "label": "render", "description": [], "signature": [ - "(blurredPanelIndex: string) => void" + "(el: HTMLElement) => void | TNode" ], - "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.EmbeddablePanel.onBlur.$1", - "type": "string", + "id": "def-public.Embeddable.render.$1", + "type": "Object", "tags": [], - "label": "blurredPanelIndex", + "label": "el", "description": [], "signature": [ - "string" + "HTMLElement" ], - "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -3680,31 +3015,47 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.EmbeddablePanel.render", + "id": "def-public.Embeddable.getInspectorAdapters", "type": "Function", - "tags": [], - "label": "render", - "description": [], + "tags": [ + "return" + ], + "label": "getInspectorAdapters", + "description": [ + "\nAn embeddable can return inspector adapters if it want the inspector to be\navailable via the context menu of that panel." + ], "signature": [ - "() => JSX.Element" + "() => ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + " | undefined" ], - "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "children": [], - "returnComment": [] + "returnComment": [ + "Inspector adapters that will be used to open an inspector for." + ] }, { "parentPluginId": "embeddable", - "id": "def-public.EmbeddablePanel.componentDidMount", + "id": "def-public.Embeddable.destroy", "type": "Function", "tags": [], - "label": "componentDidMount", - "description": [], + "label": "destroy", + "description": [ + "\nCalled when this embeddable is no longer used, this should be the place for\nimplementors to add additional clean up tasks, like un-mounting and unsubscribing." + ], "signature": [ "() => void" ], - "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "children": [], @@ -3712,69 +3063,47 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.EmbeddablePanel.closeMyContextMenuPanel", + "id": "def-public.Embeddable.setInitializationFinished", "type": "Function", "tags": [], - "label": "closeMyContextMenuPanel", - "description": [], + "label": "setInitializationFinished", + "description": [ + "\ncommunicate to the parent embeddable that this embeddable's initialization is finished.\nThis only applies to embeddables which defer their loading state with deferEmbeddableLoad." + ], "signature": [ "() => void" ], - "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddableRoot", - "type": "Class", - "tags": [], - "label": "EmbeddableRoot", - "description": [], - "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableRoot", - "text": "EmbeddableRoot" }, - " extends React.Component" - ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ { "parentPluginId": "embeddable", - "id": "def-public.EmbeddableRoot.Unnamed", + "id": "def-public.Embeddable.updateOutput", "type": "Function", "tags": [], - "label": "Constructor", + "label": "updateOutput", "description": [], "signature": [ - "any" + "(outputChanges: Partial) => void" ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.EmbeddableRoot.Unnamed.$1", + "id": "def-public.Embeddable.updateOutput.$1", "type": "Object", "tags": [], - "label": "props", + "label": "outputChanges", "description": [], "signature": [ - "Props" + "Partial" ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -3784,26 +3113,201 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.EmbeddableRoot.componentDidMount", + "id": "def-public.Embeddable.onFatalError", "type": "Function", "tags": [], - "label": "componentDidMount", - "description": [], + "label": "onFatalError", + "description": [ + "\nCall this **only** when your embeddable has encountered a non-recoverable error; recoverable errors\nshould be handled by the individual embeddable types" + ], "signature": [ - "() => void" + "(e: Error) => void" ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", "deprecated": false, "trackAdoption": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddableRoot.componentDidUpdate", - "type": "Function", - "tags": [], - "label": "componentDidUpdate", + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.Embeddable.onFatalError.$1", + "type": "Object", + "tags": [], + "label": "e", + "description": [ + "The fatal, unrecoverable Error that was thrown" + ], + "signature": [ + "Error" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "embeddable", + "id": "def-public.Embeddable.supportedTriggers", + "type": "Function", + "tags": [], + "label": "supportedTriggers", + "description": [], + "signature": [ + "() => string[]" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddableFactoryNotFoundError", + "type": "Class", + "tags": [], + "label": "EmbeddableFactoryNotFoundError", + "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableFactoryNotFoundError", + "text": "EmbeddableFactoryNotFoundError" + }, + " extends Error" + ], + "path": "src/plugins/embeddable/public/lib/errors.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddableFactoryNotFoundError.code", + "type": "string", + "tags": [], + "label": "code", + "description": [], + "path": "src/plugins/embeddable/public/lib/errors.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddableFactoryNotFoundError.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/embeddable/public/lib/errors.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddableFactoryNotFoundError.Unnamed.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/embeddable/public/lib/errors.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddableRoot", + "type": "Class", + "tags": [], + "label": "EmbeddableRoot", + "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableRoot", + "text": "EmbeddableRoot" + }, + " extends React.Component" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddableRoot.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddableRoot.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "Props" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddableRoot.componentDidMount", + "type": "Function", + "tags": [], + "label": "componentDidMount", + "description": [], + "signature": [ + "() => void" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddableRoot.componentDidUpdate", + "type": "Function", + "tags": [], + "label": "componentDidUpdate", "description": [], "signature": [ "(prevProps?: Props | undefined) => void" @@ -4625,39 +4129,75 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.PanelNotFoundError", + "id": "def-public.InspectPanelAction", "type": "Class", "tags": [], - "label": "PanelNotFoundError", + "label": "InspectPanelAction", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.PanelNotFoundError", - "text": "PanelNotFoundError" + "section": "def-public.InspectPanelAction", + "text": "InspectPanelAction" }, - " extends Error" + " implements ", + { + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.Action", + "text": "Action" + }, + "" ], - "path": "src/plugins/embeddable/public/lib/errors.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/inspect_panel_action/inspect_panel_action.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.PanelNotFoundError.code", + "id": "def-public.InspectPanelAction.type", "type": "string", "tags": [], - "label": "code", + "label": "type", "description": [], - "path": "src/plugins/embeddable/public/lib/errors.ts", + "signature": [ + "\"openInspector\"" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/inspect_panel_action/inspect_panel_action.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.PanelNotFoundError.Unnamed", + "id": "def-public.InspectPanelAction.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "\"openInspector\"" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/inspect_panel_action/inspect_panel_action.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.InspectPanelAction.order", + "type": "number", + "tags": [], + "label": "order", + "description": [], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/inspect_panel_action/inspect_panel_action.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.InspectPanelAction.Unnamed", "type": "Function", "tags": [], "label": "Constructor", @@ -4665,286 +4205,410 @@ "signature": [ "any" ], - "path": "src/plugins/embeddable/public/lib/errors.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/inspect_panel_action/inspect_panel_action.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.InspectPanelAction.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "inspector", + "description": [], + "signature": [ + { + "pluginId": "inspector", + "scope": "public", + "docId": "kibInspectorPluginApi", + "section": "def-public.Start", + "text": "Start" + } + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/inspect_panel_action/inspect_panel_action.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "embeddable", + "id": "def-public.InspectPanelAction.getDisplayName", + "type": "Function", + "tags": [], + "label": "getDisplayName", + "description": [], + "signature": [ + "() => any" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/inspect_panel_action/inspect_panel_action.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] - } - ], - "initialIsOpen": false - } - ], - "functions": [ - { - "parentPluginId": "embeddable", - "id": "def-public.defaultEmbeddableFactoryProvider", - "type": "Function", - "tags": [], - "label": "defaultEmbeddableFactoryProvider", - "description": [], - "signature": [ - " = ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - ", T = ", - { - "pluginId": "@kbn/core-saved-objects-common", - "scope": "common", - "docId": "kibKbnCoreSavedObjectsCommonPluginApi", - "section": "def-common.SavedObjectAttributes", - "text": "SavedObjectAttributes" }, - ">(def: ", { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableFactoryDefinition", - "text": "EmbeddableFactoryDefinition" + "parentPluginId": "embeddable", + "id": "def-public.InspectPanelAction.getIconType", + "type": "Function", + "tags": [], + "label": "getIconType", + "description": [], + "signature": [ + "() => string" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/inspect_panel_action/inspect_panel_action.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] }, - ") => ", { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableFactory", - "text": "EmbeddableFactory" + "parentPluginId": "embeddable", + "id": "def-public.InspectPanelAction.isCompatible", + "type": "Function", + "tags": [], + "label": "isCompatible", + "description": [], + "signature": [ + "({ embeddable }: ActionContext) => Promise" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/inspect_panel_action/inspect_panel_action.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.InspectPanelAction.isCompatible.$1", + "type": "Object", + "tags": [], + "label": "{ embeddable }", + "description": [], + "signature": [ + "ActionContext" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/inspect_panel_action/inspect_panel_action.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] }, - "" - ], - "path": "src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ { "parentPluginId": "embeddable", - "id": "def-public.defaultEmbeddableFactoryProvider.$1", - "type": "CompoundType", + "id": "def-public.InspectPanelAction.execute", + "type": "Function", "tags": [], - "label": "def", + "label": "execute", "description": [], "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableFactoryDefinition", - "text": "EmbeddableFactoryDefinition" - }, - "" + "({ embeddable }: ActionContext) => Promise" ], - "path": "src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/inspect_panel_action/inspect_panel_action.ts", "deprecated": false, "trackAdoption": false, - "isRequired": true + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.InspectPanelAction.execute.$1", + "type": "Object", + "tags": [], + "label": "{ embeddable }", + "description": [], + "signature": [ + "ActionContext" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/inspect_panel_action/inspect_panel_action.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] } ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "embeddable", - "id": "def-public.EmbeddableRenderer", - "type": "Function", + "id": "def-public.PanelNotFoundError", + "type": "Class", "tags": [], - "label": "EmbeddableRenderer", - "description": [ - "\nHelper react component to render an embeddable\nCan be used if you have an embeddable object or an embeddable factory\nSupports updating input by passing `input` prop\n" - ], + "label": "PanelNotFoundError", + "description": [], "signature": [ - "(props: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableRendererProps", - "text": "EmbeddableRendererProps" + "section": "def-public.PanelNotFoundError", + "text": "PanelNotFoundError" }, - ") => JSX.Element" + " extends Error" ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx", + "path": "src/plugins/embeddable/public/lib/errors.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.EmbeddableRenderer.$1", - "type": "CompoundType", + "id": "def-public.PanelNotFoundError.code", + "type": "string", "tags": [], - "label": "props", - "description": [ - "- {@link EmbeddableRendererProps }" - ], + "label": "code", + "description": [], + "path": "src/plugins/embeddable/public/lib/errors.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.PanelNotFoundError.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableRendererProps", - "text": "EmbeddableRendererProps" - }, - "" + "any" ], - "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx", + "path": "src/plugins/embeddable/public/lib/errors.ts", "deprecated": false, "trackAdoption": false, - "isRequired": true + "children": [], + "returnComment": [] } ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "embeddable", - "id": "def-public.genericEmbeddableInputIsEqual", - "type": "Function", + "id": "def-public.RemovePanelAction", + "type": "Class", "tags": [], - "label": "genericEmbeddableInputIsEqual", + "label": "RemovePanelAction", "description": [], "signature": [ - "(currentInput: Partial<", { "pluginId": "embeddable", - "scope": "common", + "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" + "section": "def-public.RemovePanelAction", + "text": "RemovePanelAction" }, - ">, lastInput: Partial<", + " implements ", { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" + "pluginId": "uiActions", + "scope": "public", + "docId": "kibUiActionsPluginApi", + "section": "def-public.Action", + "text": "Action" }, - ">) => boolean" + "" ], - "path": "src/plugins/embeddable/public/lib/embeddables/diff_embeddable_input.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/remove_panel_action/remove_panel_action.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.genericEmbeddableInputIsEqual.$1", - "type": "Object", + "id": "def-public.RemovePanelAction.type", + "type": "string", "tags": [], - "label": "currentInput", + "label": "type", "description": [], "signature": [ - "Partial<", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - }, - ">" + "\"deletePanel\"" ], - "path": "src/plugins/embeddable/public/lib/embeddables/diff_embeddable_input.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/remove_panel_action/remove_panel_action.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.RemovePanelAction.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "\"deletePanel\"" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/remove_panel_action/remove_panel_action.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.RemovePanelAction.order", + "type": "number", + "tags": [], + "label": "order", + "description": [], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/remove_panel_action/remove_panel_action.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.RemovePanelAction.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/remove_panel_action/remove_panel_action.ts", "deprecated": false, "trackAdoption": false, - "isRequired": true + "children": [], + "returnComment": [] }, { "parentPluginId": "embeddable", - "id": "def-public.genericEmbeddableInputIsEqual.$2", - "type": "Object", + "id": "def-public.RemovePanelAction.getDisplayName", + "type": "Function", "tags": [], - "label": "lastInput", + "label": "getDisplayName", "description": [], "signature": [ - "Partial<", + "() => any" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/remove_panel_action/remove_panel_action.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "embeddable", + "id": "def-public.RemovePanelAction.getIconType", + "type": "Function", + "tags": [], + "label": "getIconType", + "description": [], + "signature": [ + "() => string" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/remove_panel_action/remove_panel_action.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "embeddable", + "id": "def-public.RemovePanelAction.isCompatible", + "type": "Function", + "tags": [], + "label": "isCompatible", + "description": [], + "signature": [ + "({ embeddable }: ActionContext) => Promise" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/remove_panel_action/remove_panel_action.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - }, - ">" + "parentPluginId": "embeddable", + "id": "def-public.RemovePanelAction.isCompatible.$1", + "type": "Object", + "tags": [], + "label": "{ embeddable }", + "description": [], + "signature": [ + "ActionContext" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/remove_panel_action/remove_panel_action.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } ], - "path": "src/plugins/embeddable/public/lib/embeddables/diff_embeddable_input.ts", + "returnComment": [] + }, + { + "parentPluginId": "embeddable", + "id": "def-public.RemovePanelAction.execute", + "type": "Function", + "tags": [], + "label": "execute", + "description": [], + "signature": [ + "({ embeddable }: ActionContext) => Promise" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/remove_panel_action/remove_panel_action.ts", "deprecated": false, "trackAdoption": false, - "isRequired": true + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.RemovePanelAction.execute.$1", + "type": "Object", + "tags": [], + "label": "{ embeddable }", + "description": [], + "signature": [ + "ActionContext" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/remove_panel_action/remove_panel_action.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] } ], - "returnComment": [], "initialIsOpen": false - }, + } + ], + "functions": [ { "parentPluginId": "embeddable", - "id": "def-public.isContextMenuTriggerContext", + "id": "def-public.defaultEmbeddableFactoryProvider", "type": "Function", "tags": [], - "label": "isContextMenuTriggerContext", + "label": "defaultEmbeddableFactoryProvider", "description": [], "signature": [ - "(context: unknown) => context is ", + " = ", { "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + ", T = ", + { + "pluginId": "@kbn/core-saved-objects-common", "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectAttributes", + "text": "SavedObjectAttributes" + }, + ">(def: ", + { + "pluginId": "embeddable", + "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" + "section": "def-public.EmbeddableFactoryDefinition", + "text": "EmbeddableFactoryDefinition" }, - ", ", + ") => ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" + "section": "def-public.EmbeddableFactory", + "text": "EmbeddableFactory" }, - ", any>>" + "" ], - "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "path": "src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.isContextMenuTriggerContext.$1", - "type": "Unknown", + "id": "def-public.defaultEmbeddableFactoryProvider.$1", + "type": "CompoundType", "tags": [], - "label": "context", + "label": "def", "description": [], "signature": [ - "unknown" + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableFactoryDefinition", + "text": "EmbeddableFactoryDefinition" + }, + "" ], - "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "path": "src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -4995,53 +4682,33 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.isEmbeddable", + "id": "def-public.EmbeddablePanel", "type": "Function", "tags": [], - "label": "isEmbeddable", - "description": [], + "label": "EmbeddablePanel", + "description": [ + "\nLoads and renders an embeddable." + ], "signature": [ - "(x: unknown) => x is ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - "<", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - }, - ", ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" - }, - ", any>" + "(props: ", + "EmbeddablePanelProps", + ") => JSX.Element" ], - "path": "src/plugins/embeddable/public/lib/embeddables/is_embeddable.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/index.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.isEmbeddable.$1", - "type": "Unknown", + "id": "def-public.EmbeddablePanel.$1", + "type": "Object", "tags": [], - "label": "x", + "label": "props", "description": [], "signature": [ - "unknown" + "EmbeddablePanelProps" ], - "path": "src/plugins/embeddable/public/lib/embeddables/is_embeddable.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/index.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -5052,44 +4719,56 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.isErrorEmbeddable", + "id": "def-public.EmbeddableRenderer", "type": "Function", "tags": [], - "label": "isErrorEmbeddable", - "description": [], + "label": "EmbeddableRenderer", + "description": [ + "\nHelper react component to render an embeddable\nCan be used if you have an embeddable object or an embeddable factory\nSupports updating input by passing `input` prop\n" + ], "signature": [ - "(embeddable: ", + "(props: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.ErrorEmbeddable", - "text": "ErrorEmbeddable" + "section": "def-public.EmbeddableRendererProps", + "text": "EmbeddableRendererProps" }, - " | TEmbeddable) => boolean" + ") => JSX.Element" ], - "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.isErrorEmbeddable.$1", + "id": "def-public.EmbeddableRenderer.$1", "type": "CompoundType", "tags": [], - "label": "embeddable", - "description": [], + "label": "props", + "description": [ + "- {@link EmbeddableRendererProps }" + ], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.ErrorEmbeddable", - "text": "ErrorEmbeddable" + "section": "def-public.EmbeddableRendererProps", + "text": "EmbeddableRendererProps" }, - " | TEmbeddable" + "" ], - "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", + "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -5100,68 +4779,13 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.isFilterableEmbeddable", - "type": "Function", - "tags": [], - "label": "isFilterableEmbeddable", - "description": [ - "\nEnsure that embeddable supports filtering/querying" - ], - "signature": [ - "(incoming: unknown) => boolean" - ], - "path": "src/plugins/embeddable/public/lib/filterable_embeddable/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.isFilterableEmbeddable.$1", - "type": "Unknown", - "tags": [], - "label": "incoming", - "description": [ - "Embeddable that is being tested to check if it is a FilterableEmbeddable" - ], - "signature": [ - "unknown" - ], - "path": "src/plugins/embeddable/public/lib/filterable_embeddable/types.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [ - "true if the incoming embeddable is a FilterableEmbeddable, false if it is not" - ], - "initialIsOpen": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.isMultiValueClickTriggerContext", + "id": "def-public.genericEmbeddableInputIsEqual", "type": "Function", "tags": [], - "label": "isMultiValueClickTriggerContext", + "label": "genericEmbeddableInputIsEqual", "description": [], "signature": [ - "(context: ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ChartActionContext", - "text": "ChartActionContext" - }, - "<", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - "<", + "(currentInput: Partial<", { "pluginId": "embeddable", "scope": "common", @@ -5169,31 +4793,7 @@ "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, - ", ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" - }, - ", any>>) => context is ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.MultiValueClickContext", - "text": "MultiValueClickContext" - }, - "<", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - "<", + ">, lastInput: Partial<", { "pluginId": "embeddable", "scope": "common", @@ -5201,44 +4801,21 @@ "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, - ", ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" - }, - ", any>>" + ">) => boolean" ], - "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "path": "src/plugins/embeddable/public/lib/embeddables/diff_embeddable_input.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.isMultiValueClickTriggerContext.$1", - "type": "CompoundType", + "id": "def-public.genericEmbeddableInputIsEqual.$1", + "type": "Object", "tags": [], - "label": "context", + "label": "currentInput", "description": [], "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ChartActionContext", - "text": "ChartActionContext" - }, - "<", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - "<", + "Partial<", { "pluginId": "embeddable", "scope": "common", @@ -5246,17 +4823,32 @@ "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, - ", ", + ">" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/diff_embeddable_input.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "embeddable", + "id": "def-public.genericEmbeddableInputIsEqual.$2", + "type": "Object", + "tags": [], + "label": "lastInput", + "description": [], + "signature": [ + "Partial<", { "pluginId": "embeddable", - "scope": "public", + "scope": "common", "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" }, - ", any>>" + ">" ], - "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "path": "src/plugins/embeddable/public/lib/embeddables/diff_embeddable_input.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -5267,19 +4859,19 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.isRangeSelectTriggerContext", + "id": "def-public.isContextMenuTriggerContext", "type": "Function", "tags": [], - "label": "isRangeSelectTriggerContext", + "label": "isContextMenuTriggerContext", "description": [], "signature": [ - "(context: ", + "(context: unknown) => context is ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.ChartActionContext", - "text": "ChartActionContext" + "section": "def-public.EmbeddableContext", + "text": "EmbeddableContext" }, "<", { @@ -5305,15 +4897,40 @@ "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, - ", any>>) => context is ", + ", any>>" + ], + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.RangeSelectContext", - "text": "RangeSelectContext" - }, - "<", + "parentPluginId": "embeddable", + "id": "def-public.isContextMenuTriggerContext.$1", + "type": "Unknown", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "unknown" + ], + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.isEmbeddable", + "type": "Function", + "tags": [], + "label": "isEmbeddable", + "description": [], + "signature": [ + "(x: unknown) => x is ", { "pluginId": "embeddable", "scope": "public", @@ -5337,54 +4954,71 @@ "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, - ", any>>" + ", any>" ], - "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "path": "src/plugins/embeddable/public/lib/embeddables/is_embeddable.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.isRangeSelectTriggerContext.$1", - "type": "CompoundType", + "id": "def-public.isEmbeddable.$1", + "type": "Unknown", "tags": [], - "label": "context", + "label": "x", + "description": [], + "signature": [ + "unknown" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/is_embeddable.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.isErrorEmbeddable", + "type": "Function", + "tags": [], + "label": "isErrorEmbeddable", + "description": [], + "signature": [ + "(embeddable: ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ErrorEmbeddable", + "text": "ErrorEmbeddable" + }, + " | TEmbeddable) => boolean" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.isErrorEmbeddable.$1", + "type": "CompoundType", + "tags": [], + "label": "embeddable", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.ChartActionContext", - "text": "ChartActionContext" - }, - "<", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - "<", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - }, - ", ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" + "section": "def-public.ErrorEmbeddable", + "text": "ErrorEmbeddable" }, - ", any>>" + " | TEmbeddable" ], - "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "path": "src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -5395,43 +5029,49 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.isReferenceOrValueEmbeddable", + "id": "def-public.isFilterableEmbeddable", "type": "Function", "tags": [], - "label": "isReferenceOrValueEmbeddable", - "description": [], + "label": "isFilterableEmbeddable", + "description": [ + "\nEnsure that embeddable supports filtering/querying" + ], "signature": [ "(incoming: unknown) => boolean" ], - "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", + "path": "src/plugins/embeddable/public/lib/filterable_embeddable/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.isReferenceOrValueEmbeddable.$1", + "id": "def-public.isFilterableEmbeddable.$1", "type": "Unknown", "tags": [], "label": "incoming", - "description": [], + "description": [ + "Embeddable that is being tested to check if it is a FilterableEmbeddable" + ], "signature": [ "unknown" ], - "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", + "path": "src/plugins/embeddable/public/lib/filterable_embeddable/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], - "returnComment": [], + "returnComment": [ + "true if the incoming embeddable is a FilterableEmbeddable, false if it is not" + ], "initialIsOpen": false }, { "parentPluginId": "embeddable", - "id": "def-public.isRowClickTriggerContext", + "id": "def-public.isMultiValueClickTriggerContext", "type": "Function", "tags": [], - "label": "isRowClickTriggerContext", + "label": "isMultiValueClickTriggerContext", "description": [], "signature": [ "(context: ", @@ -5468,12 +5108,37 @@ }, ", any>>) => context is ", { - "pluginId": "@kbn/ui-actions-browser", + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.MultiValueClickContext", + "text": "MultiValueClickContext" + }, + "<", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + "<", + { + "pluginId": "embeddable", "scope": "common", - "docId": "kibKbnUiActionsBrowserPluginApi", - "section": "def-common.RowClickContext", - "text": "RowClickContext" - } + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + }, + ", any>>" ], "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "deprecated": false, @@ -5481,7 +5146,7 @@ "children": [ { "parentPluginId": "embeddable", - "id": "def-public.isRowClickTriggerContext.$1", + "id": "def-public.isMultiValueClickTriggerContext.$1", "type": "CompoundType", "tags": [], "label": "context", @@ -5531,73 +5196,10 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.isSavedObjectEmbeddableInput", - "type": "Function", - "tags": [], - "label": "isSavedObjectEmbeddableInput", - "description": [], - "signature": [ - "(input: ", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - }, - " | ", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.SavedObjectEmbeddableInput", - "text": "SavedObjectEmbeddableInput" - }, - ") => boolean" - ], - "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.isSavedObjectEmbeddableInput.$1", - "type": "CompoundType", - "tags": [], - "label": "input", - "description": [], - "signature": [ - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - }, - " | ", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.SavedObjectEmbeddableInput", - "text": "SavedObjectEmbeddableInput" - } - ], - "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.isValueClickTriggerContext", + "id": "def-public.isRangeSelectTriggerContext", "type": "Function", "tags": [], - "label": "isValueClickTriggerContext", + "label": "isRangeSelectTriggerContext", "description": [], "signature": [ "(context: ", @@ -5637,8 +5239,8 @@ "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.ValueClickContext", - "text": "ValueClickContext" + "section": "def-public.RangeSelectContext", + "text": "RangeSelectContext" }, "<", { @@ -5672,7 +5274,7 @@ "children": [ { "parentPluginId": "embeddable", - "id": "def-public.isValueClickTriggerContext.$1", + "id": "def-public.isRangeSelectTriggerContext.$1", "type": "CompoundType", "tags": [], "label": "context", @@ -5722,53 +5324,29 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.omitGenericEmbeddableInput", + "id": "def-public.isReferenceOrValueEmbeddable", "type": "Function", "tags": [], - "label": "omitGenericEmbeddableInput", + "label": "isReferenceOrValueEmbeddable", "description": [], "signature": [ - " = Partial<", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - }, - ">>(input: I) => Omit" + "(incoming: unknown) => boolean" ], - "path": "src/plugins/embeddable/public/lib/embeddables/diff_embeddable_input.ts", + "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.omitGenericEmbeddableInput.$1", - "type": "Uncategorized", + "id": "def-public.isReferenceOrValueEmbeddable.$1", + "type": "Unknown", "tags": [], - "label": "input", + "label": "incoming", "description": [], "signature": [ - "I" + "unknown" ], - "path": "src/plugins/embeddable/public/lib/embeddables/diff_embeddable_input.ts", + "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -5779,45 +5357,29 @@ }, { "parentPluginId": "embeddable", - "id": "def-public.openAddPanelFlyout", + "id": "def-public.isRowClickTriggerContext", "type": "Function", "tags": [], - "label": "openAddPanelFlyout", + "label": "isRowClickTriggerContext", "description": [], "signature": [ - "(options: { embeddable: ", + "(context: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.IContainer", - "text": "IContainer" + "section": "def-public.ChartActionContext", + "text": "ChartActionContext" }, - "<{}, ", + "<", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerInput", - "text": "ContainerInput" - }, - "<{}>, ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerOutput", - "text": "ContainerOutput" - }, - ">; getFactory: >) => context is ", { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" - }, - ", E extends ", + "pluginId": "@kbn/ui-actions-browser", + "scope": "common", + "docId": "kibKbnUiActionsBrowserPluginApi", + "section": "def-common.RowClickContext", + "text": "RowClickContext" + } + ], + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.isRowClickTriggerContext.$1", + "type": "CompoundType", + "tags": [], + "label": "context", + "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ChartActionContext", + "text": "ChartActionContext" + }, + "<", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + "<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + ", ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + }, + ", any>>" + ], + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.isSavedObjectEmbeddableInput", + "type": "Function", + "tags": [], + "label": "isSavedObjectEmbeddableInput", + "description": [], + "signature": [ + "(input: ", { "pluginId": "embeddable", - "scope": "public", + "scope": "common", "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" }, - " = ", + " | ", { "pluginId": "embeddable", - "scope": "public", + "scope": "common", "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" + "section": "def-common.SavedObjectEmbeddableInput", + "text": "SavedObjectEmbeddableInput" }, - ">(embeddableFactoryId: string) => ", + ") => boolean" + ], + "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.isSavedObjectEmbeddableInput.$1", + "type": "CompoundType", + "tags": [], + "label": "input", + "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + " | ", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.SavedObjectEmbeddableInput", + "text": "SavedObjectEmbeddableInput" + } + ], + "path": "src/plugins/embeddable/common/lib/saved_object_embeddable.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.isValueClickTriggerContext", + "type": "Function", + "tags": [], + "label": "isValueClickTriggerContext", + "description": [], + "signature": [ + "(context: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableFactory", - "text": "EmbeddableFactory" + "section": "def-public.ChartActionContext", + "text": "ChartActionContext" }, - " | undefined; getAllFactories: () => IterableIterator<", + "<", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableFactory", - "text": "EmbeddableFactory" + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" }, "<", { @@ -5889,7 +5561,15 @@ "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, - ", ", + ", any>>) => context is ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ValueClickContext", + "text": "ValueClickContext" + }, + "<", { "pluginId": "embeddable", "scope": "public", @@ -5913,338 +5593,209 @@ "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, - ", any>, unknown>>; overlays: ", - { - "pluginId": "@kbn/core-overlays-browser", - "scope": "common", - "docId": "kibKbnCoreOverlaysBrowserPluginApi", - "section": "def-common.OverlayStart", - "text": "OverlayStart" - }, - "; notifications: ", - { - "pluginId": "@kbn/core-notifications-browser", - "scope": "common", - "docId": "kibKbnCoreNotificationsBrowserPluginApi", - "section": "def-common.NotificationsStart", - "text": "NotificationsStart" - }, - "; SavedObjectFinder: React.ComponentType; showCreateNewMenu?: boolean | undefined; reportUiCounter?: ((appName: string, type: string, eventNames: string | string[], count?: number | undefined) => void) | undefined; theme: ", - { - "pluginId": "@kbn/core-theme-browser", - "scope": "common", - "docId": "kibKbnCoreThemeBrowserPluginApi", - "section": "def-common.ThemeServiceStart", - "text": "ThemeServiceStart" - }, - "; onAddPanel?: ((id: string) => void) | undefined; }) => ", - { - "pluginId": "@kbn/core-mount-utils-browser", - "scope": "common", - "docId": "kibKbnCoreMountUtilsBrowserPluginApi", - "section": "def-common.OverlayRef", - "text": "OverlayRef" - } + ", any>>" ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "embeddable", - "id": "def-public.openAddPanelFlyout.$1", - "type": "Object", + "id": "def-public.isValueClickTriggerContext.$1", + "type": "CompoundType", "tags": [], - "label": "options", + "label": "context", "description": [], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ + "signature": [ { - "parentPluginId": "embeddable", - "id": "def-public.openAddPanelFlyout.$1.embeddable", - "type": "Object", - "tags": [], - "label": "embeddable", - "description": [], - "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IContainer", - "text": "IContainer" - }, - "<{}, ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerInput", - "text": "ContainerInput" - }, - "<{}>, ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerOutput", - "text": "ContainerOutput" - }, - ">" - ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", - "deprecated": false, - "trackAdoption": false + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ChartActionContext", + "text": "ChartActionContext" }, + "<", { - "parentPluginId": "embeddable", - "id": "def-public.openAddPanelFlyout.$1.getFactory", - "type": "Function", - "tags": [], - "label": "getFactory", - "description": [], - "signature": [ - " = ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - ">(embeddableFactoryId: string) => ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableFactory", - "text": "EmbeddableFactory" - }, - " | undefined" - ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", - "deprecated": false, - "trackAdoption": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.openAddPanelFlyout.$1.getFactory.$1", - "type": "string", - "tags": [], - "label": "embeddableFactoryId", - "description": [], - "path": "src/plugins/embeddable/public/plugin.tsx", - "deprecated": false, - "trackAdoption": false - } - ] - }, - { - "parentPluginId": "embeddable", - "id": "def-public.openAddPanelFlyout.$1.getAllFactories", - "type": "Function", - "tags": [], - "label": "getAllFactories", - "description": [], - "signature": [ - "() => IterableIterator<", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableFactory", - "text": "EmbeddableFactory" - }, - "<", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - }, - ", ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" - }, - ", ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - "<", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - }, - ", ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" - }, - ", any>, unknown>>" - ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", - "deprecated": false, - "trackAdoption": false, - "returnComment": [], - "children": [] - }, - { - "parentPluginId": "embeddable", - "id": "def-public.openAddPanelFlyout.$1.overlays", - "type": "Object", - "tags": [], - "label": "overlays", - "description": [], - "signature": [ - { - "pluginId": "@kbn/core-overlays-browser", - "scope": "common", - "docId": "kibKbnCoreOverlaysBrowserPluginApi", - "section": "def-common.OverlayStart", - "text": "OverlayStart" - } - ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.openAddPanelFlyout.$1.notifications", - "type": "Object", - "tags": [], - "label": "notifications", - "description": [], - "signature": [ - { - "pluginId": "@kbn/core-notifications-browser", - "scope": "common", - "docId": "kibKbnCoreNotificationsBrowserPluginApi", - "section": "def-common.NotificationsStart", - "text": "NotificationsStart" - } - ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.openAddPanelFlyout.$1.SavedObjectFinder", - "type": "CompoundType", - "tags": [], - "label": "SavedObjectFinder", - "description": [], - "signature": [ - "React.ComponentClass | React.FunctionComponent" - ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", - "deprecated": false, - "trackAdoption": false + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" }, + "<", { - "parentPluginId": "embeddable", - "id": "def-public.openAddPanelFlyout.$1.showCreateNewMenu", - "type": "CompoundType", - "tags": [], - "label": "showCreateNewMenu", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", - "deprecated": false, - "trackAdoption": false + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" }, + ", ", { - "parentPluginId": "embeddable", - "id": "def-public.openAddPanelFlyout.$1.reportUiCounter", - "type": "Function", - "tags": [], - "label": "reportUiCounter", - "description": [], - "signature": [ - "((appName: string, type: string, eventNames: string | string[], count?: number | undefined) => void) | undefined" - ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", - "deprecated": false, - "trackAdoption": false + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" }, + ", any>>" + ], + "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.omitGenericEmbeddableInput", + "type": "Function", + "tags": [], + "label": "omitGenericEmbeddableInput", + "description": [], + "signature": [ + " = Partial<", + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableInput", + "text": "EmbeddableInput" + }, + ">>(input: I) => Omit" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/diff_embeddable_input.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.omitGenericEmbeddableInput.$1", + "type": "Uncategorized", + "tags": [], + "label": "input", + "description": [], + "signature": [ + "I" + ], + "path": "src/plugins/embeddable/public/lib/embeddables/diff_embeddable_input.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.openAddPanelFlyout", + "type": "Function", + "tags": [], + "label": "openAddPanelFlyout", + "description": [], + "signature": [ + "({ container, onAddPanel, }: { container: ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IContainer", + "text": "IContainer" + }, + "<{}, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerInput", + "text": "ContainerInput" + }, + "<{}>, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerOutput", + "text": "ContainerOutput" + }, + ">; onAddPanel?: ((id: string) => void) | undefined; }) => ", + { + "pluginId": "@kbn/core-mount-utils-browser", + "scope": "common", + "docId": "kibKbnCoreMountUtilsBrowserPluginApi", + "section": "def-common.OverlayRef", + "text": "OverlayRef" + } + ], + "path": "src/plugins/embeddable/public/add_panel_flyout/open_add_panel_flyout.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.openAddPanelFlyout.$1", + "type": "Object", + "tags": [], + "label": "{\n container,\n onAddPanel,\n}", + "description": [], + "path": "src/plugins/embeddable/public/add_panel_flyout/open_add_panel_flyout.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ { "parentPluginId": "embeddable", - "id": "def-public.openAddPanelFlyout.$1.theme", + "id": "def-public.openAddPanelFlyout.$1.container", "type": "Object", "tags": [], - "label": "theme", + "label": "container", "description": [], "signature": [ { - "pluginId": "@kbn/core-theme-browser", - "scope": "common", - "docId": "kibKbnCoreThemeBrowserPluginApi", - "section": "def-common.ThemeServiceStart", - "text": "ThemeServiceStart" - } + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IContainer", + "text": "IContainer" + }, + "<{}, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerInput", + "text": "ContainerInput" + }, + "<{}>, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerOutput", + "text": "ContainerOutput" + }, + ">" ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", + "path": "src/plugins/embeddable/public/add_panel_flyout/open_add_panel_flyout.tsx", "deprecated": false, "trackAdoption": false }, @@ -6258,7 +5809,7 @@ "signature": [ "((id: string) => void) | undefined" ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", + "path": "src/plugins/embeddable/public/add_panel_flyout/open_add_panel_flyout.tsx", "deprecated": false, "trackAdoption": false, "children": [ @@ -6272,7 +5823,7 @@ "signature": [ "string" ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", + "path": "src/plugins/embeddable/public/add_panel_flyout/open_add_panel_flyout.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -6607,302 +6158,89 @@ "id": "def-public.ContainerInput.hidePanelTitles", "type": "CompoundType", "tags": [], - "label": "hidePanelTitles", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.ContainerInput.panels", - "type": "Object", - "tags": [], - "label": "panels", - "description": [], - "signature": [ - "{ [key: string]: ", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.PanelState", - "text": "PanelState" - }, - "; }" - ], - "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", - "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.ContainerOutput", - "type": "Interface", - "tags": [], - "label": "ContainerOutput", - "description": [], - "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerOutput", - "text": "ContainerOutput" - }, - " extends ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" - } - ], - "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.ContainerOutput.embeddableLoaded", - "type": "Object", - "tags": [], - "label": "embeddableLoaded", - "description": [], - "signature": [ - "{ [key: string]: boolean; }" - ], - "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", - "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddableChildPanelProps", - "type": "Interface", - "tags": [], - "label": "EmbeddableChildPanelProps", - "description": [], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddableChildPanelProps.embeddableId", - "type": "string", - "tags": [], - "label": "embeddableId", - "description": [], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddableChildPanelProps.index", - "type": "number", - "tags": [], - "label": "index", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddableChildPanelProps.className", - "type": "string", - "tags": [], - "label": "className", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddableChildPanelProps.container", - "type": "Object", - "tags": [], - "label": "container", - "description": [], - "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IContainer", - "text": "IContainer" - }, - "<{}, ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerInput", - "text": "ContainerInput" - }, - "<{}>, ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.ContainerOutput", - "text": "ContainerOutput" - }, - ">" - ], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddableChildPanelProps.PanelComponent", - "type": "Function", - "tags": [], - "label": "PanelComponent", - "description": [], - "signature": [ - "React.FunctionComponent<{ embeddable: ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - "<", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - }, - ", ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" - }, - ", any>; hideHeader?: boolean | undefined; containerContext?: ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableContainerContext", - "text": "EmbeddableContainerContext" - }, - " | undefined; index?: number | undefined; }>" - ], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", - "deprecated": false, - "trackAdoption": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddableChildPanelProps.PanelComponent.$1", - "type": "CompoundType", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "P & { children?: React.ReactNode; }" - ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddableChildPanelProps.PanelComponent.$2", - "type": "Any", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "any" - ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false, - "trackAdoption": false - } - ] + "label": "hidePanelTitles", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "deprecated": false, + "trackAdoption": false }, { "parentPluginId": "embeddable", - "id": "def-public.EmbeddableChildPanelProps.onPanelStatusChange", - "type": "Function", + "id": "def-public.ContainerInput.panels", + "type": "Object", "tags": [], - "label": "onPanelStatusChange", + "label": "panels", "description": [], "signature": [ - "((info: ", + "{ [key: string]: ", { "pluginId": "embeddable", - "scope": "public", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.PanelState", + "text": "PanelState" + }, + " void) | undefined" + " & { id: string; }>; }" ], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddableChildPanelProps.onPanelStatusChange.$1", - "type": "Object", - "tags": [], - "label": "info", - "description": [], - "signature": [ - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddablePhaseEvent", - "text": "EmbeddablePhaseEvent" - } - ], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.ContainerOutput", + "type": "Interface", + "tags": [], + "label": "ContainerOutput", + "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerOutput", + "text": "ContainerOutput" + }, + " extends ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.EmbeddableOutput", + "text": "EmbeddableOutput" + } + ], + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.ContainerOutput.embeddableLoaded", + "type": "Object", + "tags": [], + "label": "embeddableLoaded", + "description": [], + "signature": [ + "{ [key: string]: boolean; }" ], - "returnComment": [] + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -6913,10 +6251,8 @@ "type": "Interface", "tags": [], "label": "EmbeddableContainerContext", - "description": [ - "\nEmbeddable container may provide information about its environment,\nUse it for drilling down data that is static or doesn't have to be reactive,\notherwise prefer passing data with input$" - ], - "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "description": [], + "path": "src/plugins/embeddable/public/embeddable_panel/types.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -6932,7 +6268,7 @@ "signature": [ "(() => string) | undefined" ], - "path": "src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/types.ts", "deprecated": false, "trackAdoption": false, "children": [], @@ -7949,7 +7285,7 @@ "tags": [], "label": "EmbeddablePhaseEvent", "description": [], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/types.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -7960,7 +7296,7 @@ "tags": [], "label": "id", "description": [], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/types.ts", "deprecated": false, "trackAdoption": false }, @@ -7972,9 +7308,9 @@ "label": "status", "description": [], "signature": [ - "\"error\" | \"loading\" | \"loaded\" | \"rendered\"" + "\"error\" | \"loading\" | \"rendered\" | \"loaded\"" ], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/types.ts", "deprecated": false, "trackAdoption": false }, @@ -7995,7 +7331,7 @@ }, " | undefined" ], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/types.ts", "deprecated": false, "trackAdoption": false }, @@ -8006,7 +7342,7 @@ "tags": [], "label": "timeToEvent", "description": [], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/types.ts", "deprecated": false, "trackAdoption": false } @@ -8184,6 +7520,26 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "embeddable", + "id": "def-public.EmbeddableStartDependencies.usageCollection", + "type": "Object", + "tags": [], + "label": "usageCollection", + "description": [], + "signature": [ + { + "pluginId": "usageCollection", + "scope": "public", + "docId": "kibUsageCollectionPluginApi", + "section": "def-public.UsageCollectionStart", + "text": "UsageCollectionStart" + } + ], + "path": "src/plugins/embeddable/public/plugin.tsx", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStartDependencies.savedObjectsManagement", @@ -10240,15 +9596,15 @@ "misc": [ { "parentPluginId": "embeddable", - "id": "def-public.ACTION_ADD_PANEL", + "id": "def-public.ACTION_CUSTOMIZE_PANEL", "type": "string", "tags": [], - "label": "ACTION_ADD_PANEL", + "label": "ACTION_CUSTOMIZE_PANEL", "description": [], "signature": [ - "\"ACTION_ADD_PANEL\"" + "\"ACTION_CUSTOMIZE_PANEL\"" ], - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/customize_panel_action/customize_panel_action.tsx", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -10263,7 +9619,22 @@ "signature": [ "\"editPanel\"" ], - "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/edit_panel_action/edit_panel_action.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.ACTION_INSPECT_PANEL", + "type": "string", + "tags": [], + "label": "ACTION_INSPECT_PANEL", + "description": [], + "signature": [ + "\"openInspector\"" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/inspect_panel_action/inspect_panel_action.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -10430,95 +9801,19 @@ "trackAdoption": false, "initialIsOpen": false }, - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddablePanelHOC", - "type": "Type", - "tags": [], - "label": "EmbeddablePanelHOC", - "description": [], - "signature": [ - "React.FunctionComponent<{ embeddable: ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - "<", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - }, - ", ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" - }, - ", any>; hideHeader?: boolean | undefined; containerContext?: ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableContainerContext", - "text": "EmbeddableContainerContext" - }, - " | undefined; index?: number | undefined; }>" - ], - "path": "src/plugins/embeddable/public/plugin.tsx", - "deprecated": false, - "trackAdoption": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddablePanelHOC.$1", - "type": "CompoundType", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "P & { children?: React.ReactNode; }" - ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddablePanelHOC.$2", - "type": "Any", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "any" - ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddablePhase", "type": "Type", "tags": [], "label": "EmbeddablePhase", - "description": [], + "description": [ + "\n Performance tracking types" + ], "signature": [ - "\"error\" | \"loading\" | \"loaded\" | \"rendered\"" + "\"error\" | \"loading\" | \"rendered\" | \"loaded\"" ], - "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", + "path": "src/plugins/embeddable/public/embeddable_panel/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -10600,6 +9895,21 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "embeddable", + "id": "def-public.REMOVE_PANEL_ACTION", + "type": "string", + "tags": [], + "label": "REMOVE_PANEL_ACTION", + "description": [], + "signature": [ + "\"deletePanel\"" + ], + "path": "src/plugins/embeddable/public/embeddable_panel/panel_actions/remove_panel_action/remove_panel_action.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "embeddable", "id": "def-public.SELECT_RANGE_TRIGGER", @@ -11342,83 +10652,6 @@ "children": [], "returnComment": [] }, - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddableStart.EmbeddablePanel", - "type": "Function", - "tags": [], - "label": "EmbeddablePanel", - "description": [], - "signature": [ - "React.FunctionComponent<{ embeddable: ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - "<", - { - "pluginId": "embeddable", - "scope": "common", - "docId": "kibEmbeddablePluginApi", - "section": "def-common.EmbeddableInput", - "text": "EmbeddableInput" - }, - ", ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableOutput", - "text": "EmbeddableOutput" - }, - ", any>; hideHeader?: boolean | undefined; containerContext?: ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableContainerContext", - "text": "EmbeddableContainerContext" - }, - " | undefined; index?: number | undefined; }>" - ], - "path": "src/plugins/embeddable/public/plugin.tsx", - "deprecated": false, - "trackAdoption": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddableStart.EmbeddablePanel.$1", - "type": "CompoundType", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "P & { children?: React.ReactNode; }" - ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "embeddable", - "id": "def-public.EmbeddableStart.EmbeddablePanel.$2", - "type": "Any", - "tags": [], - "label": "context", - "description": [], - "signature": [ - "any" - ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false, - "trackAdoption": false - } - ] - }, { "parentPluginId": "embeddable", "id": "def-public.EmbeddableStart.getStateTransfer", diff --git a/api_docs/embeddable.mdx b/api_docs/embeddable.mdx index 5df5a15d89f59..a2590f312ee65 100644 --- a/api_docs/embeddable.mdx +++ b/api_docs/embeddable.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/embeddable title: "embeddable" image: https://source.unsplash.com/400x175/?github description: API docs for the embeddable plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable'] --- import embeddableObj from './embeddable.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kib | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 548 | 11 | 444 | 4 | +| 532 | 11 | 434 | 7 | ## Client diff --git a/api_docs/embeddable_enhanced.mdx b/api_docs/embeddable_enhanced.mdx index 5df39f9b59f6b..daddf3374bcd0 100644 --- a/api_docs/embeddable_enhanced.mdx +++ b/api_docs/embeddable_enhanced.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/embeddableEnhanced title: "embeddableEnhanced" image: https://source.unsplash.com/400x175/?github description: API docs for the embeddableEnhanced plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddableEnhanced'] --- import embeddableEnhancedObj from './embeddable_enhanced.devdocs.json'; diff --git a/api_docs/encrypted_saved_objects.mdx b/api_docs/encrypted_saved_objects.mdx index 0bc3b60a9a7cd..02c8beb1d5bed 100644 --- a/api_docs/encrypted_saved_objects.mdx +++ b/api_docs/encrypted_saved_objects.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/encryptedSavedObjects title: "encryptedSavedObjects" image: https://source.unsplash.com/400x175/?github description: API docs for the encryptedSavedObjects plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects'] --- import encryptedSavedObjectsObj from './encrypted_saved_objects.devdocs.json'; diff --git a/api_docs/enterprise_search.devdocs.json b/api_docs/enterprise_search.devdocs.json index 9481ef8ff7ad5..99cda4d5bb3af 100644 --- a/api_docs/enterprise_search.devdocs.json +++ b/api_docs/enterprise_search.devdocs.json @@ -128,7 +128,7 @@ "label": "CURRENT_CONNECTORS_JOB_INDEX", "description": [], "signature": [ - "\".elastic-connectors-v1\"" + "\".elastic-connectors-sync-jobs-v1\"" ], "path": "x-pack/plugins/enterprise_search/server/index.ts", "deprecated": false, diff --git a/api_docs/enterprise_search.mdx b/api_docs/enterprise_search.mdx index a40603ac30816..a6e2107a2781c 100644 --- a/api_docs/enterprise_search.mdx +++ b/api_docs/enterprise_search.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/enterpriseSearch title: "enterpriseSearch" image: https://source.unsplash.com/400x175/?github description: API docs for the enterpriseSearch plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch'] --- import enterpriseSearchObj from './enterprise_search.devdocs.json'; diff --git a/api_docs/es_ui_shared.mdx b/api_docs/es_ui_shared.mdx index 72a974ca15d84..390a0c369b003 100644 --- a/api_docs/es_ui_shared.mdx +++ b/api_docs/es_ui_shared.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/esUiShared title: "esUiShared" image: https://source.unsplash.com/400x175/?github description: API docs for the esUiShared plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared'] --- import esUiSharedObj from './es_ui_shared.devdocs.json'; diff --git a/api_docs/event_annotation.devdocs.json b/api_docs/event_annotation.devdocs.json index 9cbab58d01ef1..e61c8b977dd39 100644 --- a/api_docs/event_annotation.devdocs.json +++ b/api_docs/event_annotation.devdocs.json @@ -2,262 +2,7 @@ "id": "eventAnnotation", "client": { "classes": [], - "functions": [ - { - "parentPluginId": "eventAnnotation", - "id": "def-public.AnnotationEditorControls", - "type": "Function", - "tags": [], - "label": "AnnotationEditorControls", - "description": [], - "signature": [ - "(props: ", - "Props", - ") => JSX.Element" - ], - "path": "src/plugins/event_annotation/public/components/annotation_editor_controls/index.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "eventAnnotation", - "id": "def-public.AnnotationEditorControls.$1", - "type": "Object", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "Props" - ], - "path": "src/plugins/event_annotation/public/components/annotation_editor_controls/index.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "eventAnnotation", - "id": "def-public.getAnnotationAccessor", - "type": "Function", - "tags": [], - "label": "getAnnotationAccessor", - "description": [], - "signature": [ - "(annotation: ", - { - "pluginId": "eventAnnotation", - "scope": "common", - "docId": "kibEventAnnotationPluginApi", - "section": "def-common.EventAnnotationConfig", - "text": "EventAnnotationConfig" - }, - ") => ", - { - "pluginId": "visualizationUiComponents", - "scope": "public", - "docId": "kibVisualizationUiComponentsPluginApi", - "section": "def-public.AccessorConfig", - "text": "AccessorConfig" - } - ], - "path": "src/plugins/event_annotation/public/components/get_annotation_accessor.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "eventAnnotation", - "id": "def-public.getAnnotationAccessor.$1", - "type": "CompoundType", - "tags": [], - "label": "annotation", - "description": [], - "signature": [ - { - "pluginId": "eventAnnotation", - "scope": "common", - "docId": "kibEventAnnotationPluginApi", - "section": "def-common.EventAnnotationConfig", - "text": "EventAnnotationConfig" - } - ], - "path": "src/plugins/event_annotation/public/components/get_annotation_accessor.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "eventAnnotation", - "id": "def-public.isManualPointAnnotationConfig", - "type": "Function", - "tags": [], - "label": "isManualPointAnnotationConfig", - "description": [], - "signature": [ - "(annotation?: ", - { - "pluginId": "eventAnnotation", - "scope": "common", - "docId": "kibEventAnnotationPluginApi", - "section": "def-common.EventAnnotationConfig", - "text": "EventAnnotationConfig" - }, - " | undefined) => annotation is ", - { - "pluginId": "eventAnnotation", - "scope": "common", - "docId": "kibEventAnnotationPluginApi", - "section": "def-common.PointInTimeEventAnnotationConfig", - "text": "PointInTimeEventAnnotationConfig" - } - ], - "path": "src/plugins/event_annotation/public/event_annotation_service/helpers.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "eventAnnotation", - "id": "def-public.isManualPointAnnotationConfig.$1", - "type": "CompoundType", - "tags": [], - "label": "annotation", - "description": [], - "signature": [ - { - "pluginId": "eventAnnotation", - "scope": "common", - "docId": "kibEventAnnotationPluginApi", - "section": "def-common.EventAnnotationConfig", - "text": "EventAnnotationConfig" - }, - " | undefined" - ], - "path": "src/plugins/event_annotation/public/event_annotation_service/helpers.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": false - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "eventAnnotation", - "id": "def-public.isQueryAnnotationConfig", - "type": "Function", - "tags": [], - "label": "isQueryAnnotationConfig", - "description": [], - "signature": [ - "(annotation?: ", - { - "pluginId": "eventAnnotation", - "scope": "common", - "docId": "kibEventAnnotationPluginApi", - "section": "def-common.EventAnnotationConfig", - "text": "EventAnnotationConfig" - }, - " | undefined) => annotation is ", - { - "pluginId": "eventAnnotation", - "scope": "common", - "docId": "kibEventAnnotationPluginApi", - "section": "def-common.QueryPointEventAnnotationConfig", - "text": "QueryPointEventAnnotationConfig" - } - ], - "path": "src/plugins/event_annotation/public/event_annotation_service/helpers.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "eventAnnotation", - "id": "def-public.isQueryAnnotationConfig.$1", - "type": "CompoundType", - "tags": [], - "label": "annotation", - "description": [], - "signature": [ - { - "pluginId": "eventAnnotation", - "scope": "common", - "docId": "kibEventAnnotationPluginApi", - "section": "def-common.EventAnnotationConfig", - "text": "EventAnnotationConfig" - }, - " | undefined" - ], - "path": "src/plugins/event_annotation/public/event_annotation_service/helpers.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": false - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "eventAnnotation", - "id": "def-public.isRangeAnnotationConfig", - "type": "Function", - "tags": [], - "label": "isRangeAnnotationConfig", - "description": [], - "signature": [ - "(annotation?: ", - { - "pluginId": "eventAnnotation", - "scope": "common", - "docId": "kibEventAnnotationPluginApi", - "section": "def-common.EventAnnotationConfig", - "text": "EventAnnotationConfig" - }, - " | undefined) => annotation is ", - { - "pluginId": "eventAnnotation", - "scope": "common", - "docId": "kibEventAnnotationPluginApi", - "section": "def-common.RangeEventAnnotationConfig", - "text": "RangeEventAnnotationConfig" - } - ], - "path": "src/plugins/event_annotation/public/event_annotation_service/helpers.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "eventAnnotation", - "id": "def-public.isRangeAnnotationConfig.$1", - "type": "CompoundType", - "tags": [], - "label": "annotation", - "description": [], - "signature": [ - { - "pluginId": "eventAnnotation", - "scope": "common", - "docId": "kibEventAnnotationPluginApi", - "section": "def-common.EventAnnotationConfig", - "text": "EventAnnotationConfig" - }, - " | undefined" - ], - "path": "src/plugins/event_annotation/public/event_annotation_service/helpers.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": false - } - ], - "returnComment": [], - "initialIsOpen": false - } - ], + "functions": [], "interfaces": [ { "parentPluginId": "eventAnnotation", @@ -266,7 +11,7 @@ "tags": [], "label": "EventAnnotationServiceType", "description": [], - "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "path": "packages/kbn-event-annotation-components/types.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -280,15 +25,15 @@ "signature": [ "(savedObjectId: string) => Promise<", { - "pluginId": "eventAnnotation", + "pluginId": "@kbn/event-annotation-common", "scope": "common", - "docId": "kibEventAnnotationPluginApi", + "docId": "kibKbnEventAnnotationCommonPluginApi", "section": "def-common.EventAnnotationGroupConfig", "text": "EventAnnotationGroupConfig" }, ">" ], - "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "path": "packages/kbn-event-annotation-components/types.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -302,7 +47,7 @@ "signature": [ "string" ], - "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "path": "packages/kbn-event-annotation-components/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -320,7 +65,7 @@ "signature": [ "(title: string) => Promise" ], - "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "path": "packages/kbn-event-annotation-components/types.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -334,7 +79,7 @@ "signature": [ "string" ], - "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "path": "packages/kbn-event-annotation-components/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -351,10 +96,16 @@ "description": [], "signature": [ "(searchTerm: string, pageSize: number, tagsToInclude?: string[] | undefined, tagsToExclude?: string[] | undefined) => Promise<{ total: number; hits: ", - "EventAnnotationGroupContent", + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.EventAnnotationGroupContent", + "text": "EventAnnotationGroupContent" + }, "[]; }>" ], - "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "path": "packages/kbn-event-annotation-components/types.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -368,7 +119,7 @@ "signature": [ "string" ], - "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "path": "packages/kbn-event-annotation-components/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -383,7 +134,7 @@ "signature": [ "number" ], - "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "path": "packages/kbn-event-annotation-components/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -398,7 +149,7 @@ "signature": [ "string[] | undefined" ], - "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "path": "packages/kbn-event-annotation-components/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": false @@ -413,7 +164,7 @@ "signature": [ "string[] | undefined" ], - "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "path": "packages/kbn-event-annotation-components/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": false @@ -431,7 +182,7 @@ "signature": [ "(ids: string[]) => Promise" ], - "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "path": "packages/kbn-event-annotation-components/types.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -445,7 +196,7 @@ "signature": [ "string[]" ], - "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "path": "packages/kbn-event-annotation-components/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -463,15 +214,15 @@ "signature": [ "(group: ", { - "pluginId": "eventAnnotation", + "pluginId": "@kbn/event-annotation-common", "scope": "common", - "docId": "kibEventAnnotationPluginApi", + "docId": "kibKbnEventAnnotationCommonPluginApi", "section": "def-common.EventAnnotationGroupConfig", "text": "EventAnnotationGroupConfig" }, ") => Promise<{ id: string; }>" ], - "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "path": "packages/kbn-event-annotation-components/types.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -484,14 +235,14 @@ "description": [], "signature": [ { - "pluginId": "eventAnnotation", + "pluginId": "@kbn/event-annotation-common", "scope": "common", - "docId": "kibEventAnnotationPluginApi", + "docId": "kibKbnEventAnnotationCommonPluginApi", "section": "def-common.EventAnnotationGroupConfig", "text": "EventAnnotationGroupConfig" } ], - "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "path": "packages/kbn-event-annotation-components/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -509,15 +260,15 @@ "signature": [ "(group: ", { - "pluginId": "eventAnnotation", + "pluginId": "@kbn/event-annotation-common", "scope": "common", - "docId": "kibEventAnnotationPluginApi", + "docId": "kibKbnEventAnnotationCommonPluginApi", "section": "def-common.EventAnnotationGroupConfig", "text": "EventAnnotationGroupConfig" }, ", savedObjectId: string) => Promise" ], - "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "path": "packages/kbn-event-annotation-components/types.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -530,14 +281,14 @@ "description": [], "signature": [ { - "pluginId": "eventAnnotation", + "pluginId": "@kbn/event-annotation-common", "scope": "common", - "docId": "kibEventAnnotationPluginApi", + "docId": "kibKbnEventAnnotationCommonPluginApi", "section": "def-common.EventAnnotationGroupConfig", "text": "EventAnnotationGroupConfig" } ], - "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "path": "packages/kbn-event-annotation-components/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -552,7 +303,7 @@ "signature": [ "string" ], - "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "path": "packages/kbn-event-annotation-components/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -570,9 +321,9 @@ "signature": [ "(props: ", { - "pluginId": "eventAnnotation", + "pluginId": "@kbn/event-annotation-common", "scope": "common", - "docId": "kibEventAnnotationPluginApi", + "docId": "kibKbnEventAnnotationCommonPluginApi", "section": "def-common.EventAnnotationConfig", "text": "EventAnnotationConfig" }, @@ -586,7 +337,7 @@ }, "[]" ], - "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "path": "packages/kbn-event-annotation-components/types.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -599,15 +350,15 @@ "description": [], "signature": [ { - "pluginId": "eventAnnotation", + "pluginId": "@kbn/event-annotation-common", "scope": "common", - "docId": "kibEventAnnotationPluginApi", + "docId": "kibKbnEventAnnotationCommonPluginApi", "section": "def-common.EventAnnotationConfig", "text": "EventAnnotationConfig" }, "[]" ], - "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "path": "packages/kbn-event-annotation-components/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -625,9 +376,9 @@ "signature": [ "(props: { interval: string; groups: Pick<", { - "pluginId": "eventAnnotation", + "pluginId": "@kbn/event-annotation-common", "scope": "common", - "docId": "kibEventAnnotationPluginApi", + "docId": "kibKbnEventAnnotationCommonPluginApi", "section": "def-common.EventAnnotationGroupConfig", "text": "EventAnnotationGroupConfig" }, @@ -641,7 +392,7 @@ }, "[]" ], - "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "path": "packages/kbn-event-annotation-components/types.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -652,7 +403,7 @@ "tags": [], "label": "props", "description": [], - "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "path": "packages/kbn-event-annotation-components/types.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -663,7 +414,7 @@ "tags": [], "label": "interval", "description": [], - "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "path": "packages/kbn-event-annotation-components/types.ts", "deprecated": false, "trackAdoption": false }, @@ -677,15 +428,15 @@ "signature": [ "Pick<", { - "pluginId": "eventAnnotation", + "pluginId": "@kbn/event-annotation-common", "scope": "common", - "docId": "kibEventAnnotationPluginApi", + "docId": "kibKbnEventAnnotationCommonPluginApi", "section": "def-common.EventAnnotationGroupConfig", "text": "EventAnnotationGroupConfig" }, ", \"annotations\" | \"ignoreGlobalFilters\" | \"indexPatternId\">[]" ], - "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "path": "packages/kbn-event-annotation-components/types.ts", "deprecated": false, "trackAdoption": false } @@ -712,7 +463,7 @@ }, "; }) => void; onCreateNew: () => void; }) => JSX.Element" ], - "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "path": "packages/kbn-event-annotation-components/types.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -723,7 +474,7 @@ "tags": [], "label": "props", "description": [], - "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "path": "packages/kbn-event-annotation-components/types.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -737,7 +488,7 @@ "signature": [ "number | undefined" ], - "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "path": "packages/kbn-event-annotation-components/types.ts", "deprecated": false, "trackAdoption": false }, @@ -759,7 +510,7 @@ }, "; }) => void" ], - "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "path": "packages/kbn-event-annotation-components/types.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -770,7 +521,7 @@ "tags": [], "label": "value", "description": [], - "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "path": "packages/kbn-event-annotation-components/types.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -781,7 +532,7 @@ "tags": [], "label": "id", "description": [], - "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "path": "packages/kbn-event-annotation-components/types.ts", "deprecated": false, "trackAdoption": false }, @@ -792,7 +543,7 @@ "tags": [], "label": "type", "description": [], - "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "path": "packages/kbn-event-annotation-components/types.ts", "deprecated": false, "trackAdoption": false }, @@ -803,7 +554,7 @@ "tags": [], "label": "fullName", "description": [], - "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "path": "packages/kbn-event-annotation-components/types.ts", "deprecated": false, "trackAdoption": false }, @@ -824,7 +575,7 @@ }, "" ], - "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "path": "packages/kbn-event-annotation-components/types.ts", "deprecated": false, "trackAdoption": false } @@ -843,7 +594,7 @@ "signature": [ "() => void" ], - "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", + "path": "packages/kbn-event-annotation-components/types.ts", "deprecated": false, "trackAdoption": false, "children": [], @@ -859,58 +610,7 @@ } ], "enums": [], - "misc": [ - { - "parentPluginId": "eventAnnotation", - "id": "def-public.annotationsIconSet", - "type": "Array", - "tags": [], - "label": "annotationsIconSet", - "description": [], - "signature": [ - "{ value: ", - { - "pluginId": "eventAnnotation", - "scope": "common", - "docId": "kibEventAnnotationPluginApi", - "section": "def-common.AvailableAnnotationIcon", - "text": "AvailableAnnotationIcon" - }, - "; label: string; icon?: string | React.ComponentClass<{}, any> | React.FunctionComponent<{}> | undefined; shouldRotate?: boolean | undefined; }[]" - ], - "path": "src/plugins/event_annotation/public/components/annotation_editor_controls/icon_set.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "eventAnnotation", - "id": "def-public.defaultAnnotationColor", - "type": "string", - "tags": [], - "label": "defaultAnnotationColor", - "description": [], - "path": "src/plugins/event_annotation/public/event_annotation_service/helpers.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "eventAnnotation", - "id": "def-public.defaultAnnotationRangeColor", - "type": "string", - "tags": [], - "label": "defaultAnnotationRangeColor", - "description": [], - "signature": [ - "\"#F04E981A\"" - ], - "path": "src/plugins/event_annotation/public/event_annotation_service/helpers.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - } - ], + "misc": [], "objects": [], "setup": { "parentPluginId": "eventAnnotation", @@ -1029,9 +729,9 @@ "signature": [ "() => Promise<", { - "pluginId": "eventAnnotation", + "pluginId": "@kbn/event-annotation-components", "scope": "public", - "docId": "kibEventAnnotationPluginApi", + "docId": "kibKbnEventAnnotationComponentsPluginApi", "section": "def-public.EventAnnotationServiceType", "text": "EventAnnotationServiceType" }, @@ -1061,106 +761,21 @@ "functions": [ { "parentPluginId": "eventAnnotation", - "id": "def-common.createCopiedAnnotation", + "id": "def-common.eventAnnotationGroup", "type": "Function", "tags": [], - "label": "createCopiedAnnotation", + "label": "eventAnnotationGroup", "description": [], "signature": [ - "(newId: string, timestamp: string, source?: ", + "() => ", { - "pluginId": "eventAnnotation", + "pluginId": "expressions", "scope": "common", - "docId": "kibEventAnnotationPluginApi", - "section": "def-common.EventAnnotationConfig", - "text": "EventAnnotationConfig" + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionFunctionDefinition", + "text": "ExpressionFunctionDefinition" }, - " | undefined) => ", - { - "pluginId": "eventAnnotation", - "scope": "common", - "docId": "kibEventAnnotationPluginApi", - "section": "def-common.EventAnnotationConfig", - "text": "EventAnnotationConfig" - } - ], - "path": "src/plugins/event_annotation/common/create_copied_annotation.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "eventAnnotation", - "id": "def-common.createCopiedAnnotation.$1", - "type": "string", - "tags": [], - "label": "newId", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/event_annotation/common/create_copied_annotation.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "eventAnnotation", - "id": "def-common.createCopiedAnnotation.$2", - "type": "string", - "tags": [], - "label": "timestamp", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/event_annotation/common/create_copied_annotation.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "eventAnnotation", - "id": "def-common.createCopiedAnnotation.$3", - "type": "CompoundType", - "tags": [], - "label": "source", - "description": [], - "signature": [ - { - "pluginId": "eventAnnotation", - "scope": "common", - "docId": "kibEventAnnotationPluginApi", - "section": "def-common.EventAnnotationConfig", - "text": "EventAnnotationConfig" - }, - " | undefined" - ], - "path": "src/plugins/event_annotation/common/create_copied_annotation.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": false - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "eventAnnotation", - "id": "def-common.eventAnnotationGroup", - "type": "Function", - "tags": [], - "label": "eventAnnotationGroup", - "description": [], - "signature": [ - "() => ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"event_annotation_group\", null, ", + "<\"event_annotation_group\", null, ", { "pluginId": "eventAnnotation", "scope": "common", @@ -1188,317 +803,37 @@ }, ", ", { - "pluginId": "@kbn/utility-types", - "scope": "common", - "docId": "kibKbnUtilityTypesPluginApi", - "section": "def-common.SerializableRecord", - "text": "SerializableRecord" - }, - ">>" - ], - "path": "src/plugins/event_annotation/common/event_annotation_group/index.ts", - "deprecated": false, - "trackAdoption": false, - "children": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "eventAnnotation", - "id": "def-common.getDefaultManualAnnotation", - "type": "Function", - "tags": [], - "label": "getDefaultManualAnnotation", - "description": [], - "signature": [ - "(id: string, timestamp: string) => ", - { - "pluginId": "eventAnnotation", - "scope": "common", - "docId": "kibEventAnnotationPluginApi", - "section": "def-common.EventAnnotationConfig", - "text": "EventAnnotationConfig" - } - ], - "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "eventAnnotation", - "id": "def-common.getDefaultManualAnnotation.$1", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "eventAnnotation", - "id": "def-common.getDefaultManualAnnotation.$2", - "type": "string", - "tags": [], - "label": "timestamp", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "eventAnnotation", - "id": "def-common.getDefaultQueryAnnotation", - "type": "Function", - "tags": [], - "label": "getDefaultQueryAnnotation", - "description": [], - "signature": [ - "(id: string, fieldName: string, timeField: string) => ", - { - "pluginId": "eventAnnotation", - "scope": "common", - "docId": "kibEventAnnotationPluginApi", - "section": "def-common.EventAnnotationConfig", - "text": "EventAnnotationConfig" - } - ], - "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "eventAnnotation", - "id": "def-common.getDefaultQueryAnnotation.$1", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "eventAnnotation", - "id": "def-common.getDefaultQueryAnnotation.$2", - "type": "string", - "tags": [], - "label": "fieldName", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "eventAnnotation", - "id": "def-common.getDefaultQueryAnnotation.$3", - "type": "string", - "tags": [], - "label": "timeField", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - } - ], - "interfaces": [ - { - "parentPluginId": "eventAnnotation", - "id": "def-common.EventAnnotationGroupArgs", - "type": "Interface", - "tags": [], - "label": "EventAnnotationGroupArgs", - "description": [], - "path": "src/plugins/event_annotation/common/event_annotation_group/index.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "eventAnnotation", - "id": "def-common.EventAnnotationGroupArgs.annotations", - "type": "Array", - "tags": [], - "label": "annotations", - "description": [], - "signature": [ - { - "pluginId": "eventAnnotation", - "scope": "common", - "docId": "kibEventAnnotationPluginApi", - "section": "def-common.EventAnnotationOutput", - "text": "EventAnnotationOutput" - }, - "[]" - ], - "path": "src/plugins/event_annotation/common/event_annotation_group/index.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "eventAnnotation", - "id": "def-common.EventAnnotationGroupArgs.dataView", - "type": "Object", - "tags": [], - "label": "dataView", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPatternExpressionType", - "text": "IndexPatternExpressionType" - } - ], - "path": "src/plugins/event_annotation/common/event_annotation_group/index.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "eventAnnotation", - "id": "def-common.EventAnnotationGroupArgs.ignoreGlobalFilters", - "type": "boolean", - "tags": [], - "label": "ignoreGlobalFilters", - "description": [], - "path": "src/plugins/event_annotation/common/event_annotation_group/index.ts", - "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "eventAnnotation", - "id": "def-common.EventAnnotationGroupAttributes", - "type": "Interface", - "tags": [], - "label": "EventAnnotationGroupAttributes", - "description": [], - "path": "src/plugins/event_annotation/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "eventAnnotation", - "id": "def-common.EventAnnotationGroupAttributes.title", - "type": "string", - "tags": [], - "label": "title", - "description": [], - "path": "src/plugins/event_annotation/common/types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "eventAnnotation", - "id": "def-common.EventAnnotationGroupAttributes.description", - "type": "string", - "tags": [], - "label": "description", - "description": [], - "path": "src/plugins/event_annotation/common/types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "eventAnnotation", - "id": "def-common.EventAnnotationGroupAttributes.ignoreGlobalFilters", - "type": "boolean", - "tags": [], - "label": "ignoreGlobalFilters", - "description": [], - "path": "src/plugins/event_annotation/common/types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "eventAnnotation", - "id": "def-common.EventAnnotationGroupAttributes.annotations", - "type": "Array", - "tags": [], - "label": "annotations", - "description": [], - "signature": [ - { - "pluginId": "eventAnnotation", - "scope": "common", - "docId": "kibEventAnnotationPluginApi", - "section": "def-common.EventAnnotationConfig", - "text": "EventAnnotationConfig" - }, - "[]" - ], - "path": "src/plugins/event_annotation/common/types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "eventAnnotation", - "id": "def-common.EventAnnotationGroupAttributes.dataViewSpec", - "type": "CompoundType", - "tags": [], - "label": "dataViewSpec", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - " | null | undefined" - ], - "path": "src/plugins/event_annotation/common/types.ts", - "deprecated": false, - "trackAdoption": false - } + "pluginId": "@kbn/utility-types", + "scope": "common", + "docId": "kibKbnUtilityTypesPluginApi", + "section": "def-common.SerializableRecord", + "text": "SerializableRecord" + }, + ">>" ], + "path": "src/plugins/event_annotation/common/event_annotation_group/index.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [], "initialIsOpen": false - }, + } + ], + "interfaces": [ { "parentPluginId": "eventAnnotation", - "id": "def-common.EventAnnotationGroupConfig", + "id": "def-common.EventAnnotationGroupArgs", "type": "Interface", "tags": [], - "label": "EventAnnotationGroupConfig", + "label": "EventAnnotationGroupArgs", "description": [], - "path": "src/plugins/event_annotation/common/types.ts", + "path": "src/plugins/event_annotation/common/event_annotation_group/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "eventAnnotation", - "id": "def-common.EventAnnotationGroupConfig.annotations", + "id": "def-common.EventAnnotationGroupArgs.annotations", "type": "Array", "tags": [], "label": "annotations", @@ -1508,91 +843,43 @@ "pluginId": "eventAnnotation", "scope": "common", "docId": "kibEventAnnotationPluginApi", - "section": "def-common.EventAnnotationConfig", - "text": "EventAnnotationConfig" + "section": "def-common.EventAnnotationOutput", + "text": "EventAnnotationOutput" }, "[]" ], - "path": "src/plugins/event_annotation/common/types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "eventAnnotation", - "id": "def-common.EventAnnotationGroupConfig.indexPatternId", - "type": "string", - "tags": [], - "label": "indexPatternId", - "description": [], - "path": "src/plugins/event_annotation/common/types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "eventAnnotation", - "id": "def-common.EventAnnotationGroupConfig.ignoreGlobalFilters", - "type": "boolean", - "tags": [], - "label": "ignoreGlobalFilters", - "description": [], - "path": "src/plugins/event_annotation/common/types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "eventAnnotation", - "id": "def-common.EventAnnotationGroupConfig.title", - "type": "string", - "tags": [], - "label": "title", - "description": [], - "path": "src/plugins/event_annotation/common/types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "eventAnnotation", - "id": "def-common.EventAnnotationGroupConfig.description", - "type": "string", - "tags": [], - "label": "description", - "description": [], - "path": "src/plugins/event_annotation/common/types.ts", + "path": "src/plugins/event_annotation/common/event_annotation_group/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "eventAnnotation", - "id": "def-common.EventAnnotationGroupConfig.tags", - "type": "Array", + "id": "def-common.EventAnnotationGroupArgs.dataView", + "type": "Object", "tags": [], - "label": "tags", + "label": "dataView", "description": [], "signature": [ - "string[]" + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.IndexPatternExpressionType", + "text": "IndexPatternExpressionType" + } ], - "path": "src/plugins/event_annotation/common/types.ts", + "path": "src/plugins/event_annotation/common/event_annotation_group/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "eventAnnotation", - "id": "def-common.EventAnnotationGroupConfig.dataViewSpec", - "type": "Object", + "id": "def-common.EventAnnotationGroupArgs.ignoreGlobalFilters", + "type": "boolean", "tags": [], - "label": "dataViewSpec", + "label": "ignoreGlobalFilters", "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewSpec", - "text": "DataViewSpec" - }, - " | undefined" - ], - "path": "src/plugins/event_annotation/common/types.ts", + "path": "src/plugins/event_annotation/common/event_annotation_group/index.ts", "deprecated": false, "trackAdoption": false } @@ -1652,9 +939,9 @@ "description": [], "signature": [ { - "pluginId": "eventAnnotation", + "pluginId": "@kbn/event-annotation-common", "scope": "common", - "docId": "kibEventAnnotationPluginApi", + "docId": "kibKbnEventAnnotationCommonPluginApi", "section": "def-common.EventAnnotationConfig", "text": "EventAnnotationConfig" }, @@ -1746,36 +1033,6 @@ "trackAdoption": false, "initialIsOpen": false }, - { - "parentPluginId": "eventAnnotation", - "id": "def-common.AvailableAnnotationIcon", - "type": "Type", - "tags": [], - "label": "AvailableAnnotationIcon", - "description": [], - "signature": [ - "\"alert\" | \"circle\" | \"tag\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"editorComment\" | \"flag\" | \"heart\" | \"mapMarker\" | \"pinFilled\" | \"starEmpty\" | \"starFilled\" | \"triangle\"" - ], - "path": "src/plugins/event_annotation/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "eventAnnotation", - "id": "def-common.EVENT_ANNOTATION_GROUP_TYPE", - "type": "string", - "tags": [], - "label": "EVENT_ANNOTATION_GROUP_TYPE", - "description": [], - "signature": [ - "\"event-annotation-group\"" - ], - "path": "src/plugins/event_annotation/common/constants.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, { "parentPluginId": "eventAnnotation", "id": "def-common.EventAnnotationArgs", @@ -1813,43 +1070,6 @@ "trackAdoption": false, "initialIsOpen": false }, - { - "parentPluginId": "eventAnnotation", - "id": "def-common.EventAnnotationConfig", - "type": "Type", - "tags": [], - "label": "EventAnnotationConfig", - "description": [], - "signature": [ - { - "pluginId": "eventAnnotation", - "scope": "common", - "docId": "kibEventAnnotationPluginApi", - "section": "def-common.PointInTimeEventAnnotationConfig", - "text": "PointInTimeEventAnnotationConfig" - }, - " | ", - { - "pluginId": "eventAnnotation", - "scope": "common", - "docId": "kibEventAnnotationPluginApi", - "section": "def-common.RangeEventAnnotationConfig", - "text": "RangeEventAnnotationConfig" - }, - " | ", - { - "pluginId": "eventAnnotation", - "scope": "common", - "docId": "kibEventAnnotationPluginApi", - "section": "def-common.QueryPointEventAnnotationConfig", - "text": "QueryPointEventAnnotationConfig" - } - ], - "path": "src/plugins/event_annotation/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, { "parentPluginId": "eventAnnotation", "id": "def-common.EventAnnotationOutput", @@ -1883,14 +1103,20 @@ "signature": [ "{ id: string; time: string; } & StyleSharedProps & { icon?: ", { - "pluginId": "eventAnnotation", + "pluginId": "@kbn/event-annotation-common", "scope": "common", - "docId": "kibEventAnnotationPluginApi", + "docId": "kibKbnEventAnnotationCommonPluginApi", "section": "def-common.AvailableAnnotationIcon", "text": "AvailableAnnotationIcon" }, " | undefined; lineWidth?: number | undefined; lineStyle?: ", - "LineStyle", + { + "pluginId": "@kbn/visualization-ui-components", + "scope": "public", + "docId": "kibKbnVisualizationUiComponentsPluginApi", + "section": "def-public.LineStyle", + "text": "LineStyle" + }, " | undefined; textVisibility?: boolean | undefined; }" ], "path": "src/plugins/event_annotation/common/manual_event_annotation/types.ts", @@ -1908,14 +1134,20 @@ "signature": [ "{ id: string; time: string; } & StyleSharedProps & { icon?: ", { - "pluginId": "eventAnnotation", + "pluginId": "@kbn/event-annotation-common", "scope": "common", - "docId": "kibEventAnnotationPluginApi", + "docId": "kibKbnEventAnnotationCommonPluginApi", "section": "def-common.AvailableAnnotationIcon", "text": "AvailableAnnotationIcon" }, " | undefined; lineWidth?: number | undefined; lineStyle?: ", - "LineStyle", + { + "pluginId": "@kbn/visualization-ui-components", + "scope": "public", + "docId": "kibKbnVisualizationUiComponentsPluginApi", + "section": "def-public.LineStyle", + "text": "LineStyle" + }, " | undefined; textVisibility?: boolean | undefined; } & { type: \"manual_point_event_annotation\"; }" ], "path": "src/plugins/event_annotation/common/manual_event_annotation/types.ts", @@ -1978,42 +1210,23 @@ "signature": [ "{ id: string; time: string; type: \"point\"; timebucket: string; skippedCount?: number | undefined; } & StyleSharedProps & { icon?: ", { - "pluginId": "eventAnnotation", + "pluginId": "@kbn/event-annotation-common", "scope": "common", - "docId": "kibEventAnnotationPluginApi", + "docId": "kibKbnEventAnnotationCommonPluginApi", "section": "def-common.AvailableAnnotationIcon", "text": "AvailableAnnotationIcon" }, " | undefined; lineWidth?: number | undefined; lineStyle?: ", - "LineStyle", - " | undefined; textVisibility?: boolean | undefined; } & Record" - ], - "path": "src/plugins/event_annotation/common/manual_event_annotation/types.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "eventAnnotation", - "id": "def-common.PointInTimeEventAnnotationConfig", - "type": "Type", - "tags": [], - "label": "PointInTimeEventAnnotationConfig", - "description": [], - "signature": [ - "{ id: string; type: \"manual\"; key: { type: \"point_in_time\"; timestamp: string; }; } & StyleSharedProps & { icon?: ", { - "pluginId": "eventAnnotation", - "scope": "common", - "docId": "kibEventAnnotationPluginApi", - "section": "def-common.AvailableAnnotationIcon", - "text": "AvailableAnnotationIcon" + "pluginId": "@kbn/visualization-ui-components", + "scope": "public", + "docId": "kibKbnVisualizationUiComponentsPluginApi", + "section": "def-public.LineStyle", + "text": "LineStyle" }, - " | undefined; lineWidth?: number | undefined; lineStyle?: ", - "LineStyle", - " | undefined; textVisibility?: boolean | undefined; }" + " | undefined; textVisibility?: boolean | undefined; } & Record" ], - "path": "src/plugins/event_annotation/common/types.ts", + "path": "src/plugins/event_annotation/common/manual_event_annotation/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -2036,50 +1249,23 @@ }, "; timeField?: string | undefined; extraFields?: string[] | undefined; textField?: string | undefined; } & StyleSharedProps & { icon?: ", { - "pluginId": "eventAnnotation", + "pluginId": "@kbn/event-annotation-common", "scope": "common", - "docId": "kibEventAnnotationPluginApi", + "docId": "kibKbnEventAnnotationCommonPluginApi", "section": "def-common.AvailableAnnotationIcon", "text": "AvailableAnnotationIcon" }, " | undefined; lineWidth?: number | undefined; lineStyle?: ", - "LineStyle", - " | undefined; textVisibility?: boolean | undefined; }" - ], - "path": "src/plugins/event_annotation/common/query_point_event_annotation/types.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "eventAnnotation", - "id": "def-common.QueryPointEventAnnotationConfig", - "type": "Type", - "tags": [], - "label": "QueryPointEventAnnotationConfig", - "description": [], - "signature": [ - "{ id: string; type: \"query\"; filter: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataSearchPluginApi", - "section": "def-common.KibanaQueryOutput", - "text": "KibanaQueryOutput" - }, - "; timeField?: string | undefined; textField?: string | undefined; extraFields?: string[] | undefined; key: { type: \"point_in_time\"; }; } & StyleSharedProps & { icon?: ", { - "pluginId": "eventAnnotation", - "scope": "common", - "docId": "kibEventAnnotationPluginApi", - "section": "def-common.AvailableAnnotationIcon", - "text": "AvailableAnnotationIcon" + "pluginId": "@kbn/visualization-ui-components", + "scope": "public", + "docId": "kibKbnVisualizationUiComponentsPluginApi", + "section": "def-public.LineStyle", + "text": "LineStyle" }, - " | undefined; lineWidth?: number | undefined; lineStyle?: ", - "LineStyle", " | undefined; textVisibility?: boolean | undefined; }" ], - "path": "src/plugins/event_annotation/common/types.ts", + "path": "src/plugins/event_annotation/common/query_point_event_annotation/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -2102,35 +1288,26 @@ }, "; timeField?: string | undefined; extraFields?: string[] | undefined; textField?: string | undefined; } & StyleSharedProps & { icon?: ", { - "pluginId": "eventAnnotation", + "pluginId": "@kbn/event-annotation-common", "scope": "common", - "docId": "kibEventAnnotationPluginApi", + "docId": "kibKbnEventAnnotationCommonPluginApi", "section": "def-common.AvailableAnnotationIcon", "text": "AvailableAnnotationIcon" }, " | undefined; lineWidth?: number | undefined; lineStyle?: ", - "LineStyle", + { + "pluginId": "@kbn/visualization-ui-components", + "scope": "public", + "docId": "kibKbnVisualizationUiComponentsPluginApi", + "section": "def-public.LineStyle", + "text": "LineStyle" + }, " | undefined; textVisibility?: boolean | undefined; } & { type: \"query_point_event_annotation\"; }" ], "path": "src/plugins/event_annotation/common/query_point_event_annotation/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false - }, - { - "parentPluginId": "eventAnnotation", - "id": "def-common.RangeEventAnnotationConfig", - "type": "Type", - "tags": [], - "label": "RangeEventAnnotationConfig", - "description": [], - "signature": [ - "{ type: \"manual\"; id: string; key: { type: \"range\"; timestamp: string; endTimestamp: string; }; } & StyleSharedProps & { outside?: boolean | undefined; }" - ], - "path": "src/plugins/event_annotation/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false } ], "objects": [ @@ -2671,14 +1848,20 @@ }, ") => { id: string; time: string; label: string; color?: string | undefined; isHidden?: boolean | undefined; icon?: ", { - "pluginId": "eventAnnotation", + "pluginId": "@kbn/event-annotation-common", "scope": "common", - "docId": "kibEventAnnotationPluginApi", + "docId": "kibKbnEventAnnotationCommonPluginApi", "section": "def-common.AvailableAnnotationIcon", "text": "AvailableAnnotationIcon" }, " | undefined; lineWidth?: number | undefined; lineStyle?: ", - "LineStyle", + { + "pluginId": "@kbn/visualization-ui-components", + "scope": "public", + "docId": "kibKbnVisualizationUiComponentsPluginApi", + "section": "def-public.LineStyle", + "text": "LineStyle" + }, " | undefined; textVisibility?: boolean | undefined; type: \"manual_point_event_annotation\"; }" ], "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", @@ -2710,14 +1893,20 @@ "signature": [ "{ id: string; time: string; } & StyleSharedProps & { icon?: ", { - "pluginId": "eventAnnotation", + "pluginId": "@kbn/event-annotation-common", "scope": "common", - "docId": "kibEventAnnotationPluginApi", + "docId": "kibKbnEventAnnotationCommonPluginApi", "section": "def-common.AvailableAnnotationIcon", "text": "AvailableAnnotationIcon" }, " | undefined; lineWidth?: number | undefined; lineStyle?: ", - "LineStyle", + { + "pluginId": "@kbn/visualization-ui-components", + "scope": "public", + "docId": "kibKbnVisualizationUiComponentsPluginApi", + "section": "def-public.LineStyle", + "text": "LineStyle" + }, " | undefined; textVisibility?: boolean | undefined; }" ], "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", @@ -3887,14 +3076,20 @@ }, "; timeField?: string | undefined; extraFields?: string[] | undefined; textField?: string | undefined; label: string; color?: string | undefined; isHidden?: boolean | undefined; icon?: ", { - "pluginId": "eventAnnotation", + "pluginId": "@kbn/event-annotation-common", "scope": "common", - "docId": "kibEventAnnotationPluginApi", + "docId": "kibKbnEventAnnotationCommonPluginApi", "section": "def-common.AvailableAnnotationIcon", "text": "AvailableAnnotationIcon" }, " | undefined; lineWidth?: number | undefined; lineStyle?: ", - "LineStyle", + { + "pluginId": "@kbn/visualization-ui-components", + "scope": "public", + "docId": "kibKbnVisualizationUiComponentsPluginApi", + "section": "def-public.LineStyle", + "text": "LineStyle" + }, " | undefined; textVisibility?: boolean | undefined; type: \"query_point_event_annotation\"; }" ], "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", @@ -3934,14 +3129,20 @@ }, "; timeField?: string | undefined; extraFields?: string[] | undefined; textField?: string | undefined; } & StyleSharedProps & { icon?: ", { - "pluginId": "eventAnnotation", + "pluginId": "@kbn/event-annotation-common", "scope": "common", - "docId": "kibEventAnnotationPluginApi", + "docId": "kibKbnEventAnnotationCommonPluginApi", "section": "def-common.AvailableAnnotationIcon", "text": "AvailableAnnotationIcon" }, " | undefined; lineWidth?: number | undefined; lineStyle?: ", - "LineStyle", + { + "pluginId": "@kbn/visualization-ui-components", + "scope": "public", + "docId": "kibKbnVisualizationUiComponentsPluginApi", + "section": "def-public.LineStyle", + "text": "LineStyle" + }, " | undefined; textVisibility?: boolean | undefined; }" ], "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", diff --git a/api_docs/event_annotation.mdx b/api_docs/event_annotation.mdx index 5364940099acc..b0fc696f93af6 100644 --- a/api_docs/event_annotation.mdx +++ b/api_docs/event_annotation.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventAnnotation title: "eventAnnotation" image: https://source.unsplash.com/400x175/?github description: API docs for the eventAnnotation plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation'] --- import eventAnnotationObj from './event_annotation.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 236 | 30 | 236 | 4 | +| 192 | 30 | 192 | 2 | ## Client @@ -31,15 +31,9 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k ### Start -### Functions - - ### Interfaces -### Consts, variables and types - - ## Common ### Objects diff --git a/api_docs/event_log.mdx b/api_docs/event_log.mdx index ae328fd1164ba..b85c77b1353d3 100644 --- a/api_docs/event_log.mdx +++ b/api_docs/event_log.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventLog title: "eventLog" image: https://source.unsplash.com/400x175/?github description: API docs for the eventLog plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog'] --- import eventLogObj from './event_log.devdocs.json'; diff --git a/api_docs/exploratory_view.devdocs.json b/api_docs/exploratory_view.devdocs.json index d057f52840ecc..7a3538c920f49 100644 --- a/api_docs/exploratory_view.devdocs.json +++ b/api_docs/exploratory_view.devdocs.json @@ -2337,158 +2337,7 @@ "functions": [], "interfaces": [], "enums": [], - "misc": [ - { - "parentPluginId": "exploratoryView", - "id": "def-common.NETWORK_TIMINGS_FIELDS", - "type": "Array", - "tags": [], - "label": "NETWORK_TIMINGS_FIELDS", - "description": [], - "signature": [ - "string[]" - ], - "path": "x-pack/plugins/exploratory_view/common/field_names/synthetics.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "exploratoryView", - "id": "def-common.SYNTHETICS_BLOCKED_TIMINGS", - "type": "string", - "tags": [], - "label": "SYNTHETICS_BLOCKED_TIMINGS", - "description": [], - "signature": [ - "\"synthetics.payload.timings.blocked\"" - ], - "path": "x-pack/plugins/exploratory_view/common/field_names/synthetics.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "exploratoryView", - "id": "def-common.SYNTHETICS_CONNECT_TIMINGS", - "type": "string", - "tags": [], - "label": "SYNTHETICS_CONNECT_TIMINGS", - "description": [], - "signature": [ - "\"synthetics.payload.timings.connect\"" - ], - "path": "x-pack/plugins/exploratory_view/common/field_names/synthetics.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "exploratoryView", - "id": "def-common.SYNTHETICS_DNS_TIMINGS", - "type": "string", - "tags": [], - "label": "SYNTHETICS_DNS_TIMINGS", - "description": [], - "signature": [ - "\"synthetics.payload.timings.dns\"" - ], - "path": "x-pack/plugins/exploratory_view/common/field_names/synthetics.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "exploratoryView", - "id": "def-common.SYNTHETICS_RECEIVE_TIMINGS", - "type": "string", - "tags": [], - "label": "SYNTHETICS_RECEIVE_TIMINGS", - "description": [], - "signature": [ - "\"synthetics.payload.timings.receive\"" - ], - "path": "x-pack/plugins/exploratory_view/common/field_names/synthetics.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "exploratoryView", - "id": "def-common.SYNTHETICS_SEND_TIMINGS", - "type": "string", - "tags": [], - "label": "SYNTHETICS_SEND_TIMINGS", - "description": [], - "signature": [ - "\"synthetics.payload.timings.send\"" - ], - "path": "x-pack/plugins/exploratory_view/common/field_names/synthetics.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "exploratoryView", - "id": "def-common.SYNTHETICS_SSL_TIMINGS", - "type": "string", - "tags": [], - "label": "SYNTHETICS_SSL_TIMINGS", - "description": [], - "signature": [ - "\"synthetics.payload.timings.ssl\"" - ], - "path": "x-pack/plugins/exploratory_view/common/field_names/synthetics.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "exploratoryView", - "id": "def-common.SYNTHETICS_STEP_DURATION", - "type": "string", - "tags": [], - "label": "SYNTHETICS_STEP_DURATION", - "description": [], - "signature": [ - "\"synthetics.step.duration.us\"" - ], - "path": "x-pack/plugins/exploratory_view/common/field_names/synthetics.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "exploratoryView", - "id": "def-common.SYNTHETICS_TOTAL_TIMINGS", - "type": "string", - "tags": [], - "label": "SYNTHETICS_TOTAL_TIMINGS", - "description": [], - "signature": [ - "\"synthetics.payload.timings.total\"" - ], - "path": "x-pack/plugins/exploratory_view/common/field_names/synthetics.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "exploratoryView", - "id": "def-common.SYNTHETICS_WAIT_TIMINGS", - "type": "string", - "tags": [], - "label": "SYNTHETICS_WAIT_TIMINGS", - "description": [], - "signature": [ - "\"synthetics.payload.timings.wait\"" - ], - "path": "x-pack/plugins/exploratory_view/common/field_names/synthetics.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - } - ], + "misc": [], "objects": [] } } \ No newline at end of file diff --git a/api_docs/exploratory_view.mdx b/api_docs/exploratory_view.mdx index 2694ba0efd2bf..2f4c7d34342dc 100644 --- a/api_docs/exploratory_view.mdx +++ b/api_docs/exploratory_view.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/exploratoryView title: "exploratoryView" image: https://source.unsplash.com/400x175/?github description: API docs for the exploratoryView plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'exploratoryView'] --- import exploratoryViewObj from './exploratory_view.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/uptime](https://github.com/orgs/elastic/teams/uptime) for ques | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 141 | 1 | 141 | 14 | +| 131 | 1 | 131 | 14 | ## Client @@ -43,8 +43,3 @@ Contact [@elastic/uptime](https://github.com/orgs/elastic/teams/uptime) for ques ### Consts, variables and types -## Common - -### Consts, variables and types - - diff --git a/api_docs/expression_error.mdx b/api_docs/expression_error.mdx index e7967eeaca8f3..bc1b7f1e40f2a 100644 --- a/api_docs/expression_error.mdx +++ b/api_docs/expression_error.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionError title: "expressionError" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionError plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionError'] --- import expressionErrorObj from './expression_error.devdocs.json'; diff --git a/api_docs/expression_gauge.mdx b/api_docs/expression_gauge.mdx index 8373065ef030e..1452efc3ccf08 100644 --- a/api_docs/expression_gauge.mdx +++ b/api_docs/expression_gauge.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionGauge title: "expressionGauge" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionGauge plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionGauge'] --- import expressionGaugeObj from './expression_gauge.devdocs.json'; diff --git a/api_docs/expression_heatmap.mdx b/api_docs/expression_heatmap.mdx index 6d4eb1c010933..b8e9f061560c5 100644 --- a/api_docs/expression_heatmap.mdx +++ b/api_docs/expression_heatmap.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionHeatmap title: "expressionHeatmap" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionHeatmap plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionHeatmap'] --- import expressionHeatmapObj from './expression_heatmap.devdocs.json'; diff --git a/api_docs/expression_image.mdx b/api_docs/expression_image.mdx index 19a7dd01ee13e..cba670a39d608 100644 --- a/api_docs/expression_image.mdx +++ b/api_docs/expression_image.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionImage title: "expressionImage" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionImage plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionImage'] --- import expressionImageObj from './expression_image.devdocs.json'; diff --git a/api_docs/expression_legacy_metric_vis.mdx b/api_docs/expression_legacy_metric_vis.mdx index 44793c00bee3d..74137afc17dbc 100644 --- a/api_docs/expression_legacy_metric_vis.mdx +++ b/api_docs/expression_legacy_metric_vis.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionLegacyMetricVis title: "expressionLegacyMetricVis" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionLegacyMetricVis plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionLegacyMetricVis'] --- import expressionLegacyMetricVisObj from './expression_legacy_metric_vis.devdocs.json'; diff --git a/api_docs/expression_metric.mdx b/api_docs/expression_metric.mdx index 7e4d7ed60343a..2f5807bbf2c6d 100644 --- a/api_docs/expression_metric.mdx +++ b/api_docs/expression_metric.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionMetric title: "expressionMetric" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionMetric plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetric'] --- import expressionMetricObj from './expression_metric.devdocs.json'; diff --git a/api_docs/expression_metric_vis.mdx b/api_docs/expression_metric_vis.mdx index 71d6bb1e7adf4..0a36d450166c1 100644 --- a/api_docs/expression_metric_vis.mdx +++ b/api_docs/expression_metric_vis.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionMetricVis title: "expressionMetricVis" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionMetricVis plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetricVis'] --- import expressionMetricVisObj from './expression_metric_vis.devdocs.json'; diff --git a/api_docs/expression_partition_vis.mdx b/api_docs/expression_partition_vis.mdx index c37e371814afc..a09aa038494b1 100644 --- a/api_docs/expression_partition_vis.mdx +++ b/api_docs/expression_partition_vis.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionPartitionVis title: "expressionPartitionVis" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionPartitionVis plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionPartitionVis'] --- import expressionPartitionVisObj from './expression_partition_vis.devdocs.json'; diff --git a/api_docs/expression_repeat_image.mdx b/api_docs/expression_repeat_image.mdx index 590ef7c4d56fb..bc467a95f7d2a 100644 --- a/api_docs/expression_repeat_image.mdx +++ b/api_docs/expression_repeat_image.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionRepeatImage title: "expressionRepeatImage" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionRepeatImage plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRepeatImage'] --- import expressionRepeatImageObj from './expression_repeat_image.devdocs.json'; diff --git a/api_docs/expression_reveal_image.mdx b/api_docs/expression_reveal_image.mdx index ebc9b628e0530..fffb646bef74c 100644 --- a/api_docs/expression_reveal_image.mdx +++ b/api_docs/expression_reveal_image.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionRevealImage title: "expressionRevealImage" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionRevealImage plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRevealImage'] --- import expressionRevealImageObj from './expression_reveal_image.devdocs.json'; diff --git a/api_docs/expression_shape.mdx b/api_docs/expression_shape.mdx index d86d0ae3509af..5cde16ec19504 100644 --- a/api_docs/expression_shape.mdx +++ b/api_docs/expression_shape.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionShape title: "expressionShape" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionShape plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionShape'] --- import expressionShapeObj from './expression_shape.devdocs.json'; diff --git a/api_docs/expression_tagcloud.mdx b/api_docs/expression_tagcloud.mdx index 85f18ea25427c..bc7710f626a78 100644 --- a/api_docs/expression_tagcloud.mdx +++ b/api_docs/expression_tagcloud.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionTagcloud title: "expressionTagcloud" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionTagcloud plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionTagcloud'] --- import expressionTagcloudObj from './expression_tagcloud.devdocs.json'; diff --git a/api_docs/expression_x_y.mdx b/api_docs/expression_x_y.mdx index ee2b844da1d64..d57ebbe54297e 100644 --- a/api_docs/expression_x_y.mdx +++ b/api_docs/expression_x_y.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionXY title: "expressionXY" image: https://source.unsplash.com/400x175/?github description: API docs for the expressionXY plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionXY'] --- import expressionXYObj from './expression_x_y.devdocs.json'; diff --git a/api_docs/expressions.mdx b/api_docs/expressions.mdx index a58ece1eff7a5..a2e25acedca71 100644 --- a/api_docs/expressions.mdx +++ b/api_docs/expressions.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressions title: "expressions" image: https://source.unsplash.com/400x175/?github description: API docs for the expressions plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions'] --- import expressionsObj from './expressions.devdocs.json'; diff --git a/api_docs/features.mdx b/api_docs/features.mdx index 90661245687eb..144afa2bc84a6 100644 --- a/api_docs/features.mdx +++ b/api_docs/features.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/features title: "features" image: https://source.unsplash.com/400x175/?github description: API docs for the features plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features'] --- import featuresObj from './features.devdocs.json'; diff --git a/api_docs/field_formats.mdx b/api_docs/field_formats.mdx index 637d41fac6a29..2982db4680850 100644 --- a/api_docs/field_formats.mdx +++ b/api_docs/field_formats.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fieldFormats title: "fieldFormats" image: https://source.unsplash.com/400x175/?github description: API docs for the fieldFormats plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats'] --- import fieldFormatsObj from './field_formats.devdocs.json'; diff --git a/api_docs/file_upload.mdx b/api_docs/file_upload.mdx index 97587fa96493e..b2d86dc6c1cfd 100644 --- a/api_docs/file_upload.mdx +++ b/api_docs/file_upload.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fileUpload title: "fileUpload" image: https://source.unsplash.com/400x175/?github description: API docs for the fileUpload plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload'] --- import fileUploadObj from './file_upload.devdocs.json'; diff --git a/api_docs/files.mdx b/api_docs/files.mdx index 8e94b08147a8e..2b7991e019f54 100644 --- a/api_docs/files.mdx +++ b/api_docs/files.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/files title: "files" image: https://source.unsplash.com/400x175/?github description: API docs for the files plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'files'] --- import filesObj from './files.devdocs.json'; diff --git a/api_docs/files_management.mdx b/api_docs/files_management.mdx index fcecdf57b2296..da0648ba1fa24 100644 --- a/api_docs/files_management.mdx +++ b/api_docs/files_management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/filesManagement title: "filesManagement" image: https://source.unsplash.com/400x175/?github description: API docs for the filesManagement plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'filesManagement'] --- import filesManagementObj from './files_management.devdocs.json'; diff --git a/api_docs/fleet.devdocs.json b/api_docs/fleet.devdocs.json index a5eb0c5dd285e..ee84d6deead3a 100644 --- a/api_docs/fleet.devdocs.json +++ b/api_docs/fleet.devdocs.json @@ -3899,6 +3899,22 @@ "children": [], "returnComment": [] }, + { + "parentPluginId": "fleet", + "id": "def-public.pagePathGetters.uninstall_tokens", + "type": "Function", + "tags": [], + "label": "uninstall_tokens", + "description": [], + "signature": [ + "() => [string, string]" + ], + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + }, { "parentPluginId": "fleet", "id": "def-public.pagePathGetters.data_streams", @@ -20305,7 +20321,7 @@ "label": "install_source", "description": [], "signature": [ - "\"upload\" | \"registry\" | \"bundled\"" + "\"custom\" | \"upload\" | \"registry\" | \"bundled\"" ], "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false, @@ -20509,7 +20525,7 @@ "label": "installSource", "description": [], "signature": [ - "\"upload\" | \"registry\" | \"bundled\"" + "\"custom\" | \"upload\" | \"registry\" | \"bundled\"" ], "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", "deprecated": false, @@ -22630,6 +22646,21 @@ "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.lifecycle", + "type": "Object", + "tags": [], + "label": "[RegistryDataStreamKeys.lifecycle]", + "description": [], + "signature": [ + "RegistryDataStreamLifecycle", + " | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -26750,6 +26781,17 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "fleet", + "id": "def-common.EPM_API_ROUTES.CUSTOM_INTEGRATIONS_PATTERN", + "type": "string", + "tags": [], + "label": "CUSTOM_INTEGRATIONS_PATTERN", + "description": [], + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "fleet", "id": "def-common.EPM_API_ROUTES.DELETE_PATTERN", diff --git a/api_docs/fleet.mdx b/api_docs/fleet.mdx index 5533a02e4c496..523c25656cf83 100644 --- a/api_docs/fleet.mdx +++ b/api_docs/fleet.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fleet title: "fleet" image: https://source.unsplash.com/400x175/?github description: API docs for the fleet plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet'] --- import fleetObj from './fleet.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/fleet](https://github.com/orgs/elastic/teams/fleet) for questi | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 1179 | 3 | 1063 | 39 | +| 1182 | 3 | 1066 | 40 | ## Client diff --git a/api_docs/global_search.mdx b/api_docs/global_search.mdx index d2193fc298d04..75d231af5de5f 100644 --- a/api_docs/global_search.mdx +++ b/api_docs/global_search.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/globalSearch title: "globalSearch" image: https://source.unsplash.com/400x175/?github description: API docs for the globalSearch plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch'] --- import globalSearchObj from './global_search.devdocs.json'; diff --git a/api_docs/guided_onboarding.mdx b/api_docs/guided_onboarding.mdx index 200ddd283c321..f91d599ddf681 100644 --- a/api_docs/guided_onboarding.mdx +++ b/api_docs/guided_onboarding.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/guidedOnboarding title: "guidedOnboarding" image: https://source.unsplash.com/400x175/?github description: API docs for the guidedOnboarding plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'guidedOnboarding'] --- import guidedOnboardingObj from './guided_onboarding.devdocs.json'; diff --git a/api_docs/home.mdx b/api_docs/home.mdx index dfb874a8fc880..7e0c1514553bb 100644 --- a/api_docs/home.mdx +++ b/api_docs/home.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/home title: "home" image: https://source.unsplash.com/400x175/?github description: API docs for the home plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'home'] --- import homeObj from './home.devdocs.json'; diff --git a/api_docs/image_embeddable.mdx b/api_docs/image_embeddable.mdx index 4a484b4aa6d1d..6a72cd9913613 100644 --- a/api_docs/image_embeddable.mdx +++ b/api_docs/image_embeddable.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/imageEmbeddable title: "imageEmbeddable" image: https://source.unsplash.com/400x175/?github description: API docs for the imageEmbeddable plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'imageEmbeddable'] --- import imageEmbeddableObj from './image_embeddable.devdocs.json'; diff --git a/api_docs/index_lifecycle_management.mdx b/api_docs/index_lifecycle_management.mdx index 8a7a53787ab26..7de7975665f13 100644 --- a/api_docs/index_lifecycle_management.mdx +++ b/api_docs/index_lifecycle_management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/indexLifecycleManagement title: "indexLifecycleManagement" image: https://source.unsplash.com/400x175/?github description: API docs for the indexLifecycleManagement plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexLifecycleManagement'] --- import indexLifecycleManagementObj from './index_lifecycle_management.devdocs.json'; diff --git a/api_docs/index_management.devdocs.json b/api_docs/index_management.devdocs.json index bfdd40f900a37..15ae3372c6048 100644 --- a/api_docs/index_management.devdocs.json +++ b/api_docs/index_management.devdocs.json @@ -750,7 +750,7 @@ "label": "IndexManagementConfig", "description": [], "signature": [ - "{ readonly ui: Readonly<{} & { enabled: boolean; }>; }" + "{ readonly ui: Readonly<{} & { enabled: boolean; }>; readonly enableIndexActions: boolean; }" ], "path": "x-pack/plugins/index_management/server/config.ts", "deprecated": false, diff --git a/api_docs/index_management.mdx b/api_docs/index_management.mdx index d6f48042ed408..23d7c394f8e13 100644 --- a/api_docs/index_management.mdx +++ b/api_docs/index_management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/indexManagement title: "indexManagement" image: https://source.unsplash.com/400x175/?github description: API docs for the indexManagement plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement'] --- import indexManagementObj from './index_management.devdocs.json'; diff --git a/api_docs/infra.devdocs.json b/api_docs/infra.devdocs.json index 8e89a67df15ec..96f62ca88f47d 100644 --- a/api_docs/infra.devdocs.json +++ b/api_docs/infra.devdocs.json @@ -443,6 +443,17 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "infra", + "id": "def-server.InfraConfig.enabled", + "type": "boolean", + "tags": [], + "label": "enabled", + "description": [], + "path": "x-pack/plugins/infra/common/plugin_config_types.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "infra", "id": "def-server.InfraConfig.inventory", diff --git a/api_docs/infra.mdx b/api_docs/infra.mdx index 4e69c773e8a69..ae79ca13aa95f 100644 --- a/api_docs/infra.mdx +++ b/api_docs/infra.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/infra title: "infra" image: https://source.unsplash.com/400x175/?github description: API docs for the infra plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'infra'] --- import infraObj from './infra.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/infra-monitoring-ui](https://github.com/orgs/elastic/teams/inf | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 44 | 0 | 41 | 11 | +| 45 | 0 | 42 | 11 | ## Client diff --git a/api_docs/inspector.mdx b/api_docs/inspector.mdx index 12f05417a90a8..6bde33e4e402b 100644 --- a/api_docs/inspector.mdx +++ b/api_docs/inspector.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/inspector title: "inspector" image: https://source.unsplash.com/400x175/?github description: API docs for the inspector plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inspector'] --- import inspectorObj from './inspector.devdocs.json'; diff --git a/api_docs/interactive_setup.mdx b/api_docs/interactive_setup.mdx index 9a54b5f51ee88..2f2f2deb10262 100644 --- a/api_docs/interactive_setup.mdx +++ b/api_docs/interactive_setup.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/interactiveSetup title: "interactiveSetup" image: https://source.unsplash.com/400x175/?github description: API docs for the interactiveSetup plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'interactiveSetup'] --- import interactiveSetupObj from './interactive_setup.devdocs.json'; diff --git a/api_docs/kbn_ace.mdx b/api_docs/kbn_ace.mdx index f9ddf1e99904b..2046e0566882c 100644 --- a/api_docs/kbn_ace.mdx +++ b/api_docs/kbn_ace.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ace title: "@kbn/ace" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ace plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ace'] --- import kbnAceObj from './kbn_ace.devdocs.json'; diff --git a/api_docs/kbn_aiops_components.mdx b/api_docs/kbn_aiops_components.mdx index 0f7b2497feed4..fc6cd3d8f66bc 100644 --- a/api_docs/kbn_aiops_components.mdx +++ b/api_docs/kbn_aiops_components.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-components title: "@kbn/aiops-components" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/aiops-components plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-components'] --- import kbnAiopsComponentsObj from './kbn_aiops_components.devdocs.json'; diff --git a/api_docs/kbn_aiops_utils.mdx b/api_docs/kbn_aiops_utils.mdx index 1a2d7e193ff44..ead30fd831d92 100644 --- a/api_docs/kbn_aiops_utils.mdx +++ b/api_docs/kbn_aiops_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-utils title: "@kbn/aiops-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/aiops-utils plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-utils'] --- import kbnAiopsUtilsObj from './kbn_aiops_utils.devdocs.json'; diff --git a/api_docs/kbn_alerting_state_types.mdx b/api_docs/kbn_alerting_state_types.mdx index 1fbb9cecf8b29..f3076136c0277 100644 --- a/api_docs/kbn_alerting_state_types.mdx +++ b/api_docs/kbn_alerting_state_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerting-state-types title: "@kbn/alerting-state-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/alerting-state-types plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerting-state-types'] --- import kbnAlertingStateTypesObj from './kbn_alerting_state_types.devdocs.json'; diff --git a/api_docs/kbn_alerts_as_data_utils.devdocs.json b/api_docs/kbn_alerts_as_data_utils.devdocs.json index 9849eec4e5d5b..c58905ca35d4f 100644 --- a/api_docs/kbn_alerts_as_data_utils.devdocs.json +++ b/api_docs/kbn_alerts_as_data_utils.devdocs.json @@ -148,7 +148,7 @@ "label": "AADAlert", "description": [], "signature": [ - "({ '@timestamp': string; kibana: { alert: { instance: { id: string; }; rule: { category: string; consumer: string; name: string; producer: string; revision: string | number; rule_type_id: string; uuid: string; }; status: string; uuid: string; }; space_ids: string[]; }; } & { event?: { action?: string | undefined; kind?: string | undefined; } | undefined; kibana?: { alert?: { action_group?: string | undefined; case_ids?: string[] | undefined; duration?: { us?: string | number | undefined; } | undefined; end?: string | undefined; flapping?: boolean | undefined; flapping_history?: boolean[] | undefined; last_detected?: string | undefined; maintenance_window_ids?: string[] | undefined; reason?: string | undefined; rule?: { execution?: { uuid?: string | undefined; } | undefined; parameters?: unknown; tags?: string[] | undefined; } | undefined; start?: string | undefined; time_range?: { gte?: string | undefined; lte?: string | undefined; } | undefined; url?: string | undefined; workflow_status?: string | undefined; workflow_tags?: string[] | undefined; } | undefined; version?: string | undefined; } | undefined; tags?: string[] | undefined; }) | ({} & { agent?: { name?: string | undefined; } | undefined; error?: { grouping_key?: string | undefined; } | undefined; kibana?: { alert?: { evaluation?: { threshold?: string | number | undefined; value?: string | number | undefined; values?: (string | number)[] | undefined; } | undefined; } | undefined; } | undefined; processor?: { event?: string | undefined; } | undefined; service?: { environment?: string | undefined; language?: { name?: string | undefined; } | undefined; name?: string | undefined; } | undefined; transaction?: { name?: string | undefined; type?: string | undefined; } | undefined; } & { '@timestamp': string; kibana: { alert: { instance: { id: string; }; rule: { category: string; consumer: string; name: string; producer: string; revision: string | number; rule_type_id: string; uuid: string; }; status: string; uuid: string; }; space_ids: string[]; }; } & { event?: { action?: string | undefined; kind?: string | undefined; } | undefined; kibana?: { alert?: { action_group?: string | undefined; case_ids?: string[] | undefined; duration?: { us?: string | number | undefined; } | undefined; end?: string | undefined; flapping?: boolean | undefined; flapping_history?: boolean[] | undefined; last_detected?: string | undefined; maintenance_window_ids?: string[] | undefined; reason?: string | undefined; rule?: { execution?: { uuid?: string | undefined; } | undefined; parameters?: unknown; tags?: string[] | undefined; } | undefined; start?: string | undefined; time_range?: { gte?: string | undefined; lte?: string | undefined; } | undefined; url?: string | undefined; workflow_status?: string | undefined; workflow_tags?: string[] | undefined; } | undefined; version?: string | undefined; } | undefined; tags?: string[] | undefined; } & {} & { ecs?: { version?: string | undefined; } | undefined; kibana?: { alert?: { risk_score?: number | undefined; rule?: { author?: string | undefined; created_at?: string | undefined; created_by?: string | undefined; description?: string | undefined; enabled?: string | undefined; from?: string | undefined; interval?: string | undefined; license?: string | undefined; note?: string | undefined; references?: string[] | undefined; rule_id?: string | undefined; rule_name_override?: string | undefined; to?: string | undefined; type?: string | undefined; updated_at?: string | undefined; updated_by?: string | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; suppression?: { docs_count?: string | number | undefined; end?: string | undefined; start?: string | undefined; terms?: { field?: string[] | undefined; value?: string[] | undefined; } | undefined; } | undefined; system_status?: string | undefined; workflow_reason?: string | undefined; workflow_user?: string | undefined; } | undefined; } | undefined; }) | ({} & { kibana?: { alert?: { evaluation?: { threshold?: string | number | undefined; value?: string | number | undefined; values?: (string | number)[] | undefined; } | undefined; } | undefined; } | undefined; } & { '@timestamp': string; kibana: { alert: { instance: { id: string; }; rule: { category: string; consumer: string; name: string; producer: string; revision: string | number; rule_type_id: string; uuid: string; }; status: string; uuid: string; }; space_ids: string[]; }; } & { event?: { action?: string | undefined; kind?: string | undefined; } | undefined; kibana?: { alert?: { action_group?: string | undefined; case_ids?: string[] | undefined; duration?: { us?: string | number | undefined; } | undefined; end?: string | undefined; flapping?: boolean | undefined; flapping_history?: boolean[] | undefined; last_detected?: string | undefined; maintenance_window_ids?: string[] | undefined; reason?: string | undefined; rule?: { execution?: { uuid?: string | undefined; } | undefined; parameters?: unknown; tags?: string[] | undefined; } | undefined; start?: string | undefined; time_range?: { gte?: string | undefined; lte?: string | undefined; } | undefined; url?: string | undefined; workflow_status?: string | undefined; workflow_tags?: string[] | undefined; } | undefined; version?: string | undefined; } | undefined; tags?: string[] | undefined; } & { '@timestamp': string; ecs: { version: string; }; } & { agent?: { build?: { original?: string | undefined; } | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; client?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; cloud?: { account?: { id?: string | undefined; name?: string | undefined; } | undefined; availability_zone?: string | undefined; instance?: { id?: string | undefined; name?: string | undefined; } | undefined; machine?: { type?: string | undefined; } | undefined; origin?: { account?: { id?: string | undefined; name?: string | undefined; } | undefined; availability_zone?: string | undefined; instance?: { id?: string | undefined; name?: string | undefined; } | undefined; machine?: { type?: string | undefined; } | undefined; project?: { id?: string | undefined; name?: string | undefined; } | undefined; provider?: string | undefined; region?: string | undefined; service?: { name?: string | undefined; } | undefined; } | undefined; project?: { id?: string | undefined; name?: string | undefined; } | undefined; provider?: string | undefined; region?: string | undefined; service?: { name?: string | undefined; } | undefined; target?: { account?: { id?: string | undefined; name?: string | undefined; } | undefined; availability_zone?: string | undefined; instance?: { id?: string | undefined; name?: string | undefined; } | undefined; machine?: { type?: string | undefined; } | undefined; project?: { id?: string | undefined; name?: string | undefined; } | undefined; provider?: string | undefined; region?: string | undefined; service?: { name?: string | undefined; } | undefined; } | undefined; } | undefined; container?: { cpu?: { usage?: string | number | undefined; } | undefined; disk?: { read?: { bytes?: string | number | undefined; } | undefined; write?: { bytes?: string | number | undefined; } | undefined; } | undefined; id?: string | undefined; image?: { hash?: { all?: string[] | undefined; } | undefined; name?: string | undefined; tag?: string[] | undefined; } | undefined; memory?: { usage?: string | number | undefined; } | undefined; name?: string | undefined; network?: { egress?: { bytes?: string | number | undefined; } | undefined; ingress?: { bytes?: string | number | undefined; } | undefined; } | undefined; runtime?: string | undefined; } | undefined; destination?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; device?: { id?: string | undefined; manufacturer?: string | undefined; model?: { identifier?: string | undefined; name?: string | undefined; } | undefined; } | undefined; dll?: { code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; name?: string | undefined; path?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; } | undefined; dns?: { answers?: { class?: string | undefined; data?: string | undefined; name?: string | undefined; ttl?: string | number | undefined; type?: string | undefined; }[] | undefined; header_flags?: string[] | undefined; id?: string | undefined; op_code?: string | undefined; question?: { class?: string | undefined; name?: string | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; type?: string | undefined; } | undefined; resolved_ip?: string[] | undefined; response_code?: string | undefined; type?: string | undefined; } | undefined; email?: { attachments?: { file?: { extension?: string | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; mime_type?: string | undefined; name?: string | undefined; size?: string | number | undefined; } | undefined; }[] | undefined; bcc?: { address?: string[] | undefined; } | undefined; cc?: { address?: string[] | undefined; } | undefined; content_type?: string | undefined; delivery_timestamp?: string | undefined; direction?: string | undefined; from?: { address?: string[] | undefined; } | undefined; local_id?: string | undefined; message_id?: string | undefined; origination_timestamp?: string | undefined; reply_to?: { address?: string[] | undefined; } | undefined; sender?: { address?: string | undefined; } | undefined; subject?: string | undefined; to?: { address?: string[] | undefined; } | undefined; x_mailer?: string | undefined; } | undefined; error?: { code?: string | undefined; id?: string | undefined; message?: string | undefined; stack_trace?: string | undefined; type?: string | undefined; } | undefined; event?: { action?: string | undefined; agent_id_status?: string | undefined; category?: string[] | undefined; code?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: string | number | undefined; end?: string | undefined; hash?: string | undefined; id?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; original?: string | undefined; outcome?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; severity?: string | number | undefined; start?: string | undefined; timezone?: string | undefined; type?: string[] | undefined; url?: string | undefined; } | undefined; faas?: { coldstart?: boolean | undefined; execution?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; } | undefined; file?: { accessed?: string | undefined; attributes?: string[] | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; created?: string | undefined; ctime?: string | undefined; device?: string | undefined; directory?: string | undefined; drive_letter?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; extension?: string | undefined; fork_name?: string | undefined; gid?: string | undefined; group?: string | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; inode?: string | undefined; mime_type?: string | undefined; mode?: string | undefined; mtime?: string | undefined; name?: string | undefined; owner?: string | undefined; path?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; size?: string | number | undefined; target_path?: string | undefined; type?: string | undefined; uid?: string | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; host?: { architecture?: string | undefined; boot?: { id?: string | undefined; } | undefined; cpu?: { usage?: string | number | undefined; } | undefined; disk?: { read?: { bytes?: string | number | undefined; } | undefined; write?: { bytes?: string | number | undefined; } | undefined; } | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; hostname?: string | undefined; id?: string | undefined; ip?: string[] | undefined; mac?: string[] | undefined; name?: string | undefined; network?: { egress?: { bytes?: string | number | undefined; packets?: string | number | undefined; } | undefined; ingress?: { bytes?: string | number | undefined; packets?: string | number | undefined; } | undefined; } | undefined; os?: { family?: string | undefined; full?: string | undefined; kernel?: string | undefined; name?: string | undefined; platform?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; pid_ns_ino?: string | undefined; risk?: { calculated_level?: string | undefined; calculated_score?: number | undefined; calculated_score_norm?: number | undefined; static_level?: string | undefined; static_score?: number | undefined; static_score_norm?: number | undefined; } | undefined; type?: string | undefined; uptime?: string | number | undefined; } | undefined; http?: { request?: { body?: { bytes?: string | number | undefined; content?: string | undefined; } | undefined; bytes?: string | number | undefined; id?: string | undefined; method?: string | undefined; mime_type?: string | undefined; referrer?: string | undefined; } | undefined; response?: { body?: { bytes?: string | number | undefined; content?: string | undefined; } | undefined; bytes?: string | number | undefined; mime_type?: string | undefined; status_code?: string | number | undefined; } | undefined; version?: string | undefined; } | undefined; log?: { file?: { path?: string | undefined; } | undefined; level?: string | undefined; logger?: string | undefined; origin?: { file?: { line?: string | number | undefined; name?: string | undefined; } | undefined; function?: string | undefined; } | undefined; } | undefined; message?: string | undefined; network?: { application?: string | undefined; bytes?: string | number | undefined; community_id?: string | undefined; direction?: string | undefined; forwarded_ip?: string | undefined; iana_number?: string | undefined; name?: string | undefined; packets?: string | number | undefined; protocol?: string | undefined; transport?: string | undefined; type?: string | undefined; vlan?: { id?: string | undefined; name?: string | undefined; } | undefined; } | undefined; observer?: { geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; hostname?: string | undefined; ip?: string[] | undefined; mac?: string[] | undefined; name?: string | undefined; os?: { family?: string | undefined; full?: string | undefined; kernel?: string | undefined; name?: string | undefined; platform?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; product?: string | undefined; serial_number?: string | undefined; type?: string | undefined; vendor?: string | undefined; version?: string | undefined; } | undefined; orchestrator?: { api_version?: string | undefined; cluster?: { id?: string | undefined; name?: string | undefined; url?: string | undefined; version?: string | undefined; } | undefined; namespace?: string | undefined; organization?: string | undefined; resource?: { id?: string | undefined; ip?: string[] | undefined; name?: string | undefined; parent?: { type?: string | undefined; } | undefined; type?: string | undefined; } | undefined; type?: string | undefined; } | undefined; organization?: { id?: string | undefined; name?: string | undefined; } | undefined; package?: { architecture?: string | undefined; build_version?: string | undefined; checksum?: string | undefined; description?: string | undefined; install_scope?: string | undefined; installed?: string | undefined; license?: string | undefined; name?: string | undefined; path?: string | undefined; reference?: string | undefined; size?: string | number | undefined; type?: string | undefined; version?: string | undefined; } | undefined; process?: { args?: string[] | undefined; args_count?: string | number | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; command_line?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; end?: string | undefined; entity_id?: string | undefined; entry_leader?: { args?: string[] | undefined; args_count?: string | number | undefined; attested_groups?: { name?: string | undefined; } | undefined; attested_user?: { id?: string | undefined; name?: string | undefined; } | undefined; command_line?: string | undefined; entity_id?: string | undefined; entry_meta?: { source?: { ip?: string | undefined; } | undefined; type?: string | undefined; } | undefined; executable?: string | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; parent?: { entity_id?: string | undefined; pid?: string | number | undefined; session_leader?: { entity_id?: string | undefined; pid?: string | number | undefined; start?: string | undefined; } | undefined; start?: string | undefined; } | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; same_as_process?: boolean | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; env_vars?: string[] | undefined; executable?: string | undefined; exit_code?: string | number | undefined; group_leader?: { args?: string[] | undefined; args_count?: string | number | undefined; command_line?: string | undefined; entity_id?: string | undefined; executable?: string | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; same_as_process?: boolean | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; parent?: { args?: string[] | undefined; args_count?: string | number | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; command_line?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; end?: string | undefined; entity_id?: string | undefined; executable?: string | undefined; exit_code?: string | number | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; group_leader?: { entity_id?: string | undefined; pid?: string | number | undefined; start?: string | undefined; } | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; pgid?: string | number | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; thread?: { id?: string | number | undefined; name?: string | undefined; } | undefined; title?: string | undefined; uptime?: string | number | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; pgid?: string | number | undefined; pid?: string | number | undefined; previous?: { args?: string[] | undefined; args_count?: string | number | undefined; executable?: string | undefined; } | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; session_leader?: { args?: string[] | undefined; args_count?: string | number | undefined; command_line?: string | undefined; entity_id?: string | undefined; executable?: string | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; parent?: { entity_id?: string | undefined; pid?: string | number | undefined; session_leader?: { entity_id?: string | undefined; pid?: string | number | undefined; start?: string | undefined; } | undefined; start?: string | undefined; } | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; same_as_process?: boolean | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; thread?: { id?: string | number | undefined; name?: string | undefined; } | undefined; title?: string | undefined; uptime?: string | number | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; registry?: { data?: { bytes?: string | undefined; strings?: string[] | undefined; type?: string | undefined; } | undefined; hive?: string | undefined; key?: string | undefined; path?: string | undefined; value?: string | undefined; } | undefined; related?: { hash?: string[] | undefined; hosts?: string[] | undefined; ip?: string[] | undefined; user?: string[] | undefined; } | undefined; rule?: { author?: string[] | undefined; category?: string | undefined; description?: string | undefined; id?: string | undefined; license?: string | undefined; name?: string | undefined; reference?: string | undefined; ruleset?: string | undefined; uuid?: string | undefined; version?: string | undefined; } | undefined; server?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; service?: { address?: string | undefined; environment?: string | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; node?: { name?: string | undefined; role?: string | undefined; roles?: string[] | undefined; } | undefined; origin?: { address?: string | undefined; environment?: string | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; node?: { name?: string | undefined; role?: string | undefined; roles?: string[] | undefined; } | undefined; state?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; state?: string | undefined; target?: { address?: string | undefined; environment?: string | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; node?: { name?: string | undefined; role?: string | undefined; roles?: string[] | undefined; } | undefined; state?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; type?: string | undefined; version?: string | undefined; } | undefined; source?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; span?: { id?: string | undefined; } | undefined; tags?: string[] | undefined; threat?: { enrichments?: { matched?: { atomic?: string | undefined; field?: string | undefined; id?: string | undefined; index?: string | undefined; occurred?: string | undefined; type?: string | undefined; } | undefined; }[] | undefined; feed?: { dashboard_id?: string | undefined; description?: string | undefined; name?: string | undefined; reference?: string | undefined; } | undefined; framework?: string | undefined; group?: { alias?: string[] | undefined; id?: string | undefined; name?: string | undefined; reference?: string | undefined; } | undefined; indicator?: { as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; confidence?: string | undefined; description?: string | undefined; email?: { address?: string | undefined; } | undefined; file?: { accessed?: string | undefined; attributes?: string[] | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; created?: string | undefined; ctime?: string | undefined; device?: string | undefined; directory?: string | undefined; drive_letter?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; extension?: string | undefined; fork_name?: string | undefined; gid?: string | undefined; group?: string | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; inode?: string | undefined; mime_type?: string | undefined; mode?: string | undefined; mtime?: string | undefined; name?: string | undefined; owner?: string | undefined; path?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; size?: string | number | undefined; target_path?: string | undefined; type?: string | undefined; uid?: string | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; first_seen?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; last_seen?: string | undefined; marking?: { tlp?: string | undefined; tlp_version?: string | undefined; } | undefined; modified_at?: string | undefined; port?: string | number | undefined; provider?: string | undefined; reference?: string | undefined; registry?: { data?: { bytes?: string | undefined; strings?: string[] | undefined; type?: string | undefined; } | undefined; hive?: string | undefined; key?: string | undefined; path?: string | undefined; value?: string | undefined; } | undefined; scanner_stats?: string | number | undefined; sightings?: string | number | undefined; type?: string | undefined; url?: { domain?: string | undefined; extension?: string | undefined; fragment?: string | undefined; full?: string | undefined; original?: string | undefined; password?: string | undefined; path?: string | undefined; port?: string | number | undefined; query?: string | undefined; registered_domain?: string | undefined; scheme?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; username?: string | undefined; } | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; software?: { alias?: string[] | undefined; id?: string | undefined; name?: string | undefined; platforms?: string[] | undefined; reference?: string | undefined; type?: string | undefined; } | undefined; tactic?: { id?: string[] | undefined; name?: string[] | undefined; reference?: string[] | undefined; } | undefined; technique?: { id?: string[] | undefined; name?: string[] | undefined; reference?: string[] | undefined; subtechnique?: { id?: string[] | undefined; name?: string[] | undefined; reference?: string[] | undefined; } | undefined; } | undefined; } | undefined; tls?: { cipher?: string | undefined; client?: { certificate?: string | undefined; certificate_chain?: string[] | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; } | undefined; issuer?: string | undefined; ja3?: string | undefined; not_after?: string | undefined; not_before?: string | undefined; server_name?: string | undefined; subject?: string | undefined; supported_ciphers?: string[] | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; curve?: string | undefined; established?: boolean | undefined; next_protocol?: string | undefined; resumed?: boolean | undefined; server?: { certificate?: string | undefined; certificate_chain?: string[] | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; } | undefined; issuer?: string | undefined; ja3s?: string | undefined; not_after?: string | undefined; not_before?: string | undefined; subject?: string | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; version?: string | undefined; version_protocol?: string | undefined; } | undefined; trace?: { id?: string | undefined; } | undefined; transaction?: { id?: string | undefined; } | undefined; url?: { domain?: string | undefined; extension?: string | undefined; fragment?: string | undefined; full?: string | undefined; original?: string | undefined; password?: string | undefined; path?: string | undefined; port?: string | number | undefined; query?: string | undefined; registered_domain?: string | undefined; scheme?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; username?: string | undefined; } | undefined; user?: { changes?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; domain?: string | undefined; effective?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; risk?: { calculated_level?: string | undefined; calculated_score?: number | undefined; calculated_score_norm?: number | undefined; static_level?: string | undefined; static_score?: number | undefined; static_score_norm?: number | undefined; } | undefined; roles?: string[] | undefined; target?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; user_agent?: { device?: { name?: string | undefined; } | undefined; name?: string | undefined; original?: string | undefined; os?: { family?: string | undefined; full?: string | undefined; kernel?: string | undefined; name?: string | undefined; platform?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; version?: string | undefined; } | undefined; vulnerability?: { category?: string[] | undefined; classification?: string | undefined; description?: string | undefined; enumeration?: string | undefined; id?: string | undefined; reference?: string | undefined; report_id?: string | undefined; scanner?: { vendor?: string | undefined; } | undefined; score?: { base?: number | undefined; environmental?: number | undefined; temporal?: number | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; } | undefined; } & {} & { ecs?: { version?: string | undefined; } | undefined; kibana?: { alert?: { risk_score?: number | undefined; rule?: { author?: string | undefined; created_at?: string | undefined; created_by?: string | undefined; description?: string | undefined; enabled?: string | undefined; from?: string | undefined; interval?: string | undefined; license?: string | undefined; note?: string | undefined; references?: string[] | undefined; rule_id?: string | undefined; rule_name_override?: string | undefined; to?: string | undefined; type?: string | undefined; updated_at?: string | undefined; updated_by?: string | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; suppression?: { docs_count?: string | number | undefined; end?: string | undefined; start?: string | undefined; terms?: { field?: string[] | undefined; value?: string[] | undefined; } | undefined; } | undefined; system_status?: string | undefined; workflow_reason?: string | undefined; workflow_user?: string | undefined; } | undefined; } | undefined; }) | ({} & { kibana?: { alert?: { evaluation?: { threshold?: string | number | undefined; value?: string | number | undefined; values?: (string | number)[] | undefined; } | undefined; } | undefined; } | undefined; } & { '@timestamp': string; kibana: { alert: { instance: { id: string; }; rule: { category: string; consumer: string; name: string; producer: string; revision: string | number; rule_type_id: string; uuid: string; }; status: string; uuid: string; }; space_ids: string[]; }; } & { event?: { action?: string | undefined; kind?: string | undefined; } | undefined; kibana?: { alert?: { action_group?: string | undefined; case_ids?: string[] | undefined; duration?: { us?: string | number | undefined; } | undefined; end?: string | undefined; flapping?: boolean | undefined; flapping_history?: boolean[] | undefined; last_detected?: string | undefined; maintenance_window_ids?: string[] | undefined; reason?: string | undefined; rule?: { execution?: { uuid?: string | undefined; } | undefined; parameters?: unknown; tags?: string[] | undefined; } | undefined; start?: string | undefined; time_range?: { gte?: string | undefined; lte?: string | undefined; } | undefined; url?: string | undefined; workflow_status?: string | undefined; workflow_tags?: string[] | undefined; } | undefined; version?: string | undefined; } | undefined; tags?: string[] | undefined; } & { '@timestamp': string; ecs: { version: string; }; } & { agent?: { build?: { original?: string | undefined; } | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; client?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; cloud?: { account?: { id?: string | undefined; name?: string | undefined; } | undefined; availability_zone?: string | undefined; instance?: { id?: string | undefined; name?: string | undefined; } | undefined; machine?: { type?: string | undefined; } | undefined; origin?: { account?: { id?: string | undefined; name?: string | undefined; } | undefined; availability_zone?: string | undefined; instance?: { id?: string | undefined; name?: string | undefined; } | undefined; machine?: { type?: string | undefined; } | undefined; project?: { id?: string | undefined; name?: string | undefined; } | undefined; provider?: string | undefined; region?: string | undefined; service?: { name?: string | undefined; } | undefined; } | undefined; project?: { id?: string | undefined; name?: string | undefined; } | undefined; provider?: string | undefined; region?: string | undefined; service?: { name?: string | undefined; } | undefined; target?: { account?: { id?: string | undefined; name?: string | undefined; } | undefined; availability_zone?: string | undefined; instance?: { id?: string | undefined; name?: string | undefined; } | undefined; machine?: { type?: string | undefined; } | undefined; project?: { id?: string | undefined; name?: string | undefined; } | undefined; provider?: string | undefined; region?: string | undefined; service?: { name?: string | undefined; } | undefined; } | undefined; } | undefined; container?: { cpu?: { usage?: string | number | undefined; } | undefined; disk?: { read?: { bytes?: string | number | undefined; } | undefined; write?: { bytes?: string | number | undefined; } | undefined; } | undefined; id?: string | undefined; image?: { hash?: { all?: string[] | undefined; } | undefined; name?: string | undefined; tag?: string[] | undefined; } | undefined; memory?: { usage?: string | number | undefined; } | undefined; name?: string | undefined; network?: { egress?: { bytes?: string | number | undefined; } | undefined; ingress?: { bytes?: string | number | undefined; } | undefined; } | undefined; runtime?: string | undefined; } | undefined; destination?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; device?: { id?: string | undefined; manufacturer?: string | undefined; model?: { identifier?: string | undefined; name?: string | undefined; } | undefined; } | undefined; dll?: { code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; name?: string | undefined; path?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; } | undefined; dns?: { answers?: { class?: string | undefined; data?: string | undefined; name?: string | undefined; ttl?: string | number | undefined; type?: string | undefined; }[] | undefined; header_flags?: string[] | undefined; id?: string | undefined; op_code?: string | undefined; question?: { class?: string | undefined; name?: string | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; type?: string | undefined; } | undefined; resolved_ip?: string[] | undefined; response_code?: string | undefined; type?: string | undefined; } | undefined; email?: { attachments?: { file?: { extension?: string | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; mime_type?: string | undefined; name?: string | undefined; size?: string | number | undefined; } | undefined; }[] | undefined; bcc?: { address?: string[] | undefined; } | undefined; cc?: { address?: string[] | undefined; } | undefined; content_type?: string | undefined; delivery_timestamp?: string | undefined; direction?: string | undefined; from?: { address?: string[] | undefined; } | undefined; local_id?: string | undefined; message_id?: string | undefined; origination_timestamp?: string | undefined; reply_to?: { address?: string[] | undefined; } | undefined; sender?: { address?: string | undefined; } | undefined; subject?: string | undefined; to?: { address?: string[] | undefined; } | undefined; x_mailer?: string | undefined; } | undefined; error?: { code?: string | undefined; id?: string | undefined; message?: string | undefined; stack_trace?: string | undefined; type?: string | undefined; } | undefined; event?: { action?: string | undefined; agent_id_status?: string | undefined; category?: string[] | undefined; code?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: string | number | undefined; end?: string | undefined; hash?: string | undefined; id?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; original?: string | undefined; outcome?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; severity?: string | number | undefined; start?: string | undefined; timezone?: string | undefined; type?: string[] | undefined; url?: string | undefined; } | undefined; faas?: { coldstart?: boolean | undefined; execution?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; } | undefined; file?: { accessed?: string | undefined; attributes?: string[] | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; created?: string | undefined; ctime?: string | undefined; device?: string | undefined; directory?: string | undefined; drive_letter?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; extension?: string | undefined; fork_name?: string | undefined; gid?: string | undefined; group?: string | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; inode?: string | undefined; mime_type?: string | undefined; mode?: string | undefined; mtime?: string | undefined; name?: string | undefined; owner?: string | undefined; path?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; size?: string | number | undefined; target_path?: string | undefined; type?: string | undefined; uid?: string | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; host?: { architecture?: string | undefined; boot?: { id?: string | undefined; } | undefined; cpu?: { usage?: string | number | undefined; } | undefined; disk?: { read?: { bytes?: string | number | undefined; } | undefined; write?: { bytes?: string | number | undefined; } | undefined; } | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; hostname?: string | undefined; id?: string | undefined; ip?: string[] | undefined; mac?: string[] | undefined; name?: string | undefined; network?: { egress?: { bytes?: string | number | undefined; packets?: string | number | undefined; } | undefined; ingress?: { bytes?: string | number | undefined; packets?: string | number | undefined; } | undefined; } | undefined; os?: { family?: string | undefined; full?: string | undefined; kernel?: string | undefined; name?: string | undefined; platform?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; pid_ns_ino?: string | undefined; risk?: { calculated_level?: string | undefined; calculated_score?: number | undefined; calculated_score_norm?: number | undefined; static_level?: string | undefined; static_score?: number | undefined; static_score_norm?: number | undefined; } | undefined; type?: string | undefined; uptime?: string | number | undefined; } | undefined; http?: { request?: { body?: { bytes?: string | number | undefined; content?: string | undefined; } | undefined; bytes?: string | number | undefined; id?: string | undefined; method?: string | undefined; mime_type?: string | undefined; referrer?: string | undefined; } | undefined; response?: { body?: { bytes?: string | number | undefined; content?: string | undefined; } | undefined; bytes?: string | number | undefined; mime_type?: string | undefined; status_code?: string | number | undefined; } | undefined; version?: string | undefined; } | undefined; log?: { file?: { path?: string | undefined; } | undefined; level?: string | undefined; logger?: string | undefined; origin?: { file?: { line?: string | number | undefined; name?: string | undefined; } | undefined; function?: string | undefined; } | undefined; } | undefined; message?: string | undefined; network?: { application?: string | undefined; bytes?: string | number | undefined; community_id?: string | undefined; direction?: string | undefined; forwarded_ip?: string | undefined; iana_number?: string | undefined; name?: string | undefined; packets?: string | number | undefined; protocol?: string | undefined; transport?: string | undefined; type?: string | undefined; vlan?: { id?: string | undefined; name?: string | undefined; } | undefined; } | undefined; observer?: { geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; hostname?: string | undefined; ip?: string[] | undefined; mac?: string[] | undefined; name?: string | undefined; os?: { family?: string | undefined; full?: string | undefined; kernel?: string | undefined; name?: string | undefined; platform?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; product?: string | undefined; serial_number?: string | undefined; type?: string | undefined; vendor?: string | undefined; version?: string | undefined; } | undefined; orchestrator?: { api_version?: string | undefined; cluster?: { id?: string | undefined; name?: string | undefined; url?: string | undefined; version?: string | undefined; } | undefined; namespace?: string | undefined; organization?: string | undefined; resource?: { id?: string | undefined; ip?: string[] | undefined; name?: string | undefined; parent?: { type?: string | undefined; } | undefined; type?: string | undefined; } | undefined; type?: string | undefined; } | undefined; organization?: { id?: string | undefined; name?: string | undefined; } | undefined; package?: { architecture?: string | undefined; build_version?: string | undefined; checksum?: string | undefined; description?: string | undefined; install_scope?: string | undefined; installed?: string | undefined; license?: string | undefined; name?: string | undefined; path?: string | undefined; reference?: string | undefined; size?: string | number | undefined; type?: string | undefined; version?: string | undefined; } | undefined; process?: { args?: string[] | undefined; args_count?: string | number | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; command_line?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; end?: string | undefined; entity_id?: string | undefined; entry_leader?: { args?: string[] | undefined; args_count?: string | number | undefined; attested_groups?: { name?: string | undefined; } | undefined; attested_user?: { id?: string | undefined; name?: string | undefined; } | undefined; command_line?: string | undefined; entity_id?: string | undefined; entry_meta?: { source?: { ip?: string | undefined; } | undefined; type?: string | undefined; } | undefined; executable?: string | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; parent?: { entity_id?: string | undefined; pid?: string | number | undefined; session_leader?: { entity_id?: string | undefined; pid?: string | number | undefined; start?: string | undefined; } | undefined; start?: string | undefined; } | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; same_as_process?: boolean | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; env_vars?: string[] | undefined; executable?: string | undefined; exit_code?: string | number | undefined; group_leader?: { args?: string[] | undefined; args_count?: string | number | undefined; command_line?: string | undefined; entity_id?: string | undefined; executable?: string | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; same_as_process?: boolean | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; parent?: { args?: string[] | undefined; args_count?: string | number | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; command_line?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; end?: string | undefined; entity_id?: string | undefined; executable?: string | undefined; exit_code?: string | number | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; group_leader?: { entity_id?: string | undefined; pid?: string | number | undefined; start?: string | undefined; } | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; pgid?: string | number | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; thread?: { id?: string | number | undefined; name?: string | undefined; } | undefined; title?: string | undefined; uptime?: string | number | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; pgid?: string | number | undefined; pid?: string | number | undefined; previous?: { args?: string[] | undefined; args_count?: string | number | undefined; executable?: string | undefined; } | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; session_leader?: { args?: string[] | undefined; args_count?: string | number | undefined; command_line?: string | undefined; entity_id?: string | undefined; executable?: string | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; parent?: { entity_id?: string | undefined; pid?: string | number | undefined; session_leader?: { entity_id?: string | undefined; pid?: string | number | undefined; start?: string | undefined; } | undefined; start?: string | undefined; } | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; same_as_process?: boolean | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; thread?: { id?: string | number | undefined; name?: string | undefined; } | undefined; title?: string | undefined; uptime?: string | number | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; registry?: { data?: { bytes?: string | undefined; strings?: string[] | undefined; type?: string | undefined; } | undefined; hive?: string | undefined; key?: string | undefined; path?: string | undefined; value?: string | undefined; } | undefined; related?: { hash?: string[] | undefined; hosts?: string[] | undefined; ip?: string[] | undefined; user?: string[] | undefined; } | undefined; rule?: { author?: string[] | undefined; category?: string | undefined; description?: string | undefined; id?: string | undefined; license?: string | undefined; name?: string | undefined; reference?: string | undefined; ruleset?: string | undefined; uuid?: string | undefined; version?: string | undefined; } | undefined; server?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; service?: { address?: string | undefined; environment?: string | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; node?: { name?: string | undefined; role?: string | undefined; roles?: string[] | undefined; } | undefined; origin?: { address?: string | undefined; environment?: string | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; node?: { name?: string | undefined; role?: string | undefined; roles?: string[] | undefined; } | undefined; state?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; state?: string | undefined; target?: { address?: string | undefined; environment?: string | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; node?: { name?: string | undefined; role?: string | undefined; roles?: string[] | undefined; } | undefined; state?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; type?: string | undefined; version?: string | undefined; } | undefined; source?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; span?: { id?: string | undefined; } | undefined; tags?: string[] | undefined; threat?: { enrichments?: { matched?: { atomic?: string | undefined; field?: string | undefined; id?: string | undefined; index?: string | undefined; occurred?: string | undefined; type?: string | undefined; } | undefined; }[] | undefined; feed?: { dashboard_id?: string | undefined; description?: string | undefined; name?: string | undefined; reference?: string | undefined; } | undefined; framework?: string | undefined; group?: { alias?: string[] | undefined; id?: string | undefined; name?: string | undefined; reference?: string | undefined; } | undefined; indicator?: { as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; confidence?: string | undefined; description?: string | undefined; email?: { address?: string | undefined; } | undefined; file?: { accessed?: string | undefined; attributes?: string[] | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; created?: string | undefined; ctime?: string | undefined; device?: string | undefined; directory?: string | undefined; drive_letter?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; extension?: string | undefined; fork_name?: string | undefined; gid?: string | undefined; group?: string | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; inode?: string | undefined; mime_type?: string | undefined; mode?: string | undefined; mtime?: string | undefined; name?: string | undefined; owner?: string | undefined; path?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; size?: string | number | undefined; target_path?: string | undefined; type?: string | undefined; uid?: string | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; first_seen?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; last_seen?: string | undefined; marking?: { tlp?: string | undefined; tlp_version?: string | undefined; } | undefined; modified_at?: string | undefined; port?: string | number | undefined; provider?: string | undefined; reference?: string | undefined; registry?: { data?: { bytes?: string | undefined; strings?: string[] | undefined; type?: string | undefined; } | undefined; hive?: string | undefined; key?: string | undefined; path?: string | undefined; value?: string | undefined; } | undefined; scanner_stats?: string | number | undefined; sightings?: string | number | undefined; type?: string | undefined; url?: { domain?: string | undefined; extension?: string | undefined; fragment?: string | undefined; full?: string | undefined; original?: string | undefined; password?: string | undefined; path?: string | undefined; port?: string | number | undefined; query?: string | undefined; registered_domain?: string | undefined; scheme?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; username?: string | undefined; } | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; software?: { alias?: string[] | undefined; id?: string | undefined; name?: string | undefined; platforms?: string[] | undefined; reference?: string | undefined; type?: string | undefined; } | undefined; tactic?: { id?: string[] | undefined; name?: string[] | undefined; reference?: string[] | undefined; } | undefined; technique?: { id?: string[] | undefined; name?: string[] | undefined; reference?: string[] | undefined; subtechnique?: { id?: string[] | undefined; name?: string[] | undefined; reference?: string[] | undefined; } | undefined; } | undefined; } | undefined; tls?: { cipher?: string | undefined; client?: { certificate?: string | undefined; certificate_chain?: string[] | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; } | undefined; issuer?: string | undefined; ja3?: string | undefined; not_after?: string | undefined; not_before?: string | undefined; server_name?: string | undefined; subject?: string | undefined; supported_ciphers?: string[] | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; curve?: string | undefined; established?: boolean | undefined; next_protocol?: string | undefined; resumed?: boolean | undefined; server?: { certificate?: string | undefined; certificate_chain?: string[] | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; } | undefined; issuer?: string | undefined; ja3s?: string | undefined; not_after?: string | undefined; not_before?: string | undefined; subject?: string | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; version?: string | undefined; version_protocol?: string | undefined; } | undefined; trace?: { id?: string | undefined; } | undefined; transaction?: { id?: string | undefined; } | undefined; url?: { domain?: string | undefined; extension?: string | undefined; fragment?: string | undefined; full?: string | undefined; original?: string | undefined; password?: string | undefined; path?: string | undefined; port?: string | number | undefined; query?: string | undefined; registered_domain?: string | undefined; scheme?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; username?: string | undefined; } | undefined; user?: { changes?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; domain?: string | undefined; effective?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; risk?: { calculated_level?: string | undefined; calculated_score?: number | undefined; calculated_score_norm?: number | undefined; static_level?: string | undefined; static_score?: number | undefined; static_score_norm?: number | undefined; } | undefined; roles?: string[] | undefined; target?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; user_agent?: { device?: { name?: string | undefined; } | undefined; name?: string | undefined; original?: string | undefined; os?: { family?: string | undefined; full?: string | undefined; kernel?: string | undefined; name?: string | undefined; platform?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; version?: string | undefined; } | undefined; vulnerability?: { category?: string[] | undefined; classification?: string | undefined; description?: string | undefined; enumeration?: string | undefined; id?: string | undefined; reference?: string | undefined; report_id?: string | undefined; scanner?: { vendor?: string | undefined; } | undefined; score?: { base?: number | undefined; environmental?: number | undefined; temporal?: number | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; } | undefined; } & {} & { ecs?: { version?: string | undefined; } | undefined; kibana?: { alert?: { risk_score?: number | undefined; rule?: { author?: string | undefined; created_at?: string | undefined; created_by?: string | undefined; description?: string | undefined; enabled?: string | undefined; from?: string | undefined; interval?: string | undefined; license?: string | undefined; note?: string | undefined; references?: string[] | undefined; rule_id?: string | undefined; rule_name_override?: string | undefined; to?: string | undefined; type?: string | undefined; updated_at?: string | undefined; updated_by?: string | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; suppression?: { docs_count?: string | number | undefined; end?: string | undefined; start?: string | undefined; terms?: { field?: string[] | undefined; value?: string[] | undefined; } | undefined; } | undefined; system_status?: string | undefined; workflow_reason?: string | undefined; workflow_user?: string | undefined; } | undefined; } | undefined; }) | ({} & { kibana?: { alert?: { evaluation?: { threshold?: string | number | undefined; value?: string | number | undefined; values?: (string | number)[] | undefined; } | undefined; } | undefined; } | undefined; slo?: { id?: string | undefined; revision?: string | number | undefined; } | undefined; } & { '@timestamp': string; kibana: { alert: { instance: { id: string; }; rule: { category: string; consumer: string; name: string; producer: string; revision: string | number; rule_type_id: string; uuid: string; }; status: string; uuid: string; }; space_ids: string[]; }; } & { event?: { action?: string | undefined; kind?: string | undefined; } | undefined; kibana?: { alert?: { action_group?: string | undefined; case_ids?: string[] | undefined; duration?: { us?: string | number | undefined; } | undefined; end?: string | undefined; flapping?: boolean | undefined; flapping_history?: boolean[] | undefined; last_detected?: string | undefined; maintenance_window_ids?: string[] | undefined; reason?: string | undefined; rule?: { execution?: { uuid?: string | undefined; } | undefined; parameters?: unknown; tags?: string[] | undefined; } | undefined; start?: string | undefined; time_range?: { gte?: string | undefined; lte?: string | undefined; } | undefined; url?: string | undefined; workflow_status?: string | undefined; workflow_tags?: string[] | undefined; } | undefined; version?: string | undefined; } | undefined; tags?: string[] | undefined; } & {} & { ecs?: { version?: string | undefined; } | undefined; kibana?: { alert?: { risk_score?: number | undefined; rule?: { author?: string | undefined; created_at?: string | undefined; created_by?: string | undefined; description?: string | undefined; enabled?: string | undefined; from?: string | undefined; interval?: string | undefined; license?: string | undefined; note?: string | undefined; references?: string[] | undefined; rule_id?: string | undefined; rule_name_override?: string | undefined; to?: string | undefined; type?: string | undefined; updated_at?: string | undefined; updated_by?: string | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; suppression?: { docs_count?: string | number | undefined; end?: string | undefined; start?: string | undefined; terms?: { field?: string[] | undefined; value?: string[] | undefined; } | undefined; } | undefined; system_status?: string | undefined; workflow_reason?: string | undefined; workflow_user?: string | undefined; } | undefined; } | undefined; }) | ({} & { agent?: { name?: string | undefined; } | undefined; anomaly?: { bucket_span?: { minutes?: string | undefined; } | undefined; start?: string | undefined; } | undefined; error?: { message?: string | undefined; } | undefined; kibana?: { alert?: { evaluation?: { threshold?: string | number | undefined; value?: string | number | undefined; values?: (string | number)[] | undefined; } | undefined; } | undefined; } | undefined; monitor?: { id?: string | undefined; name?: string | undefined; type?: string | undefined; } | undefined; observer?: { geo?: { name?: string | undefined; } | undefined; } | undefined; tls?: { server?: { hash?: { sha256?: string | undefined; } | undefined; x509?: { issuer?: { common_name?: string | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; subject?: { common_name?: string | undefined; } | undefined; } | undefined; } | undefined; } | undefined; url?: { full?: string | undefined; } | undefined; } & { '@timestamp': string; kibana: { alert: { instance: { id: string; }; rule: { category: string; consumer: string; name: string; producer: string; revision: string | number; rule_type_id: string; uuid: string; }; status: string; uuid: string; }; space_ids: string[]; }; } & { event?: { action?: string | undefined; kind?: string | undefined; } | undefined; kibana?: { alert?: { action_group?: string | undefined; case_ids?: string[] | undefined; duration?: { us?: string | number | undefined; } | undefined; end?: string | undefined; flapping?: boolean | undefined; flapping_history?: boolean[] | undefined; last_detected?: string | undefined; maintenance_window_ids?: string[] | undefined; reason?: string | undefined; rule?: { execution?: { uuid?: string | undefined; } | undefined; parameters?: unknown; tags?: string[] | undefined; } | undefined; start?: string | undefined; time_range?: { gte?: string | undefined; lte?: string | undefined; } | undefined; url?: string | undefined; workflow_status?: string | undefined; workflow_tags?: string[] | undefined; } | undefined; version?: string | undefined; } | undefined; tags?: string[] | undefined; } & {} & { ecs?: { version?: string | undefined; } | undefined; kibana?: { alert?: { risk_score?: number | undefined; rule?: { author?: string | undefined; created_at?: string | undefined; created_by?: string | undefined; description?: string | undefined; enabled?: string | undefined; from?: string | undefined; interval?: string | undefined; license?: string | undefined; note?: string | undefined; references?: string[] | undefined; rule_id?: string | undefined; rule_name_override?: string | undefined; to?: string | undefined; type?: string | undefined; updated_at?: string | undefined; updated_by?: string | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; suppression?: { docs_count?: string | number | undefined; end?: string | undefined; start?: string | undefined; terms?: { field?: string[] | undefined; value?: string[] | undefined; } | undefined; } | undefined; system_status?: string | undefined; workflow_reason?: string | undefined; workflow_user?: string | undefined; } | undefined; } | undefined; }) | ({ '@timestamp': string; kibana: { alert: { ancestors: { depth: string | number; id: string; index: string; type: string; }[]; depth: string | number; instance: { id: string; }; original_event: { action: string; category: string[]; created: string; dataset: string; id: string; ingested: string; kind: string; module: string; original: string; outcome: string; provider: string; sequence: string | number; type: string[]; }; original_time: string; rule: { category: string; consumer: string; false_positives: string[]; max_signals: (string | number)[]; name: string; producer: string; revision: string | number; rule_type_id: string; threat: { framework: string; tactic: { id: string; name: string; reference: string; }; technique: { id: string; name: string; reference: string; subtechnique: { id: string; name: string; reference: string; }; }; }; uuid: string; }; status: string; uuid: string; }; space_ids: string[]; }; } & { ecs?: { version?: string | undefined; } | undefined; event?: { action?: string | undefined; kind?: string | undefined; } | undefined; kibana?: { alert?: { action_group?: string | undefined; ancestors?: { rule?: string | undefined; } | undefined; building_block_type?: string | undefined; case_ids?: string[] | undefined; duration?: { us?: string | number | undefined; } | undefined; end?: string | undefined; flapping?: boolean | undefined; flapping_history?: boolean[] | undefined; group?: { id?: string | undefined; index?: number | undefined; } | undefined; last_detected?: string | undefined; maintenance_window_ids?: string[] | undefined; new_terms?: string[] | undefined; original_event?: { agent_id_status?: string | undefined; code?: string | undefined; duration?: string | undefined; end?: string | undefined; hash?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; severity?: string | number | undefined; start?: string | undefined; timezone?: string | undefined; url?: string | undefined; } | undefined; reason?: string | undefined; risk_score?: number | undefined; rule?: { author?: string | undefined; building_block_type?: string | undefined; created_at?: string | undefined; created_by?: string | undefined; description?: string | undefined; enabled?: string | undefined; execution?: { uuid?: string | undefined; } | undefined; from?: string | undefined; immutable?: string[] | undefined; interval?: string | undefined; license?: string | undefined; note?: string | undefined; parameters?: unknown; references?: string[] | undefined; rule_id?: string | undefined; rule_name_override?: string | undefined; tags?: string[] | undefined; timeline_id?: string[] | undefined; timeline_title?: string[] | undefined; timestamp_override?: string | undefined; to?: string | undefined; type?: string | undefined; updated_at?: string | undefined; updated_by?: string | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; start?: string | undefined; suppression?: { docs_count?: string | number | undefined; end?: string | undefined; start?: string | undefined; terms?: { field?: string[] | undefined; value?: string[] | undefined; } | undefined; } | undefined; system_status?: string | undefined; threshold_result?: { count?: string | number | undefined; from?: string | undefined; terms?: { field?: string | undefined; value?: string | undefined; }[] | undefined; } | undefined; time_range?: { gte?: string | undefined; lte?: string | undefined; } | undefined; url?: string | undefined; workflow_reason?: string | undefined; workflow_status?: string | undefined; workflow_tags?: string[] | undefined; workflow_user?: string | undefined; } | undefined; version?: string | undefined; } | undefined; signal?: { ancestors?: { depth?: unknown; id?: unknown; index?: unknown; type?: unknown; } | undefined; depth?: unknown; group?: { id?: unknown; index?: unknown; } | undefined; original_event?: { action?: unknown; category?: unknown; code?: unknown; created?: unknown; dataset?: unknown; duration?: unknown; end?: unknown; hash?: unknown; id?: unknown; kind?: unknown; module?: unknown; outcome?: unknown; provider?: unknown; reason?: unknown; risk_score?: unknown; risk_score_norm?: unknown; sequence?: unknown; severity?: unknown; start?: unknown; timezone?: unknown; type?: unknown; } | undefined; original_time?: unknown; reason?: unknown; rule?: { author?: unknown; building_block_type?: unknown; created_at?: unknown; created_by?: unknown; description?: unknown; enabled?: unknown; false_positives?: unknown; from?: unknown; id?: unknown; immutable?: unknown; interval?: unknown; license?: unknown; max_signals?: unknown; name?: unknown; note?: unknown; references?: unknown; risk_score?: unknown; rule_id?: unknown; rule_name_override?: unknown; severity?: unknown; tags?: unknown; threat?: { framework?: unknown; tactic?: { id?: unknown; name?: unknown; reference?: unknown; } | undefined; technique?: { id?: unknown; name?: unknown; reference?: unknown; subtechnique?: { id?: unknown; name?: unknown; reference?: unknown; } | undefined; } | undefined; } | undefined; timeline_id?: unknown; timeline_title?: unknown; timestamp_override?: unknown; to?: unknown; type?: unknown; updated_at?: unknown; updated_by?: unknown; version?: unknown; } | undefined; status?: unknown; threshold_result?: { cardinality?: { field?: unknown; value?: unknown; } | undefined; count?: unknown; from?: unknown; terms?: { field?: unknown; value?: unknown; } | undefined; } | undefined; } | undefined; tags?: string[] | undefined; } & { '@timestamp': string; kibana: { alert: { instance: { id: string; }; rule: { category: string; consumer: string; name: string; producer: string; revision: string | number; rule_type_id: string; uuid: string; }; status: string; uuid: string; }; space_ids: string[]; }; } & { event?: { action?: string | undefined; kind?: string | undefined; } | undefined; kibana?: { alert?: { action_group?: string | undefined; case_ids?: string[] | undefined; duration?: { us?: string | number | undefined; } | undefined; end?: string | undefined; flapping?: boolean | undefined; flapping_history?: boolean[] | undefined; last_detected?: string | undefined; maintenance_window_ids?: string[] | undefined; reason?: string | undefined; rule?: { execution?: { uuid?: string | undefined; } | undefined; parameters?: unknown; tags?: string[] | undefined; } | undefined; start?: string | undefined; time_range?: { gte?: string | undefined; lte?: string | undefined; } | undefined; url?: string | undefined; workflow_status?: string | undefined; workflow_tags?: string[] | undefined; } | undefined; version?: string | undefined; } | undefined; tags?: string[] | undefined; } & { '@timestamp': string; ecs: { version: string; }; } & { agent?: { build?: { original?: string | undefined; } | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; client?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; cloud?: { account?: { id?: string | undefined; name?: string | undefined; } | undefined; availability_zone?: string | undefined; instance?: { id?: string | undefined; name?: string | undefined; } | undefined; machine?: { type?: string | undefined; } | undefined; origin?: { account?: { id?: string | undefined; name?: string | undefined; } | undefined; availability_zone?: string | undefined; instance?: { id?: string | undefined; name?: string | undefined; } | undefined; machine?: { type?: string | undefined; } | undefined; project?: { id?: string | undefined; name?: string | undefined; } | undefined; provider?: string | undefined; region?: string | undefined; service?: { name?: string | undefined; } | undefined; } | undefined; project?: { id?: string | undefined; name?: string | undefined; } | undefined; provider?: string | undefined; region?: string | undefined; service?: { name?: string | undefined; } | undefined; target?: { account?: { id?: string | undefined; name?: string | undefined; } | undefined; availability_zone?: string | undefined; instance?: { id?: string | undefined; name?: string | undefined; } | undefined; machine?: { type?: string | undefined; } | undefined; project?: { id?: string | undefined; name?: string | undefined; } | undefined; provider?: string | undefined; region?: string | undefined; service?: { name?: string | undefined; } | undefined; } | undefined; } | undefined; container?: { cpu?: { usage?: string | number | undefined; } | undefined; disk?: { read?: { bytes?: string | number | undefined; } | undefined; write?: { bytes?: string | number | undefined; } | undefined; } | undefined; id?: string | undefined; image?: { hash?: { all?: string[] | undefined; } | undefined; name?: string | undefined; tag?: string[] | undefined; } | undefined; memory?: { usage?: string | number | undefined; } | undefined; name?: string | undefined; network?: { egress?: { bytes?: string | number | undefined; } | undefined; ingress?: { bytes?: string | number | undefined; } | undefined; } | undefined; runtime?: string | undefined; } | undefined; destination?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; device?: { id?: string | undefined; manufacturer?: string | undefined; model?: { identifier?: string | undefined; name?: string | undefined; } | undefined; } | undefined; dll?: { code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; name?: string | undefined; path?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; } | undefined; dns?: { answers?: { class?: string | undefined; data?: string | undefined; name?: string | undefined; ttl?: string | number | undefined; type?: string | undefined; }[] | undefined; header_flags?: string[] | undefined; id?: string | undefined; op_code?: string | undefined; question?: { class?: string | undefined; name?: string | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; type?: string | undefined; } | undefined; resolved_ip?: string[] | undefined; response_code?: string | undefined; type?: string | undefined; } | undefined; email?: { attachments?: { file?: { extension?: string | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; mime_type?: string | undefined; name?: string | undefined; size?: string | number | undefined; } | undefined; }[] | undefined; bcc?: { address?: string[] | undefined; } | undefined; cc?: { address?: string[] | undefined; } | undefined; content_type?: string | undefined; delivery_timestamp?: string | undefined; direction?: string | undefined; from?: { address?: string[] | undefined; } | undefined; local_id?: string | undefined; message_id?: string | undefined; origination_timestamp?: string | undefined; reply_to?: { address?: string[] | undefined; } | undefined; sender?: { address?: string | undefined; } | undefined; subject?: string | undefined; to?: { address?: string[] | undefined; } | undefined; x_mailer?: string | undefined; } | undefined; error?: { code?: string | undefined; id?: string | undefined; message?: string | undefined; stack_trace?: string | undefined; type?: string | undefined; } | undefined; event?: { action?: string | undefined; agent_id_status?: string | undefined; category?: string[] | undefined; code?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: string | number | undefined; end?: string | undefined; hash?: string | undefined; id?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; original?: string | undefined; outcome?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; severity?: string | number | undefined; start?: string | undefined; timezone?: string | undefined; type?: string[] | undefined; url?: string | undefined; } | undefined; faas?: { coldstart?: boolean | undefined; execution?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; } | undefined; file?: { accessed?: string | undefined; attributes?: string[] | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; created?: string | undefined; ctime?: string | undefined; device?: string | undefined; directory?: string | undefined; drive_letter?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; extension?: string | undefined; fork_name?: string | undefined; gid?: string | undefined; group?: string | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; inode?: string | undefined; mime_type?: string | undefined; mode?: string | undefined; mtime?: string | undefined; name?: string | undefined; owner?: string | undefined; path?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; size?: string | number | undefined; target_path?: string | undefined; type?: string | undefined; uid?: string | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; host?: { architecture?: string | undefined; boot?: { id?: string | undefined; } | undefined; cpu?: { usage?: string | number | undefined; } | undefined; disk?: { read?: { bytes?: string | number | undefined; } | undefined; write?: { bytes?: string | number | undefined; } | undefined; } | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; hostname?: string | undefined; id?: string | undefined; ip?: string[] | undefined; mac?: string[] | undefined; name?: string | undefined; network?: { egress?: { bytes?: string | number | undefined; packets?: string | number | undefined; } | undefined; ingress?: { bytes?: string | number | undefined; packets?: string | number | undefined; } | undefined; } | undefined; os?: { family?: string | undefined; full?: string | undefined; kernel?: string | undefined; name?: string | undefined; platform?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; pid_ns_ino?: string | undefined; risk?: { calculated_level?: string | undefined; calculated_score?: number | undefined; calculated_score_norm?: number | undefined; static_level?: string | undefined; static_score?: number | undefined; static_score_norm?: number | undefined; } | undefined; type?: string | undefined; uptime?: string | number | undefined; } | undefined; http?: { request?: { body?: { bytes?: string | number | undefined; content?: string | undefined; } | undefined; bytes?: string | number | undefined; id?: string | undefined; method?: string | undefined; mime_type?: string | undefined; referrer?: string | undefined; } | undefined; response?: { body?: { bytes?: string | number | undefined; content?: string | undefined; } | undefined; bytes?: string | number | undefined; mime_type?: string | undefined; status_code?: string | number | undefined; } | undefined; version?: string | undefined; } | undefined; log?: { file?: { path?: string | undefined; } | undefined; level?: string | undefined; logger?: string | undefined; origin?: { file?: { line?: string | number | undefined; name?: string | undefined; } | undefined; function?: string | undefined; } | undefined; } | undefined; message?: string | undefined; network?: { application?: string | undefined; bytes?: string | number | undefined; community_id?: string | undefined; direction?: string | undefined; forwarded_ip?: string | undefined; iana_number?: string | undefined; name?: string | undefined; packets?: string | number | undefined; protocol?: string | undefined; transport?: string | undefined; type?: string | undefined; vlan?: { id?: string | undefined; name?: string | undefined; } | undefined; } | undefined; observer?: { geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; hostname?: string | undefined; ip?: string[] | undefined; mac?: string[] | undefined; name?: string | undefined; os?: { family?: string | undefined; full?: string | undefined; kernel?: string | undefined; name?: string | undefined; platform?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; product?: string | undefined; serial_number?: string | undefined; type?: string | undefined; vendor?: string | undefined; version?: string | undefined; } | undefined; orchestrator?: { api_version?: string | undefined; cluster?: { id?: string | undefined; name?: string | undefined; url?: string | undefined; version?: string | undefined; } | undefined; namespace?: string | undefined; organization?: string | undefined; resource?: { id?: string | undefined; ip?: string[] | undefined; name?: string | undefined; parent?: { type?: string | undefined; } | undefined; type?: string | undefined; } | undefined; type?: string | undefined; } | undefined; organization?: { id?: string | undefined; name?: string | undefined; } | undefined; package?: { architecture?: string | undefined; build_version?: string | undefined; checksum?: string | undefined; description?: string | undefined; install_scope?: string | undefined; installed?: string | undefined; license?: string | undefined; name?: string | undefined; path?: string | undefined; reference?: string | undefined; size?: string | number | undefined; type?: string | undefined; version?: string | undefined; } | undefined; process?: { args?: string[] | undefined; args_count?: string | number | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; command_line?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; end?: string | undefined; entity_id?: string | undefined; entry_leader?: { args?: string[] | undefined; args_count?: string | number | undefined; attested_groups?: { name?: string | undefined; } | undefined; attested_user?: { id?: string | undefined; name?: string | undefined; } | undefined; command_line?: string | undefined; entity_id?: string | undefined; entry_meta?: { source?: { ip?: string | undefined; } | undefined; type?: string | undefined; } | undefined; executable?: string | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; parent?: { entity_id?: string | undefined; pid?: string | number | undefined; session_leader?: { entity_id?: string | undefined; pid?: string | number | undefined; start?: string | undefined; } | undefined; start?: string | undefined; } | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; same_as_process?: boolean | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; env_vars?: string[] | undefined; executable?: string | undefined; exit_code?: string | number | undefined; group_leader?: { args?: string[] | undefined; args_count?: string | number | undefined; command_line?: string | undefined; entity_id?: string | undefined; executable?: string | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; same_as_process?: boolean | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; parent?: { args?: string[] | undefined; args_count?: string | number | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; command_line?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; end?: string | undefined; entity_id?: string | undefined; executable?: string | undefined; exit_code?: string | number | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; group_leader?: { entity_id?: string | undefined; pid?: string | number | undefined; start?: string | undefined; } | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; pgid?: string | number | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; thread?: { id?: string | number | undefined; name?: string | undefined; } | undefined; title?: string | undefined; uptime?: string | number | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; pgid?: string | number | undefined; pid?: string | number | undefined; previous?: { args?: string[] | undefined; args_count?: string | number | undefined; executable?: string | undefined; } | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; session_leader?: { args?: string[] | undefined; args_count?: string | number | undefined; command_line?: string | undefined; entity_id?: string | undefined; executable?: string | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; parent?: { entity_id?: string | undefined; pid?: string | number | undefined; session_leader?: { entity_id?: string | undefined; pid?: string | number | undefined; start?: string | undefined; } | undefined; start?: string | undefined; } | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; same_as_process?: boolean | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; thread?: { id?: string | number | undefined; name?: string | undefined; } | undefined; title?: string | undefined; uptime?: string | number | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; registry?: { data?: { bytes?: string | undefined; strings?: string[] | undefined; type?: string | undefined; } | undefined; hive?: string | undefined; key?: string | undefined; path?: string | undefined; value?: string | undefined; } | undefined; related?: { hash?: string[] | undefined; hosts?: string[] | undefined; ip?: string[] | undefined; user?: string[] | undefined; } | undefined; rule?: { author?: string[] | undefined; category?: string | undefined; description?: string | undefined; id?: string | undefined; license?: string | undefined; name?: string | undefined; reference?: string | undefined; ruleset?: string | undefined; uuid?: string | undefined; version?: string | undefined; } | undefined; server?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; service?: { address?: string | undefined; environment?: string | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; node?: { name?: string | undefined; role?: string | undefined; roles?: string[] | undefined; } | undefined; origin?: { address?: string | undefined; environment?: string | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; node?: { name?: string | undefined; role?: string | undefined; roles?: string[] | undefined; } | undefined; state?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; state?: string | undefined; target?: { address?: string | undefined; environment?: string | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; node?: { name?: string | undefined; role?: string | undefined; roles?: string[] | undefined; } | undefined; state?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; type?: string | undefined; version?: string | undefined; } | undefined; source?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; span?: { id?: string | undefined; } | undefined; tags?: string[] | undefined; threat?: { enrichments?: { matched?: { atomic?: string | undefined; field?: string | undefined; id?: string | undefined; index?: string | undefined; occurred?: string | undefined; type?: string | undefined; } | undefined; }[] | undefined; feed?: { dashboard_id?: string | undefined; description?: string | undefined; name?: string | undefined; reference?: string | undefined; } | undefined; framework?: string | undefined; group?: { alias?: string[] | undefined; id?: string | undefined; name?: string | undefined; reference?: string | undefined; } | undefined; indicator?: { as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; confidence?: string | undefined; description?: string | undefined; email?: { address?: string | undefined; } | undefined; file?: { accessed?: string | undefined; attributes?: string[] | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; created?: string | undefined; ctime?: string | undefined; device?: string | undefined; directory?: string | undefined; drive_letter?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; extension?: string | undefined; fork_name?: string | undefined; gid?: string | undefined; group?: string | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; inode?: string | undefined; mime_type?: string | undefined; mode?: string | undefined; mtime?: string | undefined; name?: string | undefined; owner?: string | undefined; path?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; size?: string | number | undefined; target_path?: string | undefined; type?: string | undefined; uid?: string | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; first_seen?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; last_seen?: string | undefined; marking?: { tlp?: string | undefined; tlp_version?: string | undefined; } | undefined; modified_at?: string | undefined; port?: string | number | undefined; provider?: string | undefined; reference?: string | undefined; registry?: { data?: { bytes?: string | undefined; strings?: string[] | undefined; type?: string | undefined; } | undefined; hive?: string | undefined; key?: string | undefined; path?: string | undefined; value?: string | undefined; } | undefined; scanner_stats?: string | number | undefined; sightings?: string | number | undefined; type?: string | undefined; url?: { domain?: string | undefined; extension?: string | undefined; fragment?: string | undefined; full?: string | undefined; original?: string | undefined; password?: string | undefined; path?: string | undefined; port?: string | number | undefined; query?: string | undefined; registered_domain?: string | undefined; scheme?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; username?: string | undefined; } | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; software?: { alias?: string[] | undefined; id?: string | undefined; name?: string | undefined; platforms?: string[] | undefined; reference?: string | undefined; type?: string | undefined; } | undefined; tactic?: { id?: string[] | undefined; name?: string[] | undefined; reference?: string[] | undefined; } | undefined; technique?: { id?: string[] | undefined; name?: string[] | undefined; reference?: string[] | undefined; subtechnique?: { id?: string[] | undefined; name?: string[] | undefined; reference?: string[] | undefined; } | undefined; } | undefined; } | undefined; tls?: { cipher?: string | undefined; client?: { certificate?: string | undefined; certificate_chain?: string[] | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; } | undefined; issuer?: string | undefined; ja3?: string | undefined; not_after?: string | undefined; not_before?: string | undefined; server_name?: string | undefined; subject?: string | undefined; supported_ciphers?: string[] | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; curve?: string | undefined; established?: boolean | undefined; next_protocol?: string | undefined; resumed?: boolean | undefined; server?: { certificate?: string | undefined; certificate_chain?: string[] | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; } | undefined; issuer?: string | undefined; ja3s?: string | undefined; not_after?: string | undefined; not_before?: string | undefined; subject?: string | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; version?: string | undefined; version_protocol?: string | undefined; } | undefined; trace?: { id?: string | undefined; } | undefined; transaction?: { id?: string | undefined; } | undefined; url?: { domain?: string | undefined; extension?: string | undefined; fragment?: string | undefined; full?: string | undefined; original?: string | undefined; password?: string | undefined; path?: string | undefined; port?: string | number | undefined; query?: string | undefined; registered_domain?: string | undefined; scheme?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; username?: string | undefined; } | undefined; user?: { changes?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; domain?: string | undefined; effective?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; risk?: { calculated_level?: string | undefined; calculated_score?: number | undefined; calculated_score_norm?: number | undefined; static_level?: string | undefined; static_score?: number | undefined; static_score_norm?: number | undefined; } | undefined; roles?: string[] | undefined; target?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; user_agent?: { device?: { name?: string | undefined; } | undefined; name?: string | undefined; original?: string | undefined; os?: { family?: string | undefined; full?: string | undefined; kernel?: string | undefined; name?: string | undefined; platform?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; version?: string | undefined; } | undefined; vulnerability?: { category?: string[] | undefined; classification?: string | undefined; description?: string | undefined; enumeration?: string | undefined; id?: string | undefined; reference?: string | undefined; report_id?: string | undefined; scanner?: { vendor?: string | undefined; } | undefined; score?: { base?: number | undefined; environmental?: number | undefined; temporal?: number | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; } | undefined; } & {} & { ecs?: { version?: string | undefined; } | undefined; kibana?: { alert?: { risk_score?: number | undefined; rule?: { author?: string | undefined; created_at?: string | undefined; created_by?: string | undefined; description?: string | undefined; enabled?: string | undefined; from?: string | undefined; interval?: string | undefined; license?: string | undefined; note?: string | undefined; references?: string[] | undefined; rule_id?: string | undefined; rule_name_override?: string | undefined; to?: string | undefined; type?: string | undefined; updated_at?: string | undefined; updated_by?: string | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; suppression?: { docs_count?: string | number | undefined; end?: string | undefined; start?: string | undefined; terms?: { field?: string[] | undefined; value?: string[] | undefined; } | undefined; } | undefined; system_status?: string | undefined; workflow_reason?: string | undefined; workflow_user?: string | undefined; } | undefined; } | undefined; })" + "({ '@timestamp': string; kibana: { alert: { instance: { id: string; }; rule: { category: string; consumer: string; name: string; producer: string; revision: string | number; rule_type_id: string; uuid: string; }; status: string; uuid: string; }; space_ids: string[]; }; } & { event?: { action?: string | undefined; kind?: string | undefined; } | undefined; kibana?: { alert?: { action_group?: string | undefined; case_ids?: string[] | undefined; duration?: { us?: string | number | undefined; } | undefined; end?: string | undefined; flapping?: boolean | undefined; flapping_history?: boolean[] | undefined; last_detected?: string | undefined; maintenance_window_ids?: string[] | undefined; reason?: string | undefined; rule?: { execution?: { uuid?: string | undefined; } | undefined; parameters?: unknown; tags?: string[] | undefined; } | undefined; start?: string | undefined; time_range?: { gte?: string | undefined; lte?: string | undefined; } | undefined; url?: string | undefined; workflow_status?: string | undefined; workflow_tags?: string[] | undefined; } | undefined; version?: string | undefined; } | undefined; tags?: string[] | undefined; }) | ({} & { agent?: { name?: string | undefined; } | undefined; error?: { grouping_key?: string | undefined; grouping_name?: string | undefined; } | undefined; kibana?: { alert?: { evaluation?: { threshold?: string | number | undefined; value?: string | number | undefined; values?: (string | number)[] | undefined; } | undefined; } | undefined; } | undefined; processor?: { event?: string | undefined; } | undefined; service?: { environment?: string | undefined; language?: { name?: string | undefined; } | undefined; name?: string | undefined; } | undefined; transaction?: { name?: string | undefined; type?: string | undefined; } | undefined; } & { '@timestamp': string; kibana: { alert: { instance: { id: string; }; rule: { category: string; consumer: string; name: string; producer: string; revision: string | number; rule_type_id: string; uuid: string; }; status: string; uuid: string; }; space_ids: string[]; }; } & { event?: { action?: string | undefined; kind?: string | undefined; } | undefined; kibana?: { alert?: { action_group?: string | undefined; case_ids?: string[] | undefined; duration?: { us?: string | number | undefined; } | undefined; end?: string | undefined; flapping?: boolean | undefined; flapping_history?: boolean[] | undefined; last_detected?: string | undefined; maintenance_window_ids?: string[] | undefined; reason?: string | undefined; rule?: { execution?: { uuid?: string | undefined; } | undefined; parameters?: unknown; tags?: string[] | undefined; } | undefined; start?: string | undefined; time_range?: { gte?: string | undefined; lte?: string | undefined; } | undefined; url?: string | undefined; workflow_status?: string | undefined; workflow_tags?: string[] | undefined; } | undefined; version?: string | undefined; } | undefined; tags?: string[] | undefined; } & {} & { ecs?: { version?: string | undefined; } | undefined; kibana?: { alert?: { risk_score?: number | undefined; rule?: { author?: string | undefined; created_at?: string | undefined; created_by?: string | undefined; description?: string | undefined; enabled?: string | undefined; from?: string | undefined; interval?: string | undefined; license?: string | undefined; note?: string | undefined; references?: string[] | undefined; rule_id?: string | undefined; rule_name_override?: string | undefined; to?: string | undefined; type?: string | undefined; updated_at?: string | undefined; updated_by?: string | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; suppression?: { docs_count?: string | number | undefined; end?: string | undefined; start?: string | undefined; terms?: { field?: string[] | undefined; value?: string[] | undefined; } | undefined; } | undefined; system_status?: string | undefined; workflow_reason?: string | undefined; workflow_user?: string | undefined; } | undefined; } | undefined; }) | ({} & { kibana?: { alert?: { evaluation?: { threshold?: string | number | undefined; value?: string | number | undefined; values?: (string | number)[] | undefined; } | undefined; } | undefined; } | undefined; } & { '@timestamp': string; kibana: { alert: { instance: { id: string; }; rule: { category: string; consumer: string; name: string; producer: string; revision: string | number; rule_type_id: string; uuid: string; }; status: string; uuid: string; }; space_ids: string[]; }; } & { event?: { action?: string | undefined; kind?: string | undefined; } | undefined; kibana?: { alert?: { action_group?: string | undefined; case_ids?: string[] | undefined; duration?: { us?: string | number | undefined; } | undefined; end?: string | undefined; flapping?: boolean | undefined; flapping_history?: boolean[] | undefined; last_detected?: string | undefined; maintenance_window_ids?: string[] | undefined; reason?: string | undefined; rule?: { execution?: { uuid?: string | undefined; } | undefined; parameters?: unknown; tags?: string[] | undefined; } | undefined; start?: string | undefined; time_range?: { gte?: string | undefined; lte?: string | undefined; } | undefined; url?: string | undefined; workflow_status?: string | undefined; workflow_tags?: string[] | undefined; } | undefined; version?: string | undefined; } | undefined; tags?: string[] | undefined; } & { '@timestamp': string; ecs: { version: string; }; } & { agent?: { build?: { original?: string | undefined; } | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; client?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; cloud?: { account?: { id?: string | undefined; name?: string | undefined; } | undefined; availability_zone?: string | undefined; instance?: { id?: string | undefined; name?: string | undefined; } | undefined; machine?: { type?: string | undefined; } | undefined; origin?: { account?: { id?: string | undefined; name?: string | undefined; } | undefined; availability_zone?: string | undefined; instance?: { id?: string | undefined; name?: string | undefined; } | undefined; machine?: { type?: string | undefined; } | undefined; project?: { id?: string | undefined; name?: string | undefined; } | undefined; provider?: string | undefined; region?: string | undefined; service?: { name?: string | undefined; } | undefined; } | undefined; project?: { id?: string | undefined; name?: string | undefined; } | undefined; provider?: string | undefined; region?: string | undefined; service?: { name?: string | undefined; } | undefined; target?: { account?: { id?: string | undefined; name?: string | undefined; } | undefined; availability_zone?: string | undefined; instance?: { id?: string | undefined; name?: string | undefined; } | undefined; machine?: { type?: string | undefined; } | undefined; project?: { id?: string | undefined; name?: string | undefined; } | undefined; provider?: string | undefined; region?: string | undefined; service?: { name?: string | undefined; } | undefined; } | undefined; } | undefined; container?: { cpu?: { usage?: string | number | undefined; } | undefined; disk?: { read?: { bytes?: string | number | undefined; } | undefined; write?: { bytes?: string | number | undefined; } | undefined; } | undefined; id?: string | undefined; image?: { hash?: { all?: string[] | undefined; } | undefined; name?: string | undefined; tag?: string[] | undefined; } | undefined; memory?: { usage?: string | number | undefined; } | undefined; name?: string | undefined; network?: { egress?: { bytes?: string | number | undefined; } | undefined; ingress?: { bytes?: string | number | undefined; } | undefined; } | undefined; runtime?: string | undefined; } | undefined; destination?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; device?: { id?: string | undefined; manufacturer?: string | undefined; model?: { identifier?: string | undefined; name?: string | undefined; } | undefined; } | undefined; dll?: { code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; name?: string | undefined; path?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; } | undefined; dns?: { answers?: { class?: string | undefined; data?: string | undefined; name?: string | undefined; ttl?: string | number | undefined; type?: string | undefined; }[] | undefined; header_flags?: string[] | undefined; id?: string | undefined; op_code?: string | undefined; question?: { class?: string | undefined; name?: string | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; type?: string | undefined; } | undefined; resolved_ip?: string[] | undefined; response_code?: string | undefined; type?: string | undefined; } | undefined; email?: { attachments?: { file?: { extension?: string | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; mime_type?: string | undefined; name?: string | undefined; size?: string | number | undefined; } | undefined; }[] | undefined; bcc?: { address?: string[] | undefined; } | undefined; cc?: { address?: string[] | undefined; } | undefined; content_type?: string | undefined; delivery_timestamp?: string | undefined; direction?: string | undefined; from?: { address?: string[] | undefined; } | undefined; local_id?: string | undefined; message_id?: string | undefined; origination_timestamp?: string | undefined; reply_to?: { address?: string[] | undefined; } | undefined; sender?: { address?: string | undefined; } | undefined; subject?: string | undefined; to?: { address?: string[] | undefined; } | undefined; x_mailer?: string | undefined; } | undefined; error?: { code?: string | undefined; id?: string | undefined; message?: string | undefined; stack_trace?: string | undefined; type?: string | undefined; } | undefined; event?: { action?: string | undefined; agent_id_status?: string | undefined; category?: string[] | undefined; code?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: string | number | undefined; end?: string | undefined; hash?: string | undefined; id?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; original?: string | undefined; outcome?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; severity?: string | number | undefined; start?: string | undefined; timezone?: string | undefined; type?: string[] | undefined; url?: string | undefined; } | undefined; faas?: { coldstart?: boolean | undefined; execution?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; } | undefined; file?: { accessed?: string | undefined; attributes?: string[] | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; created?: string | undefined; ctime?: string | undefined; device?: string | undefined; directory?: string | undefined; drive_letter?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; extension?: string | undefined; fork_name?: string | undefined; gid?: string | undefined; group?: string | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; inode?: string | undefined; mime_type?: string | undefined; mode?: string | undefined; mtime?: string | undefined; name?: string | undefined; owner?: string | undefined; path?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; size?: string | number | undefined; target_path?: string | undefined; type?: string | undefined; uid?: string | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; host?: { architecture?: string | undefined; boot?: { id?: string | undefined; } | undefined; cpu?: { usage?: string | number | undefined; } | undefined; disk?: { read?: { bytes?: string | number | undefined; } | undefined; write?: { bytes?: string | number | undefined; } | undefined; } | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; hostname?: string | undefined; id?: string | undefined; ip?: string[] | undefined; mac?: string[] | undefined; name?: string | undefined; network?: { egress?: { bytes?: string | number | undefined; packets?: string | number | undefined; } | undefined; ingress?: { bytes?: string | number | undefined; packets?: string | number | undefined; } | undefined; } | undefined; os?: { family?: string | undefined; full?: string | undefined; kernel?: string | undefined; name?: string | undefined; platform?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; pid_ns_ino?: string | undefined; risk?: { calculated_level?: string | undefined; calculated_score?: number | undefined; calculated_score_norm?: number | undefined; static_level?: string | undefined; static_score?: number | undefined; static_score_norm?: number | undefined; } | undefined; type?: string | undefined; uptime?: string | number | undefined; } | undefined; http?: { request?: { body?: { bytes?: string | number | undefined; content?: string | undefined; } | undefined; bytes?: string | number | undefined; id?: string | undefined; method?: string | undefined; mime_type?: string | undefined; referrer?: string | undefined; } | undefined; response?: { body?: { bytes?: string | number | undefined; content?: string | undefined; } | undefined; bytes?: string | number | undefined; mime_type?: string | undefined; status_code?: string | number | undefined; } | undefined; version?: string | undefined; } | undefined; log?: { file?: { path?: string | undefined; } | undefined; level?: string | undefined; logger?: string | undefined; origin?: { file?: { line?: string | number | undefined; name?: string | undefined; } | undefined; function?: string | undefined; } | undefined; } | undefined; message?: string | undefined; network?: { application?: string | undefined; bytes?: string | number | undefined; community_id?: string | undefined; direction?: string | undefined; forwarded_ip?: string | undefined; iana_number?: string | undefined; name?: string | undefined; packets?: string | number | undefined; protocol?: string | undefined; transport?: string | undefined; type?: string | undefined; vlan?: { id?: string | undefined; name?: string | undefined; } | undefined; } | undefined; observer?: { geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; hostname?: string | undefined; ip?: string[] | undefined; mac?: string[] | undefined; name?: string | undefined; os?: { family?: string | undefined; full?: string | undefined; kernel?: string | undefined; name?: string | undefined; platform?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; product?: string | undefined; serial_number?: string | undefined; type?: string | undefined; vendor?: string | undefined; version?: string | undefined; } | undefined; orchestrator?: { api_version?: string | undefined; cluster?: { id?: string | undefined; name?: string | undefined; url?: string | undefined; version?: string | undefined; } | undefined; namespace?: string | undefined; organization?: string | undefined; resource?: { id?: string | undefined; ip?: string[] | undefined; name?: string | undefined; parent?: { type?: string | undefined; } | undefined; type?: string | undefined; } | undefined; type?: string | undefined; } | undefined; organization?: { id?: string | undefined; name?: string | undefined; } | undefined; package?: { architecture?: string | undefined; build_version?: string | undefined; checksum?: string | undefined; description?: string | undefined; install_scope?: string | undefined; installed?: string | undefined; license?: string | undefined; name?: string | undefined; path?: string | undefined; reference?: string | undefined; size?: string | number | undefined; type?: string | undefined; version?: string | undefined; } | undefined; process?: { args?: string[] | undefined; args_count?: string | number | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; command_line?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; end?: string | undefined; entity_id?: string | undefined; entry_leader?: { args?: string[] | undefined; args_count?: string | number | undefined; attested_groups?: { name?: string | undefined; } | undefined; attested_user?: { id?: string | undefined; name?: string | undefined; } | undefined; command_line?: string | undefined; entity_id?: string | undefined; entry_meta?: { source?: { ip?: string | undefined; } | undefined; type?: string | undefined; } | undefined; executable?: string | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; parent?: { entity_id?: string | undefined; pid?: string | number | undefined; session_leader?: { entity_id?: string | undefined; pid?: string | number | undefined; start?: string | undefined; } | undefined; start?: string | undefined; } | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; same_as_process?: boolean | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; env_vars?: string[] | undefined; executable?: string | undefined; exit_code?: string | number | undefined; group_leader?: { args?: string[] | undefined; args_count?: string | number | undefined; command_line?: string | undefined; entity_id?: string | undefined; executable?: string | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; same_as_process?: boolean | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; parent?: { args?: string[] | undefined; args_count?: string | number | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; command_line?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; end?: string | undefined; entity_id?: string | undefined; executable?: string | undefined; exit_code?: string | number | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; group_leader?: { entity_id?: string | undefined; pid?: string | number | undefined; start?: string | undefined; } | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; pgid?: string | number | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; thread?: { id?: string | number | undefined; name?: string | undefined; } | undefined; title?: string | undefined; uptime?: string | number | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; pgid?: string | number | undefined; pid?: string | number | undefined; previous?: { args?: string[] | undefined; args_count?: string | number | undefined; executable?: string | undefined; } | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; session_leader?: { args?: string[] | undefined; args_count?: string | number | undefined; command_line?: string | undefined; entity_id?: string | undefined; executable?: string | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; parent?: { entity_id?: string | undefined; pid?: string | number | undefined; session_leader?: { entity_id?: string | undefined; pid?: string | number | undefined; start?: string | undefined; } | undefined; start?: string | undefined; } | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; same_as_process?: boolean | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; thread?: { id?: string | number | undefined; name?: string | undefined; } | undefined; title?: string | undefined; uptime?: string | number | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; registry?: { data?: { bytes?: string | undefined; strings?: string[] | undefined; type?: string | undefined; } | undefined; hive?: string | undefined; key?: string | undefined; path?: string | undefined; value?: string | undefined; } | undefined; related?: { hash?: string[] | undefined; hosts?: string[] | undefined; ip?: string[] | undefined; user?: string[] | undefined; } | undefined; rule?: { author?: string[] | undefined; category?: string | undefined; description?: string | undefined; id?: string | undefined; license?: string | undefined; name?: string | undefined; reference?: string | undefined; ruleset?: string | undefined; uuid?: string | undefined; version?: string | undefined; } | undefined; server?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; service?: { address?: string | undefined; environment?: string | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; node?: { name?: string | undefined; role?: string | undefined; roles?: string[] | undefined; } | undefined; origin?: { address?: string | undefined; environment?: string | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; node?: { name?: string | undefined; role?: string | undefined; roles?: string[] | undefined; } | undefined; state?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; state?: string | undefined; target?: { address?: string | undefined; environment?: string | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; node?: { name?: string | undefined; role?: string | undefined; roles?: string[] | undefined; } | undefined; state?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; type?: string | undefined; version?: string | undefined; } | undefined; source?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; span?: { id?: string | undefined; } | undefined; tags?: string[] | undefined; threat?: { enrichments?: { matched?: { atomic?: string | undefined; field?: string | undefined; id?: string | undefined; index?: string | undefined; occurred?: string | undefined; type?: string | undefined; } | undefined; }[] | undefined; feed?: { dashboard_id?: string | undefined; description?: string | undefined; name?: string | undefined; reference?: string | undefined; } | undefined; framework?: string | undefined; group?: { alias?: string[] | undefined; id?: string | undefined; name?: string | undefined; reference?: string | undefined; } | undefined; indicator?: { as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; confidence?: string | undefined; description?: string | undefined; email?: { address?: string | undefined; } | undefined; file?: { accessed?: string | undefined; attributes?: string[] | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; created?: string | undefined; ctime?: string | undefined; device?: string | undefined; directory?: string | undefined; drive_letter?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; extension?: string | undefined; fork_name?: string | undefined; gid?: string | undefined; group?: string | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; inode?: string | undefined; mime_type?: string | undefined; mode?: string | undefined; mtime?: string | undefined; name?: string | undefined; owner?: string | undefined; path?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; size?: string | number | undefined; target_path?: string | undefined; type?: string | undefined; uid?: string | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; first_seen?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; last_seen?: string | undefined; marking?: { tlp?: string | undefined; tlp_version?: string | undefined; } | undefined; modified_at?: string | undefined; port?: string | number | undefined; provider?: string | undefined; reference?: string | undefined; registry?: { data?: { bytes?: string | undefined; strings?: string[] | undefined; type?: string | undefined; } | undefined; hive?: string | undefined; key?: string | undefined; path?: string | undefined; value?: string | undefined; } | undefined; scanner_stats?: string | number | undefined; sightings?: string | number | undefined; type?: string | undefined; url?: { domain?: string | undefined; extension?: string | undefined; fragment?: string | undefined; full?: string | undefined; original?: string | undefined; password?: string | undefined; path?: string | undefined; port?: string | number | undefined; query?: string | undefined; registered_domain?: string | undefined; scheme?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; username?: string | undefined; } | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; software?: { alias?: string[] | undefined; id?: string | undefined; name?: string | undefined; platforms?: string[] | undefined; reference?: string | undefined; type?: string | undefined; } | undefined; tactic?: { id?: string[] | undefined; name?: string[] | undefined; reference?: string[] | undefined; } | undefined; technique?: { id?: string[] | undefined; name?: string[] | undefined; reference?: string[] | undefined; subtechnique?: { id?: string[] | undefined; name?: string[] | undefined; reference?: string[] | undefined; } | undefined; } | undefined; } | undefined; tls?: { cipher?: string | undefined; client?: { certificate?: string | undefined; certificate_chain?: string[] | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; } | undefined; issuer?: string | undefined; ja3?: string | undefined; not_after?: string | undefined; not_before?: string | undefined; server_name?: string | undefined; subject?: string | undefined; supported_ciphers?: string[] | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; curve?: string | undefined; established?: boolean | undefined; next_protocol?: string | undefined; resumed?: boolean | undefined; server?: { certificate?: string | undefined; certificate_chain?: string[] | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; } | undefined; issuer?: string | undefined; ja3s?: string | undefined; not_after?: string | undefined; not_before?: string | undefined; subject?: string | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; version?: string | undefined; version_protocol?: string | undefined; } | undefined; trace?: { id?: string | undefined; } | undefined; transaction?: { id?: string | undefined; } | undefined; url?: { domain?: string | undefined; extension?: string | undefined; fragment?: string | undefined; full?: string | undefined; original?: string | undefined; password?: string | undefined; path?: string | undefined; port?: string | number | undefined; query?: string | undefined; registered_domain?: string | undefined; scheme?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; username?: string | undefined; } | undefined; user?: { changes?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; domain?: string | undefined; effective?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; risk?: { calculated_level?: string | undefined; calculated_score?: number | undefined; calculated_score_norm?: number | undefined; static_level?: string | undefined; static_score?: number | undefined; static_score_norm?: number | undefined; } | undefined; roles?: string[] | undefined; target?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; user_agent?: { device?: { name?: string | undefined; } | undefined; name?: string | undefined; original?: string | undefined; os?: { family?: string | undefined; full?: string | undefined; kernel?: string | undefined; name?: string | undefined; platform?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; version?: string | undefined; } | undefined; vulnerability?: { category?: string[] | undefined; classification?: string | undefined; description?: string | undefined; enumeration?: string | undefined; id?: string | undefined; reference?: string | undefined; report_id?: string | undefined; scanner?: { vendor?: string | undefined; } | undefined; score?: { base?: number | undefined; environmental?: number | undefined; temporal?: number | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; } | undefined; } & {} & { ecs?: { version?: string | undefined; } | undefined; kibana?: { alert?: { risk_score?: number | undefined; rule?: { author?: string | undefined; created_at?: string | undefined; created_by?: string | undefined; description?: string | undefined; enabled?: string | undefined; from?: string | undefined; interval?: string | undefined; license?: string | undefined; note?: string | undefined; references?: string[] | undefined; rule_id?: string | undefined; rule_name_override?: string | undefined; to?: string | undefined; type?: string | undefined; updated_at?: string | undefined; updated_by?: string | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; suppression?: { docs_count?: string | number | undefined; end?: string | undefined; start?: string | undefined; terms?: { field?: string[] | undefined; value?: string[] | undefined; } | undefined; } | undefined; system_status?: string | undefined; workflow_reason?: string | undefined; workflow_user?: string | undefined; } | undefined; } | undefined; }) | ({} & { kibana?: { alert?: { evaluation?: { threshold?: string | number | undefined; value?: string | number | undefined; values?: (string | number)[] | undefined; } | undefined; } | undefined; } | undefined; } & { '@timestamp': string; kibana: { alert: { instance: { id: string; }; rule: { category: string; consumer: string; name: string; producer: string; revision: string | number; rule_type_id: string; uuid: string; }; status: string; uuid: string; }; space_ids: string[]; }; } & { event?: { action?: string | undefined; kind?: string | undefined; } | undefined; kibana?: { alert?: { action_group?: string | undefined; case_ids?: string[] | undefined; duration?: { us?: string | number | undefined; } | undefined; end?: string | undefined; flapping?: boolean | undefined; flapping_history?: boolean[] | undefined; last_detected?: string | undefined; maintenance_window_ids?: string[] | undefined; reason?: string | undefined; rule?: { execution?: { uuid?: string | undefined; } | undefined; parameters?: unknown; tags?: string[] | undefined; } | undefined; start?: string | undefined; time_range?: { gte?: string | undefined; lte?: string | undefined; } | undefined; url?: string | undefined; workflow_status?: string | undefined; workflow_tags?: string[] | undefined; } | undefined; version?: string | undefined; } | undefined; tags?: string[] | undefined; } & { '@timestamp': string; ecs: { version: string; }; } & { agent?: { build?: { original?: string | undefined; } | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; client?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; cloud?: { account?: { id?: string | undefined; name?: string | undefined; } | undefined; availability_zone?: string | undefined; instance?: { id?: string | undefined; name?: string | undefined; } | undefined; machine?: { type?: string | undefined; } | undefined; origin?: { account?: { id?: string | undefined; name?: string | undefined; } | undefined; availability_zone?: string | undefined; instance?: { id?: string | undefined; name?: string | undefined; } | undefined; machine?: { type?: string | undefined; } | undefined; project?: { id?: string | undefined; name?: string | undefined; } | undefined; provider?: string | undefined; region?: string | undefined; service?: { name?: string | undefined; } | undefined; } | undefined; project?: { id?: string | undefined; name?: string | undefined; } | undefined; provider?: string | undefined; region?: string | undefined; service?: { name?: string | undefined; } | undefined; target?: { account?: { id?: string | undefined; name?: string | undefined; } | undefined; availability_zone?: string | undefined; instance?: { id?: string | undefined; name?: string | undefined; } | undefined; machine?: { type?: string | undefined; } | undefined; project?: { id?: string | undefined; name?: string | undefined; } | undefined; provider?: string | undefined; region?: string | undefined; service?: { name?: string | undefined; } | undefined; } | undefined; } | undefined; container?: { cpu?: { usage?: string | number | undefined; } | undefined; disk?: { read?: { bytes?: string | number | undefined; } | undefined; write?: { bytes?: string | number | undefined; } | undefined; } | undefined; id?: string | undefined; image?: { hash?: { all?: string[] | undefined; } | undefined; name?: string | undefined; tag?: string[] | undefined; } | undefined; memory?: { usage?: string | number | undefined; } | undefined; name?: string | undefined; network?: { egress?: { bytes?: string | number | undefined; } | undefined; ingress?: { bytes?: string | number | undefined; } | undefined; } | undefined; runtime?: string | undefined; } | undefined; destination?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; device?: { id?: string | undefined; manufacturer?: string | undefined; model?: { identifier?: string | undefined; name?: string | undefined; } | undefined; } | undefined; dll?: { code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; name?: string | undefined; path?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; } | undefined; dns?: { answers?: { class?: string | undefined; data?: string | undefined; name?: string | undefined; ttl?: string | number | undefined; type?: string | undefined; }[] | undefined; header_flags?: string[] | undefined; id?: string | undefined; op_code?: string | undefined; question?: { class?: string | undefined; name?: string | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; type?: string | undefined; } | undefined; resolved_ip?: string[] | undefined; response_code?: string | undefined; type?: string | undefined; } | undefined; email?: { attachments?: { file?: { extension?: string | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; mime_type?: string | undefined; name?: string | undefined; size?: string | number | undefined; } | undefined; }[] | undefined; bcc?: { address?: string[] | undefined; } | undefined; cc?: { address?: string[] | undefined; } | undefined; content_type?: string | undefined; delivery_timestamp?: string | undefined; direction?: string | undefined; from?: { address?: string[] | undefined; } | undefined; local_id?: string | undefined; message_id?: string | undefined; origination_timestamp?: string | undefined; reply_to?: { address?: string[] | undefined; } | undefined; sender?: { address?: string | undefined; } | undefined; subject?: string | undefined; to?: { address?: string[] | undefined; } | undefined; x_mailer?: string | undefined; } | undefined; error?: { code?: string | undefined; id?: string | undefined; message?: string | undefined; stack_trace?: string | undefined; type?: string | undefined; } | undefined; event?: { action?: string | undefined; agent_id_status?: string | undefined; category?: string[] | undefined; code?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: string | number | undefined; end?: string | undefined; hash?: string | undefined; id?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; original?: string | undefined; outcome?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; severity?: string | number | undefined; start?: string | undefined; timezone?: string | undefined; type?: string[] | undefined; url?: string | undefined; } | undefined; faas?: { coldstart?: boolean | undefined; execution?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; } | undefined; file?: { accessed?: string | undefined; attributes?: string[] | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; created?: string | undefined; ctime?: string | undefined; device?: string | undefined; directory?: string | undefined; drive_letter?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; extension?: string | undefined; fork_name?: string | undefined; gid?: string | undefined; group?: string | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; inode?: string | undefined; mime_type?: string | undefined; mode?: string | undefined; mtime?: string | undefined; name?: string | undefined; owner?: string | undefined; path?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; size?: string | number | undefined; target_path?: string | undefined; type?: string | undefined; uid?: string | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; host?: { architecture?: string | undefined; boot?: { id?: string | undefined; } | undefined; cpu?: { usage?: string | number | undefined; } | undefined; disk?: { read?: { bytes?: string | number | undefined; } | undefined; write?: { bytes?: string | number | undefined; } | undefined; } | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; hostname?: string | undefined; id?: string | undefined; ip?: string[] | undefined; mac?: string[] | undefined; name?: string | undefined; network?: { egress?: { bytes?: string | number | undefined; packets?: string | number | undefined; } | undefined; ingress?: { bytes?: string | number | undefined; packets?: string | number | undefined; } | undefined; } | undefined; os?: { family?: string | undefined; full?: string | undefined; kernel?: string | undefined; name?: string | undefined; platform?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; pid_ns_ino?: string | undefined; risk?: { calculated_level?: string | undefined; calculated_score?: number | undefined; calculated_score_norm?: number | undefined; static_level?: string | undefined; static_score?: number | undefined; static_score_norm?: number | undefined; } | undefined; type?: string | undefined; uptime?: string | number | undefined; } | undefined; http?: { request?: { body?: { bytes?: string | number | undefined; content?: string | undefined; } | undefined; bytes?: string | number | undefined; id?: string | undefined; method?: string | undefined; mime_type?: string | undefined; referrer?: string | undefined; } | undefined; response?: { body?: { bytes?: string | number | undefined; content?: string | undefined; } | undefined; bytes?: string | number | undefined; mime_type?: string | undefined; status_code?: string | number | undefined; } | undefined; version?: string | undefined; } | undefined; log?: { file?: { path?: string | undefined; } | undefined; level?: string | undefined; logger?: string | undefined; origin?: { file?: { line?: string | number | undefined; name?: string | undefined; } | undefined; function?: string | undefined; } | undefined; } | undefined; message?: string | undefined; network?: { application?: string | undefined; bytes?: string | number | undefined; community_id?: string | undefined; direction?: string | undefined; forwarded_ip?: string | undefined; iana_number?: string | undefined; name?: string | undefined; packets?: string | number | undefined; protocol?: string | undefined; transport?: string | undefined; type?: string | undefined; vlan?: { id?: string | undefined; name?: string | undefined; } | undefined; } | undefined; observer?: { geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; hostname?: string | undefined; ip?: string[] | undefined; mac?: string[] | undefined; name?: string | undefined; os?: { family?: string | undefined; full?: string | undefined; kernel?: string | undefined; name?: string | undefined; platform?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; product?: string | undefined; serial_number?: string | undefined; type?: string | undefined; vendor?: string | undefined; version?: string | undefined; } | undefined; orchestrator?: { api_version?: string | undefined; cluster?: { id?: string | undefined; name?: string | undefined; url?: string | undefined; version?: string | undefined; } | undefined; namespace?: string | undefined; organization?: string | undefined; resource?: { id?: string | undefined; ip?: string[] | undefined; name?: string | undefined; parent?: { type?: string | undefined; } | undefined; type?: string | undefined; } | undefined; type?: string | undefined; } | undefined; organization?: { id?: string | undefined; name?: string | undefined; } | undefined; package?: { architecture?: string | undefined; build_version?: string | undefined; checksum?: string | undefined; description?: string | undefined; install_scope?: string | undefined; installed?: string | undefined; license?: string | undefined; name?: string | undefined; path?: string | undefined; reference?: string | undefined; size?: string | number | undefined; type?: string | undefined; version?: string | undefined; } | undefined; process?: { args?: string[] | undefined; args_count?: string | number | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; command_line?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; end?: string | undefined; entity_id?: string | undefined; entry_leader?: { args?: string[] | undefined; args_count?: string | number | undefined; attested_groups?: { name?: string | undefined; } | undefined; attested_user?: { id?: string | undefined; name?: string | undefined; } | undefined; command_line?: string | undefined; entity_id?: string | undefined; entry_meta?: { source?: { ip?: string | undefined; } | undefined; type?: string | undefined; } | undefined; executable?: string | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; parent?: { entity_id?: string | undefined; pid?: string | number | undefined; session_leader?: { entity_id?: string | undefined; pid?: string | number | undefined; start?: string | undefined; } | undefined; start?: string | undefined; } | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; same_as_process?: boolean | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; env_vars?: string[] | undefined; executable?: string | undefined; exit_code?: string | number | undefined; group_leader?: { args?: string[] | undefined; args_count?: string | number | undefined; command_line?: string | undefined; entity_id?: string | undefined; executable?: string | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; same_as_process?: boolean | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; parent?: { args?: string[] | undefined; args_count?: string | number | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; command_line?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; end?: string | undefined; entity_id?: string | undefined; executable?: string | undefined; exit_code?: string | number | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; group_leader?: { entity_id?: string | undefined; pid?: string | number | undefined; start?: string | undefined; } | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; pgid?: string | number | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; thread?: { id?: string | number | undefined; name?: string | undefined; } | undefined; title?: string | undefined; uptime?: string | number | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; pgid?: string | number | undefined; pid?: string | number | undefined; previous?: { args?: string[] | undefined; args_count?: string | number | undefined; executable?: string | undefined; } | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; session_leader?: { args?: string[] | undefined; args_count?: string | number | undefined; command_line?: string | undefined; entity_id?: string | undefined; executable?: string | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; parent?: { entity_id?: string | undefined; pid?: string | number | undefined; session_leader?: { entity_id?: string | undefined; pid?: string | number | undefined; start?: string | undefined; } | undefined; start?: string | undefined; } | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; same_as_process?: boolean | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; thread?: { id?: string | number | undefined; name?: string | undefined; } | undefined; title?: string | undefined; uptime?: string | number | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; registry?: { data?: { bytes?: string | undefined; strings?: string[] | undefined; type?: string | undefined; } | undefined; hive?: string | undefined; key?: string | undefined; path?: string | undefined; value?: string | undefined; } | undefined; related?: { hash?: string[] | undefined; hosts?: string[] | undefined; ip?: string[] | undefined; user?: string[] | undefined; } | undefined; rule?: { author?: string[] | undefined; category?: string | undefined; description?: string | undefined; id?: string | undefined; license?: string | undefined; name?: string | undefined; reference?: string | undefined; ruleset?: string | undefined; uuid?: string | undefined; version?: string | undefined; } | undefined; server?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; service?: { address?: string | undefined; environment?: string | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; node?: { name?: string | undefined; role?: string | undefined; roles?: string[] | undefined; } | undefined; origin?: { address?: string | undefined; environment?: string | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; node?: { name?: string | undefined; role?: string | undefined; roles?: string[] | undefined; } | undefined; state?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; state?: string | undefined; target?: { address?: string | undefined; environment?: string | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; node?: { name?: string | undefined; role?: string | undefined; roles?: string[] | undefined; } | undefined; state?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; type?: string | undefined; version?: string | undefined; } | undefined; source?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; span?: { id?: string | undefined; } | undefined; tags?: string[] | undefined; threat?: { enrichments?: { matched?: { atomic?: string | undefined; field?: string | undefined; id?: string | undefined; index?: string | undefined; occurred?: string | undefined; type?: string | undefined; } | undefined; }[] | undefined; feed?: { dashboard_id?: string | undefined; description?: string | undefined; name?: string | undefined; reference?: string | undefined; } | undefined; framework?: string | undefined; group?: { alias?: string[] | undefined; id?: string | undefined; name?: string | undefined; reference?: string | undefined; } | undefined; indicator?: { as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; confidence?: string | undefined; description?: string | undefined; email?: { address?: string | undefined; } | undefined; file?: { accessed?: string | undefined; attributes?: string[] | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; created?: string | undefined; ctime?: string | undefined; device?: string | undefined; directory?: string | undefined; drive_letter?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; extension?: string | undefined; fork_name?: string | undefined; gid?: string | undefined; group?: string | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; inode?: string | undefined; mime_type?: string | undefined; mode?: string | undefined; mtime?: string | undefined; name?: string | undefined; owner?: string | undefined; path?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; size?: string | number | undefined; target_path?: string | undefined; type?: string | undefined; uid?: string | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; first_seen?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; last_seen?: string | undefined; marking?: { tlp?: string | undefined; tlp_version?: string | undefined; } | undefined; modified_at?: string | undefined; port?: string | number | undefined; provider?: string | undefined; reference?: string | undefined; registry?: { data?: { bytes?: string | undefined; strings?: string[] | undefined; type?: string | undefined; } | undefined; hive?: string | undefined; key?: string | undefined; path?: string | undefined; value?: string | undefined; } | undefined; scanner_stats?: string | number | undefined; sightings?: string | number | undefined; type?: string | undefined; url?: { domain?: string | undefined; extension?: string | undefined; fragment?: string | undefined; full?: string | undefined; original?: string | undefined; password?: string | undefined; path?: string | undefined; port?: string | number | undefined; query?: string | undefined; registered_domain?: string | undefined; scheme?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; username?: string | undefined; } | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; software?: { alias?: string[] | undefined; id?: string | undefined; name?: string | undefined; platforms?: string[] | undefined; reference?: string | undefined; type?: string | undefined; } | undefined; tactic?: { id?: string[] | undefined; name?: string[] | undefined; reference?: string[] | undefined; } | undefined; technique?: { id?: string[] | undefined; name?: string[] | undefined; reference?: string[] | undefined; subtechnique?: { id?: string[] | undefined; name?: string[] | undefined; reference?: string[] | undefined; } | undefined; } | undefined; } | undefined; tls?: { cipher?: string | undefined; client?: { certificate?: string | undefined; certificate_chain?: string[] | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; } | undefined; issuer?: string | undefined; ja3?: string | undefined; not_after?: string | undefined; not_before?: string | undefined; server_name?: string | undefined; subject?: string | undefined; supported_ciphers?: string[] | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; curve?: string | undefined; established?: boolean | undefined; next_protocol?: string | undefined; resumed?: boolean | undefined; server?: { certificate?: string | undefined; certificate_chain?: string[] | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; } | undefined; issuer?: string | undefined; ja3s?: string | undefined; not_after?: string | undefined; not_before?: string | undefined; subject?: string | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; version?: string | undefined; version_protocol?: string | undefined; } | undefined; trace?: { id?: string | undefined; } | undefined; transaction?: { id?: string | undefined; } | undefined; url?: { domain?: string | undefined; extension?: string | undefined; fragment?: string | undefined; full?: string | undefined; original?: string | undefined; password?: string | undefined; path?: string | undefined; port?: string | number | undefined; query?: string | undefined; registered_domain?: string | undefined; scheme?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; username?: string | undefined; } | undefined; user?: { changes?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; domain?: string | undefined; effective?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; risk?: { calculated_level?: string | undefined; calculated_score?: number | undefined; calculated_score_norm?: number | undefined; static_level?: string | undefined; static_score?: number | undefined; static_score_norm?: number | undefined; } | undefined; roles?: string[] | undefined; target?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; user_agent?: { device?: { name?: string | undefined; } | undefined; name?: string | undefined; original?: string | undefined; os?: { family?: string | undefined; full?: string | undefined; kernel?: string | undefined; name?: string | undefined; platform?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; version?: string | undefined; } | undefined; vulnerability?: { category?: string[] | undefined; classification?: string | undefined; description?: string | undefined; enumeration?: string | undefined; id?: string | undefined; reference?: string | undefined; report_id?: string | undefined; scanner?: { vendor?: string | undefined; } | undefined; score?: { base?: number | undefined; environmental?: number | undefined; temporal?: number | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; } | undefined; } & {} & { ecs?: { version?: string | undefined; } | undefined; kibana?: { alert?: { risk_score?: number | undefined; rule?: { author?: string | undefined; created_at?: string | undefined; created_by?: string | undefined; description?: string | undefined; enabled?: string | undefined; from?: string | undefined; interval?: string | undefined; license?: string | undefined; note?: string | undefined; references?: string[] | undefined; rule_id?: string | undefined; rule_name_override?: string | undefined; to?: string | undefined; type?: string | undefined; updated_at?: string | undefined; updated_by?: string | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; suppression?: { docs_count?: string | number | undefined; end?: string | undefined; start?: string | undefined; terms?: { field?: string[] | undefined; value?: string[] | undefined; } | undefined; } | undefined; system_status?: string | undefined; workflow_reason?: string | undefined; workflow_user?: string | undefined; } | undefined; } | undefined; }) | ({} & { kibana?: { alert?: { evaluation?: { threshold?: string | number | undefined; value?: string | number | undefined; values?: (string | number)[] | undefined; } | undefined; } | undefined; } | undefined; slo?: { id?: string | undefined; revision?: string | number | undefined; } | undefined; } & { '@timestamp': string; kibana: { alert: { instance: { id: string; }; rule: { category: string; consumer: string; name: string; producer: string; revision: string | number; rule_type_id: string; uuid: string; }; status: string; uuid: string; }; space_ids: string[]; }; } & { event?: { action?: string | undefined; kind?: string | undefined; } | undefined; kibana?: { alert?: { action_group?: string | undefined; case_ids?: string[] | undefined; duration?: { us?: string | number | undefined; } | undefined; end?: string | undefined; flapping?: boolean | undefined; flapping_history?: boolean[] | undefined; last_detected?: string | undefined; maintenance_window_ids?: string[] | undefined; reason?: string | undefined; rule?: { execution?: { uuid?: string | undefined; } | undefined; parameters?: unknown; tags?: string[] | undefined; } | undefined; start?: string | undefined; time_range?: { gte?: string | undefined; lte?: string | undefined; } | undefined; url?: string | undefined; workflow_status?: string | undefined; workflow_tags?: string[] | undefined; } | undefined; version?: string | undefined; } | undefined; tags?: string[] | undefined; } & {} & { ecs?: { version?: string | undefined; } | undefined; kibana?: { alert?: { risk_score?: number | undefined; rule?: { author?: string | undefined; created_at?: string | undefined; created_by?: string | undefined; description?: string | undefined; enabled?: string | undefined; from?: string | undefined; interval?: string | undefined; license?: string | undefined; note?: string | undefined; references?: string[] | undefined; rule_id?: string | undefined; rule_name_override?: string | undefined; to?: string | undefined; type?: string | undefined; updated_at?: string | undefined; updated_by?: string | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; suppression?: { docs_count?: string | number | undefined; end?: string | undefined; start?: string | undefined; terms?: { field?: string[] | undefined; value?: string[] | undefined; } | undefined; } | undefined; system_status?: string | undefined; workflow_reason?: string | undefined; workflow_user?: string | undefined; } | undefined; } | undefined; }) | ({} & { agent?: { name?: string | undefined; } | undefined; anomaly?: { bucket_span?: { minutes?: string | undefined; } | undefined; start?: string | undefined; } | undefined; error?: { message?: string | undefined; } | undefined; kibana?: { alert?: { evaluation?: { threshold?: string | number | undefined; value?: string | number | undefined; values?: (string | number)[] | undefined; } | undefined; } | undefined; } | undefined; monitor?: { id?: string | undefined; name?: string | undefined; type?: string | undefined; } | undefined; observer?: { geo?: { name?: string | undefined; } | undefined; } | undefined; tls?: { server?: { hash?: { sha256?: string | undefined; } | undefined; x509?: { issuer?: { common_name?: string | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; subject?: { common_name?: string | undefined; } | undefined; } | undefined; } | undefined; } | undefined; url?: { full?: string | undefined; } | undefined; } & { '@timestamp': string; kibana: { alert: { instance: { id: string; }; rule: { category: string; consumer: string; name: string; producer: string; revision: string | number; rule_type_id: string; uuid: string; }; status: string; uuid: string; }; space_ids: string[]; }; } & { event?: { action?: string | undefined; kind?: string | undefined; } | undefined; kibana?: { alert?: { action_group?: string | undefined; case_ids?: string[] | undefined; duration?: { us?: string | number | undefined; } | undefined; end?: string | undefined; flapping?: boolean | undefined; flapping_history?: boolean[] | undefined; last_detected?: string | undefined; maintenance_window_ids?: string[] | undefined; reason?: string | undefined; rule?: { execution?: { uuid?: string | undefined; } | undefined; parameters?: unknown; tags?: string[] | undefined; } | undefined; start?: string | undefined; time_range?: { gte?: string | undefined; lte?: string | undefined; } | undefined; url?: string | undefined; workflow_status?: string | undefined; workflow_tags?: string[] | undefined; } | undefined; version?: string | undefined; } | undefined; tags?: string[] | undefined; } & {} & { ecs?: { version?: string | undefined; } | undefined; kibana?: { alert?: { risk_score?: number | undefined; rule?: { author?: string | undefined; created_at?: string | undefined; created_by?: string | undefined; description?: string | undefined; enabled?: string | undefined; from?: string | undefined; interval?: string | undefined; license?: string | undefined; note?: string | undefined; references?: string[] | undefined; rule_id?: string | undefined; rule_name_override?: string | undefined; to?: string | undefined; type?: string | undefined; updated_at?: string | undefined; updated_by?: string | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; suppression?: { docs_count?: string | number | undefined; end?: string | undefined; start?: string | undefined; terms?: { field?: string[] | undefined; value?: string[] | undefined; } | undefined; } | undefined; system_status?: string | undefined; workflow_reason?: string | undefined; workflow_user?: string | undefined; } | undefined; } | undefined; }) | ({ '@timestamp': string; kibana: { alert: { ancestors: { depth: string | number; id: string; index: string; type: string; }[]; depth: string | number; instance: { id: string; }; original_event: { action: string; category: string[]; created: string; dataset: string; id: string; ingested: string; kind: string; module: string; original: string; outcome: string; provider: string; sequence: string | number; type: string[]; }; original_time: string; rule: { category: string; consumer: string; false_positives: string[]; max_signals: (string | number)[]; name: string; producer: string; revision: string | number; rule_type_id: string; threat: { framework: string; tactic: { id: string; name: string; reference: string; }; technique: { id: string; name: string; reference: string; subtechnique: { id: string; name: string; reference: string; }; }; }; uuid: string; }; status: string; uuid: string; }; space_ids: string[]; }; } & { ecs?: { version?: string | undefined; } | undefined; event?: { action?: string | undefined; kind?: string | undefined; } | undefined; kibana?: { alert?: { action_group?: string | undefined; ancestors?: { rule?: string | undefined; } | undefined; building_block_type?: string | undefined; case_ids?: string[] | undefined; duration?: { us?: string | number | undefined; } | undefined; end?: string | undefined; flapping?: boolean | undefined; flapping_history?: boolean[] | undefined; group?: { id?: string | undefined; index?: number | undefined; } | undefined; last_detected?: string | undefined; maintenance_window_ids?: string[] | undefined; new_terms?: string[] | undefined; original_event?: { agent_id_status?: string | undefined; code?: string | undefined; duration?: string | undefined; end?: string | undefined; hash?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; severity?: string | number | undefined; start?: string | undefined; timezone?: string | undefined; url?: string | undefined; } | undefined; reason?: string | undefined; risk_score?: number | undefined; rule?: { author?: string | undefined; building_block_type?: string | undefined; created_at?: string | undefined; created_by?: string | undefined; description?: string | undefined; enabled?: string | undefined; execution?: { uuid?: string | undefined; } | undefined; from?: string | undefined; immutable?: string[] | undefined; interval?: string | undefined; license?: string | undefined; note?: string | undefined; parameters?: unknown; references?: string[] | undefined; rule_id?: string | undefined; rule_name_override?: string | undefined; tags?: string[] | undefined; timeline_id?: string[] | undefined; timeline_title?: string[] | undefined; timestamp_override?: string | undefined; to?: string | undefined; type?: string | undefined; updated_at?: string | undefined; updated_by?: string | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; start?: string | undefined; suppression?: { docs_count?: string | number | undefined; end?: string | undefined; start?: string | undefined; terms?: { field?: string[] | undefined; value?: string[] | undefined; } | undefined; } | undefined; system_status?: string | undefined; threshold_result?: { count?: string | number | undefined; from?: string | undefined; terms?: { field?: string | undefined; value?: string | undefined; }[] | undefined; } | undefined; time_range?: { gte?: string | undefined; lte?: string | undefined; } | undefined; url?: string | undefined; workflow_reason?: string | undefined; workflow_status?: string | undefined; workflow_tags?: string[] | undefined; workflow_user?: string | undefined; } | undefined; version?: string | undefined; } | undefined; signal?: { ancestors?: { depth?: unknown; id?: unknown; index?: unknown; type?: unknown; } | undefined; depth?: unknown; group?: { id?: unknown; index?: unknown; } | undefined; original_event?: { action?: unknown; category?: unknown; code?: unknown; created?: unknown; dataset?: unknown; duration?: unknown; end?: unknown; hash?: unknown; id?: unknown; kind?: unknown; module?: unknown; outcome?: unknown; provider?: unknown; reason?: unknown; risk_score?: unknown; risk_score_norm?: unknown; sequence?: unknown; severity?: unknown; start?: unknown; timezone?: unknown; type?: unknown; } | undefined; original_time?: unknown; reason?: unknown; rule?: { author?: unknown; building_block_type?: unknown; created_at?: unknown; created_by?: unknown; description?: unknown; enabled?: unknown; false_positives?: unknown; from?: unknown; id?: unknown; immutable?: unknown; interval?: unknown; license?: unknown; max_signals?: unknown; name?: unknown; note?: unknown; references?: unknown; risk_score?: unknown; rule_id?: unknown; rule_name_override?: unknown; severity?: unknown; tags?: unknown; threat?: { framework?: unknown; tactic?: { id?: unknown; name?: unknown; reference?: unknown; } | undefined; technique?: { id?: unknown; name?: unknown; reference?: unknown; subtechnique?: { id?: unknown; name?: unknown; reference?: unknown; } | undefined; } | undefined; } | undefined; timeline_id?: unknown; timeline_title?: unknown; timestamp_override?: unknown; to?: unknown; type?: unknown; updated_at?: unknown; updated_by?: unknown; version?: unknown; } | undefined; status?: unknown; threshold_result?: { cardinality?: { field?: unknown; value?: unknown; } | undefined; count?: unknown; from?: unknown; terms?: { field?: unknown; value?: unknown; } | undefined; } | undefined; } | undefined; tags?: string[] | undefined; } & { '@timestamp': string; kibana: { alert: { instance: { id: string; }; rule: { category: string; consumer: string; name: string; producer: string; revision: string | number; rule_type_id: string; uuid: string; }; status: string; uuid: string; }; space_ids: string[]; }; } & { event?: { action?: string | undefined; kind?: string | undefined; } | undefined; kibana?: { alert?: { action_group?: string | undefined; case_ids?: string[] | undefined; duration?: { us?: string | number | undefined; } | undefined; end?: string | undefined; flapping?: boolean | undefined; flapping_history?: boolean[] | undefined; last_detected?: string | undefined; maintenance_window_ids?: string[] | undefined; reason?: string | undefined; rule?: { execution?: { uuid?: string | undefined; } | undefined; parameters?: unknown; tags?: string[] | undefined; } | undefined; start?: string | undefined; time_range?: { gte?: string | undefined; lte?: string | undefined; } | undefined; url?: string | undefined; workflow_status?: string | undefined; workflow_tags?: string[] | undefined; } | undefined; version?: string | undefined; } | undefined; tags?: string[] | undefined; } & { '@timestamp': string; ecs: { version: string; }; } & { agent?: { build?: { original?: string | undefined; } | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; client?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; cloud?: { account?: { id?: string | undefined; name?: string | undefined; } | undefined; availability_zone?: string | undefined; instance?: { id?: string | undefined; name?: string | undefined; } | undefined; machine?: { type?: string | undefined; } | undefined; origin?: { account?: { id?: string | undefined; name?: string | undefined; } | undefined; availability_zone?: string | undefined; instance?: { id?: string | undefined; name?: string | undefined; } | undefined; machine?: { type?: string | undefined; } | undefined; project?: { id?: string | undefined; name?: string | undefined; } | undefined; provider?: string | undefined; region?: string | undefined; service?: { name?: string | undefined; } | undefined; } | undefined; project?: { id?: string | undefined; name?: string | undefined; } | undefined; provider?: string | undefined; region?: string | undefined; service?: { name?: string | undefined; } | undefined; target?: { account?: { id?: string | undefined; name?: string | undefined; } | undefined; availability_zone?: string | undefined; instance?: { id?: string | undefined; name?: string | undefined; } | undefined; machine?: { type?: string | undefined; } | undefined; project?: { id?: string | undefined; name?: string | undefined; } | undefined; provider?: string | undefined; region?: string | undefined; service?: { name?: string | undefined; } | undefined; } | undefined; } | undefined; container?: { cpu?: { usage?: string | number | undefined; } | undefined; disk?: { read?: { bytes?: string | number | undefined; } | undefined; write?: { bytes?: string | number | undefined; } | undefined; } | undefined; id?: string | undefined; image?: { hash?: { all?: string[] | undefined; } | undefined; name?: string | undefined; tag?: string[] | undefined; } | undefined; memory?: { usage?: string | number | undefined; } | undefined; name?: string | undefined; network?: { egress?: { bytes?: string | number | undefined; } | undefined; ingress?: { bytes?: string | number | undefined; } | undefined; } | undefined; runtime?: string | undefined; } | undefined; destination?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; device?: { id?: string | undefined; manufacturer?: string | undefined; model?: { identifier?: string | undefined; name?: string | undefined; } | undefined; } | undefined; dll?: { code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; name?: string | undefined; path?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; } | undefined; dns?: { answers?: { class?: string | undefined; data?: string | undefined; name?: string | undefined; ttl?: string | number | undefined; type?: string | undefined; }[] | undefined; header_flags?: string[] | undefined; id?: string | undefined; op_code?: string | undefined; question?: { class?: string | undefined; name?: string | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; type?: string | undefined; } | undefined; resolved_ip?: string[] | undefined; response_code?: string | undefined; type?: string | undefined; } | undefined; email?: { attachments?: { file?: { extension?: string | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; mime_type?: string | undefined; name?: string | undefined; size?: string | number | undefined; } | undefined; }[] | undefined; bcc?: { address?: string[] | undefined; } | undefined; cc?: { address?: string[] | undefined; } | undefined; content_type?: string | undefined; delivery_timestamp?: string | undefined; direction?: string | undefined; from?: { address?: string[] | undefined; } | undefined; local_id?: string | undefined; message_id?: string | undefined; origination_timestamp?: string | undefined; reply_to?: { address?: string[] | undefined; } | undefined; sender?: { address?: string | undefined; } | undefined; subject?: string | undefined; to?: { address?: string[] | undefined; } | undefined; x_mailer?: string | undefined; } | undefined; error?: { code?: string | undefined; id?: string | undefined; message?: string | undefined; stack_trace?: string | undefined; type?: string | undefined; } | undefined; event?: { action?: string | undefined; agent_id_status?: string | undefined; category?: string[] | undefined; code?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: string | number | undefined; end?: string | undefined; hash?: string | undefined; id?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; original?: string | undefined; outcome?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; severity?: string | number | undefined; start?: string | undefined; timezone?: string | undefined; type?: string[] | undefined; url?: string | undefined; } | undefined; faas?: { coldstart?: boolean | undefined; execution?: string | undefined; id?: string | undefined; name?: string | undefined; version?: string | undefined; } | undefined; file?: { accessed?: string | undefined; attributes?: string[] | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; created?: string | undefined; ctime?: string | undefined; device?: string | undefined; directory?: string | undefined; drive_letter?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; extension?: string | undefined; fork_name?: string | undefined; gid?: string | undefined; group?: string | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; inode?: string | undefined; mime_type?: string | undefined; mode?: string | undefined; mtime?: string | undefined; name?: string | undefined; owner?: string | undefined; path?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; size?: string | number | undefined; target_path?: string | undefined; type?: string | undefined; uid?: string | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; host?: { architecture?: string | undefined; boot?: { id?: string | undefined; } | undefined; cpu?: { usage?: string | number | undefined; } | undefined; disk?: { read?: { bytes?: string | number | undefined; } | undefined; write?: { bytes?: string | number | undefined; } | undefined; } | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; hostname?: string | undefined; id?: string | undefined; ip?: string[] | undefined; mac?: string[] | undefined; name?: string | undefined; network?: { egress?: { bytes?: string | number | undefined; packets?: string | number | undefined; } | undefined; ingress?: { bytes?: string | number | undefined; packets?: string | number | undefined; } | undefined; } | undefined; os?: { family?: string | undefined; full?: string | undefined; kernel?: string | undefined; name?: string | undefined; platform?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; pid_ns_ino?: string | undefined; risk?: { calculated_level?: string | undefined; calculated_score?: number | undefined; calculated_score_norm?: number | undefined; static_level?: string | undefined; static_score?: number | undefined; static_score_norm?: number | undefined; } | undefined; type?: string | undefined; uptime?: string | number | undefined; } | undefined; http?: { request?: { body?: { bytes?: string | number | undefined; content?: string | undefined; } | undefined; bytes?: string | number | undefined; id?: string | undefined; method?: string | undefined; mime_type?: string | undefined; referrer?: string | undefined; } | undefined; response?: { body?: { bytes?: string | number | undefined; content?: string | undefined; } | undefined; bytes?: string | number | undefined; mime_type?: string | undefined; status_code?: string | number | undefined; } | undefined; version?: string | undefined; } | undefined; log?: { file?: { path?: string | undefined; } | undefined; level?: string | undefined; logger?: string | undefined; origin?: { file?: { line?: string | number | undefined; name?: string | undefined; } | undefined; function?: string | undefined; } | undefined; } | undefined; message?: string | undefined; network?: { application?: string | undefined; bytes?: string | number | undefined; community_id?: string | undefined; direction?: string | undefined; forwarded_ip?: string | undefined; iana_number?: string | undefined; name?: string | undefined; packets?: string | number | undefined; protocol?: string | undefined; transport?: string | undefined; type?: string | undefined; vlan?: { id?: string | undefined; name?: string | undefined; } | undefined; } | undefined; observer?: { geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; hostname?: string | undefined; ip?: string[] | undefined; mac?: string[] | undefined; name?: string | undefined; os?: { family?: string | undefined; full?: string | undefined; kernel?: string | undefined; name?: string | undefined; platform?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; product?: string | undefined; serial_number?: string | undefined; type?: string | undefined; vendor?: string | undefined; version?: string | undefined; } | undefined; orchestrator?: { api_version?: string | undefined; cluster?: { id?: string | undefined; name?: string | undefined; url?: string | undefined; version?: string | undefined; } | undefined; namespace?: string | undefined; organization?: string | undefined; resource?: { id?: string | undefined; ip?: string[] | undefined; name?: string | undefined; parent?: { type?: string | undefined; } | undefined; type?: string | undefined; } | undefined; type?: string | undefined; } | undefined; organization?: { id?: string | undefined; name?: string | undefined; } | undefined; package?: { architecture?: string | undefined; build_version?: string | undefined; checksum?: string | undefined; description?: string | undefined; install_scope?: string | undefined; installed?: string | undefined; license?: string | undefined; name?: string | undefined; path?: string | undefined; reference?: string | undefined; size?: string | number | undefined; type?: string | undefined; version?: string | undefined; } | undefined; process?: { args?: string[] | undefined; args_count?: string | number | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; command_line?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; end?: string | undefined; entity_id?: string | undefined; entry_leader?: { args?: string[] | undefined; args_count?: string | number | undefined; attested_groups?: { name?: string | undefined; } | undefined; attested_user?: { id?: string | undefined; name?: string | undefined; } | undefined; command_line?: string | undefined; entity_id?: string | undefined; entry_meta?: { source?: { ip?: string | undefined; } | undefined; type?: string | undefined; } | undefined; executable?: string | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; parent?: { entity_id?: string | undefined; pid?: string | number | undefined; session_leader?: { entity_id?: string | undefined; pid?: string | number | undefined; start?: string | undefined; } | undefined; start?: string | undefined; } | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; same_as_process?: boolean | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; env_vars?: string[] | undefined; executable?: string | undefined; exit_code?: string | number | undefined; group_leader?: { args?: string[] | undefined; args_count?: string | number | undefined; command_line?: string | undefined; entity_id?: string | undefined; executable?: string | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; same_as_process?: boolean | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; parent?: { args?: string[] | undefined; args_count?: string | number | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; command_line?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; end?: string | undefined; entity_id?: string | undefined; executable?: string | undefined; exit_code?: string | number | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; group_leader?: { entity_id?: string | undefined; pid?: string | number | undefined; start?: string | undefined; } | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; pgid?: string | number | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; thread?: { id?: string | number | undefined; name?: string | undefined; } | undefined; title?: string | undefined; uptime?: string | number | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; pgid?: string | number | undefined; pid?: string | number | undefined; previous?: { args?: string[] | undefined; args_count?: string | number | undefined; executable?: string | undefined; } | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; session_leader?: { args?: string[] | undefined; args_count?: string | number | undefined; command_line?: string | undefined; entity_id?: string | undefined; executable?: string | undefined; group?: { id?: string | undefined; name?: string | undefined; } | undefined; interactive?: boolean | undefined; name?: string | undefined; parent?: { entity_id?: string | undefined; pid?: string | number | undefined; session_leader?: { entity_id?: string | undefined; pid?: string | number | undefined; start?: string | undefined; } | undefined; start?: string | undefined; } | undefined; pid?: string | number | undefined; real_group?: { id?: string | undefined; name?: string | undefined; } | undefined; real_user?: { id?: string | undefined; name?: string | undefined; } | undefined; same_as_process?: boolean | undefined; saved_group?: { id?: string | undefined; name?: string | undefined; } | undefined; saved_user?: { id?: string | undefined; name?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; start?: string | undefined; supplemental_groups?: { id?: string | undefined; name?: string | undefined; } | undefined; thread?: { id?: string | number | undefined; name?: string | undefined; } | undefined; title?: string | undefined; uptime?: string | number | undefined; user?: { id?: string | undefined; name?: string | undefined; } | undefined; working_directory?: string | undefined; } | undefined; registry?: { data?: { bytes?: string | undefined; strings?: string[] | undefined; type?: string | undefined; } | undefined; hive?: string | undefined; key?: string | undefined; path?: string | undefined; value?: string | undefined; } | undefined; related?: { hash?: string[] | undefined; hosts?: string[] | undefined; ip?: string[] | undefined; user?: string[] | undefined; } | undefined; rule?: { author?: string[] | undefined; category?: string | undefined; description?: string | undefined; id?: string | undefined; license?: string | undefined; name?: string | undefined; reference?: string | undefined; ruleset?: string | undefined; uuid?: string | undefined; version?: string | undefined; } | undefined; server?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; service?: { address?: string | undefined; environment?: string | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; node?: { name?: string | undefined; role?: string | undefined; roles?: string[] | undefined; } | undefined; origin?: { address?: string | undefined; environment?: string | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; node?: { name?: string | undefined; role?: string | undefined; roles?: string[] | undefined; } | undefined; state?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; state?: string | undefined; target?: { address?: string | undefined; environment?: string | undefined; ephemeral_id?: string | undefined; id?: string | undefined; name?: string | undefined; node?: { name?: string | undefined; role?: string | undefined; roles?: string[] | undefined; } | undefined; state?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; type?: string | undefined; version?: string | undefined; } | undefined; source?: { address?: string | undefined; as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; bytes?: string | number | undefined; domain?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; mac?: string | undefined; nat?: { ip?: string | undefined; port?: string | number | undefined; } | undefined; packets?: string | number | undefined; port?: string | number | undefined; registered_domain?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; user?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; span?: { id?: string | undefined; } | undefined; tags?: string[] | undefined; threat?: { enrichments?: { matched?: { atomic?: string | undefined; field?: string | undefined; id?: string | undefined; index?: string | undefined; occurred?: string | undefined; type?: string | undefined; } | undefined; }[] | undefined; feed?: { dashboard_id?: string | undefined; description?: string | undefined; name?: string | undefined; reference?: string | undefined; } | undefined; framework?: string | undefined; group?: { alias?: string[] | undefined; id?: string | undefined; name?: string | undefined; reference?: string | undefined; } | undefined; indicator?: { as?: { number?: string | number | undefined; organization?: { name?: string | undefined; } | undefined; } | undefined; confidence?: string | undefined; description?: string | undefined; email?: { address?: string | undefined; } | undefined; file?: { accessed?: string | undefined; attributes?: string[] | undefined; code_signature?: { digest_algorithm?: string | undefined; exists?: boolean | undefined; signing_id?: string | undefined; status?: string | undefined; subject_name?: string | undefined; team_id?: string | undefined; timestamp?: string | undefined; trusted?: boolean | undefined; valid?: boolean | undefined; } | undefined; created?: string | undefined; ctime?: string | undefined; device?: string | undefined; directory?: string | undefined; drive_letter?: string | undefined; elf?: { architecture?: string | undefined; byte_order?: string | undefined; cpu_type?: string | undefined; creation_date?: string | undefined; exports?: unknown[] | undefined; header?: { abi_version?: string | undefined; class?: string | undefined; data?: string | undefined; entrypoint?: string | number | undefined; object_version?: string | undefined; os_abi?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; imports?: unknown[] | undefined; sections?: { chi2?: string | number | undefined; entropy?: string | number | undefined; flags?: string | undefined; name?: string | undefined; physical_offset?: string | undefined; physical_size?: string | number | undefined; type?: string | undefined; virtual_address?: string | number | undefined; virtual_size?: string | number | undefined; }[] | undefined; segments?: { sections?: string | undefined; type?: string | undefined; }[] | undefined; shared_libraries?: string[] | undefined; telfhash?: string | undefined; } | undefined; extension?: string | undefined; fork_name?: string | undefined; gid?: string | undefined; group?: string | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; sha384?: string | undefined; sha512?: string | undefined; ssdeep?: string | undefined; tlsh?: string | undefined; } | undefined; inode?: string | undefined; mime_type?: string | undefined; mode?: string | undefined; mtime?: string | undefined; name?: string | undefined; owner?: string | undefined; path?: string | undefined; pe?: { architecture?: string | undefined; company?: string | undefined; description?: string | undefined; file_version?: string | undefined; imphash?: string | undefined; original_file_name?: string | undefined; pehash?: string | undefined; product?: string | undefined; } | undefined; size?: string | number | undefined; target_path?: string | undefined; type?: string | undefined; uid?: string | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; first_seen?: string | undefined; geo?: { city_name?: string | undefined; continent_code?: string | undefined; continent_name?: string | undefined; country_iso_code?: string | undefined; country_name?: string | undefined; location?: string | { type: string; coordinates: number[]; } | { lat: number; lon: number; } | { location: number[]; } | { location: string; } | undefined; name?: string | undefined; postal_code?: string | undefined; region_iso_code?: string | undefined; region_name?: string | undefined; timezone?: string | undefined; } | undefined; ip?: string | undefined; last_seen?: string | undefined; marking?: { tlp?: string | undefined; tlp_version?: string | undefined; } | undefined; modified_at?: string | undefined; port?: string | number | undefined; provider?: string | undefined; reference?: string | undefined; registry?: { data?: { bytes?: string | undefined; strings?: string[] | undefined; type?: string | undefined; } | undefined; hive?: string | undefined; key?: string | undefined; path?: string | undefined; value?: string | undefined; } | undefined; scanner_stats?: string | number | undefined; sightings?: string | number | undefined; type?: string | undefined; url?: { domain?: string | undefined; extension?: string | undefined; fragment?: string | undefined; full?: string | undefined; original?: string | undefined; password?: string | undefined; path?: string | undefined; port?: string | number | undefined; query?: string | undefined; registered_domain?: string | undefined; scheme?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; username?: string | undefined; } | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; software?: { alias?: string[] | undefined; id?: string | undefined; name?: string | undefined; platforms?: string[] | undefined; reference?: string | undefined; type?: string | undefined; } | undefined; tactic?: { id?: string[] | undefined; name?: string[] | undefined; reference?: string[] | undefined; } | undefined; technique?: { id?: string[] | undefined; name?: string[] | undefined; reference?: string[] | undefined; subtechnique?: { id?: string[] | undefined; name?: string[] | undefined; reference?: string[] | undefined; } | undefined; } | undefined; } | undefined; tls?: { cipher?: string | undefined; client?: { certificate?: string | undefined; certificate_chain?: string[] | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; } | undefined; issuer?: string | undefined; ja3?: string | undefined; not_after?: string | undefined; not_before?: string | undefined; server_name?: string | undefined; subject?: string | undefined; supported_ciphers?: string[] | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; curve?: string | undefined; established?: boolean | undefined; next_protocol?: string | undefined; resumed?: boolean | undefined; server?: { certificate?: string | undefined; certificate_chain?: string[] | undefined; hash?: { md5?: string | undefined; sha1?: string | undefined; sha256?: string | undefined; } | undefined; issuer?: string | undefined; ja3s?: string | undefined; not_after?: string | undefined; not_before?: string | undefined; subject?: string | undefined; x509?: { alternative_names?: string[] | undefined; issuer?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; not_after?: string | undefined; not_before?: string | undefined; public_key_algorithm?: string | undefined; public_key_curve?: string | undefined; public_key_exponent?: string | number | undefined; public_key_size?: string | number | undefined; serial_number?: string | undefined; signature_algorithm?: string | undefined; subject?: { common_name?: string[] | undefined; country?: string[] | undefined; distinguished_name?: string | undefined; locality?: string[] | undefined; organization?: string[] | undefined; organizational_unit?: string[] | undefined; state_or_province?: string[] | undefined; } | undefined; version_number?: string | undefined; } | undefined; } | undefined; version?: string | undefined; version_protocol?: string | undefined; } | undefined; trace?: { id?: string | undefined; } | undefined; transaction?: { id?: string | undefined; } | undefined; url?: { domain?: string | undefined; extension?: string | undefined; fragment?: string | undefined; full?: string | undefined; original?: string | undefined; password?: string | undefined; path?: string | undefined; port?: string | number | undefined; query?: string | undefined; registered_domain?: string | undefined; scheme?: string | undefined; subdomain?: string | undefined; top_level_domain?: string | undefined; username?: string | undefined; } | undefined; user?: { changes?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; domain?: string | undefined; effective?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; risk?: { calculated_level?: string | undefined; calculated_score?: number | undefined; calculated_score_norm?: number | undefined; static_level?: string | undefined; static_score?: number | undefined; static_score_norm?: number | undefined; } | undefined; roles?: string[] | undefined; target?: { domain?: string | undefined; email?: string | undefined; full_name?: string | undefined; group?: { domain?: string | undefined; id?: string | undefined; name?: string | undefined; } | undefined; hash?: string | undefined; id?: string | undefined; name?: string | undefined; roles?: string[] | undefined; } | undefined; } | undefined; user_agent?: { device?: { name?: string | undefined; } | undefined; name?: string | undefined; original?: string | undefined; os?: { family?: string | undefined; full?: string | undefined; kernel?: string | undefined; name?: string | undefined; platform?: string | undefined; type?: string | undefined; version?: string | undefined; } | undefined; version?: string | undefined; } | undefined; vulnerability?: { category?: string[] | undefined; classification?: string | undefined; description?: string | undefined; enumeration?: string | undefined; id?: string | undefined; reference?: string | undefined; report_id?: string | undefined; scanner?: { vendor?: string | undefined; } | undefined; score?: { base?: number | undefined; environmental?: number | undefined; temporal?: number | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; } | undefined; } & {} & { ecs?: { version?: string | undefined; } | undefined; kibana?: { alert?: { risk_score?: number | undefined; rule?: { author?: string | undefined; created_at?: string | undefined; created_by?: string | undefined; description?: string | undefined; enabled?: string | undefined; from?: string | undefined; interval?: string | undefined; license?: string | undefined; note?: string | undefined; references?: string[] | undefined; rule_id?: string | undefined; rule_name_override?: string | undefined; to?: string | undefined; type?: string | undefined; updated_at?: string | undefined; updated_by?: string | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; suppression?: { docs_count?: string | number | undefined; end?: string | undefined; start?: string | undefined; terms?: { field?: string[] | undefined; value?: string[] | undefined; } | undefined; } | undefined; system_status?: string | undefined; workflow_reason?: string | undefined; workflow_user?: string | undefined; } | undefined; } | undefined; })" ], "path": "packages/kbn-alerts-as-data-utils/src/schemas/index.ts", "deprecated": false, @@ -244,7 +244,7 @@ "label": "ObservabilityApmAlert", "description": [], "signature": [ - "{} & { agent?: { name?: string | undefined; } | undefined; error?: { grouping_key?: string | undefined; } | undefined; kibana?: { alert?: { evaluation?: { threshold?: string | number | undefined; value?: string | number | undefined; values?: (string | number)[] | undefined; } | undefined; } | undefined; } | undefined; processor?: { event?: string | undefined; } | undefined; service?: { environment?: string | undefined; language?: { name?: string | undefined; } | undefined; name?: string | undefined; } | undefined; transaction?: { name?: string | undefined; type?: string | undefined; } | undefined; } & { '@timestamp': string; kibana: { alert: { instance: { id: string; }; rule: { category: string; consumer: string; name: string; producer: string; revision: string | number; rule_type_id: string; uuid: string; }; status: string; uuid: string; }; space_ids: string[]; }; } & { event?: { action?: string | undefined; kind?: string | undefined; } | undefined; kibana?: { alert?: { action_group?: string | undefined; case_ids?: string[] | undefined; duration?: { us?: string | number | undefined; } | undefined; end?: string | undefined; flapping?: boolean | undefined; flapping_history?: boolean[] | undefined; last_detected?: string | undefined; maintenance_window_ids?: string[] | undefined; reason?: string | undefined; rule?: { execution?: { uuid?: string | undefined; } | undefined; parameters?: unknown; tags?: string[] | undefined; } | undefined; start?: string | undefined; time_range?: { gte?: string | undefined; lte?: string | undefined; } | undefined; url?: string | undefined; workflow_status?: string | undefined; workflow_tags?: string[] | undefined; } | undefined; version?: string | undefined; } | undefined; tags?: string[] | undefined; } & {} & { ecs?: { version?: string | undefined; } | undefined; kibana?: { alert?: { risk_score?: number | undefined; rule?: { author?: string | undefined; created_at?: string | undefined; created_by?: string | undefined; description?: string | undefined; enabled?: string | undefined; from?: string | undefined; interval?: string | undefined; license?: string | undefined; note?: string | undefined; references?: string[] | undefined; rule_id?: string | undefined; rule_name_override?: string | undefined; to?: string | undefined; type?: string | undefined; updated_at?: string | undefined; updated_by?: string | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; suppression?: { docs_count?: string | number | undefined; end?: string | undefined; start?: string | undefined; terms?: { field?: string[] | undefined; value?: string[] | undefined; } | undefined; } | undefined; system_status?: string | undefined; workflow_reason?: string | undefined; workflow_user?: string | undefined; } | undefined; } | undefined; }" + "{} & { agent?: { name?: string | undefined; } | undefined; error?: { grouping_key?: string | undefined; grouping_name?: string | undefined; } | undefined; kibana?: { alert?: { evaluation?: { threshold?: string | number | undefined; value?: string | number | undefined; values?: (string | number)[] | undefined; } | undefined; } | undefined; } | undefined; processor?: { event?: string | undefined; } | undefined; service?: { environment?: string | undefined; language?: { name?: string | undefined; } | undefined; name?: string | undefined; } | undefined; transaction?: { name?: string | undefined; type?: string | undefined; } | undefined; } & { '@timestamp': string; kibana: { alert: { instance: { id: string; }; rule: { category: string; consumer: string; name: string; producer: string; revision: string | number; rule_type_id: string; uuid: string; }; status: string; uuid: string; }; space_ids: string[]; }; } & { event?: { action?: string | undefined; kind?: string | undefined; } | undefined; kibana?: { alert?: { action_group?: string | undefined; case_ids?: string[] | undefined; duration?: { us?: string | number | undefined; } | undefined; end?: string | undefined; flapping?: boolean | undefined; flapping_history?: boolean[] | undefined; last_detected?: string | undefined; maintenance_window_ids?: string[] | undefined; reason?: string | undefined; rule?: { execution?: { uuid?: string | undefined; } | undefined; parameters?: unknown; tags?: string[] | undefined; } | undefined; start?: string | undefined; time_range?: { gte?: string | undefined; lte?: string | undefined; } | undefined; url?: string | undefined; workflow_status?: string | undefined; workflow_tags?: string[] | undefined; } | undefined; version?: string | undefined; } | undefined; tags?: string[] | undefined; } & {} & { ecs?: { version?: string | undefined; } | undefined; kibana?: { alert?: { risk_score?: number | undefined; rule?: { author?: string | undefined; created_at?: string | undefined; created_by?: string | undefined; description?: string | undefined; enabled?: string | undefined; from?: string | undefined; interval?: string | undefined; license?: string | undefined; note?: string | undefined; references?: string[] | undefined; rule_id?: string | undefined; rule_name_override?: string | undefined; to?: string | undefined; type?: string | undefined; updated_at?: string | undefined; updated_by?: string | undefined; version?: string | undefined; } | undefined; severity?: string | undefined; suppression?: { docs_count?: string | number | undefined; end?: string | undefined; start?: string | undefined; terms?: { field?: string[] | undefined; value?: string[] | undefined; } | undefined; } | undefined; system_status?: string | undefined; workflow_reason?: string | undefined; workflow_user?: string | undefined; } | undefined; } | undefined; }" ], "path": "packages/kbn-alerts-as-data-utils/src/schemas/generated/observability_apm_schema.ts", "deprecated": false, diff --git a/api_docs/kbn_alerts_as_data_utils.mdx b/api_docs/kbn_alerts_as_data_utils.mdx index b9b520e36dfb8..ab14195c15091 100644 --- a/api_docs/kbn_alerts_as_data_utils.mdx +++ b/api_docs/kbn_alerts_as_data_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerts-as-data-utils title: "@kbn/alerts-as-data-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/alerts-as-data-utils plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts-as-data-utils'] --- import kbnAlertsAsDataUtilsObj from './kbn_alerts_as_data_utils.devdocs.json'; diff --git a/api_docs/kbn_alerts_ui_shared.mdx b/api_docs/kbn_alerts_ui_shared.mdx index 694d2f230f177..7a94b38c05096 100644 --- a/api_docs/kbn_alerts_ui_shared.mdx +++ b/api_docs/kbn_alerts_ui_shared.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerts-ui-shared title: "@kbn/alerts-ui-shared" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/alerts-ui-shared plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts-ui-shared'] --- import kbnAlertsUiSharedObj from './kbn_alerts_ui_shared.devdocs.json'; diff --git a/api_docs/kbn_analytics.mdx b/api_docs/kbn_analytics.mdx index 126f0a46f88cb..f122edd4401a1 100644 --- a/api_docs/kbn_analytics.mdx +++ b/api_docs/kbn_analytics.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics title: "@kbn/analytics" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/analytics plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics'] --- import kbnAnalyticsObj from './kbn_analytics.devdocs.json'; diff --git a/api_docs/kbn_analytics_client.mdx b/api_docs/kbn_analytics_client.mdx index 74a8353bbed7d..29b926dce16a7 100644 --- a/api_docs/kbn_analytics_client.mdx +++ b/api_docs/kbn_analytics_client.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-client title: "@kbn/analytics-client" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/analytics-client plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-client'] --- import kbnAnalyticsClientObj from './kbn_analytics_client.devdocs.json'; diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx b/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx index 34d69381a912f..c8380f8763366 100644 --- a/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx +++ b/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx @@ -8,7 +8,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 description: API docs for the @kbn/analytics-shippers-elastic-v3-browser plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-browser'] --- import kbnAnalyticsShippersElasticV3BrowserObj from './kbn_analytics_shippers_elastic_v3_browser.devdocs.json'; diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx b/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx index 8b4ea10b16aba..680f42bc3641c 100644 --- a/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx +++ b/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx @@ -8,7 +8,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 description: API docs for the @kbn/analytics-shippers-elastic-v3-common plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-common'] --- import kbnAnalyticsShippersElasticV3CommonObj from './kbn_analytics_shippers_elastic_v3_common.devdocs.json'; diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx b/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx index 23f311d7a545c..7332e477405d1 100644 --- a/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx +++ b/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx @@ -8,7 +8,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 description: API docs for the @kbn/analytics-shippers-elastic-v3-server plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-server'] --- import kbnAnalyticsShippersElasticV3ServerObj from './kbn_analytics_shippers_elastic_v3_server.devdocs.json'; diff --git a/api_docs/kbn_analytics_shippers_fullstory.mdx b/api_docs/kbn_analytics_shippers_fullstory.mdx index f9f6d8e319a20..e6e0a50d5c447 100644 --- a/api_docs/kbn_analytics_shippers_fullstory.mdx +++ b/api_docs/kbn_analytics_shippers_fullstory.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-fullstory title: "@kbn/analytics-shippers-fullstory" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/analytics-shippers-fullstory plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-fullstory'] --- import kbnAnalyticsShippersFullstoryObj from './kbn_analytics_shippers_fullstory.devdocs.json'; diff --git a/api_docs/kbn_analytics_shippers_gainsight.mdx b/api_docs/kbn_analytics_shippers_gainsight.mdx index 3072792c8f147..bced0c20cdc36 100644 --- a/api_docs/kbn_analytics_shippers_gainsight.mdx +++ b/api_docs/kbn_analytics_shippers_gainsight.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-gainsight title: "@kbn/analytics-shippers-gainsight" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/analytics-shippers-gainsight plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-gainsight'] --- import kbnAnalyticsShippersGainsightObj from './kbn_analytics_shippers_gainsight.devdocs.json'; diff --git a/api_docs/kbn_apm_config_loader.mdx b/api_docs/kbn_apm_config_loader.mdx index cc63c9a594184..8fdfe8423fc2b 100644 --- a/api_docs/kbn_apm_config_loader.mdx +++ b/api_docs/kbn_apm_config_loader.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-config-loader title: "@kbn/apm-config-loader" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/apm-config-loader plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-config-loader'] --- import kbnApmConfigLoaderObj from './kbn_apm_config_loader.devdocs.json'; diff --git a/api_docs/kbn_apm_synthtrace.mdx b/api_docs/kbn_apm_synthtrace.mdx index 59119a02ed685..bcfbdff46b083 100644 --- a/api_docs/kbn_apm_synthtrace.mdx +++ b/api_docs/kbn_apm_synthtrace.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-synthtrace title: "@kbn/apm-synthtrace" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/apm-synthtrace plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-synthtrace'] --- import kbnApmSynthtraceObj from './kbn_apm_synthtrace.devdocs.json'; diff --git a/api_docs/kbn_apm_synthtrace_client.mdx b/api_docs/kbn_apm_synthtrace_client.mdx index 78e0682b0677f..5fa8c3fe95794 100644 --- a/api_docs/kbn_apm_synthtrace_client.mdx +++ b/api_docs/kbn_apm_synthtrace_client.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-synthtrace-client title: "@kbn/apm-synthtrace-client" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/apm-synthtrace-client plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-synthtrace-client'] --- import kbnApmSynthtraceClientObj from './kbn_apm_synthtrace_client.devdocs.json'; diff --git a/api_docs/kbn_apm_utils.mdx b/api_docs/kbn_apm_utils.mdx index 7621ada3f324d..b4d21c063c0f8 100644 --- a/api_docs/kbn_apm_utils.mdx +++ b/api_docs/kbn_apm_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-utils title: "@kbn/apm-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/apm-utils plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-utils'] --- import kbnApmUtilsObj from './kbn_apm_utils.devdocs.json'; diff --git a/api_docs/kbn_axe_config.mdx b/api_docs/kbn_axe_config.mdx index 9172324ca42bf..3ff842f115ea7 100644 --- a/api_docs/kbn_axe_config.mdx +++ b/api_docs/kbn_axe_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-axe-config title: "@kbn/axe-config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/axe-config plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/axe-config'] --- import kbnAxeConfigObj from './kbn_axe_config.devdocs.json'; diff --git a/api_docs/kbn_cases_components.mdx b/api_docs/kbn_cases_components.mdx index ff368b72062dc..eaa150a7b6758 100644 --- a/api_docs/kbn_cases_components.mdx +++ b/api_docs/kbn_cases_components.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-cases-components title: "@kbn/cases-components" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/cases-components plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cases-components'] --- import kbnCasesComponentsObj from './kbn_cases_components.devdocs.json'; diff --git a/api_docs/kbn_cell_actions.mdx b/api_docs/kbn_cell_actions.mdx index d5eb1e50d7a6c..86316c32c20bc 100644 --- a/api_docs/kbn_cell_actions.mdx +++ b/api_docs/kbn_cell_actions.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-cell-actions title: "@kbn/cell-actions" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/cell-actions plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cell-actions'] --- import kbnCellActionsObj from './kbn_cell_actions.devdocs.json'; diff --git a/api_docs/kbn_chart_expressions_common.mdx b/api_docs/kbn_chart_expressions_common.mdx index a06e63ba0db57..0a1523bc6a68f 100644 --- a/api_docs/kbn_chart_expressions_common.mdx +++ b/api_docs/kbn_chart_expressions_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-chart-expressions-common title: "@kbn/chart-expressions-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/chart-expressions-common plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/chart-expressions-common'] --- import kbnChartExpressionsCommonObj from './kbn_chart_expressions_common.devdocs.json'; diff --git a/api_docs/kbn_chart_icons.mdx b/api_docs/kbn_chart_icons.mdx index c2b8678b95d5c..a39778a801567 100644 --- a/api_docs/kbn_chart_icons.mdx +++ b/api_docs/kbn_chart_icons.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-chart-icons title: "@kbn/chart-icons" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/chart-icons plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/chart-icons'] --- import kbnChartIconsObj from './kbn_chart_icons.devdocs.json'; diff --git a/api_docs/kbn_ci_stats_core.mdx b/api_docs/kbn_ci_stats_core.mdx index dd345f00b4991..16500199cd6e4 100644 --- a/api_docs/kbn_ci_stats_core.mdx +++ b/api_docs/kbn_ci_stats_core.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-core title: "@kbn/ci-stats-core" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ci-stats-core plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-core'] --- import kbnCiStatsCoreObj from './kbn_ci_stats_core.devdocs.json'; diff --git a/api_docs/kbn_ci_stats_performance_metrics.mdx b/api_docs/kbn_ci_stats_performance_metrics.mdx index a620ff7fa7f31..568f200a41b05 100644 --- a/api_docs/kbn_ci_stats_performance_metrics.mdx +++ b/api_docs/kbn_ci_stats_performance_metrics.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-performance-metrics title: "@kbn/ci-stats-performance-metrics" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ci-stats-performance-metrics plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-performance-metrics'] --- import kbnCiStatsPerformanceMetricsObj from './kbn_ci_stats_performance_metrics.devdocs.json'; diff --git a/api_docs/kbn_ci_stats_reporter.mdx b/api_docs/kbn_ci_stats_reporter.mdx index 5c0d6aebc6bfd..9ba656d7c845e 100644 --- a/api_docs/kbn_ci_stats_reporter.mdx +++ b/api_docs/kbn_ci_stats_reporter.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-reporter title: "@kbn/ci-stats-reporter" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ci-stats-reporter plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-reporter'] --- import kbnCiStatsReporterObj from './kbn_ci_stats_reporter.devdocs.json'; diff --git a/api_docs/kbn_cli_dev_mode.mdx b/api_docs/kbn_cli_dev_mode.mdx index 57a4692ea3eb9..c095e5ba84924 100644 --- a/api_docs/kbn_cli_dev_mode.mdx +++ b/api_docs/kbn_cli_dev_mode.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-cli-dev-mode title: "@kbn/cli-dev-mode" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/cli-dev-mode plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cli-dev-mode'] --- import kbnCliDevModeObj from './kbn_cli_dev_mode.devdocs.json'; diff --git a/api_docs/kbn_code_editor.mdx b/api_docs/kbn_code_editor.mdx index a6f8482805bfa..6aec3930e682f 100644 --- a/api_docs/kbn_code_editor.mdx +++ b/api_docs/kbn_code_editor.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-code-editor title: "@kbn/code-editor" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/code-editor plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/code-editor'] --- import kbnCodeEditorObj from './kbn_code_editor.devdocs.json'; diff --git a/api_docs/kbn_code_editor_mocks.mdx b/api_docs/kbn_code_editor_mocks.mdx index f504890769f02..ba52e349a47a0 100644 --- a/api_docs/kbn_code_editor_mocks.mdx +++ b/api_docs/kbn_code_editor_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-code-editor-mocks title: "@kbn/code-editor-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/code-editor-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/code-editor-mocks'] --- import kbnCodeEditorMocksObj from './kbn_code_editor_mocks.devdocs.json'; diff --git a/api_docs/kbn_coloring.mdx b/api_docs/kbn_coloring.mdx index e76b045c08ae6..234bd71ee1b42 100644 --- a/api_docs/kbn_coloring.mdx +++ b/api_docs/kbn_coloring.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-coloring title: "@kbn/coloring" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/coloring plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/coloring'] --- import kbnColoringObj from './kbn_coloring.devdocs.json'; diff --git a/api_docs/kbn_config.mdx b/api_docs/kbn_config.mdx index 70ed7fb5db79f..bd4b8713d576a 100644 --- a/api_docs/kbn_config.mdx +++ b/api_docs/kbn_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-config title: "@kbn/config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/config plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config'] --- import kbnConfigObj from './kbn_config.devdocs.json'; diff --git a/api_docs/kbn_config_mocks.devdocs.json b/api_docs/kbn_config_mocks.devdocs.json index 800e030c8cac8..df37ecf488422 100644 --- a/api_docs/kbn_config_mocks.devdocs.json +++ b/api_docs/kbn_config_mocks.devdocs.json @@ -230,7 +230,7 @@ "section": "def-common.ConfigPath", "text": "ConfigPath" }, - "]>; get: jest.MockInstance; get: jest.MockInstance; set: jest.MockInstance; set: jest.MockInstance; getFlattenedPaths: jest.MockInstance; toRaw: jest.MockInstance, []>; } & ", + ", value: any], unknown>; getFlattenedPaths: jest.MockInstance; toRaw: jest.MockInstance, [], unknown>; } & ", "Config" ], "path": "packages/kbn-config-mocks/src/config.mock.ts", @@ -264,11 +264,11 @@ "signature": [ "{ validate: jest.MockInstance, [params?: ", "ConfigValidateParameters", - " | undefined]>; getConfig$: jest.MockInstance<", + " | undefined], unknown>; getConfig$: jest.MockInstance<", "Observable", "<", "Config", - ">, []>; setSchema: jest.MockInstance, [], unknown>; setSchema: jest.MockInstance]>; addDeprecationProvider: jest.MockInstance], unknown>; addDeprecationProvider: jest.MockInstance; getHandledDeprecatedConfigs: jest.MockInstance<[string, ", + "], unknown>; getHandledDeprecatedConfigs: jest.MockInstance<[string, ", { "pluginId": "@kbn/config", "scope": "common", @@ -308,7 +308,7 @@ "section": "def-common.DeprecatedConfigDetails", "text": "DeprecatedConfigDetails" }, - "[]][], []>; atPath: jest.MockInstance<", + "[]][], [], unknown>; atPath: jest.MockInstance<", "Observable", ", [path: ", { @@ -318,7 +318,7 @@ "section": "def-common.ConfigPath", "text": "ConfigPath" }, - "]>; atPathSync: jest.MockInstance; atPathSync: jest.MockInstance; isEnabledAtPath: jest.MockInstance, [path: ", + "], unknown>; isEnabledAtPath: jest.MockInstance, [path: ", { "pluginId": "@kbn/config", "scope": "common", @@ -334,7 +334,7 @@ "section": "def-common.ConfigPath", "text": "ConfigPath" }, - "]>; getUnusedPaths: jest.MockInstance, []>; getUsedPaths: jest.MockInstance, []>; getDeprecatedConfigPath$: jest.MockInstance<", + "], unknown>; getUnusedPaths: jest.MockInstance, [], unknown>; getUsedPaths: jest.MockInstance, [], unknown>; getDeprecatedConfigPath$: jest.MockInstance<", "Observable", "<", { @@ -344,7 +344,7 @@ "section": "def-common.ChangedDeprecatedPaths", "text": "ChangedDeprecatedPaths" }, - ">, []>; } & ", + ">, [], unknown>; } & ", "IConfigService" ], "path": "packages/kbn-config-mocks/src/config_service.mock.ts", @@ -360,9 +360,9 @@ "label": "RawConfigServiceMock", "description": [], "signature": [ - "{ stop: jest.MockInstance; getConfig$: jest.MockInstance<", + "{ stop: jest.MockInstance; getConfig$: jest.MockInstance<", "Observable", - ">, []>; loadConfig: jest.MockInstance; reloadConfig: jest.MockInstance; } & ", + ">, [], unknown>; loadConfig: jest.MockInstance; reloadConfig: jest.MockInstance; } & ", { "pluginId": "@kbn/utility-types", "scope": "common", diff --git a/api_docs/kbn_config_mocks.mdx b/api_docs/kbn_config_mocks.mdx index 232eb1874d230..7131e8691b8f8 100644 --- a/api_docs/kbn_config_mocks.mdx +++ b/api_docs/kbn_config_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-config-mocks title: "@kbn/config-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/config-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config-mocks'] --- import kbnConfigMocksObj from './kbn_config_mocks.devdocs.json'; diff --git a/api_docs/kbn_config_schema.mdx b/api_docs/kbn_config_schema.mdx index 86ba55286ac5c..26c94ae469b3b 100644 --- a/api_docs/kbn_config_schema.mdx +++ b/api_docs/kbn_config_schema.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-config-schema title: "@kbn/config-schema" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/config-schema plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config-schema'] --- import kbnConfigSchemaObj from './kbn_config_schema.devdocs.json'; diff --git a/api_docs/kbn_content_management_content_editor.mdx b/api_docs/kbn_content_management_content_editor.mdx index 346f8be9ed795..0ab96f8899261 100644 --- a/api_docs/kbn_content_management_content_editor.mdx +++ b/api_docs/kbn_content_management_content_editor.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-content-management-content-editor title: "@kbn/content-management-content-editor" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/content-management-content-editor plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/content-management-content-editor'] --- import kbnContentManagementContentEditorObj from './kbn_content_management_content_editor.devdocs.json'; diff --git a/api_docs/kbn_content_management_tabbed_table_list_view.mdx b/api_docs/kbn_content_management_tabbed_table_list_view.mdx index cb07834904447..9014be64c0f5b 100644 --- a/api_docs/kbn_content_management_tabbed_table_list_view.mdx +++ b/api_docs/kbn_content_management_tabbed_table_list_view.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-content-management-tabbed-table-list-view title: "@kbn/content-management-tabbed-table-list-view" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/content-management-tabbed-table-list-view plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/content-management-tabbed-table-list-view'] --- import kbnContentManagementTabbedTableListViewObj from './kbn_content_management_tabbed_table_list_view.devdocs.json'; diff --git a/api_docs/kbn_content_management_table_list_view.mdx b/api_docs/kbn_content_management_table_list_view.mdx index c6bdced42d5eb..d11aa0d498e1d 100644 --- a/api_docs/kbn_content_management_table_list_view.mdx +++ b/api_docs/kbn_content_management_table_list_view.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-content-management-table-list-view title: "@kbn/content-management-table-list-view" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/content-management-table-list-view plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/content-management-table-list-view'] --- import kbnContentManagementTableListViewObj from './kbn_content_management_table_list_view.devdocs.json'; diff --git a/api_docs/kbn_content_management_table_list_view_table.devdocs.json b/api_docs/kbn_content_management_table_list_view_table.devdocs.json index 35d5364d4b7d2..5ec3703c8de0c 100644 --- a/api_docs/kbn_content_management_table_list_view_table.devdocs.json +++ b/api_docs/kbn_content_management_table_list_view_table.devdocs.json @@ -893,7 +893,9 @@ "type": "CompoundType", "tags": [], "label": "refreshListBouncer", - "description": [], + "description": [ + "Flag to force a new fetch of the table items. Whenever it changes, the `findItems()` will be called." + ], "signature": [ "boolean | undefined" ], diff --git a/api_docs/kbn_content_management_table_list_view_table.mdx b/api_docs/kbn_content_management_table_list_view_table.mdx index 59bf34fc96f24..3ea9d022a7453 100644 --- a/api_docs/kbn_content_management_table_list_view_table.mdx +++ b/api_docs/kbn_content_management_table_list_view_table.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-content-management-table-list-view-table title: "@kbn/content-management-table-list-view-table" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/content-management-table-list-view-table plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/content-management-table-list-view-table'] --- import kbnContentManagementTableListViewTableObj from './kbn_content_management_table_list_view_table.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sh | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 58 | 0 | 41 | 4 | +| 58 | 0 | 40 | 4 | ## Common diff --git a/api_docs/kbn_content_management_utils.mdx b/api_docs/kbn_content_management_utils.mdx index babd8c5419aea..f7efb664a5c71 100644 --- a/api_docs/kbn_content_management_utils.mdx +++ b/api_docs/kbn_content_management_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-content-management-utils title: "@kbn/content-management-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/content-management-utils plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/content-management-utils'] --- import kbnContentManagementUtilsObj from './kbn_content_management_utils.devdocs.json'; diff --git a/api_docs/kbn_core_analytics_browser.mdx b/api_docs/kbn_core_analytics_browser.mdx index d4c0bd5f4855d..f824ca61a6b07 100644 --- a/api_docs/kbn_core_analytics_browser.mdx +++ b/api_docs/kbn_core_analytics_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-browser title: "@kbn/core-analytics-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-analytics-browser plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-browser'] --- import kbnCoreAnalyticsBrowserObj from './kbn_core_analytics_browser.devdocs.json'; diff --git a/api_docs/kbn_core_analytics_browser_internal.mdx b/api_docs/kbn_core_analytics_browser_internal.mdx index 50250c0c082ac..126fe56d7b5e1 100644 --- a/api_docs/kbn_core_analytics_browser_internal.mdx +++ b/api_docs/kbn_core_analytics_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-browser-internal title: "@kbn/core-analytics-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-analytics-browser-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-browser-internal'] --- import kbnCoreAnalyticsBrowserInternalObj from './kbn_core_analytics_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_analytics_browser_mocks.mdx b/api_docs/kbn_core_analytics_browser_mocks.mdx index 6f87d89ab7d18..596035b721295 100644 --- a/api_docs/kbn_core_analytics_browser_mocks.mdx +++ b/api_docs/kbn_core_analytics_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-browser-mocks title: "@kbn/core-analytics-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-analytics-browser-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-browser-mocks'] --- import kbnCoreAnalyticsBrowserMocksObj from './kbn_core_analytics_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_analytics_server.mdx b/api_docs/kbn_core_analytics_server.mdx index 92336f64a9a8b..bfe4ec54bbea5 100644 --- a/api_docs/kbn_core_analytics_server.mdx +++ b/api_docs/kbn_core_analytics_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-server title: "@kbn/core-analytics-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-analytics-server plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-server'] --- import kbnCoreAnalyticsServerObj from './kbn_core_analytics_server.devdocs.json'; diff --git a/api_docs/kbn_core_analytics_server_internal.mdx b/api_docs/kbn_core_analytics_server_internal.mdx index 2c847f6fe747f..15e5d0931a50f 100644 --- a/api_docs/kbn_core_analytics_server_internal.mdx +++ b/api_docs/kbn_core_analytics_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-server-internal title: "@kbn/core-analytics-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-analytics-server-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-server-internal'] --- import kbnCoreAnalyticsServerInternalObj from './kbn_core_analytics_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_analytics_server_mocks.mdx b/api_docs/kbn_core_analytics_server_mocks.mdx index cd24830e79c03..6f6716f58b3a6 100644 --- a/api_docs/kbn_core_analytics_server_mocks.mdx +++ b/api_docs/kbn_core_analytics_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-server-mocks title: "@kbn/core-analytics-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-analytics-server-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-server-mocks'] --- import kbnCoreAnalyticsServerMocksObj from './kbn_core_analytics_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_application_browser.mdx b/api_docs/kbn_core_application_browser.mdx index d02e04fa133c9..548ca2da02ded 100644 --- a/api_docs/kbn_core_application_browser.mdx +++ b/api_docs/kbn_core_application_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-application-browser title: "@kbn/core-application-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-application-browser plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-application-browser'] --- import kbnCoreApplicationBrowserObj from './kbn_core_application_browser.devdocs.json'; diff --git a/api_docs/kbn_core_application_browser_internal.mdx b/api_docs/kbn_core_application_browser_internal.mdx index 0aaeeda661da6..8d38aca61da13 100644 --- a/api_docs/kbn_core_application_browser_internal.mdx +++ b/api_docs/kbn_core_application_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-application-browser-internal title: "@kbn/core-application-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-application-browser-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-application-browser-internal'] --- import kbnCoreApplicationBrowserInternalObj from './kbn_core_application_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_application_browser_mocks.devdocs.json b/api_docs/kbn_core_application_browser_mocks.devdocs.json index be12beebfd75c..9f38ead6f5aa9 100644 --- a/api_docs/kbn_core_application_browser_mocks.devdocs.json +++ b/api_docs/kbn_core_application_browser_mocks.devdocs.json @@ -38,25 +38,25 @@ "section": "def-common.ScopedHistory", "text": "ScopedHistory" }, - ", [basePath: string]>; createHref: jest.MockInstance, [basePath: string], unknown>; createHref: jest.MockInstance, options?: { prependBasePath?: boolean | undefined; } | undefined]>; length: number; action: ", + ", options?: { prependBasePath?: boolean | undefined; } | undefined], unknown>; length: number; action: ", "Action", "; location: ", "Location", "; push: jest.MockInstance, state?: unknown]>; replace: jest.MockInstance, state?: unknown], unknown>; replace: jest.MockInstance, state?: unknown]>; go: jest.MockInstance; goBack: jest.MockInstance; goForward: jest.MockInstance; block: jest.MockInstance<", + ", state?: unknown], unknown>; go: jest.MockInstance; goBack: jest.MockInstance; goForward: jest.MockInstance; block: jest.MockInstance<", "UnregisterCallback", ", [prompt?: string | boolean | ", "TransitionPromptHook", - " | undefined]>; listen: jest.MockInstance<", + " | undefined], unknown>; listen: jest.MockInstance<", "UnregisterCallback", ", [listener: ", "LocationListener", - "]>; } & ", + "], unknown>; } & ", { "pluginId": "@kbn/core-application-browser", "scope": "common", diff --git a/api_docs/kbn_core_application_browser_mocks.mdx b/api_docs/kbn_core_application_browser_mocks.mdx index 20cb5788d863d..1d73eaa19753a 100644 --- a/api_docs/kbn_core_application_browser_mocks.mdx +++ b/api_docs/kbn_core_application_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-application-browser-mocks title: "@kbn/core-application-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-application-browser-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-application-browser-mocks'] --- import kbnCoreApplicationBrowserMocksObj from './kbn_core_application_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_application_common.mdx b/api_docs/kbn_core_application_common.mdx index d69dcf27afdb4..19465741f3e33 100644 --- a/api_docs/kbn_core_application_common.mdx +++ b/api_docs/kbn_core_application_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-application-common title: "@kbn/core-application-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-application-common plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-application-common'] --- import kbnCoreApplicationCommonObj from './kbn_core_application_common.devdocs.json'; diff --git a/api_docs/kbn_core_apps_browser_internal.mdx b/api_docs/kbn_core_apps_browser_internal.mdx index 75b470d49a335..d11d8208da661 100644 --- a/api_docs/kbn_core_apps_browser_internal.mdx +++ b/api_docs/kbn_core_apps_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-apps-browser-internal title: "@kbn/core-apps-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-apps-browser-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-apps-browser-internal'] --- import kbnCoreAppsBrowserInternalObj from './kbn_core_apps_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_apps_browser_mocks.mdx b/api_docs/kbn_core_apps_browser_mocks.mdx index 9b7f724e197e7..713fe5dff5baf 100644 --- a/api_docs/kbn_core_apps_browser_mocks.mdx +++ b/api_docs/kbn_core_apps_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-apps-browser-mocks title: "@kbn/core-apps-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-apps-browser-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-apps-browser-mocks'] --- import kbnCoreAppsBrowserMocksObj from './kbn_core_apps_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_apps_server_internal.mdx b/api_docs/kbn_core_apps_server_internal.mdx index 4260c6c974c8e..f7ae5b17a9cb9 100644 --- a/api_docs/kbn_core_apps_server_internal.mdx +++ b/api_docs/kbn_core_apps_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-apps-server-internal title: "@kbn/core-apps-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-apps-server-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-apps-server-internal'] --- import kbnCoreAppsServerInternalObj from './kbn_core_apps_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_base_browser_mocks.mdx b/api_docs/kbn_core_base_browser_mocks.mdx index 07703d075984c..87709d92a712c 100644 --- a/api_docs/kbn_core_base_browser_mocks.mdx +++ b/api_docs/kbn_core_base_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-browser-mocks title: "@kbn/core-base-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-base-browser-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-browser-mocks'] --- import kbnCoreBaseBrowserMocksObj from './kbn_core_base_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_base_common.mdx b/api_docs/kbn_core_base_common.mdx index f6b533e2eef39..b71852d927893 100644 --- a/api_docs/kbn_core_base_common.mdx +++ b/api_docs/kbn_core_base_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-common title: "@kbn/core-base-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-base-common plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-common'] --- import kbnCoreBaseCommonObj from './kbn_core_base_common.devdocs.json'; diff --git a/api_docs/kbn_core_base_server_internal.mdx b/api_docs/kbn_core_base_server_internal.mdx index f1b64c8e792fc..76cc99e93718e 100644 --- a/api_docs/kbn_core_base_server_internal.mdx +++ b/api_docs/kbn_core_base_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-server-internal title: "@kbn/core-base-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-base-server-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-server-internal'] --- import kbnCoreBaseServerInternalObj from './kbn_core_base_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_base_server_mocks.mdx b/api_docs/kbn_core_base_server_mocks.mdx index 11da7cb2dab13..1787197510cd5 100644 --- a/api_docs/kbn_core_base_server_mocks.mdx +++ b/api_docs/kbn_core_base_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-server-mocks title: "@kbn/core-base-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-base-server-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-server-mocks'] --- import kbnCoreBaseServerMocksObj from './kbn_core_base_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_capabilities_browser_mocks.mdx b/api_docs/kbn_core_capabilities_browser_mocks.mdx index 74d3338be9d8c..b89badc493d30 100644 --- a/api_docs/kbn_core_capabilities_browser_mocks.mdx +++ b/api_docs/kbn_core_capabilities_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-capabilities-browser-mocks title: "@kbn/core-capabilities-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-capabilities-browser-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-capabilities-browser-mocks'] --- import kbnCoreCapabilitiesBrowserMocksObj from './kbn_core_capabilities_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_capabilities_common.mdx b/api_docs/kbn_core_capabilities_common.mdx index d547d5b2b4096..2b6c9b13aac4f 100644 --- a/api_docs/kbn_core_capabilities_common.mdx +++ b/api_docs/kbn_core_capabilities_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-capabilities-common title: "@kbn/core-capabilities-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-capabilities-common plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-capabilities-common'] --- import kbnCoreCapabilitiesCommonObj from './kbn_core_capabilities_common.devdocs.json'; diff --git a/api_docs/kbn_core_capabilities_server.mdx b/api_docs/kbn_core_capabilities_server.mdx index 89cbbf7641566..882b8e92b3318 100644 --- a/api_docs/kbn_core_capabilities_server.mdx +++ b/api_docs/kbn_core_capabilities_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-capabilities-server title: "@kbn/core-capabilities-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-capabilities-server plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-capabilities-server'] --- import kbnCoreCapabilitiesServerObj from './kbn_core_capabilities_server.devdocs.json'; diff --git a/api_docs/kbn_core_capabilities_server_mocks.mdx b/api_docs/kbn_core_capabilities_server_mocks.mdx index 816606360771e..563dfe4bee36a 100644 --- a/api_docs/kbn_core_capabilities_server_mocks.mdx +++ b/api_docs/kbn_core_capabilities_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-capabilities-server-mocks title: "@kbn/core-capabilities-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-capabilities-server-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-capabilities-server-mocks'] --- import kbnCoreCapabilitiesServerMocksObj from './kbn_core_capabilities_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_chrome_browser.devdocs.json b/api_docs/kbn_core_chrome_browser.devdocs.json index 125aa8582db52..cdfc29910c83d 100644 --- a/api_docs/kbn_core_chrome_browser.devdocs.json +++ b/api_docs/kbn_core_chrome_browser.devdocs.json @@ -1620,32 +1620,12 @@ "\nOptional function to get the active state. This function is called whenever the location changes." ], "signature": [ - "((location: ", - "Location", - ") => boolean) | undefined" + "GetIsActiveFn", + " | undefined" ], "path": "packages/core/chrome/core-chrome-browser/src/project_navigation.ts", "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/core-chrome-browser", - "id": "def-common.ChromeProjectNavigationNode.getIsActive.$1", - "type": "Object", - "tags": [], - "label": "location", - "description": [], - "signature": [ - "Location", - "" - ], - "path": "packages/core/chrome/core-chrome-browser/src/project_navigation.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] + "trackAdoption": false }, { "parentPluginId": "@kbn/core-chrome-browser", @@ -2875,6 +2855,29 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "@kbn/core-chrome-browser", + "id": "def-common.NodeDefinition.cloudLink", + "type": "CompoundType", + "tags": [], + "label": "cloudLink", + "description": [ + "Cloud link id" + ], + "signature": [ + { + "pluginId": "@kbn/core-chrome-browser", + "scope": "common", + "docId": "kibKbnCoreChromeBrowserPluginApi", + "section": "def-common.CloudLinkId", + "text": "CloudLinkId" + }, + " | undefined" + ], + "path": "packages/core/chrome/core-chrome-browser/src/project_navigation.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "@kbn/core-chrome-browser", "id": "def-common.NodeDefinition.icon", @@ -2941,32 +2944,12 @@ "\nOptional function to get the active state. This function is called whenever the location changes." ], "signature": [ - "((location: ", - "Location", - ") => boolean) | undefined" + "GetIsActiveFn", + " | undefined" ], "path": "packages/core/chrome/core-chrome-browser/src/project_navigation.ts", "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/core-chrome-browser", - "id": "def-common.NodeDefinition.getIsActive.$1", - "type": "Object", - "tags": [], - "label": "location", - "description": [], - "signature": [ - "Location", - "" - ], - "path": "packages/core/chrome/core-chrome-browser/src/project_navigation.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] + "trackAdoption": false }, { "parentPluginId": "@kbn/core-chrome-browser", @@ -3237,6 +3220,21 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "@kbn/core-chrome-browser", + "id": "def-common.CloudLinkId", + "type": "Type", + "tags": [], + "label": "CloudLinkId", + "description": [], + "signature": [ + "\"userAndRoles\" | \"performance\" | \"billingAndSub\"" + ], + "path": "packages/core/chrome/core-chrome-browser/src/project_navigation.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "@kbn/core-chrome-browser", "id": "def-common.NodeDefinitionWithChildren", diff --git a/api_docs/kbn_core_chrome_browser.mdx b/api_docs/kbn_core_chrome_browser.mdx index 6c92c2a164684..2065ec0eb3048 100644 --- a/api_docs/kbn_core_chrome_browser.mdx +++ b/api_docs/kbn_core_chrome_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-chrome-browser title: "@kbn/core-chrome-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-chrome-browser plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-chrome-browser'] --- import kbnCoreChromeBrowserObj from './kbn_core_chrome_browser.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sh | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 166 | 0 | 67 | 0 | +| 166 | 0 | 66 | 1 | ## Common diff --git a/api_docs/kbn_core_chrome_browser_mocks.mdx b/api_docs/kbn_core_chrome_browser_mocks.mdx index 44779d3375ccc..e35cda709960b 100644 --- a/api_docs/kbn_core_chrome_browser_mocks.mdx +++ b/api_docs/kbn_core_chrome_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-chrome-browser-mocks title: "@kbn/core-chrome-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-chrome-browser-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-chrome-browser-mocks'] --- import kbnCoreChromeBrowserMocksObj from './kbn_core_chrome_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_config_server_internal.mdx b/api_docs/kbn_core_config_server_internal.mdx index 8cadef61b790d..afa64a1ddd80c 100644 --- a/api_docs/kbn_core_config_server_internal.mdx +++ b/api_docs/kbn_core_config_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-config-server-internal title: "@kbn/core-config-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-config-server-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-config-server-internal'] --- import kbnCoreConfigServerInternalObj from './kbn_core_config_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_custom_branding_browser.mdx b/api_docs/kbn_core_custom_branding_browser.mdx index 2850149229722..472a13dc0c5bb 100644 --- a/api_docs/kbn_core_custom_branding_browser.mdx +++ b/api_docs/kbn_core_custom_branding_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-custom-branding-browser title: "@kbn/core-custom-branding-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-custom-branding-browser plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-custom-branding-browser'] --- import kbnCoreCustomBrandingBrowserObj from './kbn_core_custom_branding_browser.devdocs.json'; diff --git a/api_docs/kbn_core_custom_branding_browser_internal.mdx b/api_docs/kbn_core_custom_branding_browser_internal.mdx index aa8fba73ae214..2ba6d0ba90bbf 100644 --- a/api_docs/kbn_core_custom_branding_browser_internal.mdx +++ b/api_docs/kbn_core_custom_branding_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-custom-branding-browser-internal title: "@kbn/core-custom-branding-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-custom-branding-browser-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-custom-branding-browser-internal'] --- import kbnCoreCustomBrandingBrowserInternalObj from './kbn_core_custom_branding_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_custom_branding_browser_mocks.mdx b/api_docs/kbn_core_custom_branding_browser_mocks.mdx index c5e555af955cf..b67b76f3191cc 100644 --- a/api_docs/kbn_core_custom_branding_browser_mocks.mdx +++ b/api_docs/kbn_core_custom_branding_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-custom-branding-browser-mocks title: "@kbn/core-custom-branding-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-custom-branding-browser-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-custom-branding-browser-mocks'] --- import kbnCoreCustomBrandingBrowserMocksObj from './kbn_core_custom_branding_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_custom_branding_common.mdx b/api_docs/kbn_core_custom_branding_common.mdx index 31520988ae26c..f14d285e098a4 100644 --- a/api_docs/kbn_core_custom_branding_common.mdx +++ b/api_docs/kbn_core_custom_branding_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-custom-branding-common title: "@kbn/core-custom-branding-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-custom-branding-common plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-custom-branding-common'] --- import kbnCoreCustomBrandingCommonObj from './kbn_core_custom_branding_common.devdocs.json'; diff --git a/api_docs/kbn_core_custom_branding_server.mdx b/api_docs/kbn_core_custom_branding_server.mdx index 6938d95c58330..b8a1ffd050563 100644 --- a/api_docs/kbn_core_custom_branding_server.mdx +++ b/api_docs/kbn_core_custom_branding_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-custom-branding-server title: "@kbn/core-custom-branding-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-custom-branding-server plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-custom-branding-server'] --- import kbnCoreCustomBrandingServerObj from './kbn_core_custom_branding_server.devdocs.json'; diff --git a/api_docs/kbn_core_custom_branding_server_internal.mdx b/api_docs/kbn_core_custom_branding_server_internal.mdx index 19f86b54f69b6..fee70301ae0d8 100644 --- a/api_docs/kbn_core_custom_branding_server_internal.mdx +++ b/api_docs/kbn_core_custom_branding_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-custom-branding-server-internal title: "@kbn/core-custom-branding-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-custom-branding-server-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-custom-branding-server-internal'] --- import kbnCoreCustomBrandingServerInternalObj from './kbn_core_custom_branding_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_custom_branding_server_mocks.devdocs.json b/api_docs/kbn_core_custom_branding_server_mocks.devdocs.json index a0dcf7cd134cf..3ce2c8571b4da 100644 --- a/api_docs/kbn_core_custom_branding_server_mocks.devdocs.json +++ b/api_docs/kbn_core_custom_branding_server_mocks.devdocs.json @@ -66,7 +66,7 @@ "label": "createSetupContract", "description": [], "signature": [ - "() => { register: jest.Mock; getBrandingFor: jest.Mock; }" + "() => { register: jest.Mock; getBrandingFor: jest.Mock; }" ], "path": "packages/core/custom-branding/core-custom-branding-server-mocks/src/custom_branding_service.mock.ts", "deprecated": false, diff --git a/api_docs/kbn_core_custom_branding_server_mocks.mdx b/api_docs/kbn_core_custom_branding_server_mocks.mdx index 29fc1342f239d..d5a8ce9aef735 100644 --- a/api_docs/kbn_core_custom_branding_server_mocks.mdx +++ b/api_docs/kbn_core_custom_branding_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-custom-branding-server-mocks title: "@kbn/core-custom-branding-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-custom-branding-server-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-custom-branding-server-mocks'] --- import kbnCoreCustomBrandingServerMocksObj from './kbn_core_custom_branding_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_deprecations_browser.mdx b/api_docs/kbn_core_deprecations_browser.mdx index 967f1860d3bdd..b113611afc66e 100644 --- a/api_docs/kbn_core_deprecations_browser.mdx +++ b/api_docs/kbn_core_deprecations_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-browser title: "@kbn/core-deprecations-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-deprecations-browser plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-deprecations-browser'] --- import kbnCoreDeprecationsBrowserObj from './kbn_core_deprecations_browser.devdocs.json'; diff --git a/api_docs/kbn_core_deprecations_browser_internal.mdx b/api_docs/kbn_core_deprecations_browser_internal.mdx index 2e0e4e0f10f03..b1a3bdc97ce54 100644 --- a/api_docs/kbn_core_deprecations_browser_internal.mdx +++ b/api_docs/kbn_core_deprecations_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-browser-internal title: "@kbn/core-deprecations-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-deprecations-browser-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-deprecations-browser-internal'] --- import kbnCoreDeprecationsBrowserInternalObj from './kbn_core_deprecations_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_deprecations_browser_mocks.mdx b/api_docs/kbn_core_deprecations_browser_mocks.mdx index 78afd614e82fe..f13a377929e89 100644 --- a/api_docs/kbn_core_deprecations_browser_mocks.mdx +++ b/api_docs/kbn_core_deprecations_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-browser-mocks title: "@kbn/core-deprecations-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-deprecations-browser-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-deprecations-browser-mocks'] --- import kbnCoreDeprecationsBrowserMocksObj from './kbn_core_deprecations_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_deprecations_common.mdx b/api_docs/kbn_core_deprecations_common.mdx index 4cd3e1b19f738..0ec3c736eee2b 100644 --- a/api_docs/kbn_core_deprecations_common.mdx +++ b/api_docs/kbn_core_deprecations_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-common title: "@kbn/core-deprecations-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-deprecations-common plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-deprecations-common'] --- import kbnCoreDeprecationsCommonObj from './kbn_core_deprecations_common.devdocs.json'; diff --git a/api_docs/kbn_core_deprecations_server.mdx b/api_docs/kbn_core_deprecations_server.mdx index 209597139058c..a65f389081966 100644 --- a/api_docs/kbn_core_deprecations_server.mdx +++ b/api_docs/kbn_core_deprecations_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-server title: "@kbn/core-deprecations-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-deprecations-server plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-deprecations-server'] --- import kbnCoreDeprecationsServerObj from './kbn_core_deprecations_server.devdocs.json'; diff --git a/api_docs/kbn_core_deprecations_server_internal.mdx b/api_docs/kbn_core_deprecations_server_internal.mdx index ff0d8c4a668f2..c42c7379cbb65 100644 --- a/api_docs/kbn_core_deprecations_server_internal.mdx +++ b/api_docs/kbn_core_deprecations_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-server-internal title: "@kbn/core-deprecations-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-deprecations-server-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-deprecations-server-internal'] --- import kbnCoreDeprecationsServerInternalObj from './kbn_core_deprecations_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_deprecations_server_mocks.mdx b/api_docs/kbn_core_deprecations_server_mocks.mdx index aa7d63ff68aa6..8b8a244e0dc3c 100644 --- a/api_docs/kbn_core_deprecations_server_mocks.mdx +++ b/api_docs/kbn_core_deprecations_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-server-mocks title: "@kbn/core-deprecations-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-deprecations-server-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-deprecations-server-mocks'] --- import kbnCoreDeprecationsServerMocksObj from './kbn_core_deprecations_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_doc_links_browser.mdx b/api_docs/kbn_core_doc_links_browser.mdx index 3b23da0ad24f8..cd7a9104fd788 100644 --- a/api_docs/kbn_core_doc_links_browser.mdx +++ b/api_docs/kbn_core_doc_links_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-browser title: "@kbn/core-doc-links-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-doc-links-browser plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-browser'] --- import kbnCoreDocLinksBrowserObj from './kbn_core_doc_links_browser.devdocs.json'; diff --git a/api_docs/kbn_core_doc_links_browser_mocks.devdocs.json b/api_docs/kbn_core_doc_links_browser_mocks.devdocs.json index cb8eebb761298..d49117767da15 100644 --- a/api_docs/kbn_core_doc_links_browser_mocks.devdocs.json +++ b/api_docs/kbn_core_doc_links_browser_mocks.devdocs.json @@ -58,7 +58,7 @@ "label": "createSetupContract", "description": [], "signature": [ - "() => jest.Mock" + "() => jest.Mock" ], "path": "packages/core/doc-links/core-doc-links-browser-mocks/src/doc_links_service.mock.ts", "deprecated": false, diff --git a/api_docs/kbn_core_doc_links_browser_mocks.mdx b/api_docs/kbn_core_doc_links_browser_mocks.mdx index a01948504beaa..13591d7daa79c 100644 --- a/api_docs/kbn_core_doc_links_browser_mocks.mdx +++ b/api_docs/kbn_core_doc_links_browser_mocks.mdx @@ -8,7 +8,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 description: API docs for the @kbn/core-doc-links-browser-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-browser-mocks'] --- import kbnCoreDocLinksBrowserMocksObj from './kbn_core_doc_links_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_doc_links_server.mdx b/api_docs/kbn_core_doc_links_server.mdx index 25d170c7d20ef..a368c66633478 100644 --- a/api_docs/kbn_core_doc_links_server.mdx +++ b/api_docs/kbn_core_doc_links_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-server title: "@kbn/core-doc-links-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-doc-links-server plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-server'] --- import kbnCoreDocLinksServerObj from './kbn_core_doc_links_server.devdocs.json'; diff --git a/api_docs/kbn_core_doc_links_server_mocks.mdx b/api_docs/kbn_core_doc_links_server_mocks.mdx index f76a7596fd664..772f255b544b1 100644 --- a/api_docs/kbn_core_doc_links_server_mocks.mdx +++ b/api_docs/kbn_core_doc_links_server_mocks.mdx @@ -8,7 +8,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 description: API docs for the @kbn/core-doc-links-server-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-server-mocks'] --- import kbnCoreDocLinksServerMocksObj from './kbn_core_doc_links_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_elasticsearch_client_server_internal.mdx b/api_docs/kbn_core_elasticsearch_client_server_internal.mdx index c5e360c68faca..f305b8f77c78c 100644 --- a/api_docs/kbn_core_elasticsearch_client_server_internal.mdx +++ b/api_docs/kbn_core_elasticsearch_client_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-elasticsearch-client-server-internal title: "@kbn/core-elasticsearch-client-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-elasticsearch-client-server-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-elasticsearch-client-server-internal'] --- import kbnCoreElasticsearchClientServerInternalObj from './kbn_core_elasticsearch_client_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_elasticsearch_client_server_mocks.devdocs.json b/api_docs/kbn_core_elasticsearch_client_server_mocks.devdocs.json index 5d5398da21156..7ad9ebdcc1c7f 100644 --- a/api_docs/kbn_core_elasticsearch_client_server_mocks.devdocs.json +++ b/api_docs/kbn_core_elasticsearch_client_server_mocks.devdocs.json @@ -61,7 +61,7 @@ "section": "def-common.ClientApiMockInstance", "text": "ClientApiMockInstance" }, - " extends jest.MockInstance" + " extends jest.MockInstance" ], "path": "packages/core/elasticsearch/core-elasticsearch-client-server-mocks/src/mocks.ts", "deprecated": false, @@ -1366,7 +1366,7 @@ "section": "def-common.ScopedClusterClientMock", "text": "ScopedClusterClientMock" }, - ", []> & (() => ", + ", [], unknown> & (() => ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", "scope": "common", @@ -3584,7 +3584,7 @@ "label": "CustomClusterClientMock", "description": [], "signature": [ - "{ close: jest.MockInstance, []>; readonly asInternalUser: ", + "{ close: jest.MockInstance, [], unknown>; readonly asInternalUser: ", { "pluginId": "@kbn/core-elasticsearch-server", "scope": "common", @@ -3608,7 +3608,7 @@ "section": "def-common.ScopeableRequest", "text": "ScopeableRequest" }, - "]>; } & ", + "], unknown>; } & ", { "pluginId": "@kbn/core-elasticsearch-server", "scope": "common", diff --git a/api_docs/kbn_core_elasticsearch_client_server_mocks.mdx b/api_docs/kbn_core_elasticsearch_client_server_mocks.mdx index 1cec70fc49ab5..14ad08f3aa793 100644 --- a/api_docs/kbn_core_elasticsearch_client_server_mocks.mdx +++ b/api_docs/kbn_core_elasticsearch_client_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-elasticsearch-client-server-mocks title: "@kbn/core-elasticsearch-client-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-elasticsearch-client-server-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-elasticsearch-client-server-mocks'] --- import kbnCoreElasticsearchClientServerMocksObj from './kbn_core_elasticsearch_client_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_elasticsearch_server.mdx b/api_docs/kbn_core_elasticsearch_server.mdx index 3ac4ccbab444e..ba8e059c34f3c 100644 --- a/api_docs/kbn_core_elasticsearch_server.mdx +++ b/api_docs/kbn_core_elasticsearch_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-elasticsearch-server title: "@kbn/core-elasticsearch-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-elasticsearch-server plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-elasticsearch-server'] --- import kbnCoreElasticsearchServerObj from './kbn_core_elasticsearch_server.devdocs.json'; diff --git a/api_docs/kbn_core_elasticsearch_server_internal.mdx b/api_docs/kbn_core_elasticsearch_server_internal.mdx index 24ac35dca54af..c5d96f1783120 100644 --- a/api_docs/kbn_core_elasticsearch_server_internal.mdx +++ b/api_docs/kbn_core_elasticsearch_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-elasticsearch-server-internal title: "@kbn/core-elasticsearch-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-elasticsearch-server-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-elasticsearch-server-internal'] --- import kbnCoreElasticsearchServerInternalObj from './kbn_core_elasticsearch_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_elasticsearch_server_mocks.devdocs.json b/api_docs/kbn_core_elasticsearch_server_mocks.devdocs.json index 787e518bcf5f8..ce0361d169a13 100644 --- a/api_docs/kbn_core_elasticsearch_server_mocks.devdocs.json +++ b/api_docs/kbn_core_elasticsearch_server_mocks.devdocs.json @@ -75,7 +75,7 @@ "section": "def-common.ElasticsearchClientConfig", "text": "ElasticsearchClientConfig" }, - "> | undefined]> & ((type: string, config?: Partial<", + "> | undefined], unknown> & ((type: string, config?: Partial<", { "pluginId": "@kbn/core-elasticsearch-server", "scope": "common", @@ -155,7 +155,7 @@ "section": "def-common.UnauthorizedErrorHandler", "text": "UnauthorizedErrorHandler" }, - "]>; } & Omit<", + "], unknown>; } & Omit<", { "pluginId": "@kbn/core-elasticsearch-server", "scope": "common", diff --git a/api_docs/kbn_core_elasticsearch_server_mocks.mdx b/api_docs/kbn_core_elasticsearch_server_mocks.mdx index 47b92383acd3c..9b707ad7ecfe5 100644 --- a/api_docs/kbn_core_elasticsearch_server_mocks.mdx +++ b/api_docs/kbn_core_elasticsearch_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-elasticsearch-server-mocks title: "@kbn/core-elasticsearch-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-elasticsearch-server-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-elasticsearch-server-mocks'] --- import kbnCoreElasticsearchServerMocksObj from './kbn_core_elasticsearch_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_environment_server_internal.mdx b/api_docs/kbn_core_environment_server_internal.mdx index b3d29d65cdf9b..199dcc71891d5 100644 --- a/api_docs/kbn_core_environment_server_internal.mdx +++ b/api_docs/kbn_core_environment_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-environment-server-internal title: "@kbn/core-environment-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-environment-server-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-environment-server-internal'] --- import kbnCoreEnvironmentServerInternalObj from './kbn_core_environment_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_environment_server_mocks.mdx b/api_docs/kbn_core_environment_server_mocks.mdx index d5d2e0bea2fbb..9ca28326d595b 100644 --- a/api_docs/kbn_core_environment_server_mocks.mdx +++ b/api_docs/kbn_core_environment_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-environment-server-mocks title: "@kbn/core-environment-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-environment-server-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-environment-server-mocks'] --- import kbnCoreEnvironmentServerMocksObj from './kbn_core_environment_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_execution_context_browser.mdx b/api_docs/kbn_core_execution_context_browser.mdx index da01635129551..5fda49a71cb71 100644 --- a/api_docs/kbn_core_execution_context_browser.mdx +++ b/api_docs/kbn_core_execution_context_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-browser title: "@kbn/core-execution-context-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-execution-context-browser plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-browser'] --- import kbnCoreExecutionContextBrowserObj from './kbn_core_execution_context_browser.devdocs.json'; diff --git a/api_docs/kbn_core_execution_context_browser_internal.mdx b/api_docs/kbn_core_execution_context_browser_internal.mdx index cbc07a2cee616..702d9551abcab 100644 --- a/api_docs/kbn_core_execution_context_browser_internal.mdx +++ b/api_docs/kbn_core_execution_context_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-browser-internal title: "@kbn/core-execution-context-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-execution-context-browser-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-browser-internal'] --- import kbnCoreExecutionContextBrowserInternalObj from './kbn_core_execution_context_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_execution_context_browser_mocks.mdx b/api_docs/kbn_core_execution_context_browser_mocks.mdx index 76d388fed0e4b..592bc49c00498 100644 --- a/api_docs/kbn_core_execution_context_browser_mocks.mdx +++ b/api_docs/kbn_core_execution_context_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-browser-mocks title: "@kbn/core-execution-context-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-execution-context-browser-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-browser-mocks'] --- import kbnCoreExecutionContextBrowserMocksObj from './kbn_core_execution_context_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_execution_context_common.mdx b/api_docs/kbn_core_execution_context_common.mdx index c31e8c64cb02a..1c00a2a6e9bbf 100644 --- a/api_docs/kbn_core_execution_context_common.mdx +++ b/api_docs/kbn_core_execution_context_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-common title: "@kbn/core-execution-context-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-execution-context-common plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-common'] --- import kbnCoreExecutionContextCommonObj from './kbn_core_execution_context_common.devdocs.json'; diff --git a/api_docs/kbn_core_execution_context_server.mdx b/api_docs/kbn_core_execution_context_server.mdx index 0adc8ebfe00d5..c35f5af9a2100 100644 --- a/api_docs/kbn_core_execution_context_server.mdx +++ b/api_docs/kbn_core_execution_context_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-server title: "@kbn/core-execution-context-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-execution-context-server plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-server'] --- import kbnCoreExecutionContextServerObj from './kbn_core_execution_context_server.devdocs.json'; diff --git a/api_docs/kbn_core_execution_context_server_internal.mdx b/api_docs/kbn_core_execution_context_server_internal.mdx index babca9b4374b5..15d9aca5bf8ca 100644 --- a/api_docs/kbn_core_execution_context_server_internal.mdx +++ b/api_docs/kbn_core_execution_context_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-server-internal title: "@kbn/core-execution-context-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-execution-context-server-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-server-internal'] --- import kbnCoreExecutionContextServerInternalObj from './kbn_core_execution_context_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_execution_context_server_mocks.mdx b/api_docs/kbn_core_execution_context_server_mocks.mdx index 29532576b39fb..a5510bd8325b4 100644 --- a/api_docs/kbn_core_execution_context_server_mocks.mdx +++ b/api_docs/kbn_core_execution_context_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-server-mocks title: "@kbn/core-execution-context-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-execution-context-server-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-server-mocks'] --- import kbnCoreExecutionContextServerMocksObj from './kbn_core_execution_context_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_fatal_errors_browser.mdx b/api_docs/kbn_core_fatal_errors_browser.mdx index c241df41f3e97..ccd3632f7aa4f 100644 --- a/api_docs/kbn_core_fatal_errors_browser.mdx +++ b/api_docs/kbn_core_fatal_errors_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-fatal-errors-browser title: "@kbn/core-fatal-errors-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-fatal-errors-browser plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-fatal-errors-browser'] --- import kbnCoreFatalErrorsBrowserObj from './kbn_core_fatal_errors_browser.devdocs.json'; diff --git a/api_docs/kbn_core_fatal_errors_browser_mocks.mdx b/api_docs/kbn_core_fatal_errors_browser_mocks.mdx index 8c2c1f74b9e9e..cb7bcaa668573 100644 --- a/api_docs/kbn_core_fatal_errors_browser_mocks.mdx +++ b/api_docs/kbn_core_fatal_errors_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-fatal-errors-browser-mocks title: "@kbn/core-fatal-errors-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-fatal-errors-browser-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-fatal-errors-browser-mocks'] --- import kbnCoreFatalErrorsBrowserMocksObj from './kbn_core_fatal_errors_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_http_browser.mdx b/api_docs/kbn_core_http_browser.mdx index b10b9dc6b10fb..87d5e4d765893 100644 --- a/api_docs/kbn_core_http_browser.mdx +++ b/api_docs/kbn_core_http_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-browser title: "@kbn/core-http-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-browser plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-browser'] --- import kbnCoreHttpBrowserObj from './kbn_core_http_browser.devdocs.json'; diff --git a/api_docs/kbn_core_http_browser_internal.mdx b/api_docs/kbn_core_http_browser_internal.mdx index edf4d89eac14a..6f66c586c708d 100644 --- a/api_docs/kbn_core_http_browser_internal.mdx +++ b/api_docs/kbn_core_http_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-browser-internal title: "@kbn/core-http-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-browser-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-browser-internal'] --- import kbnCoreHttpBrowserInternalObj from './kbn_core_http_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_http_browser_mocks.devdocs.json b/api_docs/kbn_core_http_browser_mocks.devdocs.json index 99f58c97afc9c..39526d744321e 100644 --- a/api_docs/kbn_core_http_browser_mocks.devdocs.json +++ b/api_docs/kbn_core_http_browser_mocks.devdocs.json @@ -164,7 +164,7 @@ "section": "def-common.HttpInterceptor", "text": "HttpInterceptor" }, - "]>; fetch: jest.MockInstance, [options: ", + "], unknown>; fetch: jest.MockInstance, [options: ", { "pluginId": "@kbn/core-http-browser", "scope": "common", @@ -172,7 +172,7 @@ "section": "def-common.HttpFetchOptionsWithPath", "text": "HttpFetchOptionsWithPath" }, - "]>; delete: jest.MockInstance, [options: ", + "], unknown>; delete: jest.MockInstance, [options: ", { "pluginId": "@kbn/core-http-browser", "scope": "common", @@ -180,7 +180,7 @@ "section": "def-common.HttpFetchOptionsWithPath", "text": "HttpFetchOptionsWithPath" }, - "]>; get: jest.MockInstance, [options: ", + "], unknown>; get: jest.MockInstance, [options: ", { "pluginId": "@kbn/core-http-browser", "scope": "common", @@ -188,7 +188,7 @@ "section": "def-common.HttpFetchOptionsWithPath", "text": "HttpFetchOptionsWithPath" }, - "]>; head: jest.MockInstance, [options: ", + "], unknown>; head: jest.MockInstance, [options: ", { "pluginId": "@kbn/core-http-browser", "scope": "common", @@ -196,7 +196,7 @@ "section": "def-common.HttpFetchOptionsWithPath", "text": "HttpFetchOptionsWithPath" }, - "]>; options: jest.MockInstance, [options: ", + "], unknown>; options: jest.MockInstance, [options: ", { "pluginId": "@kbn/core-http-browser", "scope": "common", @@ -204,7 +204,7 @@ "section": "def-common.HttpFetchOptionsWithPath", "text": "HttpFetchOptionsWithPath" }, - "]>; patch: jest.MockInstance, [options: ", + "], unknown>; patch: jest.MockInstance, [options: ", { "pluginId": "@kbn/core-http-browser", "scope": "common", @@ -212,7 +212,7 @@ "section": "def-common.HttpFetchOptionsWithPath", "text": "HttpFetchOptionsWithPath" }, - "]>; post: jest.MockInstance, [options: ", + "], unknown>; post: jest.MockInstance, [options: ", { "pluginId": "@kbn/core-http-browser", "scope": "common", @@ -220,7 +220,7 @@ "section": "def-common.HttpFetchOptionsWithPath", "text": "HttpFetchOptionsWithPath" }, - "]>; put: jest.MockInstance, [options: ", + "], unknown>; put: jest.MockInstance, [options: ", { "pluginId": "@kbn/core-http-browser", "scope": "common", @@ -228,11 +228,11 @@ "section": "def-common.HttpFetchOptionsWithPath", "text": "HttpFetchOptionsWithPath" }, - "]>; addLoadingCountSource: jest.MockInstance; addLoadingCountSource: jest.MockInstance]>; getLoadingCount$: jest.MockInstance<", + "], unknown>; getLoadingCount$: jest.MockInstance<", "Observable", - ", []>; } & ", + ", [], unknown>; } & ", { "pluginId": "@kbn/core-http-browser", "scope": "common", diff --git a/api_docs/kbn_core_http_browser_mocks.mdx b/api_docs/kbn_core_http_browser_mocks.mdx index a1154770e00e1..09d90df34c740 100644 --- a/api_docs/kbn_core_http_browser_mocks.mdx +++ b/api_docs/kbn_core_http_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-browser-mocks title: "@kbn/core-http-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-browser-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-browser-mocks'] --- import kbnCoreHttpBrowserMocksObj from './kbn_core_http_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_http_common.mdx b/api_docs/kbn_core_http_common.mdx index 6073146d38323..728eab7ae47b9 100644 --- a/api_docs/kbn_core_http_common.mdx +++ b/api_docs/kbn_core_http_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-common title: "@kbn/core-http-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-common plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-common'] --- import kbnCoreHttpCommonObj from './kbn_core_http_common.devdocs.json'; diff --git a/api_docs/kbn_core_http_context_server_mocks.devdocs.json b/api_docs/kbn_core_http_context_server_mocks.devdocs.json index 547559b7e5ce0..fe319a53cb570 100644 --- a/api_docs/kbn_core_http_context_server_mocks.devdocs.json +++ b/api_docs/kbn_core_http_context_server_mocks.devdocs.json @@ -54,7 +54,7 @@ "section": "def-common.RequestHandlerContextBase", "text": "RequestHandlerContextBase" }, - ", \"resolve\">]>; createHandler: jest.MockInstance<(request: ", + ", \"resolve\">], unknown>; createHandler: jest.MockInstance<(request: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -102,7 +102,7 @@ "section": "def-common.KibanaResponseFactory", "text": "KibanaResponseFactory" }, - ">]>; } & ", + ">], unknown>; } & ", { "pluginId": "@kbn/core-http-server", "scope": "common", diff --git a/api_docs/kbn_core_http_context_server_mocks.mdx b/api_docs/kbn_core_http_context_server_mocks.mdx index 2976a7d7e17aa..875c84daba792 100644 --- a/api_docs/kbn_core_http_context_server_mocks.mdx +++ b/api_docs/kbn_core_http_context_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-context-server-mocks title: "@kbn/core-http-context-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-context-server-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-context-server-mocks'] --- import kbnCoreHttpContextServerMocksObj from './kbn_core_http_context_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_http_request_handler_context_server.mdx b/api_docs/kbn_core_http_request_handler_context_server.mdx index db999bfae8965..43c76c0e14350 100644 --- a/api_docs/kbn_core_http_request_handler_context_server.mdx +++ b/api_docs/kbn_core_http_request_handler_context_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-request-handler-context-server title: "@kbn/core-http-request-handler-context-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-request-handler-context-server plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-request-handler-context-server'] --- import kbnCoreHttpRequestHandlerContextServerObj from './kbn_core_http_request_handler_context_server.devdocs.json'; diff --git a/api_docs/kbn_core_http_resources_server.mdx b/api_docs/kbn_core_http_resources_server.mdx index f2095d830f97f..8c1593a191f6b 100644 --- a/api_docs/kbn_core_http_resources_server.mdx +++ b/api_docs/kbn_core_http_resources_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-resources-server title: "@kbn/core-http-resources-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-resources-server plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-resources-server'] --- import kbnCoreHttpResourcesServerObj from './kbn_core_http_resources_server.devdocs.json'; diff --git a/api_docs/kbn_core_http_resources_server_internal.mdx b/api_docs/kbn_core_http_resources_server_internal.mdx index 94faccd55fa77..725ca85fe4b85 100644 --- a/api_docs/kbn_core_http_resources_server_internal.mdx +++ b/api_docs/kbn_core_http_resources_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-resources-server-internal title: "@kbn/core-http-resources-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-resources-server-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-resources-server-internal'] --- import kbnCoreHttpResourcesServerInternalObj from './kbn_core_http_resources_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_http_resources_server_mocks.devdocs.json b/api_docs/kbn_core_http_resources_server_mocks.devdocs.json index 0ce3d88b19cbf..5af3c308b95e5 100644 --- a/api_docs/kbn_core_http_resources_server_mocks.devdocs.json +++ b/api_docs/kbn_core_http_resources_server_mocks.devdocs.json @@ -30,7 +30,7 @@ "label": "HttpResourcesMock", "description": [], "signature": [ - "{ start: jest.MockInstance; setup: jest.MockInstance<{ createRegistrar: (router: ", + "{ start: jest.MockInstance; setup: jest.MockInstance<{ createRegistrar: (router: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -56,7 +56,7 @@ }, "; }, [deps: ", "SetupDeps", - "]>; stop: jest.MockInstance; preboot: jest.MockInstance<{ createRegistrar: (router: ", + "], unknown>; stop: jest.MockInstance; preboot: jest.MockInstance<{ createRegistrar: (router: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -82,7 +82,7 @@ }, "; }, [deps: ", "PrebootDeps", - "]>; } & ", + "], unknown>; } & ", { "pluginId": "@kbn/utility-types", "scope": "common", @@ -181,7 +181,7 @@ "section": "def-common.HttpResources", "text": "HttpResources" }, - ">, []>; }" + ">, [], any>; }" ], "path": "packages/core/http/core-http-resources-server-mocks/src/http_resources_server.mock.ts", "deprecated": false, @@ -205,7 +205,7 @@ "section": "def-common.HttpResources", "text": "HttpResources" }, - ">, []>; }" + ">, [], any>; }" ], "path": "packages/core/http/core-http-resources-server-mocks/src/http_resources_server.mock.ts", "deprecated": false, @@ -237,7 +237,7 @@ "section": "def-common.HttpResourcesRenderOptions", "text": "HttpResourcesRenderOptions" }, - " | undefined]> & ((options?: ", + " | undefined], unknown> & ((options?: ", { "pluginId": "@kbn/core-http-resources-server", "scope": "common", @@ -269,7 +269,7 @@ "section": "def-common.HttpResourcesRenderOptions", "text": "HttpResourcesRenderOptions" }, - " | undefined]> & ((options?: ", + " | undefined], unknown> & ((options?: ", { "pluginId": "@kbn/core-http-resources-server", "scope": "common", @@ -301,7 +301,7 @@ "section": "def-common.HttpResourcesResponseOptions", "text": "HttpResourcesResponseOptions" }, - "]> & ((options: ", + "], unknown> & ((options: ", { "pluginId": "@kbn/core-http-resources-server", "scope": "common", @@ -333,7 +333,7 @@ "section": "def-common.HttpResourcesResponseOptions", "text": "HttpResourcesResponseOptions" }, - "]> & ((options: ", + "], unknown> & ((options: ", { "pluginId": "@kbn/core-http-resources-server", "scope": "common", @@ -365,7 +365,7 @@ "section": "def-common.HttpResourcesResponseOptions", "text": "HttpResourcesResponseOptions" }, - "]> & ((options: ", + "], unknown> & ((options: ", { "pluginId": "@kbn/core-http-resources-server", "scope": "common", @@ -417,7 +417,7 @@ "section": "def-common.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | undefined> | undefined]> & ( | Error | Buffer | ", + " | undefined; } | undefined> | undefined], unknown> & ( | Error | Buffer | ", "Stream", " | { message: string | Error; attributes?: ", { @@ -479,7 +479,7 @@ "section": "def-common.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | undefined> | undefined]> & ( | Error | Buffer | ", + " | undefined; } | undefined> | undefined], unknown> & ( | Error | Buffer | ", "Stream", " | { message: string | Error; attributes?: ", { @@ -521,7 +521,7 @@ "section": "def-common.HttpResponseOptions", "text": "HttpResponseOptions" }, - " | undefined]> & ((options?: ", + " | undefined], unknown> & ((options?: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -553,7 +553,7 @@ "section": "def-common.RedirectResponseOptions", "text": "RedirectResponseOptions" }, - "]> & ((options: ", + "], unknown> & ((options: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -585,7 +585,7 @@ "section": "def-common.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, - " | undefined]> & ((options?: ", + " | undefined], unknown> & ((options?: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -617,7 +617,7 @@ "section": "def-common.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, - " | undefined]> & ((options?: ", + " | undefined], unknown> & ((options?: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -649,7 +649,7 @@ "section": "def-common.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, - " | undefined]> & ((options?: ", + " | undefined], unknown> & ((options?: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -681,7 +681,7 @@ "section": "def-common.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, - " | undefined]> & ((options?: ", + " | undefined], unknown> & ((options?: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -713,7 +713,7 @@ "section": "def-common.ErrorHttpResponseOptions", "text": "ErrorHttpResponseOptions" }, - " | undefined]> & ((options?: ", + " | undefined], unknown> & ((options?: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -755,7 +755,7 @@ "section": "def-common.ResponseError", "text": "ResponseError" }, - ">]> & ((options: ", + ">], unknown> & ((options: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -807,7 +807,7 @@ "section": "def-common.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | undefined>]> & ( | Error | Buffer | ", + " | undefined; } | undefined>], unknown> & ( | Error | Buffer | ", "Stream", " | { message: string | Error; attributes?: ", { @@ -859,7 +859,7 @@ "section": "def-common.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | undefined>]> & ( | Error | Buffer | ", + " | undefined; } | undefined>], unknown> & ( | Error | Buffer | ", "Stream", " | { message: string | Error; attributes?: ", { diff --git a/api_docs/kbn_core_http_resources_server_mocks.mdx b/api_docs/kbn_core_http_resources_server_mocks.mdx index 6db6f8d25b767..592f7fb9e9c95 100644 --- a/api_docs/kbn_core_http_resources_server_mocks.mdx +++ b/api_docs/kbn_core_http_resources_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-resources-server-mocks title: "@kbn/core-http-resources-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-resources-server-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-resources-server-mocks'] --- import kbnCoreHttpResourcesServerMocksObj from './kbn_core_http_resources_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_http_router_server_internal.mdx b/api_docs/kbn_core_http_router_server_internal.mdx index 771c814b023d7..1c726d9563e99 100644 --- a/api_docs/kbn_core_http_router_server_internal.mdx +++ b/api_docs/kbn_core_http_router_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-router-server-internal title: "@kbn/core-http-router-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-router-server-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-router-server-internal'] --- import kbnCoreHttpRouterServerInternalObj from './kbn_core_http_router_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_http_router_server_mocks.devdocs.json b/api_docs/kbn_core_http_router_server_mocks.devdocs.json index ddb2cbc8b1b18..8dbc1fe6e57a7 100644 --- a/api_docs/kbn_core_http_router_server_mocks.devdocs.json +++ b/api_docs/kbn_core_http_router_server_mocks.devdocs.json @@ -210,7 +210,7 @@ "section": "def-common.IKibanaResponse", "text": "IKibanaResponse" }, - ">]>; } & ", + ">], unknown>; } & ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -265,7 +265,7 @@ "section": "def-common.VersionedRouteConfig", "text": "VersionedRouteConfig" }, - "<\"get\">]>; put: jest.MockInstance<", + "<\"get\">], unknown>; put: jest.MockInstance<", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -281,7 +281,7 @@ "section": "def-common.VersionedRouteConfig", "text": "VersionedRouteConfig" }, - "<\"put\">]>; post: jest.MockInstance<", + "<\"put\">], unknown>; post: jest.MockInstance<", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -297,7 +297,7 @@ "section": "def-common.VersionedRouteConfig", "text": "VersionedRouteConfig" }, - "<\"post\">]>; patch: jest.MockInstance<", + "<\"post\">], unknown>; patch: jest.MockInstance<", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -313,7 +313,7 @@ "section": "def-common.VersionedRouteConfig", "text": "VersionedRouteConfig" }, - "<\"patch\">]>; delete: jest.MockInstance<", + "<\"patch\">], unknown>; delete: jest.MockInstance<", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -329,7 +329,7 @@ "section": "def-common.VersionedRouteConfig", "text": "VersionedRouteConfig" }, - "<\"delete\">]>; } & ", + "<\"delete\">], unknown>; } & ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -400,7 +400,7 @@ "section": "def-common.KibanaResponseFactory", "text": "KibanaResponseFactory" }, - ">]>; post: jest.MockInstance], unknown>; post: jest.MockInstance]>; put: jest.MockInstance], unknown>; put: jest.MockInstance]>; patch: jest.MockInstance], unknown>; patch: jest.MockInstance]>; delete: jest.MockInstance], unknown>; delete: jest.MockInstance]>; handleLegacyErrors: jest.MockInstance<", + ">], unknown>; handleLegacyErrors: jest.MockInstance<", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -560,7 +560,7 @@ "section": "def-common.KibanaResponseFactory", "text": "KibanaResponseFactory" }, - ">]>; getRoutes: jest.MockInstance<", + ">], unknown>; getRoutes: jest.MockInstance<", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -568,7 +568,7 @@ "section": "def-common.RouterRoute", "text": "RouterRoute" }, - "[], []>; versioned: ", + "[], [], unknown>; versioned: ", { "pluginId": "@kbn/core-http-server", "scope": "common", diff --git a/api_docs/kbn_core_http_router_server_mocks.mdx b/api_docs/kbn_core_http_router_server_mocks.mdx index b6ccef6c3723c..7dd50428e765c 100644 --- a/api_docs/kbn_core_http_router_server_mocks.mdx +++ b/api_docs/kbn_core_http_router_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-router-server-mocks title: "@kbn/core-http-router-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-router-server-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-router-server-mocks'] --- import kbnCoreHttpRouterServerMocksObj from './kbn_core_http_router_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_http_server.devdocs.json b/api_docs/kbn_core_http_server.devdocs.json index 8f3d3158648cb..e0de3c7a3ff08 100644 --- a/api_docs/kbn_core_http_server.devdocs.json +++ b/api_docs/kbn_core_http_server.devdocs.json @@ -3267,6 +3267,14 @@ "plugin": "@kbn/core-ui-settings-server-internal", "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/routes/get.ts" }, + { + "plugin": "@kbn/core-ui-settings-server-internal", + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/routes/internal/get.ts" + }, + { + "plugin": "@kbn/core-ui-settings-server-internal", + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/routes/internal/get.ts" + }, { "plugin": "@kbn/core-status-server-internal", "path": "packages/core/status/core-status-server-internal/src/routes/status.ts" @@ -3487,10 +3495,6 @@ "plugin": "actions", "path": "x-pack/plugins/actions/server/routes/legacy/list_action_types.ts" }, - { - "plugin": "data", - "path": "src/plugins/data/server/scripts/route.ts" - }, { "plugin": "share", "path": "src/plugins/share/server/url_service/http/short_urls/register_get_route.ts" @@ -6105,6 +6109,22 @@ "plugin": "@kbn/core-ui-settings-server-internal", "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/routes/set.ts" }, + { + "plugin": "@kbn/core-ui-settings-server-internal", + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/routes/internal/set_many.ts" + }, + { + "plugin": "@kbn/core-ui-settings-server-internal", + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/routes/internal/set_many.ts" + }, + { + "plugin": "@kbn/core-ui-settings-server-internal", + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/routes/internal/set.ts" + }, + { + "plugin": "@kbn/core-ui-settings-server-internal", + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/routes/internal/set.ts" + }, { "plugin": "@kbn/core-capabilities-server-internal", "path": "packages/core/capabilities/core-capabilities-server-internal/src/routes/resolve_capabilities.ts" @@ -6261,10 +6281,6 @@ "plugin": "contentManagement", "path": "src/plugins/content_management/server/rpc/routes/routes.ts" }, - { - "plugin": "data", - "path": "src/plugins/data/server/kql_telemetry/route.ts" - }, { "plugin": "share", "path": "src/plugins/share/server/url_service/http/short_urls/register_create_route.ts" @@ -8121,6 +8137,10 @@ "plugin": "fleet", "path": "x-pack/plugins/fleet/server/routes/epm/index.ts" }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/routes/epm/index.ts" + }, { "plugin": "fleet", "path": "x-pack/plugins/fleet/server/routes/setup/index.ts" @@ -9643,6 +9663,14 @@ "plugin": "@kbn/core-ui-settings-server-internal", "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/routes/delete.ts" }, + { + "plugin": "@kbn/core-ui-settings-server-internal", + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/routes/internal/delete.ts" + }, + { + "plugin": "@kbn/core-ui-settings-server-internal", + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/routes/internal/delete.ts" + }, { "plugin": "home", "path": "src/plugins/home/server/services/sample_data/routes/uninstall.ts" @@ -13758,6 +13786,10 @@ "plugin": "data", "path": "src/plugins/data/server/query/routes.ts" }, + { + "plugin": "data", + "path": "src/plugins/data/server/scripts/route.ts" + }, { "plugin": "ml", "path": "x-pack/plugins/ml/server/routes/json_schema.ts" @@ -14698,9 +14730,13 @@ "plugin": "data", "path": "src/plugins/data/server/query/routes.ts" }, + { + "plugin": "data", + "path": "src/plugins/data/server/kql_telemetry/route.ts" + }, { "plugin": "aiops", - "path": "x-pack/plugins/aiops/server/routes/explain_log_rate_spikes.ts" + "path": "x-pack/plugins/aiops/server/routes/log_rate_analysis.ts" }, { "plugin": "unifiedSearch", diff --git a/api_docs/kbn_core_http_server.mdx b/api_docs/kbn_core_http_server.mdx index 96b41a5ef180a..69384898b78cc 100644 --- a/api_docs/kbn_core_http_server.mdx +++ b/api_docs/kbn_core_http_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-server title: "@kbn/core-http-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-server plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-server'] --- import kbnCoreHttpServerObj from './kbn_core_http_server.devdocs.json'; diff --git a/api_docs/kbn_core_http_server_internal.mdx b/api_docs/kbn_core_http_server_internal.mdx index c53bbf9c0cb05..98b7e520b9dbd 100644 --- a/api_docs/kbn_core_http_server_internal.mdx +++ b/api_docs/kbn_core_http_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-server-internal title: "@kbn/core-http-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-server-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-server-internal'] --- import kbnCoreHttpServerInternalObj from './kbn_core_http_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_http_server_mocks.devdocs.json b/api_docs/kbn_core_http_server_mocks.devdocs.json index 40836ac247b24..f62b950435af3 100644 --- a/api_docs/kbn_core_http_server_mocks.devdocs.json +++ b/api_docs/kbn_core_http_server_mocks.devdocs.json @@ -197,7 +197,7 @@ "section": "def-common.RequestHandlerContextBase", "text": "RequestHandlerContextBase" }, - ">) => void]>; basePath: ", + ">) => void], unknown>; basePath: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -213,7 +213,7 @@ "section": "def-common.HttpServerInfo", "text": "HttpServerInfo" }, - ", []>; } & ", + ", [], unknown>; } & ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -268,7 +268,7 @@ "section": "def-common.IContextProvider", "text": "IContextProvider" }, - ">]>; getServerInfo: jest.MockInstance<", + ">], unknown>; getServerInfo: jest.MockInstance<", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -276,7 +276,7 @@ "section": "def-common.HttpServerInfo", "text": "HttpServerInfo" }, - ", []>; createCookieSessionStorageFactory: jest.MockInstance; createCookieSessionStorageFactory: jest.MockInstance]>; registerOnPreRouting: jest.MockInstance], unknown>; registerOnPreRouting: jest.MockInstance; registerOnPreAuth: jest.MockInstance; registerOnPreAuth: jest.MockInstance; registerAuth: jest.MockInstance; registerAuth: jest.MockInstance; registerOnPostAuth: jest.MockInstance; registerOnPostAuth: jest.MockInstance; registerOnPreResponse: jest.MockInstance; registerOnPreResponse: jest.MockInstance; } & Omit<", + "], unknown>; } & Omit<", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -387,7 +387,7 @@ "section": "def-common.HttpServerInfo", "text": "HttpServerInfo" }, - ", []>; } & ", + ", [], unknown>; } & ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -436,7 +436,15 @@ }, "; server: ", "Server", - "; registerStaticDir: jest.MockInstance; registerRouteHandlerContext: jest.MockInstance; registerRouteHandlerContext: >(pluginOpaqueId: symbol, contextName: ContextName, provider: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -444,15 +452,15 @@ "section": "def-common.IContextProvider", "text": "IContextProvider" }, - "<", + ") => ", { "pluginId": "@kbn/core-http-server", "scope": "common", "docId": "kibKbnCoreHttpServerPluginApi", - "section": "def-common.RequestHandlerContextBase", - "text": "RequestHandlerContextBase" + "section": "def-common.IContextContainer", + "text": "IContextContainer" }, - ", never>]>; getServerInfo: jest.MockInstance<", + "; getServerInfo: jest.MockInstance<", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -460,7 +468,7 @@ "section": "def-common.HttpServerInfo", "text": "HttpServerInfo" }, - ", []>; registerRoutes: jest.MockInstance; registerRoutes: jest.MockInstance) => void]>; } & Omit<", + ">) => void], unknown>; } & Omit<", "InternalHttpServicePreboot", ", \"basePath\"> & { basePath: BasePathMocked; }" ], @@ -511,7 +519,15 @@ }, "; server: ", "Server", - "; registerStaticDir: jest.MockInstance; registerRouteHandlerContext: jest.MockInstance; registerRouteHandlerContext: >(pluginOpaqueId: symbol, contextName: ContextName, provider: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -519,15 +535,15 @@ "section": "def-common.IContextProvider", "text": "IContextProvider" }, - "<", + ") => ", { "pluginId": "@kbn/core-http-server", "scope": "common", "docId": "kibKbnCoreHttpServerPluginApi", - "section": "def-common.RequestHandlerContextBase", - "text": "RequestHandlerContextBase" + "section": "def-common.IContextContainer", + "text": "IContextContainer" }, - ", never>]>; getServerInfo: jest.MockInstance<", + "; getServerInfo: jest.MockInstance<", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -535,7 +551,7 @@ "section": "def-common.HttpServerInfo", "text": "HttpServerInfo" }, - ", []>; createCookieSessionStorageFactory: jest.MockInstance; createCookieSessionStorageFactory: jest.MockInstance]>; registerOnPreRouting: jest.MockInstance], unknown>; registerOnPreRouting: jest.MockInstance; registerOnPreAuth: jest.MockInstance; registerOnPreAuth: jest.MockInstance; registerAuth: jest.MockInstance; registerAuth: jest.MockInstance; registerOnPostAuth: jest.MockInstance; registerOnPostAuth: jest.MockInstance; registerOnPreResponse: jest.MockInstance; registerOnPreResponse: jest.MockInstance; registerRouterAfterListening: jest.MockInstance; registerRouterAfterListening: jest.MockInstance]>; } & Omit<", + ">], unknown>; } & Omit<", "InternalHttpServiceSetup", ", \"createRouter\" | \"basePath\" | \"auth\" | \"authRequestHeaders\"> & { auth: AuthMocked; basePath: BasePathMocked; createRouter: jest.MockedFunction<(path: string) => ", { @@ -640,7 +656,7 @@ "label": "InternalHttpServiceStartMock", "description": [], "signature": [ - "{ isListening: jest.MockInstance; basePath: ", + "{ isListening: jest.MockInstance; basePath: ", { "pluginId": "@kbn/core-http-server", "scope": "common", @@ -664,7 +680,7 @@ "section": "def-common.HttpServerInfo", "text": "HttpServerInfo" }, - ", []>; } & ", + ", [], unknown>; } & ", "InternalHttpServiceStart", " & { basePath: BasePathMocked; }" ], diff --git a/api_docs/kbn_core_http_server_mocks.mdx b/api_docs/kbn_core_http_server_mocks.mdx index 5d18120f474da..ab13cd1748cbe 100644 --- a/api_docs/kbn_core_http_server_mocks.mdx +++ b/api_docs/kbn_core_http_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-server-mocks title: "@kbn/core-http-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-http-server-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-server-mocks'] --- import kbnCoreHttpServerMocksObj from './kbn_core_http_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_i18n_browser.mdx b/api_docs/kbn_core_i18n_browser.mdx index 6709630e1127a..8d265006f9064 100644 --- a/api_docs/kbn_core_i18n_browser.mdx +++ b/api_docs/kbn_core_i18n_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-i18n-browser title: "@kbn/core-i18n-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-i18n-browser plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-i18n-browser'] --- import kbnCoreI18nBrowserObj from './kbn_core_i18n_browser.devdocs.json'; diff --git a/api_docs/kbn_core_i18n_browser_mocks.mdx b/api_docs/kbn_core_i18n_browser_mocks.mdx index 2876d33b14f3c..10f1f515bcbd5 100644 --- a/api_docs/kbn_core_i18n_browser_mocks.mdx +++ b/api_docs/kbn_core_i18n_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-i18n-browser-mocks title: "@kbn/core-i18n-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-i18n-browser-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-i18n-browser-mocks'] --- import kbnCoreI18nBrowserMocksObj from './kbn_core_i18n_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_i18n_server.mdx b/api_docs/kbn_core_i18n_server.mdx index c68d4ebb7b9f6..f3d8b3a79d9af 100644 --- a/api_docs/kbn_core_i18n_server.mdx +++ b/api_docs/kbn_core_i18n_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-i18n-server title: "@kbn/core-i18n-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-i18n-server plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-i18n-server'] --- import kbnCoreI18nServerObj from './kbn_core_i18n_server.devdocs.json'; diff --git a/api_docs/kbn_core_i18n_server_internal.mdx b/api_docs/kbn_core_i18n_server_internal.mdx index 9300dd5403ed2..4f39a6c4fccf2 100644 --- a/api_docs/kbn_core_i18n_server_internal.mdx +++ b/api_docs/kbn_core_i18n_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-i18n-server-internal title: "@kbn/core-i18n-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-i18n-server-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-i18n-server-internal'] --- import kbnCoreI18nServerInternalObj from './kbn_core_i18n_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_i18n_server_mocks.mdx b/api_docs/kbn_core_i18n_server_mocks.mdx index 19218eeeb0bc5..348ef4bb92d7a 100644 --- a/api_docs/kbn_core_i18n_server_mocks.mdx +++ b/api_docs/kbn_core_i18n_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-i18n-server-mocks title: "@kbn/core-i18n-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-i18n-server-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-i18n-server-mocks'] --- import kbnCoreI18nServerMocksObj from './kbn_core_i18n_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_injected_metadata_browser_mocks.mdx b/api_docs/kbn_core_injected_metadata_browser_mocks.mdx index 82c23c51f2cac..20c318e61fc40 100644 --- a/api_docs/kbn_core_injected_metadata_browser_mocks.mdx +++ b/api_docs/kbn_core_injected_metadata_browser_mocks.mdx @@ -8,7 +8,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 description: API docs for the @kbn/core-injected-metadata-browser-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-injected-metadata-browser-mocks'] --- import kbnCoreInjectedMetadataBrowserMocksObj from './kbn_core_injected_metadata_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_integrations_browser_internal.mdx b/api_docs/kbn_core_integrations_browser_internal.mdx index 3e1275ecb779d..e8af0917a10a3 100644 --- a/api_docs/kbn_core_integrations_browser_internal.mdx +++ b/api_docs/kbn_core_integrations_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-integrations-browser-internal title: "@kbn/core-integrations-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-integrations-browser-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-integrations-browser-internal'] --- import kbnCoreIntegrationsBrowserInternalObj from './kbn_core_integrations_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_integrations_browser_mocks.devdocs.json b/api_docs/kbn_core_integrations_browser_mocks.devdocs.json index a5bbc4f2e637b..0a1cd1cd04f08 100644 --- a/api_docs/kbn_core_integrations_browser_mocks.devdocs.json +++ b/api_docs/kbn_core_integrations_browser_mocks.devdocs.json @@ -61,7 +61,7 @@ "section": "def-common.IntegrationsServiceSetupDeps", "text": "IntegrationsServiceSetupDeps" }, - "]>; setup: jest.MockInstance, []>; stop: jest.MockInstance, []>; } & ", + "], unknown>; setup: jest.MockInstance, [], unknown>; stop: jest.MockInstance, [], unknown>; } & ", { "pluginId": "@kbn/core-integrations-browser-mocks", "scope": "common", diff --git a/api_docs/kbn_core_integrations_browser_mocks.mdx b/api_docs/kbn_core_integrations_browser_mocks.mdx index 8338056c152cc..56a8758ad8a04 100644 --- a/api_docs/kbn_core_integrations_browser_mocks.mdx +++ b/api_docs/kbn_core_integrations_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-integrations-browser-mocks title: "@kbn/core-integrations-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-integrations-browser-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-integrations-browser-mocks'] --- import kbnCoreIntegrationsBrowserMocksObj from './kbn_core_integrations_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_lifecycle_browser.mdx b/api_docs/kbn_core_lifecycle_browser.mdx index 7d52748dead01..1f28fea27d68f 100644 --- a/api_docs/kbn_core_lifecycle_browser.mdx +++ b/api_docs/kbn_core_lifecycle_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-lifecycle-browser title: "@kbn/core-lifecycle-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-lifecycle-browser plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-lifecycle-browser'] --- import kbnCoreLifecycleBrowserObj from './kbn_core_lifecycle_browser.devdocs.json'; diff --git a/api_docs/kbn_core_lifecycle_browser_mocks.devdocs.json b/api_docs/kbn_core_lifecycle_browser_mocks.devdocs.json index b366bf385edb9..5818e585029e8 100644 --- a/api_docs/kbn_core_lifecycle_browser_mocks.devdocs.json +++ b/api_docs/kbn_core_lifecycle_browser_mocks.devdocs.json @@ -70,7 +70,7 @@ }, ">; hasCustomBranding$: ", "Observable", - "; }; docLinks: jest.Mock; executionContext: jest.Mocked<", + "; }; docLinks: jest.Mock; executionContext: jest.Mocked<", { "pluginId": "@kbn/core-execution-context-browser", "scope": "common", @@ -244,7 +244,7 @@ "section": "def-common.FatalErrorsSetup", "text": "FatalErrorsSetup" }, - ">; }, any, any]>, []>; http: ", + ">; }, any, any]>, [], any>; http: ", { "pluginId": "@kbn/core-http-browser-mocks", "scope": "common", diff --git a/api_docs/kbn_core_lifecycle_browser_mocks.mdx b/api_docs/kbn_core_lifecycle_browser_mocks.mdx index 11de43cdc82ae..2a3a86ee94380 100644 --- a/api_docs/kbn_core_lifecycle_browser_mocks.mdx +++ b/api_docs/kbn_core_lifecycle_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-lifecycle-browser-mocks title: "@kbn/core-lifecycle-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-lifecycle-browser-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-lifecycle-browser-mocks'] --- import kbnCoreLifecycleBrowserMocksObj from './kbn_core_lifecycle_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_lifecycle_server.mdx b/api_docs/kbn_core_lifecycle_server.mdx index 230b0c3e8c2ce..f411b9a940785 100644 --- a/api_docs/kbn_core_lifecycle_server.mdx +++ b/api_docs/kbn_core_lifecycle_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-lifecycle-server title: "@kbn/core-lifecycle-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-lifecycle-server plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-lifecycle-server'] --- import kbnCoreLifecycleServerObj from './kbn_core_lifecycle_server.devdocs.json'; diff --git a/api_docs/kbn_core_lifecycle_server_mocks.devdocs.json b/api_docs/kbn_core_lifecycle_server_mocks.devdocs.json index 5a0a8c83af587..3eb3da50099db 100644 --- a/api_docs/kbn_core_lifecycle_server_mocks.devdocs.json +++ b/api_docs/kbn_core_lifecycle_server_mocks.devdocs.json @@ -68,7 +68,7 @@ "section": "def-common.HttpResources", "text": "HttpResources" }, - ">, []>; }; uiSettings: jest.Mocked<", + ">, [], any>; }; uiSettings: jest.Mocked<", "InternalUiSettingsServicePreboot", ">; logging: jest.Mocked<", "InternalLoggingServicePreboot", @@ -152,7 +152,7 @@ "section": "def-common.HttpResources", "text": "HttpResources" }, - ">, []>; }; rendering: jest.Mocked<", + ">, [], any>; }; rendering: jest.Mocked<", "InternalRenderingServiceSetup", ">; uiSettings: jest.Mocked<", { @@ -184,7 +184,7 @@ "IExecutionContext", ">; coreUsageData: jest.Mocked<", "InternalCoreUsageDataSetup", - ">; customBranding: { register: jest.Mock; getBrandingFor: jest.Mock; }; userSettings: { setUserProfileSettings: jest.Mock; getUserSettingDarkMode: jest.Mock; }; }" + ">; customBranding: { register: jest.Mock; getBrandingFor: jest.Mock; }; userSettings: { setUserProfileSettings: jest.Mock; getUserSettingDarkMode: jest.Mock; }; }" ], "path": "packages/core/lifecycle/core-lifecycle-server-mocks/src/index.ts", "deprecated": false, diff --git a/api_docs/kbn_core_lifecycle_server_mocks.mdx b/api_docs/kbn_core_lifecycle_server_mocks.mdx index ab34cc42b940e..d1436528bf313 100644 --- a/api_docs/kbn_core_lifecycle_server_mocks.mdx +++ b/api_docs/kbn_core_lifecycle_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-lifecycle-server-mocks title: "@kbn/core-lifecycle-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-lifecycle-server-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-lifecycle-server-mocks'] --- import kbnCoreLifecycleServerMocksObj from './kbn_core_lifecycle_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_logging_browser_mocks.mdx b/api_docs/kbn_core_logging_browser_mocks.mdx index 20bbbb8883518..cf9195987a01b 100644 --- a/api_docs/kbn_core_logging_browser_mocks.mdx +++ b/api_docs/kbn_core_logging_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-browser-mocks title: "@kbn/core-logging-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-logging-browser-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-logging-browser-mocks'] --- import kbnCoreLoggingBrowserMocksObj from './kbn_core_logging_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_logging_common_internal.mdx b/api_docs/kbn_core_logging_common_internal.mdx index 92e7e69c7646b..1bba43be88af7 100644 --- a/api_docs/kbn_core_logging_common_internal.mdx +++ b/api_docs/kbn_core_logging_common_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-common-internal title: "@kbn/core-logging-common-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-logging-common-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-logging-common-internal'] --- import kbnCoreLoggingCommonInternalObj from './kbn_core_logging_common_internal.devdocs.json'; diff --git a/api_docs/kbn_core_logging_server.mdx b/api_docs/kbn_core_logging_server.mdx index c7221624f35ce..6ecc26d055b34 100644 --- a/api_docs/kbn_core_logging_server.mdx +++ b/api_docs/kbn_core_logging_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-server title: "@kbn/core-logging-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-logging-server plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-logging-server'] --- import kbnCoreLoggingServerObj from './kbn_core_logging_server.devdocs.json'; diff --git a/api_docs/kbn_core_logging_server_internal.mdx b/api_docs/kbn_core_logging_server_internal.mdx index 06f41a57cb1ff..b0a67b385fee9 100644 --- a/api_docs/kbn_core_logging_server_internal.mdx +++ b/api_docs/kbn_core_logging_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-server-internal title: "@kbn/core-logging-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-logging-server-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-logging-server-internal'] --- import kbnCoreLoggingServerInternalObj from './kbn_core_logging_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_logging_server_mocks.mdx b/api_docs/kbn_core_logging_server_mocks.mdx index d96d61e84fbe3..3ae8a26cb1a9e 100644 --- a/api_docs/kbn_core_logging_server_mocks.mdx +++ b/api_docs/kbn_core_logging_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-server-mocks title: "@kbn/core-logging-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-logging-server-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-logging-server-mocks'] --- import kbnCoreLoggingServerMocksObj from './kbn_core_logging_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_metrics_collectors_server_internal.mdx b/api_docs/kbn_core_metrics_collectors_server_internal.mdx index d3049399cdcb3..bb4baf16d2e0c 100644 --- a/api_docs/kbn_core_metrics_collectors_server_internal.mdx +++ b/api_docs/kbn_core_metrics_collectors_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-metrics-collectors-server-internal title: "@kbn/core-metrics-collectors-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-metrics-collectors-server-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-metrics-collectors-server-internal'] --- import kbnCoreMetricsCollectorsServerInternalObj from './kbn_core_metrics_collectors_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_metrics_collectors_server_mocks.mdx b/api_docs/kbn_core_metrics_collectors_server_mocks.mdx index 769c76c04fe3f..40aa2c80d9d50 100644 --- a/api_docs/kbn_core_metrics_collectors_server_mocks.mdx +++ b/api_docs/kbn_core_metrics_collectors_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-metrics-collectors-server-mocks title: "@kbn/core-metrics-collectors-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-metrics-collectors-server-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-metrics-collectors-server-mocks'] --- import kbnCoreMetricsCollectorsServerMocksObj from './kbn_core_metrics_collectors_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_metrics_server.mdx b/api_docs/kbn_core_metrics_server.mdx index 824617b579599..9e97aee081320 100644 --- a/api_docs/kbn_core_metrics_server.mdx +++ b/api_docs/kbn_core_metrics_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-metrics-server title: "@kbn/core-metrics-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-metrics-server plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-metrics-server'] --- import kbnCoreMetricsServerObj from './kbn_core_metrics_server.devdocs.json'; diff --git a/api_docs/kbn_core_metrics_server_internal.mdx b/api_docs/kbn_core_metrics_server_internal.mdx index b5611371ab7d8..1f166ba3b38d3 100644 --- a/api_docs/kbn_core_metrics_server_internal.mdx +++ b/api_docs/kbn_core_metrics_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-metrics-server-internal title: "@kbn/core-metrics-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-metrics-server-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-metrics-server-internal'] --- import kbnCoreMetricsServerInternalObj from './kbn_core_metrics_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_metrics_server_mocks.mdx b/api_docs/kbn_core_metrics_server_mocks.mdx index 3d305788a5077..0a6a8a7d430e3 100644 --- a/api_docs/kbn_core_metrics_server_mocks.mdx +++ b/api_docs/kbn_core_metrics_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-metrics-server-mocks title: "@kbn/core-metrics-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-metrics-server-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-metrics-server-mocks'] --- import kbnCoreMetricsServerMocksObj from './kbn_core_metrics_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_mount_utils_browser.mdx b/api_docs/kbn_core_mount_utils_browser.mdx index 74f08a008e206..4f30f710d3959 100644 --- a/api_docs/kbn_core_mount_utils_browser.mdx +++ b/api_docs/kbn_core_mount_utils_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-mount-utils-browser title: "@kbn/core-mount-utils-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-mount-utils-browser plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-mount-utils-browser'] --- import kbnCoreMountUtilsBrowserObj from './kbn_core_mount_utils_browser.devdocs.json'; diff --git a/api_docs/kbn_core_node_server.mdx b/api_docs/kbn_core_node_server.mdx index 002138972d995..22db43b55590d 100644 --- a/api_docs/kbn_core_node_server.mdx +++ b/api_docs/kbn_core_node_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-node-server title: "@kbn/core-node-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-node-server plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-node-server'] --- import kbnCoreNodeServerObj from './kbn_core_node_server.devdocs.json'; diff --git a/api_docs/kbn_core_node_server_internal.mdx b/api_docs/kbn_core_node_server_internal.mdx index 050342c97717e..745ea13c7202b 100644 --- a/api_docs/kbn_core_node_server_internal.mdx +++ b/api_docs/kbn_core_node_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-node-server-internal title: "@kbn/core-node-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-node-server-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-node-server-internal'] --- import kbnCoreNodeServerInternalObj from './kbn_core_node_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_node_server_mocks.mdx b/api_docs/kbn_core_node_server_mocks.mdx index cc4236a7a04fa..bfb107695162f 100644 --- a/api_docs/kbn_core_node_server_mocks.mdx +++ b/api_docs/kbn_core_node_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-node-server-mocks title: "@kbn/core-node-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-node-server-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-node-server-mocks'] --- import kbnCoreNodeServerMocksObj from './kbn_core_node_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_notifications_browser.mdx b/api_docs/kbn_core_notifications_browser.mdx index 5c4ab4074ab5e..0fe5a53c17be4 100644 --- a/api_docs/kbn_core_notifications_browser.mdx +++ b/api_docs/kbn_core_notifications_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-notifications-browser title: "@kbn/core-notifications-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-notifications-browser plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-notifications-browser'] --- import kbnCoreNotificationsBrowserObj from './kbn_core_notifications_browser.devdocs.json'; diff --git a/api_docs/kbn_core_notifications_browser_internal.mdx b/api_docs/kbn_core_notifications_browser_internal.mdx index 4586b1ef3373a..ce8724e7a3b8f 100644 --- a/api_docs/kbn_core_notifications_browser_internal.mdx +++ b/api_docs/kbn_core_notifications_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-notifications-browser-internal title: "@kbn/core-notifications-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-notifications-browser-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-notifications-browser-internal'] --- import kbnCoreNotificationsBrowserInternalObj from './kbn_core_notifications_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_notifications_browser_mocks.mdx b/api_docs/kbn_core_notifications_browser_mocks.mdx index fa2a31a6205d0..1ab4c912979e1 100644 --- a/api_docs/kbn_core_notifications_browser_mocks.mdx +++ b/api_docs/kbn_core_notifications_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-notifications-browser-mocks title: "@kbn/core-notifications-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-notifications-browser-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-notifications-browser-mocks'] --- import kbnCoreNotificationsBrowserMocksObj from './kbn_core_notifications_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_overlays_browser.mdx b/api_docs/kbn_core_overlays_browser.mdx index 66d75ee886ac6..cdbe0a4b4b1c5 100644 --- a/api_docs/kbn_core_overlays_browser.mdx +++ b/api_docs/kbn_core_overlays_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-overlays-browser title: "@kbn/core-overlays-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-overlays-browser plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-overlays-browser'] --- import kbnCoreOverlaysBrowserObj from './kbn_core_overlays_browser.devdocs.json'; diff --git a/api_docs/kbn_core_overlays_browser_internal.mdx b/api_docs/kbn_core_overlays_browser_internal.mdx index 09e4448c2e956..9d191f3f59a42 100644 --- a/api_docs/kbn_core_overlays_browser_internal.mdx +++ b/api_docs/kbn_core_overlays_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-overlays-browser-internal title: "@kbn/core-overlays-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-overlays-browser-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-overlays-browser-internal'] --- import kbnCoreOverlaysBrowserInternalObj from './kbn_core_overlays_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_overlays_browser_mocks.mdx b/api_docs/kbn_core_overlays_browser_mocks.mdx index 7bbf1ac0d3dec..4b605310cbd38 100644 --- a/api_docs/kbn_core_overlays_browser_mocks.mdx +++ b/api_docs/kbn_core_overlays_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-overlays-browser-mocks title: "@kbn/core-overlays-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-overlays-browser-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-overlays-browser-mocks'] --- import kbnCoreOverlaysBrowserMocksObj from './kbn_core_overlays_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_plugins_browser.mdx b/api_docs/kbn_core_plugins_browser.mdx index 66072ad97528c..b0242e4148e23 100644 --- a/api_docs/kbn_core_plugins_browser.mdx +++ b/api_docs/kbn_core_plugins_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-plugins-browser title: "@kbn/core-plugins-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-plugins-browser plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-plugins-browser'] --- import kbnCorePluginsBrowserObj from './kbn_core_plugins_browser.devdocs.json'; diff --git a/api_docs/kbn_core_plugins_browser_mocks.mdx b/api_docs/kbn_core_plugins_browser_mocks.mdx index fa824d883ebe6..68fb3d367061f 100644 --- a/api_docs/kbn_core_plugins_browser_mocks.mdx +++ b/api_docs/kbn_core_plugins_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-plugins-browser-mocks title: "@kbn/core-plugins-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-plugins-browser-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-plugins-browser-mocks'] --- import kbnCorePluginsBrowserMocksObj from './kbn_core_plugins_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_plugins_server.mdx b/api_docs/kbn_core_plugins_server.mdx index 783aa573f84c2..1e82247f21bf4 100644 --- a/api_docs/kbn_core_plugins_server.mdx +++ b/api_docs/kbn_core_plugins_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-plugins-server title: "@kbn/core-plugins-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-plugins-server plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-plugins-server'] --- import kbnCorePluginsServerObj from './kbn_core_plugins_server.devdocs.json'; diff --git a/api_docs/kbn_core_plugins_server_mocks.mdx b/api_docs/kbn_core_plugins_server_mocks.mdx index ef61a15e60017..51bee1ffee1e4 100644 --- a/api_docs/kbn_core_plugins_server_mocks.mdx +++ b/api_docs/kbn_core_plugins_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-plugins-server-mocks title: "@kbn/core-plugins-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-plugins-server-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-plugins-server-mocks'] --- import kbnCorePluginsServerMocksObj from './kbn_core_plugins_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_preboot_server.mdx b/api_docs/kbn_core_preboot_server.mdx index 5ccf7174db502..370a0d7f5b37a 100644 --- a/api_docs/kbn_core_preboot_server.mdx +++ b/api_docs/kbn_core_preboot_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-preboot-server title: "@kbn/core-preboot-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-preboot-server plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-preboot-server'] --- import kbnCorePrebootServerObj from './kbn_core_preboot_server.devdocs.json'; diff --git a/api_docs/kbn_core_preboot_server_mocks.devdocs.json b/api_docs/kbn_core_preboot_server_mocks.devdocs.json index 0d76046807017..c762b352747d3 100644 --- a/api_docs/kbn_core_preboot_server_mocks.devdocs.json +++ b/api_docs/kbn_core_preboot_server_mocks.devdocs.json @@ -30,7 +30,7 @@ "label": "InternalPrebootServicePrebootMock", "description": [], "signature": [ - "{ readonly isSetupOnHold: jest.MockInstance; readonly holdSetupUntilResolved: jest.MockInstance]>; readonly waitUntilCanSetup: jest.MockInstance, []>; } & ", + "{ readonly isSetupOnHold: jest.MockInstance; readonly holdSetupUntilResolved: jest.MockInstance], unknown>; readonly waitUntilCanSetup: jest.MockInstance, [], unknown>; } & ", "InternalPrebootServicePreboot" ], "path": "packages/core/preboot/core-preboot-server-mocks/src/preboot_service.mock.ts", @@ -46,7 +46,7 @@ "label": "PrebootServicePrebootMock", "description": [], "signature": [ - "{ readonly isSetupOnHold: jest.MockInstance; readonly holdSetupUntilResolved: jest.MockInstance]>; } & ", + "{ readonly isSetupOnHold: jest.MockInstance; readonly holdSetupUntilResolved: jest.MockInstance], unknown>; } & ", { "pluginId": "@kbn/core-preboot-server", "scope": "common", diff --git a/api_docs/kbn_core_preboot_server_mocks.mdx b/api_docs/kbn_core_preboot_server_mocks.mdx index 1717891a7115c..6eaedb4a69b8e 100644 --- a/api_docs/kbn_core_preboot_server_mocks.mdx +++ b/api_docs/kbn_core_preboot_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-preboot-server-mocks title: "@kbn/core-preboot-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-preboot-server-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-preboot-server-mocks'] --- import kbnCorePrebootServerMocksObj from './kbn_core_preboot_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_rendering_browser_mocks.mdx b/api_docs/kbn_core_rendering_browser_mocks.mdx index 9f4008313135c..1564c814cb453 100644 --- a/api_docs/kbn_core_rendering_browser_mocks.mdx +++ b/api_docs/kbn_core_rendering_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-rendering-browser-mocks title: "@kbn/core-rendering-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-rendering-browser-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-rendering-browser-mocks'] --- import kbnCoreRenderingBrowserMocksObj from './kbn_core_rendering_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_rendering_server_internal.mdx b/api_docs/kbn_core_rendering_server_internal.mdx index 3a74cdbb2ad5b..a805ae573155d 100644 --- a/api_docs/kbn_core_rendering_server_internal.mdx +++ b/api_docs/kbn_core_rendering_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-rendering-server-internal title: "@kbn/core-rendering-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-rendering-server-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-rendering-server-internal'] --- import kbnCoreRenderingServerInternalObj from './kbn_core_rendering_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_rendering_server_mocks.mdx b/api_docs/kbn_core_rendering_server_mocks.mdx index ba662708fd64c..00cbf185ffc6f 100644 --- a/api_docs/kbn_core_rendering_server_mocks.mdx +++ b/api_docs/kbn_core_rendering_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-rendering-server-mocks title: "@kbn/core-rendering-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-rendering-server-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-rendering-server-mocks'] --- import kbnCoreRenderingServerMocksObj from './kbn_core_rendering_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_root_server_internal.mdx b/api_docs/kbn_core_root_server_internal.mdx index c41c5062aa565..8f5ee842abf2e 100644 --- a/api_docs/kbn_core_root_server_internal.mdx +++ b/api_docs/kbn_core_root_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-root-server-internal title: "@kbn/core-root-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-root-server-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-root-server-internal'] --- import kbnCoreRootServerInternalObj from './kbn_core_root_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_api_browser.devdocs.json b/api_docs/kbn_core_saved_objects_api_browser.devdocs.json index cb7c6b8810907..cc9449f2b9824 100644 --- a/api_docs/kbn_core_saved_objects_api_browser.devdocs.json +++ b/api_docs/kbn_core_saved_objects_api_browser.devdocs.json @@ -2995,18 +2995,6 @@ "plugin": "savedObjects", "path": "src/plugins/saved_objects/public/saved_object/helpers/find_object_by_title.ts" }, - { - "plugin": "embeddable", - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx" - }, - { - "plugin": "embeddable", - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx" - }, - { - "plugin": "embeddable", - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx" - }, { "plugin": "presentationUtil", "path": "src/plugins/presentation_util/public/services/dashboards/types.ts" diff --git a/api_docs/kbn_core_saved_objects_api_browser.mdx b/api_docs/kbn_core_saved_objects_api_browser.mdx index 4da78adc42468..17bef96f6e837 100644 --- a/api_docs/kbn_core_saved_objects_api_browser.mdx +++ b/api_docs/kbn_core_saved_objects_api_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-api-browser title: "@kbn/core-saved-objects-api-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-api-browser plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-api-browser'] --- import kbnCoreSavedObjectsApiBrowserObj from './kbn_core_saved_objects_api_browser.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_api_server.devdocs.json b/api_docs/kbn_core_saved_objects_api_server.devdocs.json index 2d11fb4b9bb95..31fbb9fb8cb39 100644 --- a/api_docs/kbn_core_saved_objects_api_server.devdocs.json +++ b/api_docs/kbn_core_saved_objects_api_server.devdocs.json @@ -2366,6 +2366,10 @@ "plugin": "fleet", "path": "x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts" }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts" + }, { "plugin": "graph", "path": "x-pack/plugins/graph/server/sample_data/logs.ts" diff --git a/api_docs/kbn_core_saved_objects_api_server.mdx b/api_docs/kbn_core_saved_objects_api_server.mdx index 4362de7b6be02..d39dfc009b42e 100644 --- a/api_docs/kbn_core_saved_objects_api_server.mdx +++ b/api_docs/kbn_core_saved_objects_api_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-api-server title: "@kbn/core-saved-objects-api-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-api-server plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-api-server'] --- import kbnCoreSavedObjectsApiServerObj from './kbn_core_saved_objects_api_server.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_api_server_mocks.mdx b/api_docs/kbn_core_saved_objects_api_server_mocks.mdx index 78532a7032059..d23d5a4b2dcb8 100644 --- a/api_docs/kbn_core_saved_objects_api_server_mocks.mdx +++ b/api_docs/kbn_core_saved_objects_api_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-api-server-mocks title: "@kbn/core-saved-objects-api-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-api-server-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-api-server-mocks'] --- import kbnCoreSavedObjectsApiServerMocksObj from './kbn_core_saved_objects_api_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_base_server_internal.mdx b/api_docs/kbn_core_saved_objects_base_server_internal.mdx index 7266a40032075..f7c8573c9b694 100644 --- a/api_docs/kbn_core_saved_objects_base_server_internal.mdx +++ b/api_docs/kbn_core_saved_objects_base_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-base-server-internal title: "@kbn/core-saved-objects-base-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-base-server-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-base-server-internal'] --- import kbnCoreSavedObjectsBaseServerInternalObj from './kbn_core_saved_objects_base_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_base_server_mocks.mdx b/api_docs/kbn_core_saved_objects_base_server_mocks.mdx index 21e78fe177f1b..2bd629c3c5530 100644 --- a/api_docs/kbn_core_saved_objects_base_server_mocks.mdx +++ b/api_docs/kbn_core_saved_objects_base_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-base-server-mocks title: "@kbn/core-saved-objects-base-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-base-server-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-base-server-mocks'] --- import kbnCoreSavedObjectsBaseServerMocksObj from './kbn_core_saved_objects_base_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_browser.mdx b/api_docs/kbn_core_saved_objects_browser.mdx index 42d8f8f377b83..79b28f2bf8992 100644 --- a/api_docs/kbn_core_saved_objects_browser.mdx +++ b/api_docs/kbn_core_saved_objects_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-browser title: "@kbn/core-saved-objects-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-browser plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-browser'] --- import kbnCoreSavedObjectsBrowserObj from './kbn_core_saved_objects_browser.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_browser_internal.mdx b/api_docs/kbn_core_saved_objects_browser_internal.mdx index cd203fad90fab..b4ff1053664bb 100644 --- a/api_docs/kbn_core_saved_objects_browser_internal.mdx +++ b/api_docs/kbn_core_saved_objects_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-browser-internal title: "@kbn/core-saved-objects-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-browser-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-browser-internal'] --- import kbnCoreSavedObjectsBrowserInternalObj from './kbn_core_saved_objects_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_browser_mocks.mdx b/api_docs/kbn_core_saved_objects_browser_mocks.mdx index 2218de8a2fe22..d7937d6fa72aa 100644 --- a/api_docs/kbn_core_saved_objects_browser_mocks.mdx +++ b/api_docs/kbn_core_saved_objects_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-browser-mocks title: "@kbn/core-saved-objects-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-browser-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-browser-mocks'] --- import kbnCoreSavedObjectsBrowserMocksObj from './kbn_core_saved_objects_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_common.devdocs.json b/api_docs/kbn_core_saved_objects_common.devdocs.json index 8eba223b71c72..df94083947f81 100644 --- a/api_docs/kbn_core_saved_objects_common.devdocs.json +++ b/api_docs/kbn_core_saved_objects_common.devdocs.json @@ -1639,18 +1639,6 @@ "plugin": "savedObjects", "path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts" }, - { - "plugin": "embeddable", - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx" - }, - { - "plugin": "embeddable", - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx" - }, - { - "plugin": "embeddable", - "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx" - }, { "plugin": "embeddable", "path": "src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts" diff --git a/api_docs/kbn_core_saved_objects_common.mdx b/api_docs/kbn_core_saved_objects_common.mdx index 28ffd4be36b30..34f2d90170ac1 100644 --- a/api_docs/kbn_core_saved_objects_common.mdx +++ b/api_docs/kbn_core_saved_objects_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-common title: "@kbn/core-saved-objects-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-common plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-common'] --- import kbnCoreSavedObjectsCommonObj from './kbn_core_saved_objects_common.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_import_export_server_internal.mdx b/api_docs/kbn_core_saved_objects_import_export_server_internal.mdx index be802b9444f0e..689f07b3a9db4 100644 --- a/api_docs/kbn_core_saved_objects_import_export_server_internal.mdx +++ b/api_docs/kbn_core_saved_objects_import_export_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-import-export-server-internal title: "@kbn/core-saved-objects-import-export-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-import-export-server-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-import-export-server-internal'] --- import kbnCoreSavedObjectsImportExportServerInternalObj from './kbn_core_saved_objects_import_export_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_import_export_server_mocks.mdx b/api_docs/kbn_core_saved_objects_import_export_server_mocks.mdx index beffba5db75bc..e6dedd2ee7e9e 100644 --- a/api_docs/kbn_core_saved_objects_import_export_server_mocks.mdx +++ b/api_docs/kbn_core_saved_objects_import_export_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-import-export-server-mocks title: "@kbn/core-saved-objects-import-export-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-import-export-server-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-import-export-server-mocks'] --- import kbnCoreSavedObjectsImportExportServerMocksObj from './kbn_core_saved_objects_import_export_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_migration_server_internal.mdx b/api_docs/kbn_core_saved_objects_migration_server_internal.mdx index 7cd8ac84fc940..54ca407ab103a 100644 --- a/api_docs/kbn_core_saved_objects_migration_server_internal.mdx +++ b/api_docs/kbn_core_saved_objects_migration_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-migration-server-internal title: "@kbn/core-saved-objects-migration-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-migration-server-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-migration-server-internal'] --- import kbnCoreSavedObjectsMigrationServerInternalObj from './kbn_core_saved_objects_migration_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_migration_server_mocks.mdx b/api_docs/kbn_core_saved_objects_migration_server_mocks.mdx index b2553c8b7132d..cd91a6c8aab50 100644 --- a/api_docs/kbn_core_saved_objects_migration_server_mocks.mdx +++ b/api_docs/kbn_core_saved_objects_migration_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-migration-server-mocks title: "@kbn/core-saved-objects-migration-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-migration-server-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-migration-server-mocks'] --- import kbnCoreSavedObjectsMigrationServerMocksObj from './kbn_core_saved_objects_migration_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_server.devdocs.json b/api_docs/kbn_core_saved_objects_server.devdocs.json index 5354c336cd82f..c8938d2d31144 100644 --- a/api_docs/kbn_core_saved_objects_server.devdocs.json +++ b/api_docs/kbn_core_saved_objects_server.devdocs.json @@ -5831,6 +5831,10 @@ "plugin": "fleet", "path": "x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts" }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/server/services/epm/kibana/assets/install.ts" + }, { "plugin": "graph", "path": "x-pack/plugins/graph/server/sample_data/logs.ts" diff --git a/api_docs/kbn_core_saved_objects_server.mdx b/api_docs/kbn_core_saved_objects_server.mdx index 0e4f67e68df09..c775fe97a8d4e 100644 --- a/api_docs/kbn_core_saved_objects_server.mdx +++ b/api_docs/kbn_core_saved_objects_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-server title: "@kbn/core-saved-objects-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-server plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-server'] --- import kbnCoreSavedObjectsServerObj from './kbn_core_saved_objects_server.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_server_internal.mdx b/api_docs/kbn_core_saved_objects_server_internal.mdx index 52d1c333567c3..6273df187e8eb 100644 --- a/api_docs/kbn_core_saved_objects_server_internal.mdx +++ b/api_docs/kbn_core_saved_objects_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-server-internal title: "@kbn/core-saved-objects-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-server-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-server-internal'] --- import kbnCoreSavedObjectsServerInternalObj from './kbn_core_saved_objects_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_server_mocks.mdx b/api_docs/kbn_core_saved_objects_server_mocks.mdx index 2c3c6c3c5b386..8911adcf95f0b 100644 --- a/api_docs/kbn_core_saved_objects_server_mocks.mdx +++ b/api_docs/kbn_core_saved_objects_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-server-mocks title: "@kbn/core-saved-objects-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-server-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-server-mocks'] --- import kbnCoreSavedObjectsServerMocksObj from './kbn_core_saved_objects_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_saved_objects_utils_server.mdx b/api_docs/kbn_core_saved_objects_utils_server.mdx index b27f0e3aa63ab..f957b61828576 100644 --- a/api_docs/kbn_core_saved_objects_utils_server.mdx +++ b/api_docs/kbn_core_saved_objects_utils_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-utils-server title: "@kbn/core-saved-objects-utils-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-utils-server plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-utils-server'] --- import kbnCoreSavedObjectsUtilsServerObj from './kbn_core_saved_objects_utils_server.devdocs.json'; diff --git a/api_docs/kbn_core_status_common.mdx b/api_docs/kbn_core_status_common.mdx index 3b5e4b646b6fc..355edf1e29c07 100644 --- a/api_docs/kbn_core_status_common.mdx +++ b/api_docs/kbn_core_status_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-status-common title: "@kbn/core-status-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-status-common plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-status-common'] --- import kbnCoreStatusCommonObj from './kbn_core_status_common.devdocs.json'; diff --git a/api_docs/kbn_core_status_common_internal.mdx b/api_docs/kbn_core_status_common_internal.mdx index f7c73c872fcbb..237d538d2ce6e 100644 --- a/api_docs/kbn_core_status_common_internal.mdx +++ b/api_docs/kbn_core_status_common_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-status-common-internal title: "@kbn/core-status-common-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-status-common-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-status-common-internal'] --- import kbnCoreStatusCommonInternalObj from './kbn_core_status_common_internal.devdocs.json'; diff --git a/api_docs/kbn_core_status_server.mdx b/api_docs/kbn_core_status_server.mdx index 9d9a783ed469a..c80a61c528872 100644 --- a/api_docs/kbn_core_status_server.mdx +++ b/api_docs/kbn_core_status_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-status-server title: "@kbn/core-status-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-status-server plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-status-server'] --- import kbnCoreStatusServerObj from './kbn_core_status_server.devdocs.json'; diff --git a/api_docs/kbn_core_status_server_internal.mdx b/api_docs/kbn_core_status_server_internal.mdx index 70a7d567d87d2..2613155bcc245 100644 --- a/api_docs/kbn_core_status_server_internal.mdx +++ b/api_docs/kbn_core_status_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-status-server-internal title: "@kbn/core-status-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-status-server-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-status-server-internal'] --- import kbnCoreStatusServerInternalObj from './kbn_core_status_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_status_server_mocks.mdx b/api_docs/kbn_core_status_server_mocks.mdx index 6284e192e9745..4288c0ffd77f6 100644 --- a/api_docs/kbn_core_status_server_mocks.mdx +++ b/api_docs/kbn_core_status_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-status-server-mocks title: "@kbn/core-status-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-status-server-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-status-server-mocks'] --- import kbnCoreStatusServerMocksObj from './kbn_core_status_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_test_helpers_deprecations_getters.mdx b/api_docs/kbn_core_test_helpers_deprecations_getters.mdx index dd2e747e69100..9444e1124a67b 100644 --- a/api_docs/kbn_core_test_helpers_deprecations_getters.mdx +++ b/api_docs/kbn_core_test_helpers_deprecations_getters.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-test-helpers-deprecations-getters title: "@kbn/core-test-helpers-deprecations-getters" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-test-helpers-deprecations-getters plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-test-helpers-deprecations-getters'] --- import kbnCoreTestHelpersDeprecationsGettersObj from './kbn_core_test_helpers_deprecations_getters.devdocs.json'; diff --git a/api_docs/kbn_core_test_helpers_http_setup_browser.devdocs.json b/api_docs/kbn_core_test_helpers_http_setup_browser.devdocs.json index f60b10783ed6e..5d94094ad2028 100644 --- a/api_docs/kbn_core_test_helpers_http_setup_browser.devdocs.json +++ b/api_docs/kbn_core_test_helpers_http_setup_browser.devdocs.json @@ -123,13 +123,13 @@ "label": "injectedMetadata", "description": [], "signature": [ - "{ getBasePath: jest.MockInstance; getServerBasePath: jest.MockInstance; getPublicBaseUrl: jest.MockInstance; getKibanaBuildNumber: jest.MockInstance; getKibanaBranch: jest.MockInstance; getKibanaVersion: jest.MockInstance; getCspConfig: jest.MockInstance<{ warnLegacyBrowsers: boolean; }, []>; getExternalUrlConfig: jest.MockInstance<{ policy: ", + "{ getBasePath: jest.MockInstance; getServerBasePath: jest.MockInstance; getPublicBaseUrl: jest.MockInstance; getKibanaBuildNumber: jest.MockInstance; getKibanaBranch: jest.MockInstance; getKibanaVersion: jest.MockInstance; getCspConfig: jest.MockInstance<{ warnLegacyBrowsers: boolean; }, [], unknown>; getExternalUrlConfig: jest.MockInstance<{ policy: ", "InjectedMetadataExternalUrlPolicy", - "[]; }, []>; getTheme: jest.MockInstance<{ darkMode: boolean; version: \"v8\"; }, []>; getElasticsearchInfo: jest.MockInstance<", + "[]; }, [], unknown>; getTheme: jest.MockInstance<{ darkMode: boolean; version: \"v8\"; }, [], unknown>; getElasticsearchInfo: jest.MockInstance<", "InjectedMetadataClusterInfo", - ", []>; getPlugins: jest.MockInstance<", + ", [], unknown>; getPlugins: jest.MockInstance<", "InjectedMetadataPlugin", - "[], []>; getAnonymousStatusPage: jest.MockInstance; getLegacyMetadata: jest.MockInstance<{ uiSettings: { defaults: Record; user?: Record | undefined; }; globalUiSettings: { defaults: Record; user?: Record | undefined; }; }, []>; getInjectedVar: jest.MockInstance; getInjectedVars: jest.MockInstance<{ [key: string]: unknown; }, []>; getCustomBranding: jest.MockInstance<", + "[], [], unknown>; getAnonymousStatusPage: jest.MockInstance; getLegacyMetadata: jest.MockInstance<{ uiSettings: { defaults: Record; user?: Record | undefined; }; globalUiSettings: { defaults: Record; user?: Record | undefined; }; }, [], unknown>; getInjectedVar: jest.MockInstance; getInjectedVars: jest.MockInstance<{ [key: string]: unknown; }, [], unknown>; getCustomBranding: jest.MockInstance<", { "pluginId": "@kbn/core-custom-branding-common", "scope": "common", @@ -137,7 +137,7 @@ "section": "def-common.CustomBranding", "text": "CustomBranding" }, - ", []>; } & ", + ", [], unknown>; } & ", "InternalInjectedMetadataSetup" ], "path": "packages/core/test-helpers/core-test-helpers-http-setup-browser/src/http_test_setup.ts", @@ -152,7 +152,7 @@ "label": "fatalErrors", "description": [], "signature": [ - "{ add: jest.MockInstance; get$: jest.MockInstance<", + "{ add: jest.MockInstance; get$: jest.MockInstance<", "Observable", "<", { @@ -162,7 +162,7 @@ "section": "def-common.FatalErrorInfo", "text": "FatalErrorInfo" }, - ">, []>; } & ", + ">, [], unknown>; } & ", { "pluginId": "@kbn/core-fatal-errors-browser", "scope": "common", diff --git a/api_docs/kbn_core_test_helpers_http_setup_browser.mdx b/api_docs/kbn_core_test_helpers_http_setup_browser.mdx index 7226da9ff1194..ee571ceecb91f 100644 --- a/api_docs/kbn_core_test_helpers_http_setup_browser.mdx +++ b/api_docs/kbn_core_test_helpers_http_setup_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-test-helpers-http-setup-browser title: "@kbn/core-test-helpers-http-setup-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-test-helpers-http-setup-browser plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-test-helpers-http-setup-browser'] --- import kbnCoreTestHelpersHttpSetupBrowserObj from './kbn_core_test_helpers_http_setup_browser.devdocs.json'; diff --git a/api_docs/kbn_core_test_helpers_kbn_server.mdx b/api_docs/kbn_core_test_helpers_kbn_server.mdx index 402053b2511c1..abcbfddf6f596 100644 --- a/api_docs/kbn_core_test_helpers_kbn_server.mdx +++ b/api_docs/kbn_core_test_helpers_kbn_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-test-helpers-kbn-server title: "@kbn/core-test-helpers-kbn-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-test-helpers-kbn-server plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-test-helpers-kbn-server'] --- import kbnCoreTestHelpersKbnServerObj from './kbn_core_test_helpers_kbn_server.devdocs.json'; diff --git a/api_docs/kbn_core_test_helpers_so_type_serializer.mdx b/api_docs/kbn_core_test_helpers_so_type_serializer.mdx index f98e734ba0c85..4b44ed4b7fe77 100644 --- a/api_docs/kbn_core_test_helpers_so_type_serializer.mdx +++ b/api_docs/kbn_core_test_helpers_so_type_serializer.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-test-helpers-so-type-serializer title: "@kbn/core-test-helpers-so-type-serializer" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-test-helpers-so-type-serializer plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-test-helpers-so-type-serializer'] --- import kbnCoreTestHelpersSoTypeSerializerObj from './kbn_core_test_helpers_so_type_serializer.devdocs.json'; diff --git a/api_docs/kbn_core_test_helpers_test_utils.mdx b/api_docs/kbn_core_test_helpers_test_utils.mdx index 316731894ec08..21c8a955efc5d 100644 --- a/api_docs/kbn_core_test_helpers_test_utils.mdx +++ b/api_docs/kbn_core_test_helpers_test_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-test-helpers-test-utils title: "@kbn/core-test-helpers-test-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-test-helpers-test-utils plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-test-helpers-test-utils'] --- import kbnCoreTestHelpersTestUtilsObj from './kbn_core_test_helpers_test_utils.devdocs.json'; diff --git a/api_docs/kbn_core_theme_browser.mdx b/api_docs/kbn_core_theme_browser.mdx index ef96520cd8d06..b95d010d290b0 100644 --- a/api_docs/kbn_core_theme_browser.mdx +++ b/api_docs/kbn_core_theme_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-theme-browser title: "@kbn/core-theme-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-theme-browser plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-theme-browser'] --- import kbnCoreThemeBrowserObj from './kbn_core_theme_browser.devdocs.json'; diff --git a/api_docs/kbn_core_theme_browser_internal.mdx b/api_docs/kbn_core_theme_browser_internal.mdx index d035a28221fba..1fc1c1b56f557 100644 --- a/api_docs/kbn_core_theme_browser_internal.mdx +++ b/api_docs/kbn_core_theme_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-theme-browser-internal title: "@kbn/core-theme-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-theme-browser-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-theme-browser-internal'] --- import kbnCoreThemeBrowserInternalObj from './kbn_core_theme_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_theme_browser_mocks.mdx b/api_docs/kbn_core_theme_browser_mocks.mdx index 29dbacf9025ca..1a4741f73b9cf 100644 --- a/api_docs/kbn_core_theme_browser_mocks.mdx +++ b/api_docs/kbn_core_theme_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-theme-browser-mocks title: "@kbn/core-theme-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-theme-browser-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-theme-browser-mocks'] --- import kbnCoreThemeBrowserMocksObj from './kbn_core_theme_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_ui_settings_browser.mdx b/api_docs/kbn_core_ui_settings_browser.mdx index 9958562bd293e..1287ea986de1d 100644 --- a/api_docs/kbn_core_ui_settings_browser.mdx +++ b/api_docs/kbn_core_ui_settings_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-browser title: "@kbn/core-ui-settings-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-ui-settings-browser plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-ui-settings-browser'] --- import kbnCoreUiSettingsBrowserObj from './kbn_core_ui_settings_browser.devdocs.json'; diff --git a/api_docs/kbn_core_ui_settings_browser_internal.mdx b/api_docs/kbn_core_ui_settings_browser_internal.mdx index 1585fc6f5b346..cd52f7ecfcf24 100644 --- a/api_docs/kbn_core_ui_settings_browser_internal.mdx +++ b/api_docs/kbn_core_ui_settings_browser_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-browser-internal title: "@kbn/core-ui-settings-browser-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-ui-settings-browser-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-ui-settings-browser-internal'] --- import kbnCoreUiSettingsBrowserInternalObj from './kbn_core_ui_settings_browser_internal.devdocs.json'; diff --git a/api_docs/kbn_core_ui_settings_browser_mocks.mdx b/api_docs/kbn_core_ui_settings_browser_mocks.mdx index 7c938bf838fff..7097674f04f71 100644 --- a/api_docs/kbn_core_ui_settings_browser_mocks.mdx +++ b/api_docs/kbn_core_ui_settings_browser_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-browser-mocks title: "@kbn/core-ui-settings-browser-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-ui-settings-browser-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-ui-settings-browser-mocks'] --- import kbnCoreUiSettingsBrowserMocksObj from './kbn_core_ui_settings_browser_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_ui_settings_common.mdx b/api_docs/kbn_core_ui_settings_common.mdx index cb415dedcf87c..fd600b2c0a471 100644 --- a/api_docs/kbn_core_ui_settings_common.mdx +++ b/api_docs/kbn_core_ui_settings_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-common title: "@kbn/core-ui-settings-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-ui-settings-common plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-ui-settings-common'] --- import kbnCoreUiSettingsCommonObj from './kbn_core_ui_settings_common.devdocs.json'; diff --git a/api_docs/kbn_core_ui_settings_server.mdx b/api_docs/kbn_core_ui_settings_server.mdx index 3c5b615232c94..29a0c7ab39160 100644 --- a/api_docs/kbn_core_ui_settings_server.mdx +++ b/api_docs/kbn_core_ui_settings_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-server title: "@kbn/core-ui-settings-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-ui-settings-server plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-ui-settings-server'] --- import kbnCoreUiSettingsServerObj from './kbn_core_ui_settings_server.devdocs.json'; diff --git a/api_docs/kbn_core_ui_settings_server_internal.devdocs.json b/api_docs/kbn_core_ui_settings_server_internal.devdocs.json index 51a298f3e4469..19b0355b0870b 100644 --- a/api_docs/kbn_core_ui_settings_server_internal.devdocs.json +++ b/api_docs/kbn_core_ui_settings_server_internal.devdocs.json @@ -298,7 +298,15 @@ "section": "def-common.ObjectType", "text": "ObjectType" }, - "<{}>; }>" + "<{}>; publicApiEnabled: ", + { + "pluginId": "@kbn/config-schema", + "scope": "common", + "docId": "kibKbnConfigSchemaPluginApi", + "section": "def-common.ConditionalType", + "text": "ConditionalType" + }, + "; }>" ], "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_config.ts", "deprecated": false, diff --git a/api_docs/kbn_core_ui_settings_server_internal.mdx b/api_docs/kbn_core_ui_settings_server_internal.mdx index 42330a3b90e20..dd5255e30efaf 100644 --- a/api_docs/kbn_core_ui_settings_server_internal.mdx +++ b/api_docs/kbn_core_ui_settings_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-server-internal title: "@kbn/core-ui-settings-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-ui-settings-server-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-ui-settings-server-internal'] --- import kbnCoreUiSettingsServerInternalObj from './kbn_core_ui_settings_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_ui_settings_server_mocks.mdx b/api_docs/kbn_core_ui_settings_server_mocks.mdx index fb6d27268c6c0..067a7c5cec6a3 100644 --- a/api_docs/kbn_core_ui_settings_server_mocks.mdx +++ b/api_docs/kbn_core_ui_settings_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-server-mocks title: "@kbn/core-ui-settings-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-ui-settings-server-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-ui-settings-server-mocks'] --- import kbnCoreUiSettingsServerMocksObj from './kbn_core_ui_settings_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_usage_data_server.mdx b/api_docs/kbn_core_usage_data_server.mdx index eac2398eadf85..9581b7f3d8767 100644 --- a/api_docs/kbn_core_usage_data_server.mdx +++ b/api_docs/kbn_core_usage_data_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-usage-data-server title: "@kbn/core-usage-data-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-usage-data-server plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-usage-data-server'] --- import kbnCoreUsageDataServerObj from './kbn_core_usage_data_server.devdocs.json'; diff --git a/api_docs/kbn_core_usage_data_server_internal.mdx b/api_docs/kbn_core_usage_data_server_internal.mdx index 487c8d6b6978a..5b60676eb0be9 100644 --- a/api_docs/kbn_core_usage_data_server_internal.mdx +++ b/api_docs/kbn_core_usage_data_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-usage-data-server-internal title: "@kbn/core-usage-data-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-usage-data-server-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-usage-data-server-internal'] --- import kbnCoreUsageDataServerInternalObj from './kbn_core_usage_data_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_usage_data_server_mocks.devdocs.json b/api_docs/kbn_core_usage_data_server_mocks.devdocs.json index 161e578a32ed5..b96ca62e45b33 100644 --- a/api_docs/kbn_core_usage_data_server_mocks.devdocs.json +++ b/api_docs/kbn_core_usage_data_server_mocks.devdocs.json @@ -101,39 +101,39 @@ "section": "def-common.CoreUsageStats", "text": "CoreUsageStats" }, - ">, []>; incrementSavedObjectsBulkCreate: jest.MockInstance, [options: ", + ">, [], unknown>; incrementSavedObjectsBulkCreate: jest.MockInstance, [options: ", "BaseIncrementOptions", - "]>; incrementSavedObjectsBulkGet: jest.MockInstance, [options: ", + "], unknown>; incrementSavedObjectsBulkGet: jest.MockInstance, [options: ", "BaseIncrementOptions", - "]>; incrementSavedObjectsBulkResolve: jest.MockInstance, [options: ", + "], unknown>; incrementSavedObjectsBulkResolve: jest.MockInstance, [options: ", "BaseIncrementOptions", - "]>; incrementSavedObjectsBulkUpdate: jest.MockInstance, [options: ", + "], unknown>; incrementSavedObjectsBulkUpdate: jest.MockInstance, [options: ", "BaseIncrementOptions", - "]>; incrementSavedObjectsBulkDelete: jest.MockInstance, [options: ", + "], unknown>; incrementSavedObjectsBulkDelete: jest.MockInstance, [options: ", "BaseIncrementOptions", - "]>; incrementSavedObjectsCreate: jest.MockInstance, [options: ", + "], unknown>; incrementSavedObjectsCreate: jest.MockInstance, [options: ", "BaseIncrementOptions", - "]>; incrementSavedObjectsDelete: jest.MockInstance, [options: ", + "], unknown>; incrementSavedObjectsDelete: jest.MockInstance, [options: ", "BaseIncrementOptions", - "]>; incrementSavedObjectsFind: jest.MockInstance, [options: ", + "], unknown>; incrementSavedObjectsFind: jest.MockInstance, [options: ", "BaseIncrementOptions", - "]>; incrementSavedObjectsGet: jest.MockInstance, [options: ", + "], unknown>; incrementSavedObjectsGet: jest.MockInstance, [options: ", "BaseIncrementOptions", - "]>; incrementSavedObjectsResolve: jest.MockInstance, [options: ", + "], unknown>; incrementSavedObjectsResolve: jest.MockInstance, [options: ", "BaseIncrementOptions", - "]>; incrementSavedObjectsUpdate: jest.MockInstance, [options: ", + "], unknown>; incrementSavedObjectsUpdate: jest.MockInstance, [options: ", "BaseIncrementOptions", - "]>; incrementSavedObjectsImport: jest.MockInstance, [options: ", + "], unknown>; incrementSavedObjectsImport: jest.MockInstance, [options: ", "IncrementSavedObjectsImportOptions", - "]>; incrementSavedObjectsResolveImportErrors: jest.MockInstance, [options: ", + "], unknown>; incrementSavedObjectsResolveImportErrors: jest.MockInstance, [options: ", "IncrementSavedObjectsResolveImportErrorsOptions", - "]>; incrementSavedObjectsExport: jest.MockInstance, [options: ", + "], unknown>; incrementSavedObjectsExport: jest.MockInstance, [options: ", "IncrementSavedObjectsExportOptions", - "]>; incrementLegacyDashboardsImport: jest.MockInstance, [options: ", + "], unknown>; incrementLegacyDashboardsImport: jest.MockInstance, [options: ", "BaseIncrementOptions", - "]>; incrementLegacyDashboardsExport: jest.MockInstance, [options: ", + "], unknown>; incrementLegacyDashboardsExport: jest.MockInstance, [options: ", "BaseIncrementOptions", - "]>; } & ", + "], unknown>; } & ", "ICoreUsageStatsClient" ], "path": "packages/core/usage-data/core-usage-data-server-mocks/src/core_usage_data_service.mock.ts", diff --git a/api_docs/kbn_core_usage_data_server_mocks.mdx b/api_docs/kbn_core_usage_data_server_mocks.mdx index 4b9acc72dd408..5d7436130218d 100644 --- a/api_docs/kbn_core_usage_data_server_mocks.mdx +++ b/api_docs/kbn_core_usage_data_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-usage-data-server-mocks title: "@kbn/core-usage-data-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-usage-data-server-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-usage-data-server-mocks'] --- import kbnCoreUsageDataServerMocksObj from './kbn_core_usage_data_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_core_user_settings_server.mdx b/api_docs/kbn_core_user_settings_server.mdx index ec6c2e36f8287..e7127a60cbe85 100644 --- a/api_docs/kbn_core_user_settings_server.mdx +++ b/api_docs/kbn_core_user_settings_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-user-settings-server title: "@kbn/core-user-settings-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-user-settings-server plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-user-settings-server'] --- import kbnCoreUserSettingsServerObj from './kbn_core_user_settings_server.devdocs.json'; diff --git a/api_docs/kbn_core_user_settings_server_internal.mdx b/api_docs/kbn_core_user_settings_server_internal.mdx index 9afe2e777c398..175d79ec9b2f3 100644 --- a/api_docs/kbn_core_user_settings_server_internal.mdx +++ b/api_docs/kbn_core_user_settings_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-user-settings-server-internal title: "@kbn/core-user-settings-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-user-settings-server-internal plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-user-settings-server-internal'] --- import kbnCoreUserSettingsServerInternalObj from './kbn_core_user_settings_server_internal.devdocs.json'; diff --git a/api_docs/kbn_core_user_settings_server_mocks.devdocs.json b/api_docs/kbn_core_user_settings_server_mocks.devdocs.json index 08b7ea7d803fe..3b10d96b110bf 100644 --- a/api_docs/kbn_core_user_settings_server_mocks.devdocs.json +++ b/api_docs/kbn_core_user_settings_server_mocks.devdocs.json @@ -66,7 +66,7 @@ "label": "createSetupContract", "description": [], "signature": [ - "() => { setUserProfileSettings: jest.Mock; getUserSettingDarkMode: jest.Mock; }" + "() => { setUserProfileSettings: jest.Mock; getUserSettingDarkMode: jest.Mock; }" ], "path": "packages/core/user-settings/core-user-settings-server-mocks/src/user_settings_service.mock.ts", "deprecated": false, diff --git a/api_docs/kbn_core_user_settings_server_mocks.mdx b/api_docs/kbn_core_user_settings_server_mocks.mdx index 9a16b292e90a7..d6718649f5289 100644 --- a/api_docs/kbn_core_user_settings_server_mocks.mdx +++ b/api_docs/kbn_core_user_settings_server_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-user-settings-server-mocks title: "@kbn/core-user-settings-server-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-user-settings-server-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-user-settings-server-mocks'] --- import kbnCoreUserSettingsServerMocksObj from './kbn_core_user_settings_server_mocks.devdocs.json'; diff --git a/api_docs/kbn_crypto.mdx b/api_docs/kbn_crypto.mdx index 34e611ff5a4c8..2d4afe8a833a1 100644 --- a/api_docs/kbn_crypto.mdx +++ b/api_docs/kbn_crypto.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-crypto title: "@kbn/crypto" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/crypto plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/crypto'] --- import kbnCryptoObj from './kbn_crypto.devdocs.json'; diff --git a/api_docs/kbn_crypto_browser.mdx b/api_docs/kbn_crypto_browser.mdx index 9a5b0dbb7c957..25e8140375912 100644 --- a/api_docs/kbn_crypto_browser.mdx +++ b/api_docs/kbn_crypto_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-crypto-browser title: "@kbn/crypto-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/crypto-browser plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/crypto-browser'] --- import kbnCryptoBrowserObj from './kbn_crypto_browser.devdocs.json'; diff --git a/api_docs/kbn_cypress_config.mdx b/api_docs/kbn_cypress_config.mdx index cc4126bb50c06..f8f0e7cc4a4a6 100644 --- a/api_docs/kbn_cypress_config.mdx +++ b/api_docs/kbn_cypress_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-cypress-config title: "@kbn/cypress-config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/cypress-config plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cypress-config'] --- import kbnCypressConfigObj from './kbn_cypress_config.devdocs.json'; diff --git a/api_docs/kbn_data_service.mdx b/api_docs/kbn_data_service.mdx index 6a25144310430..573a7934b5ba1 100644 --- a/api_docs/kbn_data_service.mdx +++ b/api_docs/kbn_data_service.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-data-service title: "@kbn/data-service" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/data-service plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/data-service'] --- import kbnDataServiceObj from './kbn_data_service.devdocs.json'; diff --git a/api_docs/kbn_datemath.mdx b/api_docs/kbn_datemath.mdx index 73accf99299ce..bd87dd8e5ac30 100644 --- a/api_docs/kbn_datemath.mdx +++ b/api_docs/kbn_datemath.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-datemath title: "@kbn/datemath" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/datemath plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/datemath'] --- import kbnDatemathObj from './kbn_datemath.devdocs.json'; diff --git a/api_docs/kbn_deeplinks_analytics.mdx b/api_docs/kbn_deeplinks_analytics.mdx index f2eee176558d2..804c4b8768e1b 100644 --- a/api_docs/kbn_deeplinks_analytics.mdx +++ b/api_docs/kbn_deeplinks_analytics.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-deeplinks-analytics title: "@kbn/deeplinks-analytics" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/deeplinks-analytics plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/deeplinks-analytics'] --- import kbnDeeplinksAnalyticsObj from './kbn_deeplinks_analytics.devdocs.json'; diff --git a/api_docs/kbn_deeplinks_devtools.mdx b/api_docs/kbn_deeplinks_devtools.mdx index bcb83d34a64f9..39bf326843f73 100644 --- a/api_docs/kbn_deeplinks_devtools.mdx +++ b/api_docs/kbn_deeplinks_devtools.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-deeplinks-devtools title: "@kbn/deeplinks-devtools" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/deeplinks-devtools plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/deeplinks-devtools'] --- import kbnDeeplinksDevtoolsObj from './kbn_deeplinks_devtools.devdocs.json'; diff --git a/api_docs/kbn_deeplinks_management.mdx b/api_docs/kbn_deeplinks_management.mdx index cb5b653560357..307b10e706bcd 100644 --- a/api_docs/kbn_deeplinks_management.mdx +++ b/api_docs/kbn_deeplinks_management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-deeplinks-management title: "@kbn/deeplinks-management" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/deeplinks-management plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/deeplinks-management'] --- import kbnDeeplinksManagementObj from './kbn_deeplinks_management.devdocs.json'; diff --git a/api_docs/kbn_deeplinks_ml.devdocs.json b/api_docs/kbn_deeplinks_ml.devdocs.json index cece82529cc09..f18294ad8a5be 100644 --- a/api_docs/kbn_deeplinks_ml.devdocs.json +++ b/api_docs/kbn_deeplinks_ml.devdocs.json @@ -45,7 +45,7 @@ "label": "DeepLinkId", "description": [], "signature": [ - "\"ml\" | \"ml:nodes\" | \"ml:notifications\" | \"ml:overview\" | \"ml:settings\" | \"ml:dataVisualizer\" | \"ml:anomalyDetection\" | \"ml:anomalyExplorer\" | \"ml:singleMetricViewer\" | \"ml:dataFrameAnalytics\" | \"ml:resultExplorer\" | \"ml:analyticsMap\" | \"ml:aiOps\" | \"ml:explainLogRateSpikes\" | \"ml:logPatternAnalysis\" | \"ml:changePointDetections\" | \"ml:modelManagement\" | \"ml:nodesOverview\" | \"ml:memoryUsage\" | \"ml:fileUpload\" | \"ml:indexDataVisualizer\" | \"ml:calendarSettings\" | \"ml:filterListsSettings\"" + "\"ml\" | \"ml:nodes\" | \"ml:notifications\" | \"ml:overview\" | \"ml:settings\" | \"ml:dataVisualizer\" | \"ml:anomalyDetection\" | \"ml:anomalyExplorer\" | \"ml:singleMetricViewer\" | \"ml:dataFrameAnalytics\" | \"ml:resultExplorer\" | \"ml:analyticsMap\" | \"ml:aiOps\" | \"ml:logRateAnalysis\" | \"ml:logPatternAnalysis\" | \"ml:changePointDetections\" | \"ml:modelManagement\" | \"ml:nodesOverview\" | \"ml:memoryUsage\" | \"ml:fileUpload\" | \"ml:indexDataVisualizer\" | \"ml:calendarSettings\" | \"ml:filterListsSettings\"" ], "path": "packages/deeplinks/ml/deep_links.ts", "deprecated": false, @@ -60,7 +60,7 @@ "label": "LinkId", "description": [], "signature": [ - "\"nodes\" | \"notifications\" | \"overview\" | \"settings\" | \"dataVisualizer\" | \"anomalyDetection\" | \"anomalyExplorer\" | \"singleMetricViewer\" | \"dataFrameAnalytics\" | \"resultExplorer\" | \"analyticsMap\" | \"aiOps\" | \"explainLogRateSpikes\" | \"logPatternAnalysis\" | \"changePointDetections\" | \"modelManagement\" | \"nodesOverview\" | \"memoryUsage\" | \"fileUpload\" | \"indexDataVisualizer\" | \"calendarSettings\" | \"filterListsSettings\"" + "\"nodes\" | \"notifications\" | \"overview\" | \"settings\" | \"dataVisualizer\" | \"anomalyDetection\" | \"anomalyExplorer\" | \"singleMetricViewer\" | \"dataFrameAnalytics\" | \"resultExplorer\" | \"analyticsMap\" | \"aiOps\" | \"logRateAnalysis\" | \"logPatternAnalysis\" | \"changePointDetections\" | \"modelManagement\" | \"nodesOverview\" | \"memoryUsage\" | \"fileUpload\" | \"indexDataVisualizer\" | \"calendarSettings\" | \"filterListsSettings\"" ], "path": "packages/deeplinks/ml/deep_links.ts", "deprecated": false, diff --git a/api_docs/kbn_deeplinks_ml.mdx b/api_docs/kbn_deeplinks_ml.mdx index 67eecc850f3df..4703d778b3119 100644 --- a/api_docs/kbn_deeplinks_ml.mdx +++ b/api_docs/kbn_deeplinks_ml.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-deeplinks-ml title: "@kbn/deeplinks-ml" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/deeplinks-ml plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/deeplinks-ml'] --- import kbnDeeplinksMlObj from './kbn_deeplinks_ml.devdocs.json'; diff --git a/api_docs/kbn_deeplinks_observability.mdx b/api_docs/kbn_deeplinks_observability.mdx index a1eab7d606d3f..ca5dc7a224ecc 100644 --- a/api_docs/kbn_deeplinks_observability.mdx +++ b/api_docs/kbn_deeplinks_observability.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-deeplinks-observability title: "@kbn/deeplinks-observability" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/deeplinks-observability plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/deeplinks-observability'] --- import kbnDeeplinksObservabilityObj from './kbn_deeplinks_observability.devdocs.json'; diff --git a/api_docs/kbn_deeplinks_search.mdx b/api_docs/kbn_deeplinks_search.mdx index 71f3b0309537b..1f7375d850a05 100644 --- a/api_docs/kbn_deeplinks_search.mdx +++ b/api_docs/kbn_deeplinks_search.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-deeplinks-search title: "@kbn/deeplinks-search" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/deeplinks-search plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/deeplinks-search'] --- import kbnDeeplinksSearchObj from './kbn_deeplinks_search.devdocs.json'; diff --git a/api_docs/kbn_default_nav_analytics.mdx b/api_docs/kbn_default_nav_analytics.mdx index ee131463e91dc..614db193b8ace 100644 --- a/api_docs/kbn_default_nav_analytics.mdx +++ b/api_docs/kbn_default_nav_analytics.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-default-nav-analytics title: "@kbn/default-nav-analytics" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/default-nav-analytics plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/default-nav-analytics'] --- import kbnDefaultNavAnalyticsObj from './kbn_default_nav_analytics.devdocs.json'; diff --git a/api_docs/kbn_default_nav_devtools.mdx b/api_docs/kbn_default_nav_devtools.mdx index 62537fe4c1834..0bc14f4f6673c 100644 --- a/api_docs/kbn_default_nav_devtools.mdx +++ b/api_docs/kbn_default_nav_devtools.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-default-nav-devtools title: "@kbn/default-nav-devtools" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/default-nav-devtools plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/default-nav-devtools'] --- import kbnDefaultNavDevtoolsObj from './kbn_default_nav_devtools.devdocs.json'; diff --git a/api_docs/kbn_default_nav_management.mdx b/api_docs/kbn_default_nav_management.mdx index 530013cafb912..e4879a1b037fd 100644 --- a/api_docs/kbn_default_nav_management.mdx +++ b/api_docs/kbn_default_nav_management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-default-nav-management title: "@kbn/default-nav-management" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/default-nav-management plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/default-nav-management'] --- import kbnDefaultNavManagementObj from './kbn_default_nav_management.devdocs.json'; diff --git a/api_docs/kbn_default_nav_ml.devdocs.json b/api_docs/kbn_default_nav_ml.devdocs.json index ef16da2dd9b34..7c79c7686c12f 100644 --- a/api_docs/kbn_default_nav_ml.devdocs.json +++ b/api_docs/kbn_default_nav_ml.devdocs.json @@ -175,7 +175,7 @@ "label": "children", "description": [], "signature": [ - "[{ title: string; id: \"root\"; children: [{ link: \"ml:overview\"; }, { link: \"ml:notifications\"; }]; }, { title: any; id: \"anomaly_detection\"; children: [{ title: any; link: \"ml:anomalyDetection\"; }, { link: \"ml:anomalyExplorer\"; }, { link: \"ml:singleMetricViewer\"; }, { link: \"ml:settings\"; }]; }, { id: \"data_frame_analytics\"; title: any; children: [{ title: string; link: \"ml:dataFrameAnalytics\"; }, { link: \"ml:resultExplorer\"; }, { link: \"ml:analyticsMap\"; }]; }, { id: \"model_management\"; title: any; children: [{ link: \"ml:nodesOverview\"; }, { link: \"ml:nodes\"; }]; }, { id: \"data_visualizer\"; title: any; children: [{ title: any; link: \"ml:fileUpload\"; }, { title: any; link: \"ml:indexDataVisualizer\"; }]; }, { id: \"aiops_labs\"; title: any; children: [{ link: \"ml:explainLogRateSpikes\"; }, { link: \"ml:logPatternAnalysis\"; }, { link: \"ml:changePointDetections\"; }]; }]" + "[{ title: string; id: \"root\"; children: [{ link: \"ml:overview\"; }, { link: \"ml:notifications\"; }]; }, { title: any; id: \"anomaly_detection\"; children: [{ title: any; link: \"ml:anomalyDetection\"; }, { link: \"ml:anomalyExplorer\"; }, { link: \"ml:singleMetricViewer\"; }, { link: \"ml:settings\"; }]; }, { id: \"data_frame_analytics\"; title: any; children: [{ title: string; link: \"ml:dataFrameAnalytics\"; }, { link: \"ml:resultExplorer\"; }, { link: \"ml:analyticsMap\"; }]; }, { id: \"model_management\"; title: any; children: [{ link: \"ml:nodesOverview\"; }, { link: \"ml:nodes\"; }]; }, { id: \"data_visualizer\"; title: any; children: [{ title: any; link: \"ml:fileUpload\"; }, { title: any; link: \"ml:indexDataVisualizer\"; }]; }, { id: \"aiops_labs\"; title: any; children: [{ link: \"ml:logRateAnalysis\"; }, { link: \"ml:logPatternAnalysis\"; }, { link: \"ml:changePointDetections\"; }]; }]" ], "path": "packages/default-nav/ml/default_navigation.ts", "deprecated": false, diff --git a/api_docs/kbn_default_nav_ml.mdx b/api_docs/kbn_default_nav_ml.mdx index 1395e842f88d8..58858e3c579e8 100644 --- a/api_docs/kbn_default_nav_ml.mdx +++ b/api_docs/kbn_default_nav_ml.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-default-nav-ml title: "@kbn/default-nav-ml" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/default-nav-ml plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/default-nav-ml'] --- import kbnDefaultNavMlObj from './kbn_default_nav_ml.devdocs.json'; diff --git a/api_docs/kbn_dev_cli_errors.mdx b/api_docs/kbn_dev_cli_errors.mdx index 859fd3ebb15dd..6fc76897de2e3 100644 --- a/api_docs/kbn_dev_cli_errors.mdx +++ b/api_docs/kbn_dev_cli_errors.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-dev-cli-errors title: "@kbn/dev-cli-errors" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/dev-cli-errors plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-cli-errors'] --- import kbnDevCliErrorsObj from './kbn_dev_cli_errors.devdocs.json'; diff --git a/api_docs/kbn_dev_cli_runner.mdx b/api_docs/kbn_dev_cli_runner.mdx index bd9cc94a57032..f77d9bd224784 100644 --- a/api_docs/kbn_dev_cli_runner.mdx +++ b/api_docs/kbn_dev_cli_runner.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-dev-cli-runner title: "@kbn/dev-cli-runner" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/dev-cli-runner plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-cli-runner'] --- import kbnDevCliRunnerObj from './kbn_dev_cli_runner.devdocs.json'; diff --git a/api_docs/kbn_dev_proc_runner.mdx b/api_docs/kbn_dev_proc_runner.mdx index c6a7ae588b82f..dd0f1d4b22d53 100644 --- a/api_docs/kbn_dev_proc_runner.mdx +++ b/api_docs/kbn_dev_proc_runner.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-dev-proc-runner title: "@kbn/dev-proc-runner" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/dev-proc-runner plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-proc-runner'] --- import kbnDevProcRunnerObj from './kbn_dev_proc_runner.devdocs.json'; diff --git a/api_docs/kbn_dev_utils.mdx b/api_docs/kbn_dev_utils.mdx index ab8a1e337faf9..8b0cf007f675f 100644 --- a/api_docs/kbn_dev_utils.mdx +++ b/api_docs/kbn_dev_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-dev-utils title: "@kbn/dev-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/dev-utils plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-utils'] --- import kbnDevUtilsObj from './kbn_dev_utils.devdocs.json'; diff --git a/api_docs/kbn_discover_utils.devdocs.json b/api_docs/kbn_discover_utils.devdocs.json new file mode 100644 index 0000000000000..c17b301887dad --- /dev/null +++ b/api_docs/kbn_discover_utils.devdocs.json @@ -0,0 +1,229 @@ +{ + "id": "@kbn/discover-utils", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/discover-utils", + "id": "def-common.buildDataTableRecord", + "type": "Function", + "tags": [], + "label": "buildDataTableRecord", + "description": [ + "\nBuild a record for data table, explorer + classic one" + ], + "signature": [ + "(doc: ", + "EsHitRecord", + ", dataView: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | undefined, isAnchor: boolean | undefined) => ", + "DataTableRecord" + ], + "path": "packages/kbn-discover-utils/src/utils/build_data_record.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/discover-utils", + "id": "def-common.buildDataTableRecord.$1", + "type": "Object", + "tags": [], + "label": "doc", + "description": [ + "the document returned from Elasticsearch" + ], + "signature": [ + "EsHitRecord" + ], + "path": "packages/kbn-discover-utils/src/utils/build_data_record.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/discover-utils", + "id": "def-common.buildDataTableRecord.$2", + "type": "Object", + "tags": [], + "label": "dataView", + "description": [ + "this current data view" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | undefined" + ], + "path": "packages/kbn-discover-utils/src/utils/build_data_record.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + }, + { + "parentPluginId": "@kbn/discover-utils", + "id": "def-common.buildDataTableRecord.$3", + "type": "CompoundType", + "tags": [], + "label": "isAnchor", + "description": [ + "determines if the given doc is the anchor doc when viewing surrounding documents" + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/kbn-discover-utils/src/utils/build_data_record.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/discover-utils", + "id": "def-common.buildDataTableRecordList", + "type": "Function", + "tags": [], + "label": "buildDataTableRecordList", + "description": [ + "\nHelper to build multiple DataTableRecords at once, saved a bit of testing code lines" + ], + "signature": [ + "(docs: ", + "EsHitRecord", + "[], dataView: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | undefined) => ", + "DataTableRecord", + "[]" + ], + "path": "packages/kbn-discover-utils/src/utils/build_data_record.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/discover-utils", + "id": "def-common.buildDataTableRecordList.$1", + "type": "Array", + "tags": [], + "label": "docs", + "description": [ + "Array of documents returned from Elasticsearch" + ], + "signature": [ + "EsHitRecord", + "[]" + ], + "path": "packages/kbn-discover-utils/src/utils/build_data_record.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/discover-utils", + "id": "def-common.buildDataTableRecordList.$2", + "type": "Object", + "tags": [], + "label": "dataView", + "description": [ + "this current data view" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + " | undefined" + ], + "path": "packages/kbn-discover-utils/src/utils/build_data_record.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/discover-utils", + "id": "def-common.getDocId", + "type": "Function", + "tags": [], + "label": "getDocId", + "description": [ + "\nReturning a generated id of a given ES document, since `_id` can be the same\nwhen using different indices and shard routing" + ], + "signature": [ + "(doc: ", + "EsHitRecord", + " & { _routing?: string | undefined; }) => string" + ], + "path": "packages/kbn-discover-utils/src/utils/get_doc_id.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/discover-utils", + "id": "def-common.getDocId.$1", + "type": "CompoundType", + "tags": [], + "label": "doc", + "description": [], + "signature": [ + "EsHitRecord", + " & { _routing?: string | undefined; }" + ], + "path": "packages/kbn-discover-utils/src/utils/get_doc_id.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_discover_utils.mdx b/api_docs/kbn_discover_utils.mdx new file mode 100644 index 0000000000000..c7861312017f3 --- /dev/null +++ b/api_docs/kbn_discover_utils.mdx @@ -0,0 +1,30 @@ +--- +#### +#### 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. +#### +id: kibKbnDiscoverUtilsPluginApi +slug: /kibana-dev-docs/api/kbn-discover-utils +title: "@kbn/discover-utils" +image: https://source.unsplash.com/400x175/?github +description: API docs for the @kbn/discover-utils plugin +date: 2023-07-20 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/discover-utils'] +--- +import kbnDiscoverUtilsObj from './kbn_discover_utils.devdocs.json'; + + + +Contact [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 9 | 0 | 1 | 2 | + +## Common + +### Functions + + diff --git a/api_docs/kbn_doc_links.mdx b/api_docs/kbn_doc_links.mdx index 954dd7d4166cc..5de676c6bddbb 100644 --- a/api_docs/kbn_doc_links.mdx +++ b/api_docs/kbn_doc_links.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-doc-links title: "@kbn/doc-links" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/doc-links plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/doc-links'] --- import kbnDocLinksObj from './kbn_doc_links.devdocs.json'; diff --git a/api_docs/kbn_docs_utils.mdx b/api_docs/kbn_docs_utils.mdx index 24771c25a64ea..bdbe42041fff5 100644 --- a/api_docs/kbn_docs_utils.mdx +++ b/api_docs/kbn_docs_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-docs-utils title: "@kbn/docs-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/docs-utils plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/docs-utils'] --- import kbnDocsUtilsObj from './kbn_docs_utils.devdocs.json'; diff --git a/api_docs/kbn_dom_drag_drop.mdx b/api_docs/kbn_dom_drag_drop.mdx index 0d7703dd0ad8b..65329f892f990 100644 --- a/api_docs/kbn_dom_drag_drop.mdx +++ b/api_docs/kbn_dom_drag_drop.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-dom-drag-drop title: "@kbn/dom-drag-drop" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/dom-drag-drop plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dom-drag-drop'] --- import kbnDomDragDropObj from './kbn_dom_drag_drop.devdocs.json'; diff --git a/api_docs/kbn_ebt_tools.mdx b/api_docs/kbn_ebt_tools.mdx index c6a477dc2e2b4..29c995e3de97b 100644 --- a/api_docs/kbn_ebt_tools.mdx +++ b/api_docs/kbn_ebt_tools.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ebt-tools title: "@kbn/ebt-tools" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ebt-tools plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ebt-tools'] --- import kbnEbtToolsObj from './kbn_ebt_tools.devdocs.json'; diff --git a/api_docs/kbn_ecs.mdx b/api_docs/kbn_ecs.mdx index 4b6d571c93f75..bca918865d85d 100644 --- a/api_docs/kbn_ecs.mdx +++ b/api_docs/kbn_ecs.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ecs title: "@kbn/ecs" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ecs plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ecs'] --- import kbnEcsObj from './kbn_ecs.devdocs.json'; diff --git a/api_docs/kbn_ecs_data_quality_dashboard.mdx b/api_docs/kbn_ecs_data_quality_dashboard.mdx index 0105733724ec9..ea6348d2cf5b4 100644 --- a/api_docs/kbn_ecs_data_quality_dashboard.mdx +++ b/api_docs/kbn_ecs_data_quality_dashboard.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ecs-data-quality-dashboard title: "@kbn/ecs-data-quality-dashboard" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ecs-data-quality-dashboard plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ecs-data-quality-dashboard'] --- import kbnEcsDataQualityDashboardObj from './kbn_ecs_data_quality_dashboard.devdocs.json'; diff --git a/api_docs/kbn_elastic_assistant.devdocs.json b/api_docs/kbn_elastic_assistant.devdocs.json index 3685f00b7b9b9..8e4208cecb509 100644 --- a/api_docs/kbn_elastic_assistant.devdocs.json +++ b/api_docs/kbn_elastic_assistant.devdocs.json @@ -897,6 +897,21 @@ ], "enums": [], "misc": [ + { + "parentPluginId": "@kbn/elastic-assistant", + "id": "def-public.ELASTIC_AI_ASSISTANT_TITLE", + "type": "Any", + "tags": [], + "label": "ELASTIC_AI_ASSISTANT_TITLE", + "description": [], + "signature": [ + "any" + ], + "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/translations.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "@kbn/elastic-assistant", "id": "def-public.PromptContextTemplate", @@ -928,292 +943,24 @@ "deprecated": false, "trackAdoption": false, "initialIsOpen": false - } - ], - "objects": [ + }, { "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS", - "type": "Object", + "id": "def-public.WELCOME_CONVERSATION_TITLE", + "type": "Any", "tags": [], - "label": "BASE_CONVERSATIONS", + "label": "WELCOME_CONVERSATION_TITLE", "description": [], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", + "signature": [ + "any" + ], + "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/translations.ts", "deprecated": false, "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.DEFAULT_CONVERSATION_TITLE", - "type": "Object", - "tags": [], - "label": "[DEFAULT_CONVERSATION_TITLE]", - "description": [], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.DEFAULT_CONVERSATION_TITLE.id", - "type": "Any", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "any" - ], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.DEFAULT_CONVERSATION_TITLE.messages", - "type": "Array", - "tags": [], - "label": "messages", - "description": [], - "signature": [ - "({ role: \"user\"; content: string; timestamp: string; } | { role: \"assistant\"; content: string; timestamp: string; })[]" - ], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.DEFAULT_CONVERSATION_TITLE.apiConfig", - "type": "Object", - "tags": [], - "label": "apiConfig", - "description": [], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [] - } - ] - }, - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.timeline", - "type": "Object", - "tags": [], - "label": "timeline", - "description": [], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.timeline.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.timeline.messages", - "type": "Array", - "tags": [], - "label": "messages", - "description": [], - "signature": [ - "never[]" - ], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.timeline.apiConfig", - "type": "Object", - "tags": [], - "label": "apiConfig", - "description": [], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [] - } - ] - }, - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.WELCOME_CONVERSATION_TITLE", - "type": "Object", - "tags": [], - "label": "[WELCOME_CONVERSATION_TITLE]", - "description": [], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.WELCOME_CONVERSATION_TITLE.id", - "type": "Any", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "any" - ], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.WELCOME_CONVERSATION_TITLE.theme", - "type": "Object", - "tags": [], - "label": "theme", - "description": [], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.WELCOME_CONVERSATION_TITLE.theme.title", - "type": "Any", - "tags": [], - "label": "title", - "description": [], - "signature": [ - "any" - ], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.WELCOME_CONVERSATION_TITLE.theme.titleIcon", - "type": "string", - "tags": [], - "label": "titleIcon", - "description": [], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.WELCOME_CONVERSATION_TITLE.theme.assistant", - "type": "Object", - "tags": [], - "label": "assistant", - "description": [], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.WELCOME_CONVERSATION_TITLE.theme.assistant.name", - "type": "Any", - "tags": [], - "label": "name", - "description": [], - "signature": [ - "any" - ], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.WELCOME_CONVERSATION_TITLE.theme.assistant.icon", - "type": "string", - "tags": [], - "label": "icon", - "description": [], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false - } - ] - }, - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.WELCOME_CONVERSATION_TITLE.theme.system", - "type": "Object", - "tags": [], - "label": "system", - "description": [], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.WELCOME_CONVERSATION_TITLE.theme.system.icon", - "type": "string", - "tags": [], - "label": "icon", - "description": [], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false - } - ] - }, - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.WELCOME_CONVERSATION_TITLE.theme.user", - "type": "Object", - "tags": [], - "label": "user", - "description": [], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [] - } - ] - }, - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.WELCOME_CONVERSATION_TITLE.messages", - "type": "Array", - "tags": [], - "label": "messages", - "description": [], - "signature": [ - "{ role: \"assistant\"; content: any; timestamp: string; presentation: { delay: number; stream: true; }; }[]" - ], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/elastic-assistant", - "id": "def-public.BASE_CONVERSATIONS.WELCOME_CONVERSATION_TITLE.apiConfig", - "type": "Object", - "tags": [], - "label": "apiConfig", - "description": [], - "path": "x-pack/packages/kbn-elastic-assistant/impl/assistant/use_conversation/sample_conversations.tsx", - "deprecated": false, - "trackAdoption": false, - "children": [] - } - ] - } - ], "initialIsOpen": false } - ] + ], + "objects": [] }, "server": { "classes": [], diff --git a/api_docs/kbn_elastic_assistant.mdx b/api_docs/kbn_elastic_assistant.mdx index 22de25998b737..add70b9f71594 100644 --- a/api_docs/kbn_elastic_assistant.mdx +++ b/api_docs/kbn_elastic_assistant.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-elastic-assistant title: "@kbn/elastic-assistant" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/elastic-assistant plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/elastic-assistant'] --- import kbnElasticAssistantObj from './kbn_elastic_assistant.devdocs.json'; @@ -21,13 +21,10 @@ Contact [@elastic/security-solution](https://github.com/orgs/elastic/teams/secur | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 84 | 4 | 65 | 3 | +| 64 | 2 | 45 | 3 | ## Client -### Objects - - ### Functions diff --git a/api_docs/kbn_es.mdx b/api_docs/kbn_es.mdx index b4728c59e9cb6..fc5b52ccfaed8 100644 --- a/api_docs/kbn_es.mdx +++ b/api_docs/kbn_es.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-es title: "@kbn/es" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/es plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es'] --- import kbnEsObj from './kbn_es.devdocs.json'; diff --git a/api_docs/kbn_es_archiver.mdx b/api_docs/kbn_es_archiver.mdx index d99444e6d694f..bb1bc533fc3bb 100644 --- a/api_docs/kbn_es_archiver.mdx +++ b/api_docs/kbn_es_archiver.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-es-archiver title: "@kbn/es-archiver" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/es-archiver plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-archiver'] --- import kbnEsArchiverObj from './kbn_es_archiver.devdocs.json'; diff --git a/api_docs/kbn_es_errors.mdx b/api_docs/kbn_es_errors.mdx index 3d94e2e2467dd..9174d6dd49205 100644 --- a/api_docs/kbn_es_errors.mdx +++ b/api_docs/kbn_es_errors.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-es-errors title: "@kbn/es-errors" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/es-errors plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-errors'] --- import kbnEsErrorsObj from './kbn_es_errors.devdocs.json'; diff --git a/api_docs/kbn_es_query.devdocs.json b/api_docs/kbn_es_query.devdocs.json index 960dfc1192653..bc53217d27e65 100644 --- a/api_docs/kbn_es_query.devdocs.json +++ b/api_docs/kbn_es_query.devdocs.json @@ -4036,6 +4036,55 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/es-query", + "id": "def-common.toKqlExpression", + "type": "Function", + "tags": [], + "label": "toKqlExpression", + "description": [ + "\nGiven a KQL AST node, generate the corresponding KQL expression." + ], + "signature": [ + "(node: ", + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.KueryNode", + "text": "KueryNode" + }, + ") => string" + ], + "path": "packages/kbn-es-query/src/kuery/ast/ast.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/es-query", + "id": "def-common.toKqlExpression.$1", + "type": "Object", + "tags": [], + "label": "node", + "description": [], + "signature": [ + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.KueryNode", + "text": "KueryNode" + } + ], + "path": "packages/kbn-es-query/src/kuery/ast/ast.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/es-query", "id": "def-common.uniqFilters", @@ -5295,62 +5344,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "@kbn/es-query", - "id": "def-common.FunctionTypeBuildNode", - "type": "Interface", - "tags": [], - "label": "FunctionTypeBuildNode", - "description": [], - "path": "packages/kbn-es-query/src/kuery/node_types/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/es-query", - "id": "def-common.FunctionTypeBuildNode.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"function\"" - ], - "path": "packages/kbn-es-query/src/kuery/node_types/types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/es-query", - "id": "def-common.FunctionTypeBuildNode.function", - "type": "CompoundType", - "tags": [], - "label": "function", - "description": [], - "signature": [ - "\"nested\" | \"exists\" | \"is\" | \"range\" | \"and\" | \"or\" | \"not\"" - ], - "path": "packages/kbn-es-query/src/kuery/node_types/types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/es-query", - "id": "def-common.FunctionTypeBuildNode.arguments", - "type": "Array", - "tags": [], - "label": "arguments", - "description": [], - "signature": [ - "any[]" - ], - "path": "packages/kbn-es-query/src/kuery/node_types/types.ts", - "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "@kbn/es-query", "id": "def-common.IFieldSubTypeMulti", diff --git a/api_docs/kbn_es_query.mdx b/api_docs/kbn_es_query.mdx index 4fdd9d9aa5892..6f821a7f1c051 100644 --- a/api_docs/kbn_es_query.mdx +++ b/api_docs/kbn_es_query.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-es-query title: "@kbn/es-query" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/es-query plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-query'] --- import kbnEsQueryObj from './kbn_es_query.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/k | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 255 | 1 | 197 | 15 | +| 253 | 1 | 194 | 15 | ## Common diff --git a/api_docs/kbn_es_types.mdx b/api_docs/kbn_es_types.mdx index 1801c44f0802a..330a6d7dee05e 100644 --- a/api_docs/kbn_es_types.mdx +++ b/api_docs/kbn_es_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-es-types title: "@kbn/es-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/es-types plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-types'] --- import kbnEsTypesObj from './kbn_es_types.devdocs.json'; diff --git a/api_docs/kbn_eslint_plugin_imports.mdx b/api_docs/kbn_eslint_plugin_imports.mdx index c3562691f4b59..2f42e4b386a45 100644 --- a/api_docs/kbn_eslint_plugin_imports.mdx +++ b/api_docs/kbn_eslint_plugin_imports.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-eslint-plugin-imports title: "@kbn/eslint-plugin-imports" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/eslint-plugin-imports plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/eslint-plugin-imports'] --- import kbnEslintPluginImportsObj from './kbn_eslint_plugin_imports.devdocs.json'; diff --git a/api_docs/kbn_event_annotation_common.devdocs.json b/api_docs/kbn_event_annotation_common.devdocs.json new file mode 100644 index 0000000000000..53af5d26f6862 --- /dev/null +++ b/api_docs/kbn_event_annotation_common.devdocs.json @@ -0,0 +1,820 @@ +{ + "id": "@kbn/event-annotation-common", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.createCopiedAnnotation", + "type": "Function", + "tags": [], + "label": "createCopiedAnnotation", + "description": [], + "signature": [ + "(newId: string, timestamp: string, source?: ", + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.EventAnnotationConfig", + "text": "EventAnnotationConfig" + }, + " | undefined) => ", + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.EventAnnotationConfig", + "text": "EventAnnotationConfig" + } + ], + "path": "packages/kbn-event-annotation-common/util.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.createCopiedAnnotation.$1", + "type": "string", + "tags": [], + "label": "newId", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-event-annotation-common/util.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.createCopiedAnnotation.$2", + "type": "string", + "tags": [], + "label": "timestamp", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-event-annotation-common/util.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.createCopiedAnnotation.$3", + "type": "CompoundType", + "tags": [], + "label": "source", + "description": [], + "signature": [ + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.EventAnnotationConfig", + "text": "EventAnnotationConfig" + }, + " | undefined" + ], + "path": "packages/kbn-event-annotation-common/util.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.getDefaultManualAnnotation", + "type": "Function", + "tags": [], + "label": "getDefaultManualAnnotation", + "description": [], + "signature": [ + "(id: string, timestamp: string) => ", + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.EventAnnotationConfig", + "text": "EventAnnotationConfig" + } + ], + "path": "packages/kbn-event-annotation-common/util.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.getDefaultManualAnnotation.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-event-annotation-common/util.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.getDefaultManualAnnotation.$2", + "type": "string", + "tags": [], + "label": "timestamp", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-event-annotation-common/util.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.getDefaultQueryAnnotation", + "type": "Function", + "tags": [], + "label": "getDefaultQueryAnnotation", + "description": [], + "signature": [ + "(id: string, fieldName: string, timeField: string) => ", + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.EventAnnotationConfig", + "text": "EventAnnotationConfig" + } + ], + "path": "packages/kbn-event-annotation-common/util.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.getDefaultQueryAnnotation.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-event-annotation-common/util.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.getDefaultQueryAnnotation.$2", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-event-annotation-common/util.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.getDefaultQueryAnnotation.$3", + "type": "string", + "tags": [], + "label": "timeField", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-event-annotation-common/util.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.isManualPointAnnotationConfig", + "type": "Function", + "tags": [], + "label": "isManualPointAnnotationConfig", + "description": [], + "signature": [ + "(annotation?: ", + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.EventAnnotationConfig", + "text": "EventAnnotationConfig" + }, + " | undefined) => annotation is ", + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.PointInTimeEventAnnotationConfig", + "text": "PointInTimeEventAnnotationConfig" + } + ], + "path": "packages/kbn-event-annotation-common/util.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.isManualPointAnnotationConfig.$1", + "type": "CompoundType", + "tags": [], + "label": "annotation", + "description": [], + "signature": [ + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.EventAnnotationConfig", + "text": "EventAnnotationConfig" + }, + " | undefined" + ], + "path": "packages/kbn-event-annotation-common/util.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.isQueryAnnotationConfig", + "type": "Function", + "tags": [], + "label": "isQueryAnnotationConfig", + "description": [], + "signature": [ + "(annotation?: ", + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.EventAnnotationConfig", + "text": "EventAnnotationConfig" + }, + " | undefined) => annotation is ", + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.QueryPointEventAnnotationConfig", + "text": "QueryPointEventAnnotationConfig" + } + ], + "path": "packages/kbn-event-annotation-common/util.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.isQueryAnnotationConfig.$1", + "type": "CompoundType", + "tags": [], + "label": "annotation", + "description": [], + "signature": [ + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.EventAnnotationConfig", + "text": "EventAnnotationConfig" + }, + " | undefined" + ], + "path": "packages/kbn-event-annotation-common/util.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.isRangeAnnotationConfig", + "type": "Function", + "tags": [], + "label": "isRangeAnnotationConfig", + "description": [], + "signature": [ + "(annotation?: ", + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.EventAnnotationConfig", + "text": "EventAnnotationConfig" + }, + " | undefined) => annotation is ", + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.RangeEventAnnotationConfig", + "text": "RangeEventAnnotationConfig" + } + ], + "path": "packages/kbn-event-annotation-common/util.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.isRangeAnnotationConfig.$1", + "type": "CompoundType", + "tags": [], + "label": "annotation", + "description": [], + "signature": [ + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.EventAnnotationConfig", + "text": "EventAnnotationConfig" + }, + " | undefined" + ], + "path": "packages/kbn-event-annotation-common/util.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.EventAnnotationGroupConfig", + "type": "Interface", + "tags": [], + "label": "EventAnnotationGroupConfig", + "description": [], + "path": "packages/kbn-event-annotation-common/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.EventAnnotationGroupConfig.annotations", + "type": "Array", + "tags": [], + "label": "annotations", + "description": [], + "signature": [ + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.EventAnnotationConfig", + "text": "EventAnnotationConfig" + }, + "[]" + ], + "path": "packages/kbn-event-annotation-common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.EventAnnotationGroupConfig.indexPatternId", + "type": "string", + "tags": [], + "label": "indexPatternId", + "description": [], + "path": "packages/kbn-event-annotation-common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.EventAnnotationGroupConfig.ignoreGlobalFilters", + "type": "boolean", + "tags": [], + "label": "ignoreGlobalFilters", + "description": [], + "path": "packages/kbn-event-annotation-common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.EventAnnotationGroupConfig.title", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "path": "packages/kbn-event-annotation-common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.EventAnnotationGroupConfig.description", + "type": "string", + "tags": [], + "label": "description", + "description": [], + "path": "packages/kbn-event-annotation-common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.EventAnnotationGroupConfig.tags", + "type": "Array", + "tags": [], + "label": "tags", + "description": [], + "signature": [ + "string[]" + ], + "path": "packages/kbn-event-annotation-common/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.EventAnnotationGroupConfig.dataViewSpec", + "type": "Object", + "tags": [], + "label": "dataViewSpec", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + }, + " | undefined" + ], + "path": "packages/kbn-event-annotation-common/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.AvailableAnnotationIcon", + "type": "Type", + "tags": [], + "label": "AvailableAnnotationIcon", + "description": [], + "signature": [ + "\"alert\" | \"circle\" | \"tag\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"editorComment\" | \"flag\" | \"heart\" | \"mapMarker\" | \"pinFilled\" | \"starEmpty\" | \"starFilled\" | \"triangle\"" + ], + "path": "packages/kbn-event-annotation-common/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.defaultAnnotationColor", + "type": "string", + "tags": [], + "label": "defaultAnnotationColor", + "description": [], + "path": "packages/kbn-event-annotation-common/util.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.defaultAnnotationLabel", + "type": "Any", + "tags": [], + "label": "defaultAnnotationLabel", + "description": [], + "signature": [ + "any" + ], + "path": "packages/kbn-event-annotation-common/util.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.defaultAnnotationRangeColor", + "type": "string", + "tags": [], + "label": "defaultAnnotationRangeColor", + "description": [], + "signature": [ + "\"#F04E981A\"" + ], + "path": "packages/kbn-event-annotation-common/util.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.EVENT_ANNOTATION_GROUP_TYPE", + "type": "string", + "tags": [], + "label": "EVENT_ANNOTATION_GROUP_TYPE", + "description": [], + "signature": [ + "\"event-annotation-group\"" + ], + "path": "packages/kbn-event-annotation-common/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.EventAnnotationConfig", + "type": "Type", + "tags": [], + "label": "EventAnnotationConfig", + "description": [], + "signature": [ + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.PointInTimeEventAnnotationConfig", + "text": "PointInTimeEventAnnotationConfig" + }, + " | ", + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.RangeEventAnnotationConfig", + "text": "RangeEventAnnotationConfig" + }, + " | ", + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.QueryPointEventAnnotationConfig", + "text": "QueryPointEventAnnotationConfig" + } + ], + "path": "packages/kbn-event-annotation-common/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.EventAnnotationGroupContent", + "type": "Type", + "tags": [], + "label": "EventAnnotationGroupContent", + "description": [], + "signature": [ + { + "pluginId": "@kbn/content-management-table-list-view-table", + "scope": "common", + "docId": "kibKbnContentManagementTableListViewTablePluginApi", + "section": "def-common.UserContentCommonSchema", + "text": "UserContentCommonSchema" + }, + " & { attributes: { indexPatternId: string; dataViewSpec?: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + }, + " | undefined; }; }" + ], + "path": "packages/kbn-event-annotation-common/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.ManualAnnotationType", + "type": "Type", + "tags": [], + "label": "ManualAnnotationType", + "description": [], + "signature": [ + "\"manual\"" + ], + "path": "packages/kbn-event-annotation-common/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.PointInTimeEventAnnotationConfig", + "type": "Type", + "tags": [], + "label": "PointInTimeEventAnnotationConfig", + "description": [], + "signature": [ + "{ id: string; type: \"manual\"; key: { type: \"point_in_time\"; timestamp: string; }; } & StyleSharedProps & { icon?: ", + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.AvailableAnnotationIcon", + "text": "AvailableAnnotationIcon" + }, + " | undefined; lineWidth?: number | undefined; lineStyle?: ", + { + "pluginId": "@kbn/visualization-ui-components", + "scope": "public", + "docId": "kibKbnVisualizationUiComponentsPluginApi", + "section": "def-public.LineStyle", + "text": "LineStyle" + }, + " | undefined; textVisibility?: boolean | undefined; }" + ], + "path": "packages/kbn-event-annotation-common/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.PointStyleProps", + "type": "Type", + "tags": [], + "label": "PointStyleProps", + "description": [], + "signature": [ + "StyleSharedProps & { icon?: ", + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.AvailableAnnotationIcon", + "text": "AvailableAnnotationIcon" + }, + " | undefined; lineWidth?: number | undefined; lineStyle?: ", + { + "pluginId": "@kbn/visualization-ui-components", + "scope": "public", + "docId": "kibKbnVisualizationUiComponentsPluginApi", + "section": "def-public.LineStyle", + "text": "LineStyle" + }, + " | undefined; textVisibility?: boolean | undefined; }" + ], + "path": "packages/kbn-event-annotation-common/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.QueryPointEventAnnotationConfig", + "type": "Type", + "tags": [], + "label": "QueryPointEventAnnotationConfig", + "description": [], + "signature": [ + "{ id: string; type: \"query\"; filter: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.KibanaQueryOutput", + "text": "KibanaQueryOutput" + }, + "; timeField?: string | undefined; textField?: string | undefined; extraFields?: string[] | undefined; key: { type: \"point_in_time\"; }; } & StyleSharedProps & { icon?: ", + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.AvailableAnnotationIcon", + "text": "AvailableAnnotationIcon" + }, + " | undefined; lineWidth?: number | undefined; lineStyle?: ", + { + "pluginId": "@kbn/visualization-ui-components", + "scope": "public", + "docId": "kibKbnVisualizationUiComponentsPluginApi", + "section": "def-public.LineStyle", + "text": "LineStyle" + }, + " | undefined; textVisibility?: boolean | undefined; }" + ], + "path": "packages/kbn-event-annotation-common/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.RangeEventAnnotationConfig", + "type": "Type", + "tags": [], + "label": "RangeEventAnnotationConfig", + "description": [], + "signature": [ + "{ type: \"manual\"; id: string; key: { type: \"range\"; timestamp: string; endTimestamp: string; }; } & StyleSharedProps & { outside?: boolean | undefined; }" + ], + "path": "packages/kbn-event-annotation-common/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.RangeStyleProps", + "type": "Type", + "tags": [], + "label": "RangeStyleProps", + "description": [], + "signature": [ + "StyleSharedProps & { outside?: boolean | undefined; }" + ], + "path": "packages/kbn-event-annotation-common/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], + "objects": [ + { + "parentPluginId": "@kbn/event-annotation-common", + "id": "def-common.AvailableAnnotationIcons", + "type": "Object", + "tags": [], + "label": "AvailableAnnotationIcons", + "description": [], + "signature": [ + "{ readonly ASTERISK: \"asterisk\"; readonly ALERT: \"alert\"; readonly BELL: \"bell\"; readonly BOLT: \"bolt\"; readonly BUG: \"bug\"; readonly CIRCLE: \"circle\"; readonly EDITOR_COMMENT: \"editorComment\"; readonly FLAG: \"flag\"; readonly HEART: \"heart\"; readonly MAP_MARKER: \"mapMarker\"; readonly PIN_FILLED: \"pinFilled\"; readonly STAR_EMPTY: \"starEmpty\"; readonly STAR_FILLED: \"starFilled\"; readonly TAG: \"tag\"; readonly TRIANGLE: \"triangle\"; }" + ], + "path": "packages/kbn-event-annotation-common/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ] + } +} \ No newline at end of file diff --git a/api_docs/kbn_event_annotation_common.mdx b/api_docs/kbn_event_annotation_common.mdx new file mode 100644 index 0000000000000..6c2bb5ed1a051 --- /dev/null +++ b/api_docs/kbn_event_annotation_common.mdx @@ -0,0 +1,39 @@ +--- +#### +#### 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. +#### +id: kibKbnEventAnnotationCommonPluginApi +slug: /kibana-dev-docs/api/kbn-event-annotation-common +title: "@kbn/event-annotation-common" +image: https://source.unsplash.com/400x175/?github +description: API docs for the @kbn/event-annotation-common plugin +date: 2023-07-20 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/event-annotation-common'] +--- +import kbnEventAnnotationCommonObj from './kbn_event_annotation_common.devdocs.json'; + + + +Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 39 | 1 | 39 | 0 | + +## Common + +### Objects + + +### Functions + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/kbn_event_annotation_components.devdocs.json b/api_docs/kbn_event_annotation_components.devdocs.json new file mode 100644 index 0000000000000..e835390ba84ac --- /dev/null +++ b/api_docs/kbn_event_annotation_components.devdocs.json @@ -0,0 +1,1383 @@ +{ + "id": "@kbn/event-annotation-components", + "client": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.AnnotationEditorControls", + "type": "Function", + "tags": [], + "label": "AnnotationEditorControls", + "description": [], + "signature": [ + "(props: ", + "Props", + ") => JSX.Element" + ], + "path": "packages/kbn-event-annotation-components/components/annotation_editor_controls/index.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.AnnotationEditorControls.$1", + "type": "Object", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "Props" + ], + "path": "packages/kbn-event-annotation-components/components/annotation_editor_controls/index.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.createCopiedAnnotation", + "type": "Function", + "tags": [], + "label": "createCopiedAnnotation", + "description": [], + "signature": [ + "(newId: string, timestamp: string, source?: ", + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.EventAnnotationConfig", + "text": "EventAnnotationConfig" + }, + " | undefined) => ", + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.EventAnnotationConfig", + "text": "EventAnnotationConfig" + } + ], + "path": "packages/kbn-event-annotation-common/util.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.createCopiedAnnotation.$1", + "type": "string", + "tags": [], + "label": "newId", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-event-annotation-common/util.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.createCopiedAnnotation.$2", + "type": "string", + "tags": [], + "label": "timestamp", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-event-annotation-common/util.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.createCopiedAnnotation.$3", + "type": "CompoundType", + "tags": [], + "label": "source", + "description": [], + "signature": [ + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.EventAnnotationConfig", + "text": "EventAnnotationConfig" + }, + " | undefined" + ], + "path": "packages/kbn-event-annotation-common/util.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationGroupTableList", + "type": "Function", + "tags": [], + "label": "EventAnnotationGroupTableList", + "description": [], + "signature": [ + "({ uiSettings, eventAnnotationService, visualizeCapabilities, savedObjectsTagging, parentProps, dataViews, createDataView, queryInputServices, toasts, navigateToLens, }: { uiSettings: ", + { + "pluginId": "@kbn/core-ui-settings-browser", + "scope": "common", + "docId": "kibKbnCoreUiSettingsBrowserPluginApi", + "section": "def-common.IUiSettingsClient", + "text": "IUiSettingsClient" + }, + "; eventAnnotationService: ", + { + "pluginId": "@kbn/event-annotation-components", + "scope": "public", + "docId": "kibKbnEventAnnotationComponentsPluginApi", + "section": "def-public.EventAnnotationServiceType", + "text": "EventAnnotationServiceType" + }, + "; visualizeCapabilities: Record>; savedObjectsTagging: ", + { + "pluginId": "savedObjectsTaggingOss", + "scope": "public", + "docId": "kibSavedObjectsTaggingOssPluginApi", + "section": "def-public.SavedObjectsTaggingApi", + "text": "SavedObjectsTaggingApi" + }, + "; parentProps: ", + { + "pluginId": "@kbn/content-management-tabbed-table-list-view", + "scope": "common", + "docId": "kibKbnContentManagementTabbedTableListViewPluginApi", + "section": "def-common.TableListTabParentProps", + "text": "TableListTabParentProps" + }, + "<", + { + "pluginId": "@kbn/content-management-table-list-view-table", + "scope": "common", + "docId": "kibKbnContentManagementTableListViewTablePluginApi", + "section": "def-common.UserContentCommonSchema", + "text": "UserContentCommonSchema" + }, + ">; dataViews: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + "[]; createDataView: (spec: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + }, + ") => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">; queryInputServices: ", + { + "pluginId": "@kbn/visualization-ui-components", + "scope": "public", + "docId": "kibKbnVisualizationUiComponentsPluginApi", + "section": "def-public.QueryInputServices", + "text": "QueryInputServices" + }, + "; toasts: ", + { + "pluginId": "@kbn/core-notifications-browser", + "scope": "common", + "docId": "kibKbnCoreNotificationsBrowserPluginApi", + "section": "def-common.IToasts", + "text": "IToasts" + }, + "; navigateToLens: () => void; }) => JSX.Element" + ], + "path": "packages/kbn-event-annotation-components/components/table_list.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationGroupTableList.$1", + "type": "Object", + "tags": [], + "label": "{\n uiSettings,\n eventAnnotationService,\n visualizeCapabilities,\n savedObjectsTagging,\n parentProps,\n dataViews,\n createDataView,\n queryInputServices,\n toasts,\n navigateToLens,\n}", + "description": [], + "path": "packages/kbn-event-annotation-components/components/table_list.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationGroupTableList.$1.uiSettings", + "type": "Object", + "tags": [], + "label": "uiSettings", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-ui-settings-browser", + "scope": "common", + "docId": "kibKbnCoreUiSettingsBrowserPluginApi", + "section": "def-common.IUiSettingsClient", + "text": "IUiSettingsClient" + } + ], + "path": "packages/kbn-event-annotation-components/components/table_list.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationGroupTableList.$1.eventAnnotationService", + "type": "Object", + "tags": [], + "label": "eventAnnotationService", + "description": [], + "signature": [ + { + "pluginId": "@kbn/event-annotation-components", + "scope": "public", + "docId": "kibKbnEventAnnotationComponentsPluginApi", + "section": "def-public.EventAnnotationServiceType", + "text": "EventAnnotationServiceType" + } + ], + "path": "packages/kbn-event-annotation-components/components/table_list.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationGroupTableList.$1.visualizeCapabilities", + "type": "Object", + "tags": [], + "label": "visualizeCapabilities", + "description": [], + "signature": [ + "{ [x: string]: boolean | Record; }" + ], + "path": "packages/kbn-event-annotation-components/components/table_list.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationGroupTableList.$1.savedObjectsTagging", + "type": "Object", + "tags": [], + "label": "savedObjectsTagging", + "description": [], + "signature": [ + { + "pluginId": "savedObjectsTaggingOss", + "scope": "public", + "docId": "kibSavedObjectsTaggingOssPluginApi", + "section": "def-public.SavedObjectsTaggingApi", + "text": "SavedObjectsTaggingApi" + } + ], + "path": "packages/kbn-event-annotation-components/components/table_list.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationGroupTableList.$1.parentProps", + "type": "Object", + "tags": [], + "label": "parentProps", + "description": [], + "signature": [ + "{ onFetchSuccess: () => void; setPageDataTestSubject: (subject: string) => void; }" + ], + "path": "packages/kbn-event-annotation-components/components/table_list.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationGroupTableList.$1.dataViews", + "type": "Array", + "tags": [], + "label": "dataViews", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + "[]" + ], + "path": "packages/kbn-event-annotation-components/components/table_list.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationGroupTableList.$1.createDataView", + "type": "Function", + "tags": [], + "label": "createDataView", + "description": [], + "signature": [ + "(spec: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + }, + ") => Promise<", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + ">" + ], + "path": "packages/kbn-event-annotation-components/components/table_list.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationGroupTableList.$1.createDataView.$1", + "type": "Object", + "tags": [], + "label": "spec", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataViewSpec", + "text": "DataViewSpec" + } + ], + "path": "packages/kbn-event-annotation-components/components/table_list.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationGroupTableList.$1.queryInputServices", + "type": "Object", + "tags": [], + "label": "queryInputServices", + "description": [], + "signature": [ + { + "pluginId": "@kbn/visualization-ui-components", + "scope": "public", + "docId": "kibKbnVisualizationUiComponentsPluginApi", + "section": "def-public.QueryInputServices", + "text": "QueryInputServices" + } + ], + "path": "packages/kbn-event-annotation-components/components/table_list.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationGroupTableList.$1.toasts", + "type": "Object", + "tags": [], + "label": "toasts", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-notifications-browser", + "scope": "common", + "docId": "kibKbnCoreNotificationsBrowserPluginApi", + "section": "def-common.IToasts", + "text": "IToasts" + } + ], + "path": "packages/kbn-event-annotation-components/components/table_list.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationGroupTableList.$1.navigateToLens", + "type": "Function", + "tags": [], + "label": "navigateToLens", + "description": [], + "signature": [ + "() => void" + ], + "path": "packages/kbn-event-annotation-components/components/table_list.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + } + ] + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.getAnnotationAccessor", + "type": "Function", + "tags": [], + "label": "getAnnotationAccessor", + "description": [], + "signature": [ + "(annotation: ", + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.EventAnnotationConfig", + "text": "EventAnnotationConfig" + }, + ") => ", + { + "pluginId": "@kbn/visualization-ui-components", + "scope": "public", + "docId": "kibKbnVisualizationUiComponentsPluginApi", + "section": "def-public.AccessorConfig", + "text": "AccessorConfig" + } + ], + "path": "packages/kbn-event-annotation-components/components/get_annotation_accessor.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.getAnnotationAccessor.$1", + "type": "CompoundType", + "tags": [], + "label": "annotation", + "description": [], + "signature": [ + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.EventAnnotationConfig", + "text": "EventAnnotationConfig" + } + ], + "path": "packages/kbn-event-annotation-components/components/get_annotation_accessor.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.isManualPointAnnotationConfig", + "type": "Function", + "tags": [], + "label": "isManualPointAnnotationConfig", + "description": [], + "signature": [ + "(annotation?: ", + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.EventAnnotationConfig", + "text": "EventAnnotationConfig" + }, + " | undefined) => annotation is ", + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.PointInTimeEventAnnotationConfig", + "text": "PointInTimeEventAnnotationConfig" + } + ], + "path": "packages/kbn-event-annotation-common/util.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.isManualPointAnnotationConfig.$1", + "type": "CompoundType", + "tags": [], + "label": "annotation", + "description": [], + "signature": [ + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.EventAnnotationConfig", + "text": "EventAnnotationConfig" + }, + " | undefined" + ], + "path": "packages/kbn-event-annotation-common/util.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.isQueryAnnotationConfig", + "type": "Function", + "tags": [], + "label": "isQueryAnnotationConfig", + "description": [], + "signature": [ + "(annotation?: ", + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.EventAnnotationConfig", + "text": "EventAnnotationConfig" + }, + " | undefined) => annotation is ", + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.QueryPointEventAnnotationConfig", + "text": "QueryPointEventAnnotationConfig" + } + ], + "path": "packages/kbn-event-annotation-common/util.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.isQueryAnnotationConfig.$1", + "type": "CompoundType", + "tags": [], + "label": "annotation", + "description": [], + "signature": [ + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.EventAnnotationConfig", + "text": "EventAnnotationConfig" + }, + " | undefined" + ], + "path": "packages/kbn-event-annotation-common/util.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.isRangeAnnotationConfig", + "type": "Function", + "tags": [], + "label": "isRangeAnnotationConfig", + "description": [], + "signature": [ + "(annotation?: ", + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.EventAnnotationConfig", + "text": "EventAnnotationConfig" + }, + " | undefined) => annotation is ", + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.RangeEventAnnotationConfig", + "text": "RangeEventAnnotationConfig" + } + ], + "path": "packages/kbn-event-annotation-common/util.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.isRangeAnnotationConfig.$1", + "type": "CompoundType", + "tags": [], + "label": "annotation", + "description": [], + "signature": [ + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.EventAnnotationConfig", + "text": "EventAnnotationConfig" + }, + " | undefined" + ], + "path": "packages/kbn-event-annotation-common/util.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationServiceType", + "type": "Interface", + "tags": [], + "label": "EventAnnotationServiceType", + "description": [], + "path": "packages/kbn-event-annotation-components/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationServiceType.loadAnnotationGroup", + "type": "Function", + "tags": [], + "label": "loadAnnotationGroup", + "description": [], + "signature": [ + "(savedObjectId: string) => Promise<", + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.EventAnnotationGroupConfig", + "text": "EventAnnotationGroupConfig" + }, + ">" + ], + "path": "packages/kbn-event-annotation-components/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationServiceType.loadAnnotationGroup.$1", + "type": "string", + "tags": [], + "label": "savedObjectId", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-event-annotation-components/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationServiceType.groupExistsWithTitle", + "type": "Function", + "tags": [], + "label": "groupExistsWithTitle", + "description": [], + "signature": [ + "(title: string) => Promise" + ], + "path": "packages/kbn-event-annotation-components/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationServiceType.groupExistsWithTitle.$1", + "type": "string", + "tags": [], + "label": "title", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-event-annotation-components/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationServiceType.findAnnotationGroupContent", + "type": "Function", + "tags": [], + "label": "findAnnotationGroupContent", + "description": [], + "signature": [ + "(searchTerm: string, pageSize: number, tagsToInclude?: string[] | undefined, tagsToExclude?: string[] | undefined) => Promise<{ total: number; hits: ", + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.EventAnnotationGroupContent", + "text": "EventAnnotationGroupContent" + }, + "[]; }>" + ], + "path": "packages/kbn-event-annotation-components/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationServiceType.findAnnotationGroupContent.$1", + "type": "string", + "tags": [], + "label": "searchTerm", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-event-annotation-components/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationServiceType.findAnnotationGroupContent.$2", + "type": "number", + "tags": [], + "label": "pageSize", + "description": [], + "signature": [ + "number" + ], + "path": "packages/kbn-event-annotation-components/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationServiceType.findAnnotationGroupContent.$3", + "type": "Array", + "tags": [], + "label": "tagsToInclude", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "packages/kbn-event-annotation-components/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationServiceType.findAnnotationGroupContent.$4", + "type": "Array", + "tags": [], + "label": "tagsToExclude", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "packages/kbn-event-annotation-components/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationServiceType.deleteAnnotationGroups", + "type": "Function", + "tags": [], + "label": "deleteAnnotationGroups", + "description": [], + "signature": [ + "(ids: string[]) => Promise" + ], + "path": "packages/kbn-event-annotation-components/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationServiceType.deleteAnnotationGroups.$1", + "type": "Array", + "tags": [], + "label": "ids", + "description": [], + "signature": [ + "string[]" + ], + "path": "packages/kbn-event-annotation-components/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationServiceType.createAnnotationGroup", + "type": "Function", + "tags": [], + "label": "createAnnotationGroup", + "description": [], + "signature": [ + "(group: ", + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.EventAnnotationGroupConfig", + "text": "EventAnnotationGroupConfig" + }, + ") => Promise<{ id: string; }>" + ], + "path": "packages/kbn-event-annotation-components/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationServiceType.createAnnotationGroup.$1", + "type": "Object", + "tags": [], + "label": "group", + "description": [], + "signature": [ + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.EventAnnotationGroupConfig", + "text": "EventAnnotationGroupConfig" + } + ], + "path": "packages/kbn-event-annotation-components/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationServiceType.updateAnnotationGroup", + "type": "Function", + "tags": [], + "label": "updateAnnotationGroup", + "description": [], + "signature": [ + "(group: ", + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.EventAnnotationGroupConfig", + "text": "EventAnnotationGroupConfig" + }, + ", savedObjectId: string) => Promise" + ], + "path": "packages/kbn-event-annotation-components/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationServiceType.updateAnnotationGroup.$1", + "type": "Object", + "tags": [], + "label": "group", + "description": [], + "signature": [ + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.EventAnnotationGroupConfig", + "text": "EventAnnotationGroupConfig" + } + ], + "path": "packages/kbn-event-annotation-components/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationServiceType.updateAnnotationGroup.$2", + "type": "string", + "tags": [], + "label": "savedObjectId", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-event-annotation-components/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationServiceType.toExpression", + "type": "Function", + "tags": [], + "label": "toExpression", + "description": [], + "signature": [ + "(props: ", + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.EventAnnotationConfig", + "text": "EventAnnotationConfig" + }, + "[]) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + "[]" + ], + "path": "packages/kbn-event-annotation-components/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationServiceType.toExpression.$1", + "type": "Array", + "tags": [], + "label": "props", + "description": [], + "signature": [ + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.EventAnnotationConfig", + "text": "EventAnnotationConfig" + }, + "[]" + ], + "path": "packages/kbn-event-annotation-components/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationServiceType.toFetchExpression", + "type": "Function", + "tags": [], + "label": "toFetchExpression", + "description": [], + "signature": [ + "(props: { interval: string; groups: Pick<", + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.EventAnnotationGroupConfig", + "text": "EventAnnotationGroupConfig" + }, + ", \"annotations\" | \"ignoreGlobalFilters\" | \"indexPatternId\">[]; }) => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + }, + "[]" + ], + "path": "packages/kbn-event-annotation-components/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationServiceType.toFetchExpression.$1", + "type": "Object", + "tags": [], + "label": "props", + "description": [], + "path": "packages/kbn-event-annotation-components/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationServiceType.toFetchExpression.$1.interval", + "type": "string", + "tags": [], + "label": "interval", + "description": [], + "path": "packages/kbn-event-annotation-components/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationServiceType.toFetchExpression.$1.groups", + "type": "Array", + "tags": [], + "label": "groups", + "description": [], + "signature": [ + "Pick<", + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.EventAnnotationGroupConfig", + "text": "EventAnnotationGroupConfig" + }, + ", \"annotations\" | \"ignoreGlobalFilters\" | \"indexPatternId\">[]" + ], + "path": "packages/kbn-event-annotation-components/types.ts", + "deprecated": false, + "trackAdoption": false + } + ] + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationServiceType.renderEventAnnotationGroupSavedObjectFinder", + "type": "Function", + "tags": [], + "label": "renderEventAnnotationGroupSavedObjectFinder", + "description": [], + "signature": [ + "(props: { fixedPageSize?: number | undefined; onChoose: (value: { id: string; type: string; fullName: string; savedObject: ", + { + "pluginId": "savedObjectsFinder", + "scope": "common", + "docId": "kibSavedObjectsFinderPluginApi", + "section": "def-common.SavedObjectCommon", + "text": "SavedObjectCommon" + }, + "; }) => void; onCreateNew: () => void; }) => JSX.Element" + ], + "path": "packages/kbn-event-annotation-components/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationServiceType.renderEventAnnotationGroupSavedObjectFinder.$1", + "type": "Object", + "tags": [], + "label": "props", + "description": [], + "path": "packages/kbn-event-annotation-components/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationServiceType.renderEventAnnotationGroupSavedObjectFinder.$1.fixedPageSize", + "type": "number", + "tags": [], + "label": "fixedPageSize", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "packages/kbn-event-annotation-components/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationServiceType.renderEventAnnotationGroupSavedObjectFinder.$1.onChoose", + "type": "Function", + "tags": [], + "label": "onChoose", + "description": [], + "signature": [ + "(value: { id: string; type: string; fullName: string; savedObject: ", + { + "pluginId": "savedObjectsFinder", + "scope": "common", + "docId": "kibSavedObjectsFinderPluginApi", + "section": "def-common.SavedObjectCommon", + "text": "SavedObjectCommon" + }, + "; }) => void" + ], + "path": "packages/kbn-event-annotation-components/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationServiceType.renderEventAnnotationGroupSavedObjectFinder.$1.onChoose.$1", + "type": "Object", + "tags": [], + "label": "value", + "description": [], + "path": "packages/kbn-event-annotation-components/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationServiceType.renderEventAnnotationGroupSavedObjectFinder.$1.onChoose.$1.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "packages/kbn-event-annotation-components/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationServiceType.renderEventAnnotationGroupSavedObjectFinder.$1.onChoose.$1.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "packages/kbn-event-annotation-components/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationServiceType.renderEventAnnotationGroupSavedObjectFinder.$1.onChoose.$1.fullName", + "type": "string", + "tags": [], + "label": "fullName", + "description": [], + "path": "packages/kbn-event-annotation-components/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationServiceType.renderEventAnnotationGroupSavedObjectFinder.$1.onChoose.$1.savedObject", + "type": "Object", + "tags": [], + "label": "savedObject", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + "" + ], + "path": "packages/kbn-event-annotation-components/types.ts", + "deprecated": false, + "trackAdoption": false + } + ] + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EventAnnotationServiceType.renderEventAnnotationGroupSavedObjectFinder.$1.onCreateNew", + "type": "Function", + "tags": [], + "label": "onCreateNew", + "description": [], + "signature": [ + "() => void" + ], + "path": "packages/kbn-event-annotation-components/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + } + ] + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.annotationsIconSet", + "type": "Array", + "tags": [], + "label": "annotationsIconSet", + "description": [], + "signature": [ + "{ value: ", + { + "pluginId": "@kbn/event-annotation-common", + "scope": "common", + "docId": "kibKbnEventAnnotationCommonPluginApi", + "section": "def-common.AvailableAnnotationIcon", + "text": "AvailableAnnotationIcon" + }, + "; label: string; icon?: string | React.ComponentClass<{}, any> | React.FunctionComponent<{}> | undefined; shouldRotate?: boolean | undefined; }[]" + ], + "path": "packages/kbn-event-annotation-components/components/annotation_editor_controls/icon_set.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.defaultAnnotationColor", + "type": "string", + "tags": [], + "label": "defaultAnnotationColor", + "description": [], + "path": "packages/kbn-event-annotation-common/util.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.defaultAnnotationLabel", + "type": "Any", + "tags": [], + "label": "defaultAnnotationLabel", + "description": [], + "signature": [ + "any" + ], + "path": "packages/kbn-event-annotation-common/util.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.defaultAnnotationRangeColor", + "type": "string", + "tags": [], + "label": "defaultAnnotationRangeColor", + "description": [], + "signature": [ + "\"#F04E981A\"" + ], + "path": "packages/kbn-event-annotation-common/util.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/event-annotation-components", + "id": "def-public.EVENT_ANNOTATION_APP_NAME", + "type": "string", + "tags": [], + "label": "EVENT_ANNOTATION_APP_NAME", + "description": [], + "signature": [ + "\"event-annotations\"" + ], + "path": "packages/kbn-event-annotation-components/constants.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_event_annotation_components.mdx b/api_docs/kbn_event_annotation_components.mdx new file mode 100644 index 0000000000000..13ee31f8389eb --- /dev/null +++ b/api_docs/kbn_event_annotation_components.mdx @@ -0,0 +1,36 @@ +--- +#### +#### 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. +#### +id: kibKbnEventAnnotationComponentsPluginApi +slug: /kibana-dev-docs/api/kbn-event-annotation-components +title: "@kbn/event-annotation-components" +image: https://source.unsplash.com/400x175/?github +description: API docs for the @kbn/event-annotation-components plugin +date: 2023-07-20 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/event-annotation-components'] +--- +import kbnEventAnnotationComponentsObj from './kbn_event_annotation_components.devdocs.json'; + + + +Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 65 | 1 | 65 | 1 | + +## Client + +### Functions + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/kbn_expandable_flyout.mdx b/api_docs/kbn_expandable_flyout.mdx index c3648fff54cbf..26766ae8e4254 100644 --- a/api_docs/kbn_expandable_flyout.mdx +++ b/api_docs/kbn_expandable_flyout.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-expandable-flyout title: "@kbn/expandable-flyout" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/expandable-flyout plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/expandable-flyout'] --- import kbnExpandableFlyoutObj from './kbn_expandable_flyout.devdocs.json'; diff --git a/api_docs/kbn_field_types.mdx b/api_docs/kbn_field_types.mdx index 49432057fb7cb..a6b33c52b0cfa 100644 --- a/api_docs/kbn_field_types.mdx +++ b/api_docs/kbn_field_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-field-types title: "@kbn/field-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/field-types plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/field-types'] --- import kbnFieldTypesObj from './kbn_field_types.devdocs.json'; diff --git a/api_docs/kbn_find_used_node_modules.mdx b/api_docs/kbn_find_used_node_modules.mdx index 46c842e191a78..d2ce521c14aef 100644 --- a/api_docs/kbn_find_used_node_modules.mdx +++ b/api_docs/kbn_find_used_node_modules.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-find-used-node-modules title: "@kbn/find-used-node-modules" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/find-used-node-modules plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/find-used-node-modules'] --- import kbnFindUsedNodeModulesObj from './kbn_find_used_node_modules.devdocs.json'; diff --git a/api_docs/kbn_ftr_common_functional_services.mdx b/api_docs/kbn_ftr_common_functional_services.mdx index 82aef15de730f..6be0aeb218f81 100644 --- a/api_docs/kbn_ftr_common_functional_services.mdx +++ b/api_docs/kbn_ftr_common_functional_services.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ftr-common-functional-services title: "@kbn/ftr-common-functional-services" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ftr-common-functional-services plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ftr-common-functional-services'] --- import kbnFtrCommonFunctionalServicesObj from './kbn_ftr_common_functional_services.devdocs.json'; diff --git a/api_docs/kbn_generate.mdx b/api_docs/kbn_generate.mdx index 0007e6a55495d..06cbb1fc124b7 100644 --- a/api_docs/kbn_generate.mdx +++ b/api_docs/kbn_generate.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-generate title: "@kbn/generate" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/generate plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/generate'] --- import kbnGenerateObj from './kbn_generate.devdocs.json'; diff --git a/api_docs/kbn_generate_console_definitions.mdx b/api_docs/kbn_generate_console_definitions.mdx index 2dcee172c5978..cdb66bbb6c517 100644 --- a/api_docs/kbn_generate_console_definitions.mdx +++ b/api_docs/kbn_generate_console_definitions.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-generate-console-definitions title: "@kbn/generate-console-definitions" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/generate-console-definitions plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/generate-console-definitions'] --- import kbnGenerateConsoleDefinitionsObj from './kbn_generate_console_definitions.devdocs.json'; diff --git a/api_docs/kbn_generate_csv.mdx b/api_docs/kbn_generate_csv.mdx index 98035cabd6a92..7a6a8b1800542 100644 --- a/api_docs/kbn_generate_csv.mdx +++ b/api_docs/kbn_generate_csv.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-generate-csv title: "@kbn/generate-csv" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/generate-csv plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/generate-csv'] --- import kbnGenerateCsvObj from './kbn_generate_csv.devdocs.json'; diff --git a/api_docs/kbn_generate_csv_types.mdx b/api_docs/kbn_generate_csv_types.mdx index d480599d61f01..b5f689975ad54 100644 --- a/api_docs/kbn_generate_csv_types.mdx +++ b/api_docs/kbn_generate_csv_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-generate-csv-types title: "@kbn/generate-csv-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/generate-csv-types plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/generate-csv-types'] --- import kbnGenerateCsvTypesObj from './kbn_generate_csv_types.devdocs.json'; diff --git a/api_docs/kbn_guided_onboarding.mdx b/api_docs/kbn_guided_onboarding.mdx index 8b1a4f6c3dc3b..012c336e62d86 100644 --- a/api_docs/kbn_guided_onboarding.mdx +++ b/api_docs/kbn_guided_onboarding.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-guided-onboarding title: "@kbn/guided-onboarding" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/guided-onboarding plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/guided-onboarding'] --- import kbnGuidedOnboardingObj from './kbn_guided_onboarding.devdocs.json'; diff --git a/api_docs/kbn_handlebars.mdx b/api_docs/kbn_handlebars.mdx index 9b9abc6e897d8..b790012eea2d6 100644 --- a/api_docs/kbn_handlebars.mdx +++ b/api_docs/kbn_handlebars.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-handlebars title: "@kbn/handlebars" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/handlebars plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/handlebars'] --- import kbnHandlebarsObj from './kbn_handlebars.devdocs.json'; diff --git a/api_docs/kbn_hapi_mocks.mdx b/api_docs/kbn_hapi_mocks.mdx index 43d7ce55e4e87..5e1a9fb15ffeb 100644 --- a/api_docs/kbn_hapi_mocks.mdx +++ b/api_docs/kbn_hapi_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-hapi-mocks title: "@kbn/hapi-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/hapi-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/hapi-mocks'] --- import kbnHapiMocksObj from './kbn_hapi_mocks.devdocs.json'; diff --git a/api_docs/kbn_health_gateway_server.mdx b/api_docs/kbn_health_gateway_server.mdx index 4f233991d579a..5124c896b1e69 100644 --- a/api_docs/kbn_health_gateway_server.mdx +++ b/api_docs/kbn_health_gateway_server.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-health-gateway-server title: "@kbn/health-gateway-server" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/health-gateway-server plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/health-gateway-server'] --- import kbnHealthGatewayServerObj from './kbn_health_gateway_server.devdocs.json'; diff --git a/api_docs/kbn_home_sample_data_card.mdx b/api_docs/kbn_home_sample_data_card.mdx index 9ac01d4d88485..e0d8900ce4f54 100644 --- a/api_docs/kbn_home_sample_data_card.mdx +++ b/api_docs/kbn_home_sample_data_card.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-home-sample-data-card title: "@kbn/home-sample-data-card" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/home-sample-data-card plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/home-sample-data-card'] --- import kbnHomeSampleDataCardObj from './kbn_home_sample_data_card.devdocs.json'; diff --git a/api_docs/kbn_home_sample_data_tab.mdx b/api_docs/kbn_home_sample_data_tab.mdx index 14fed28478710..7bf81eca5795f 100644 --- a/api_docs/kbn_home_sample_data_tab.mdx +++ b/api_docs/kbn_home_sample_data_tab.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-home-sample-data-tab title: "@kbn/home-sample-data-tab" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/home-sample-data-tab plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/home-sample-data-tab'] --- import kbnHomeSampleDataTabObj from './kbn_home_sample_data_tab.devdocs.json'; diff --git a/api_docs/kbn_i18n.mdx b/api_docs/kbn_i18n.mdx index 9eaade5c41805..4795094a05ede 100644 --- a/api_docs/kbn_i18n.mdx +++ b/api_docs/kbn_i18n.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-i18n title: "@kbn/i18n" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/i18n plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/i18n'] --- import kbnI18nObj from './kbn_i18n.devdocs.json'; diff --git a/api_docs/kbn_i18n_react.mdx b/api_docs/kbn_i18n_react.mdx index 46de432822cf9..fa681990c1045 100644 --- a/api_docs/kbn_i18n_react.mdx +++ b/api_docs/kbn_i18n_react.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-i18n-react title: "@kbn/i18n-react" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/i18n-react plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/i18n-react'] --- import kbnI18nReactObj from './kbn_i18n_react.devdocs.json'; diff --git a/api_docs/kbn_import_resolver.mdx b/api_docs/kbn_import_resolver.mdx index aa6843f4a6d2b..2e31ef4faab16 100644 --- a/api_docs/kbn_import_resolver.mdx +++ b/api_docs/kbn_import_resolver.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-import-resolver title: "@kbn/import-resolver" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/import-resolver plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/import-resolver'] --- import kbnImportResolverObj from './kbn_import_resolver.devdocs.json'; diff --git a/api_docs/kbn_infra_forge.mdx b/api_docs/kbn_infra_forge.mdx index 9adda81297c71..0c91a815127da 100644 --- a/api_docs/kbn_infra_forge.mdx +++ b/api_docs/kbn_infra_forge.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-infra-forge title: "@kbn/infra-forge" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/infra-forge plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/infra-forge'] --- import kbnInfraForgeObj from './kbn_infra_forge.devdocs.json'; diff --git a/api_docs/kbn_interpreter.mdx b/api_docs/kbn_interpreter.mdx index dfd6c00ccaa4f..da192ffad72bb 100644 --- a/api_docs/kbn_interpreter.mdx +++ b/api_docs/kbn_interpreter.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-interpreter title: "@kbn/interpreter" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/interpreter plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/interpreter'] --- import kbnInterpreterObj from './kbn_interpreter.devdocs.json'; diff --git a/api_docs/kbn_io_ts_utils.mdx b/api_docs/kbn_io_ts_utils.mdx index 0892ebe00a4af..df372701d65a1 100644 --- a/api_docs/kbn_io_ts_utils.mdx +++ b/api_docs/kbn_io_ts_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-io-ts-utils title: "@kbn/io-ts-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/io-ts-utils plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/io-ts-utils'] --- import kbnIoTsUtilsObj from './kbn_io_ts_utils.devdocs.json'; diff --git a/api_docs/kbn_jest_serializers.mdx b/api_docs/kbn_jest_serializers.mdx index 6749a78383d90..3dcdc08f73fcc 100644 --- a/api_docs/kbn_jest_serializers.mdx +++ b/api_docs/kbn_jest_serializers.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-jest-serializers title: "@kbn/jest-serializers" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/jest-serializers plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/jest-serializers'] --- import kbnJestSerializersObj from './kbn_jest_serializers.devdocs.json'; diff --git a/api_docs/kbn_journeys.mdx b/api_docs/kbn_journeys.mdx index dff452ed5ca6c..6ae86e53ed60b 100644 --- a/api_docs/kbn_journeys.mdx +++ b/api_docs/kbn_journeys.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-journeys title: "@kbn/journeys" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/journeys plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/journeys'] --- import kbnJourneysObj from './kbn_journeys.devdocs.json'; diff --git a/api_docs/kbn_json_ast.mdx b/api_docs/kbn_json_ast.mdx index a8222c6f73a35..036a40284978a 100644 --- a/api_docs/kbn_json_ast.mdx +++ b/api_docs/kbn_json_ast.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-json-ast title: "@kbn/json-ast" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/json-ast plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/json-ast'] --- import kbnJsonAstObj from './kbn_json_ast.devdocs.json'; diff --git a/api_docs/kbn_kibana_manifest_schema.mdx b/api_docs/kbn_kibana_manifest_schema.mdx index d9a1f3701fe38..87b3c1da9b705 100644 --- a/api_docs/kbn_kibana_manifest_schema.mdx +++ b/api_docs/kbn_kibana_manifest_schema.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-kibana-manifest-schema title: "@kbn/kibana-manifest-schema" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/kibana-manifest-schema plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/kibana-manifest-schema'] --- import kbnKibanaManifestSchemaObj from './kbn_kibana_manifest_schema.devdocs.json'; diff --git a/api_docs/kbn_language_documentation_popover.mdx b/api_docs/kbn_language_documentation_popover.mdx index 2ef27220a1c40..7459cca49a1ce 100644 --- a/api_docs/kbn_language_documentation_popover.mdx +++ b/api_docs/kbn_language_documentation_popover.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-language-documentation-popover title: "@kbn/language-documentation-popover" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/language-documentation-popover plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/language-documentation-popover'] --- import kbnLanguageDocumentationPopoverObj from './kbn_language_documentation_popover.devdocs.json'; diff --git a/api_docs/kbn_logging.mdx b/api_docs/kbn_logging.mdx index 5d828552545c6..9b86f32381901 100644 --- a/api_docs/kbn_logging.mdx +++ b/api_docs/kbn_logging.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-logging title: "@kbn/logging" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/logging plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/logging'] --- import kbnLoggingObj from './kbn_logging.devdocs.json'; diff --git a/api_docs/kbn_logging_mocks.devdocs.json b/api_docs/kbn_logging_mocks.devdocs.json index 617062bcc5f08..39e3725849b91 100644 --- a/api_docs/kbn_logging_mocks.devdocs.json +++ b/api_docs/kbn_logging_mocks.devdocs.json @@ -38,7 +38,7 @@ "section": "def-common.LogMeta", "text": "LogMeta" }, - " | undefined]>; debug: jest.MockInstance; debug: jest.MockInstance; info: jest.MockInstance; info: jest.MockInstance; warn: jest.MockInstance; warn: jest.MockInstance; error: jest.MockInstance; error: jest.MockInstance; fatal: jest.MockInstance; fatal: jest.MockInstance; log: jest.MockInstance; log: jest.MockInstance; isLevelEnabled: jest.MockInstance; isLevelEnabled: jest.MockInstance; get: jest.MockInstance<", + "], unknown>; get: jest.MockInstance<", { "pluginId": "@kbn/logging", "scope": "common", @@ -90,7 +90,7 @@ "section": "def-common.Logger", "text": "Logger" }, - ", string[]>; } & ", + ", string[], unknown>; } & ", { "pluginId": "@kbn/logging", "scope": "common", @@ -195,7 +195,7 @@ "section": "def-common.LogMeta", "text": "LogMeta" }, - " | undefined]>; debug: jest.MockInstance; debug: jest.MockInstance; info: jest.MockInstance; info: jest.MockInstance; warn: jest.MockInstance; warn: jest.MockInstance; error: jest.MockInstance; error: jest.MockInstance; fatal: jest.MockInstance; fatal: jest.MockInstance; log: jest.MockInstance; log: jest.MockInstance; isLevelEnabled: jest.MockInstance; isLevelEnabled: jest.MockInstance; get: jest.MockInstance<", + "], unknown>; get: jest.MockInstance<", { "pluginId": "@kbn/logging", "scope": "common", @@ -247,7 +247,7 @@ "section": "def-common.Logger", "text": "Logger" }, - ", string[]>; } & ", + ", string[], unknown>; } & ", { "pluginId": "@kbn/logging", "scope": "common", @@ -352,7 +352,7 @@ "section": "def-common.LogMeta", "text": "LogMeta" }, - " | undefined]>; debug: jest.MockInstance; debug: jest.MockInstance; info: jest.MockInstance; info: jest.MockInstance; warn: jest.MockInstance; warn: jest.MockInstance; error: jest.MockInstance; error: jest.MockInstance; fatal: jest.MockInstance; fatal: jest.MockInstance; log: jest.MockInstance; log: jest.MockInstance; isLevelEnabled: jest.MockInstance; isLevelEnabled: jest.MockInstance; get: jest.MockInstance<", + "], unknown>; get: jest.MockInstance<", { "pluginId": "@kbn/logging", "scope": "common", @@ -404,7 +404,7 @@ "section": "def-common.Logger", "text": "Logger" }, - ", string[]>; } & ", + ", string[], unknown>; } & ", { "pluginId": "@kbn/logging", "scope": "common", diff --git a/api_docs/kbn_logging_mocks.mdx b/api_docs/kbn_logging_mocks.mdx index fc4c19983ea80..0357bf09a9db3 100644 --- a/api_docs/kbn_logging_mocks.mdx +++ b/api_docs/kbn_logging_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-logging-mocks title: "@kbn/logging-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/logging-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/logging-mocks'] --- import kbnLoggingMocksObj from './kbn_logging_mocks.devdocs.json'; diff --git a/api_docs/kbn_managed_vscode_config.mdx b/api_docs/kbn_managed_vscode_config.mdx index c87e28734802f..6e510e46694c5 100644 --- a/api_docs/kbn_managed_vscode_config.mdx +++ b/api_docs/kbn_managed_vscode_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-managed-vscode-config title: "@kbn/managed-vscode-config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/managed-vscode-config plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/managed-vscode-config'] --- import kbnManagedVscodeConfigObj from './kbn_managed_vscode_config.devdocs.json'; diff --git a/api_docs/kbn_management_cards_navigation.mdx b/api_docs/kbn_management_cards_navigation.mdx index 6e114e8188c6b..e80b81c8102ca 100644 --- a/api_docs/kbn_management_cards_navigation.mdx +++ b/api_docs/kbn_management_cards_navigation.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-management-cards-navigation title: "@kbn/management-cards-navigation" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/management-cards-navigation plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/management-cards-navigation'] --- import kbnManagementCardsNavigationObj from './kbn_management_cards_navigation.devdocs.json'; diff --git a/api_docs/kbn_management_storybook_config.mdx b/api_docs/kbn_management_storybook_config.mdx index b353e88bd74f3..186bbd3ca26bb 100644 --- a/api_docs/kbn_management_storybook_config.mdx +++ b/api_docs/kbn_management_storybook_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-management-storybook-config title: "@kbn/management-storybook-config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/management-storybook-config plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/management-storybook-config'] --- import kbnManagementStorybookConfigObj from './kbn_management_storybook_config.devdocs.json'; diff --git a/api_docs/kbn_mapbox_gl.devdocs.json b/api_docs/kbn_mapbox_gl.devdocs.json index 77583b59f73f0..176946b8db4e2 100644 --- a/api_docs/kbn_mapbox_gl.devdocs.json +++ b/api_docs/kbn_mapbox_gl.devdocs.json @@ -145,7 +145,7 @@ "label": "_data", "description": [], "signature": [ - "string | GeoJSON.GeoJSON" + "string | GeoJSON.GeoJSON | undefined" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -154,12 +154,12 @@ { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.GeoJSONSource._options", - "type": "Any", + "type": "Object", "tags": [], "label": "_options", "description": [], "signature": [ - "any" + "{ data?: string | GeoJSON.GeoJSON | undefined; cluster?: boolean | undefined; clusterMaxZoom?: number | undefined; clusterRadius?: number | undefined; clusterMinPoints?: number | undefined; generateId?: boolean | undefined; }" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -168,12 +168,12 @@ { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.GeoJSONSource.workerOptions", - "type": "Any", + "type": "Object", "tags": [], "label": "workerOptions", "description": [], "signature": [ - "any" + "{ source?: string | undefined; cluster?: boolean | undefined; geojsonVtOptions?: { buffer?: number | undefined; tolerance?: number | undefined; extent?: number | undefined; maxZoom?: number | undefined; linemetrics?: boolean | undefined; generateId?: boolean | undefined; } | undefined; superclusterOptions?: { maxZoom?: number | undefined; miniPoints?: number | undefined; extent?: number | undefined; radius?: number | undefined; log?: boolean | undefined; generateId?: boolean | undefined; } | undefined; clusterProperties?: any; fliter?: any; promoteId?: any; collectResourceTiming?: boolean | undefined; }" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -405,6 +405,82 @@ "this" ] }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.GeoJSONSource.updateData", + "type": "Function", + "tags": [], + "label": "updateData", + "description": [ + "\nUpdates the source's GeoJSON, and re-renders the map.\n\nFor sources with lots of features, this method can be used to make updates more quickly.\n\nThis approach requires unique IDs for every feature in the source. The IDs can either be specified on the feature,\nor by using the promoteId option to specify which property should be used as the ID.\n\nIt is an error to call updateData on a source that did not have unique IDs for each of its features already.\n\nUpdates are applied on a best-effort basis, updating an ID that does not exist will not result in an error.\n" + ], + "signature": [ + "(diff: maplibregl.GeoJSONSourceDiff) => this" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.GeoJSONSource.updateData.$1", + "type": "Object", + "tags": [], + "label": "diff", + "description": [ + "The changes that need to be applied." + ], + "signature": [ + "maplibregl.GeoJSONSourceDiff" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [ + "this" + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.GeoJSONSource.setClusterOptions", + "type": "Function", + "tags": [], + "label": "setClusterOptions", + "description": [ + "\nTo disable/enable clustering on the source options" + ], + "signature": [ + "(options: maplibregl.SetClusterOptions) => this" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.GeoJSONSource.setClusterOptions.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "The options to set" + ], + "signature": [ + "maplibregl.SetClusterOptions" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [ + "this" + ] + }, { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.GeoJSONSource.getClusterExpansionZoom", @@ -612,7 +688,7 @@ "label": "_updateWorkerData", "description": [], "signature": [ - "(sourceDataType: maplibregl.MapSourceDataType) => void" + "(diff?: maplibregl.GeoJSONSourceDiff | undefined) => void" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -621,17 +697,17 @@ { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.GeoJSONSource._updateWorkerData.$1", - "type": "CompoundType", + "type": "Object", "tags": [], - "label": "sourceDataType", + "label": "diff", "description": [], "signature": [ - "maplibregl.MapSourceDataType" + "maplibregl.GeoJSONSourceDiff | undefined" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "trackAdoption": false, - "isRequired": true + "isRequired": false } ], "returnComment": [] @@ -927,14 +1003,14 @@ "\nReturns the coordinates represented as an array of two numbers.\n" ], "signature": [ - "() => number[]" + "() => [number, number]" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [ - "The coordinates represeted as an array of longitude and latitude." + "The coordinates represented as an array of longitude and latitude." ] }, { @@ -995,44 +1071,6 @@ "Distance in meters between the two coordinates." ] }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-common.LngLat.toBounds", - "type": "Function", - "tags": [], - "label": "toBounds", - "description": [ - "\nReturns a `LngLatBounds` from the coordinates extended by a given `radius`. The returned `LngLatBounds` completely contains the `radius`.\n" - ], - "signature": [ - "(radius?: number | undefined) => maplibregl.LngLatBounds" - ], - "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-common.LngLat.toBounds.$1", - "type": "number", - "tags": [], - "label": "radius", - "description": [ - "Distance in meters from the coordinates to extend the bounds." - ], - "signature": [ - "number | undefined" - ], - "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": false - } - ], - "returnComment": [ - "A new `LngLatBounds` object representing the coordinates extended by the `radius`." - ] - }, { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.LngLat.convert", @@ -1133,32 +1171,36 @@ { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.LngLatBounds.Unnamed.$1", - "type": "Any", + "type": "CompoundType", "tags": [], "label": "sw", - "description": [], + "description": [ + "The southwest corner of the bounding box.\nOR array of 4 numbers in the order of west, south, east, north\nOR array of 2 LngLatLike: [sw,ne]" + ], "signature": [ - "any" + "[number, number, number, number] | maplibregl.LngLatLike | [maplibregl.LngLatLike, maplibregl.LngLatLike] | undefined" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "trackAdoption": false, - "isRequired": true + "isRequired": false }, { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.LngLatBounds.Unnamed.$2", - "type": "Any", + "type": "CompoundType", "tags": [], "label": "ne", - "description": [], + "description": [ + "The northeast corner of the bounding box." + ], "signature": [ - "any" + "maplibregl.LngLatLike | undefined" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "trackAdoption": false, - "isRequired": true + "isRequired": false } ], "returnComment": [] @@ -1467,7 +1509,7 @@ "\nReturns the bounding box represented as an array.\n" ], "signature": [ - "() => number[][]" + "() => [number, number][]" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -1592,6 +1634,61 @@ "returnComment": [ "A new `LngLatBounds` object, if a conversion occurred, or the original `LngLatBounds` object." ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.LngLatBounds.fromLngLat", + "type": "Function", + "tags": [], + "label": "fromLngLat", + "description": [ + "\nReturns a `LngLatBounds` from the coordinates extended by a given `radius`. The returned `LngLatBounds` completely contains the `radius`.\n" + ], + "signature": [ + "(center: maplibregl.LngLat, radius?: number | undefined) => maplibregl.LngLatBounds" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.LngLatBounds.fromLngLat.$1", + "type": "Object", + "tags": [], + "label": "center", + "description": [ + "center coordinates of the new bounds." + ], + "signature": [ + "maplibregl.LngLat" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.LngLatBounds.fromLngLat.$2", + "type": "number", + "tags": [], + "label": "radius", + "description": [ + "Distance in meters from the coordinates to extend the bounds." + ], + "signature": [ + "number | undefined" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [ + "A new `LngLatBounds` object representing the coordinates extended by the `radius`." + ] } ], "initialIsOpen": false @@ -1719,6 +1816,48 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map._cooperativeGestures", + "type": "CompoundType", + "tags": [], + "label": "_cooperativeGestures", + "description": [], + "signature": [ + "boolean | maplibregl.GestureOptions" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map._cooperativeGesturesScreen", + "type": "Object", + "tags": [], + "label": "_cooperativeGesturesScreen", + "description": [], + "signature": [ + "HTMLElement" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map._metaKey", + "type": "CompoundType", + "tags": [], + "label": "_metaKey", + "description": [], + "signature": [ + "keyof MouseEvent" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.Map._showTileBoundaries", @@ -1810,6 +1949,17 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map._maxTileCacheZoomLevels", + "type": "number", + "tags": [], + "label": "_maxTileCacheZoomLevels", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.Map._frame", @@ -1868,6 +2018,17 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map._idleTriggered", + "type": "boolean", + "tags": [], + "label": "_idleTriggered", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.Map._fullyLoaded", @@ -1890,6 +2051,20 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map._resizeObserver", + "type": "Object", + "tags": [], + "label": "_resizeObserver", + "description": [], + "signature": [ + "ResizeObserver" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.Map._preserveDrawingBuffer", @@ -2056,6 +2231,17 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map._validateStyle", + "type": "boolean", + "tags": [], + "label": "_validateStyle", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.Map._requestManager", @@ -2119,23 +2305,67 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-common.Map.scrollZoom", - "type": "Object", + "id": "def-common.Map._terrainDataCallback", + "type": "Function", "tags": [], - "label": "scrollZoom", - "description": [ - "\nThe map's {@link ScrollZoomHandler}, which implements zooming in and out with a scroll wheel or trackpad.\nFind more details and examples using `scrollZoom` in the {@link ScrollZoomHandler} section." - ], + "label": "_terrainDataCallback", + "description": [], "signature": [ - "maplibregl.ScrollZoomHandler" + "(e: maplibregl.MapStyleDataEvent | maplibregl.MapSourceDataEvent) => void" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-common.Map.boxZoom", + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map._terrainDataCallback.$1", + "type": "CompoundType", + "tags": [], + "label": "e", + "description": [], + "signature": [ + "maplibregl.MapStyleDataEvent | maplibregl.MapSourceDataEvent" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false + } + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map._imageQueueHandle", + "type": "number", + "tags": [], + "label": "_imageQueueHandle", + "description": [ + "image queue throttling handle. To be used later when clean up" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.scrollZoom", + "type": "Object", + "tags": [], + "label": "scrollZoom", + "description": [ + "\nThe map's {@link ScrollZoomHandler}, which implements zooming in and out with a scroll wheel or trackpad.\nFind more details and examples using `scrollZoom` in the {@link ScrollZoomHandler} section." + ], + "signature": [ + "maplibregl.ScrollZoomHandler" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.boxZoom", "type": "Object", "tags": [], "label": "boxZoom", @@ -2220,10 +2450,10 @@ "tags": [], "label": "touchZoomRotate", "description": [ - "\nThe map's {@link TouchZoomRotateHandler}, which allows the user to zoom or rotate the map with touch gestures.\nFind more details and examples using `touchZoomRotate` in the {@link TouchZoomRotateHandler} section." + "\nThe map's {@link TwoFingersTouchZoomRotateHandler}, which allows the user to zoom or rotate the map with touch gestures.\nFind more details and examples using `touchZoomRotate` in the {@link TwoFingersTouchZoomRotateHandler} section." ], "signature": [ - "maplibregl.TouchZoomRotateHandler" + "maplibregl.TwoFingersTouchZoomRotateHandler" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -2236,10 +2466,10 @@ "tags": [], "label": "touchPitch", "description": [ - "\nThe map's {@link TouchPitchHandler}, which allows the user to pitch the map with touch gestures.\nFind more details and examples using `touchPitch` in the {@link TouchPitchHandler} section." + "\nThe map's {@link TwoFingersTouchPitchHandler}, which allows the user to pitch the map with touch gestures.\nFind more details and examples using `touchPitch` in the {@link TwoFingersTouchPitchHandler} section." ], "signature": [ - "maplibregl.TouchPitchHandler" + "maplibregl.TwoFingersTouchPitchHandler" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -2426,6 +2656,83 @@ "True if map contains control." ] }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.calculateCameraOptionsFromTo", + "type": "Function", + "tags": [], + "label": "calculateCameraOptionsFromTo", + "description": [], + "signature": [ + "(from: maplibregl.LngLat, altitudeFrom: number, to: maplibregl.LngLat, altitudeTo?: number | undefined) => maplibregl.CameraOptions" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.calculateCameraOptionsFromTo.$1", + "type": "Object", + "tags": [], + "label": "from", + "description": [], + "signature": [ + "maplibregl.LngLat" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.calculateCameraOptionsFromTo.$2", + "type": "number", + "tags": [], + "label": "altitudeFrom", + "description": [], + "signature": [ + "number" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.calculateCameraOptionsFromTo.$3", + "type": "Object", + "tags": [], + "label": "to", + "description": [], + "signature": [ + "maplibregl.LngLat" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.calculateCameraOptionsFromTo.$4", + "type": "number", + "tags": [], + "label": "altitudeTo", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [] + }, { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.Map.resize", @@ -2892,6 +3199,64 @@ "`this`" ] }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.getCooperativeGestures", + "type": "Function", + "tags": [], + "label": "getCooperativeGestures", + "description": [ + "\nGets the map's cooperativeGestures option\n" + ], + "signature": [ + "() => boolean | maplibregl.GestureOptions" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [ + "gestureOptions" + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.setCooperativeGestures", + "type": "Function", + "tags": [], + "label": "setCooperativeGestures", + "description": [ + "\nSets or clears the map's cooperativeGestures option\n" + ], + "signature": [ + "(gestureOptions?: boolean | maplibregl.GestureOptions | null | undefined) => this" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.setCooperativeGestures.$1", + "type": "CompoundType", + "tags": [], + "label": "gestureOptions", + "description": [ + "If `true` or set to an options object, map is only accessible on desktop while holding Command/Ctrl and only accessible on mobile with two fingers. Interacting with the map using normal gestures will trigger an informational screen. With this option enabled, \"drag to pitch\" requires a three-finger gesture." + ], + "signature": [ + "boolean | maplibregl.GestureOptions | null | undefined" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [ + "`this`" + ] + }, { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.Map.project", @@ -3037,7 +3402,7 @@ "label": "_createDelegatedListener", "description": [], "signature": [ - "(type: string, layerId: string, listener: maplibregl.Listener) => { layer: string; listener: maplibregl.Listener; delegates: { error?: ((e: any) => void) | undefined; load?: ((e: any) => void) | undefined; idle?: ((e: any) => void) | undefined; remove?: ((e: any) => void) | undefined; render?: ((e: any) => void) | undefined; resize?: ((e: any) => void) | undefined; webglcontextlost?: ((e: any) => void) | undefined; webglcontextrestored?: ((e: any) => void) | undefined; dataloading?: ((e: any) => void) | undefined; data?: ((e: any) => void) | undefined; tiledataloading?: ((e: any) => void) | undefined; sourcedataloading?: ((e: any) => void) | undefined; styledataloading?: ((e: any) => void) | undefined; sourcedata?: ((e: any) => void) | undefined; styledata?: ((e: any) => void) | undefined; styleimagemissing?: ((e: any) => void) | undefined; dataabort?: ((e: any) => void) | undefined; sourcedataabort?: ((e: any) => void) | undefined; boxzoomcancel?: ((e: any) => void) | undefined; boxzoomstart?: ((e: any) => void) | undefined; boxzoomend?: ((e: any) => void) | undefined; touchcancel?: ((e: any) => void) | undefined; touchmove?: ((e: any) => void) | undefined; touchend?: ((e: any) => void) | undefined; touchstart?: ((e: any) => void) | undefined; click?: ((e: any) => void) | undefined; contextmenu?: ((e: any) => void) | undefined; dblclick?: ((e: any) => void) | undefined; mousemove?: ((e: any) => void) | undefined; mouseup?: ((e: any) => void) | undefined; mousedown?: ((e: any) => void) | undefined; mouseout?: ((e: any) => void) | undefined; mouseover?: ((e: any) => void) | undefined; movestart?: ((e: any) => void) | undefined; move?: ((e: any) => void) | undefined; moveend?: ((e: any) => void) | undefined; zoomstart?: ((e: any) => void) | undefined; zoom?: ((e: any) => void) | undefined; zoomend?: ((e: any) => void) | undefined; rotatestart?: ((e: any) => void) | undefined; rotate?: ((e: any) => void) | undefined; rotateend?: ((e: any) => void) | undefined; dragstart?: ((e: any) => void) | undefined; drag?: ((e: any) => void) | undefined; dragend?: ((e: any) => void) | undefined; pitchstart?: ((e: any) => void) | undefined; pitch?: ((e: any) => void) | undefined; pitchend?: ((e: any) => void) | undefined; wheel?: ((e: any) => void) | undefined; }; }" + "(type: string, layerId: string, listener: maplibregl.Listener) => { layer: string; listener: maplibregl.Listener; delegates: { error?: ((e: any) => void) | undefined; load?: ((e: any) => void) | undefined; idle?: ((e: any) => void) | undefined; remove?: ((e: any) => void) | undefined; render?: ((e: any) => void) | undefined; resize?: ((e: any) => void) | undefined; webglcontextlost?: ((e: any) => void) | undefined; webglcontextrestored?: ((e: any) => void) | undefined; dataloading?: ((e: any) => void) | undefined; data?: ((e: any) => void) | undefined; tiledataloading?: ((e: any) => void) | undefined; sourcedataloading?: ((e: any) => void) | undefined; styledataloading?: ((e: any) => void) | undefined; sourcedata?: ((e: any) => void) | undefined; styledata?: ((e: any) => void) | undefined; styleimagemissing?: ((e: any) => void) | undefined; dataabort?: ((e: any) => void) | undefined; sourcedataabort?: ((e: any) => void) | undefined; boxzoomcancel?: ((e: any) => void) | undefined; boxzoomstart?: ((e: any) => void) | undefined; boxzoomend?: ((e: any) => void) | undefined; touchcancel?: ((e: any) => void) | undefined; touchmove?: ((e: any) => void) | undefined; touchend?: ((e: any) => void) | undefined; touchstart?: ((e: any) => void) | undefined; click?: ((e: any) => void) | undefined; contextmenu?: ((e: any) => void) | undefined; dblclick?: ((e: any) => void) | undefined; mousemove?: ((e: any) => void) | undefined; mouseup?: ((e: any) => void) | undefined; mousedown?: ((e: any) => void) | undefined; mouseout?: ((e: any) => void) | undefined; mouseover?: ((e: any) => void) | undefined; movestart?: ((e: any) => void) | undefined; move?: ((e: any) => void) | undefined; moveend?: ((e: any) => void) | undefined; zoomstart?: ((e: any) => void) | undefined; zoom?: ((e: any) => void) | undefined; zoomend?: ((e: any) => void) | undefined; rotatestart?: ((e: any) => void) | undefined; rotate?: ((e: any) => void) | undefined; rotateend?: ((e: any) => void) | undefined; dragstart?: ((e: any) => void) | undefined; drag?: ((e: any) => void) | undefined; dragend?: ((e: any) => void) | undefined; pitchstart?: ((e: any) => void) | undefined; pitch?: ((e: any) => void) | undefined; pitchend?: ((e: any) => void) | undefined; wheel?: ((e: any) => void) | undefined; terrain?: ((e: any) => void) | undefined; }; }" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -3135,7 +3500,9 @@ "type": "string", "tags": [], "label": "layer", - "description": [], + "description": [ + "The ID of a style layer or a listener if no ID is provided. Event will only be triggered if its location\nis within a visible feature in this layer. The event will have a `features` property containing\nan array of the matching features. If `layerIdOrListener` is not supplied, the event will not have a `features` property.\nPlease note that many event types are not compatible with the optional `layerIdOrListener` parameter." + ], "signature": [ "string" ], @@ -3275,7 +3642,7 @@ "\nAdds a listener that will be called only once to a specified event type.\n\n\nAdds a listener that will be called only once to a specified event type occurring on features in a specified style layer.\n" ], "signature": [ - "{ (type: T, layer: string, listener: (ev: maplibregl.MapLayerEventType[T] & Object) => void): this; (type: T, listener: (ev: maplibregl.MapEventType[T] & Object) => void): this; (type: string, listener: maplibregl.Listener): this; }" + "{ (type: T, layer: string, listener?: ((ev: maplibregl.MapLayerEventType[T] & Object) => void) | undefined): this | Promise; (type: T, listener?: ((ev: maplibregl.MapEventType[T] & Object) => void) | undefined): Promise | this; (type: string, listener?: maplibregl.Listener | undefined): Promise | this; }" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -3304,7 +3671,9 @@ "type": "string", "tags": [], "label": "layer", - "description": [], + "description": [ + "The ID of a style layer or a listener if no ID is provided. Only events whose location is within a visible\nfeature in this layer will trigger the listener. The event will have a `features` property containing\nan array of the matching features." + ], "signature": [ "string" ], @@ -3323,12 +3692,12 @@ "The function to be called when the event is fired.\nThe listener function is called with the data object passed to `fire`,\nextended with `target` and `type` properties." ], "signature": [ - "(ev: maplibregl.MapLayerEventType[T] & Object) => void" + "((ev: maplibregl.MapLayerEventType[T] & Object) => void) | undefined" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "trackAdoption": false, - "isRequired": true + "isRequired": false } ], "returnComment": [ @@ -3343,7 +3712,7 @@ "label": "once", "description": [], "signature": [ - "{ (type: T, layer: string, listener: (ev: maplibregl.MapLayerEventType[T] & Object) => void): this; (type: T, listener: (ev: maplibregl.MapEventType[T] & Object) => void): this; (type: string, listener: maplibregl.Listener): this; }" + "{ (type: T, layer: string, listener?: ((ev: maplibregl.MapLayerEventType[T] & Object) => void) | undefined): this | Promise; (type: T, listener?: ((ev: maplibregl.MapEventType[T] & Object) => void) | undefined): Promise | this; (type: string, listener?: maplibregl.Listener | undefined): Promise | this; }" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -3372,12 +3741,12 @@ "label": "listener", "description": [], "signature": [ - "(ev: maplibregl.MapEventType[T] & Object) => void" + "((ev: maplibregl.MapEventType[T] & Object) => void) | undefined" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "trackAdoption": false, - "isRequired": true + "isRequired": false } ], "returnComment": [] @@ -3390,7 +3759,7 @@ "label": "once", "description": [], "signature": [ - "{ (type: T, layer: string, listener: (ev: maplibregl.MapLayerEventType[T] & Object) => void): this; (type: T, listener: (ev: maplibregl.MapEventType[T] & Object) => void): this; (type: string, listener: maplibregl.Listener): this; }" + "{ (type: T, layer: string, listener?: ((ev: maplibregl.MapLayerEventType[T] & Object) => void) | undefined): this | Promise; (type: T, listener?: ((ev: maplibregl.MapEventType[T] & Object) => void) | undefined): Promise | this; (type: string, listener?: maplibregl.Listener | undefined): Promise | this; }" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -3419,12 +3788,12 @@ "label": "listener", "description": [], "signature": [ - "maplibregl.Listener" + "maplibregl.Listener | undefined" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "trackAdoption": false, - "isRequired": true + "isRequired": false } ], "returnComment": [] @@ -3473,7 +3842,9 @@ "type": "string", "tags": [], "label": "layer", - "description": [], + "description": [ + "The layer ID or listener previously used to install the listener." + ], "signature": [ "string" ], @@ -3610,7 +3981,7 @@ "\nReturns an array of MapGeoJSONFeature objects\nrepresenting visible features that satisfy the query parameters.\n" ], "signature": [ - "(geometry?: maplibregl.PointLike | [maplibregl.PointLike, maplibregl.PointLike] | undefined, options?: any) => maplibregl.MapGeoJSONFeature[]" + "(geometryOrOptions?: maplibregl.PointLike | [maplibregl.PointLike, maplibregl.PointLike] | maplibregl.QueryRenderedFeaturesOptions | undefined, options?: maplibregl.QueryRenderedFeaturesOptions | undefined) => maplibregl.MapGeoJSONFeature[]" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -3621,12 +3992,12 @@ "id": "def-common.Map.queryRenderedFeatures.$1", "type": "CompoundType", "tags": [], - "label": "geometry", + "label": "geometryOrOptions", "description": [ - "- The geometry of the query region:\neither a single point or southwest and northeast points describing a bounding box.\nOmitting this parameter (i.e. calling {@link MapqueryRenderedFeatures } with zero arguments,\nor with only a `options` argument) is equivalent to passing a bounding box encompassing the entire\nmap viewport." + "(optional) The geometry of the query region:\neither a single point or southwest and northeast points describing a bounding box.\nOmitting this parameter (i.e. calling {@link MapqueryRenderedFeatures } with zero arguments,\nor with only a `options` argument) is equivalent to passing a bounding box encompassing the entire\nmap viewport.\nThe geometryOrOptions can receive a QueryRenderedFeaturesOptions only to support a situation where the function receives only one parameter which is the options parameter." ], "signature": [ - "maplibregl.PointLike | [maplibregl.PointLike, maplibregl.PointLike] | undefined" + "maplibregl.PointLike | [maplibregl.PointLike, maplibregl.PointLike] | maplibregl.QueryRenderedFeaturesOptions | undefined" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -3636,23 +4007,23 @@ { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.Map.queryRenderedFeatures.$2", - "type": "Any", + "type": "Object", "tags": [], "label": "options", "description": [ - "Options object." + "(optional) Options object." ], "signature": [ - "any" + "maplibregl.QueryRenderedFeaturesOptions | undefined" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "trackAdoption": false, - "isRequired": true + "isRequired": false } ], "returnComment": [ - "An array of MapGeoJSONFeature objects.\n\nThe `properties` value of each returned feature object contains the properties of its source feature. For GeoJSON sources, only\nstring and numeric property values are supported (i.e. `null`, `Array`, and `Object` values are not supported).\n\nEach feature includes top-level `layer`, `source`, and `sourceLayer` properties. The `layer` property is an object\nrepresenting the style layer to which the feature belongs. Layout and paint properties in this object contain values\nwhich are fully evaluated for the given zoom level and feature.\n\nOnly features that are currently rendered are included. Some features will **not** be included, like:\n\n- Features from layers whose `visibility` property is `\"none\"`.\n- Features from layers whose zoom range excludes the current zoom level.\n- Symbol features that have been hidden due to text or icon collision.\n\nFeatures from all other layers are included, including features that may have no visible\ncontribution to the rendered result; for example, because the layer's opacity or color alpha component is set to\n0.\n\nThe topmost rendered feature appears first in the returned array, and subsequent features are sorted by\ndescending z-order. Features that are rendered multiple times (due to wrapping across the antimeridian at low\nzoom levels) are returned only once (though subject to the following caveat).\n\nBecause features come from tiled vector data or GeoJSON data that is converted to tiles internally, feature\ngeometries may be split or duplicated across tile boundaries and, as a result, features may appear multiple\ntimes in query results. For example, suppose there is a highway running through the bounding rectangle of a query.\nThe results of the query will be those parts of the highway that lie within the map tiles covering the bounding\nrectangle, even if the highway extends into other tiles, and the portion of the highway within each map tile\nwill be returned as a separate feature. Similarly, a point feature near a tile boundary may appear in multiple\ntiles due to tile buffering." + "An array of MapGeoJSONFeature objects.\n\nThe `properties` value of each returned feature object contains the properties of its source feature. For GeoJSON sources, only\nstring and numeric property values are supported (i.e. `null`, `Array`, and `Object` values are not supported).\n\nEach feature includes top-level `layer`, `source`, and `sourceLayer` properties. The `layer` property is an object\nrepresenting the style layer to which the feature belongs. Layout and paint properties in this object contain values\nwhich are fully evaluated for the given zoom level and feature.\n\nOnly features that are currently rendered are included. Some features will **not** be included, like:\n\n- Features from layers whose `visibility` property is `\"none\"`.\n- Features from layers whose zoom range excludes the current zoom level.\n- Symbol features that have been hidden due to text or icon collision.\n\nFeatures from all other layers are included, including features that may have no visible\ncontribution to the rendered result; for example, because the layer's opacity or color alpha component is set to\n0.\n\nThe topmost rendered feature appears first in the returned array, and subsequent features are sorted by\ndescending z-order. Features that are rendered multiple times (due to wrapping across the antemeridian at low\nzoom levels) are returned only once (though subject to the following caveat).\n\nBecause features come from tiled vector data or GeoJSON data that is converted to tiles internally, feature\ngeometries may be split or duplicated across tile boundaries and, as a result, features may appear multiple\ntimes in query results. For example, suppose there is a highway running through the bounding rectangle of a query.\nThe results of the query will be those parts of the highway that lie within the map tiles covering the bounding\nrectangle, even if the highway extends into other tiles, and the portion of the highway within each map tile\nwill be returned as a separate feature. Similarly, a point feature near a tile boundary may appear in multiple\ntiles due to tile buffering." ] }, { @@ -3665,7 +4036,7 @@ "\nReturns an array of MapGeoJSONFeature objects\nrepresenting features within the specified vector tile or GeoJSON source that satisfy the query parameters.\n" ], "signature": [ - "(sourceId: string, parameters?: { sourceLayer: string; filter: any[]; validate?: boolean | undefined; } | null | undefined) => maplibregl.MapGeoJSONFeature[]" + "(sourceId: string, parameters?: { sourceLayer?: string | undefined; filter?: maplibregl.FilterSpecification | undefined; validate?: boolean | undefined; } | null | undefined) => maplibregl.MapGeoJSONFeature[]" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -3698,7 +4069,7 @@ "Options object." ], "signature": [ - "{ sourceLayer: string; filter: any[]; validate?: boolean | undefined; } | null | undefined" + "{ sourceLayer?: string | undefined; filter?: maplibregl.FilterSpecification | undefined; validate?: boolean | undefined; } | null | undefined" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -3720,7 +4091,7 @@ "\nUpdates the map's MapLibre style object with a new value.\n\nIf a style is already set when this is used and options.diff is set to true, the map renderer will attempt to compare the given style\nagainst the map's current state and perform only the changes necessary to make the map style match the desired state. Changes in sprites\n(images used for icons and patterns) and glyphs (fonts for label text) **cannot** be diffed. If the sprites or fonts used in the current\nstyle and the given style are different in any way, the map renderer will force a full update, removing the current style and building\nthe given one from scratch.\n\n" ], "signature": [ - "(style: string | maplibregl.StyleSpecification | null, options?: ({ diff?: boolean | undefined; } & maplibregl.StyleOptions) | undefined) => this" + "(style: string | maplibregl.StyleSpecification | null, options?: (maplibregl.StyleSwapOptions & maplibregl.StyleOptions) | undefined) => this" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -3733,7 +4104,7 @@ "tags": [], "label": "style", "description": [ - "A JSON object conforming to the schema described in the\n[MapLibre Style Specification](https://maplibre.org/maplibre-gl-js-docs/style-spec/), or a URL to such JSON." + "A JSON object conforming to the schema described in the\n[MapLibre Style Specification](https://maplibre.org/maplibre-style-spec/), or a URL to such JSON." ], "signature": [ "string | maplibregl.StyleSpecification | null" @@ -3753,7 +4124,7 @@ "Options object." ], "signature": [ - "({ diff?: boolean | undefined; } & maplibregl.StyleOptions) | undefined" + "(maplibregl.StyleSwapOptions & maplibregl.StyleOptions) | undefined" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -3843,7 +4214,7 @@ "label": "_updateStyle", "description": [], "signature": [ - "(style: string | maplibregl.StyleSpecification | null, options?: ({ diff?: boolean | undefined; } & maplibregl.StyleOptions) | undefined) => this" + "(style: string | maplibregl.StyleSpecification | null, options?: (maplibregl.StyleSwapOptions & maplibregl.StyleOptions) | undefined) => this" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -3872,7 +4243,7 @@ "label": "options", "description": [], "signature": [ - "({ diff?: boolean | undefined; } & maplibregl.StyleOptions) | undefined" + "(maplibregl.StyleSwapOptions & maplibregl.StyleOptions) | undefined" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -3906,7 +4277,7 @@ "label": "_diffStyle", "description": [], "signature": [ - "(style: string | maplibregl.StyleSpecification, options?: ({ diff?: boolean | undefined; } & maplibregl.StyleOptions) | undefined) => void" + "(style: string | maplibregl.StyleSpecification, options?: (maplibregl.StyleSwapOptions & maplibregl.StyleOptions) | undefined) => void" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -3935,7 +4306,7 @@ "label": "options", "description": [], "signature": [ - "({ diff?: boolean | undefined; } & maplibregl.StyleOptions) | undefined" + "(maplibregl.StyleSwapOptions & maplibregl.StyleOptions) | undefined" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -3953,7 +4324,7 @@ "label": "_updateDiff", "description": [], "signature": [ - "(style: maplibregl.StyleSpecification, options?: ({ diff?: boolean | undefined; } & maplibregl.StyleOptions) | undefined) => void" + "(style: maplibregl.StyleSpecification, options?: (maplibregl.StyleSwapOptions & maplibregl.StyleOptions) | undefined) => void" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -3982,7 +4353,7 @@ "label": "options", "description": [], "signature": [ - "({ diff?: boolean | undefined; } & maplibregl.StyleOptions) | undefined" + "(maplibregl.StyleSwapOptions & maplibregl.StyleOptions) | undefined" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -4075,7 +4446,7 @@ "tags": [], "label": "source", "description": [ - "The source object, conforming to the\nMapLibre Style Specification's [source definition](https://maplibre.org/maplibre-gl-js-docs/style-spec/#sources) or\n{@link CanvasSourceOptions }." + "The source object, conforming to the\nMapLibre Style Specification's [source definition](https://maplibre.org/maplibre-style-spec/#sources) or\n{@link CanvasSourceOptions }." ], "signature": [ "maplibregl.SourceSpecification" @@ -4128,6 +4499,64 @@ "A Boolean indicating whether the source is loaded." ] }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.setTerrain", + "type": "Function", + "tags": [], + "label": "setTerrain", + "description": [ + "\nLoads a 3D terrain mesh, based on a \"raster-dem\" source." + ], + "signature": [ + "(options: maplibregl.TerrainSpecification) => maplibregl.Map" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.setTerrain.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "Options object." + ], + "signature": [ + "maplibregl.TerrainSpecification" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [ + "`this`" + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.getTerrain", + "type": "Function", + "tags": [], + "label": "getTerrain", + "description": [ + "\nGet the terrain-options if terrain is loaded" + ], + "signature": [ + "() => maplibregl.TerrainSpecification" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [ + "the TerrainSpecification passed to setTerrain" + ] + }, { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.Map.areTilesLoaded", @@ -4230,7 +4659,7 @@ "\nRemoves a source from the map's style.\n" ], "signature": [ - "(id: string) => this" + "(id: string) => maplibregl.Map" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -4297,7 +4726,7 @@ } ], "returnComment": [ - "The style source with the specified ID or `undefined` if the ID\ncorresponds to no existing sources.\nThe shape of the object varies by source type.\nA list of options for each source type is available on the MapLibre Style Specification's\n[Sources](https://maplibre.org/maplibre-gl-js-docs/style-spec/sources/) page." + "The style source with the specified ID or `undefined` if the ID\ncorresponds to no existing sources.\nThe shape of the object varies by source type.\nA list of options for each source type is available on the MapLibre Style Specification's\n[Sources](https://maplibre.org/maplibre-style-spec/sources/) page." ] }, { @@ -4310,7 +4739,7 @@ ], "label": "addImage", "description": [ - "\nAdd an image to the style. This image can be displayed on the map like any other icon in the style's\nsprite using the image's ID with\n[`icon-image`](https://maplibre.org/maplibre-gl-js-docs/style-spec/#layout-symbol-icon-image),\n[`background-pattern`](https://maplibre.org/maplibre-gl-js-docs/style-spec/#paint-background-background-pattern),\n[`fill-pattern`](https://maplibre.org/maplibre-gl-js-docs/style-spec/#paint-fill-fill-pattern),\nor [`line-pattern`](https://maplibre.org/maplibre-gl-js-docs/style-spec/#paint-line-line-pattern).\nA {@link Map.event:error} event will be fired if there is not enough space in the sprite to add this image.\n" + "\nAdd an image to the style. This image can be displayed on the map like any other icon in the style's\nsprite using the image's ID with\n[`icon-image`](https://maplibre.org/maplibre-style-spec/#layout-symbol-icon-image),\n[`background-pattern`](https://maplibre.org/maplibre-style-spec/#paint-background-background-pattern),\n[`fill-pattern`](https://maplibre.org/maplibre-style-spec/#paint-fill-fill-pattern),\nor [`line-pattern`](https://maplibre.org/maplibre-style-spec/#paint-line-line-pattern).\nA {@link Map.event:error} event will be fired if there is not enough space in the sprite to add this image.\n" ], "signature": [ "(id: string, image: HTMLImageElement | ImageBitmap | ImageData | { width: number; height: number; data: Uint8Array | Uint8ClampedArray; } | maplibregl.StyleImageInterface, { pixelRatio, sdf, stretchX, stretchY, content }?: Partial | undefined) => this" @@ -4378,7 +4807,7 @@ "tags": [], "label": "updateImage", "description": [ - "\nUpdate an existing image in a style. This image can be displayed on the map like any other icon in the style's\nsprite using the image's ID with\n[`icon-image`](https://maplibre.org/maplibre-gl-js-docs/style-spec/#layout-symbol-icon-image),\n[`background-pattern`](https://maplibre.org/maplibre-gl-js-docs/style-spec/#paint-background-background-pattern),\n[`fill-pattern`](https://maplibre.org/maplibre-gl-js-docs/style-spec/#paint-fill-fill-pattern),\nor [`line-pattern`](https://maplibre.org/maplibre-gl-js-docs/style-spec/#paint-line-line-pattern).\n" + "\nUpdate an existing image in a style. This image can be displayed on the map like any other icon in the style's\nsprite using the image's ID with\n[`icon-image`](https://maplibre.org/maplibre-style-spec/#layout-symbol-icon-image),\n[`background-pattern`](https://maplibre.org/maplibre-style-spec/#paint-background-background-pattern),\n[`fill-pattern`](https://maplibre.org/maplibre-style-spec/#paint-fill-fill-pattern),\nor [`line-pattern`](https://maplibre.org/maplibre-style-spec/#paint-line-line-pattern).\n" ], "signature": [ "(id: string, image: HTMLImageElement | ImageBitmap | ImageData | maplibregl.StyleImageInterface | { width: number; height: number; data: Uint8Array | Uint8ClampedArray; }) => this" @@ -4424,6 +4853,44 @@ ], "returnComment": [] }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.getImage", + "type": "Function", + "tags": [], + "label": "getImage", + "description": [ + "\nReturns an image, specified by ID, currently available in the map.\nThis includes both images from the style's original sprite\nand any images that have been added at runtime using {@link Map#addImage}.\n" + ], + "signature": [ + "(id: string) => maplibregl.StyleImage" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.getImage.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "The ID of the image." + ], + "signature": [ + "string" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [ + "An image in the map with the specified ID." + ] + }, { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.Map.hasImage", @@ -4584,10 +5051,10 @@ ], "label": "addLayer", "description": [ - "\nAdds a [MapLibre style layer](https://maplibre.org/maplibre-gl-js-docs/style-spec/#layers)\nto the map's style.\n\nA layer defines how data from a specified source will be styled. Read more about layer types\nand available paint and layout properties in the [MapLibre Style Specification](https://maplibre.org/maplibre-gl-js-docs/style-spec/#layers).\n" + "\nAdds a [MapLibre style layer](https://maplibre.org/maplibre-style-spec/#layers)\nto the map's style.\n\nA layer defines how data from a specified source will be styled. Read more about layer types\nand available paint and layout properties in the [MapLibre Style Specification](https://maplibre.org/maplibre-style-spec/#layers).\n\nTODO: JSDoc can't pass @param {(LayerSpecification & {source?: string | SourceSpecification}) | CustomLayerInterface} layer The layer to add," ], "signature": [ - "(layer: maplibregl.LayerSpecification | maplibregl.CustomLayerInterface, beforeId?: string | undefined) => this" + "(layer: (maplibregl.LayerSpecification & { source?: string | maplibregl.SourceSpecification | undefined; }) | maplibregl.CustomLayerInterface, beforeId?: string | undefined) => this" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -4600,10 +5067,10 @@ "tags": [], "label": "layer", "description": [ - "The layer to add, conforming to either the MapLibre Style Specification's [layer definition](https://maplibre.org/maplibre-gl-js-docs/style-spec/#layers) or, less commonly, the {@link CustomLayerInterface } specification.\nThe MapLibre Style Specification's layer definition is appropriate for most layers." + "conforming to either the MapLibre Style Specification's [layer definition](https://maplibre.org/maplibre-style-spec/#layers) or,\nless commonly, the {@link CustomLayerInterface } specification.\nThe MapLibre Style Specification's layer definition is appropriate for most layers." ], "signature": [ - "maplibregl.LayerSpecification | maplibregl.CustomLayerInterface" + "(maplibregl.LayerSpecification & { source?: string | maplibregl.SourceSpecification | undefined; }) | maplibregl.CustomLayerInterface" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -4773,7 +5240,7 @@ "tags": [], "label": "setLayerZoomRange", "description": [ - "\nSets the zoom extent for the specified style layer. The zoom extent includes the\n[minimum zoom level](https://maplibre.org/maplibre-gl-js-docs/style-spec/#layer-minzoom)\nand [maximum zoom level](https://maplibre.org/maplibre-gl-js-docs/style-spec/#layer-maxzoom))\nat which the layer will be rendered.\n\nNote: For style layers using vector sources, style layers cannot be rendered at zoom levels lower than the\nminimum zoom level of the _source layer_ because the data does not exist at those zoom levels. If the minimum\nzoom level of the source layer is higher than the minimum zoom level defined in the style layer, the style\nlayer will not be rendered at all zoom levels in the zoom range.\n" + "\nSets the zoom extent for the specified style layer. The zoom extent includes the\n[minimum zoom level](https://maplibre.org/maplibre-style-spec/#layer-minzoom)\nand [maximum zoom level](https://maplibre.org/maplibre-style-spec/#layer-maxzoom))\nat which the layer will be rendered.\n\nNote: For style layers using vector sources, style layers cannot be rendered at zoom levels lower than the\nminimum zoom level of the _source layer_ because the data does not exist at those zoom levels. If the minimum\nzoom level of the source layer is higher than the minimum zoom level defined in the style layer, the style\nlayer will not be rendered at all zoom levels in the zoom range.\n" ], "signature": [ "(layerId: string, minzoom: number, maxzoom: number) => this" @@ -4880,7 +5347,7 @@ "tags": [], "label": "filter", "description": [ - "The filter, conforming to the MapLibre Style Specification's\n[filter definition](https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/#filter). If `null` or `undefined` is provided, the function removes any existing filter from the layer." + "The filter, conforming to the MapLibre Style Specification's\n[filter definition](https://maplibre.org/maplibre-style-spec/layers/#filter). If `null` or `undefined` is provided, the function removes any existing filter from the layer." ], "signature": [ "maplibregl.FilterSpecification | null | undefined" @@ -5010,7 +5477,7 @@ "tags": [], "label": "value", "description": [ - "The value of the paint property to set.\nMust be of a type appropriate for the property, as defined in the [MapLibre Style Specification](https://maplibre.org/maplibre-gl-js-docs/style-spec/)." + "The value of the paint property to set.\nMust be of a type appropriate for the property, as defined in the [MapLibre Style Specification](https://maplibre.org/maplibre-style-spec/)." ], "signature": [ "any" @@ -5154,7 +5621,7 @@ "tags": [], "label": "value", "description": [ - "The value of the layout property. Must be of a type appropriate for the property, as defined in the [MapLibre Style Specification](https://maplibre.org/maplibre-gl-js-docs/style-spec/)." + "The value of the layout property. Must be of a type appropriate for the property, as defined in the [MapLibre Style Specification](https://maplibre.org/maplibre-style-spec/)." ], "signature": [ "any" @@ -5166,20 +5633,264 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-common.Map.setLayoutProperty.$4", - "type": "Object", + "id": "def-common.Map.setLayoutProperty.$4", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "Options object." + ], + "signature": [ + "maplibregl.StyleSetterOptions | undefined" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [ + "`this`" + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.getLayoutProperty", + "type": "Function", + "tags": [], + "label": "getLayoutProperty", + "description": [ + "\nReturns the value of a layout property in the specified style layer.\n" + ], + "signature": [ + "(layerId: string, name: string) => any" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.getLayoutProperty.$1", + "type": "string", + "tags": [], + "label": "layerId", + "description": [ + "The ID of the layer to get the layout property from." + ], + "signature": [ + "string" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.getLayoutProperty.$2", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "The name of the layout property to get." + ], + "signature": [ + "string" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [ + "The value of the specified layout property." + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.setGlyphs", + "type": "Function", + "tags": [], + "label": "setGlyphs", + "description": [ + "\nSets the value of the style's glyphs property.\n" + ], + "signature": [ + "(glyphsUrl: string | null, options?: maplibregl.StyleSetterOptions | undefined) => this" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.setGlyphs.$1", + "type": "CompoundType", + "tags": [], + "label": "glyphsUrl", + "description": [ + "Glyph URL to set. Must conform to the [MapLibre Style Specification](https://maplibre.org/maplibre-style-spec/glyphs/)." + ], + "signature": [ + "string | null" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.setGlyphs.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "Options object." + ], + "signature": [ + "maplibregl.StyleSetterOptions | undefined" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [ + "`this`" + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.getGlyphs", + "type": "Function", + "tags": [], + "label": "getGlyphs", + "description": [ + "\nReturns the value of the style's glyphs URL\n" + ], + "signature": [ + "() => string" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [ + "glyphs Style's glyphs url" + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.addSprite", + "type": "Function", + "tags": [ + "fires" + ], + "label": "addSprite", + "description": [ + "\nAdds a sprite to the map's style.\n" + ], + "signature": [ + "(id: string, url: string, options?: maplibregl.StyleSetterOptions | undefined) => this" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.addSprite.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "The ID of the sprite to add. Must not conflict with existing sprites." + ], + "signature": [ + "string" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.addSprite.$2", + "type": "string", + "tags": [], + "label": "url", + "description": [ + "The URL to load the sprite from" + ], + "signature": [ + "string" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.addSprite.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "Options object." + ], + "signature": [ + "maplibregl.StyleSetterOptions | undefined" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [ + "`this`" + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.removeSprite", + "type": "Function", + "tags": [ + "fires" + ], + "label": "removeSprite", + "description": [ + "\nRemoves the sprite from the map's style.\n" + ], + "signature": [ + "(id: string) => this" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.removeSprite.$1", + "type": "string", "tags": [], - "label": "options", + "label": "id", "description": [ - "Options object." + "The ID of the sprite to remove. If the sprite is declared as a single URL, the ID must be \"default\"." ], "signature": [ - "maplibregl.StyleSetterOptions | undefined" + "string" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "trackAdoption": false, - "isRequired": false + "isRequired": true } ], "returnComment": [ @@ -5188,15 +5899,35 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-common.Map.getLayoutProperty", + "id": "def-common.Map.getSprite", "type": "Function", "tags": [], - "label": "getLayoutProperty", + "label": "getSprite", "description": [ - "\nReturns the value of a layout property in the specified style layer.\n" + "\nReturns the as-is value of the style's sprite.\n" ], "signature": [ - "(layerId: string, name: string) => any" + "() => { id: string; url: string; }[]" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [ + "style's sprite url or a list of id-url pairs" + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.setSprite", + "type": "Function", + "tags": [], + "label": "setSprite", + "description": [ + "\nSets the value of the style's sprite property.\n" + ], + "signature": [ + "(spriteUrl: string | null, options?: maplibregl.StyleSetterOptions | undefined) => this" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -5204,41 +5935,41 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-common.Map.getLayoutProperty.$1", - "type": "string", + "id": "def-common.Map.setSprite.$1", + "type": "CompoundType", "tags": [], - "label": "layerId", + "label": "spriteUrl", "description": [ - "The ID of the layer to get the layout property from." + "Sprite URL to set." ], "signature": [ - "string" + "string | null" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "trackAdoption": false, - "isRequired": true + "isRequired": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-common.Map.getLayoutProperty.$2", - "type": "string", + "id": "def-common.Map.setSprite.$2", + "type": "Object", "tags": [], - "label": "name", + "label": "options", "description": [ - "The name of the layout property to get." + "Options object." ], "signature": [ - "string" + "maplibregl.StyleSetterOptions | undefined" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "trackAdoption": false, - "isRequired": true + "isRequired": false } ], "returnComment": [ - "The value of the specified layout property." + "`this`" ] }, { @@ -5264,7 +5995,7 @@ "tags": [], "label": "light", "description": [ - "Light properties to set. Must conform to the [MapLibre Style Specification](https://maplibre.org/maplibre-gl-js-docs/style-spec/#light)." + "Light properties to set. Must conform to the [MapLibre Style Specification](https://maplibre.org/maplibre-style-spec/#light)." ], "signature": [ "maplibregl.LightSpecification" @@ -5325,7 +6056,7 @@ ], "label": "setFeatureState", "description": [ - "\nSets the `state` of a feature.\nA feature's `state` is a set of user-defined key-value pairs that are assigned to a feature at runtime.\nWhen using this method, the `state` object is merged with any existing key-value pairs in the feature's state.\nFeatures are identified by their `feature.id` attribute, which can be any number or string.\n\nThis method can only be used with sources that have a `feature.id` attribute. The `feature.id` attribute can be defined in three ways:\n- For vector or GeoJSON sources, including an `id` attribute in the original data file.\n- For vector or GeoJSON sources, using the [`promoteId`](https://maplibre.org/maplibre-gl-js-docs/style-spec/sources/#vector-promoteId) option at the time the source is defined.\n- For GeoJSON sources, using the [`generateId`](https://maplibre.org/maplibre-gl-js-docs/style-spec/sources/#geojson-generateId) option to auto-assign an `id` based on the feature's index in the source data. If you change feature data using `map.getSource('some id').setData(..)`, you may need to re-apply state taking into account updated `id` values.\n\n_Note: You can use the [`feature-state` expression](https://maplibre.org/maplibre-gl-js-docs/style-spec/expressions/#feature-state) to access the values in a feature's state object for the purposes of styling._\n" + "\nSets the `state` of a feature.\nA feature's `state` is a set of user-defined key-value pairs that are assigned to a feature at runtime.\nWhen using this method, the `state` object is merged with any existing key-value pairs in the feature's state.\nFeatures are identified by their `feature.id` attribute, which can be any number or string.\n\nThis method can only be used with sources that have a `feature.id` attribute. The `feature.id` attribute can be defined in three ways:\n- For vector or GeoJSON sources, including an `id` attribute in the original data file.\n- For vector or GeoJSON sources, using the [`promoteId`](https://maplibre.org/maplibre-style-spec/sources/#vector-promoteId) option at the time the source is defined.\n- For GeoJSON sources, using the [`generateId`](https://maplibre.org/maplibre-style-spec/sources/#geojson-generateId) option to auto-assign an `id` based on the feature's index in the source data. If you change feature data using `map.getSource('some id').setData(..)`, you may need to re-apply state taking into account updated `id` values.\n\n_Note: You can use the [`feature-state` expression](https://maplibre.org/maplibre-style-spec/expressions/#feature-state) to access the values in a feature's state object for the purposes of styling._\n" ], "signature": [ "(feature: maplibregl.FeatureIdentifier, state: any) => this" @@ -5431,7 +6162,7 @@ "tags": [], "label": "getFeatureState", "description": [ - "\nGets the `state` of a feature.\nA feature's `state` is a set of user-defined key-value pairs that are assigned to a feature at runtime.\nFeatures are identified by their `feature.id` attribute, which can be any number or string.\n\n_Note: To access the values in a feature's state object for the purposes of styling the feature, use the [`feature-state` expression](https://maplibre.org/maplibre-gl-js-docs/style-spec/expressions/#feature-state)._\n" + "\nGets the `state` of a feature.\nA feature's `state` is a set of user-defined key-value pairs that are assigned to a feature at runtime.\nFeatures are identified by their `feature.id` attribute, which can be any number or string.\n\n_Note: To access the values in a feature's state object for the purposes of styling the feature, use the [`feature-state` expression](https://maplibre.org/maplibre-style-spec/expressions/#feature-state)._\n" ], "signature": [ "(feature: maplibregl.FeatureIdentifier) => any" @@ -5560,6 +6291,70 @@ "children": [], "returnComment": [] }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map._cooperativeGesturesOnWheel", + "type": "Function", + "tags": [], + "label": "_cooperativeGesturesOnWheel", + "description": [], + "signature": [ + "(event: WheelEvent) => void" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map._cooperativeGesturesOnWheel.$1", + "type": "Object", + "tags": [], + "label": "event", + "description": [], + "signature": [ + "WheelEvent" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map._setupCooperativeGestures", + "type": "Function", + "tags": [], + "label": "_setupCooperativeGestures", + "description": [], + "signature": [ + "() => void" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map._destroyCooperativeGestures", + "type": "Function", + "tags": [], + "label": "_destroyCooperativeGestures", + "description": [], + "signature": [ + "() => void" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + }, { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.Map._resizeCanvas", @@ -5734,6 +6529,68 @@ ], "returnComment": [] }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map._onCooperativeGesture", + "type": "Function", + "tags": [], + "label": "_onCooperativeGesture", + "description": [], + "signature": [ + "(event: any, metaPress: any, touches: any) => boolean" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map._onCooperativeGesture.$1", + "type": "Any", + "tags": [], + "label": "event", + "description": [], + "signature": [ + "any" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map._onCooperativeGesture.$2", + "type": "Any", + "tags": [], + "label": "metaPress", + "description": [], + "signature": [ + "any" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map._onCooperativeGesture.$3", + "type": "Any", + "tags": [], + "label": "touches", + "description": [], + "signature": [ + "any" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.Map.loaded", @@ -5979,38 +6836,6 @@ "children": [], "returnComment": [] }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-common.Map._onWindowResize", - "type": "Function", - "tags": [], - "label": "_onWindowResize", - "description": [], - "signature": [ - "(event: maplibregl.Event) => void" - ], - "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-common.Map._onWindowResize.$1", - "type": "Object", - "tags": [], - "label": "event", - "description": [], - "signature": [ - "maplibregl.Event" - ], - "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] - }, { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.Map.showTileBoundaries", @@ -6173,50 +6998,36 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-common.Map._setCacheLimits", + "id": "def-common.Map.version", + "type": "string", + "tags": [], + "label": "version", + "description": [ + "\nReturns the package version of the library" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.Map.getCameraTargetElevation", "type": "Function", "tags": [], - "label": "_setCacheLimits", - "description": [], + "label": "getCameraTargetElevation", + "description": [ + "\nReturns the elevation for the point where the camera is looking.\nThis value corresponds to:\n\"meters above sea level\" * \"exaggeration\"" + ], "signature": [ - "(limit: number, checkThreshold: number) => void" + "() => number" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-common.Map._setCacheLimits.$1", - "type": "number", - "tags": [], - "label": "limit", - "description": [], - "signature": [ - "number" - ], - "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-common.Map._setCacheLimits.$2", - "type": "number", - "tags": [], - "label": "checkThreshold", - "description": [], - "signature": [ - "number" - ], - "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] + "children": [], + "returnComment": [ + "* The elevation." + ] } ], "initialIsOpen": false @@ -7794,7 +8605,7 @@ "\nCalled during a render frame allowing the layer to draw into the GL context.\n\nThe layer can assume blending and depth state is set to allow the layer to properly\nblend and clip other layers. The layer cannot make any other assumptions about the\ncurrent GL state.\n\nIf the layer needs to render to a texture, it should implement the `prerender` method\nto do this and only use the `render` method for drawing directly into the main framebuffer.\n\nThe blend function is set to `gl.blendFunc(gl.ONE, gl.ONE_MINUS_SRC_ALPHA)`. This expects\ncolors to be provided in premultiplied alpha form where the `r`, `g` and `b` values are already\nmultiplied by the `a` value. If you are unable to provide colors in premultiplied form you\nmay want to change the blend function to\n`gl.blendFuncSeparate(gl.SRC_ALPHA, gl.ONE_MINUS_SRC_ALPHA, gl.ONE, gl.ONE_MINUS_SRC_ALPHA)`.\n" ], "signature": [ - "(gl: WebGLRenderingContext, matrix: ", + "(gl: WebGLRenderingContext | WebGL2RenderingContext, matrix: ", "mat4", ") => void" ], @@ -7806,14 +8617,14 @@ { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.CustomLayerInterface.render.$1", - "type": "Object", + "type": "CompoundType", "tags": [], "label": "gl", "description": [ "The map's gl context." ], "signature": [ - "WebGLRenderingContext" + "WebGLRenderingContext | WebGL2RenderingContext" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -7873,7 +8684,7 @@ "\nOptional method called when the layer has been added to the Map with {@link Map#addLayer}. This\ngives the layer a chance to initialize gl resources and register event listeners.\n" ], "signature": [ - "((map: maplibregl.Map, gl: WebGLRenderingContext) => void) | undefined" + "((map: maplibregl.Map, gl: WebGLRenderingContext | WebGL2RenderingContext) => void) | undefined" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -7899,14 +8710,14 @@ { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.CustomLayerInterface.onAdd.$2", - "type": "Object", + "type": "CompoundType", "tags": [], "label": "gl", "description": [ "The gl context for the map." ], "signature": [ - "WebGLRenderingContext" + "WebGLRenderingContext | WebGL2RenderingContext" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -7931,7 +8742,7 @@ "\nOptional method called when the layer has been removed from the Map with {@link Map#removeLayer}. This\ngives the layer a chance to clean up gl resources and event listeners.\n" ], "signature": [ - "((map: maplibregl.Map, gl: WebGLRenderingContext) => void) | undefined" + "((map: maplibregl.Map, gl: WebGLRenderingContext | WebGL2RenderingContext) => void) | undefined" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -7957,14 +8768,14 @@ { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.CustomLayerInterface.onRemove.$2", - "type": "Object", + "type": "CompoundType", "tags": [], "label": "gl", "description": [ "The gl context for the map." ], "signature": [ - "WebGLRenderingContext" + "WebGLRenderingContext | WebGL2RenderingContext" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -7985,7 +8796,7 @@ "label": "MapSourceDataEvent", "description": [], "signature": [ - "maplibregl.MapSourceDataEvent extends maplibregl.MapLibreEvent" + "maplibregl.MapSourceDataEvent extends maplibregl.MapLibreEvent" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -8049,7 +8860,7 @@ "label": "sourceDataType", "description": [], "signature": [ - "\"metadata\" | \"content\"" + "\"metadata\" | \"content\" | \"visibility\" | \"idle\"" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -8602,9 +9413,9 @@ "label": "FilterSpecification", "description": [], "signature": [ - "[\"at\", number, (string | number)[]] | [\"get\", string, (Record | undefined)?] | [\"has\", string, (Record | undefined)?] | [\"in\", ...maplibregl.FilterSpecificationInputType[], maplibregl.FilterSpecificationInputType | maplibregl.FilterSpecificationInputType[]] | [\"index-of\", maplibregl.FilterSpecificationInputType, maplibregl.FilterSpecificationInputType | maplibregl.FilterSpecificationInputType[]] | [\"length\", string | string[]] | [\"slice\", string | string[], number] | [\"!\", maplibregl.FilterSpecification] | [\"!=\", string | maplibregl.FilterSpecification, maplibregl.FilterSpecificationInputType] | [\"<\", string | maplibregl.FilterSpecification, maplibregl.FilterSpecificationInputType] | [\"<=\", string | maplibregl.FilterSpecification, maplibregl.FilterSpecificationInputType] | [\"==\", string | maplibregl.FilterSpecification, maplibregl.FilterSpecificationInputType] | [\">\", string | maplibregl.FilterSpecification, maplibregl.FilterSpecificationInputType] | [\">=\", string | maplibregl.FilterSpecification, maplibregl.FilterSpecificationInputType] | [\"all\", ...maplibregl.FilterSpecification[], maplibregl.FilterSpecificationInputType] | [\"any\", ...maplibregl.FilterSpecification[], maplibregl.FilterSpecificationInputType] | [\"case\", ...maplibregl.FilterSpecification[], maplibregl.FilterSpecificationInputType] | [\"coalesce\", ...maplibregl.FilterSpecification[], maplibregl.FilterSpecificationInputType] | [\"match\", ...maplibregl.FilterSpecification[], maplibregl.FilterSpecificationInputType] | [\"within\", ...maplibregl.FilterSpecification[], maplibregl.FilterSpecificationInputType] | [\"!in\", ...maplibregl.FilterSpecification[], maplibregl.FilterSpecificationInputType] | [\"!has\", ...maplibregl.FilterSpecification[], maplibregl.FilterSpecificationInputType] | [\"none\", ...maplibregl.FilterSpecification[], maplibregl.FilterSpecificationInputType] | (string | maplibregl.FilterSpecification)[]" + "maplibregl.ExpressionFilterSpecification | maplibregl.LegacyFilterSpecification" ], - "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "path": "node_modules/@maplibre/maplibre-gl-style-spec/dist/index.d.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -8619,7 +9430,7 @@ "signature": [ "maplibregl.FillLayerSpecification | maplibregl.LineLayerSpecification | maplibregl.SymbolLayerSpecification | maplibregl.CircleLayerSpecification | maplibregl.HeatmapLayerSpecification | maplibregl.FillExtrusionLayerSpecification | maplibregl.RasterLayerSpecification | maplibregl.HillshadeLayerSpecification | maplibregl.BackgroundLayerSpecification" ], - "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "path": "node_modules/@maplibre/maplibre-gl-style-spec/dist/index.d.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -8632,7 +9443,7 @@ "label": "MapEvent", "description": [], "signature": [ - "\"error\" | \"remove\" | \"data\" | \"move\" | \"render\" | \"rotate\" | \"resize\" | \"zoom\" | \"idle\" | \"mousedown\" | \"mouseup\" | \"mouseover\" | \"mousemove\" | \"click\" | \"dblclick\" | \"mouseenter\" | \"mouseleave\" | \"mouseout\" | \"contextmenu\" | \"wheel\" | \"touchstart\" | \"touchend\" | \"touchmove\" | \"touchcancel\" | \"movestart\" | \"moveend\" | \"dragstart\" | \"drag\" | \"dragend\" | \"zoomstart\" | \"zoomend\" | \"rotatestart\" | \"rotateend\" | \"pitchstart\" | \"pitch\" | \"pitchend\" | \"boxzoomstart\" | \"boxzoomend\" | \"boxzoomcancel\" | \"webglcontextlost\" | \"webglcontextrestored\" | \"load\" | \"styledata\" | \"sourcedata\" | \"dataloading\" | \"styledataloading\" | \"sourcedataloading\" | \"styleimagemissing\" | \"style.load\" | \"dataabort\" | \"sourcedataabort\"" + "\"error\" | \"remove\" | \"data\" | \"move\" | \"render\" | \"rotate\" | \"resize\" | \"zoom\" | \"idle\" | \"mousedown\" | \"mouseup\" | \"mouseover\" | \"mousemove\" | \"click\" | \"dblclick\" | \"mouseenter\" | \"mouseleave\" | \"mouseout\" | \"contextmenu\" | \"wheel\" | \"touchstart\" | \"touchend\" | \"touchmove\" | \"touchcancel\" | \"movestart\" | \"moveend\" | \"dragstart\" | \"drag\" | \"dragend\" | \"zoomstart\" | \"zoomend\" | \"rotatestart\" | \"rotateend\" | \"pitchstart\" | \"pitch\" | \"pitchend\" | \"boxzoomstart\" | \"boxzoomend\" | \"boxzoomcancel\" | \"webglcontextlost\" | \"webglcontextrestored\" | \"load\" | \"styledata\" | \"sourcedata\" | \"dataloading\" | \"styledataloading\" | \"sourcedataloading\" | \"styleimagemissing\" | \"style.load\" | \"terrain\" | \"dataabort\" | \"sourcedataabort\"" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -8647,7 +9458,7 @@ "label": "MapGeoJSONFeature", "description": [], "signature": [ - "maplibregl.GeoJSONFeature & { layer: Omit & { source: string; }; source: string; sourceLayer?: string | undefined; state: { [key: string]: any; }; }" + "maplibregl.GeoJSONFeature & { layer: (Omit | Omit | Omit | Omit | Omit | Omit | Omit | Omit | Omit) & { source: string; }; source: string; sourceLayer?: string | undefined; state: { [key: string]: any; }; }" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -8677,7 +9488,7 @@ "label": "MapOptions", "description": [], "signature": [ - "{ hash?: string | boolean | undefined; interactive?: boolean | undefined; container: string | HTMLElement; bearingSnap?: number | undefined; attributionControl?: boolean | undefined; customAttribution?: string | string[] | undefined; maplibreLogo?: boolean | undefined; logoPosition?: maplibregl.ControlPosition | undefined; failIfMajorPerformanceCaveat?: boolean | undefined; preserveDrawingBuffer?: boolean | undefined; antialias?: boolean | undefined; refreshExpiredTiles?: boolean | undefined; maxBounds?: maplibregl.LngLatBoundsLike | undefined; scrollZoom?: boolean | undefined; minZoom?: number | null | undefined; maxZoom?: number | null | undefined; minPitch?: number | null | undefined; maxPitch?: number | null | undefined; boxZoom?: boolean | undefined; dragRotate?: boolean | undefined; dragPan?: boolean | maplibregl.DragPanOptions | undefined; keyboard?: boolean | undefined; doubleClickZoom?: boolean | undefined; touchZoomRotate?: boolean | undefined; touchPitch?: boolean | undefined; trackResize?: boolean | undefined; center?: maplibregl.LngLatLike | undefined; zoom?: number | undefined; bearing?: number | undefined; pitch?: number | undefined; renderWorldCopies?: boolean | undefined; maxTileCacheSize?: number | undefined; transformRequest?: maplibregl.RequestTransformFunction | undefined; locale?: any; fadeDuration?: number | undefined; crossSourceCollisions?: boolean | undefined; collectResourceTiming?: boolean | undefined; clickTolerance?: number | undefined; bounds?: maplibregl.LngLatBoundsLike | undefined; fitBoundsOptions?: Object | undefined; localIdeographFontFamily?: string | undefined; style: string | maplibregl.StyleSpecification; pitchWithRotate?: boolean | undefined; pixelRatio?: number | undefined; }" + "{ hash?: string | boolean | undefined; interactive?: boolean | undefined; container: string | HTMLElement; bearingSnap?: number | undefined; attributionControl?: boolean | undefined; customAttribution?: string | string[] | undefined; maplibreLogo?: boolean | undefined; logoPosition?: maplibregl.ControlPosition | undefined; failIfMajorPerformanceCaveat?: boolean | undefined; preserveDrawingBuffer?: boolean | undefined; antialias?: boolean | undefined; refreshExpiredTiles?: boolean | undefined; maxBounds?: maplibregl.LngLatBoundsLike | undefined; scrollZoom?: boolean | undefined; minZoom?: number | null | undefined; maxZoom?: number | null | undefined; minPitch?: number | null | undefined; maxPitch?: number | null | undefined; boxZoom?: boolean | undefined; dragRotate?: boolean | undefined; dragPan?: boolean | maplibregl.DragPanOptions | undefined; keyboard?: boolean | undefined; doubleClickZoom?: boolean | undefined; touchZoomRotate?: boolean | undefined; touchPitch?: boolean | undefined; cooperativeGestures?: boolean | maplibregl.GestureOptions | undefined; trackResize?: boolean | undefined; center?: maplibregl.LngLatLike | undefined; zoom?: number | undefined; bearing?: number | undefined; pitch?: number | undefined; renderWorldCopies?: boolean | undefined; maxTileCacheSize?: number | undefined; maxTileCacheZoomLevels?: number | undefined; transformRequest?: maplibregl.RequestTransformFunction | undefined; transformCameraUpdate?: maplibregl.CameraUpdateTransformFunction | undefined; locale?: any; fadeDuration?: number | undefined; crossSourceCollisions?: boolean | undefined; collectResourceTiming?: boolean | undefined; clickTolerance?: number | undefined; bounds?: maplibregl.LngLatBoundsLike | undefined; fitBoundsOptions?: Object | undefined; localIdeographFontFamily?: string | undefined; style: string | maplibregl.StyleSpecification; pitchWithRotate?: boolean | undefined; pixelRatio?: number | undefined; validateStyle?: boolean | undefined; }" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -8729,7 +9540,7 @@ "signature": [ "maplibregl.VectorSourceSpecification | maplibregl.RasterSourceSpecification | maplibregl.RasterDEMSourceSpecification | maplibregl.GeoJSONSourceSpecification | maplibregl.VideoSourceSpecification | maplibregl.ImageSourceSpecification" ], - "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "path": "node_modules/@maplibre/maplibre-gl-style-spec/dist/index.d.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -8742,9 +9553,9 @@ "label": "StyleSpecification", "description": [], "signature": [ - "{ version: 8; name?: string | undefined; metadata?: unknown; center?: number[] | undefined; zoom?: number | undefined; bearing?: number | undefined; pitch?: number | undefined; light?: maplibregl.LightSpecification | undefined; sources: { [_: string]: maplibregl.SourceSpecification; }; sprite?: string | undefined; glyphs?: string | undefined; transition?: maplibregl.TransitionSpecification | undefined; layers: maplibregl.LayerSpecification[]; }" + "{ version: 8; name?: string | undefined; metadata?: unknown; center?: number[] | undefined; zoom?: number | undefined; bearing?: number | undefined; pitch?: number | undefined; light?: maplibregl.LightSpecification | undefined; terrain?: maplibregl.TerrainSpecification | undefined; sources: { [_: string]: maplibregl.SourceSpecification; }; sprite?: maplibregl.SpriteSpecification | undefined; glyphs?: string | undefined; transition?: maplibregl.TransitionSpecification | undefined; layers: maplibregl.LayerSpecification[]; }" ], - "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "path": "node_modules/@maplibre/maplibre-gl-style-spec/dist/index.d.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false diff --git a/api_docs/kbn_mapbox_gl.mdx b/api_docs/kbn_mapbox_gl.mdx index fc673c59774c1..fed44ad3003c9 100644 --- a/api_docs/kbn_mapbox_gl.mdx +++ b/api_docs/kbn_mapbox_gl.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-mapbox-gl title: "@kbn/mapbox-gl" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/mapbox-gl plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/mapbox-gl'] --- import kbnMapboxGlObj from './kbn_mapbox_gl.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/kibana-gis](https://github.com/orgs/elastic/teams/kibana-gis) | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 535 | 1 | 1 | 0 | +| 582 | 1 | 1 | 0 | ## Common diff --git a/api_docs/kbn_maps_vector_tile_utils.mdx b/api_docs/kbn_maps_vector_tile_utils.mdx index a86a3e534b28d..a1e5e3e266932 100644 --- a/api_docs/kbn_maps_vector_tile_utils.mdx +++ b/api_docs/kbn_maps_vector_tile_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-maps-vector-tile-utils title: "@kbn/maps-vector-tile-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/maps-vector-tile-utils plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/maps-vector-tile-utils'] --- import kbnMapsVectorTileUtilsObj from './kbn_maps_vector_tile_utils.devdocs.json'; diff --git a/api_docs/kbn_ml_agg_utils.devdocs.json b/api_docs/kbn_ml_agg_utils.devdocs.json index b0d081192c460..c03505f9d472e 100644 --- a/api_docs/kbn_ml_agg_utils.devdocs.json +++ b/api_docs/kbn_ml_agg_utils.devdocs.json @@ -669,7 +669,7 @@ "tags": [], "label": "isSignificantTerm", "description": [ - "\nType guard for a significant term.\nNote this is used as a custom type within Explain Log Rate Spikes\nfor a p-value based variant, not a generic significant terms\naggregation type." + "\nType guard for a significant term.\nNote this is used as a custom type within Log Rate Analysis\nfor a p-value based variant, not a generic significant terms\naggregation type." ], "signature": [ "(arg: unknown) => boolean" @@ -1149,7 +1149,7 @@ "tags": [], "label": "SignificantTerm", "description": [ - "\nSignificant term meta data for a field/value pair.\nNote this is used as a custom type within Explain Log Rate Spikes\nfor a p-value based variant, not a generic significant terms\naggregation type." + "\nSignificant term meta data for a field/value pair.\nNote this is used as a custom type within Log Rate Analysis\nfor a p-value based variant, not a generic significant terms\naggregation type." ], "signature": [ { diff --git a/api_docs/kbn_ml_agg_utils.mdx b/api_docs/kbn_ml_agg_utils.mdx index bbecb363c4c0b..ccfc346caeb43 100644 --- a/api_docs/kbn_ml_agg_utils.mdx +++ b/api_docs/kbn_ml_agg_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-agg-utils title: "@kbn/ml-agg-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-agg-utils plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-agg-utils'] --- import kbnMlAggUtilsObj from './kbn_ml_agg_utils.devdocs.json'; diff --git a/api_docs/kbn_ml_anomaly_utils.mdx b/api_docs/kbn_ml_anomaly_utils.mdx index d9501d70b776d..a801e179e3dab 100644 --- a/api_docs/kbn_ml_anomaly_utils.mdx +++ b/api_docs/kbn_ml_anomaly_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-anomaly-utils title: "@kbn/ml-anomaly-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-anomaly-utils plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-anomaly-utils'] --- import kbnMlAnomalyUtilsObj from './kbn_ml_anomaly_utils.devdocs.json'; diff --git a/api_docs/kbn_ml_category_validator.devdocs.json b/api_docs/kbn_ml_category_validator.devdocs.json new file mode 100644 index 0000000000000..45db461ceab38 --- /dev/null +++ b/api_docs/kbn_ml_category_validator.devdocs.json @@ -0,0 +1,584 @@ +{ + "id": "@kbn/ml-category-validator", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/ml-category-validator", + "id": "def-common.categorizationExamplesProvider", + "type": "Function", + "tags": [ + "export" + ], + "label": "categorizationExamplesProvider", + "description": [ + "\nProvides methods for checking whether categories can be\nproduced from a field.\n" + ], + "signature": [ + "(client: ", + { + "pluginId": "@kbn/core-elasticsearch-server", + "scope": "common", + "docId": "kibKbnCoreElasticsearchServerPluginApi", + "section": "def-common.IScopedClusterClient", + "text": "IScopedClusterClient" + }, + ") => { validateCategoryExamples: (indexPatternTitle: string, query: ", + "QueryDslQueryContainer", + ", size: number, categorizationFieldName: string, timeField: string | undefined, start: number, end: number, analyzer: ", + { + "pluginId": "@kbn/ml-category-validator", + "scope": "common", + "docId": "kibKbnMlCategoryValidatorPluginApi", + "section": "def-common.CategorizationAnalyzer", + "text": "CategorizationAnalyzer" + }, + ", runtimeMappings: ", + "MappingRuntimeFields", + " | undefined, indicesOptions: ", + "IndicesOptions", + " | undefined) => Promise<{ overallValidStatus: ", + { + "pluginId": "@kbn/ml-category-validator", + "scope": "common", + "docId": "kibKbnMlCategoryValidatorPluginApi", + "section": "def-common.CATEGORY_EXAMPLES_VALIDATION_STATUS", + "text": "CATEGORY_EXAMPLES_VALIDATION_STATUS" + }, + "; validationChecks: ", + { + "pluginId": "@kbn/ml-category-validator", + "scope": "common", + "docId": "kibKbnMlCategoryValidatorPluginApi", + "section": "def-common.FieldExampleCheck", + "text": "FieldExampleCheck" + }, + "[]; sampleSize: number; examples: { text: string; tokens: ", + { + "pluginId": "@kbn/ml-category-validator", + "scope": "common", + "docId": "kibKbnMlCategoryValidatorPluginApi", + "section": "def-common.Token", + "text": "Token" + }, + "[]; }[]; }>; }" + ], + "path": "x-pack/packages/ml/category_validator/src/examples.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/ml-category-validator", + "id": "def-common.categorizationExamplesProvider.$1", + "type": "Object", + "tags": [], + "label": "client", + "description": [ + "- IScopedClusterClient" + ], + "signature": [ + { + "pluginId": "@kbn/core-elasticsearch-server", + "scope": "common", + "docId": "kibKbnCoreElasticsearchServerPluginApi", + "section": "def-common.IScopedClusterClient", + "text": "IScopedClusterClient" + } + ], + "path": "x-pack/packages/ml/category_validator/src/examples.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "@kbn/ml-category-validator", + "id": "def-common.CategoryFieldExample", + "type": "Interface", + "tags": [], + "label": "CategoryFieldExample", + "description": [ + "\nField example for a category." + ], + "path": "x-pack/packages/ml/category_validator/common/types/categories.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/ml-category-validator", + "id": "def-common.CategoryFieldExample.text", + "type": "string", + "tags": [], + "label": "text", + "description": [ + "\nThe text of the field example." + ], + "path": "x-pack/packages/ml/category_validator/common/types/categories.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/ml-category-validator", + "id": "def-common.CategoryFieldExample.tokens", + "type": "Array", + "tags": [], + "label": "tokens", + "description": [ + "\nThe tokens extracted from the field example." + ], + "signature": [ + { + "pluginId": "@kbn/ml-category-validator", + "scope": "common", + "docId": "kibKbnMlCategoryValidatorPluginApi", + "section": "def-common.Token", + "text": "Token" + }, + "[]" + ], + "path": "x-pack/packages/ml/category_validator/common/types/categories.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/ml-category-validator", + "id": "def-common.FieldExampleCheck", + "type": "Interface", + "tags": [], + "label": "FieldExampleCheck", + "description": [ + "\nResult of a field example check." + ], + "path": "x-pack/packages/ml/category_validator/common/types/categories.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/ml-category-validator", + "id": "def-common.FieldExampleCheck.id", + "type": "Enum", + "tags": [], + "label": "id", + "description": [ + "\nThe ID of the validation result." + ], + "signature": [ + { + "pluginId": "@kbn/ml-category-validator", + "scope": "common", + "docId": "kibKbnMlCategoryValidatorPluginApi", + "section": "def-common.VALIDATION_RESULT", + "text": "VALIDATION_RESULT" + } + ], + "path": "x-pack/packages/ml/category_validator/common/types/categories.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/ml-category-validator", + "id": "def-common.FieldExampleCheck.valid", + "type": "Enum", + "tags": [], + "label": "valid", + "description": [ + "\nThe validation status of the field example." + ], + "signature": [ + { + "pluginId": "@kbn/ml-category-validator", + "scope": "common", + "docId": "kibKbnMlCategoryValidatorPluginApi", + "section": "def-common.CATEGORY_EXAMPLES_VALIDATION_STATUS", + "text": "CATEGORY_EXAMPLES_VALIDATION_STATUS" + } + ], + "path": "x-pack/packages/ml/category_validator/common/types/categories.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/ml-category-validator", + "id": "def-common.FieldExampleCheck.message", + "type": "string", + "tags": [], + "label": "message", + "description": [ + "\nThe message associated with the validation result." + ], + "path": "x-pack/packages/ml/category_validator/common/types/categories.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/ml-category-validator", + "id": "def-common.Token", + "type": "Interface", + "tags": [], + "label": "Token", + "description": [ + "\nToken" + ], + "path": "x-pack/packages/ml/category_validator/common/types/categories.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/ml-category-validator", + "id": "def-common.Token.token", + "type": "string", + "tags": [], + "label": "token", + "description": [ + "\nThe token string." + ], + "path": "x-pack/packages/ml/category_validator/common/types/categories.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/ml-category-validator", + "id": "def-common.Token.start_offset", + "type": "number", + "tags": [], + "label": "start_offset", + "description": [ + "\nThe starting offset of the token." + ], + "path": "x-pack/packages/ml/category_validator/common/types/categories.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/ml-category-validator", + "id": "def-common.Token.end_offset", + "type": "number", + "tags": [], + "label": "end_offset", + "description": [ + "\nThe ending offset of the token." + ], + "path": "x-pack/packages/ml/category_validator/common/types/categories.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/ml-category-validator", + "id": "def-common.Token.type", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "\nThe type of the token." + ], + "path": "x-pack/packages/ml/category_validator/common/types/categories.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/ml-category-validator", + "id": "def-common.Token.position", + "type": "number", + "tags": [], + "label": "position", + "description": [ + "\nThe position of the token." + ], + "path": "x-pack/packages/ml/category_validator/common/types/categories.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + } + ], + "enums": [ + { + "parentPluginId": "@kbn/ml-category-validator", + "id": "def-common.CATEGORY_EXAMPLES_VALIDATION_STATUS", + "type": "Enum", + "tags": [], + "label": "CATEGORY_EXAMPLES_VALIDATION_STATUS", + "description": [ + "\nEnum representing the validation status of category examples." + ], + "path": "x-pack/packages/ml/category_validator/common/constants/categorization.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/ml-category-validator", + "id": "def-common.VALIDATION_RESULT", + "type": "Enum", + "tags": [], + "label": "VALIDATION_RESULT", + "description": [ + "\nEnum representing the validation results for field examples." + ], + "path": "x-pack/packages/ml/category_validator/common/constants/categorization.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], + "misc": [ + { + "parentPluginId": "@kbn/ml-category-validator", + "id": "def-common.CategorizationAnalyzer", + "type": "Type", + "tags": [], + "label": "CategorizationAnalyzer", + "description": [ + "\nCategorization analyzer with additional properties." + ], + "signature": [ + "MlCategorizationAnalyzerDefinition", + " & { analyzer?: string | undefined; }" + ], + "path": "x-pack/packages/ml/category_validator/common/types/categories.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/ml-category-validator", + "id": "def-common.CATEGORY_EXAMPLES_ERROR_LIMIT", + "type": "number", + "tags": [], + "label": "CATEGORY_EXAMPLES_ERROR_LIMIT", + "description": [ + "\nThe error limit for category examples. If the category examples validation falls below this limit, an error is triggered." + ], + "signature": [ + "0.02" + ], + "path": "x-pack/packages/ml/category_validator/common/constants/categorization.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/ml-category-validator", + "id": "def-common.CATEGORY_EXAMPLES_SAMPLE_SIZE", + "type": "number", + "tags": [], + "label": "CATEGORY_EXAMPLES_SAMPLE_SIZE", + "description": [ + "\nThe number of category examples to use for analysis." + ], + "signature": [ + "1000" + ], + "path": "x-pack/packages/ml/category_validator/common/constants/categorization.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/ml-category-validator", + "id": "def-common.CATEGORY_EXAMPLES_WARNING_LIMIT", + "type": "number", + "tags": [], + "label": "CATEGORY_EXAMPLES_WARNING_LIMIT", + "description": [ + "\nThe warning limit for category examples. If the category examples validation falls below this limit, a warning is triggered." + ], + "signature": [ + "0.75" + ], + "path": "x-pack/packages/ml/category_validator/common/constants/categorization.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/ml-category-validator", + "id": "def-common.MEDIAN_LINE_LENGTH_LIMIT", + "type": "number", + "tags": [], + "label": "MEDIAN_LINE_LENGTH_LIMIT", + "description": [ + "\nThe limit for the median line length of category examples." + ], + "signature": [ + "400" + ], + "path": "x-pack/packages/ml/category_validator/common/constants/categorization.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/ml-category-validator", + "id": "def-common.NULL_COUNT_PERCENT_LIMIT", + "type": "number", + "tags": [], + "label": "NULL_COUNT_PERCENT_LIMIT", + "description": [ + "\nThe limit for the percentage of null values in category examples." + ], + "signature": [ + "0.75" + ], + "path": "x-pack/packages/ml/category_validator/common/constants/categorization.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/ml-category-validator", + "id": "def-common.VALID_TOKEN_COUNT", + "type": "number", + "tags": [], + "label": "VALID_TOKEN_COUNT", + "description": [ + "\nThe valid token count for category examples." + ], + "signature": [ + "3" + ], + "path": "x-pack/packages/ml/category_validator/common/constants/categorization.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], + "objects": [ + { + "parentPluginId": "@kbn/ml-category-validator", + "id": "def-common.VALIDATION_CHECK_DESCRIPTION", + "type": "Object", + "tags": [], + "label": "VALIDATION_CHECK_DESCRIPTION", + "description": [ + "\nDescription for each validation result." + ], + "path": "x-pack/packages/ml/category_validator/common/constants/categorization.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/ml-category-validator", + "id": "def-common.VALIDATION_CHECK_DESCRIPTION.VALIDATION_RESULT.NO_EXAMPLES", + "type": "string", + "tags": [], + "label": "[VALIDATION_RESULT.NO_EXAMPLES]", + "description": [ + "/**\n * Examples were successfully loaded.\n */" + ], + "path": "x-pack/packages/ml/category_validator/common/constants/categorization.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/ml-category-validator", + "id": "def-common.VALIDATION_CHECK_DESCRIPTION.VALIDATION_RESULT.FAILED_TO_TOKENIZE", + "type": "string", + "tags": [], + "label": "[VALIDATION_RESULT.FAILED_TO_TOKENIZE]", + "description": [ + "/**\n * The loaded examples were tokenized successfully.\n */" + ], + "path": "x-pack/packages/ml/category_validator/common/constants/categorization.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/ml-category-validator", + "id": "def-common.VALIDATION_CHECK_DESCRIPTION.VALIDATION_RESULT.TOKEN_COUNT", + "type": "string", + "tags": [], + "label": "[VALIDATION_RESULT.TOKEN_COUNT]", + "description": [ + "/**\n * More than {tokenCount} tokens per example were found in over {percentage}% of the loaded examples.\n */" + ], + "path": "x-pack/packages/ml/category_validator/common/constants/categorization.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/ml-category-validator", + "id": "def-common.VALIDATION_CHECK_DESCRIPTION.VALIDATION_RESULT.MEDIAN_LINE_LENGTH", + "type": "string", + "tags": [], + "label": "[VALIDATION_RESULT.MEDIAN_LINE_LENGTH]", + "description": [ + "/**\n * The median line length of the loaded examples was less than {medianCharCount} characters.\n */" + ], + "path": "x-pack/packages/ml/category_validator/common/constants/categorization.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/ml-category-validator", + "id": "def-common.VALIDATION_CHECK_DESCRIPTION.VALIDATION_RESULT.NULL_VALUES", + "type": "string", + "tags": [], + "label": "[VALIDATION_RESULT.NULL_VALUES]", + "description": [ + "/**\n * Less than {percentage}% of the loaded examples were null.\n */" + ], + "path": "x-pack/packages/ml/category_validator/common/constants/categorization.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/ml-category-validator", + "id": "def-common.VALIDATION_CHECK_DESCRIPTION.VALIDATION_RESULT.TOO_MANY_TOKENS", + "type": "string", + "tags": [], + "label": "[VALIDATION_RESULT.TOO_MANY_TOKENS]", + "description": [ + "/**\n * Less than 10000 tokens were found in total in the loaded examples.\n */" + ], + "path": "x-pack/packages/ml/category_validator/common/constants/categorization.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/ml-category-validator", + "id": "def-common.VALIDATION_CHECK_DESCRIPTION.VALIDATION_RESULT.INSUFFICIENT_PRIVILEGES", + "type": "string", + "tags": [], + "label": "[VALIDATION_RESULT.INSUFFICIENT_PRIVILEGES]", + "description": [ + "/**\n * The user has sufficient privileges to perform the checks.\n */" + ], + "path": "x-pack/packages/ml/category_validator/common/constants/categorization.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + } + ] + } +} \ No newline at end of file diff --git a/api_docs/kbn_ml_category_validator.mdx b/api_docs/kbn_ml_category_validator.mdx new file mode 100644 index 0000000000000..8ea8eff764089 --- /dev/null +++ b/api_docs/kbn_ml_category_validator.mdx @@ -0,0 +1,42 @@ +--- +#### +#### 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. +#### +id: kibKbnMlCategoryValidatorPluginApi +slug: /kibana-dev-docs/api/kbn-ml-category-validator +title: "@kbn/ml-category-validator" +image: https://source.unsplash.com/400x175/?github +description: API docs for the @kbn/ml-category-validator plugin +date: 2023-07-20 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-category-validator'] +--- +import kbnMlCategoryValidatorObj from './kbn_ml_category_validator.devdocs.json'; + + + +Contact [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 32 | 0 | 0 | 0 | + +## Common + +### Objects + + +### Functions + + +### Interfaces + + +### Enums + + +### Consts, variables and types + + diff --git a/api_docs/kbn_ml_data_frame_analytics_utils.mdx b/api_docs/kbn_ml_data_frame_analytics_utils.mdx index 1bcac30cc22c1..1770e9b8fcb05 100644 --- a/api_docs/kbn_ml_data_frame_analytics_utils.mdx +++ b/api_docs/kbn_ml_data_frame_analytics_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-data-frame-analytics-utils title: "@kbn/ml-data-frame-analytics-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-data-frame-analytics-utils plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-data-frame-analytics-utils'] --- import kbnMlDataFrameAnalyticsUtilsObj from './kbn_ml_data_frame_analytics_utils.devdocs.json'; diff --git a/api_docs/kbn_ml_data_grid.mdx b/api_docs/kbn_ml_data_grid.mdx index 0c63383503aa8..aa00ec903801c 100644 --- a/api_docs/kbn_ml_data_grid.mdx +++ b/api_docs/kbn_ml_data_grid.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-data-grid title: "@kbn/ml-data-grid" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-data-grid plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-data-grid'] --- import kbnMlDataGridObj from './kbn_ml_data_grid.devdocs.json'; diff --git a/api_docs/kbn_ml_date_picker.mdx b/api_docs/kbn_ml_date_picker.mdx index 0e1cbe2bd391b..f1b9577913a01 100644 --- a/api_docs/kbn_ml_date_picker.mdx +++ b/api_docs/kbn_ml_date_picker.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-date-picker title: "@kbn/ml-date-picker" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-date-picker plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-date-picker'] --- import kbnMlDatePickerObj from './kbn_ml_date_picker.devdocs.json'; diff --git a/api_docs/kbn_ml_date_utils.mdx b/api_docs/kbn_ml_date_utils.mdx index f9c8492587760..360643f3528e2 100644 --- a/api_docs/kbn_ml_date_utils.mdx +++ b/api_docs/kbn_ml_date_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-date-utils title: "@kbn/ml-date-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-date-utils plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-date-utils'] --- import kbnMlDateUtilsObj from './kbn_ml_date_utils.devdocs.json'; diff --git a/api_docs/kbn_ml_error_utils.mdx b/api_docs/kbn_ml_error_utils.mdx index 86e604497ce85..e3ee66bbc1c69 100644 --- a/api_docs/kbn_ml_error_utils.mdx +++ b/api_docs/kbn_ml_error_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-error-utils title: "@kbn/ml-error-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-error-utils plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-error-utils'] --- import kbnMlErrorUtilsObj from './kbn_ml_error_utils.devdocs.json'; diff --git a/api_docs/kbn_ml_is_defined.mdx b/api_docs/kbn_ml_is_defined.mdx index 1fb5ab2c0a2de..08f9c959a25d0 100644 --- a/api_docs/kbn_ml_is_defined.mdx +++ b/api_docs/kbn_ml_is_defined.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-is-defined title: "@kbn/ml-is-defined" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-is-defined plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-is-defined'] --- import kbnMlIsDefinedObj from './kbn_ml_is_defined.devdocs.json'; diff --git a/api_docs/kbn_ml_is_populated_object.mdx b/api_docs/kbn_ml_is_populated_object.mdx index 83c342d60dbea..49ad6f1a30dec 100644 --- a/api_docs/kbn_ml_is_populated_object.mdx +++ b/api_docs/kbn_ml_is_populated_object.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-is-populated-object title: "@kbn/ml-is-populated-object" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-is-populated-object plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-is-populated-object'] --- import kbnMlIsPopulatedObjectObj from './kbn_ml_is_populated_object.devdocs.json'; diff --git a/api_docs/kbn_ml_kibana_theme.mdx b/api_docs/kbn_ml_kibana_theme.mdx index 77e07817d5895..33006f65499cf 100644 --- a/api_docs/kbn_ml_kibana_theme.mdx +++ b/api_docs/kbn_ml_kibana_theme.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-kibana-theme title: "@kbn/ml-kibana-theme" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-kibana-theme plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-kibana-theme'] --- import kbnMlKibanaThemeObj from './kbn_ml_kibana_theme.devdocs.json'; diff --git a/api_docs/kbn_ml_local_storage.mdx b/api_docs/kbn_ml_local_storage.mdx index 2c935765ea097..1b6278f3b7c9d 100644 --- a/api_docs/kbn_ml_local_storage.mdx +++ b/api_docs/kbn_ml_local_storage.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-local-storage title: "@kbn/ml-local-storage" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-local-storage plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-local-storage'] --- import kbnMlLocalStorageObj from './kbn_ml_local_storage.devdocs.json'; diff --git a/api_docs/kbn_ml_nested_property.mdx b/api_docs/kbn_ml_nested_property.mdx index 2144f98fd58d5..49676caaeac45 100644 --- a/api_docs/kbn_ml_nested_property.mdx +++ b/api_docs/kbn_ml_nested_property.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-nested-property title: "@kbn/ml-nested-property" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-nested-property plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-nested-property'] --- import kbnMlNestedPropertyObj from './kbn_ml_nested_property.devdocs.json'; diff --git a/api_docs/kbn_ml_number_utils.mdx b/api_docs/kbn_ml_number_utils.mdx index 3abf4bbe78ab3..b336eee4139c9 100644 --- a/api_docs/kbn_ml_number_utils.mdx +++ b/api_docs/kbn_ml_number_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-number-utils title: "@kbn/ml-number-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-number-utils plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-number-utils'] --- import kbnMlNumberUtilsObj from './kbn_ml_number_utils.devdocs.json'; diff --git a/api_docs/kbn_ml_query_utils.mdx b/api_docs/kbn_ml_query_utils.mdx index d9e8b8af66924..ac552f502ca91 100644 --- a/api_docs/kbn_ml_query_utils.mdx +++ b/api_docs/kbn_ml_query_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-query-utils title: "@kbn/ml-query-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-query-utils plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-query-utils'] --- import kbnMlQueryUtilsObj from './kbn_ml_query_utils.devdocs.json'; diff --git a/api_docs/kbn_ml_random_sampler_utils.mdx b/api_docs/kbn_ml_random_sampler_utils.mdx index 785febc254310..f62831f6b9850 100644 --- a/api_docs/kbn_ml_random_sampler_utils.mdx +++ b/api_docs/kbn_ml_random_sampler_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-random-sampler-utils title: "@kbn/ml-random-sampler-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-random-sampler-utils plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-random-sampler-utils'] --- import kbnMlRandomSamplerUtilsObj from './kbn_ml_random_sampler_utils.devdocs.json'; diff --git a/api_docs/kbn_ml_route_utils.mdx b/api_docs/kbn_ml_route_utils.mdx index c3218ffa1fcd2..6c51a532c929f 100644 --- a/api_docs/kbn_ml_route_utils.mdx +++ b/api_docs/kbn_ml_route_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-route-utils title: "@kbn/ml-route-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-route-utils plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-route-utils'] --- import kbnMlRouteUtilsObj from './kbn_ml_route_utils.devdocs.json'; diff --git a/api_docs/kbn_ml_runtime_field_utils.mdx b/api_docs/kbn_ml_runtime_field_utils.mdx index 8142a24c14ea0..9b5bdbf420ea0 100644 --- a/api_docs/kbn_ml_runtime_field_utils.mdx +++ b/api_docs/kbn_ml_runtime_field_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-runtime-field-utils title: "@kbn/ml-runtime-field-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-runtime-field-utils plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-runtime-field-utils'] --- import kbnMlRuntimeFieldUtilsObj from './kbn_ml_runtime_field_utils.devdocs.json'; diff --git a/api_docs/kbn_ml_string_hash.mdx b/api_docs/kbn_ml_string_hash.mdx index ece0bfda7c59c..31c454a4c7dd6 100644 --- a/api_docs/kbn_ml_string_hash.mdx +++ b/api_docs/kbn_ml_string_hash.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-string-hash title: "@kbn/ml-string-hash" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-string-hash plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-string-hash'] --- import kbnMlStringHashObj from './kbn_ml_string_hash.devdocs.json'; diff --git a/api_docs/kbn_ml_trained_models_utils.mdx b/api_docs/kbn_ml_trained_models_utils.mdx index 899dce7caf674..9bd2112ca2d5a 100644 --- a/api_docs/kbn_ml_trained_models_utils.mdx +++ b/api_docs/kbn_ml_trained_models_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-trained-models-utils title: "@kbn/ml-trained-models-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-trained-models-utils plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-trained-models-utils'] --- import kbnMlTrainedModelsUtilsObj from './kbn_ml_trained_models_utils.devdocs.json'; diff --git a/api_docs/kbn_ml_url_state.mdx b/api_docs/kbn_ml_url_state.mdx index 4d13d0412addd..1c29df62bf1ae 100644 --- a/api_docs/kbn_ml_url_state.mdx +++ b/api_docs/kbn_ml_url_state.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ml-url-state title: "@kbn/ml-url-state" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ml-url-state plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-url-state'] --- import kbnMlUrlStateObj from './kbn_ml_url_state.devdocs.json'; diff --git a/api_docs/kbn_monaco.mdx b/api_docs/kbn_monaco.mdx index d1cfa0d7e5e93..1b1fb2676f07b 100644 --- a/api_docs/kbn_monaco.mdx +++ b/api_docs/kbn_monaco.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-monaco title: "@kbn/monaco" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/monaco plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/monaco'] --- import kbnMonacoObj from './kbn_monaco.devdocs.json'; diff --git a/api_docs/kbn_object_versioning.mdx b/api_docs/kbn_object_versioning.mdx index 728e2a7adab86..27030ea6e0413 100644 --- a/api_docs/kbn_object_versioning.mdx +++ b/api_docs/kbn_object_versioning.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-object-versioning title: "@kbn/object-versioning" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/object-versioning plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/object-versioning'] --- import kbnObjectVersioningObj from './kbn_object_versioning.devdocs.json'; diff --git a/api_docs/kbn_observability_alert_details.mdx b/api_docs/kbn_observability_alert_details.mdx index b4e10cc02478c..1121e5aeb0851 100644 --- a/api_docs/kbn_observability_alert_details.mdx +++ b/api_docs/kbn_observability_alert_details.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-observability-alert-details title: "@kbn/observability-alert-details" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/observability-alert-details plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/observability-alert-details'] --- import kbnObservabilityAlertDetailsObj from './kbn_observability_alert_details.devdocs.json'; diff --git a/api_docs/kbn_optimizer.mdx b/api_docs/kbn_optimizer.mdx index 7ef35894ecaf9..82efa2b671933 100644 --- a/api_docs/kbn_optimizer.mdx +++ b/api_docs/kbn_optimizer.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-optimizer title: "@kbn/optimizer" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/optimizer plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/optimizer'] --- import kbnOptimizerObj from './kbn_optimizer.devdocs.json'; diff --git a/api_docs/kbn_optimizer_webpack_helpers.mdx b/api_docs/kbn_optimizer_webpack_helpers.mdx index 647b916fe560b..7f5ca5670495a 100644 --- a/api_docs/kbn_optimizer_webpack_helpers.mdx +++ b/api_docs/kbn_optimizer_webpack_helpers.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-optimizer-webpack-helpers title: "@kbn/optimizer-webpack-helpers" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/optimizer-webpack-helpers plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/optimizer-webpack-helpers'] --- import kbnOptimizerWebpackHelpersObj from './kbn_optimizer_webpack_helpers.devdocs.json'; diff --git a/api_docs/kbn_osquery_io_ts_types.mdx b/api_docs/kbn_osquery_io_ts_types.mdx index 5a32b074bd17b..0075025611604 100644 --- a/api_docs/kbn_osquery_io_ts_types.mdx +++ b/api_docs/kbn_osquery_io_ts_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-osquery-io-ts-types title: "@kbn/osquery-io-ts-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/osquery-io-ts-types plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/osquery-io-ts-types'] --- import kbnOsqueryIoTsTypesObj from './kbn_osquery_io_ts_types.devdocs.json'; diff --git a/api_docs/kbn_performance_testing_dataset_extractor.mdx b/api_docs/kbn_performance_testing_dataset_extractor.mdx index 74788a1d1c89a..3f861d2589378 100644 --- a/api_docs/kbn_performance_testing_dataset_extractor.mdx +++ b/api_docs/kbn_performance_testing_dataset_extractor.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-performance-testing-dataset-extractor title: "@kbn/performance-testing-dataset-extractor" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/performance-testing-dataset-extractor plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/performance-testing-dataset-extractor'] --- import kbnPerformanceTestingDatasetExtractorObj from './kbn_performance_testing_dataset_extractor.devdocs.json'; diff --git a/api_docs/kbn_plugin_generator.mdx b/api_docs/kbn_plugin_generator.mdx index e4da13b92e275..ada306c19ebb6 100644 --- a/api_docs/kbn_plugin_generator.mdx +++ b/api_docs/kbn_plugin_generator.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-plugin-generator title: "@kbn/plugin-generator" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/plugin-generator plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-generator'] --- import kbnPluginGeneratorObj from './kbn_plugin_generator.devdocs.json'; diff --git a/api_docs/kbn_plugin_helpers.mdx b/api_docs/kbn_plugin_helpers.mdx index 8cd929feffec1..ec142892d231a 100644 --- a/api_docs/kbn_plugin_helpers.mdx +++ b/api_docs/kbn_plugin_helpers.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-plugin-helpers title: "@kbn/plugin-helpers" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/plugin-helpers plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-helpers'] --- import kbnPluginHelpersObj from './kbn_plugin_helpers.devdocs.json'; diff --git a/api_docs/kbn_random_sampling.mdx b/api_docs/kbn_random_sampling.mdx index 233428680703f..d651abcf28c21 100644 --- a/api_docs/kbn_random_sampling.mdx +++ b/api_docs/kbn_random_sampling.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-random-sampling title: "@kbn/random-sampling" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/random-sampling plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/random-sampling'] --- import kbnRandomSamplingObj from './kbn_random_sampling.devdocs.json'; diff --git a/api_docs/kbn_react_field.mdx b/api_docs/kbn_react_field.mdx index bc9790cf70a50..8793c40942a77 100644 --- a/api_docs/kbn_react_field.mdx +++ b/api_docs/kbn_react_field.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-react-field title: "@kbn/react-field" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/react-field plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/react-field'] --- import kbnReactFieldObj from './kbn_react_field.devdocs.json'; diff --git a/api_docs/kbn_repo_file_maps.mdx b/api_docs/kbn_repo_file_maps.mdx index c1c3de99b4d47..5d3ccb537c7c5 100644 --- a/api_docs/kbn_repo_file_maps.mdx +++ b/api_docs/kbn_repo_file_maps.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-repo-file-maps title: "@kbn/repo-file-maps" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/repo-file-maps plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/repo-file-maps'] --- import kbnRepoFileMapsObj from './kbn_repo_file_maps.devdocs.json'; diff --git a/api_docs/kbn_repo_linter.mdx b/api_docs/kbn_repo_linter.mdx index 6658dd54172ed..3a08a6cad8690 100644 --- a/api_docs/kbn_repo_linter.mdx +++ b/api_docs/kbn_repo_linter.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-repo-linter title: "@kbn/repo-linter" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/repo-linter plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/repo-linter'] --- import kbnRepoLinterObj from './kbn_repo_linter.devdocs.json'; diff --git a/api_docs/kbn_repo_path.mdx b/api_docs/kbn_repo_path.mdx index 7333352bd4b65..832b5e3b0b5ac 100644 --- a/api_docs/kbn_repo_path.mdx +++ b/api_docs/kbn_repo_path.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-repo-path title: "@kbn/repo-path" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/repo-path plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/repo-path'] --- import kbnRepoPathObj from './kbn_repo_path.devdocs.json'; diff --git a/api_docs/kbn_repo_source_classifier.mdx b/api_docs/kbn_repo_source_classifier.mdx index 810724ceca4bf..a24ac6a4858ec 100644 --- a/api_docs/kbn_repo_source_classifier.mdx +++ b/api_docs/kbn_repo_source_classifier.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-repo-source-classifier title: "@kbn/repo-source-classifier" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/repo-source-classifier plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/repo-source-classifier'] --- import kbnRepoSourceClassifierObj from './kbn_repo_source_classifier.devdocs.json'; diff --git a/api_docs/kbn_reporting_common.mdx b/api_docs/kbn_reporting_common.mdx index 784f41aaa4b76..23611e7966ed4 100644 --- a/api_docs/kbn_reporting_common.mdx +++ b/api_docs/kbn_reporting_common.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-reporting-common title: "@kbn/reporting-common" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/reporting-common plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/reporting-common'] --- import kbnReportingCommonObj from './kbn_reporting_common.devdocs.json'; diff --git a/api_docs/kbn_rison.mdx b/api_docs/kbn_rison.mdx index d72adf744eb98..8c433d5bcf970 100644 --- a/api_docs/kbn_rison.mdx +++ b/api_docs/kbn_rison.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-rison title: "@kbn/rison" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/rison plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/rison'] --- import kbnRisonObj from './kbn_rison.devdocs.json'; diff --git a/api_docs/kbn_rrule.mdx b/api_docs/kbn_rrule.mdx index e7ff61a0c624a..a22af9baad2a0 100644 --- a/api_docs/kbn_rrule.mdx +++ b/api_docs/kbn_rrule.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-rrule title: "@kbn/rrule" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/rrule plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/rrule'] --- import kbnRruleObj from './kbn_rrule.devdocs.json'; diff --git a/api_docs/kbn_rule_data_utils.mdx b/api_docs/kbn_rule_data_utils.mdx index 5c2f2a0557551..2936772c039d8 100644 --- a/api_docs/kbn_rule_data_utils.mdx +++ b/api_docs/kbn_rule_data_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-rule-data-utils title: "@kbn/rule-data-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/rule-data-utils plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/rule-data-utils'] --- import kbnRuleDataUtilsObj from './kbn_rule_data_utils.devdocs.json'; diff --git a/api_docs/kbn_saved_objects_settings.mdx b/api_docs/kbn_saved_objects_settings.mdx index a636f200c9bea..1654b994ab6f3 100644 --- a/api_docs/kbn_saved_objects_settings.mdx +++ b/api_docs/kbn_saved_objects_settings.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-saved-objects-settings title: "@kbn/saved-objects-settings" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/saved-objects-settings plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/saved-objects-settings'] --- import kbnSavedObjectsSettingsObj from './kbn_saved_objects_settings.devdocs.json'; diff --git a/api_docs/kbn_security_solution_side_nav.mdx b/api_docs/kbn_security_solution_side_nav.mdx index ceb49813fad22..cf1fe0cb21093 100644 --- a/api_docs/kbn_security_solution_side_nav.mdx +++ b/api_docs/kbn_security_solution_side_nav.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-security-solution-side-nav title: "@kbn/security-solution-side-nav" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/security-solution-side-nav plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/security-solution-side-nav'] --- import kbnSecuritySolutionSideNavObj from './kbn_security_solution_side_nav.devdocs.json'; diff --git a/api_docs/kbn_security_solution_storybook_config.mdx b/api_docs/kbn_security_solution_storybook_config.mdx index a0376092022b2..d768d1e64fc46 100644 --- a/api_docs/kbn_security_solution_storybook_config.mdx +++ b/api_docs/kbn_security_solution_storybook_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-security-solution-storybook-config title: "@kbn/security-solution-storybook-config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/security-solution-storybook-config plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/security-solution-storybook-config'] --- import kbnSecuritySolutionStorybookConfigObj from './kbn_security_solution_storybook_config.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_autocomplete.mdx b/api_docs/kbn_securitysolution_autocomplete.mdx index 4539dc7aa6b85..d69520c161f93 100644 --- a/api_docs/kbn_securitysolution_autocomplete.mdx +++ b/api_docs/kbn_securitysolution_autocomplete.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-autocomplete title: "@kbn/securitysolution-autocomplete" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-autocomplete plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-autocomplete'] --- import kbnSecuritysolutionAutocompleteObj from './kbn_securitysolution_autocomplete.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_data_table.mdx b/api_docs/kbn_securitysolution_data_table.mdx index 885b14f6806e4..062768773e583 100644 --- a/api_docs/kbn_securitysolution_data_table.mdx +++ b/api_docs/kbn_securitysolution_data_table.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-data-table title: "@kbn/securitysolution-data-table" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-data-table plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-data-table'] --- import kbnSecuritysolutionDataTableObj from './kbn_securitysolution_data_table.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_ecs.mdx b/api_docs/kbn_securitysolution_ecs.mdx index b70d56b389188..a6e2e803596a2 100644 --- a/api_docs/kbn_securitysolution_ecs.mdx +++ b/api_docs/kbn_securitysolution_ecs.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-ecs title: "@kbn/securitysolution-ecs" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-ecs plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-ecs'] --- import kbnSecuritysolutionEcsObj from './kbn_securitysolution_ecs.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_es_utils.mdx b/api_docs/kbn_securitysolution_es_utils.mdx index 12775e6d70cae..439b0ac0b598c 100644 --- a/api_docs/kbn_securitysolution_es_utils.mdx +++ b/api_docs/kbn_securitysolution_es_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-es-utils title: "@kbn/securitysolution-es-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-es-utils plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-es-utils'] --- import kbnSecuritysolutionEsUtilsObj from './kbn_securitysolution_es_utils.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_exception_list_components.mdx b/api_docs/kbn_securitysolution_exception_list_components.mdx index 9a0de2dab7a4b..3345084fcb005 100644 --- a/api_docs/kbn_securitysolution_exception_list_components.mdx +++ b/api_docs/kbn_securitysolution_exception_list_components.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-exception-list-components title: "@kbn/securitysolution-exception-list-components" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-exception-list-components plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-exception-list-components'] --- import kbnSecuritysolutionExceptionListComponentsObj from './kbn_securitysolution_exception_list_components.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_grouping.mdx b/api_docs/kbn_securitysolution_grouping.mdx index 25b206ca64627..7e3b5e08a4b2b 100644 --- a/api_docs/kbn_securitysolution_grouping.mdx +++ b/api_docs/kbn_securitysolution_grouping.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-grouping title: "@kbn/securitysolution-grouping" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-grouping plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-grouping'] --- import kbnSecuritysolutionGroupingObj from './kbn_securitysolution_grouping.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_hook_utils.mdx b/api_docs/kbn_securitysolution_hook_utils.mdx index 9e856adc8569b..f6d2e03ae4f45 100644 --- a/api_docs/kbn_securitysolution_hook_utils.mdx +++ b/api_docs/kbn_securitysolution_hook_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-hook-utils title: "@kbn/securitysolution-hook-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-hook-utils plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-hook-utils'] --- import kbnSecuritysolutionHookUtilsObj from './kbn_securitysolution_hook_utils.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx b/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx index 5694e12a7a9fc..a580683b07c9e 100644 --- a/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx +++ b/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx @@ -8,7 +8,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 description: API docs for the @kbn/securitysolution-io-ts-alerting-types plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-alerting-types'] --- import kbnSecuritysolutionIoTsAlertingTypesObj from './kbn_securitysolution_io_ts_alerting_types.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_io_ts_list_types.mdx b/api_docs/kbn_securitysolution_io_ts_list_types.mdx index 4f723ae1661e6..ca63091c179d1 100644 --- a/api_docs/kbn_securitysolution_io_ts_list_types.mdx +++ b/api_docs/kbn_securitysolution_io_ts_list_types.mdx @@ -8,7 +8,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 description: API docs for the @kbn/securitysolution-io-ts-list-types plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-list-types'] --- import kbnSecuritysolutionIoTsListTypesObj from './kbn_securitysolution_io_ts_list_types.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_io_ts_types.mdx b/api_docs/kbn_securitysolution_io_ts_types.mdx index 18a0dfb4aeead..bd5944c3ea418 100644 --- a/api_docs/kbn_securitysolution_io_ts_types.mdx +++ b/api_docs/kbn_securitysolution_io_ts_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-types title: "@kbn/securitysolution-io-ts-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-io-ts-types plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-types'] --- import kbnSecuritysolutionIoTsTypesObj from './kbn_securitysolution_io_ts_types.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_io_ts_utils.mdx b/api_docs/kbn_securitysolution_io_ts_utils.mdx index 875ddb0081c96..3fbe6d87fd38a 100644 --- a/api_docs/kbn_securitysolution_io_ts_utils.mdx +++ b/api_docs/kbn_securitysolution_io_ts_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-utils title: "@kbn/securitysolution-io-ts-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-io-ts-utils plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-utils'] --- import kbnSecuritysolutionIoTsUtilsObj from './kbn_securitysolution_io_ts_utils.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_list_api.mdx b/api_docs/kbn_securitysolution_list_api.mdx index 07cd55fc531ce..060ae1673f679 100644 --- a/api_docs/kbn_securitysolution_list_api.mdx +++ b/api_docs/kbn_securitysolution_list_api.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-api title: "@kbn/securitysolution-list-api" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-list-api plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-api'] --- import kbnSecuritysolutionListApiObj from './kbn_securitysolution_list_api.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_list_constants.mdx b/api_docs/kbn_securitysolution_list_constants.mdx index 0ef68983298bd..26ee24a660cdd 100644 --- a/api_docs/kbn_securitysolution_list_constants.mdx +++ b/api_docs/kbn_securitysolution_list_constants.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-constants title: "@kbn/securitysolution-list-constants" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-list-constants plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-constants'] --- import kbnSecuritysolutionListConstantsObj from './kbn_securitysolution_list_constants.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_list_hooks.mdx b/api_docs/kbn_securitysolution_list_hooks.mdx index c8041592b14f9..ef393463a4b6c 100644 --- a/api_docs/kbn_securitysolution_list_hooks.mdx +++ b/api_docs/kbn_securitysolution_list_hooks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-hooks title: "@kbn/securitysolution-list-hooks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-list-hooks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-hooks'] --- import kbnSecuritysolutionListHooksObj from './kbn_securitysolution_list_hooks.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_list_utils.mdx b/api_docs/kbn_securitysolution_list_utils.mdx index 0a655ad808183..a641eb5d53919 100644 --- a/api_docs/kbn_securitysolution_list_utils.mdx +++ b/api_docs/kbn_securitysolution_list_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-utils title: "@kbn/securitysolution-list-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-list-utils plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-utils'] --- import kbnSecuritysolutionListUtilsObj from './kbn_securitysolution_list_utils.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_rules.mdx b/api_docs/kbn_securitysolution_rules.mdx index 0757e0dceb14c..98c67ffdbf7a6 100644 --- a/api_docs/kbn_securitysolution_rules.mdx +++ b/api_docs/kbn_securitysolution_rules.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-rules title: "@kbn/securitysolution-rules" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-rules plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-rules'] --- import kbnSecuritysolutionRulesObj from './kbn_securitysolution_rules.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_t_grid.mdx b/api_docs/kbn_securitysolution_t_grid.mdx index b7c63171a152d..113a082fe1c2a 100644 --- a/api_docs/kbn_securitysolution_t_grid.mdx +++ b/api_docs/kbn_securitysolution_t_grid.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-t-grid title: "@kbn/securitysolution-t-grid" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-t-grid plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-t-grid'] --- import kbnSecuritysolutionTGridObj from './kbn_securitysolution_t_grid.devdocs.json'; diff --git a/api_docs/kbn_securitysolution_utils.mdx b/api_docs/kbn_securitysolution_utils.mdx index b018b1732de98..7885f55b00c96 100644 --- a/api_docs/kbn_securitysolution_utils.mdx +++ b/api_docs/kbn_securitysolution_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-utils title: "@kbn/securitysolution-utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/securitysolution-utils plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-utils'] --- import kbnSecuritysolutionUtilsObj from './kbn_securitysolution_utils.devdocs.json'; diff --git a/api_docs/kbn_server_http_tools.mdx b/api_docs/kbn_server_http_tools.mdx index 9b388a02d86cb..4f5bcb4538797 100644 --- a/api_docs/kbn_server_http_tools.mdx +++ b/api_docs/kbn_server_http_tools.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-server-http-tools title: "@kbn/server-http-tools" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/server-http-tools plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/server-http-tools'] --- import kbnServerHttpToolsObj from './kbn_server_http_tools.devdocs.json'; diff --git a/api_docs/kbn_server_route_repository.mdx b/api_docs/kbn_server_route_repository.mdx index 8f7e62fc55188..5b14ce9d2b426 100644 --- a/api_docs/kbn_server_route_repository.mdx +++ b/api_docs/kbn_server_route_repository.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-server-route-repository title: "@kbn/server-route-repository" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/server-route-repository plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/server-route-repository'] --- import kbnServerRouteRepositoryObj from './kbn_server_route_repository.devdocs.json'; diff --git a/api_docs/kbn_serverless_project_switcher.mdx b/api_docs/kbn_serverless_project_switcher.mdx index 2d17a8a632883..394d3c801fcc7 100644 --- a/api_docs/kbn_serverless_project_switcher.mdx +++ b/api_docs/kbn_serverless_project_switcher.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-serverless-project-switcher title: "@kbn/serverless-project-switcher" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/serverless-project-switcher plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/serverless-project-switcher'] --- import kbnServerlessProjectSwitcherObj from './kbn_serverless_project_switcher.devdocs.json'; diff --git a/api_docs/kbn_serverless_storybook_config.mdx b/api_docs/kbn_serverless_storybook_config.mdx index 99e2db0f3160c..d31440fc1bcae 100644 --- a/api_docs/kbn_serverless_storybook_config.mdx +++ b/api_docs/kbn_serverless_storybook_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-serverless-storybook-config title: "@kbn/serverless-storybook-config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/serverless-storybook-config plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/serverless-storybook-config'] --- import kbnServerlessStorybookConfigObj from './kbn_serverless_storybook_config.devdocs.json'; diff --git a/api_docs/kbn_shared_svg.mdx b/api_docs/kbn_shared_svg.mdx index 54672c1714b13..9c9db45d85f72 100644 --- a/api_docs/kbn_shared_svg.mdx +++ b/api_docs/kbn_shared_svg.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-svg title: "@kbn/shared-svg" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-svg plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-svg'] --- import kbnSharedSvgObj from './kbn_shared_svg.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_avatar_solution.mdx b/api_docs/kbn_shared_ux_avatar_solution.mdx index 77fea53183751..950a2f4ededd8 100644 --- a/api_docs/kbn_shared_ux_avatar_solution.mdx +++ b/api_docs/kbn_shared_ux_avatar_solution.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-avatar-solution title: "@kbn/shared-ux-avatar-solution" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-avatar-solution plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-avatar-solution'] --- import kbnSharedUxAvatarSolutionObj from './kbn_shared_ux_avatar_solution.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_avatar_user_profile_components.mdx b/api_docs/kbn_shared_ux_avatar_user_profile_components.mdx index a6bf5f990572c..d583354bc998f 100644 --- a/api_docs/kbn_shared_ux_avatar_user_profile_components.mdx +++ b/api_docs/kbn_shared_ux_avatar_user_profile_components.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-avatar-user-profile-components title: "@kbn/shared-ux-avatar-user-profile-components" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-avatar-user-profile-components plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-avatar-user-profile-components'] --- import kbnSharedUxAvatarUserProfileComponentsObj from './kbn_shared_ux_avatar_user_profile_components.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_button_exit_full_screen.mdx b/api_docs/kbn_shared_ux_button_exit_full_screen.mdx index 114a459b3752b..0574400808471 100644 --- a/api_docs/kbn_shared_ux_button_exit_full_screen.mdx +++ b/api_docs/kbn_shared_ux_button_exit_full_screen.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-button-exit-full-screen title: "@kbn/shared-ux-button-exit-full-screen" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-button-exit-full-screen plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-button-exit-full-screen'] --- import kbnSharedUxButtonExitFullScreenObj from './kbn_shared_ux_button_exit_full_screen.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_button_exit_full_screen_mocks.mdx b/api_docs/kbn_shared_ux_button_exit_full_screen_mocks.mdx index 3ee3d134dcf75..10266a886d5f4 100644 --- a/api_docs/kbn_shared_ux_button_exit_full_screen_mocks.mdx +++ b/api_docs/kbn_shared_ux_button_exit_full_screen_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-button-exit-full-screen-mocks title: "@kbn/shared-ux-button-exit-full-screen-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-button-exit-full-screen-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-button-exit-full-screen-mocks'] --- import kbnSharedUxButtonExitFullScreenMocksObj from './kbn_shared_ux_button_exit_full_screen_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_button_toolbar.mdx b/api_docs/kbn_shared_ux_button_toolbar.mdx index abf38d393c0b4..8d83e340d8d49 100644 --- a/api_docs/kbn_shared_ux_button_toolbar.mdx +++ b/api_docs/kbn_shared_ux_button_toolbar.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-button-toolbar title: "@kbn/shared-ux-button-toolbar" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-button-toolbar plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-button-toolbar'] --- import kbnSharedUxButtonToolbarObj from './kbn_shared_ux_button_toolbar.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_card_no_data.mdx b/api_docs/kbn_shared_ux_card_no_data.mdx index a89f4255c17ee..94f86cbae8648 100644 --- a/api_docs/kbn_shared_ux_card_no_data.mdx +++ b/api_docs/kbn_shared_ux_card_no_data.mdx @@ -8,7 +8,7 @@ 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 description: API docs for the @kbn/shared-ux-card-no-data plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-card-no-data'] --- import kbnSharedUxCardNoDataObj from './kbn_shared_ux_card_no_data.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_card_no_data_mocks.mdx b/api_docs/kbn_shared_ux_card_no_data_mocks.mdx index ce5979542650b..966c628eb462f 100644 --- a/api_docs/kbn_shared_ux_card_no_data_mocks.mdx +++ b/api_docs/kbn_shared_ux_card_no_data_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-card-no-data-mocks title: "@kbn/shared-ux-card-no-data-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-card-no-data-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-card-no-data-mocks'] --- import kbnSharedUxCardNoDataMocksObj from './kbn_shared_ux_card_no_data_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_chrome_navigation.devdocs.json b/api_docs/kbn_shared_ux_chrome_navigation.devdocs.json index fa3d717f2d9a7..fe0dc89f448df 100644 --- a/api_docs/kbn_shared_ux_chrome_navigation.devdocs.json +++ b/api_docs/kbn_shared_ux_chrome_navigation.devdocs.json @@ -580,7 +580,7 @@ "tags": [], "label": "defaultIsCollapsed", "description": [ - "\nFlag to indicate if the group is initially collapsed or not.\n\n`false`: the group will be opened event if none of its children nodes matches the current URL.\n\n`true`: the group will be collapsed event if any of its children nodes matches the current URL.\n\n`undefined`: the group will be opened if any of its children nodes matches the current URL." + "\nFlag to indicate if the group is initially collapsed or not.\n\n`undefined`: (Recommended) the group will be opened if any of its children nodes matches the current URL.\n\n`false`: the group will be opened event if none of its children nodes matches the current URL.\n\n`true`: the group will be collapsed event if any of its children nodes matches the current URL." ], "signature": [ "boolean | undefined" @@ -816,6 +816,20 @@ "path": "packages/shared-ux/chrome/navigation/types/index.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "@kbn/shared-ux-chrome-navigation", + "id": "def-common.NavigationServices.cloudLinks", + "type": "Object", + "tags": [], + "label": "cloudLinks", + "description": [], + "signature": [ + "{ userAndRoles?: { title: string; href: string; } | undefined; performance?: { title: string; href: string; } | undefined; billingAndSub?: { title: string; href: string; } | undefined; }" + ], + "path": "packages/shared-ux/chrome/navigation/types/index.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false diff --git a/api_docs/kbn_shared_ux_chrome_navigation.mdx b/api_docs/kbn_shared_ux_chrome_navigation.mdx index 32cde58c6761e..305993133a9ec 100644 --- a/api_docs/kbn_shared_ux_chrome_navigation.mdx +++ b/api_docs/kbn_shared_ux_chrome_navigation.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-chrome-navigation title: "@kbn/shared-ux-chrome-navigation" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-chrome-navigation plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-chrome-navigation'] --- import kbnSharedUxChromeNavigationObj from './kbn_shared_ux_chrome_navigation.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sh | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 45 | 0 | 36 | 4 | +| 46 | 0 | 37 | 4 | ## Common diff --git a/api_docs/kbn_shared_ux_file_context.mdx b/api_docs/kbn_shared_ux_file_context.mdx index 81bb74262835f..c3f2b76a55b36 100644 --- a/api_docs/kbn_shared_ux_file_context.mdx +++ b/api_docs/kbn_shared_ux_file_context.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-context title: "@kbn/shared-ux-file-context" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-file-context plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-file-context'] --- import kbnSharedUxFileContextObj from './kbn_shared_ux_file_context.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_file_image.mdx b/api_docs/kbn_shared_ux_file_image.mdx index 2cb5705f96c47..b1f73a0eb87d7 100644 --- a/api_docs/kbn_shared_ux_file_image.mdx +++ b/api_docs/kbn_shared_ux_file_image.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-image title: "@kbn/shared-ux-file-image" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-file-image plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-file-image'] --- import kbnSharedUxFileImageObj from './kbn_shared_ux_file_image.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_file_image_mocks.mdx b/api_docs/kbn_shared_ux_file_image_mocks.mdx index e9a9f78367f15..c54ea7f744bdb 100644 --- a/api_docs/kbn_shared_ux_file_image_mocks.mdx +++ b/api_docs/kbn_shared_ux_file_image_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-image-mocks title: "@kbn/shared-ux-file-image-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-file-image-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-file-image-mocks'] --- import kbnSharedUxFileImageMocksObj from './kbn_shared_ux_file_image_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_file_mocks.mdx b/api_docs/kbn_shared_ux_file_mocks.mdx index 4f767fecb13d2..ee65539c64fb6 100644 --- a/api_docs/kbn_shared_ux_file_mocks.mdx +++ b/api_docs/kbn_shared_ux_file_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-mocks title: "@kbn/shared-ux-file-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-file-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-file-mocks'] --- import kbnSharedUxFileMocksObj from './kbn_shared_ux_file_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_file_picker.mdx b/api_docs/kbn_shared_ux_file_picker.mdx index e6afbaff0894e..030a5895a10d9 100644 --- a/api_docs/kbn_shared_ux_file_picker.mdx +++ b/api_docs/kbn_shared_ux_file_picker.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-picker title: "@kbn/shared-ux-file-picker" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-file-picker plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-file-picker'] --- import kbnSharedUxFilePickerObj from './kbn_shared_ux_file_picker.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_file_types.mdx b/api_docs/kbn_shared_ux_file_types.mdx index a3b4ed8f9caf5..4cf6c667ea9e3 100644 --- a/api_docs/kbn_shared_ux_file_types.mdx +++ b/api_docs/kbn_shared_ux_file_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-types title: "@kbn/shared-ux-file-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-file-types plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-file-types'] --- import kbnSharedUxFileTypesObj from './kbn_shared_ux_file_types.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_file_upload.mdx b/api_docs/kbn_shared_ux_file_upload.mdx index 2d1b0261a4e46..07c25b27a6103 100644 --- a/api_docs/kbn_shared_ux_file_upload.mdx +++ b/api_docs/kbn_shared_ux_file_upload.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-upload title: "@kbn/shared-ux-file-upload" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-file-upload plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-file-upload'] --- import kbnSharedUxFileUploadObj from './kbn_shared_ux_file_upload.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_file_util.mdx b/api_docs/kbn_shared_ux_file_util.mdx index c7b530611a172..4b8f241595b4c 100644 --- a/api_docs/kbn_shared_ux_file_util.mdx +++ b/api_docs/kbn_shared_ux_file_util.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-file-util title: "@kbn/shared-ux-file-util" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-file-util plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-file-util'] --- import kbnSharedUxFileUtilObj from './kbn_shared_ux_file_util.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_link_redirect_app.mdx b/api_docs/kbn_shared_ux_link_redirect_app.mdx index e38ea0f4d2a21..ba258be235f08 100644 --- a/api_docs/kbn_shared_ux_link_redirect_app.mdx +++ b/api_docs/kbn_shared_ux_link_redirect_app.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-link-redirect-app title: "@kbn/shared-ux-link-redirect-app" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-link-redirect-app plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-link-redirect-app'] --- import kbnSharedUxLinkRedirectAppObj from './kbn_shared_ux_link_redirect_app.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_link_redirect_app_mocks.mdx b/api_docs/kbn_shared_ux_link_redirect_app_mocks.mdx index e2839dfa0304f..f8590020711df 100644 --- a/api_docs/kbn_shared_ux_link_redirect_app_mocks.mdx +++ b/api_docs/kbn_shared_ux_link_redirect_app_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-link-redirect-app-mocks title: "@kbn/shared-ux-link-redirect-app-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-link-redirect-app-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-link-redirect-app-mocks'] --- import kbnSharedUxLinkRedirectAppMocksObj from './kbn_shared_ux_link_redirect_app_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_markdown.mdx b/api_docs/kbn_shared_ux_markdown.mdx index fcd56da985b5b..e40316faab031 100644 --- a/api_docs/kbn_shared_ux_markdown.mdx +++ b/api_docs/kbn_shared_ux_markdown.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-markdown title: "@kbn/shared-ux-markdown" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-markdown plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-markdown'] --- import kbnSharedUxMarkdownObj from './kbn_shared_ux_markdown.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_markdown_mocks.mdx b/api_docs/kbn_shared_ux_markdown_mocks.mdx index 17aa748038269..12957a4dbe293 100644 --- a/api_docs/kbn_shared_ux_markdown_mocks.mdx +++ b/api_docs/kbn_shared_ux_markdown_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-markdown-mocks title: "@kbn/shared-ux-markdown-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-markdown-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-markdown-mocks'] --- import kbnSharedUxMarkdownMocksObj from './kbn_shared_ux_markdown_mocks.devdocs.json'; 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 fb5aca4efd734..505bdd8307c80 100644 --- a/api_docs/kbn_shared_ux_page_analytics_no_data.mdx +++ b/api_docs/kbn_shared_ux_page_analytics_no_data.mdx @@ -8,7 +8,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 description: API docs for the @kbn/shared-ux-page-analytics-no-data plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-analytics-no-data'] --- import kbnSharedUxPageAnalyticsNoDataObj from './kbn_shared_ux_page_analytics_no_data.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_page_analytics_no_data_mocks.mdx b/api_docs/kbn_shared_ux_page_analytics_no_data_mocks.mdx index 026391b6489a8..f1bac6bf0b2c0 100644 --- a/api_docs/kbn_shared_ux_page_analytics_no_data_mocks.mdx +++ b/api_docs/kbn_shared_ux_page_analytics_no_data_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-analytics-no-data-mocks title: "@kbn/shared-ux-page-analytics-no-data-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-analytics-no-data-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-analytics-no-data-mocks'] --- import kbnSharedUxPageAnalyticsNoDataMocksObj from './kbn_shared_ux_page_analytics_no_data_mocks.devdocs.json'; 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 97d124ede683c..23cbf173a87f8 100644 --- a/api_docs/kbn_shared_ux_page_kibana_no_data.mdx +++ b/api_docs/kbn_shared_ux_page_kibana_no_data.mdx @@ -8,7 +8,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 description: API docs for the @kbn/shared-ux-page-kibana-no-data plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-kibana-no-data'] --- import kbnSharedUxPageKibanaNoDataObj from './kbn_shared_ux_page_kibana_no_data.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_page_kibana_no_data_mocks.mdx b/api_docs/kbn_shared_ux_page_kibana_no_data_mocks.mdx index 10a594f474cb3..b53af7f46ada7 100644 --- a/api_docs/kbn_shared_ux_page_kibana_no_data_mocks.mdx +++ b/api_docs/kbn_shared_ux_page_kibana_no_data_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-kibana-no-data-mocks title: "@kbn/shared-ux-page-kibana-no-data-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-kibana-no-data-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-kibana-no-data-mocks'] --- import kbnSharedUxPageKibanaNoDataMocksObj from './kbn_shared_ux_page_kibana_no_data_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_page_kibana_template.mdx b/api_docs/kbn_shared_ux_page_kibana_template.mdx index 480582c9c0545..8a4f6de7d9c75 100644 --- a/api_docs/kbn_shared_ux_page_kibana_template.mdx +++ b/api_docs/kbn_shared_ux_page_kibana_template.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-kibana-template title: "@kbn/shared-ux-page-kibana-template" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-kibana-template plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-kibana-template'] --- import kbnSharedUxPageKibanaTemplateObj from './kbn_shared_ux_page_kibana_template.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_page_kibana_template_mocks.mdx b/api_docs/kbn_shared_ux_page_kibana_template_mocks.mdx index 141fc7208768b..849a8049bdf5a 100644 --- a/api_docs/kbn_shared_ux_page_kibana_template_mocks.mdx +++ b/api_docs/kbn_shared_ux_page_kibana_template_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-kibana-template-mocks title: "@kbn/shared-ux-page-kibana-template-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-kibana-template-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-kibana-template-mocks'] --- import kbnSharedUxPageKibanaTemplateMocksObj from './kbn_shared_ux_page_kibana_template_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_page_no_data.mdx b/api_docs/kbn_shared_ux_page_no_data.mdx index 3215f62423d07..9f11e0fb1ae5f 100644 --- a/api_docs/kbn_shared_ux_page_no_data.mdx +++ b/api_docs/kbn_shared_ux_page_no_data.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-no-data title: "@kbn/shared-ux-page-no-data" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-no-data plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-no-data'] --- import kbnSharedUxPageNoDataObj from './kbn_shared_ux_page_no_data.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_page_no_data_config.mdx b/api_docs/kbn_shared_ux_page_no_data_config.mdx index a637490c86a42..9f5fe27eb8de4 100644 --- a/api_docs/kbn_shared_ux_page_no_data_config.mdx +++ b/api_docs/kbn_shared_ux_page_no_data_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-no-data-config title: "@kbn/shared-ux-page-no-data-config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-no-data-config plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-no-data-config'] --- import kbnSharedUxPageNoDataConfigObj from './kbn_shared_ux_page_no_data_config.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_page_no_data_config_mocks.mdx b/api_docs/kbn_shared_ux_page_no_data_config_mocks.mdx index dcd97d6c20ccd..114a13e246bea 100644 --- a/api_docs/kbn_shared_ux_page_no_data_config_mocks.mdx +++ b/api_docs/kbn_shared_ux_page_no_data_config_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-no-data-config-mocks title: "@kbn/shared-ux-page-no-data-config-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-no-data-config-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-no-data-config-mocks'] --- import kbnSharedUxPageNoDataConfigMocksObj from './kbn_shared_ux_page_no_data_config_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_page_no_data_mocks.mdx b/api_docs/kbn_shared_ux_page_no_data_mocks.mdx index 43dccbd629075..25b011783a5af 100644 --- a/api_docs/kbn_shared_ux_page_no_data_mocks.mdx +++ b/api_docs/kbn_shared_ux_page_no_data_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-no-data-mocks title: "@kbn/shared-ux-page-no-data-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-no-data-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-no-data-mocks'] --- import kbnSharedUxPageNoDataMocksObj from './kbn_shared_ux_page_no_data_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_page_solution_nav.mdx b/api_docs/kbn_shared_ux_page_solution_nav.mdx index fb77719b003db..20b524ebf8efc 100644 --- a/api_docs/kbn_shared_ux_page_solution_nav.mdx +++ b/api_docs/kbn_shared_ux_page_solution_nav.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-solution-nav title: "@kbn/shared-ux-page-solution-nav" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-page-solution-nav plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-solution-nav'] --- import kbnSharedUxPageSolutionNavObj from './kbn_shared_ux_page_solution_nav.devdocs.json'; 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 b4fdc12475fa1..034a931dde741 100644 --- a/api_docs/kbn_shared_ux_prompt_no_data_views.mdx +++ b/api_docs/kbn_shared_ux_prompt_no_data_views.mdx @@ -8,7 +8,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 description: API docs for the @kbn/shared-ux-prompt-no-data-views plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-prompt-no-data-views'] --- import kbnSharedUxPromptNoDataViewsObj from './kbn_shared_ux_prompt_no_data_views.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_prompt_no_data_views_mocks.mdx b/api_docs/kbn_shared_ux_prompt_no_data_views_mocks.mdx index 2dabb3198cedc..e96138aa21704 100644 --- a/api_docs/kbn_shared_ux_prompt_no_data_views_mocks.mdx +++ b/api_docs/kbn_shared_ux_prompt_no_data_views_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-prompt-no-data-views-mocks title: "@kbn/shared-ux-prompt-no-data-views-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-prompt-no-data-views-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-prompt-no-data-views-mocks'] --- import kbnSharedUxPromptNoDataViewsMocksObj from './kbn_shared_ux_prompt_no_data_views_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_prompt_not_found.mdx b/api_docs/kbn_shared_ux_prompt_not_found.mdx index 73053cd61cfb6..bfffab99df0f7 100644 --- a/api_docs/kbn_shared_ux_prompt_not_found.mdx +++ b/api_docs/kbn_shared_ux_prompt_not_found.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-prompt-not-found title: "@kbn/shared-ux-prompt-not-found" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-prompt-not-found plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-prompt-not-found'] --- import kbnSharedUxPromptNotFoundObj from './kbn_shared_ux_prompt_not_found.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_router.mdx b/api_docs/kbn_shared_ux_router.mdx index 4d69155a02948..12e50edd44ee1 100644 --- a/api_docs/kbn_shared_ux_router.mdx +++ b/api_docs/kbn_shared_ux_router.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-router title: "@kbn/shared-ux-router" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-router plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-router'] --- import kbnSharedUxRouterObj from './kbn_shared_ux_router.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_router_mocks.mdx b/api_docs/kbn_shared_ux_router_mocks.mdx index 53a74ba6dd18b..d788dfc688323 100644 --- a/api_docs/kbn_shared_ux_router_mocks.mdx +++ b/api_docs/kbn_shared_ux_router_mocks.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-router-mocks title: "@kbn/shared-ux-router-mocks" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-router-mocks plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-router-mocks'] --- import kbnSharedUxRouterMocksObj from './kbn_shared_ux_router_mocks.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_storybook_config.mdx b/api_docs/kbn_shared_ux_storybook_config.mdx index 491ba1f9af335..515a026ae8a01 100644 --- a/api_docs/kbn_shared_ux_storybook_config.mdx +++ b/api_docs/kbn_shared_ux_storybook_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-storybook-config title: "@kbn/shared-ux-storybook-config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-storybook-config plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-storybook-config'] --- import kbnSharedUxStorybookConfigObj from './kbn_shared_ux_storybook_config.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_storybook_mock.mdx b/api_docs/kbn_shared_ux_storybook_mock.mdx index 62c3cffc305fc..2ea5cf1c398a3 100644 --- a/api_docs/kbn_shared_ux_storybook_mock.mdx +++ b/api_docs/kbn_shared_ux_storybook_mock.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-storybook-mock title: "@kbn/shared-ux-storybook-mock" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-storybook-mock plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-storybook-mock'] --- import kbnSharedUxStorybookMockObj from './kbn_shared_ux_storybook_mock.devdocs.json'; diff --git a/api_docs/kbn_shared_ux_utility.mdx b/api_docs/kbn_shared_ux_utility.mdx index 07639400b0ad7..9b2e103cc1410 100644 --- a/api_docs/kbn_shared_ux_utility.mdx +++ b/api_docs/kbn_shared_ux_utility.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-utility title: "@kbn/shared-ux-utility" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/shared-ux-utility plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-utility'] --- import kbnSharedUxUtilityObj from './kbn_shared_ux_utility.devdocs.json'; diff --git a/api_docs/kbn_slo_schema.mdx b/api_docs/kbn_slo_schema.mdx index b7ba87842af49..ee5f7bd3b76d3 100644 --- a/api_docs/kbn_slo_schema.mdx +++ b/api_docs/kbn_slo_schema.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-slo-schema title: "@kbn/slo-schema" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/slo-schema plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/slo-schema'] --- import kbnSloSchemaObj from './kbn_slo_schema.devdocs.json'; diff --git a/api_docs/kbn_some_dev_log.mdx b/api_docs/kbn_some_dev_log.mdx index 343af9613a61d..5918d19a3a6f5 100644 --- a/api_docs/kbn_some_dev_log.mdx +++ b/api_docs/kbn_some_dev_log.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-some-dev-log title: "@kbn/some-dev-log" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/some-dev-log plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/some-dev-log'] --- import kbnSomeDevLogObj from './kbn_some_dev_log.devdocs.json'; diff --git a/api_docs/kbn_std.mdx b/api_docs/kbn_std.mdx index 79305962e8dcf..95d1d21b957a6 100644 --- a/api_docs/kbn_std.mdx +++ b/api_docs/kbn_std.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-std title: "@kbn/std" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/std plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/std'] --- import kbnStdObj from './kbn_std.devdocs.json'; diff --git a/api_docs/kbn_stdio_dev_helpers.mdx b/api_docs/kbn_stdio_dev_helpers.mdx index 9c624d2380994..ae8323b9d69d9 100644 --- a/api_docs/kbn_stdio_dev_helpers.mdx +++ b/api_docs/kbn_stdio_dev_helpers.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-stdio-dev-helpers title: "@kbn/stdio-dev-helpers" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/stdio-dev-helpers plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/stdio-dev-helpers'] --- import kbnStdioDevHelpersObj from './kbn_stdio_dev_helpers.devdocs.json'; diff --git a/api_docs/kbn_storybook.mdx b/api_docs/kbn_storybook.mdx index 7ae9a275e5b5d..c246f9727c0a9 100644 --- a/api_docs/kbn_storybook.mdx +++ b/api_docs/kbn_storybook.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-storybook title: "@kbn/storybook" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/storybook plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/storybook'] --- import kbnStorybookObj from './kbn_storybook.devdocs.json'; diff --git a/api_docs/kbn_telemetry_tools.mdx b/api_docs/kbn_telemetry_tools.mdx index eca9ba76ef2f7..6435f362847c0 100644 --- a/api_docs/kbn_telemetry_tools.mdx +++ b/api_docs/kbn_telemetry_tools.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-telemetry-tools title: "@kbn/telemetry-tools" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/telemetry-tools plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/telemetry-tools'] --- import kbnTelemetryToolsObj from './kbn_telemetry_tools.devdocs.json'; diff --git a/api_docs/kbn_test.mdx b/api_docs/kbn_test.mdx index 7f3b985dbe059..6df3f13e8c21a 100644 --- a/api_docs/kbn_test.mdx +++ b/api_docs/kbn_test.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-test title: "@kbn/test" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/test plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/test'] --- import kbnTestObj from './kbn_test.devdocs.json'; diff --git a/api_docs/kbn_test_jest_helpers.mdx b/api_docs/kbn_test_jest_helpers.mdx index 35d572059c064..4b49f8b51fa01 100644 --- a/api_docs/kbn_test_jest_helpers.mdx +++ b/api_docs/kbn_test_jest_helpers.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-test-jest-helpers title: "@kbn/test-jest-helpers" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/test-jest-helpers plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/test-jest-helpers'] --- import kbnTestJestHelpersObj from './kbn_test_jest_helpers.devdocs.json'; diff --git a/api_docs/kbn_test_subj_selector.mdx b/api_docs/kbn_test_subj_selector.mdx index d6ab9ab98811b..df60d8b593860 100644 --- a/api_docs/kbn_test_subj_selector.mdx +++ b/api_docs/kbn_test_subj_selector.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-test-subj-selector title: "@kbn/test-subj-selector" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/test-subj-selector plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/test-subj-selector'] --- import kbnTestSubjSelectorObj from './kbn_test_subj_selector.devdocs.json'; diff --git a/api_docs/kbn_text_based_editor.mdx b/api_docs/kbn_text_based_editor.mdx index e44107e495e30..f66536b6ea657 100644 --- a/api_docs/kbn_text_based_editor.mdx +++ b/api_docs/kbn_text_based_editor.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-text-based-editor title: "@kbn/text-based-editor" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/text-based-editor plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/text-based-editor'] --- import kbnTextBasedEditorObj from './kbn_text_based_editor.devdocs.json'; diff --git a/api_docs/kbn_tooling_log.mdx b/api_docs/kbn_tooling_log.mdx index c1d1de4a2cc04..0243c0f802ae9 100644 --- a/api_docs/kbn_tooling_log.mdx +++ b/api_docs/kbn_tooling_log.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-tooling-log title: "@kbn/tooling-log" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/tooling-log plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/tooling-log'] --- import kbnToolingLogObj from './kbn_tooling_log.devdocs.json'; diff --git a/api_docs/kbn_ts_projects.mdx b/api_docs/kbn_ts_projects.mdx index f063dac793e87..967e1043b3d19 100644 --- a/api_docs/kbn_ts_projects.mdx +++ b/api_docs/kbn_ts_projects.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ts-projects title: "@kbn/ts-projects" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ts-projects plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ts-projects'] --- import kbnTsProjectsObj from './kbn_ts_projects.devdocs.json'; diff --git a/api_docs/kbn_typed_react_router_config.mdx b/api_docs/kbn_typed_react_router_config.mdx index b368d6ec4e376..1137f0032c695 100644 --- a/api_docs/kbn_typed_react_router_config.mdx +++ b/api_docs/kbn_typed_react_router_config.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-typed-react-router-config title: "@kbn/typed-react-router-config" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/typed-react-router-config plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/typed-react-router-config'] --- import kbnTypedReactRouterConfigObj from './kbn_typed_react_router_config.devdocs.json'; diff --git a/api_docs/kbn_ui_actions_browser.mdx b/api_docs/kbn_ui_actions_browser.mdx index 70d0db96c3311..1dab0d161a562 100644 --- a/api_docs/kbn_ui_actions_browser.mdx +++ b/api_docs/kbn_ui_actions_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ui-actions-browser title: "@kbn/ui-actions-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ui-actions-browser plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ui-actions-browser'] --- import kbnUiActionsBrowserObj from './kbn_ui_actions_browser.devdocs.json'; diff --git a/api_docs/kbn_ui_shared_deps_src.mdx b/api_docs/kbn_ui_shared_deps_src.mdx index 5c3ddc31c90fc..90d07a41778d8 100644 --- a/api_docs/kbn_ui_shared_deps_src.mdx +++ b/api_docs/kbn_ui_shared_deps_src.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ui-shared-deps-src title: "@kbn/ui-shared-deps-src" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ui-shared-deps-src plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ui-shared-deps-src'] --- import kbnUiSharedDepsSrcObj from './kbn_ui_shared_deps_src.devdocs.json'; diff --git a/api_docs/kbn_ui_theme.mdx b/api_docs/kbn_ui_theme.mdx index 1212104b10bb7..a65198e462adf 100644 --- a/api_docs/kbn_ui_theme.mdx +++ b/api_docs/kbn_ui_theme.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ui-theme title: "@kbn/ui-theme" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/ui-theme plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ui-theme'] --- import kbnUiThemeObj from './kbn_ui_theme.devdocs.json'; diff --git a/api_docs/kbn_unified_field_list.mdx b/api_docs/kbn_unified_field_list.mdx index 4c13704fcd0ef..e4007133ab6e5 100644 --- a/api_docs/kbn_unified_field_list.mdx +++ b/api_docs/kbn_unified_field_list.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-unified-field-list title: "@kbn/unified-field-list" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/unified-field-list plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/unified-field-list'] --- import kbnUnifiedFieldListObj from './kbn_unified_field_list.devdocs.json'; diff --git a/api_docs/kbn_url_state.mdx b/api_docs/kbn_url_state.mdx index 4bdfc660a9a58..c3a60885710f9 100644 --- a/api_docs/kbn_url_state.mdx +++ b/api_docs/kbn_url_state.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-url-state title: "@kbn/url-state" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/url-state plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/url-state'] --- import kbnUrlStateObj from './kbn_url_state.devdocs.json'; diff --git a/api_docs/kbn_user_profile_components.mdx b/api_docs/kbn_user_profile_components.mdx index e7cae18b0eecc..d4d7cd6085d98 100644 --- a/api_docs/kbn_user_profile_components.mdx +++ b/api_docs/kbn_user_profile_components.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-user-profile-components title: "@kbn/user-profile-components" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/user-profile-components plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/user-profile-components'] --- import kbnUserProfileComponentsObj from './kbn_user_profile_components.devdocs.json'; diff --git a/api_docs/kbn_utility_types.mdx b/api_docs/kbn_utility_types.mdx index 72ceda2db5052..1997b3e62c537 100644 --- a/api_docs/kbn_utility_types.mdx +++ b/api_docs/kbn_utility_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-utility-types title: "@kbn/utility-types" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/utility-types plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/utility-types'] --- import kbnUtilityTypesObj from './kbn_utility_types.devdocs.json'; diff --git a/api_docs/kbn_utility_types_jest.devdocs.json b/api_docs/kbn_utility_types_jest.devdocs.json index 78dfcb9ccd830..9d6394e780ac4 100644 --- a/api_docs/kbn_utility_types_jest.devdocs.json +++ b/api_docs/kbn_utility_types_jest.devdocs.json @@ -38,7 +38,7 @@ "section": "def-common.DeeplyMockedKeys", "text": "DeeplyMockedKeys" }, - "[] : T[P] extends (...args: any[]) => any ? jest.MockInstance, Parameters> : T[P] extends object ? ", + "[] : T[P] extends (...args: any[]) => any ? jest.MockInstance, Parameters, any> : T[P] extends object ? ", { "pluginId": "@kbn/utility-types-jest", "scope": "common", diff --git a/api_docs/kbn_utility_types_jest.mdx b/api_docs/kbn_utility_types_jest.mdx index 1cb6601c5db39..bf0bbaf4cd927 100644 --- a/api_docs/kbn_utility_types_jest.mdx +++ b/api_docs/kbn_utility_types_jest.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-utility-types-jest title: "@kbn/utility-types-jest" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/utility-types-jest plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/utility-types-jest'] --- import kbnUtilityTypesJestObj from './kbn_utility_types_jest.devdocs.json'; diff --git a/api_docs/kbn_utils.mdx b/api_docs/kbn_utils.mdx index 075363f2e0493..0463e6df31ba9 100644 --- a/api_docs/kbn_utils.mdx +++ b/api_docs/kbn_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-utils title: "@kbn/utils" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/utils plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/utils'] --- import kbnUtilsObj from './kbn_utils.devdocs.json'; diff --git a/api_docs/visualization_ui_components.devdocs.json b/api_docs/kbn_visualization_ui_components.devdocs.json similarity index 74% rename from api_docs/visualization_ui_components.devdocs.json rename to api_docs/kbn_visualization_ui_components.devdocs.json index f068338120280..8fee65d445c51 100644 --- a/api_docs/visualization_ui_components.devdocs.json +++ b/api_docs/kbn_visualization_ui_components.devdocs.json @@ -1,10 +1,10 @@ { - "id": "visualizationUiComponents", + "id": "@kbn/visualization-ui-components", "client": { "classes": [], "functions": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.ColorPicker", "type": "Function", "tags": [], @@ -13,23 +13,23 @@ "signature": [ "({ overwriteColor, defaultColor, setConfig, label, disableHelpTooltip, disabledMessage, showAlpha, }: { overwriteColor?: string | null | undefined; defaultColor?: string | null | undefined; setConfig: (config: { color?: string | undefined; }) => void; label?: string | undefined; disableHelpTooltip?: boolean | undefined; disabledMessage?: string | undefined; showAlpha?: boolean | undefined; }) => JSX.Element" ], - "path": "src/plugins/visualization_ui_components/public/components/color_picker.tsx", + "path": "packages/kbn-visualization-ui-components/components/color_picker.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.ColorPicker.$1", "type": "Object", "tags": [], "label": "{\n overwriteColor,\n defaultColor,\n setConfig,\n label,\n disableHelpTooltip,\n disabledMessage,\n showAlpha,\n}", "description": [], - "path": "src/plugins/visualization_ui_components/public/components/color_picker.tsx", + "path": "packages/kbn-visualization-ui-components/components/color_picker.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.ColorPicker.$1.overwriteColor", "type": "CompoundType", "tags": [], @@ -38,12 +38,12 @@ "signature": [ "string | null | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/color_picker.tsx", + "path": "packages/kbn-visualization-ui-components/components/color_picker.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.ColorPicker.$1.defaultColor", "type": "CompoundType", "tags": [], @@ -52,12 +52,12 @@ "signature": [ "string | null | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/color_picker.tsx", + "path": "packages/kbn-visualization-ui-components/components/color_picker.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.ColorPicker.$1.setConfig", "type": "Function", "tags": [], @@ -66,23 +66,23 @@ "signature": [ "(config: { color?: string | undefined; }) => void" ], - "path": "src/plugins/visualization_ui_components/public/components/color_picker.tsx", + "path": "packages/kbn-visualization-ui-components/components/color_picker.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.ColorPicker.$1.setConfig.$1", "type": "Object", "tags": [], "label": "config", "description": [], - "path": "src/plugins/visualization_ui_components/public/components/color_picker.tsx", + "path": "packages/kbn-visualization-ui-components/components/color_picker.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.ColorPicker.$1.setConfig.$1.color", "type": "string", "tags": [], @@ -91,7 +91,7 @@ "signature": [ "string | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/color_picker.tsx", + "path": "packages/kbn-visualization-ui-components/components/color_picker.tsx", "deprecated": false, "trackAdoption": false } @@ -101,7 +101,7 @@ "returnComment": [] }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.ColorPicker.$1.label", "type": "string", "tags": [], @@ -110,12 +110,12 @@ "signature": [ "string | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/color_picker.tsx", + "path": "packages/kbn-visualization-ui-components/components/color_picker.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.ColorPicker.$1.disableHelpTooltip", "type": "CompoundType", "tags": [], @@ -124,12 +124,12 @@ "signature": [ "boolean | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/color_picker.tsx", + "path": "packages/kbn-visualization-ui-components/components/color_picker.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.ColorPicker.$1.disabledMessage", "type": "string", "tags": [], @@ -138,12 +138,12 @@ "signature": [ "string | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/color_picker.tsx", + "path": "packages/kbn-visualization-ui-components/components/color_picker.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.ColorPicker.$1.showAlpha", "type": "CompoundType", "tags": [], @@ -152,7 +152,7 @@ "signature": [ "boolean | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/color_picker.tsx", + "path": "packages/kbn-visualization-ui-components/components/color_picker.tsx", "deprecated": false, "trackAdoption": false } @@ -163,7 +163,7 @@ "initialIsOpen": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.DebouncedInput", "type": "Function", "tags": [], @@ -174,12 +174,12 @@ "signature": [ "(props: Props) => JSX.Element" ], - "path": "src/plugins/visualization_ui_components/public/components/debounced_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/debounced_input.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.DebouncedInput.$1", "type": "CompoundType", "tags": [], @@ -188,7 +188,7 @@ "signature": [ "Props" ], - "path": "src/plugins/visualization_ui_components/public/components/debounced_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/debounced_input.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -198,7 +198,7 @@ "initialIsOpen": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.DimensionButton", "type": "Function", "tags": [], @@ -209,12 +209,12 @@ "DimensionButtonProps", ") => JSX.Element" ], - "path": "src/plugins/visualization_ui_components/public/components/dimension_buttons/dimension_button.tsx", + "path": "packages/kbn-visualization-ui-components/components/dimension_buttons/dimension_button.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.DimensionButton.$1", "type": "Object", "tags": [], @@ -223,7 +223,7 @@ "signature": [ "DimensionButtonProps" ], - "path": "src/plugins/visualization_ui_components/public/components/dimension_buttons/dimension_button.tsx", + "path": "packages/kbn-visualization-ui-components/components/dimension_buttons/dimension_button.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -233,7 +233,7 @@ "initialIsOpen": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.DimensionEditorSection", "type": "Function", "tags": [], @@ -242,23 +242,23 @@ "signature": [ "({ children, title, }: { title?: string | undefined; children?: React.ReactNode | React.ReactNode[]; }) => JSX.Element" ], - "path": "src/plugins/visualization_ui_components/public/components/dimension_editor_section.tsx", + "path": "packages/kbn-visualization-ui-components/components/dimension_editor_section.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.DimensionEditorSection.$1", "type": "Object", "tags": [], "label": "{\n children,\n title,\n}", "description": [], - "path": "src/plugins/visualization_ui_components/public/components/dimension_editor_section.tsx", + "path": "packages/kbn-visualization-ui-components/components/dimension_editor_section.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.DimensionEditorSection.$1.title", "type": "string", "tags": [], @@ -267,12 +267,12 @@ "signature": [ "string | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/dimension_editor_section.tsx", + "path": "packages/kbn-visualization-ui-components/components/dimension_editor_section.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.DimensionEditorSection.$1.children", "type": "CompoundType", "tags": [], @@ -281,7 +281,7 @@ "signature": [ "React.ReactNode | React.ReactNode[]" ], - "path": "src/plugins/visualization_ui_components/public/components/dimension_editor_section.tsx", + "path": "packages/kbn-visualization-ui-components/components/dimension_editor_section.tsx", "deprecated": false, "trackAdoption": false } @@ -292,7 +292,7 @@ "initialIsOpen": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.DimensionTrigger", "type": "Function", "tags": [], @@ -303,23 +303,23 @@ "Property", ".Color | undefined; dataTestSubj?: string | undefined; }) => JSX.Element" ], - "path": "src/plugins/visualization_ui_components/public/components/dimension_buttons/trigger.tsx", + "path": "packages/kbn-visualization-ui-components/components/dimension_buttons/trigger.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.DimensionTrigger.$1", "type": "Object", "tags": [], "label": "{\n id,\n label,\n color,\n dataTestSubj,\n}", "description": [], - "path": "src/plugins/visualization_ui_components/public/components/dimension_buttons/trigger.tsx", + "path": "packages/kbn-visualization-ui-components/components/dimension_buttons/trigger.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.DimensionTrigger.$1.label", "type": "CompoundType", "tags": [], @@ -328,12 +328,12 @@ "signature": [ "boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | null | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/dimension_buttons/trigger.tsx", + "path": "packages/kbn-visualization-ui-components/components/dimension_buttons/trigger.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.DimensionTrigger.$1.id", "type": "string", "tags": [], @@ -342,12 +342,12 @@ "signature": [ "string | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/dimension_buttons/trigger.tsx", + "path": "packages/kbn-visualization-ui-components/components/dimension_buttons/trigger.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.DimensionTrigger.$1.color", "type": "CompoundType", "tags": [], @@ -358,12 +358,12 @@ "Property", ".Color | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/dimension_buttons/trigger.tsx", + "path": "packages/kbn-visualization-ui-components/components/dimension_buttons/trigger.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.DimensionTrigger.$1.dataTestSubj", "type": "string", "tags": [], @@ -372,7 +372,7 @@ "signature": [ "string | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/dimension_buttons/trigger.tsx", + "path": "packages/kbn-visualization-ui-components/components/dimension_buttons/trigger.tsx", "deprecated": false, "trackAdoption": false } @@ -383,7 +383,7 @@ "initialIsOpen": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.DragDropBuckets", "type": "Function", "tags": [], @@ -392,23 +392,23 @@ "signature": [ "({\n items,\n onDragStart,\n onDragEnd,\n droppableId,\n children,\n bgColor,\n}: { items: T[]; droppableId: string; children: React.ReactElement>[]; onDragStart?: (() => void) | undefined; onDragEnd?: ((items: T[]) => void) | undefined; bgColor?: \"warning\" | \"success\" | \"subdued\" | \"primary\" | \"accent\" | \"danger\" | \"transparent\" | \"plain\" | undefined; }) => JSX.Element" ], - "path": "src/plugins/visualization_ui_components/public/components/drag_drop_bucket/buckets.tsx", + "path": "packages/kbn-visualization-ui-components/components/drag_drop_bucket/buckets.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.DragDropBuckets.$1", "type": "Object", "tags": [], "label": "{\n items,\n onDragStart,\n onDragEnd,\n droppableId,\n children,\n bgColor,\n}", "description": [], - "path": "src/plugins/visualization_ui_components/public/components/drag_drop_bucket/buckets.tsx", + "path": "packages/kbn-visualization-ui-components/components/drag_drop_bucket/buckets.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.DragDropBuckets.$1.items", "type": "Array", "tags": [], @@ -417,23 +417,23 @@ "signature": [ "T[]" ], - "path": "src/plugins/visualization_ui_components/public/components/drag_drop_bucket/buckets.tsx", + "path": "packages/kbn-visualization-ui-components/components/drag_drop_bucket/buckets.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.DragDropBuckets.$1.droppableId", "type": "string", "tags": [], "label": "droppableId", "description": [], - "path": "src/plugins/visualization_ui_components/public/components/drag_drop_bucket/buckets.tsx", + "path": "packages/kbn-visualization-ui-components/components/drag_drop_bucket/buckets.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.DragDropBuckets.$1.children", "type": "Array", "tags": [], @@ -442,12 +442,12 @@ "signature": [ "React.ReactElement>[]" ], - "path": "src/plugins/visualization_ui_components/public/components/drag_drop_bucket/buckets.tsx", + "path": "packages/kbn-visualization-ui-components/components/drag_drop_bucket/buckets.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.DragDropBuckets.$1.onDragStart", "type": "Function", "tags": [], @@ -456,14 +456,14 @@ "signature": [ "(() => void) | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/drag_drop_bucket/buckets.tsx", + "path": "packages/kbn-visualization-ui-components/components/drag_drop_bucket/buckets.tsx", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.DragDropBuckets.$1.onDragEnd", "type": "Function", "tags": [], @@ -472,12 +472,12 @@ "signature": [ "((items: T[]) => void) | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/drag_drop_bucket/buckets.tsx", + "path": "packages/kbn-visualization-ui-components/components/drag_drop_bucket/buckets.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.DragDropBuckets.$1.onDragEnd.$1", "type": "Array", "tags": [], @@ -486,7 +486,7 @@ "signature": [ "T[]" ], - "path": "src/plugins/visualization_ui_components/public/components/drag_drop_bucket/buckets.tsx", + "path": "packages/kbn-visualization-ui-components/components/drag_drop_bucket/buckets.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -495,7 +495,7 @@ "returnComment": [] }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.DragDropBuckets.$1.bgColor", "type": "CompoundType", "tags": [], @@ -504,7 +504,7 @@ "signature": [ "\"warning\" | \"success\" | \"subdued\" | \"primary\" | \"accent\" | \"danger\" | \"transparent\" | \"plain\" | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/drag_drop_bucket/buckets.tsx", + "path": "packages/kbn-visualization-ui-components/components/drag_drop_bucket/buckets.tsx", "deprecated": false, "trackAdoption": false } @@ -515,7 +515,7 @@ "initialIsOpen": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.DraggableBucketContainer", "type": "Function", "tags": [], @@ -548,12 +548,12 @@ "BucketContainerProps", ", \"draggableProvided\">>>) => JSX.Element" ], - "path": "src/plugins/visualization_ui_components/public/components/drag_drop_bucket/buckets.tsx", + "path": "packages/kbn-visualization-ui-components/components/drag_drop_bucket/buckets.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.DraggableBucketContainer.$1", "type": "Object", "tags": [], @@ -585,7 +585,7 @@ "BucketContainerProps", ", \"draggableProvided\">>>" ], - "path": "src/plugins/visualization_ui_components/public/components/drag_drop_bucket/buckets.tsx", + "path": "packages/kbn-visualization-ui-components/components/drag_drop_bucket/buckets.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -595,7 +595,7 @@ "initialIsOpen": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.EmptyDimensionButton", "type": "Function", "tags": [], @@ -604,23 +604,23 @@ "signature": [ "({ label, ariaLabel, onClick, dataTestSubj, iconType, ...otherProps }: { label: React.ReactNode; ariaLabel: string; onClick: () => void; dataTestSubj?: string | undefined; iconType?: string | undefined; }) => JSX.Element" ], - "path": "src/plugins/visualization_ui_components/public/components/dimension_buttons/empty_button.tsx", + "path": "packages/kbn-visualization-ui-components/components/dimension_buttons/empty_button.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.EmptyDimensionButton.$1", "type": "Object", "tags": [], "label": "{\n label,\n ariaLabel,\n onClick,\n dataTestSubj,\n iconType,\n ...otherProps // from Drag&Drop integration\n}", "description": [], - "path": "src/plugins/visualization_ui_components/public/components/dimension_buttons/empty_button.tsx", + "path": "packages/kbn-visualization-ui-components/components/dimension_buttons/empty_button.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.EmptyDimensionButton.$1.label", "type": "CompoundType", "tags": [], @@ -629,23 +629,23 @@ "signature": [ "boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | null | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/dimension_buttons/empty_button.tsx", + "path": "packages/kbn-visualization-ui-components/components/dimension_buttons/empty_button.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.EmptyDimensionButton.$1.ariaLabel", "type": "string", "tags": [], "label": "ariaLabel", "description": [], - "path": "src/plugins/visualization_ui_components/public/components/dimension_buttons/empty_button.tsx", + "path": "packages/kbn-visualization-ui-components/components/dimension_buttons/empty_button.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.EmptyDimensionButton.$1.onClick", "type": "Function", "tags": [], @@ -654,14 +654,14 @@ "signature": [ "() => void" ], - "path": "src/plugins/visualization_ui_components/public/components/dimension_buttons/empty_button.tsx", + "path": "packages/kbn-visualization-ui-components/components/dimension_buttons/empty_button.tsx", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.EmptyDimensionButton.$1.dataTestSubj", "type": "string", "tags": [], @@ -670,12 +670,12 @@ "signature": [ "string | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/dimension_buttons/empty_button.tsx", + "path": "packages/kbn-visualization-ui-components/components/dimension_buttons/empty_button.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.EmptyDimensionButton.$1.iconType", "type": "string", "tags": [], @@ -684,7 +684,7 @@ "signature": [ "string | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/dimension_buttons/empty_button.tsx", + "path": "packages/kbn-visualization-ui-components/components/dimension_buttons/empty_button.tsx", "deprecated": false, "trackAdoption": false } @@ -695,7 +695,7 @@ "initialIsOpen": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.FieldPicker", "type": "Function", "tags": [], @@ -706,12 +706,12 @@ "FieldPickerProps", ") => JSX.Element" ], - "path": "src/plugins/visualization_ui_components/public/components/field_picker/field_picker.tsx", + "path": "packages/kbn-visualization-ui-components/components/field_picker/field_picker.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.FieldPicker.$1", "type": "Object", "tags": [], @@ -721,7 +721,7 @@ "FieldPickerProps", "" ], - "path": "src/plugins/visualization_ui_components/public/components/field_picker/field_picker.tsx", + "path": "packages/kbn-visualization-ui-components/components/field_picker/field_picker.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -731,7 +731,7 @@ "initialIsOpen": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.FieldsBucketContainer", "type": "Function", "tags": [], @@ -742,12 +742,12 @@ "BucketContainerProps", ") => JSX.Element" ], - "path": "src/plugins/visualization_ui_components/public/components/drag_drop_bucket/fields_bucket_container.tsx", + "path": "packages/kbn-visualization-ui-components/components/drag_drop_bucket/fields_bucket_container.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.FieldsBucketContainer.$1", "type": "Object", "tags": [], @@ -756,7 +756,7 @@ "signature": [ "BucketContainerProps" ], - "path": "src/plugins/visualization_ui_components/public/components/drag_drop_bucket/fields_bucket_container.tsx", + "path": "packages/kbn-visualization-ui-components/components/drag_drop_bucket/fields_bucket_container.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -766,7 +766,7 @@ "initialIsOpen": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.FilterQueryInput", "type": "Function", "tags": [], @@ -799,31 +799,31 @@ }, "; helpMessage?: string | null | undefined; label?: string | undefined; initiallyOpen?: boolean | undefined; \"data-test-subj\"?: string | undefined; queryInputServices: ", { - "pluginId": "visualizationUiComponents", + "pluginId": "@kbn/visualization-ui-components", "scope": "public", - "docId": "kibVisualizationUiComponentsPluginApi", + "docId": "kibKbnVisualizationUiComponentsPluginApi", "section": "def-public.QueryInputServices", "text": "QueryInputServices" }, "; appName: string; }) => JSX.Element" ], - "path": "src/plugins/visualization_ui_components/public/components/query_input/filter_query_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/query_input/filter_query_input.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.FilterQueryInput.$1", "type": "Object", "tags": [], "label": "{\n inputFilter,\n onChange,\n dataView,\n helpMessage,\n label = filterByLabel,\n initiallyOpen,\n ['data-test-subj']: dataTestSubj,\n queryInputServices,\n appName,\n}", "description": [], - "path": "src/plugins/visualization_ui_components/public/components/query_input/filter_query_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/query_input/filter_query_input.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.FilterQueryInput.$1.inputFilter", "type": "Object", "tags": [], @@ -839,12 +839,12 @@ }, " | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/query_input/filter_query_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/query_input/filter_query_input.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.FilterQueryInput.$1.onChange", "type": "Function", "tags": [], @@ -861,12 +861,12 @@ }, ") => void" ], - "path": "src/plugins/visualization_ui_components/public/components/query_input/filter_query_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/query_input/filter_query_input.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.FilterQueryInput.$1.onChange.$1", "type": "Object", "tags": [], @@ -881,7 +881,7 @@ "text": "Query" } ], - "path": "src/plugins/visualization_ui_components/public/components/query_input/filter_query_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/query_input/filter_query_input.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -890,7 +890,7 @@ "returnComment": [] }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.FilterQueryInput.$1.dataView", "type": "Object", "tags": [], @@ -907,12 +907,12 @@ }, "[]; id?: string | undefined; title: string; }" ], - "path": "src/plugins/visualization_ui_components/public/components/query_input/filter_query_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/query_input/filter_query_input.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.FilterQueryInput.$1.helpMessage", "type": "CompoundType", "tags": [], @@ -921,12 +921,12 @@ "signature": [ "string | null | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/query_input/filter_query_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/query_input/filter_query_input.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.FilterQueryInput.$1.label", "type": "string", "tags": [], @@ -935,12 +935,12 @@ "signature": [ "string | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/query_input/filter_query_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/query_input/filter_query_input.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.FilterQueryInput.$1.initiallyOpen", "type": "CompoundType", "tags": [], @@ -949,12 +949,12 @@ "signature": [ "boolean | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/query_input/filter_query_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/query_input/filter_query_input.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.FilterQueryInput.$1.datatestsubj", "type": "string", "tags": [], @@ -963,12 +963,12 @@ "signature": [ "string | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/query_input/filter_query_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/query_input/filter_query_input.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.FilterQueryInput.$1.queryInputServices", "type": "Object", "tags": [], @@ -976,25 +976,25 @@ "description": [], "signature": [ { - "pluginId": "visualizationUiComponents", + "pluginId": "@kbn/visualization-ui-components", "scope": "public", - "docId": "kibVisualizationUiComponentsPluginApi", + "docId": "kibKbnVisualizationUiComponentsPluginApi", "section": "def-public.QueryInputServices", "text": "QueryInputServices" } ], - "path": "src/plugins/visualization_ui_components/public/components/query_input/filter_query_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/query_input/filter_query_input.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.FilterQueryInput.$1.appName", "type": "string", "tags": [], "label": "appName", "description": [], - "path": "src/plugins/visualization_ui_components/public/components/query_input/filter_query_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/query_input/filter_query_input.tsx", "deprecated": false, "trackAdoption": false } @@ -1005,7 +1005,7 @@ "initialIsOpen": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.IconSelect", "type": "Function", "tags": [], @@ -1014,31 +1014,31 @@ "signature": [ "({\n value,\n onChange,\n customIconSet,\n defaultIcon = 'empty',\n}: { value?: Icon | undefined; onChange: (newIcon: Icon) => void; customIconSet: ", { - "pluginId": "visualizationUiComponents", + "pluginId": "@kbn/visualization-ui-components", "scope": "public", - "docId": "kibVisualizationUiComponentsPluginApi", + "docId": "kibKbnVisualizationUiComponentsPluginApi", "section": "def-public.IconSet", "text": "IconSet" }, "; defaultIcon?: string | undefined; }) => JSX.Element" ], - "path": "src/plugins/visualization_ui_components/public/components/icon_select.tsx", + "path": "packages/kbn-visualization-ui-components/components/icon_select.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.IconSelect.$1", "type": "Object", "tags": [], "label": "{\n value,\n onChange,\n customIconSet,\n defaultIcon = 'empty',\n}", "description": [], - "path": "src/plugins/visualization_ui_components/public/components/icon_select.tsx", + "path": "packages/kbn-visualization-ui-components/components/icon_select.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.IconSelect.$1.value", "type": "Uncategorized", "tags": [], @@ -1047,12 +1047,12 @@ "signature": [ "Icon | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/icon_select.tsx", + "path": "packages/kbn-visualization-ui-components/components/icon_select.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.IconSelect.$1.onChange", "type": "Function", "tags": [], @@ -1061,12 +1061,12 @@ "signature": [ "(newIcon: Icon) => void" ], - "path": "src/plugins/visualization_ui_components/public/components/icon_select.tsx", + "path": "packages/kbn-visualization-ui-components/components/icon_select.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.IconSelect.$1.onChange.$1", "type": "Uncategorized", "tags": [], @@ -1075,7 +1075,7 @@ "signature": [ "Icon" ], - "path": "src/plugins/visualization_ui_components/public/components/icon_select.tsx", + "path": "packages/kbn-visualization-ui-components/components/icon_select.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -1084,7 +1084,7 @@ "returnComment": [] }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.IconSelect.$1.customIconSet", "type": "Array", "tags": [], @@ -1095,12 +1095,12 @@ "IconType", " | Icon | undefined; shouldRotate?: boolean | undefined; }[]" ], - "path": "src/plugins/visualization_ui_components/public/components/icon_select.tsx", + "path": "packages/kbn-visualization-ui-components/components/icon_select.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.IconSelect.$1.defaultIcon", "type": "string", "tags": [], @@ -1109,7 +1109,7 @@ "signature": [ "string | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/icon_select.tsx", + "path": "packages/kbn-visualization-ui-components/components/icon_select.tsx", "deprecated": false, "trackAdoption": false } @@ -1120,7 +1120,7 @@ "initialIsOpen": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.IconSelectSetting", "type": "Function", "tags": [], @@ -1129,31 +1129,31 @@ "signature": [ "({\n currentIcon,\n setIcon,\n customIconSet,\n defaultIcon = 'empty',\n}: { currentIcon?: Icon | undefined; setIcon: (icon: Icon) => void; customIconSet: ", { - "pluginId": "visualizationUiComponents", + "pluginId": "@kbn/visualization-ui-components", "scope": "public", - "docId": "kibVisualizationUiComponentsPluginApi", + "docId": "kibKbnVisualizationUiComponentsPluginApi", "section": "def-public.IconSet", "text": "IconSet" }, "; defaultIcon?: string | undefined; }) => JSX.Element" ], - "path": "src/plugins/visualization_ui_components/public/components/icon_select.tsx", + "path": "packages/kbn-visualization-ui-components/components/icon_select.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.IconSelectSetting.$1", "type": "Object", "tags": [], "label": "{\n currentIcon,\n setIcon,\n customIconSet,\n defaultIcon = 'empty',\n}", "description": [], - "path": "src/plugins/visualization_ui_components/public/components/icon_select.tsx", + "path": "packages/kbn-visualization-ui-components/components/icon_select.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.IconSelectSetting.$1.currentIcon", "type": "Uncategorized", "tags": [], @@ -1162,12 +1162,12 @@ "signature": [ "Icon | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/icon_select.tsx", + "path": "packages/kbn-visualization-ui-components/components/icon_select.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.IconSelectSetting.$1.setIcon", "type": "Function", "tags": [], @@ -1176,12 +1176,12 @@ "signature": [ "(icon: Icon) => void" ], - "path": "src/plugins/visualization_ui_components/public/components/icon_select.tsx", + "path": "packages/kbn-visualization-ui-components/components/icon_select.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.IconSelectSetting.$1.setIcon.$1", "type": "Uncategorized", "tags": [], @@ -1190,7 +1190,7 @@ "signature": [ "Icon" ], - "path": "src/plugins/visualization_ui_components/public/components/icon_select.tsx", + "path": "packages/kbn-visualization-ui-components/components/icon_select.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -1199,7 +1199,7 @@ "returnComment": [] }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.IconSelectSetting.$1.customIconSet", "type": "Array", "tags": [], @@ -1210,12 +1210,12 @@ "IconType", " | Icon | undefined; shouldRotate?: boolean | undefined; }[]" ], - "path": "src/plugins/visualization_ui_components/public/components/icon_select.tsx", + "path": "packages/kbn-visualization-ui-components/components/icon_select.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.IconSelectSetting.$1.defaultIcon", "type": "string", "tags": [], @@ -1224,7 +1224,7 @@ "signature": [ "string | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/icon_select.tsx", + "path": "packages/kbn-visualization-ui-components/components/icon_select.tsx", "deprecated": false, "trackAdoption": false } @@ -1235,7 +1235,7 @@ "initialIsOpen": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.isFieldLensCompatible", "type": "Function", "tags": [], @@ -1252,12 +1252,12 @@ }, ") => boolean" ], - "path": "src/plugins/visualization_ui_components/public/util.ts", + "path": "packages/kbn-visualization-ui-components/util.ts", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.isFieldLensCompatible.$1", "type": "Object", "tags": [], @@ -1272,7 +1272,7 @@ "text": "DataViewField" } ], - "path": "src/plugins/visualization_ui_components/public/util.ts", + "path": "packages/kbn-visualization-ui-components/util.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -1282,7 +1282,7 @@ "initialIsOpen": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.isQueryValid", "type": "Function", "tags": [], @@ -1307,12 +1307,12 @@ }, ") => boolean" ], - "path": "src/plugins/visualization_ui_components/public/components/query_input/helpers.ts", + "path": "packages/kbn-visualization-ui-components/components/query_input/helpers.ts", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.isQueryValid.$1", "type": "Object", "tags": [], @@ -1327,13 +1327,13 @@ "text": "Query" } ], - "path": "src/plugins/visualization_ui_components/public/components/query_input/helpers.ts", + "path": "packages/kbn-visualization-ui-components/components/query_input/helpers.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.isQueryValid.$2", "type": "Object", "tags": [], @@ -1348,7 +1348,7 @@ "text": "DataViewBase" } ], - "path": "src/plugins/visualization_ui_components/public/components/query_input/helpers.ts", + "path": "packages/kbn-visualization-ui-components/components/query_input/helpers.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -1358,7 +1358,7 @@ "initialIsOpen": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.LineStyleSettings", "type": "Function", "tags": [], @@ -1367,23 +1367,23 @@ "signature": [ "({ currentConfig, setConfig, idPrefix, }: { currentConfig?: LineStyleConfig | undefined; setConfig: (config: LineStyleConfig) => void; idPrefix: string; }) => JSX.Element" ], - "path": "src/plugins/visualization_ui_components/public/components/line_style_settings.tsx", + "path": "packages/kbn-visualization-ui-components/components/line_style_settings.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.LineStyleSettings.$1", "type": "Object", "tags": [], "label": "{\n currentConfig,\n setConfig,\n idPrefix,\n}", "description": [], - "path": "src/plugins/visualization_ui_components/public/components/line_style_settings.tsx", + "path": "packages/kbn-visualization-ui-components/components/line_style_settings.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.LineStyleSettings.$1.currentConfig", "type": "Object", "tags": [], @@ -1392,12 +1392,12 @@ "signature": [ "LineStyleConfig | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/line_style_settings.tsx", + "path": "packages/kbn-visualization-ui-components/components/line_style_settings.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.LineStyleSettings.$1.setConfig", "type": "Function", "tags": [], @@ -1406,12 +1406,12 @@ "signature": [ "(config: LineStyleConfig) => void" ], - "path": "src/plugins/visualization_ui_components/public/components/line_style_settings.tsx", + "path": "packages/kbn-visualization-ui-components/components/line_style_settings.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.LineStyleSettings.$1.setConfig.$1", "type": "Object", "tags": [], @@ -1420,7 +1420,7 @@ "signature": [ "LineStyleConfig" ], - "path": "src/plugins/visualization_ui_components/public/components/line_style_settings.tsx", + "path": "packages/kbn-visualization-ui-components/components/line_style_settings.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -1429,13 +1429,13 @@ "returnComment": [] }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.LineStyleSettings.$1.idPrefix", "type": "string", "tags": [], "label": "idPrefix", "description": [], - "path": "src/plugins/visualization_ui_components/public/components/line_style_settings.tsx", + "path": "packages/kbn-visualization-ui-components/components/line_style_settings.tsx", "deprecated": false, "trackAdoption": false } @@ -1446,7 +1446,7 @@ "initialIsOpen": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.NameInput", "type": "Function", "tags": [], @@ -1455,34 +1455,34 @@ "signature": [ "({ value, onChange, defaultValue, }: { value: string; onChange: (value: string) => void; defaultValue?: string | undefined; }) => JSX.Element" ], - "path": "src/plugins/visualization_ui_components/public/components/name_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/name_input.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.NameInput.$1", "type": "Object", "tags": [], "label": "{\n value,\n onChange,\n defaultValue,\n}", "description": [], - "path": "src/plugins/visualization_ui_components/public/components/name_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/name_input.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.NameInput.$1.value", "type": "string", "tags": [], "label": "value", "description": [], - "path": "src/plugins/visualization_ui_components/public/components/name_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/name_input.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.NameInput.$1.onChange", "type": "Function", "tags": [], @@ -1491,12 +1491,12 @@ "signature": [ "(value: string) => void" ], - "path": "src/plugins/visualization_ui_components/public/components/name_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/name_input.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.NameInput.$1.onChange.$1", "type": "string", "tags": [], @@ -1505,7 +1505,7 @@ "signature": [ "string" ], - "path": "src/plugins/visualization_ui_components/public/components/name_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/name_input.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -1514,7 +1514,7 @@ "returnComment": [] }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.NameInput.$1.defaultValue", "type": "string", "tags": [], @@ -1523,7 +1523,7 @@ "signature": [ "string | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/name_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/name_input.tsx", "deprecated": false, "trackAdoption": false } @@ -1534,7 +1534,7 @@ "initialIsOpen": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.NewBucketButton", "type": "Function", "tags": [], @@ -1543,12 +1543,12 @@ "signature": [ "({ label, onClick, isDisabled, className, \"data-test-subj\": dataTestSubj, }: NewBucketButtonProps) => JSX.Element" ], - "path": "src/plugins/visualization_ui_components/public/components/drag_drop_bucket/new_bucket_button.tsx", + "path": "packages/kbn-visualization-ui-components/components/drag_drop_bucket/new_bucket_button.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.NewBucketButton.$1", "type": "Object", "tags": [], @@ -1557,7 +1557,7 @@ "signature": [ "NewBucketButtonProps" ], - "path": "src/plugins/visualization_ui_components/public/components/drag_drop_bucket/new_bucket_button.tsx", + "path": "packages/kbn-visualization-ui-components/components/drag_drop_bucket/new_bucket_button.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -1567,7 +1567,7 @@ "initialIsOpen": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.QueryInput", "type": "Function", "tags": [], @@ -1592,31 +1592,31 @@ }, ") => void; dataView: string | { type: \"id\" | \"title\"; value: string; }; isInvalid: boolean; onSubmit: () => void; disableAutoFocus?: boolean | undefined; 'data-test-subj'?: string | undefined; placeholder?: string | undefined; appName: string; services: ", { - "pluginId": "visualizationUiComponents", + "pluginId": "@kbn/visualization-ui-components", "scope": "public", - "docId": "kibVisualizationUiComponentsPluginApi", + "docId": "kibKbnVisualizationUiComponentsPluginApi", "section": "def-public.QueryInputServices", "text": "QueryInputServices" }, "; }) => JSX.Element" ], - "path": "src/plugins/visualization_ui_components/public/components/query_input/query_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/query_input/query_input.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.QueryInput.$1", "type": "Object", "tags": [], "label": "{\n value,\n onChange,\n dataView,\n isInvalid,\n onSubmit,\n disableAutoFocus,\n ['data-test-subj']: dataTestSubj,\n placeholder,\n appName,\n services: { data, uiSettings, http, notifications, docLinks, storage, unifiedSearch, dataViews },\n}", "description": [], - "path": "src/plugins/visualization_ui_components/public/components/query_input/query_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/query_input/query_input.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.QueryInput.$1.value", "type": "Object", "tags": [], @@ -1625,12 +1625,12 @@ "signature": [ "{ query: string | { [key: string]: any; }; language: string; }" ], - "path": "src/plugins/visualization_ui_components/public/components/query_input/query_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/query_input/query_input.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.QueryInput.$1.onChange", "type": "Function", "tags": [], @@ -1647,12 +1647,12 @@ }, ") => void" ], - "path": "src/plugins/visualization_ui_components/public/components/query_input/query_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/query_input/query_input.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.QueryInput.$1.onChange.$1", "type": "Object", "tags": [], @@ -1667,7 +1667,7 @@ "text": "Query" } ], - "path": "src/plugins/visualization_ui_components/public/components/query_input/query_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/query_input/query_input.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -1676,7 +1676,7 @@ "returnComment": [] }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.QueryInput.$1.dataView", "type": "CompoundType", "tags": [], @@ -1685,23 +1685,23 @@ "signature": [ "string | { type: \"id\" | \"title\"; value: string; }" ], - "path": "src/plugins/visualization_ui_components/public/components/query_input/query_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/query_input/query_input.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.QueryInput.$1.isInvalid", "type": "boolean", "tags": [], "label": "isInvalid", "description": [], - "path": "src/plugins/visualization_ui_components/public/components/query_input/query_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/query_input/query_input.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.QueryInput.$1.onSubmit", "type": "Function", "tags": [], @@ -1710,14 +1710,14 @@ "signature": [ "() => void" ], - "path": "src/plugins/visualization_ui_components/public/components/query_input/query_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/query_input/query_input.tsx", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.QueryInput.$1.disableAutoFocus", "type": "CompoundType", "tags": [], @@ -1726,12 +1726,12 @@ "signature": [ "boolean | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/query_input/query_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/query_input/query_input.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.QueryInput.$1.datatestsubj", "type": "string", "tags": [], @@ -1740,12 +1740,12 @@ "signature": [ "string | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/query_input/query_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/query_input/query_input.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.QueryInput.$1.placeholder", "type": "string", "tags": [], @@ -1754,23 +1754,23 @@ "signature": [ "string | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/query_input/query_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/query_input/query_input.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.QueryInput.$1.appName", "type": "string", "tags": [], "label": "appName", "description": [], - "path": "src/plugins/visualization_ui_components/public/components/query_input/query_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/query_input/query_input.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.QueryInput.$1.services", "type": "Object", "tags": [], @@ -1778,14 +1778,14 @@ "description": [], "signature": [ { - "pluginId": "visualizationUiComponents", + "pluginId": "@kbn/visualization-ui-components", "scope": "public", - "docId": "kibVisualizationUiComponentsPluginApi", + "docId": "kibKbnVisualizationUiComponentsPluginApi", "section": "def-public.QueryInputServices", "text": "QueryInputServices" } ], - "path": "src/plugins/visualization_ui_components/public/components/query_input/query_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/query_input/query_input.tsx", "deprecated": false, "trackAdoption": false } @@ -1796,7 +1796,7 @@ "initialIsOpen": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.TextDecorationSetting", "type": "Function", "tags": [], @@ -1805,34 +1805,34 @@ "signature": [ "({\n idPrefix,\n currentConfig,\n setConfig,\n isQueryBased,\n children,\n}: { idPrefix: string; currentConfig?: TextDecorationConfig | undefined; setConfig: (config: TextDecorationConfig) => void; isQueryBased?: boolean | undefined; children?: ((textDecoration: \"none\" | \"name\" | \"field\") => JSX.Element | null) | undefined; }) => JSX.Element" ], - "path": "src/plugins/visualization_ui_components/public/components/text_decoration_setting.tsx", + "path": "packages/kbn-visualization-ui-components/components/text_decoration_setting.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.TextDecorationSetting.$1", "type": "Object", "tags": [], "label": "{\n idPrefix,\n currentConfig,\n setConfig,\n isQueryBased,\n children,\n}", "description": [], - "path": "src/plugins/visualization_ui_components/public/components/text_decoration_setting.tsx", + "path": "packages/kbn-visualization-ui-components/components/text_decoration_setting.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.TextDecorationSetting.$1.idPrefix", "type": "string", "tags": [], "label": "idPrefix", "description": [], - "path": "src/plugins/visualization_ui_components/public/components/text_decoration_setting.tsx", + "path": "packages/kbn-visualization-ui-components/components/text_decoration_setting.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.TextDecorationSetting.$1.currentConfig", "type": "Object", "tags": [], @@ -1841,12 +1841,12 @@ "signature": [ "TextDecorationConfig | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/text_decoration_setting.tsx", + "path": "packages/kbn-visualization-ui-components/components/text_decoration_setting.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.TextDecorationSetting.$1.setConfig", "type": "Function", "tags": [], @@ -1855,12 +1855,12 @@ "signature": [ "(config: TextDecorationConfig) => void" ], - "path": "src/plugins/visualization_ui_components/public/components/text_decoration_setting.tsx", + "path": "packages/kbn-visualization-ui-components/components/text_decoration_setting.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.TextDecorationSetting.$1.setConfig.$1", "type": "Object", "tags": [], @@ -1869,7 +1869,7 @@ "signature": [ "TextDecorationConfig" ], - "path": "src/plugins/visualization_ui_components/public/components/text_decoration_setting.tsx", + "path": "packages/kbn-visualization-ui-components/components/text_decoration_setting.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -1878,7 +1878,7 @@ "returnComment": [] }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.TextDecorationSetting.$1.isQueryBased", "type": "CompoundType", "tags": [], @@ -1887,12 +1887,12 @@ "signature": [ "boolean | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/text_decoration_setting.tsx", + "path": "packages/kbn-visualization-ui-components/components/text_decoration_setting.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.TextDecorationSetting.$1.children", "type": "Function", "tags": [], @@ -1903,12 +1903,12 @@ "signature": [ "((textDecoration: \"none\" | \"name\" | \"field\") => JSX.Element | null) | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/text_decoration_setting.tsx", + "path": "packages/kbn-visualization-ui-components/components/text_decoration_setting.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.TextDecorationSetting.$1.children.$1", "type": "CompoundType", "tags": [], @@ -1917,7 +1917,7 @@ "signature": [ "\"none\" | \"name\" | \"field\"" ], - "path": "src/plugins/visualization_ui_components/public/components/text_decoration_setting.tsx", + "path": "packages/kbn-visualization-ui-components/components/text_decoration_setting.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -1932,7 +1932,7 @@ "initialIsOpen": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.TooltipWrapper", "type": "Function", "tags": [], @@ -1941,12 +1941,12 @@ "signature": [ "({ children, condition, tooltipContent, ...tooltipProps }: React.PropsWithChildren) => JSX.Element" ], - "path": "src/plugins/visualization_ui_components/public/components/tooltip_wrapper.tsx", + "path": "packages/kbn-visualization-ui-components/components/tooltip_wrapper.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.TooltipWrapper.$1", "type": "CompoundType", "tags": [], @@ -1955,7 +1955,7 @@ "signature": [ "React.PropsWithChildren" ], - "path": "src/plugins/visualization_ui_components/public/components/tooltip_wrapper.tsx", + "path": "packages/kbn-visualization-ui-components/components/tooltip_wrapper.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -1965,7 +1965,7 @@ "initialIsOpen": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.TruncatedLabel", "type": "Function", "tags": [], @@ -1974,13 +1974,13 @@ "signature": [ "React.NamedExoticComponent<{ label: string; search: string; width: number; font: string; }>" ], - "path": "src/plugins/visualization_ui_components/public/components/field_picker/truncated_label.tsx", + "path": "packages/kbn-visualization-ui-components/components/field_picker/truncated_label.tsx", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.TruncatedLabel.$1", "type": "Uncategorized", "tags": [], @@ -1997,7 +1997,7 @@ "initialIsOpen": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.useDebouncedValue", "type": "Function", "tags": [], @@ -2008,23 +2008,23 @@ "signature": [ "({ onChange, value, defaultValue, }: { onChange: (val: T) => void; value: T; defaultValue?: T | undefined; }, { allowFalsyValue }?: { allowFalsyValue?: boolean | undefined; }) => { inputValue: T; handleInputChange: (val: T) => void; initialValue: T; }" ], - "path": "src/plugins/visualization_ui_components/public/components/debounced_value.ts", + "path": "packages/kbn-visualization-ui-components/components/debounced_value.ts", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.useDebouncedValue.$1", "type": "Object", "tags": [], "label": "{\n onChange,\n value,\n defaultValue,\n }", "description": [], - "path": "src/plugins/visualization_ui_components/public/components/debounced_value.ts", + "path": "packages/kbn-visualization-ui-components/components/debounced_value.ts", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.useDebouncedValue.$1.onChange", "type": "Function", "tags": [], @@ -2033,12 +2033,12 @@ "signature": [ "(val: T) => void" ], - "path": "src/plugins/visualization_ui_components/public/components/debounced_value.ts", + "path": "packages/kbn-visualization-ui-components/components/debounced_value.ts", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.useDebouncedValue.$1.onChange.$1", "type": "Uncategorized", "tags": [], @@ -2047,7 +2047,7 @@ "signature": [ "T" ], - "path": "src/plugins/visualization_ui_components/public/components/debounced_value.ts", + "path": "packages/kbn-visualization-ui-components/components/debounced_value.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -2056,7 +2056,7 @@ "returnComment": [] }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.useDebouncedValue.$1.value", "type": "Uncategorized", "tags": [], @@ -2065,12 +2065,12 @@ "signature": [ "T" ], - "path": "src/plugins/visualization_ui_components/public/components/debounced_value.ts", + "path": "packages/kbn-visualization-ui-components/components/debounced_value.ts", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.useDebouncedValue.$1.defaultValue", "type": "Uncategorized", "tags": [], @@ -2079,25 +2079,25 @@ "signature": [ "T | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/debounced_value.ts", + "path": "packages/kbn-visualization-ui-components/components/debounced_value.ts", "deprecated": false, "trackAdoption": false } ] }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.useDebouncedValue.$2", "type": "Object", "tags": [], "label": "{ allowFalsyValue }", "description": [], - "path": "src/plugins/visualization_ui_components/public/components/debounced_value.ts", + "path": "packages/kbn-visualization-ui-components/components/debounced_value.ts", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.useDebouncedValue.$2.allowFalsyValue", "type": "CompoundType", "tags": [], @@ -2106,7 +2106,7 @@ "signature": [ "boolean | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/debounced_value.ts", + "path": "packages/kbn-visualization-ui-components/components/debounced_value.ts", "deprecated": false, "trackAdoption": false } @@ -2117,7 +2117,7 @@ "initialIsOpen": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.validateQuery", "type": "Function", "tags": [], @@ -2142,12 +2142,12 @@ }, ") => { isValid: boolean; error: string | undefined; }" ], - "path": "src/plugins/visualization_ui_components/public/components/query_input/helpers.ts", + "path": "packages/kbn-visualization-ui-components/components/query_input/helpers.ts", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.validateQuery.$1", "type": "Object", "tags": [], @@ -2163,13 +2163,13 @@ }, " | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/query_input/helpers.ts", + "path": "packages/kbn-visualization-ui-components/components/query_input/helpers.ts", "deprecated": false, "trackAdoption": false, "isRequired": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.validateQuery.$2", "type": "Object", "tags": [], @@ -2184,7 +2184,7 @@ "text": "DataViewBase" } ], - "path": "src/plugins/visualization_ui_components/public/components/query_input/helpers.ts", + "path": "packages/kbn-visualization-ui-components/components/query_input/helpers.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -2196,29 +2196,29 @@ ], "interfaces": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.AccessorConfig", "type": "Interface", "tags": [], "label": "AccessorConfig", "description": [], - "path": "src/plugins/visualization_ui_components/public/components/dimension_buttons/types.ts", + "path": "packages/kbn-visualization-ui-components/components/dimension_buttons/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.AccessorConfig.columnId", "type": "string", "tags": [], "label": "columnId", "description": [], - "path": "src/plugins/visualization_ui_components/public/components/dimension_buttons/types.ts", + "path": "packages/kbn-visualization-ui-components/components/dimension_buttons/types.ts", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.AccessorConfig.triggerIconType", "type": "CompoundType", "tags": [], @@ -2227,12 +2227,12 @@ "signature": [ "\"none\" | \"color\" | \"aggregate\" | \"disabled\" | \"custom\" | \"colorBy\" | \"invisible\" | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/dimension_buttons/types.ts", + "path": "packages/kbn-visualization-ui-components/components/dimension_buttons/types.ts", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.AccessorConfig.customIcon", "type": "CompoundType", "tags": [], @@ -2242,12 +2242,12 @@ "IconType", " | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/dimension_buttons/types.ts", + "path": "packages/kbn-visualization-ui-components/components/dimension_buttons/types.ts", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.AccessorConfig.color", "type": "string", "tags": [], @@ -2256,12 +2256,12 @@ "signature": [ "string | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/dimension_buttons/types.ts", + "path": "packages/kbn-visualization-ui-components/components/dimension_buttons/types.ts", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.AccessorConfig.palette", "type": "CompoundType", "tags": [], @@ -2270,7 +2270,7 @@ "signature": [ "string[] | { color: string; stop: number; }[] | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/dimension_buttons/types.ts", + "path": "packages/kbn-visualization-ui-components/components/dimension_buttons/types.ts", "deprecated": false, "trackAdoption": false } @@ -2278,18 +2278,18 @@ "initialIsOpen": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.FieldOptionValue", "type": "Interface", "tags": [], "label": "FieldOptionValue", "description": [], - "path": "src/plugins/visualization_ui_components/public/components/field_picker/types.ts", + "path": "packages/kbn-visualization-ui-components/components/field_picker/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.FieldOptionValue.type", "type": "string", "tags": [], @@ -2298,23 +2298,23 @@ "signature": [ "\"field\"" ], - "path": "src/plugins/visualization_ui_components/public/components/field_picker/types.ts", + "path": "packages/kbn-visualization-ui-components/components/field_picker/types.ts", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.FieldOptionValue.field", "type": "string", "tags": [], "label": "field", "description": [], - "path": "src/plugins/visualization_ui_components/public/components/field_picker/types.ts", + "path": "packages/kbn-visualization-ui-components/components/field_picker/types.ts", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.FieldOptionValue.dataType", "type": "CompoundType", "tags": [], @@ -2322,15 +2322,15 @@ "description": [], "signature": [ { - "pluginId": "visualizationUiComponents", + "pluginId": "@kbn/visualization-ui-components", "scope": "public", - "docId": "kibVisualizationUiComponentsPluginApi", + "docId": "kibKbnVisualizationUiComponentsPluginApi", "section": "def-public.DataType", "text": "DataType" }, " | undefined" ], - "path": "src/plugins/visualization_ui_components/public/components/field_picker/types.ts", + "path": "packages/kbn-visualization-ui-components/components/field_picker/types.ts", "deprecated": false, "trackAdoption": false } @@ -2338,18 +2338,18 @@ "initialIsOpen": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.QueryInputServices", "type": "Interface", "tags": [], "label": "QueryInputServices", "description": [], - "path": "src/plugins/visualization_ui_components/public/components/query_input/query_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/query_input/query_input.tsx", "deprecated": false, "trackAdoption": false, "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.QueryInputServices.http", "type": "Object", "tags": [], @@ -2364,12 +2364,12 @@ "text": "HttpSetup" } ], - "path": "src/plugins/visualization_ui_components/public/components/query_input/query_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/query_input/query_input.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.QueryInputServices.storage", "type": "Object", "tags": [], @@ -2385,12 +2385,12 @@ }, "" ], - "path": "src/plugins/visualization_ui_components/public/components/query_input/query_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/query_input/query_input.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.QueryInputServices.dataViews", "type": "Object", "tags": [], @@ -2405,12 +2405,12 @@ "text": "DataViewsServicePublic" } ], - "path": "src/plugins/visualization_ui_components/public/components/query_input/query_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/query_input/query_input.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.QueryInputServices.data", "type": "Object", "tags": [], @@ -2425,12 +2425,12 @@ "text": "DataPublicPluginStart" } ], - "path": "src/plugins/visualization_ui_components/public/components/query_input/query_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/query_input/query_input.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.QueryInputServices.uiSettings", "type": "Object", "tags": [], @@ -2445,12 +2445,12 @@ "text": "IUiSettingsClient" } ], - "path": "src/plugins/visualization_ui_components/public/components/query_input/query_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/query_input/query_input.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.QueryInputServices.notifications", "type": "Object", "tags": [], @@ -2465,12 +2465,12 @@ "text": "NotificationsStart" } ], - "path": "src/plugins/visualization_ui_components/public/components/query_input/query_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/query_input/query_input.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.QueryInputServices.unifiedSearch", "type": "Object", "tags": [], @@ -2485,12 +2485,12 @@ "text": "UnifiedSearchPublicPluginStart" } ], - "path": "src/plugins/visualization_ui_components/public/components/query_input/query_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/query_input/query_input.tsx", "deprecated": false, "trackAdoption": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.QueryInputServices.docLinks", "type": "Object", "tags": [], @@ -2505,7 +2505,7 @@ "text": "DocLinksStart" } ], - "path": "src/plugins/visualization_ui_components/public/components/query_input/query_input.tsx", + "path": "packages/kbn-visualization-ui-components/components/query_input/query_input.tsx", "deprecated": false, "trackAdoption": false } @@ -2516,7 +2516,7 @@ "enums": [], "misc": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.DataType", "type": "Type", "tags": [], @@ -2525,13 +2525,13 @@ "signature": [ "\"string\" | \"number\" | \"boolean\" | \"date\" | FieldOnlyDataType" ], - "path": "src/plugins/visualization_ui_components/public/components/field_picker/types.ts", + "path": "packages/kbn-visualization-ui-components/components/field_picker/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.emptyTitleText", "type": "Any", "tags": [], @@ -2540,13 +2540,13 @@ "signature": [ "any" ], - "path": "src/plugins/visualization_ui_components/public/components/dimension_buttons/constants.ts", + "path": "packages/kbn-visualization-ui-components/components/dimension_buttons/constants.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.FieldOption", "type": "Type", "tags": [], @@ -2557,13 +2557,13 @@ "EuiComboBoxOptionOption", "" ], - "path": "src/plugins/visualization_ui_components/public/components/field_picker/types.ts", + "path": "packages/kbn-visualization-ui-components/components/field_picker/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.FormatFactory", "type": "Type", "tags": [], @@ -2595,13 +2595,13 @@ "text": "FieldFormat" } ], - "path": "src/plugins/visualization_ui_components/public/types.ts", + "path": "packages/kbn-visualization-ui-components/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.FormatFactory.$1", "type": "Object", "tags": [], @@ -2625,7 +2625,7 @@ }, "> | undefined" ], - "path": "src/plugins/visualization_ui_components/public/types.ts", + "path": "packages/kbn-visualization-ui-components/types.ts", "deprecated": false, "trackAdoption": false } @@ -2633,7 +2633,7 @@ "initialIsOpen": false }, { - "parentPluginId": "visualizationUiComponents", + "parentPluginId": "@kbn/visualization-ui-components", "id": "def-public.IconSet", "type": "Type", "tags": [], @@ -2644,7 +2644,22 @@ "IconType", " | T | undefined; shouldRotate?: boolean | undefined; }[]" ], - "path": "src/plugins/visualization_ui_components/public/components/icon_select.tsx", + "path": "packages/kbn-visualization-ui-components/components/icon_select.tsx", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/visualization-ui-components", + "id": "def-public.LineStyle", + "type": "Type", + "tags": [], + "label": "LineStyle", + "description": [], + "signature": [ + "\"solid\" | \"dashed\" | \"dotted\"" + ], + "path": "packages/kbn-visualization-ui-components/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false diff --git a/api_docs/kbn_visualization_ui_components.mdx b/api_docs/kbn_visualization_ui_components.mdx new file mode 100644 index 0000000000000..0b4fc006512bf --- /dev/null +++ b/api_docs/kbn_visualization_ui_components.mdx @@ -0,0 +1,36 @@ +--- +#### +#### 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. +#### +id: kibKbnVisualizationUiComponentsPluginApi +slug: /kibana-dev-docs/api/kbn-visualization-ui-components +title: "@kbn/visualization-ui-components" +image: https://source.unsplash.com/400x175/?github +description: API docs for the @kbn/visualization-ui-components plugin +date: 2023-07-20 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/visualization-ui-components'] +--- +import kbnVisualizationUiComponentsObj from './kbn_visualization_ui_components.devdocs.json'; + + + +Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 155 | 1 | 151 | 3 | + +## Client + +### Functions + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/kbn_yarn_lock_validator.mdx b/api_docs/kbn_yarn_lock_validator.mdx index 8c2e7a5ea10cc..e4e0c2bd5ee35 100644 --- a/api_docs/kbn_yarn_lock_validator.mdx +++ b/api_docs/kbn_yarn_lock_validator.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-yarn-lock-validator title: "@kbn/yarn-lock-validator" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/yarn-lock-validator plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/yarn-lock-validator'] --- import kbnYarnLockValidatorObj from './kbn_yarn_lock_validator.devdocs.json'; diff --git a/api_docs/kibana_overview.mdx b/api_docs/kibana_overview.mdx index af3b7fc437e7d..02c261961169c 100644 --- a/api_docs/kibana_overview.mdx +++ b/api_docs/kibana_overview.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kibanaOverview title: "kibanaOverview" image: https://source.unsplash.com/400x175/?github description: API docs for the kibanaOverview plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaOverview'] --- import kibanaOverviewObj from './kibana_overview.devdocs.json'; diff --git a/api_docs/kibana_react.mdx b/api_docs/kibana_react.mdx index 933eda3214780..e8ead789d4a29 100644 --- a/api_docs/kibana_react.mdx +++ b/api_docs/kibana_react.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kibanaReact title: "kibanaReact" image: https://source.unsplash.com/400x175/?github description: API docs for the kibanaReact plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaReact'] --- import kibanaReactObj from './kibana_react.devdocs.json'; diff --git a/api_docs/kibana_utils.mdx b/api_docs/kibana_utils.mdx index 6bf1ac27b6a18..5f0364637a9cc 100644 --- a/api_docs/kibana_utils.mdx +++ b/api_docs/kibana_utils.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kibanaUtils title: "kibanaUtils" image: https://source.unsplash.com/400x175/?github description: API docs for the kibanaUtils plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaUtils'] --- import kibanaUtilsObj from './kibana_utils.devdocs.json'; diff --git a/api_docs/kubernetes_security.mdx b/api_docs/kubernetes_security.mdx index 16ee3e3135026..e266b16506299 100644 --- a/api_docs/kubernetes_security.mdx +++ b/api_docs/kubernetes_security.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kubernetesSecurity title: "kubernetesSecurity" image: https://source.unsplash.com/400x175/?github description: API docs for the kubernetesSecurity plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kubernetesSecurity'] --- import kubernetesSecurityObj from './kubernetes_security.devdocs.json'; diff --git a/api_docs/lens.mdx b/api_docs/lens.mdx index 7c52c43f688a9..922d2b0e38f32 100644 --- a/api_docs/lens.mdx +++ b/api_docs/lens.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/lens title: "lens" image: https://source.unsplash.com/400x175/?github description: API docs for the lens plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'lens'] --- import lensObj from './lens.devdocs.json'; diff --git a/api_docs/license_api_guard.mdx b/api_docs/license_api_guard.mdx index eb710a14eaa0c..acef600633d33 100644 --- a/api_docs/license_api_guard.mdx +++ b/api_docs/license_api_guard.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/licenseApiGuard title: "licenseApiGuard" image: https://source.unsplash.com/400x175/?github description: API docs for the licenseApiGuard plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licenseApiGuard'] --- import licenseApiGuardObj from './license_api_guard.devdocs.json'; diff --git a/api_docs/license_management.mdx b/api_docs/license_management.mdx index b06b88ff69665..ad6be994b60cf 100644 --- a/api_docs/license_management.mdx +++ b/api_docs/license_management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/licenseManagement title: "licenseManagement" image: https://source.unsplash.com/400x175/?github description: API docs for the licenseManagement plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licenseManagement'] --- import licenseManagementObj from './license_management.devdocs.json'; diff --git a/api_docs/licensing.mdx b/api_docs/licensing.mdx index d6572e6a9c38d..bc1c7b9f52e04 100644 --- a/api_docs/licensing.mdx +++ b/api_docs/licensing.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/licensing title: "licensing" image: https://source.unsplash.com/400x175/?github description: API docs for the licensing plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licensing'] --- import licensingObj from './licensing.devdocs.json'; diff --git a/api_docs/lists.mdx b/api_docs/lists.mdx index ff500acacf24d..b3c9f635fa0f9 100644 --- a/api_docs/lists.mdx +++ b/api_docs/lists.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/lists title: "lists" image: https://source.unsplash.com/400x175/?github description: API docs for the lists plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'lists'] --- import listsObj from './lists.devdocs.json'; diff --git a/api_docs/logs_shared.mdx b/api_docs/logs_shared.mdx index f68a42a3f1a82..91cb4d714b340 100644 --- a/api_docs/logs_shared.mdx +++ b/api_docs/logs_shared.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/logsShared title: "logsShared" image: https://source.unsplash.com/400x175/?github description: API docs for the logsShared plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'logsShared'] --- import logsSharedObj from './logs_shared.devdocs.json'; diff --git a/api_docs/management.mdx b/api_docs/management.mdx index 25b32806db246..211d933a3fca5 100644 --- a/api_docs/management.mdx +++ b/api_docs/management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/management title: "management" image: https://source.unsplash.com/400x175/?github description: API docs for the management plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'management'] --- import managementObj from './management.devdocs.json'; diff --git a/api_docs/maps.devdocs.json b/api_docs/maps.devdocs.json index 0d1caee4a2f12..e732667d42150 100644 --- a/api_docs/maps.devdocs.json +++ b/api_docs/maps.devdocs.json @@ -1813,7 +1813,7 @@ "label": "mbFeature", "description": [], "signature": [ - "maplibregl.GeoJSONFeature & { layer: Omit & { source: string; }; source: string; sourceLayer?: string | undefined; state: { [key: string]: any; }; }" + "maplibregl.GeoJSONFeature & { layer: (Omit | Omit | Omit | Omit | Omit | Omit | Omit | Omit | Omit) & { source: string; }; source: string; sourceLayer?: string | undefined; state: { [key: string]: any; }; }" ], "path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx", "deprecated": false, diff --git a/api_docs/maps.mdx b/api_docs/maps.mdx index ba510fb321033..2804af19b928e 100644 --- a/api_docs/maps.mdx +++ b/api_docs/maps.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/maps title: "maps" image: https://source.unsplash.com/400x175/?github description: API docs for the maps plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'maps'] --- import mapsObj from './maps.devdocs.json'; diff --git a/api_docs/maps_ems.mdx b/api_docs/maps_ems.mdx index b1b0cff46c80e..4311244b5340d 100644 --- a/api_docs/maps_ems.mdx +++ b/api_docs/maps_ems.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/mapsEms title: "mapsEms" image: https://source.unsplash.com/400x175/?github description: API docs for the mapsEms plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'mapsEms'] --- import mapsEmsObj from './maps_ems.devdocs.json'; diff --git a/api_docs/ml.devdocs.json b/api_docs/ml.devdocs.json index fbdfc504d747d..f3f69dffc0556 100644 --- a/api_docs/ml.devdocs.json +++ b/api_docs/ml.devdocs.json @@ -1025,7 +1025,7 @@ "label": "ML_PAGES", "description": [], "signature": [ - "{ readonly ANOMALY_DETECTION_JOBS_MANAGE: \"jobs\"; readonly ANOMALY_EXPLORER: \"explorer\"; readonly SINGLE_METRIC_VIEWER: \"timeseriesexplorer\"; readonly DATA_FRAME_ANALYTICS_JOBS_MANAGE: \"data_frame_analytics\"; readonly DATA_FRAME_ANALYTICS_SOURCE_SELECTION: \"data_frame_analytics/source_selection\"; readonly DATA_FRAME_ANALYTICS_CREATE_JOB: \"data_frame_analytics/new_job\"; readonly TRAINED_MODELS_MANAGE: \"trained_models\"; readonly NODES: \"nodes\"; readonly MEMORY_USAGE: \"memory_usage\"; readonly DATA_FRAME_ANALYTICS_EXPLORATION: \"data_frame_analytics/exploration\"; readonly DATA_FRAME_ANALYTICS_MAP: \"data_frame_analytics/map\"; readonly DATA_VISUALIZER: \"datavisualizer\"; readonly DATA_VISUALIZER_INDEX_SELECT: \"datavisualizer_index_select\"; readonly DATA_VISUALIZER_FILE: \"filedatavisualizer\"; readonly DATA_VISUALIZER_INDEX_VIEWER: \"jobs/new_job/datavisualizer\"; readonly ANOMALY_DETECTION_CREATE_JOB: \"jobs/new_job\"; readonly ANOMALY_DETECTION_CREATE_JOB_RECOGNIZER: \"jobs/new_job/recognize\"; readonly ANOMALY_DETECTION_CREATE_JOB_SINGLE_METRIC: \"jobs/new_job/single_metric\"; readonly ANOMALY_DETECTION_CREATE_JOB_MULTI_METRIC: \"jobs/new_job/multi_metric\"; readonly ANOMALY_DETECTION_CREATE_JOB_CONVERT_TO_MULTI_METRIC: \"jobs/new_job/convert_to_multi_metric\"; readonly ANOMALY_DETECTION_CREATE_JOB_ADVANCED: \"jobs/new_job/advanced\"; readonly ANOMALY_DETECTION_CREATE_JOB_POPULATION: \"jobs/new_job/population\"; readonly ANOMALY_DETECTION_CREATE_JOB_CATEGORIZATION: \"jobs/new_job/categorization\"; readonly ANOMALY_DETECTION_CREATE_JOB_RARE: \"jobs/new_job/rare\"; readonly ANOMALY_DETECTION_CREATE_JOB_GEO: \"jobs/new_job/geo\"; readonly ANOMALY_DETECTION_CREATE_JOB_CONVERT_TO_ADVANCED: \"jobs/new_job/convert_to_advanced\"; readonly ANOMALY_DETECTION_CREATE_JOB_SELECT_TYPE: \"jobs/new_job/step/job_type\"; readonly ANOMALY_DETECTION_CREATE_JOB_SELECT_INDEX: \"jobs/new_job/step/index_or_search\"; readonly ANOMALY_DETECTION_CREATE_JOB_FROM_LENS: \"jobs/new_job/from_lens\"; readonly ANOMALY_DETECTION_CREATE_JOB_FROM_MAP: \"jobs/new_job/from_map\"; readonly ANOMALY_DETECTION_MODULES_VIEW_OR_CREATE: \"modules/check_view_or_create\"; readonly SETTINGS: \"settings\"; readonly CALENDARS_MANAGE: \"settings/calendars_list\"; readonly CALENDARS_NEW: \"settings/calendars_list/new_calendar\"; readonly CALENDARS_EDIT: \"settings/calendars_list/edit_calendar\"; readonly FILTER_LISTS_MANAGE: \"settings/filter_lists\"; readonly FILTER_LISTS_NEW: \"settings/filter_lists/new_filter_list\"; readonly FILTER_LISTS_EDIT: \"settings/filter_lists/edit_filter_list\"; readonly OVERVIEW: \"overview\"; readonly NOTIFICATIONS: \"notifications\"; readonly AIOPS: \"aiops\"; readonly AIOPS_EXPLAIN_LOG_RATE_SPIKES: \"aiops/explain_log_rate_spikes\"; readonly AIOPS_EXPLAIN_LOG_RATE_SPIKES_INDEX_SELECT: \"aiops/explain_log_rate_spikes_index_select\"; readonly AIOPS_LOG_CATEGORIZATION: \"aiops/log_categorization\"; readonly AIOPS_LOG_CATEGORIZATION_INDEX_SELECT: \"aiops/log_categorization_index_select\"; readonly AIOPS_CHANGE_POINT_DETECTION: \"aiops/change_point_detection\"; readonly AIOPS_CHANGE_POINT_DETECTION_INDEX_SELECT: \"aiops/change_point_detection_index_select\"; }" + "{ readonly ANOMALY_DETECTION_JOBS_MANAGE: \"jobs\"; readonly ANOMALY_EXPLORER: \"explorer\"; readonly SINGLE_METRIC_VIEWER: \"timeseriesexplorer\"; readonly DATA_FRAME_ANALYTICS_JOBS_MANAGE: \"data_frame_analytics\"; readonly DATA_FRAME_ANALYTICS_SOURCE_SELECTION: \"data_frame_analytics/source_selection\"; readonly DATA_FRAME_ANALYTICS_CREATE_JOB: \"data_frame_analytics/new_job\"; readonly TRAINED_MODELS_MANAGE: \"trained_models\"; readonly NODES: \"nodes\"; readonly MEMORY_USAGE: \"memory_usage\"; readonly DATA_FRAME_ANALYTICS_EXPLORATION: \"data_frame_analytics/exploration\"; readonly DATA_FRAME_ANALYTICS_MAP: \"data_frame_analytics/map\"; readonly DATA_VISUALIZER: \"datavisualizer\"; readonly DATA_VISUALIZER_INDEX_SELECT: \"datavisualizer_index_select\"; readonly DATA_VISUALIZER_FILE: \"filedatavisualizer\"; readonly DATA_VISUALIZER_INDEX_VIEWER: \"jobs/new_job/datavisualizer\"; readonly ANOMALY_DETECTION_CREATE_JOB: \"jobs/new_job\"; readonly ANOMALY_DETECTION_CREATE_JOB_RECOGNIZER: \"jobs/new_job/recognize\"; readonly ANOMALY_DETECTION_CREATE_JOB_SINGLE_METRIC: \"jobs/new_job/single_metric\"; readonly ANOMALY_DETECTION_CREATE_JOB_MULTI_METRIC: \"jobs/new_job/multi_metric\"; readonly ANOMALY_DETECTION_CREATE_JOB_CONVERT_TO_MULTI_METRIC: \"jobs/new_job/convert_to_multi_metric\"; readonly ANOMALY_DETECTION_CREATE_JOB_ADVANCED: \"jobs/new_job/advanced\"; readonly ANOMALY_DETECTION_CREATE_JOB_POPULATION: \"jobs/new_job/population\"; readonly ANOMALY_DETECTION_CREATE_JOB_CATEGORIZATION: \"jobs/new_job/categorization\"; readonly ANOMALY_DETECTION_CREATE_JOB_RARE: \"jobs/new_job/rare\"; readonly ANOMALY_DETECTION_CREATE_JOB_GEO: \"jobs/new_job/geo\"; readonly ANOMALY_DETECTION_CREATE_JOB_CONVERT_TO_ADVANCED: \"jobs/new_job/convert_to_advanced\"; readonly ANOMALY_DETECTION_CREATE_JOB_SELECT_TYPE: \"jobs/new_job/step/job_type\"; readonly ANOMALY_DETECTION_CREATE_JOB_SELECT_INDEX: \"jobs/new_job/step/index_or_search\"; readonly ANOMALY_DETECTION_CREATE_JOB_FROM_LENS: \"jobs/new_job/from_lens\"; readonly ANOMALY_DETECTION_CREATE_JOB_FROM_MAP: \"jobs/new_job/from_map\"; readonly ANOMALY_DETECTION_MODULES_VIEW_OR_CREATE: \"modules/check_view_or_create\"; readonly SETTINGS: \"settings\"; readonly CALENDARS_MANAGE: \"settings/calendars_list\"; readonly CALENDARS_NEW: \"settings/calendars_list/new_calendar\"; readonly CALENDARS_EDIT: \"settings/calendars_list/edit_calendar\"; readonly FILTER_LISTS_MANAGE: \"settings/filter_lists\"; readonly FILTER_LISTS_NEW: \"settings/filter_lists/new_filter_list\"; readonly FILTER_LISTS_EDIT: \"settings/filter_lists/edit_filter_list\"; readonly OVERVIEW: \"overview\"; readonly NOTIFICATIONS: \"notifications\"; readonly AIOPS: \"aiops\"; readonly AIOPS_EXPLAIN_LOG_RATE_SPIKES: \"aiops/explain_log_rate_spikes\"; readonly AIOPS_EXPLAIN_LOG_RATE_SPIKES_INDEX_SELECT: \"aiops/explain_log_rate_spikes_index_select\"; readonly AIOPS_LOG_RATE_ANALYSIS: \"aiops/log_rate_analysis\"; readonly AIOPS_LOG_RATE_ANALYSIS_INDEX_SELECT: \"aiops/log_rate_analysis_index_select\"; readonly AIOPS_LOG_CATEGORIZATION: \"aiops/log_categorization\"; readonly AIOPS_LOG_CATEGORIZATION_INDEX_SELECT: \"aiops/log_categorization_index_select\"; readonly AIOPS_CHANGE_POINT_DETECTION: \"aiops/change_point_detection\"; readonly AIOPS_CHANGE_POINT_DETECTION_INDEX_SELECT: \"aiops/change_point_detection_index_select\"; }" ], "path": "x-pack/plugins/ml/common/constants/locator.ts", "deprecated": false, diff --git a/api_docs/ml.mdx b/api_docs/ml.mdx index a5009bc5f8ab4..3a1d848edd14c 100644 --- a/api_docs/ml.mdx +++ b/api_docs/ml.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/ml title: "ml" image: https://source.unsplash.com/400x175/?github description: API docs for the ml plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ml'] --- import mlObj from './ml.devdocs.json'; diff --git a/api_docs/monitoring.mdx b/api_docs/monitoring.mdx index 25e658d0cdea5..cc9260102e8da 100644 --- a/api_docs/monitoring.mdx +++ b/api_docs/monitoring.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/monitoring title: "monitoring" image: https://source.unsplash.com/400x175/?github description: API docs for the monitoring plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'monitoring'] --- import monitoringObj from './monitoring.devdocs.json'; diff --git a/api_docs/monitoring_collection.mdx b/api_docs/monitoring_collection.mdx index 2895b11aa7944..47b7de3d6766d 100644 --- a/api_docs/monitoring_collection.mdx +++ b/api_docs/monitoring_collection.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/monitoringCollection title: "monitoringCollection" image: https://source.unsplash.com/400x175/?github description: API docs for the monitoringCollection plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'monitoringCollection'] --- import monitoringCollectionObj from './monitoring_collection.devdocs.json'; diff --git a/api_docs/navigation.mdx b/api_docs/navigation.mdx index 4359363eadcee..0cda351d62ef0 100644 --- a/api_docs/navigation.mdx +++ b/api_docs/navigation.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/navigation title: "navigation" image: https://source.unsplash.com/400x175/?github description: API docs for the navigation plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'navigation'] --- import navigationObj from './navigation.devdocs.json'; diff --git a/api_docs/newsfeed.mdx b/api_docs/newsfeed.mdx index 24f359134dabd..770af52cf3e49 100644 --- a/api_docs/newsfeed.mdx +++ b/api_docs/newsfeed.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/newsfeed title: "newsfeed" image: https://source.unsplash.com/400x175/?github description: API docs for the newsfeed plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'newsfeed'] --- import newsfeedObj from './newsfeed.devdocs.json'; diff --git a/api_docs/notifications.mdx b/api_docs/notifications.mdx index 46a00d26058b7..1d518562f9e8f 100644 --- a/api_docs/notifications.mdx +++ b/api_docs/notifications.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/notifications title: "notifications" image: https://source.unsplash.com/400x175/?github description: API docs for the notifications plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'notifications'] --- import notificationsObj from './notifications.devdocs.json'; diff --git a/api_docs/observability.devdocs.json b/api_docs/observability.devdocs.json index 9ebbe4bbd0855..09393b66217b2 100644 --- a/api_docs/observability.devdocs.json +++ b/api_docs/observability.devdocs.json @@ -843,6 +843,60 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "observability", + "id": "def-public.useSummaryTimeRange", + "type": "Function", + "tags": [], + "label": "useSummaryTimeRange", + "description": [], + "signature": [ + "(unifiedSearchDateRange: ", + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + ") => ", + { + "pluginId": "triggersActionsUi", + "scope": "public", + "docId": "kibTriggersActionsUiPluginApi", + "section": "def-public.AlertSummaryTimeRange", + "text": "AlertSummaryTimeRange" + } + ], + "path": "x-pack/plugins/observability/public/hooks/use_summary_time_range.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "observability", + "id": "def-public.useSummaryTimeRange.$1", + "type": "Object", + "tags": [], + "label": "unifiedSearchDateRange", + "description": [], + "signature": [ + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + } + ], + "path": "x-pack/plugins/observability/public/hooks/use_summary_time_range.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "observability", "id": "def-public.useTimeBuckets", @@ -4426,7 +4480,7 @@ "label": "createOrUpdateIndex", "description": [], "signature": [ - "({\n index,\n mappings,\n client,\n logger,\n}: { index: string; mappings: ", + "({\n index,\n mappings,\n settings,\n client,\n logger,\n}: { index: string; mappings: ", "MappingTypeMapping", " & { date_detection?: boolean | undefined; dynamic?: ", "MappingDynamicMapping", @@ -4446,7 +4500,9 @@ "MappingSourceField", " | undefined; runtime?: ", "MappingRuntimeFields", - " | undefined; }; client: ", + " | undefined; }; settings?: ", + "IndicesIndexSettings", + " | undefined; client: ", { "pluginId": "@kbn/core-elasticsearch-server", "scope": "common", @@ -4473,7 +4529,7 @@ "id": "def-server.createOrUpdateIndex.$1", "type": "Object", "tags": [], - "label": "{\n index,\n mappings,\n client,\n logger,\n}", + "label": "{\n index,\n mappings,\n settings,\n client,\n logger,\n}", "description": [], "path": "x-pack/plugins/observability/server/utils/create_or_update_index.ts", "deprecated": false, @@ -4523,6 +4579,21 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "observability", + "id": "def-server.createOrUpdateIndex.$1.settings", + "type": "CompoundType", + "tags": [], + "label": "settings", + "description": [], + "signature": [ + "IndicesIndexSettings", + " | undefined" + ], + "path": "x-pack/plugins/observability/server/utils/create_or_update_index.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "observability", "id": "def-server.createOrUpdateIndex.$1.client", @@ -7651,7 +7722,7 @@ "label": "config", "description": [], "signature": [ - "{ readonly aiAssistant?: Readonly<{} & { enabled: boolean; feedback: Readonly<{} & { enabled: boolean; url: string; }>; provider: Readonly<{} & { openAI: Readonly<{} & { apiKey: string; model: string; }>; }> | Readonly<{} & { azureOpenAI: Readonly<{} & { apiKey: string; resourceName: string; deploymentId: string; }>; }>; }> | undefined; readonly enabled: boolean; readonly annotations: Readonly<{} & { index: string; enabled: boolean; }>; readonly unsafe: Readonly<{} & { alertDetails: Readonly<{} & { uptime: Readonly<{} & { enabled: boolean; }>; metrics: Readonly<{} & { enabled: boolean; }>; logs: Readonly<{} & { enabled: boolean; }>; }>; thresholdRule: Readonly<{} & { enabled: boolean; }>; }>; readonly thresholdRule: Readonly<{} & { groupByPageSize: number; }>; readonly compositeSlo: Readonly<{} & { enabled: boolean; }>; }" + "{ readonly aiAssistant?: Readonly<{} & { enabled: boolean; feedback: Readonly<{ url?: string | undefined; } & { enabled: boolean; }>; provider: Readonly<{} & { openAI: Readonly<{} & { apiKey: string; model: string; }>; }> | Readonly<{} & { azureOpenAI: Readonly<{} & { apiKey: string; resourceName: string; deploymentId: string; }>; }>; }> | undefined; readonly enabled: boolean; readonly annotations: Readonly<{} & { index: string; enabled: boolean; }>; readonly unsafe: Readonly<{} & { alertDetails: Readonly<{} & { uptime: Readonly<{} & { enabled: boolean; }>; metrics: Readonly<{} & { enabled: boolean; }>; logs: Readonly<{} & { enabled: boolean; }>; }>; thresholdRule: Readonly<{} & { enabled: boolean; }>; }>; readonly thresholdRule: Readonly<{} & { groupByPageSize: number; }>; readonly compositeSlo: Readonly<{} & { enabled: boolean; }>; }" ], "path": "x-pack/plugins/observability/server/routes/types.ts", "deprecated": false, @@ -9581,7 +9652,7 @@ "label": "ObservabilityConfig", "description": [], "signature": [ - "{ readonly aiAssistant?: Readonly<{} & { enabled: boolean; feedback: Readonly<{} & { enabled: boolean; url: string; }>; provider: Readonly<{} & { openAI: Readonly<{} & { apiKey: string; model: string; }>; }> | Readonly<{} & { azureOpenAI: Readonly<{} & { apiKey: string; resourceName: string; deploymentId: string; }>; }>; }> | undefined; readonly enabled: boolean; readonly annotations: Readonly<{} & { index: string; enabled: boolean; }>; readonly unsafe: Readonly<{} & { alertDetails: Readonly<{} & { uptime: Readonly<{} & { enabled: boolean; }>; metrics: Readonly<{} & { enabled: boolean; }>; logs: Readonly<{} & { enabled: boolean; }>; }>; thresholdRule: Readonly<{} & { enabled: boolean; }>; }>; readonly thresholdRule: Readonly<{} & { groupByPageSize: number; }>; readonly compositeSlo: Readonly<{} & { enabled: boolean; }>; }" + "{ readonly aiAssistant?: Readonly<{} & { enabled: boolean; feedback: Readonly<{ url?: string | undefined; } & { enabled: boolean; }>; provider: Readonly<{} & { openAI: Readonly<{} & { apiKey: string; model: string; }>; }> | Readonly<{} & { azureOpenAI: Readonly<{} & { apiKey: string; resourceName: string; deploymentId: string; }>; }>; }> | undefined; readonly enabled: boolean; readonly annotations: Readonly<{} & { index: string; enabled: boolean; }>; readonly unsafe: Readonly<{} & { alertDetails: Readonly<{} & { uptime: Readonly<{} & { enabled: boolean; }>; metrics: Readonly<{} & { enabled: boolean; }>; logs: Readonly<{} & { enabled: boolean; }>; }>; thresholdRule: Readonly<{} & { enabled: boolean; }>; }>; readonly thresholdRule: Readonly<{} & { groupByPageSize: number; }>; readonly compositeSlo: Readonly<{} & { enabled: boolean; }>; }" ], "path": "x-pack/plugins/observability/server/index.ts", "deprecated": false, @@ -15079,21 +15150,6 @@ "trackAdoption": false, "initialIsOpen": false }, - { - "parentPluginId": "observability", - "id": "def-common.NETWORK_TIMINGS_FIELDS", - "type": "Array", - "tags": [], - "label": "NETWORK_TIMINGS_FIELDS", - "description": [], - "signature": [ - "string[]" - ], - "path": "x-pack/plugins/observability/common/field_names/synthetics.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, { "parentPluginId": "observability", "id": "def-common.observabilityAppId", @@ -15199,141 +15255,6 @@ "trackAdoption": false, "initialIsOpen": false }, - { - "parentPluginId": "observability", - "id": "def-common.SYNTHETICS_BLOCKED_TIMINGS", - "type": "string", - "tags": [], - "label": "SYNTHETICS_BLOCKED_TIMINGS", - "description": [], - "signature": [ - "\"synthetics.payload.timings.blocked\"" - ], - "path": "x-pack/plugins/observability/common/field_names/synthetics.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "observability", - "id": "def-common.SYNTHETICS_CONNECT_TIMINGS", - "type": "string", - "tags": [], - "label": "SYNTHETICS_CONNECT_TIMINGS", - "description": [], - "signature": [ - "\"synthetics.payload.timings.connect\"" - ], - "path": "x-pack/plugins/observability/common/field_names/synthetics.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "observability", - "id": "def-common.SYNTHETICS_DNS_TIMINGS", - "type": "string", - "tags": [], - "label": "SYNTHETICS_DNS_TIMINGS", - "description": [], - "signature": [ - "\"synthetics.payload.timings.dns\"" - ], - "path": "x-pack/plugins/observability/common/field_names/synthetics.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "observability", - "id": "def-common.SYNTHETICS_RECEIVE_TIMINGS", - "type": "string", - "tags": [], - "label": "SYNTHETICS_RECEIVE_TIMINGS", - "description": [], - "signature": [ - "\"synthetics.payload.timings.receive\"" - ], - "path": "x-pack/plugins/observability/common/field_names/synthetics.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "observability", - "id": "def-common.SYNTHETICS_SEND_TIMINGS", - "type": "string", - "tags": [], - "label": "SYNTHETICS_SEND_TIMINGS", - "description": [], - "signature": [ - "\"synthetics.payload.timings.send\"" - ], - "path": "x-pack/plugins/observability/common/field_names/synthetics.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "observability", - "id": "def-common.SYNTHETICS_SSL_TIMINGS", - "type": "string", - "tags": [], - "label": "SYNTHETICS_SSL_TIMINGS", - "description": [], - "signature": [ - "\"synthetics.payload.timings.ssl\"" - ], - "path": "x-pack/plugins/observability/common/field_names/synthetics.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "observability", - "id": "def-common.SYNTHETICS_STEP_DURATION", - "type": "string", - "tags": [], - "label": "SYNTHETICS_STEP_DURATION", - "description": [], - "signature": [ - "\"synthetics.step.duration.us\"" - ], - "path": "x-pack/plugins/observability/common/field_names/synthetics.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "observability", - "id": "def-common.SYNTHETICS_TOTAL_TIMINGS", - "type": "string", - "tags": [], - "label": "SYNTHETICS_TOTAL_TIMINGS", - "description": [], - "signature": [ - "\"synthetics.payload.timings.total\"" - ], - "path": "x-pack/plugins/observability/common/field_names/synthetics.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "observability", - "id": "def-common.SYNTHETICS_WAIT_TIMINGS", - "type": "string", - "tags": [], - "label": "SYNTHETICS_WAIT_TIMINGS", - "description": [], - "signature": [ - "\"synthetics.payload.timings.wait\"" - ], - "path": "x-pack/plugins/observability/common/field_names/synthetics.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, { "parentPluginId": "observability", "id": "def-common.syntheticsEditMonitorLocatorID", diff --git a/api_docs/observability.mdx b/api_docs/observability.mdx index f76c3118e482a..fb142915bd95b 100644 --- a/api_docs/observability.mdx +++ b/api_docs/observability.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/observability title: "observability" image: https://source.unsplash.com/400x175/?github description: API docs for the observability plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'observability'] --- import observabilityObj from './observability.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/actionable-observability](https://github.com/orgs/elastic/team | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 523 | 45 | 515 | 19 | +| 516 | 45 | 508 | 19 | ## Client diff --git a/api_docs/observability_onboarding.mdx b/api_docs/observability_onboarding.mdx index 990ec4a27e661..563382c237d14 100644 --- a/api_docs/observability_onboarding.mdx +++ b/api_docs/observability_onboarding.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/observabilityOnboarding title: "observabilityOnboarding" image: https://source.unsplash.com/400x175/?github description: API docs for the observabilityOnboarding plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'observabilityOnboarding'] --- import observabilityOnboardingObj from './observability_onboarding.devdocs.json'; diff --git a/api_docs/observability_shared.devdocs.json b/api_docs/observability_shared.devdocs.json index 2a32f416393dd..0ac067f093627 100644 --- a/api_docs/observability_shared.devdocs.json +++ b/api_docs/observability_shared.devdocs.json @@ -2811,7 +2811,7 @@ "signature": [ "\"agent\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -2826,7 +2826,7 @@ "signature": [ "\"agent.name\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -2841,7 +2841,7 @@ "signature": [ "\"agent.version\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -2871,7 +2871,7 @@ "signature": [ "\"client.geo\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -2886,7 +2886,7 @@ "signature": [ "\"client.geo.country_iso_code\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -2901,7 +2901,7 @@ "signature": [ "\"client.geo.country_name\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -2916,7 +2916,7 @@ "signature": [ "\"cloud\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -2931,7 +2931,7 @@ "signature": [ "\"cloud.availability_zone\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -2946,7 +2946,7 @@ "signature": [ "\"cloud.machine.type\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -2961,7 +2961,7 @@ "signature": [ "\"cloud.provider\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -2976,7 +2976,7 @@ "signature": [ "\"cloud.region\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -2991,7 +2991,7 @@ "signature": [ "\"transaction.experience.cls\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3006,7 +3006,7 @@ "signature": [ "\"container.id\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3021,7 +3021,7 @@ "signature": [ "\"destination.address\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3036,7 +3036,7 @@ "signature": [ "\"error.culprit\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3051,7 +3051,7 @@ "signature": [ "\"error.exception.handled\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3066,7 +3066,7 @@ "signature": [ "\"error.exception.message\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3081,7 +3081,7 @@ "signature": [ "\"error.exception.type\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3096,7 +3096,7 @@ "signature": [ "\"error.grouping_key\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3111,7 +3111,7 @@ "signature": [ "\"error.log.level\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3126,7 +3126,7 @@ "signature": [ "\"error.log.message\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3141,7 +3141,7 @@ "signature": [ "\"error.page.url\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3156,7 +3156,7 @@ "signature": [ "\"event.outcome\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3171,7 +3171,7 @@ "signature": [ "\"transaction.marks.agent.firstContentfulPaint\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3186,7 +3186,7 @@ "signature": [ "\"transaction.experience.fid\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3201,7 +3201,7 @@ "signature": [ "\"host\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3216,7 +3216,7 @@ "signature": [ "\"host.hostname\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3231,7 +3231,7 @@ "signature": [ "\"host.os.platform\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3246,7 +3246,7 @@ "signature": [ "\"http.request.method\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3261,7 +3261,7 @@ "signature": [ "\"http.response.status_code\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3276,7 +3276,7 @@ "signature": [ "\"kubernetes\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3291,7 +3291,7 @@ "signature": [ "\"labels.name\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3306,7 +3306,7 @@ "signature": [ "\"transaction.marks.agent.largestContentfulPaint\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3321,7 +3321,7 @@ "signature": [ "\"system.process.cgroup.memory.mem.limit.bytes\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3336,7 +3336,7 @@ "signature": [ "\"system.process.cgroup.memory.mem.usage.bytes\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3351,7 +3351,7 @@ "signature": [ "\"jvm.gc.count\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3366,7 +3366,7 @@ "signature": [ "\"jvm.gc.time\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3381,7 +3381,7 @@ "signature": [ "\"jvm.memory.heap.committed\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3396,7 +3396,7 @@ "signature": [ "\"jvm.memory.heap.max\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3411,7 +3411,7 @@ "signature": [ "\"jvm.memory.heap.used\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3426,7 +3426,7 @@ "signature": [ "\"jvm.memory.non_heap.committed\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3441,7 +3441,7 @@ "signature": [ "\"jvm.memory.non_heap.max\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3456,7 +3456,7 @@ "signature": [ "\"jvm.memory.non_heap.used\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3471,7 +3471,7 @@ "signature": [ "\"jvm.thread.count\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3486,7 +3486,7 @@ "signature": [ "\"system.process.cpu.total.norm.pct\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3501,7 +3501,7 @@ "signature": [ "\"system.cpu.total.norm.pct\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3516,7 +3516,7 @@ "signature": [ "\"system.cpu.usage\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3531,7 +3531,7 @@ "signature": [ "\"system.memory.actual.free\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3546,7 +3546,7 @@ "signature": [ "\"system.memory.usage\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3561,7 +3561,22 @@ "signature": [ "\"system.memory.total\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "observabilityShared", + "id": "def-common.NETWORK_TIMINGS_FIELDS", + "type": "Array", + "tags": [], + "label": "NETWORK_TIMINGS_FIELDS", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/observability_shared/common/field_names/synthetics.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3606,7 +3621,7 @@ "signature": [ "\"observer.hostname\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3621,7 +3636,7 @@ "signature": [ "\"observer.listening\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3636,7 +3651,7 @@ "signature": [ "\"observer.version_major\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3651,7 +3666,7 @@ "signature": [ "\"parent.id\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3666,7 +3681,7 @@ "signature": [ "\"kubernetes.pod.name\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3681,7 +3696,7 @@ "signature": [ "\"processor.event\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3696,7 +3711,7 @@ "signature": [ "\"profile.alloc_objects.count\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3711,7 +3726,7 @@ "signature": [ "\"profile.alloc_space.bytes\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3726,7 +3741,7 @@ "signature": [ "\"profile.cpu.ns\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3741,7 +3756,7 @@ "signature": [ "\"profile.duration\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3756,7 +3771,7 @@ "signature": [ "\"profile.id\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3771,7 +3786,7 @@ "signature": [ "\"profile.inuse_objects.count\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3786,7 +3801,7 @@ "signature": [ "\"profile.inuse_space.bytes\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3801,7 +3816,7 @@ "signature": [ "\"profile.samples.count\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3816,7 +3831,7 @@ "signature": [ "\"profile.stack\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3831,7 +3846,7 @@ "signature": [ "\"profile.top.id\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3846,7 +3861,7 @@ "signature": [ "\"profile.wall.us\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3861,7 +3876,7 @@ "signature": [ "\"service\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3876,7 +3891,7 @@ "signature": [ "\"service.environment\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3891,7 +3906,7 @@ "signature": [ "\"service.framework.name\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3906,7 +3921,7 @@ "signature": [ "\"service.framework.version\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3921,7 +3936,7 @@ "signature": [ "\"service.language.name\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3936,7 +3951,7 @@ "signature": [ "\"service.language.version\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3951,7 +3966,7 @@ "signature": [ "\"service.name\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3966,7 +3981,7 @@ "signature": [ "\"service.node.name\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3981,7 +3996,7 @@ "signature": [ "\"service.runtime.name\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -3996,7 +4011,7 @@ "signature": [ "\"service.runtime.version\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -4011,7 +4026,7 @@ "signature": [ "\"service.version\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -4041,7 +4056,7 @@ "signature": [ "\"span.action\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -4056,7 +4071,7 @@ "signature": [ "\"span.destination.service.resource\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -4071,7 +4086,7 @@ "signature": [ "\"span.destination.service.response_time.count\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -4086,7 +4101,7 @@ "signature": [ "\"span.destination.service.response_time.sum.us\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -4101,7 +4116,7 @@ "signature": [ "\"span.duration.us\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -4116,7 +4131,7 @@ "signature": [ "\"span.id\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -4131,7 +4146,7 @@ "signature": [ "\"span.name\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -4146,7 +4161,7 @@ "signature": [ "\"span.self_time.sum.us\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -4161,7 +4176,7 @@ "signature": [ "\"span.subtype\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -4176,7 +4191,127 @@ "signature": [ "\"span.type\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "observabilityShared", + "id": "def-common.SYNTHETICS_BLOCKED_TIMINGS", + "type": "string", + "tags": [], + "label": "SYNTHETICS_BLOCKED_TIMINGS", + "description": [], + "signature": [ + "\"synthetics.payload.timings.blocked\"" + ], + "path": "x-pack/plugins/observability_shared/common/field_names/synthetics.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "observabilityShared", + "id": "def-common.SYNTHETICS_CONNECT_TIMINGS", + "type": "string", + "tags": [], + "label": "SYNTHETICS_CONNECT_TIMINGS", + "description": [], + "signature": [ + "\"synthetics.payload.timings.connect\"" + ], + "path": "x-pack/plugins/observability_shared/common/field_names/synthetics.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "observabilityShared", + "id": "def-common.SYNTHETICS_DNS_TIMINGS", + "type": "string", + "tags": [], + "label": "SYNTHETICS_DNS_TIMINGS", + "description": [], + "signature": [ + "\"synthetics.payload.timings.dns\"" + ], + "path": "x-pack/plugins/observability_shared/common/field_names/synthetics.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "observabilityShared", + "id": "def-common.SYNTHETICS_RECEIVE_TIMINGS", + "type": "string", + "tags": [], + "label": "SYNTHETICS_RECEIVE_TIMINGS", + "description": [], + "signature": [ + "\"synthetics.payload.timings.receive\"" + ], + "path": "x-pack/plugins/observability_shared/common/field_names/synthetics.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "observabilityShared", + "id": "def-common.SYNTHETICS_SEND_TIMINGS", + "type": "string", + "tags": [], + "label": "SYNTHETICS_SEND_TIMINGS", + "description": [], + "signature": [ + "\"synthetics.payload.timings.send\"" + ], + "path": "x-pack/plugins/observability_shared/common/field_names/synthetics.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "observabilityShared", + "id": "def-common.SYNTHETICS_SSL_TIMINGS", + "type": "string", + "tags": [], + "label": "SYNTHETICS_SSL_TIMINGS", + "description": [], + "signature": [ + "\"synthetics.payload.timings.ssl\"" + ], + "path": "x-pack/plugins/observability_shared/common/field_names/synthetics.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "observabilityShared", + "id": "def-common.SYNTHETICS_TOTAL_TIMINGS", + "type": "string", + "tags": [], + "label": "SYNTHETICS_TOTAL_TIMINGS", + "description": [], + "signature": [ + "\"synthetics.payload.timings.total\"" + ], + "path": "x-pack/plugins/observability_shared/common/field_names/synthetics.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "observabilityShared", + "id": "def-common.SYNTHETICS_WAIT_TIMINGS", + "type": "string", + "tags": [], + "label": "SYNTHETICS_WAIT_TIMINGS", + "description": [], + "signature": [ + "\"synthetics.payload.timings.wait\"" + ], + "path": "x-pack/plugins/observability_shared/common/field_names/synthetics.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -4191,7 +4326,7 @@ "signature": [ "\"transaction.experience.tbt\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -4206,7 +4341,7 @@ "signature": [ "\"trace.id\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -4221,7 +4356,7 @@ "signature": [ "\"transaction.marks.agent.domInteractive\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -4236,7 +4371,7 @@ "signature": [ "\"transaction.duration.us\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -4251,7 +4386,7 @@ "signature": [ "\"transaction.duration.histogram\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -4266,7 +4401,7 @@ "signature": [ "\"transaction.id\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -4281,7 +4416,7 @@ "signature": [ "\"transaction.name\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -4296,7 +4431,7 @@ "signature": [ "\"transaction.page.url\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -4311,7 +4446,7 @@ "signature": [ "\"transaction.result\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -4326,7 +4461,7 @@ "signature": [ "\"transaction.root\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -4341,7 +4476,7 @@ "signature": [ "\"transaction.sampled\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -4356,7 +4491,7 @@ "signature": [ "\"transaction.marks.agent.timeToFirstByte\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -4371,7 +4506,7 @@ "signature": [ "\"transaction.type\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -4386,7 +4521,7 @@ "signature": [ "\"url.full\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -4401,7 +4536,7 @@ "signature": [ "\"url.full\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -4416,7 +4551,7 @@ "signature": [ "\"user_agent.device.name\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -4431,7 +4566,7 @@ "signature": [ "\"user_agent.name\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -4446,7 +4581,7 @@ "signature": [ "\"user_agent.original\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -4461,7 +4596,7 @@ "signature": [ "\"user_agent.os.name\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -4476,7 +4611,7 @@ "signature": [ "\"user_agent.os.version\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -4491,7 +4626,7 @@ "signature": [ "\"user_agent.version\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -4506,7 +4641,7 @@ "signature": [ "\"user.id\"" ], - "path": "x-pack/plugins/observability_shared/common/elasticsearch_fieldnames.ts", + "path": "x-pack/plugins/observability_shared/common/field_names/elasticsearch.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false diff --git a/api_docs/observability_shared.mdx b/api_docs/observability_shared.mdx index 4d1731e7bd057..a1abe6a72c8f1 100644 --- a/api_docs/observability_shared.mdx +++ b/api_docs/observability_shared.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/observabilityShared title: "observabilityShared" image: https://source.unsplash.com/400x175/?github description: API docs for the observabilityShared plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'observabilityShared'] --- import observabilitySharedObj from './observability_shared.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/observability-ui](https://github.com/orgs/elastic/teams/observ | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 268 | 1 | 267 | 11 | +| 277 | 1 | 276 | 11 | ## Client diff --git a/api_docs/osquery.mdx b/api_docs/osquery.mdx index 23e8f17609ec5..b4dd08de0c45c 100644 --- a/api_docs/osquery.mdx +++ b/api_docs/osquery.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/osquery title: "osquery" image: https://source.unsplash.com/400x175/?github description: API docs for the osquery plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'osquery'] --- import osqueryObj from './osquery.devdocs.json'; diff --git a/api_docs/plugin_directory.mdx b/api_docs/plugin_directory.mdx index 2087fa4505c69..bdce64a9b71ff 100644 --- a/api_docs/plugin_directory.mdx +++ b/api_docs/plugin_directory.mdx @@ -7,7 +7,7 @@ id: kibDevDocsPluginDirectory slug: /kibana-dev-docs/api-meta/plugin-api-directory title: Directory description: Directory of public APIs available through plugins or packages. -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana'] --- @@ -15,13 +15,13 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | Count | Plugins or Packages with a
public API | Number of teams | |--------------|----------|------------------------| -| 646 | 537 | 38 | +| 650 | 541 | 38 | ### Public API health stats | API Count | Any Count | Missing comments | Missing exports | |--------------|----------|-----------------|--------| -| 71411 | 554 | 61222 | 1455 | +| 71563 | 555 | 61282 | 1460 | ## Plugin Directory @@ -29,7 +29,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] |--------------|----------------|-----------|--------------|----------|---------------|--------| | | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | - | 272 | 10 | 267 | 27 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 36 | 1 | 32 | 2 | -| | [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) | AIOps plugin maintained by ML team. | 45 | 0 | 27 | 1 | +| | [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) | AIOps plugin maintained by ML team. | 44 | 0 | 27 | 1 | | | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | - | 795 | 1 | 765 | 48 | | | [@elastic/apm-ui](https://github.com/orgs/elastic/teams/apm-ui) | The user interface for Elastic APM | 48 | 0 | 48 | 113 | | | [@elastic/infra-monitoring-ui](https://github.com/orgs/elastic/teams/infra-monitoring-ui) | Asset manager plugin for entity assets (inventory, topology, etc) | 3 | 0 | 3 | 0 | @@ -38,11 +38,11 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds Canvas application to Kibana | 9 | 0 | 8 | 3 | | | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | The Case management system in Kibana | 80 | 0 | 65 | 27 | | | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | - | 268 | 16 | 253 | 10 | -| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 54 | 0 | 12 | 0 | +| | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 65 | 0 | 15 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | Chat available on Elastic Cloud deployments for quicker assistance. | 3 | 0 | 2 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | This plugin exists as a workaround for using `cloudChat` plugin in plugins which can't have a direct dependency on security plugin. | 5 | 0 | 5 | 0 | | | [@elastic/platform-onboarding](https://github.com/orgs/elastic/teams/platform-onboarding) | Static migration page where self-managed users can see text/copy about migrating to Elastic Cloud | 8 | 1 | 8 | 1 | -| | [@elastic/sec-cloudnative-integrations](https://github.com/orgs/elastic/teams/sec-cloudnative-integrations) | Defend for containers (D4C) | 24 | 0 | 16 | 2 | +| | [@elastic/sec-cloudnative-integrations](https://github.com/orgs/elastic/teams/sec-cloudnative-integrations) | Defend for containers (D4C) | 52 | 0 | 43 | 2 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | Provides the necessary APIs to implement A/B testing scenarios, fetching the variations in configuration and reporting back metrics to track conversion rates of the experiments. | 12 | 0 | 0 | 0 | | cloudFullStory | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | When Kibana runs on Elastic Cloud, this plugin registers FullStory as a shipper for telemetry. | 0 | 0 | 0 | 0 | | cloudGainsight | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | When Kibana runs on Elastic Cloud, this plugin registers Gainsight as a shipper for telemetry. | 0 | 0 | 0 | 0 | @@ -56,7 +56,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/fleet](https://github.com/orgs/elastic/teams/fleet) | Add custom data integrations so they can be displayed in the Fleet integrations app | 271 | 0 | 252 | 1 | | | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds the Dashboard app to Kibana | 100 | 0 | 98 | 9 | | | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | - | 54 | 0 | 51 | 0 | -| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | 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. | 3291 | 119 | 2571 | 27 | +| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | 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. | 3293 | 119 | 2573 | 27 | | | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | This plugin provides the ability to create data views via a modal flyout inside Kibana apps | 16 | 0 | 7 | 0 | | | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | Reusable data view field editor across Kibana | 72 | 0 | 33 | 0 | | | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | Data view management app | 2 | 0 | 2 | 0 | @@ -67,14 +67,14 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | - | 37 | 0 | 35 | 2 | | discoverLogExplorer | [@elastic/infra-monitoring-ui](https://github.com/orgs/elastic/teams/infra-monitoring-ui) | This plugin exposes and registers Logs+ features. | 0 | 0 | 0 | 0 | | | [@elastic/security-threat-hunting-investigations](https://github.com/orgs/elastic/teams/security-threat-hunting-investigations) | APIs used to assess the quality of data in Elasticsearch indexes | 2 | 0 | 0 | 0 | -| | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds embeddables service to Kibana | 548 | 11 | 444 | 4 | +| | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds embeddables service to Kibana | 532 | 11 | 434 | 7 | | | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Extends embeddable plugin with more functionality | 14 | 0 | 14 | 0 | | | [@elastic/kibana-security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides encryption and decryption utilities for saved objects containing sensitive information. | 51 | 0 | 44 | 0 | | | [@elastic/enterprise-search-frontend](https://github.com/orgs/elastic/teams/enterprise-search-frontend) | Adds dashboards for discovering and managing Enterprise Search products. | 10 | 0 | 10 | 0 | | | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 115 | 3 | 111 | 3 | -| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | The Event Annotation service contains expressions for event annotations | 236 | 30 | 236 | 4 | +| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | The Event Annotation service contains expressions for event annotations | 192 | 30 | 192 | 2 | | | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | - | 116 | 0 | 116 | 11 | -| | [@elastic/uptime](https://github.com/orgs/elastic/teams/uptime) | - | 141 | 1 | 141 | 14 | +| | [@elastic/uptime](https://github.com/orgs/elastic/teams/uptime) | - | 131 | 1 | 131 | 14 | | | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds 'error' renderer to expressions | 17 | 0 | 15 | 2 | | | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Expression Gauge plugin adds a `gauge` renderer and function to the expression plugin. The renderer will display the `gauge` chart. | 59 | 0 | 59 | 2 | | | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Expression Heatmap plugin adds a `heatmap` renderer and function to the expression plugin. The renderer will display the `heatmap` chart. | 112 | 14 | 108 | 2 | @@ -94,7 +94,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-gis](https://github.com/orgs/elastic/teams/kibana-gis) | 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 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | File upload, download, sharing, and serving over HTTP implementation in Kibana. | 239 | 0 | 24 | 9 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Simple UI for managing files in Kibana | 2 | 1 | 2 | 0 | -| | [@elastic/fleet](https://github.com/orgs/elastic/teams/fleet) | - | 1179 | 3 | 1063 | 39 | +| | [@elastic/fleet](https://github.com/orgs/elastic/teams/fleet) | - | 1182 | 3 | 1066 | 40 | | ftrApis | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 0 | 0 | 0 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 68 | 0 | 14 | 5 | | globalSearchBar | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 0 | 0 | 0 | 0 | @@ -106,7 +106,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Image embeddable | 3 | 0 | 3 | 1 | | | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 4 | 0 | 4 | 0 | | | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 177 | 0 | 172 | 3 | -| | [@elastic/infra-monitoring-ui](https://github.com/orgs/elastic/teams/infra-monitoring-ui) | This plugin visualizes data from Filebeat and Metricbeat, and integrates with other Observability solutions | 44 | 0 | 41 | 11 | +| | [@elastic/infra-monitoring-ui](https://github.com/orgs/elastic/teams/infra-monitoring-ui) | This plugin visualizes data from Filebeat and Metricbeat, and integrates with other Observability solutions | 45 | 0 | 42 | 11 | | ingestPipelines | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 0 | 0 | 0 | 0 | | inputControlVis | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds Input Control visualization to Kibana | 0 | 0 | 0 | 0 | | | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | - | 123 | 2 | 96 | 4 | @@ -132,9 +132,9 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 34 | 0 | 34 | 2 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 17 | 0 | 17 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 2 | 0 | 2 | 1 | -| | [@elastic/actionable-observability](https://github.com/orgs/elastic/teams/actionable-observability) | - | 523 | 45 | 515 | 19 | +| | [@elastic/actionable-observability](https://github.com/orgs/elastic/teams/actionable-observability) | - | 516 | 45 | 508 | 19 | | | [@elastic/apm-ui](https://github.com/orgs/elastic/teams/apm-ui) | - | 7 | 0 | 7 | 0 | -| | [@elastic/observability-ui](https://github.com/orgs/elastic/teams/observability-ui) | - | 268 | 1 | 267 | 11 | +| | [@elastic/observability-ui](https://github.com/orgs/elastic/teams/observability-ui) | - | 277 | 1 | 276 | 11 | | | [@elastic/security-defend-workflows](https://github.com/orgs/elastic/teams/security-defend-workflows) | - | 24 | 0 | 24 | 7 | | painlessLab | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 0 | 0 | 0 | 0 | | | [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | The Presentation Utility Plugin is a set of common, shared components and toolkits for solutions within the Presentation space, (e.g. Dashboards, Canvas). | 218 | 8 | 164 | 11 | @@ -178,7 +178,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/security-threat-hunting-investigations](https://github.com/orgs/elastic/teams/security-threat-hunting-investigations) | - | 257 | 1 | 213 | 22 | | | [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) | This plugin provides access to the transforms features provided by Elastic. Transforms enable you to convert existing Elasticsearch indices into summarized indices, which provide opportunities for new insights and analytics. | 4 | 0 | 4 | 1 | | translations | [@elastic/kibana-localization](https://github.com/orgs/elastic/teams/kibana-localization) | - | 0 | 0 | 0 | 0 | -| | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | - | 560 | 11 | 534 | 50 | +| | [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) | - | 564 | 12 | 538 | 50 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Adds UI Actions service to Kibana | 144 | 2 | 102 | 9 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | Extends UI Actions plugin with more functionality | 206 | 0 | 140 | 9 | | | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | The `unifiedHistogram` plugin provides UI components to create a layout including a resizable histogram and a main display. | 53 | 0 | 23 | 2 | @@ -202,7 +202,6 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Registers the vega visualization. Is the elastic version of vega and vega-lite libraries. | 2 | 0 | 2 | 0 | | | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Contains the vislib visualizations. These are the classical area/line/bar, gauge/goal and heatmap charts. We want to replace them with elastic-charts. | 1 | 0 | 1 | 0 | | | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | 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. | 52 | 0 | 50 | 5 | -| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | - | 154 | 1 | 150 | 4 | | | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | Contains the shared architecture among all the legacy visualizations, e.g. the visualization type registry or the visualization embeddable. | 823 | 12 | 793 | 19 | | watcher | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 0 | 0 | 0 | 0 | @@ -245,7 +244,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 6 | 0 | 4 | 4 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 14 | 0 | 14 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 9 | 0 | 9 | 0 | -| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 58 | 0 | 41 | 4 | +| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 58 | 0 | 40 | 4 | | | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | - | 180 | 1 | 115 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 4 | 0 | 0 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 7 | 0 | 7 | 1 | @@ -268,7 +267,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 5 | 0 | 0 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 16 | 0 | 7 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 6 | 0 | 6 | 0 | -| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 166 | 0 | 67 | 0 | +| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 166 | 0 | 66 | 1 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 3 | 0 | 3 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 4 | 0 | 4 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 8 | 0 | 8 | 0 | @@ -423,19 +422,22 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 101 | 0 | 85 | 0 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 15 | 0 | 9 | 0 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 27 | 2 | 24 | 0 | +| | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | - | 9 | 0 | 1 | 2 | | | [@elastic/docs](https://github.com/orgs/elastic/teams/docs) | - | 72 | 0 | 72 | 2 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 1 | 0 | 1 | 0 | | | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | - | 39 | 0 | 26 | 5 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 19 | 0 | 11 | 0 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 35125 | 0 | 34718 | 0 | | | [@elastic/security-threat-hunting-investigations](https://github.com/orgs/elastic/teams/security-threat-hunting-investigations) | - | 13 | 2 | 5 | 0 | -| | [@elastic/security-solution](https://github.com/orgs/elastic/teams/security-solution) | - | 84 | 4 | 65 | 3 | +| | [@elastic/security-solution](https://github.com/orgs/elastic/teams/security-solution) | - | 64 | 2 | 45 | 3 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 4 | 0 | 4 | 0 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 27 | 0 | 14 | 1 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 7 | 0 | 3 | 0 | -| | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | - | 255 | 1 | 197 | 15 | +| | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | - | 253 | 1 | 194 | 15 | | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 12 | 0 | 12 | 0 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 2 | 0 | 1 | 0 | +| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | - | 39 | 1 | 39 | 0 | +| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | - | 65 | 1 | 65 | 1 | | | [@elastic/security-threat-hunting-investigations](https://github.com/orgs/elastic/teams/security-threat-hunting-investigations) | - | 33 | 0 | 13 | 3 | | | [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | - | 20 | 0 | 16 | 0 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 2 | 0 | 0 | 0 | @@ -466,10 +468,11 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 6 | 0 | 1 | 1 | | | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 10 | 0 | 10 | 1 | | | [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) | - | 2 | 0 | 0 | 0 | -| | [@elastic/kibana-gis](https://github.com/orgs/elastic/teams/kibana-gis) | - | 535 | 1 | 1 | 0 | +| | [@elastic/kibana-gis](https://github.com/orgs/elastic/teams/kibana-gis) | - | 582 | 1 | 1 | 0 | | | [@elastic/kibana-gis](https://github.com/orgs/elastic/teams/kibana-gis) | - | 2 | 0 | 2 | 0 | | | [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) | - | 96 | 2 | 61 | 0 | | | [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) | - | 206 | 3 | 1 | 0 | +| | [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) | - | 32 | 0 | 0 | 0 | | | [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) | - | 152 | 1 | 0 | 0 | | | [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) | - | 141 | 0 | 5 | 0 | | | [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) | - | 52 | 0 | 4 | 0 | @@ -540,7 +543,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 28 | 0 | 10 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 10 | 0 | 4 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 32 | 0 | 28 | 0 | -| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 45 | 0 | 36 | 4 | +| | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 46 | 0 | 37 | 4 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 5 | 0 | 4 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 3 | 0 | 2 | 0 | | | [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) | - | 2 | 0 | 2 | 0 | @@ -594,5 +597,6 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) | - | 36 | 0 | 15 | 1 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 2 | 0 | 2 | 0 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 24 | 0 | 14 | 0 | +| | [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) | - | 155 | 1 | 151 | 3 | | | [@elastic/kibana-operations](https://github.com/orgs/elastic/teams/kibana-operations) | - | 6 | 0 | 2 | 0 | diff --git a/api_docs/presentation_util.mdx b/api_docs/presentation_util.mdx index 49f0c03deeef3..2d7ff21f6e512 100644 --- a/api_docs/presentation_util.mdx +++ b/api_docs/presentation_util.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/presentationUtil title: "presentationUtil" image: https://source.unsplash.com/400x175/?github description: API docs for the presentationUtil plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'presentationUtil'] --- import presentationUtilObj from './presentation_util.devdocs.json'; diff --git a/api_docs/profiling.mdx b/api_docs/profiling.mdx index c8405b2fe7624..1e77bebe960d7 100644 --- a/api_docs/profiling.mdx +++ b/api_docs/profiling.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/profiling title: "profiling" image: https://source.unsplash.com/400x175/?github description: API docs for the profiling plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'profiling'] --- import profilingObj from './profiling.devdocs.json'; diff --git a/api_docs/remote_clusters.mdx b/api_docs/remote_clusters.mdx index 061a36c113752..84220a9b28dcb 100644 --- a/api_docs/remote_clusters.mdx +++ b/api_docs/remote_clusters.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/remoteClusters title: "remoteClusters" image: https://source.unsplash.com/400x175/?github description: API docs for the remoteClusters plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'remoteClusters'] --- import remoteClustersObj from './remote_clusters.devdocs.json'; diff --git a/api_docs/reporting.mdx b/api_docs/reporting.mdx index dddc7f18da556..44266c6dca1c8 100644 --- a/api_docs/reporting.mdx +++ b/api_docs/reporting.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/reporting title: "reporting" image: https://source.unsplash.com/400x175/?github description: API docs for the reporting plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'reporting'] --- import reportingObj from './reporting.devdocs.json'; diff --git a/api_docs/reporting_export_types.mdx b/api_docs/reporting_export_types.mdx index 16234f5dcfed5..a22150684d38b 100644 --- a/api_docs/reporting_export_types.mdx +++ b/api_docs/reporting_export_types.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/reportingExportTypes title: "reportingExportTypes" image: https://source.unsplash.com/400x175/?github description: API docs for the reportingExportTypes plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'reportingExportTypes'] --- import reportingExportTypesObj from './reporting_export_types.devdocs.json'; diff --git a/api_docs/rollup.mdx b/api_docs/rollup.mdx index 0a3db73eafdf9..4053c8e3d8edd 100644 --- a/api_docs/rollup.mdx +++ b/api_docs/rollup.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/rollup title: "rollup" image: https://source.unsplash.com/400x175/?github description: API docs for the rollup plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'rollup'] --- import rollupObj from './rollup.devdocs.json'; diff --git a/api_docs/rule_registry.mdx b/api_docs/rule_registry.mdx index 61515ec3d047e..2bfdef4810544 100644 --- a/api_docs/rule_registry.mdx +++ b/api_docs/rule_registry.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/ruleRegistry title: "ruleRegistry" image: https://source.unsplash.com/400x175/?github description: API docs for the ruleRegistry plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ruleRegistry'] --- import ruleRegistryObj from './rule_registry.devdocs.json'; diff --git a/api_docs/runtime_fields.mdx b/api_docs/runtime_fields.mdx index 2342963090b61..0ceb2ed5f643a 100644 --- a/api_docs/runtime_fields.mdx +++ b/api_docs/runtime_fields.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/runtimeFields title: "runtimeFields" image: https://source.unsplash.com/400x175/?github description: API docs for the runtimeFields plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'runtimeFields'] --- import runtimeFieldsObj from './runtime_fields.devdocs.json'; diff --git a/api_docs/saved_objects.mdx b/api_docs/saved_objects.mdx index 03793085a0211..6062652e91ccb 100644 --- a/api_docs/saved_objects.mdx +++ b/api_docs/saved_objects.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/savedObjects title: "savedObjects" image: https://source.unsplash.com/400x175/?github description: API docs for the savedObjects plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjects'] --- import savedObjectsObj from './saved_objects.devdocs.json'; diff --git a/api_docs/saved_objects_finder.mdx b/api_docs/saved_objects_finder.mdx index 4f598934611c0..c82076ea87209 100644 --- a/api_docs/saved_objects_finder.mdx +++ b/api_docs/saved_objects_finder.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/savedObjectsFinder title: "savedObjectsFinder" image: https://source.unsplash.com/400x175/?github description: API docs for the savedObjectsFinder plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsFinder'] --- import savedObjectsFinderObj from './saved_objects_finder.devdocs.json'; diff --git a/api_docs/saved_objects_management.mdx b/api_docs/saved_objects_management.mdx index 223c08a8743e6..dbea8ea138f69 100644 --- a/api_docs/saved_objects_management.mdx +++ b/api_docs/saved_objects_management.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/savedObjectsManagement title: "savedObjectsManagement" image: https://source.unsplash.com/400x175/?github description: API docs for the savedObjectsManagement plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsManagement'] --- import savedObjectsManagementObj from './saved_objects_management.devdocs.json'; diff --git a/api_docs/saved_objects_tagging.mdx b/api_docs/saved_objects_tagging.mdx index e6407d095fc21..4be605a52252f 100644 --- a/api_docs/saved_objects_tagging.mdx +++ b/api_docs/saved_objects_tagging.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/savedObjectsTagging title: "savedObjectsTagging" image: https://source.unsplash.com/400x175/?github description: API docs for the savedObjectsTagging plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsTagging'] --- import savedObjectsTaggingObj from './saved_objects_tagging.devdocs.json'; diff --git a/api_docs/saved_objects_tagging_oss.mdx b/api_docs/saved_objects_tagging_oss.mdx index d1897434ad5c0..8db985683a5c4 100644 --- a/api_docs/saved_objects_tagging_oss.mdx +++ b/api_docs/saved_objects_tagging_oss.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/savedObjectsTaggingOss title: "savedObjectsTaggingOss" image: https://source.unsplash.com/400x175/?github description: API docs for the savedObjectsTaggingOss plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsTaggingOss'] --- import savedObjectsTaggingOssObj from './saved_objects_tagging_oss.devdocs.json'; diff --git a/api_docs/saved_search.mdx b/api_docs/saved_search.mdx index ac1c308212638..d3fcb334b8934 100644 --- a/api_docs/saved_search.mdx +++ b/api_docs/saved_search.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/savedSearch title: "savedSearch" image: https://source.unsplash.com/400x175/?github description: API docs for the savedSearch plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedSearch'] --- import savedSearchObj from './saved_search.devdocs.json'; diff --git a/api_docs/screenshot_mode.mdx b/api_docs/screenshot_mode.mdx index 5032c2b053104..d98b56558b78e 100644 --- a/api_docs/screenshot_mode.mdx +++ b/api_docs/screenshot_mode.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/screenshotMode title: "screenshotMode" image: https://source.unsplash.com/400x175/?github description: API docs for the screenshotMode plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'screenshotMode'] --- import screenshotModeObj from './screenshot_mode.devdocs.json'; diff --git a/api_docs/screenshotting.mdx b/api_docs/screenshotting.mdx index 4b818560f503b..21a1b74bb5fe4 100644 --- a/api_docs/screenshotting.mdx +++ b/api_docs/screenshotting.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/screenshotting title: "screenshotting" image: https://source.unsplash.com/400x175/?github description: API docs for the screenshotting plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'screenshotting'] --- import screenshottingObj from './screenshotting.devdocs.json'; diff --git a/api_docs/security.mdx b/api_docs/security.mdx index 3c50b8d179486..312a695c28aa7 100644 --- a/api_docs/security.mdx +++ b/api_docs/security.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/security title: "security" image: https://source.unsplash.com/400x175/?github description: API docs for the security plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'security'] --- import securityObj from './security.devdocs.json'; diff --git a/api_docs/security_solution.mdx b/api_docs/security_solution.mdx index 77d36124df657..2f6e66c75d6f8 100644 --- a/api_docs/security_solution.mdx +++ b/api_docs/security_solution.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/securitySolution title: "securitySolution" image: https://source.unsplash.com/400x175/?github description: API docs for the securitySolution plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'securitySolution'] --- import securitySolutionObj from './security_solution.devdocs.json'; diff --git a/api_docs/security_solution_ess.mdx b/api_docs/security_solution_ess.mdx index 1b7fce653f9f7..452ce18f81f83 100644 --- a/api_docs/security_solution_ess.mdx +++ b/api_docs/security_solution_ess.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/securitySolutionEss title: "securitySolutionEss" image: https://source.unsplash.com/400x175/?github description: API docs for the securitySolutionEss plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'securitySolutionEss'] --- import securitySolutionEssObj from './security_solution_ess.devdocs.json'; diff --git a/api_docs/security_solution_serverless.mdx b/api_docs/security_solution_serverless.mdx index c9337918d58a6..4c247713e490a 100644 --- a/api_docs/security_solution_serverless.mdx +++ b/api_docs/security_solution_serverless.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/securitySolutionServerless title: "securitySolutionServerless" image: https://source.unsplash.com/400x175/?github description: API docs for the securitySolutionServerless plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'securitySolutionServerless'] --- import securitySolutionServerlessObj from './security_solution_serverless.devdocs.json'; diff --git a/api_docs/serverless.mdx b/api_docs/serverless.mdx index d40fc8030bf48..3ac3c8ed23187 100644 --- a/api_docs/serverless.mdx +++ b/api_docs/serverless.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/serverless title: "serverless" image: https://source.unsplash.com/400x175/?github description: API docs for the serverless plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'serverless'] --- import serverlessObj from './serverless.devdocs.json'; diff --git a/api_docs/serverless_observability.mdx b/api_docs/serverless_observability.mdx index d82d3853bce7e..763875d170af3 100644 --- a/api_docs/serverless_observability.mdx +++ b/api_docs/serverless_observability.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/serverlessObservability title: "serverlessObservability" image: https://source.unsplash.com/400x175/?github description: API docs for the serverlessObservability plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'serverlessObservability'] --- import serverlessObservabilityObj from './serverless_observability.devdocs.json'; diff --git a/api_docs/serverless_search.mdx b/api_docs/serverless_search.mdx index a12f9ba939189..298c1299770f8 100644 --- a/api_docs/serverless_search.mdx +++ b/api_docs/serverless_search.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/serverlessSearch title: "serverlessSearch" image: https://source.unsplash.com/400x175/?github description: API docs for the serverlessSearch plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'serverlessSearch'] --- import serverlessSearchObj from './serverless_search.devdocs.json'; diff --git a/api_docs/session_view.mdx b/api_docs/session_view.mdx index b6ca98f304703..c275016181a80 100644 --- a/api_docs/session_view.mdx +++ b/api_docs/session_view.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/sessionView title: "sessionView" image: https://source.unsplash.com/400x175/?github description: API docs for the sessionView plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'sessionView'] --- import sessionViewObj from './session_view.devdocs.json'; diff --git a/api_docs/share.mdx b/api_docs/share.mdx index fb892b7ebdfc9..e933f8ca75921 100644 --- a/api_docs/share.mdx +++ b/api_docs/share.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/share title: "share" image: https://source.unsplash.com/400x175/?github description: API docs for the share plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'share'] --- import shareObj from './share.devdocs.json'; diff --git a/api_docs/snapshot_restore.mdx b/api_docs/snapshot_restore.mdx index 42591a87924c2..aabb8ea5887ee 100644 --- a/api_docs/snapshot_restore.mdx +++ b/api_docs/snapshot_restore.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/snapshotRestore title: "snapshotRestore" image: https://source.unsplash.com/400x175/?github description: API docs for the snapshotRestore plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'snapshotRestore'] --- import snapshotRestoreObj from './snapshot_restore.devdocs.json'; diff --git a/api_docs/spaces.mdx b/api_docs/spaces.mdx index 2c94c5d9f6563..1a30b6282968f 100644 --- a/api_docs/spaces.mdx +++ b/api_docs/spaces.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/spaces title: "spaces" image: https://source.unsplash.com/400x175/?github description: API docs for the spaces plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'spaces'] --- import spacesObj from './spaces.devdocs.json'; diff --git a/api_docs/stack_alerts.mdx b/api_docs/stack_alerts.mdx index c213ec844b5c6..93536551ce2ab 100644 --- a/api_docs/stack_alerts.mdx +++ b/api_docs/stack_alerts.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/stackAlerts title: "stackAlerts" image: https://source.unsplash.com/400x175/?github description: API docs for the stackAlerts plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'stackAlerts'] --- import stackAlertsObj from './stack_alerts.devdocs.json'; diff --git a/api_docs/stack_connectors.mdx b/api_docs/stack_connectors.mdx index 8c57463b3e055..f2257b6f8e17b 100644 --- a/api_docs/stack_connectors.mdx +++ b/api_docs/stack_connectors.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/stackConnectors title: "stackConnectors" image: https://source.unsplash.com/400x175/?github description: API docs for the stackConnectors plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'stackConnectors'] --- import stackConnectorsObj from './stack_connectors.devdocs.json'; diff --git a/api_docs/task_manager.mdx b/api_docs/task_manager.mdx index 061c24ef96aab..099ee933bde54 100644 --- a/api_docs/task_manager.mdx +++ b/api_docs/task_manager.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/taskManager title: "taskManager" image: https://source.unsplash.com/400x175/?github description: API docs for the taskManager plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'taskManager'] --- import taskManagerObj from './task_manager.devdocs.json'; diff --git a/api_docs/telemetry.mdx b/api_docs/telemetry.mdx index 3f2282a2ffdfb..7eaf2ad48d571 100644 --- a/api_docs/telemetry.mdx +++ b/api_docs/telemetry.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/telemetry title: "telemetry" image: https://source.unsplash.com/400x175/?github description: API docs for the telemetry plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetry'] --- import telemetryObj from './telemetry.devdocs.json'; diff --git a/api_docs/telemetry_collection_manager.mdx b/api_docs/telemetry_collection_manager.mdx index 49e31055ef1a5..7fe459235710b 100644 --- a/api_docs/telemetry_collection_manager.mdx +++ b/api_docs/telemetry_collection_manager.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/telemetryCollectionManager title: "telemetryCollectionManager" image: https://source.unsplash.com/400x175/?github description: API docs for the telemetryCollectionManager plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryCollectionManager'] --- import telemetryCollectionManagerObj from './telemetry_collection_manager.devdocs.json'; diff --git a/api_docs/telemetry_collection_xpack.mdx b/api_docs/telemetry_collection_xpack.mdx index 2b84aa0283f5c..b9a3708c4a10f 100644 --- a/api_docs/telemetry_collection_xpack.mdx +++ b/api_docs/telemetry_collection_xpack.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/telemetryCollectionXpack title: "telemetryCollectionXpack" image: https://source.unsplash.com/400x175/?github description: API docs for the telemetryCollectionXpack plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryCollectionXpack'] --- import telemetryCollectionXpackObj from './telemetry_collection_xpack.devdocs.json'; diff --git a/api_docs/telemetry_management_section.mdx b/api_docs/telemetry_management_section.mdx index fb01126495d91..f6fe38def6032 100644 --- a/api_docs/telemetry_management_section.mdx +++ b/api_docs/telemetry_management_section.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/telemetryManagementSection title: "telemetryManagementSection" image: https://source.unsplash.com/400x175/?github description: API docs for the telemetryManagementSection plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryManagementSection'] --- import telemetryManagementSectionObj from './telemetry_management_section.devdocs.json'; diff --git a/api_docs/text_based_languages.mdx b/api_docs/text_based_languages.mdx index bcadda5438b28..f3670b9d4fa99 100644 --- a/api_docs/text_based_languages.mdx +++ b/api_docs/text_based_languages.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/textBasedLanguages title: "textBasedLanguages" image: https://source.unsplash.com/400x175/?github description: API docs for the textBasedLanguages plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'textBasedLanguages'] --- import textBasedLanguagesObj from './text_based_languages.devdocs.json'; diff --git a/api_docs/threat_intelligence.mdx b/api_docs/threat_intelligence.mdx index 12787cbd4c58d..18e49781c4370 100644 --- a/api_docs/threat_intelligence.mdx +++ b/api_docs/threat_intelligence.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/threatIntelligence title: "threatIntelligence" image: https://source.unsplash.com/400x175/?github description: API docs for the threatIntelligence plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'threatIntelligence'] --- import threatIntelligenceObj from './threat_intelligence.devdocs.json'; diff --git a/api_docs/timelines.mdx b/api_docs/timelines.mdx index 973b24abe99c0..e594f8fc330c3 100644 --- a/api_docs/timelines.mdx +++ b/api_docs/timelines.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/timelines title: "timelines" image: https://source.unsplash.com/400x175/?github description: API docs for the timelines plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'timelines'] --- import timelinesObj from './timelines.devdocs.json'; diff --git a/api_docs/transform.mdx b/api_docs/transform.mdx index e4c4abf691016..67a232ae7a588 100644 --- a/api_docs/transform.mdx +++ b/api_docs/transform.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/transform title: "transform" image: https://source.unsplash.com/400x175/?github description: API docs for the transform plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'transform'] --- import transformObj from './transform.devdocs.json'; diff --git a/api_docs/triggers_actions_ui.devdocs.json b/api_docs/triggers_actions_ui.devdocs.json index 1d182a1424ca6..0889848a320e7 100644 --- a/api_docs/triggers_actions_ui.devdocs.json +++ b/api_docs/triggers_actions_ui.devdocs.json @@ -6859,6 +6859,64 @@ "trackAdoption": false } ] + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.builtInComparators.COMPARATORS.NOT_BETWEEN", + "type": "Object", + "tags": [], + "label": "[COMPARATORS.NOT_BETWEEN]", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.builtInComparators.COMPARATORS.NOT_BETWEEN.text", + "type": "Any", + "tags": [], + "label": "text", + "description": [], + "signature": [ + "any" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.builtInComparators.COMPARATORS.NOT_BETWEEN.value", + "type": "Enum", + "tags": [], + "label": "value", + "description": [], + "signature": [ + { + "pluginId": "triggersActionsUi", + "scope": "public", + "docId": "kibTriggersActionsUiPluginApi", + "section": "def-public.COMPARATORS", + "text": "COMPARATORS" + } + ], + "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.builtInComparators.COMPARATORS.NOT_BETWEEN.requiredValues", + "type": "number", + "tags": [], + "label": "requiredValues", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/comparators.ts", + "deprecated": false, + "trackAdoption": false + } + ] } ], "initialIsOpen": false diff --git a/api_docs/triggers_actions_ui.mdx b/api_docs/triggers_actions_ui.mdx index 1792595ad4f40..d6a5c67e3c4f0 100644 --- a/api_docs/triggers_actions_ui.mdx +++ b/api_docs/triggers_actions_ui.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/triggersActionsUi title: "triggersActionsUi" image: https://source.unsplash.com/400x175/?github description: API docs for the triggersActionsUi plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'triggersActionsUi'] --- import triggersActionsUiObj from './triggers_actions_ui.devdocs.json'; @@ -21,7 +21,7 @@ Contact [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-o | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 560 | 11 | 534 | 50 | +| 564 | 12 | 538 | 50 | ## Client diff --git a/api_docs/ui_actions.mdx b/api_docs/ui_actions.mdx index dce96e9772ddd..926ddadae97f7 100644 --- a/api_docs/ui_actions.mdx +++ b/api_docs/ui_actions.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/uiActions title: "uiActions" image: https://source.unsplash.com/400x175/?github description: API docs for the uiActions plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'uiActions'] --- import uiActionsObj from './ui_actions.devdocs.json'; diff --git a/api_docs/ui_actions_enhanced.mdx b/api_docs/ui_actions_enhanced.mdx index 17921994ae1bb..c58d4911795d4 100644 --- a/api_docs/ui_actions_enhanced.mdx +++ b/api_docs/ui_actions_enhanced.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/uiActionsEnhanced title: "uiActionsEnhanced" image: https://source.unsplash.com/400x175/?github description: API docs for the uiActionsEnhanced plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'uiActionsEnhanced'] --- import uiActionsEnhancedObj from './ui_actions_enhanced.devdocs.json'; diff --git a/api_docs/unified_histogram.mdx b/api_docs/unified_histogram.mdx index 9e5b5727e1bf2..1b56aef96f138 100644 --- a/api_docs/unified_histogram.mdx +++ b/api_docs/unified_histogram.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/unifiedHistogram title: "unifiedHistogram" image: https://source.unsplash.com/400x175/?github description: API docs for the unifiedHistogram plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedHistogram'] --- import unifiedHistogramObj from './unified_histogram.devdocs.json'; diff --git a/api_docs/unified_search.mdx b/api_docs/unified_search.mdx index 3e9167cd28b7f..f47403e972beb 100644 --- a/api_docs/unified_search.mdx +++ b/api_docs/unified_search.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/unifiedSearch title: "unifiedSearch" image: https://source.unsplash.com/400x175/?github description: API docs for the unifiedSearch plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedSearch'] --- import unifiedSearchObj from './unified_search.devdocs.json'; diff --git a/api_docs/unified_search_autocomplete.mdx b/api_docs/unified_search_autocomplete.mdx index 8017ee0e95482..c888832408f76 100644 --- a/api_docs/unified_search_autocomplete.mdx +++ b/api_docs/unified_search_autocomplete.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/unifiedSearch-autocomplete title: "unifiedSearch.autocomplete" image: https://source.unsplash.com/400x175/?github description: API docs for the unifiedSearch.autocomplete plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedSearch.autocomplete'] --- import unifiedSearchAutocompleteObj from './unified_search_autocomplete.devdocs.json'; diff --git a/api_docs/url_forwarding.mdx b/api_docs/url_forwarding.mdx index 8b100c53b3ff9..99a95c26ec796 100644 --- a/api_docs/url_forwarding.mdx +++ b/api_docs/url_forwarding.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/urlForwarding title: "urlForwarding" image: https://source.unsplash.com/400x175/?github description: API docs for the urlForwarding plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'urlForwarding'] --- import urlForwardingObj from './url_forwarding.devdocs.json'; diff --git a/api_docs/usage_collection.mdx b/api_docs/usage_collection.mdx index dedf029870088..c5e2a37ed01f5 100644 --- a/api_docs/usage_collection.mdx +++ b/api_docs/usage_collection.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/usageCollection title: "usageCollection" image: https://source.unsplash.com/400x175/?github description: API docs for the usageCollection plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'usageCollection'] --- import usageCollectionObj from './usage_collection.devdocs.json'; diff --git a/api_docs/ux.mdx b/api_docs/ux.mdx index 2e99c7ee0c07d..ccbf0ecce63d4 100644 --- a/api_docs/ux.mdx +++ b/api_docs/ux.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/ux title: "ux" image: https://source.unsplash.com/400x175/?github description: API docs for the ux plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ux'] --- import uxObj from './ux.devdocs.json'; diff --git a/api_docs/vis_default_editor.mdx b/api_docs/vis_default_editor.mdx index c0c55190c4e05..550a371c76924 100644 --- a/api_docs/vis_default_editor.mdx +++ b/api_docs/vis_default_editor.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visDefaultEditor title: "visDefaultEditor" image: https://source.unsplash.com/400x175/?github description: API docs for the visDefaultEditor plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visDefaultEditor'] --- import visDefaultEditorObj from './vis_default_editor.devdocs.json'; diff --git a/api_docs/vis_type_gauge.mdx b/api_docs/vis_type_gauge.mdx index cbfcac5112433..a26f391d2d7eb 100644 --- a/api_docs/vis_type_gauge.mdx +++ b/api_docs/vis_type_gauge.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeGauge title: "visTypeGauge" image: https://source.unsplash.com/400x175/?github description: API docs for the visTypeGauge plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeGauge'] --- import visTypeGaugeObj from './vis_type_gauge.devdocs.json'; diff --git a/api_docs/vis_type_heatmap.mdx b/api_docs/vis_type_heatmap.mdx index df168319a6c13..f903192a7804f 100644 --- a/api_docs/vis_type_heatmap.mdx +++ b/api_docs/vis_type_heatmap.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeHeatmap title: "visTypeHeatmap" image: https://source.unsplash.com/400x175/?github description: API docs for the visTypeHeatmap plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeHeatmap'] --- import visTypeHeatmapObj from './vis_type_heatmap.devdocs.json'; diff --git a/api_docs/vis_type_pie.mdx b/api_docs/vis_type_pie.mdx index 73460fcfec095..ce19b6e4beca5 100644 --- a/api_docs/vis_type_pie.mdx +++ b/api_docs/vis_type_pie.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypePie title: "visTypePie" image: https://source.unsplash.com/400x175/?github description: API docs for the visTypePie plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypePie'] --- import visTypePieObj from './vis_type_pie.devdocs.json'; diff --git a/api_docs/vis_type_table.mdx b/api_docs/vis_type_table.mdx index 386fa54ce0052..c7c10be5c2201 100644 --- a/api_docs/vis_type_table.mdx +++ b/api_docs/vis_type_table.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeTable title: "visTypeTable" image: https://source.unsplash.com/400x175/?github description: API docs for the visTypeTable plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeTable'] --- import visTypeTableObj from './vis_type_table.devdocs.json'; diff --git a/api_docs/vis_type_timelion.mdx b/api_docs/vis_type_timelion.mdx index ab870cd028706..6fb866e1ecab4 100644 --- a/api_docs/vis_type_timelion.mdx +++ b/api_docs/vis_type_timelion.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeTimelion title: "visTypeTimelion" image: https://source.unsplash.com/400x175/?github description: API docs for the visTypeTimelion plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeTimelion'] --- import visTypeTimelionObj from './vis_type_timelion.devdocs.json'; diff --git a/api_docs/vis_type_timeseries.mdx b/api_docs/vis_type_timeseries.mdx index e023f80fd1104..59d9c0dd03365 100644 --- a/api_docs/vis_type_timeseries.mdx +++ b/api_docs/vis_type_timeseries.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeTimeseries title: "visTypeTimeseries" image: https://source.unsplash.com/400x175/?github description: API docs for the visTypeTimeseries plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeTimeseries'] --- import visTypeTimeseriesObj from './vis_type_timeseries.devdocs.json'; diff --git a/api_docs/vis_type_vega.mdx b/api_docs/vis_type_vega.mdx index 19138351e80eb..85ce363acea15 100644 --- a/api_docs/vis_type_vega.mdx +++ b/api_docs/vis_type_vega.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeVega title: "visTypeVega" image: https://source.unsplash.com/400x175/?github description: API docs for the visTypeVega plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeVega'] --- import visTypeVegaObj from './vis_type_vega.devdocs.json'; diff --git a/api_docs/vis_type_vislib.mdx b/api_docs/vis_type_vislib.mdx index c7fb5de6aa6f0..46277e045d32d 100644 --- a/api_docs/vis_type_vislib.mdx +++ b/api_docs/vis_type_vislib.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeVislib title: "visTypeVislib" image: https://source.unsplash.com/400x175/?github description: API docs for the visTypeVislib plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeVislib'] --- import visTypeVislibObj from './vis_type_vislib.devdocs.json'; diff --git a/api_docs/vis_type_xy.mdx b/api_docs/vis_type_xy.mdx index 3680e6bab24c7..76bce6b70dd2a 100644 --- a/api_docs/vis_type_xy.mdx +++ b/api_docs/vis_type_xy.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visTypeXy title: "visTypeXy" image: https://source.unsplash.com/400x175/?github description: API docs for the visTypeXy plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeXy'] --- import visTypeXyObj from './vis_type_xy.devdocs.json'; diff --git a/api_docs/visualization_ui_components.mdx b/api_docs/visualization_ui_components.mdx deleted file mode 100644 index ec276480b309e..0000000000000 --- a/api_docs/visualization_ui_components.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -#### -#### 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. -#### -id: kibVisualizationUiComponentsPluginApi -slug: /kibana-dev-docs/api/visualizationUiComponents -title: "visualizationUiComponents" -image: https://source.unsplash.com/400x175/?github -description: API docs for the visualizationUiComponents plugin -date: 2023-07-13 -tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visualizationUiComponents'] ---- -import visualizationUiComponentsObj from './visualization_ui_components.devdocs.json'; - - - -Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) for questions regarding this plugin. - -**Code health stats** - -| Public API count | Any count | Items lacking comments | Missing exports | -|-------------------|-----------|------------------------|-----------------| -| 154 | 1 | 150 | 4 | - -## Client - -### Functions - - -### Interfaces - - -### Consts, variables and types - - diff --git a/api_docs/visualizations.devdocs.json b/api_docs/visualizations.devdocs.json index 75d59826bdfbe..8a706378ff23e 100644 --- a/api_docs/visualizations.devdocs.json +++ b/api_docs/visualizations.devdocs.json @@ -6390,7 +6390,15 @@ "section": "def-public.VisualizeInput", "text": "VisualizeInput" }, - ">) => void; render: (domNode: HTMLElement) => Promise; getFilters: () => Promise<", + ">) => void; openInspector: () => ", + { + "pluginId": "@kbn/core-mount-utils-browser", + "scope": "common", + "docId": "kibKbnCoreMountUtilsBrowserPluginApi", + "section": "def-common.OverlayRef", + "text": "OverlayRef" + }, + " | undefined; render: (domNode: HTMLElement) => Promise; getFilters: () => Promise<", { "pluginId": "@kbn/es-query", "scope": "common", @@ -6422,14 +6430,6 @@ "section": "def-common.Adapters", "text": "Adapters" }, - " | undefined; openInspector: () => ", - { - "pluginId": "@kbn/core-mount-utils-browser", - "scope": "common", - "docId": "kibKbnCoreMountUtilsBrowserPluginApi", - "section": "def-common.OverlayRef", - "text": "OverlayRef" - }, " | undefined; transferCustomizationsToUiState: () => void; hasInspector: () => boolean; onContainerLoading: () => void; onContainerData: () => void; onContainerRender: () => void; onContainerError: (error: ", { "pluginId": "expressions", diff --git a/api_docs/visualizations.mdx b/api_docs/visualizations.mdx index 12793958e55cc..6690c4990f69f 100644 --- a/api_docs/visualizations.mdx +++ b/api_docs/visualizations.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/visualizations title: "visualizations" image: https://source.unsplash.com/400x175/?github description: API docs for the visualizations plugin -date: 2023-07-13 +date: 2023-07-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visualizations'] --- import visualizationsObj from './visualizations.devdocs.json'; diff --git a/config/serverless.es.yml b/config/serverless.es.yml index c8f1e8afa7914..5433ce9be7676 100644 --- a/config/serverless.es.yml +++ b/config/serverless.es.yml @@ -2,8 +2,15 @@ ## Disable APM and Uptime, enable Enterprise Search xpack.apm.enabled: false + +xpack.cloudSecurityPosture.enabled: false +xpack.infra.enabled: false +xpack.observability.enabled: false +xpack.securitySolution.enabled: false +xpack.serverless.observability.enabled: false xpack.uptime.enabled: false enterpriseSearch.enabled: false +monitoring.ui.enabled: false ## Enable the Serverless Search plugin xpack.serverless.search.enabled: true @@ -16,3 +23,6 @@ xpack.serverless.plugin.developer.projectSwitcher.currentType: 'search' # Specify in telemetry the project type telemetry.labels.serverless: search + +# Alerts config +xpack.actions.enabledActionTypes: ['.email', '.index', '.slack', '.jira', '.webhook', '.teams'] diff --git a/config/serverless.oblt.yml b/config/serverless.oblt.yml index 9f34fb10898a6..2928e75095897 100644 --- a/config/serverless.oblt.yml +++ b/config/serverless.oblt.yml @@ -35,6 +35,7 @@ xpack.apm.featureFlags.infraUiAvailable: false xpack.apm.featureFlags.migrationToFleetAvailable: false xpack.apm.featureFlags.sourcemapApiAvailable: false xpack.apm.featureFlags.storageExplorerAvailable: false +xpack.apm.featureFlags.fastRefreshAvailable: true # Specify in telemetry the project type telemetry.labels.serverless: observability diff --git a/config/serverless.yml b/config/serverless.yml index ea2d93a5d3c48..8167ee5a42f4f 100644 --- a/config/serverless.yml +++ b/config/serverless.yml @@ -10,9 +10,6 @@ xpack.fleet.internal.activeAgentsSoftLimit: 25000 # Cloud links xpack.cloud.base_url: "https://cloud.elastic.co" -xpack.cloud.profile_url: "/user/settings" -xpack.cloud.billing_url: "/billing" -xpack.cloud.organization_url: "/account" # Enable ZDT migration algorithm migrations.algorithm: zdt @@ -72,5 +69,8 @@ server.versioned.strictClientVersionCheck: false xpack.spaces.maxSpaces: 1 xpack.spaces.allowFeatureVisibility: false +# Only display console autocomplete suggestions for ES endpoints that are available in serverless +console.autocompleteDefinitions.endpointsAvailability: serverless + # Allow authentication via the Elasticsearch JWT realm with the `shared_secret` client authentication type. elasticsearch.requestHeadersWhitelist: ["authorization", "es-client-authentication"] diff --git a/docs/CHANGELOG.asciidoc b/docs/CHANGELOG.asciidoc index 52674816fbcaa..156a8f0254dd3 100644 --- a/docs/CHANGELOG.asciidoc +++ b/docs/CHANGELOG.asciidoc @@ -49,6 +49,36 @@ Review important information about the {kib} 8.x releases. Review the following information about the {kib} 8.8.2 release. +[float] +[[known-issues-8.8.2]] +=== Known issues + +// tag::known-issue-161249[] +[discrete] +.Kibana can run out of memory during an upgrade when there are many {fleet} agent policies. +[%collapsible] +==== +*Details* + +Due to a schema version update, during {fleet} setup in 8.8.x, all agent policies are being queried and deployed. +This action triggers a lot of queries to the Elastic Package Registry (EPR) to fetch integration packages. As a result, +there is an increase in Kibana's resident memory usage (RSS). + +*Impact* + +Because the default batch size of `100` for schema version upgrade of {fleet} agent policies is too high, this can +cause Kibana to run out of memory during an upgrade. For example, we have observed 1GB Kibana instances run +out of memory during an upgrade when there were 20 agent policies with 5 integrations in each. + +*Workaround* + +Two workaround options are available: + +* Increase the Kibana instance size to 2GB. So far, we are not able to reproduce the issue with 2GB instances. +* Set `xpack.fleet.setup.agentPolicySchemaUpgradeBatchSize` to `2` in the `kibana.yml` and restart the Kibana instance(s). + +In 8.9.0, we are addressing this by changing the default batch size to `2`. + +==== +// end::known-issue-161249[] + [float] [[fixes-v8.8.2]] === Bug Fixes @@ -106,6 +136,32 @@ Review the following information about the {kib} 8.8.1 release. [[known-issues-8.8.1]] === Known issues +// tag::known-issue-161249[] +[discrete] +.Kibana can run out of memory during an upgrade when there are many {fleet} agent policies. +[%collapsible] +==== +*Details* + +Due to a schema version update, during {fleet} setup in 8.8.x, all agent policies are being queried and deployed. +This action triggers a lot of queries to the Elastic Package Registry (EPR) to fetch integration packages. As a result, +there is an increase in Kibana's resident memory usage (RSS). + +*Impact* + +Because the default batch size of `100` for schema version upgrade of {fleet} agent policies is too high, this can +cause Kibana to run out of memory during an upgrade. For example, we have observed 1GB Kibana instances run +out of memory during an upgrade when there were 20 agent policies with 5 integrations in each. + +*Workaround* + +Two workaround options are available: + +* Increase the Kibana instance size to 2GB. So far, we are not able to reproduce the issue with 2GB instances. +* Set `xpack.fleet.setup.agentPolicySchemaUpgradeBatchSize` to `2` in the `kibana.yml` and restart the Kibana instance(s). + +In 8.9.0, we are addressing this by changing the default batch size to `2`. + +==== +// end::known-issue-161249[] + // tag::known-issue-159807[] [discrete] .Memory leak in {fleet} audit logging. @@ -198,6 +254,32 @@ Review the following information about the {kib} 8.8.0 release. [[known-issues-8.8.0]] === Known issues +// tag::known-issue-161249[] +[discrete] +.Kibana can run out of memory during an upgrade when there are many {fleet} agent policies. +[%collapsible] +==== +*Details* + +Due to a schema version update, during {fleet} setup in 8.8.x, all agent policies are being queried and deployed. +This action triggers a lot of queries to the Elastic Package Registry (EPR) to fetch integration packages. As a result, +there is an increase in Kibana's resident memory usage (RSS). + +*Impact* + +Because the default batch size of `100` for schema version upgrade of {fleet} agent policies is too high, this can +cause Kibana to run out of memory during an upgrade. For example, we have observed 1GB Kibana instances run +out of memory during an upgrade when there were 20 agent policies with 5 integrations in each. + +*Workaround* + +Two workaround options are available: + +* Increase the Kibana instance size to 2GB. So far, we are not able to reproduce the issue with 2GB instances. +* Set `xpack.fleet.setup.agentPolicySchemaUpgradeBatchSize` to `2` in the `kibana.yml` and restart the Kibana instance(s). + +In 8.9.0, we are addressing this by changing the default batch size to `2`. + +==== +// end::known-issue-161249[] + // tag::known-issue-158940[] [discrete] .Failed upgrades to 8.8.0 can cause bootlooping and data loss @@ -221,6 +303,7 @@ The 8.8.1 release includes in {kibana-pull}158940[a fix] for this problem. Custo *Details* + {fleet} introduced audit logging for various CRUD (create, read, update, and delete) operations in version 8.8.0. While audit logging is not enabled by default, we have identified an off-heap memory leak in the implementation of {fleet} audit logging that can result in poor {kib} performance, and in some cases {kib} instances being terminated by the OS kernel's oom-killer. This memory leak can occur even when {kib} audit logging is not explicitly enabled (regardless of whether `xpack.security.audit.enabled` is set in the `kibana.yml` settings file). + *Impact* + The version 8.8.2 release includes in {kibana-pull}159807[a fix] for this problem. If you are using {fleet} integrations and {kib} audit logging in version 8.8.0 or 8.8.1, you should upgrade to 8.8.2 or above to obtain the fix. diff --git a/docs/api-generated/rules/rule-apis-passthru.asciidoc b/docs/api-generated/rules/rule-apis-passthru.asciidoc index e1cf66a214f31..1dea766b0dfb3 100644 --- a/docs/api-generated/rules/rule-apis-passthru.asciidoc +++ b/docs/api-generated/rules/rule-apis-passthru.asciidoc @@ -53,7 +53,7 @@ Any modifications made to this file will be overwritten. Up
post /s/{spaceId}/api/alerting/rule
Creates a rule with a randomly generated rule identifier. (createRule)
-
You must have all privileges for the appropriate Kibana features, depending on the consumer and rule_type_id of the rule you're creating. For example, you must have privileges for the Management > Stack rules feature, Analytics > Discover and Machine Learning features, Observability features, or Security features. If the rule has actions, you must also have read privileges for the Management > Actions and Connectors feature. NOTE: This API supports only token-based authentication. When you create a rule, it identifies which roles you have at that point in time. Thereafter, when the rule performs queries, it uses those security privileges. If a user with different privileges updates the rule, its behavior might change.
+
To create a rule, you must have all privileges for the appropriate Kibana features, depending on the consumer and rule_type_id of the rule you're creating. For example, you must have privileges for the Management > Stack rules feature, Analytics > Discover and Machine Learning features, Observability features, or Security features. If the rule has actions, you must also have read privileges for the Management > Actions and Connectors feature. This API supports both key- and token-based authentication. To use key-based authentication, create an API key in Kibana and use it in the header of the API call. To use token-based authentication, provide a username and password; an API key that matches the current privileges of the user is created automatically. In both cases, the API key is subsequently used for authorization when the rule runs.

Path parameters

@@ -289,7 +289,7 @@ Any modifications made to this file will be overwritten. Up
post /s/{spaceId}/api/alerting/rule/{ruleId}
Creates a rule with a specific rule identifier. (createRuleId)
-
You must have all privileges for the appropriate Kibana features, depending on the consumer and rule_type_id of the rule you're creating. For example, you must have privileges for the Management > Stack rules feature, Analytics > Discover and Machine Learning features, Observability features, or Security features. If the rule has actions, you must also have read privileges for the Management > Actions and Connectors feature. NOTE: This API supports only token-based authentication. When you create a rule, it identifies which roles you have at that point in time. Thereafter, when the rule performs queries, it uses those security privileges. If a user with different privileges updates the rule, its behavior might change.
+
To create a rule, you must have all privileges for the appropriate Kibana features, depending on the consumer and rule_type_id of the rule you're creating. For example, you must have privileges for the Management > Stack rules feature, Analytics > Discover and Machine Learning features, Observability features, or Security features. If the rule has actions, you must also have read privileges for the Management > Actions and Connectors feature. This API supports both key- and token-based authentication. To use key-based authentication, create an API key in Kibana and use it in the header of the API call. To use token-based authentication, provide a username and password; an API key that matches the current privileges of the user is created automatically. In both cases, the API key is subsequently used for authorization when the rule runs.

Path parameters

@@ -527,7 +527,7 @@ Any modifications made to this file will be overwritten. Up
delete /s/{spaceId}/api/alerting/rule/{ruleId}
Deletes a rule. (deleteRule)
-
You must have all privileges for the appropriate Kibana 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 Machine Learning features, Observability, or Security features. WARNING: After you delete a rule, you cannot recover it.
+
To delete a rule, you must have all privileges for the appropriate Kibana 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 Machine Learning features, Observability, or Security features. WARNING: After you delete a rule, you cannot recover it. If the API key that is used by the rule was created automatically, it is deleted.

Path parameters

@@ -629,7 +629,7 @@ Any modifications made to this file will be overwritten. Up
post /s/{spaceId}/api/alerting/rule/{ruleId}/_enable
Enables a rule. (enableRule)
-
This API supports token-based authentication only. You must have all privileges for the appropriate Kibana features, depending on the consumer and rule_type_id of the rule. For example, the Management > Stack Rules feature, Analytics > Discover and Machine Learning features, Observability, and Security features.
+
To enable a rule, you must have all privileges for the appropriate Kibana features, depending on the consumer and rule_type_id of the rule. For example, the Management > Stack Rules feature, Analytics > Discover and Machine Learning features, Observability, and Security features. This API supports both key- and token-based authentication. To use key-based authentication, create an API key in Kibana and use it in the header of the API call. To use token-based authentication, provide a username and password; an API key that matches the current privileges of the user is created automatically. In both cases, the API key is subsequently used for authorization when the rule runs.

Path parameters

@@ -2594,7 +2594,7 @@ Any modifications made to this file will be overwritten. Up
put /s/{spaceId}/api/alerting/rule/{ruleId}
Updates the attributes for a rule. (updateRule)
-
You must have all privileges for the appropriate Kibana features, depending on the consumer and rule_type_id of the rule you're updating. For example, you must have privileges for the Management > Stack rules feature, Analytics > Discover and Machine Learning features, Observability features, or Security features. If the rule has actions, you must also have read privileges for the Management > Actions and Connectors feature. NOTE: This API supports only token-based authentication. When you update a rule, it identifies which roles you have at that point in time. Thereafter, when the rule performs queries, it uses those security privileges. If you have different privileges than the user that created or most recently updated the rule, you might change its behavior. Though some properties are optional, when you update the rule the existing property values are overwritten with default values. Therefore, it is recommended to explicitly set all property values.
+
To update a rule, you must have all privileges for the appropriate Kibana features, depending on the consumer and rule_type_id of the rule you're updating. For example, you must have privileges for the Management > Stack rules feature, Analytics > Discover and Machine Learning features, Observability features, or Security features. If the rule has actions, you must also have read privileges for the Management > Actions and Connectors feature. This API supports both key- and token-based authentication. To use key-based authentication, create an API key in Kibana and use it in the header of the API call. To use token-based authentication, provide a username and password; an API key that matches the current privileges of the user is created automatically. In both cases, the API key is subsequently used for authorization when the rule runs. NOTE: If the API key has different privileges than the key that created or most recently updated the rule, the rule behavior might change. Though some properties are optional, when you update the rule the existing property values are overwritten with default values. Therefore, it is recommended to explicitly set all property values.

Path parameters

@@ -2848,11 +2848,10 @@ Any modifications made to this file will be overwritten.
  • actions_inner -
  • actions_inner_alerts_filter -
  • actions_inner_alerts_filter_query -
  • -
  • actions_inner_alerts_filter_query_filters_inner -
  • -
  • actions_inner_alerts_filter_query_filters_inner_meta -
  • actions_inner_alerts_filter_timeframe -
  • actions_inner_alerts_filter_timeframe_hours -
  • actions_inner_frequency -
  • +
  • aggtype -
  • alert_response_properties - Legacy alert response properties
  • alert_response_properties_executionStatus -
  • alert_response_properties_schedule -
  • @@ -2904,6 +2903,8 @@ Any modifications made to this file will be overwritten.
  • custom_criterion_customMetric_inner -
  • custom_criterion_customMetric_inner_oneOf -
  • custom_criterion_customMetric_inner_oneOf_1 -
  • +
  • filter -
  • +
  • filter_meta -
  • findRules_200_response -
  • findRules_has_reference_parameter -
  • findRules_search_fields_parameter -
  • @@ -2920,6 +2921,7 @@ Any modifications made to this file will be overwritten.
  • getRuleTypes_200_response_inner_authorized_consumers -
  • getRuleTypes_200_response_inner_authorized_consumers_alerts -
  • getRuleTypes_200_response_inner_recovery_action_group -
  • +
  • groupby -
  • legacyFindAlerts_200_response -
  • legacyGetAlertTypes_200_response_inner -
  • legacyGetAlertTypes_200_response_inner_actionVariables -
  • @@ -2932,6 +2934,12 @@ Any modifications made to this file will be overwritten.
  • legacyGetAlertingHealth_200_response_alertingFrameworkHealth_readHealth -
  • non_count_criterion - non count criterion
  • notify_when -
  • +
  • params_es_query_rule -
  • +
  • params_es_query_rule_oneOf -
  • +
  • params_es_query_rule_oneOf_1 -
  • +
  • params_es_query_rule_oneOf_searchConfiguration -
  • +
  • params_es_query_rule_oneOf_searchConfiguration_query -
  • +
  • params_index_threshold_rule -
  • params_property_apm_anomaly -
  • params_property_apm_error_count -
  • params_property_apm_transaction_duration -
  • @@ -2956,6 +2964,8 @@ Any modifications made to this file will be overwritten.
  • rule_response_properties_last_run -
  • rule_response_properties_last_run_alerts_count -
  • schedule -
  • +
  • thresholdcomparator -
  • +
  • timewindowunit -
  • update_rule_request - Update rule request
  • @@ -3127,34 +3137,7 @@ Any modifications made to this file will be overwritten.
    Defines a query filter that determines whether the action runs.
    kql (optional)
    String A filter written in Kibana Query Language (KQL).
    -
    filters (optional)
    -
    -
    -
    -

    actions_inner_alerts_filter_query_filters_inner - Up

    -
    A filter written in Elasticsearch Query Domain Specific Language (DSL) as defined in the kbn-es-query package.
    -
    -
    meta (optional)
    -
    query (optional)
    -
    Dollarstate (optional)
    -
    -
    -
    -

    actions_inner_alerts_filter_query_filters_inner_meta - Up

    -
    -
    -
    alias (optional)
    -
    controlledBy (optional)
    -
    disabled (optional)
    -
    field (optional)
    -
    group (optional)
    -
    index (optional)
    -
    isMultiIndex (optional)
    -
    key (optional)
    -
    negate (optional)
    -
    params (optional)
    -
    type (optional)
    -
    value (optional)
    +
    filters (optional)
    @@ -3183,6 +3166,12 @@ Any modifications made to this file will be overwritten.
    throttle (optional)
    String The throttle interval, which defines how often an alert generates repeated actions. It is specified in seconds, minutes, hours, or days and is applicable only if notify_when is set to onThrottleInterval. NOTE: You cannot specify the throttle interval at both the rule and action level. The recommended method is to set it for each action. If you set it at the rule level then update the rule in Kibana, it is automatically changed to use action-specific values.
    +
    +

    aggtype - Up

    +
    The type of aggregation to perform.
    +
    +
    +

    alert_response_properties - Legacy alert response properties Up

    @@ -3359,7 +3348,7 @@ Any modifications made to this file will be overwritten.
    enabled (optional)
    Boolean Indicates whether you want to run the rule on an interval basis after it is created.
    name
    String The name of the rule. While this name does not have to be unique, a distinctive name can help you identify a rule.
    notify_when (optional)
    -
    params
    map[String, oas_any_type_not_mapped] The parameters for an Elasticsearch query rule.
    +
    params
    rule_type_id
    String The ID of the rule type that you want to call when the rule is scheduled to run.
    Enum:
    .es-query
    @@ -3395,7 +3384,7 @@ Any modifications made to this file will be overwritten.
    enabled (optional)
    Boolean Indicates whether you want to run the rule on an interval basis after it is created.
    name
    String The name of the rule. While this name does not have to be unique, a distinctive name can help you identify a rule.
    notify_when (optional)
    -
    params
    map[String, oas_any_type_not_mapped] The parameters for an index threshold rule.
    +
    params
    rule_type_id
    String The ID of the rule type that you want to call when the rule is scheduled to run.
    Enum:
    .index-threshold
    @@ -4072,6 +4061,33 @@ Any modifications made to this file will be overwritten.
    filter (optional)
    +
    +

    filter - Up

    +
    A filter written in Elasticsearch Query Domain Specific Language (DSL) as defined in the kbn-es-query package.
    +
    +
    meta (optional)
    +
    query (optional)
    +
    Dollarstate (optional)
    +
    +
    +
    +

    filter_meta - Up

    +
    +
    +
    alias (optional)
    +
    controlledBy (optional)
    +
    disabled (optional)
    +
    field (optional)
    +
    group (optional)
    +
    index (optional)
    +
    isMultiIndex (optional)
    +
    key (optional)
    +
    negate (optional)
    +
    params (optional)
    +
    type (optional)
    +
    value (optional)
    +
    +

    findRules_200_response - Up

    @@ -4229,6 +4245,12 @@ Any modifications made to this file will be overwritten.
    name (optional)
    +
    +

    groupby - Up

    +
    Indicates whether the aggregation is applied over all documents (all) or split into groups (top) using a grouping field (termField). If grouping is used, an alert will be created for each group when it exceeds the threshold; only the top groups (up to termSize number of groups) are checked.
    +
    +
    +

    legacyFindAlerts_200_response - Up

    @@ -4355,6 +4377,110 @@ Any modifications made to this file will be overwritten.
    +
    +

    params_es_query_rule - Up

    +
    +
    +
    aggField (optional)
    String The name of the numeric field that is used in the aggregation. This property is required when aggType is avg, max, min or sum.
    +
    aggType (optional)
    +
    excludeHitsFromPreviousRun (optional)
    Boolean Indicates whether to exclude matches from previous runs. If true, you can avoid alert duplication by excluding documents that have already been detected by the previous rule run. This option is not available when a grouping field is specified.
    +
    groupBy (optional)
    +
    searchConfiguration (optional)
    +
    searchType
    String The type of query, in this case a query that uses Elasticsearch Query DSL.
    +
    Enum:
    +
    esQuery
    +
    size
    Integer The number of documents to pass to the configured actions when the threshold condition is met.
    +
    termField (optional)
    String This property is required when groupBy is top. The name of the field that is used for grouping the aggregation.
    +
    termSize (optional)
    Integer This property is required when groupBy is top. It specifies the number of groups to check against the threshold and therefore limits the number of alerts on high cardinality fields.
    +
    threshold
    array[Integer] The threshold value that is used with the thresholdComparator. If the thresholdComparator is between or notBetween, you must specify the boundary values.
    +
    thresholdComparator
    +
    timeField
    String The field that is used to calculate the time window.
    +
    timeWindowSize
    Integer The size of the time window (in timeWindowUnit units), which determines how far back to search for documents. Generally it should be a value higher than the rule check interval to avoid gaps in detection.
    +
    timeWindowUnit
    +
    esQuery
    String The query definition, which uses Elasticsearch Query DSL.
    +
    index
    oneOf The indices to query.
    +
    +
    +
    +

    params_es_query_rule_oneOf - Up

    +
    The parameters for an Elasticsearch query rule that uses KQL or Lucene to define the query.
    +
    +
    aggField (optional)
    String The name of the numeric field that is used in the aggregation. This property is required when aggType is avg, max, min or sum.
    +
    aggType (optional)
    +
    excludeHitsFromPreviousRun (optional)
    Boolean Indicates whether to exclude matches from previous runs. If true, you can avoid alert duplication by excluding documents that have already been detected by the previous rule run. This option is not available when a grouping field is specified.
    +
    groupBy (optional)
    +
    searchConfiguration (optional)
    +
    searchType
    String The type of query, in this case a text-based query that uses KQL or Lucene.
    +
    Enum:
    +
    searchSource
    +
    size
    Integer The number of documents to pass to the configured actions when the threshold condition is met.
    +
    termField (optional)
    String This property is required when groupBy is top. The name of the field that is used for grouping the aggregation.
    +
    termSize (optional)
    Integer This property is required when groupBy is top. It specifies the number of groups to check against the threshold and therefore limits the number of alerts on high cardinality fields.
    +
    threshold
    array[Integer] The threshold value that is used with the thresholdComparator. If the thresholdComparator is between or notBetween, you must specify the boundary values.
    +
    thresholdComparator
    +
    timeField (optional)
    String The field that is used to calculate the time window.
    +
    timeWindowSize
    Integer The size of the time window (in timeWindowUnit units), which determines how far back to search for documents. Generally it should be a value higher than the rule check interval to avoid gaps in detection.
    +
    timeWindowUnit
    +
    +
    +
    +

    params_es_query_rule_oneOf_1 - Up

    +
    The parameters for an Elasticsearch query rule that uses Elasticsearch Query DSL to define the query.
    +
    +
    aggField (optional)
    String The name of the numeric field that is used in the aggregation. This property is required when aggType is avg, max, min or sum.
    +
    aggType (optional)
    +
    esQuery
    String The query definition, which uses Elasticsearch Query DSL.
    +
    excludeHitsFromPreviousRun (optional)
    Boolean Indicates whether to exclude matches from previous runs. If true, you can avoid alert duplication by excluding documents that have already been detected by the previous rule run. This option is not available when a grouping field is specified.
    +
    groupBy (optional)
    +
    index
    oneOf The indices to query.
    +
    searchType (optional)
    String The type of query, in this case a query that uses Elasticsearch Query DSL.
    +
    Enum:
    +
    esQuery
    +
    size (optional)
    Integer The number of documents to pass to the configured actions when the threshold condition is met.
    +
    termField (optional)
    String This property is required when groupBy is top. The name of the field that is used for grouping the aggregation.
    +
    termSize (optional)
    Integer This property is required when groupBy is top. It specifies the number of groups to check against the threshold and therefore limits the number of alerts on high cardinality fields.
    +
    threshold
    array[Integer] The threshold value that is used with the thresholdComparator. If the thresholdComparator is between or notBetween, you must specify the boundary values.
    +
    thresholdComparator
    +
    timeField
    String The field that is used to calculate the time window.
    +
    timeWindowSize
    Integer The size of the time window (in timeWindowUnit units), which determines how far back to search for documents. Generally it should be a value higher than the rule check interval to avoid gaps in detection.
    +
    timeWindowUnit
    +
    +
    +
    +

    params_es_query_rule_oneOf_searchConfiguration - Up

    +
    The query definition, which uses KQL or Lucene to fetch the documents from Elasticsearch.
    +
    +
    filter (optional)
    +
    index (optional)
    oneOf The indices to query.
    +
    query (optional)
    +
    +
    +
    +

    params_es_query_rule_oneOf_searchConfiguration_query - Up

    +
    +
    +
    language (optional)
    +
    query (optional)
    +
    +
    +
    +

    params_index_threshold_rule - Up

    +
    The parameters for an index threshold rule.
    +
    +
    aggField (optional)
    String The name of the numeric field that is used in the aggregation. This property is required when aggType is avg, max, min or sum.
    +
    aggType (optional)
    +
    filterKuery (optional)
    String A KQL expression thats limits the scope of alerts.
    +
    groupBy (optional)
    +
    index
    array[String] The indices to query.
    +
    termField (optional)
    String This property is required when groupBy is top. The name of the field that is used for grouping the aggregation.
    +
    termSize (optional)
    Integer This property is required when groupBy is top. It specifies the number of groups to check against the threshold and therefore limits the number of alerts on high cardinality fields.
    +
    threshold
    array[Integer] The threshold value that is used with the thresholdComparator. If the thresholdComparator is between or notBetween, you must specify the boundary values.
    +
    thresholdComparator
    +
    timeField
    String The field that is used to calculate the time window.
    +
    timeWindowSize
    Integer The size of the time window (in timeWindowUnit units), which determines how far back to search for documents. Generally it should be a value higher than the rule check interval to avoid gaps in detection.
    +
    timeWindowUnit
    +
    +

    params_property_apm_anomaly - Up

    @@ -4687,6 +4813,18 @@ Any modifications made to this file will be overwritten.
    interval (optional)
    +
    +

    thresholdcomparator - Up

    +
    The comparison function for the threshold. For example, "is above", "is above or equals", "is below", "is below or equals", "is between", and "is not between".
    +
    +
    +
    +
    +

    timewindowunit - Up

    +
    The type of units for the time window: seconds, minutes, hours, or days.
    +
    +
    +

    update_rule_request - Update rule request Up

    The update rule API request body varies depending on the type of rule and actions.
    diff --git a/docs/api/alerting/create_rule.asciidoc b/docs/api/alerting/create_rule.asciidoc index c5e5bec9d061f..2bce4a1c49193 100644 --- a/docs/api/alerting/create_rule.asciidoc +++ b/docs/api/alerting/create_rule.asciidoc @@ -30,17 +30,6 @@ you must also have `read` privileges for the *Management* > *{connectors-feature}* feature. For more details, refer to <>. -=== {api-description-title} - -[WARNING] -==== -* This API supports only -<>. -* When you create a rule, it identifies which roles you have at that point in time. -Thereafter, when the rule performs queries, it uses those security privileges. -If a user with different privileges updates the rule, its behavior might change. -==== - [[create-rule-api-path-params]] === {api-path-parms-title} diff --git a/docs/api/alerting/update_rule.asciidoc b/docs/api/alerting/update_rule.asciidoc index 0db4c2cf38195..11ca1dc35fc85 100644 --- a/docs/api/alerting/update_rule.asciidoc +++ b/docs/api/alerting/update_rule.asciidoc @@ -29,21 +29,6 @@ features, *{observability}*, or *Security* features. If the rule has *{connectors-feature}* feature. For more details, refer to <>. -=== {api-description-title} - -[WARNING] -==== -* This API supports only -<>. -* When you update a rule, it identifies which roles you have at that point in time. -Thereafter, when the rule performs queries, it uses those security privileges. -If you have different privileges than the user that created or most recently -updated the rule, you might change its behavior. -* Though some properties are optional, when you update the rule the existing -property values are overwritten with default values. Therefore, it is -recommended to explicitly set all property values. -==== - [[update-rule-api-path-params]] === {api-path-parms-title} diff --git a/docs/apm/images/storage-explorer-expanded.png b/docs/apm/images/storage-explorer-expanded.png index 242dfb97ac325..844f07b6f8b7e 100644 Binary files a/docs/apm/images/storage-explorer-expanded.png and b/docs/apm/images/storage-explorer-expanded.png differ diff --git a/docs/apm/images/storage-explorer-overview.png b/docs/apm/images/storage-explorer-overview.png index 317ad02d82e43..d3fcccca5f6ee 100644 Binary files a/docs/apm/images/storage-explorer-overview.png and b/docs/apm/images/storage-explorer-overview.png differ diff --git a/docs/apm/storage-explorer.asciidoc b/docs/apm/storage-explorer.asciidoc index 98547de494f1f..7ab7b0ec70c45 100644 --- a/docs/apm/storage-explorer.asciidoc +++ b/docs/apm/storage-explorer.asciidoc @@ -1,8 +1,6 @@ [[storage-explorer]] === Storage Explorer -beta::[] - Analyze your APM data and manage costs with **storage explorer**. For example, analyze the storage footprint of each of your services to see which are producing large amounts of data--then change the sample rate of a service to lower the amount of data ingested. diff --git a/docs/apm/tab-widgets/storage-explorer-user/content.asciidoc b/docs/apm/tab-widgets/storage-explorer-user/content.asciidoc index 0a6e620edbe95..8661be8d3b6e4 100644 --- a/docs/apm/tab-widgets/storage-explorer-user/content.asciidoc +++ b/docs/apm/tab-widgets/storage-explorer-user/content.asciidoc @@ -3,6 +3,10 @@ |==== |Type |Privilege |Purpose +|Cluster +|`monitor` +|Monitor the disk space used by APM indices + |Index |`monitor` on `apm-*` |Monitor access to `apm-*` for storage explorer @@ -14,6 +18,10 @@ |==== |Type |Privilege |Purpose +|Cluster +|`monitor` +|Monitor the disk space used by APM data streams + |Index |`monitor` on `logs-apm*` |Monitor access to `logs-apm*` for storage explorer diff --git a/docs/developer/plugin-list.asciidoc b/docs/developer/plugin-list.asciidoc index e29f0fa2ac0ed..08101e8eacef8 100644 --- a/docs/developer/plugin-list.asciidoc +++ b/docs/developer/plugin-list.asciidoc @@ -407,10 +407,6 @@ The plugin exposes the static DefaultEditorController class to consume. |WARNING: Missing README. -|{kib-repo}blob/{branch}/src/plugins/visualization_ui_components/README.md[visualizationUiComponents] -|A series of UI components pulled out of Lens to make them available outside Lens. - - |=== [discrete] @@ -427,7 +423,7 @@ The plugin exposes the static DefaultEditorController class to consume. |{kib-repo}blob/{branch}/x-pack/plugins/aiops/README.md[aiops] -|The plugin provides APIs and components for AIOps features, including the “Explain log rate spikes” UI, maintained by the ML team. +|The plugin provides APIs and components for AIOps features, including the “Log rate analysis” UI, maintained by the ML team. |{kib-repo}blob/{branch}/x-pack/plugins/alerting/README.md[alerting] diff --git a/docs/management/action-types.asciidoc b/docs/management/action-types.asciidoc index 24db744c5dd50..1e45c9c64fa14 100644 --- a/docs/management/action-types.asciidoc +++ b/docs/management/action-types.asciidoc @@ -159,6 +159,9 @@ action in the current space. For out-of-the-box and standardized connectors, refer to <>. +TIP: You can also manage connectors as resources with the https://registry.terraform.io/providers/elastic/elasticstack/latest[Elasticstack provider] for Terraform. +For more details, refer to the https://registry.terraform.io/providers/elastic/elasticstack/latest/docs/resources/kibana_action_connector[elasticstack_kibana_action_connector] resource. + [float] [[importing-and-exporting-connectors]] === Importing and exporting connectors diff --git a/docs/management/advanced-options.asciidoc b/docs/management/advanced-options.asciidoc index cd9ce5ca17909..0974a7cf5caf3 100644 --- a/docs/management/advanced-options.asciidoc +++ b/docs/management/advanced-options.asciidoc @@ -198,7 +198,7 @@ to be displayed). [[timepicker-refreshintervaldefaults]]`timepicker:refreshIntervalDefaults`:: The default refresh interval for the time filter. Example: -`{ "display": "15 seconds", "pause": true, "value": 15000 }`. +`{ "pause": true, "value": 15000 }`. [[timepicker-timedefaults]]`timepicker:timeDefaults`:: The default selection in the time filter. @@ -393,6 +393,26 @@ value is 10000. [[apm-enable-service-overview]]`apm:enableServiceOverview`:: When enabled, displays the *Overview* tab for services in *APM*. +[[apm-agent-explorer]]`observability:apmAgentExplorerView`:: +beta:[] Enables the Agent explorer view. + +[[apm-aws-price]]`observability:apmAWSLambdaPriceFactor`:: +Set the price per Gb-second for your AWS Lambda functions. + +[[apm-aws-request]]`observability:apmAWSLambdaRequestCostPerMillion`:: +Set the AWS Lambda cost per million requests. + +[[apm-continuous-rollups]]`observability:apmEnableContinuousRollups`:: +beta:[] When continuous rollups is enabled, the UI will select metrics with the appropriate resolution. +On larger time ranges, lower resolution metrics will be used, which will improve loading times. + +[[apm-enable-service-metrics]]`observability:apmEnableServiceMetrics`:: +beta:[] Enables the usage of service transaction metrics, which are low cardinality metrics that can be used by certain views like the service inventory for faster loading times. + +[[observability-apm-labs]]`observability:apmLabsButton`:: +Enable or disable the APM Labs button -- a quick way to enable and disable technical preview features in APM. +See <> to learn more. + [[observability-apm-critical-path]]`observability:apmEnableCriticalPath`:: When enabled, displays the critical path of a trace. @@ -401,9 +421,15 @@ preview:[] When enabled, uses progressive loading of some APM views. Data may be requested with a lower sampling rate first, with lower accuracy but faster response times, while the unsampled data loads in the background. +[[observability-apm-max-groups]]`observability:apmServiceGroupMaxNumberOfServices`:: +Limit the number of services in a given service group. + [[observability-apm-optimized-sort]]`observability:apmServiceInventoryOptimizedSorting`:: preview:[] Sorts services without anomaly detection rules on the APM Service inventory page by service name. +[[observability-default-service-env]]`observability:apmDefaultServiceEnvironment`:: +Set the default environment for the APM app. When left empty, data from all environments will be displayed by default. + [[observability-enable-aws-lambda-metrics]]`observability:enableAwsLambdaMetrics`:: preview:[] Display Amazon Lambda metrics in the service metrics tab. diff --git a/docs/management/cases/manage-cases.asciidoc b/docs/management/cases/manage-cases.asciidoc index ee7b030485ce0..a3f0a40fd6009 100644 --- a/docs/management/cases/manage-cases.asciidoc +++ b/docs/management/cases/manage-cases.asciidoc @@ -1,6 +1,11 @@ [[manage-cases]] == Open and manage cases +:frontmatter-description: Create a case then add files, visualizations, and user notifications. +:frontmatter-tags-products: [kibana] +:frontmatter-tags-content-type: [how-to] +:frontmatter-tags-user-goals: [analyze] + preview::[] [[open-case]] @@ -72,8 +77,9 @@ go back to your case. . Click *Add Comment* to add the visualization to your case. -After a visualization has been added to a case, you can modify or interact with -it by clicking the *Open Visualization* option in the comment menu. +Alternatively, while viewing a <> you can open a panel's menu then click *More > Add to existing case* or *More > Add to new case*. + +After a visualization has been added to a case, you can modify or interact with it by clicking the *Open Visualization* option in the case's comment menu. [[add-case-notifications]] === Add email notifications diff --git a/docs/management/connectors/action-types/email.asciidoc b/docs/management/connectors/action-types/email.asciidoc index 3e498f600e37c..0f652821a3661 100644 --- a/docs/management/connectors/action-types/email.asciidoc +++ b/docs/management/connectors/action-types/email.asciidoc @@ -8,11 +8,8 @@ :frontmatter-tags-content-type: [how-to] :frontmatter-tags-user-goals: [configure] -The email connector uses the SMTP protocol to send mail messages, using an -integration of https://nodemailer.com/[Nodemailer]. An exception is Microsoft -Exchange, which uses HTTP protocol for sending emails, -https://docs.microsoft.com/en-us/graph/api/user-sendmail[Send mail]. Email -message text is sent as both plain text and html text. +The email connector uses the SMTP protocol to send mail messages. +Email message text is sent as both plain text and html text. [NOTE] ==== @@ -214,11 +211,10 @@ settings. You can set configurations that apply to all your connectors or use [[configuring-email]] === Configure email accounts for well-known services -The email connector can send email using many popular SMTP email services and -the Microsoft Exchange Graph API. +The email connector uses an integration of https://nodemailer.com/[Nodemailer] to send email from many popular SMTP email services. +For Microsoft Exchange email, it uses the Microsoft Graph API. -For more information about configuring the email connector to work with -different email systems, refer to: +To configure the email connector to work with common email systems, refer to: * <> * <> @@ -337,7 +333,7 @@ at AWS. [[exchange-basic-auth]] ==== Sending email from Microsoft Exchange with Basic Authentication -deprecated:[This Microsoft Exchange configuration is deprecated in 7.16.0, and will be removed later, because Microsoft is deprecating https://docs.microsoft.com/en-us/lifecycle/announcements/exchange-online-basic-auth-deprecated [Basic Authentication]: +deprecated:[7.16.0,"This Microsoft Exchange configuration is deprecated and will be removed later because Microsoft is deprecating basic authentication."] [source,text] -------------------------------------------------- @@ -365,6 +361,8 @@ https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-client [[exchange]] ==== Sending email from Microsoft Exchange with OAuth 2.0 +NOTE: The email connector uses Microsoft Graph REST API v1.0, in particular the https://docs.microsoft.com/en-us/graph/api/user-sendmail[sendMail] endpoint. It supports only the https://learn.microsoft.com/en-us/graph/deployments#microsoft-graph-and-graph-explorer-service-root-endpoints[Microsoft Graph global service] root endpoint (`https://graph.microsoft.com`). + Before you create an email connector for Microsoft Exchange, you must create and register the client integration application on the https://go.microsoft.com/fwlink/?linkid=2083908[Azure portal]: diff --git a/docs/management/connectors/images/pre-configured-alert-history-connector.png b/docs/management/connectors/images/pre-configured-alert-history-connector.png new file mode 100644 index 0000000000000..98cfbd0f39f7b Binary files /dev/null and b/docs/management/connectors/images/pre-configured-alert-history-connector.png differ diff --git a/docs/redirects.asciidoc b/docs/redirects.asciidoc index cbd77c47c15e3..1928cfb97bdfe 100644 --- a/docs/redirects.asciidoc +++ b/docs/redirects.asciidoc @@ -7,6 +7,10 @@ The following pages have moved or been deleted. -- +[role="exclude",id="explain-log-rate-spikes"] +== Explain log rate spikes +Refer to <>. + [role="exclude",id="snapshot-repositories"] == Snapshot and Restore Refer to {ref}/snapshot-restore.html[Snapshot and Restore]. diff --git a/docs/settings/apm-settings.asciidoc b/docs/settings/apm-settings.asciidoc index 50d0fa2032ac3..05d8cc35f1cde 100644 --- a/docs/settings/apm-settings.asciidoc +++ b/docs/settings/apm-settings.asciidoc @@ -43,6 +43,7 @@ If you'd like to change any of the default values, copy and paste the relevant settings into your `kibana.yml` configuration file. Changing these settings may disable features of the APM App. +TIP: More settings are available in the <>. `xpack.apm.maxSuggestions` {ess-icon}:: Maximum number of suggestions fetched in autocomplete selection boxes. Defaults to `100`. diff --git a/docs/user/alerting/alerting-setup.asciidoc b/docs/user/alerting/alerting-setup.asciidoc index 0a2e35d0abceb..8987d2d3370a0 100644 --- a/docs/user/alerting/alerting-setup.asciidoc +++ b/docs/user/alerting/alerting-setup.asciidoc @@ -4,6 +4,11 @@ Set up ++++ +:frontmatter-description: Prerequisites and production considerations for using {kib} {alert-features}. +:frontmatter-tags-products: [alerting] +:frontmatter-tags-content-type: [other] +:frontmatter-tags-user-goals: [configure] + {kib} {alert-features} are automatically enabled, but might require some additional configuration. @@ -77,27 +82,26 @@ A rule or connector created in one space will not be visible in another. Rules are authorized using an API key. Its credentials are used to run all background tasks associated with the rule, including condition checks like {es} queries and triggered actions. -You can create API keys and use them in the header of your API calls as described in <>. -If you create or edit a rule in {kib}, an API key is created that captures a snapshot of your privileges at the time of the edit. The following actions regenerate the API key in {kib}: +If you create or edit a rule in {kib}, an API key is created that captures a snapshot of your privileges at the time of the edit. +The following actions regenerate the API key in {kib}: * Creating a rule * Updating a rule -When you disable a rule, it retains the associated API key which is reused when -the rule is enabled. If the API key is missing when you enable the rule (for -example, in the case of imported rules), it generates a new key that has your -security privileges. +When you disable a rule, it retains the associated API key which is reused when the rule is enabled. +If the API key is missing when you enable the rule (for example, in the case of imported rules), it generates a new key that has your security privileges. + +You can update an API key manually in **{stack-manage-app} > {rules-ui}** or in the rule details page by selecting **Update API key** in the actions menu. -You can update an API key manually in -**{stack-manage-app} > {rules-ui}** or in the rule details page by selecting -**Update API key** in the actions menu. +If you manage your rules by using {kib} APIs, they support support both key- and token-based authentication as described in <>. +To use key-based authentication, create API keys and use them in the header of your API calls as described in <>. +To use token-based authentication, provide a username and password; an API key that matches the current privileges of the user is created automatically. +In both cases, the API key is subsequently associated with the rule and used when it runs. [IMPORTANT] ============================================== -If a rule requires certain privileges, such as index privileges, to run and a -user without those privileges updates the rule, the rule will no longer -function. Conversely, if a user with greater or administrator privileges -modifies the rule, it will begin running with increased privileges. +If a rule requires certain privileges, such as index privileges, to run and a user without those privileges updates the rule, the rule will no longer function. +Conversely, if a user with greater or administrator privileges modifies the rule, it will begin running with increased privileges. The same behavior occurs when you change the API key in the header of your API calls. ============================================== diff --git a/docs/user/alerting/create-and-manage-rules.asciidoc b/docs/user/alerting/create-and-manage-rules.asciidoc index 88060edab5437..49dd5d2019b8b 100644 --- a/docs/user/alerting/create-and-manage-rules.asciidoc +++ b/docs/user/alerting/create-and-manage-rules.asciidoc @@ -43,6 +43,9 @@ a rule type and configuring its conditions and actions. After a rule is created, you can open the action menu (…) and select *Edit rule* to re-open the flyout and change the rule properties. +TIP: You can also manage rules as resources with the https://registry.terraform.io/providers/elastic/elasticstack/latest[Elasticstack provider] for Terraform. +For more details, refer to the https://registry.terraform.io/providers/elastic/elasticstack/latest/docs/resources/kibana_alerting_rule[elasticstack_kibana_alerting_rule] resource. + [float] [[defining-rules-type-conditions]] ==== Rule type and conditions diff --git a/docs/user/alerting/images/pre-configured-alert-history-connector.png b/docs/user/alerting/images/pre-configured-alert-history-connector.png deleted file mode 100644 index 35f9b19710cda..0000000000000 Binary files a/docs/user/alerting/images/pre-configured-alert-history-connector.png and /dev/null differ diff --git a/docs/user/alerting/images/rule-flyout-action-details.png b/docs/user/alerting/images/rule-flyout-action-details.png index 79b8ab96120fb..b7d7050dd9cab 100644 Binary files a/docs/user/alerting/images/rule-flyout-action-details.png and b/docs/user/alerting/images/rule-flyout-action-details.png differ diff --git a/docs/user/alerting/images/rule-flyout-action-variables.png b/docs/user/alerting/images/rule-flyout-action-variables.png index b977b0470e3e2..ef74f4dc179d6 100644 Binary files a/docs/user/alerting/images/rule-flyout-action-variables.png and b/docs/user/alerting/images/rule-flyout-action-variables.png differ diff --git a/docs/user/alerting/images/rule-types-index-threshold-example-action.png b/docs/user/alerting/images/rule-types-index-threshold-example-action.png index 3544514574891..278a722921757 100644 Binary files a/docs/user/alerting/images/rule-types-index-threshold-example-action.png and b/docs/user/alerting/images/rule-types-index-threshold-example-action.png differ diff --git a/docs/user/alerting/rule-types.asciidoc b/docs/user/alerting/rule-types.asciidoc index 2b3bac0f9e1c9..bcab22f05ca0c 100644 --- a/docs/user/alerting/rule-types.asciidoc +++ b/docs/user/alerting/rule-types.asciidoc @@ -54,16 +54,16 @@ If you create a rule in the {observability} app, its alerts are not visible in | <> | Detect complex conditions in *APM* data and trigger built-in actions when the conditions are met. -| {observability-guide}/create-alerts.html[Logs rules] +| {observability-guide}/logs-threshold-alert.html[Logs rules] | Detect complex conditions in the {logs-app}. -| {observability-guide}/create-alerts.html[Metrics rules] +| {observability-guide}/metrics-threshold-alert.html[Metrics rules] | Detect complex conditions in the {metrics-app}. -| <> -| Provide {kib} alerting rules out-of-the box to notify you of potential issues in the {stack}. +| {observability-guide}/slo-burn-rate-alert.html[SLO burn rate rule] +| Detect when the burn rate is above a defined threshold. -| {observability-guide}/create-alerts.html[Uptime rules] +| {observability-guide}/monitor-status-alert.html[Uptime rules] | Detect complex conditions in the {uptime-app}. |=== diff --git a/docs/user/ml/images/ml-explain-log-rate-before.png b/docs/user/ml/images/ml-explain-log-rate-before.png deleted file mode 100644 index 2fcfae8951567..0000000000000 Binary files a/docs/user/ml/images/ml-explain-log-rate-before.png and /dev/null differ diff --git a/docs/user/ml/images/ml-explain-log-rate.png b/docs/user/ml/images/ml-explain-log-rate.png deleted file mode 100644 index c5353fab29f5e..0000000000000 Binary files a/docs/user/ml/images/ml-explain-log-rate.png and /dev/null differ diff --git a/docs/user/ml/images/ml-log-rate-analysis-before.png b/docs/user/ml/images/ml-log-rate-analysis-before.png new file mode 100644 index 0000000000000..cfa4b8f5fdd6f Binary files /dev/null and b/docs/user/ml/images/ml-log-rate-analysis-before.png differ diff --git a/docs/user/ml/images/ml-log-rate-analysis.png b/docs/user/ml/images/ml-log-rate-analysis.png new file mode 100644 index 0000000000000..4d12c1410b105 Binary files /dev/null and b/docs/user/ml/images/ml-log-rate-analysis.png differ diff --git a/docs/user/ml/index.asciidoc b/docs/user/ml/index.asciidoc index e5a8f6712a6b2..e7a60df8d289e 100644 --- a/docs/user/ml/index.asciidoc +++ b/docs/user/ml/index.asciidoc @@ -117,27 +117,27 @@ AIOps Labs is a part of {ml-app} in {kib} which provides features that use advanced statistical methods to help you interpret your data and its behavior. [discrete] -[[explain-log-rate-spikes]] -=== Explain log rate spikes +[[log-rate-analysis]] +=== Log rate analysis preview::[] -Explain log rate spikes is a feature that uses advanced statistical methods to -identify reasons for increases in log rates. It makes it easy to find and -investigate causes of unusual spikes by using the analysis workflow view. +Log rate analysis is a feature that uses advanced statistical methods to +identify reasons for increases or decreases in log rates. It makes it easy to find and +investigate causes of unusual spikes or drops by using the analysis workflow view. Examine the histogram chart of the log rates for a given {data-source}, and find the reason behind a particular change possibly in millions of log events across multiple fields and values. -You can find explain log rate spikes under **{ml-app}** > **AIOps Labs** where +You can find log rate analysis under **{ml-app}** > **AIOps Labs** where you can select the {data-source} or saved search that you want to analyze. [role="screenshot"] -image::user/ml/images/ml-explain-log-rate-before.png[Log event histogram chart] +image::user/ml/images/ml-log-rate-analysis-before.png[Log event histogram chart] -Select a spike in the log event histogram chart to start the analysis. It +Select a spike or drop in the log event histogram chart to start the analysis. It identifies statistically significant field-value combinations that contribute to -the spike and displays them in a table. You can optionally choose to summarize +the spike or drop and displays them in a table. You can optionally choose to summarize the results into groups. The table also shows an indicator of the level of impact and a sparkline showing the shape of the impact in the chart. Hovering over a row displays the impact on the histogram chart in more detail. You can @@ -153,7 +153,7 @@ analyzed data. You can move the brushes to redefine both the baseline and the deviation and rerun the analysis with the modified values. [role="screenshot"] -image::user/ml/images/ml-explain-log-rate.png[Log rate spike explained] +image::user/ml/images/ml-log-rate-analysis.png[Log rate spike explained] [discrete] @@ -205,7 +205,7 @@ image::user/ml/images/ml-change-point-detection.png[Change point detection UI] Select a function and a metric field, then pick a date range to start detecting change points in the defined range. Optionally, you can split the data by a field. If the cardinality of the split field exceeds 10,000, then only the first -10,000, sorted by document count, are analyzed. You can configure a maximum of 6 +10,000, sorted by document count, are analyzed. You can configure a maximum of 6 combinations of a function applied to a metric field, partitioned by a split field to identify change points. @@ -222,4 +222,4 @@ change; lower values indicate more significant changes. You can use the change point type selector to filter the results by specific types of change points. [role="screenshot"] -image::user/ml/images/ml-change-point-detection-selected.png[Selected change points] \ No newline at end of file +image::user/ml/images/ml-change-point-detection-selected.png[Selected change points] diff --git a/examples/embeddable_examples/public/list_container/list_container.tsx b/examples/embeddable_examples/public/list_container/list_container.tsx index c4641ba0f68de..45841a539ecef 100644 --- a/examples/embeddable_examples/public/list_container/list_container.tsx +++ b/examples/embeddable_examples/public/list_container/list_container.tsx @@ -17,7 +17,7 @@ export class ListContainer extends Container<{}, ContainerInput> { public readonly type = LIST_CONTAINER; private node?: HTMLElement; - constructor(input: ContainerInput, private embeddableServices: EmbeddableStart) { + constructor(input: ContainerInput, embeddableServices: EmbeddableStart) { super(input, { embeddableLoaded: {} }, embeddableServices.getEmbeddableFactory); } @@ -32,10 +32,7 @@ export class ListContainer extends Container<{}, ContainerInput> { ReactDOM.unmountComponentAtNode(this.node); } this.node = node; - ReactDOM.render( - , - node - ); + ReactDOM.render(, node); } public destroy() { diff --git a/examples/embeddable_examples/public/list_container/list_container_component.tsx b/examples/embeddable_examples/public/list_container/list_container_component.tsx index d83ce243f37d2..e0d0b7c72139f 100644 --- a/examples/embeddable_examples/public/list_container/list_container_component.tsx +++ b/examples/embeddable_examples/public/list_container/list_container_component.tsx @@ -14,22 +14,16 @@ import { withEmbeddableSubscription, ContainerInput, ContainerOutput, - EmbeddableStart, - EmbeddableChildPanel, + EmbeddablePanel, } from '@kbn/embeddable-plugin/public'; interface Props { embeddable: IContainer; input: ContainerInput; output: ContainerOutput; - embeddableServices: EmbeddableStart; } -function renderList( - embeddable: IContainer, - panels: ContainerInput['panels'], - embeddableServices: EmbeddableStart -) { +function renderList(embeddable: IContainer, panels: ContainerInput['panels']) { let number = 0; const list = Object.values(panels).map((panel) => { number++; @@ -42,10 +36,8 @@ function renderList( - embeddable.untilEmbeddableLoaded(panel.explicitInput.id)} /> @@ -55,12 +47,12 @@ function renderList( return list; } -export function ListContainerComponentInner({ embeddable, input, embeddableServices }: Props) { +export function ListContainerComponentInner({ embeddable, input }: Props) { return (

    {embeddable.getTitle()}

    - {renderList(embeddable, input.panels, embeddableServices)} + {renderList(embeddable, input.panels)}
    ); } @@ -73,6 +65,5 @@ export function ListContainerComponentInner({ embeddable, input, embeddableServi export const ListContainerComponent = withEmbeddableSubscription< ContainerInput, ContainerOutput, - IContainer, - { embeddableServices: EmbeddableStart } + IContainer >(ListContainerComponentInner); diff --git a/examples/embeddable_examples/public/searchable_list_container/searchable_list_container_component.tsx b/examples/embeddable_examples/public/searchable_list_container/searchable_list_container_component.tsx index 2c225303fee20..39b8c49236414 100644 --- a/examples/embeddable_examples/public/searchable_list_container/searchable_list_container_component.tsx +++ b/examples/embeddable_examples/public/searchable_list_container/searchable_list_container_component.tsx @@ -25,6 +25,8 @@ import { ContainerOutput, EmbeddableOutput, EmbeddableStart, + EmbeddablePanel, + openAddPanelFlyout, } from '@kbn/embeddable-plugin/public'; import { SearchableListContainer, SearchableContainerInput } from './searchable_list_container'; @@ -120,7 +122,7 @@ export class SearchableListContainerComponentInner extends Component @@ -150,6 +152,17 @@ export class SearchableListContainerComponentInner extends Component + + + openAddPanelFlyout({ container: embeddable })} + > + Add panel + + + ); @@ -171,7 +184,7 @@ export class SearchableListContainerComponentInner extends Component { const childEmbeddable = embeddable.getChild(panel.explicitInput.id); @@ -189,7 +202,7 @@ export class SearchableListContainerComponentInner extends Component - + diff --git a/examples/embeddable_explorer/public/app.tsx b/examples/embeddable_explorer/public/app.tsx index ff6b04eb2bd30..9efc88bf0d6fe 100644 --- a/examples/embeddable_explorer/public/app.tsx +++ b/examples/embeddable_explorer/public/app.tsx @@ -112,7 +112,6 @@ const EmbeddableExplorerApp = ({ id: 'embeddablePanelExample', component: ( ), diff --git a/examples/embeddable_explorer/public/embeddable_panel_example.tsx b/examples/embeddable_explorer/public/embeddable_panel_example.tsx index 2983aa5dc2525..e571e195370cb 100644 --- a/examples/embeddable_explorer/public/embeddable_panel_example.tsx +++ b/examples/embeddable_explorer/public/embeddable_panel_example.tsx @@ -9,7 +9,7 @@ import React, { useState, useEffect, useRef } from 'react'; import { EuiPanel, EuiText, EuiPageTemplate } from '@elastic/eui'; import { EuiSpacer } from '@elastic/eui'; -import { EmbeddableStart, IEmbeddable } from '@kbn/embeddable-plugin/public'; +import { IEmbeddable, EmbeddablePanel } from '@kbn/embeddable-plugin/public'; import { HELLO_WORLD_EMBEDDABLE, TODO_EMBEDDABLE, @@ -19,11 +19,10 @@ import { } from '@kbn/embeddable-examples-plugin/public'; interface Props { - embeddableServices: EmbeddableStart; searchListContainerFactory: SearchableListContainerFactory; } -export function EmbeddablePanelExample({ embeddableServices, searchListContainerFactory }: Props) { +export function EmbeddablePanelExample({ searchListContainerFactory }: Props) { const searchableInput = { id: '1', title: 'My searchable todo list', @@ -120,7 +119,7 @@ export function EmbeddablePanelExample({ embeddableServices, searchListContainer {embeddable ? ( - + ) : ( Loading... )} diff --git a/fleet_packages.json b/fleet_packages.json index 29b4baa91d299..a850377f1c12e 100644 --- a/fleet_packages.json +++ b/fleet_packages.json @@ -24,7 +24,7 @@ [ { "name": "apm", - "version": "8.10.0-preview-1689234434", + "version": "8.10.0-preview-1689351101", "forceAlignStackVersion": true, "allowSyncToPrerelease": true }, @@ -58,6 +58,6 @@ }, { "name": "security_detection_engine", - "version": "8.9.1" + "version": "8.9.2" } ] \ No newline at end of file diff --git a/package.json b/package.json index a6fe03d4ab479..0d8c4d3824c08 100644 --- a/package.json +++ b/package.json @@ -98,7 +98,7 @@ "@elastic/datemath": "5.0.3", "@elastic/elasticsearch": "npm:@elastic/elasticsearch-canary@8.8.0-canary.2", "@elastic/ems-client": "8.4.0", - "@elastic/eui": "83.1.0", + "@elastic/eui": "84.0.0", "@elastic/filesaver": "1.1.2", "@elastic/node-crypto": "1.2.1", "@elastic/numeral": "^2.5.1", @@ -372,6 +372,7 @@ "@kbn/discover-enhanced-plugin": "link:x-pack/plugins/discover_enhanced", "@kbn/discover-log-explorer-plugin": "link:x-pack/plugins/discover_log_explorer", "@kbn/discover-plugin": "link:src/plugins/discover", + "@kbn/discover-utils": "link:packages/kbn-discover-utils", "@kbn/doc-links": "link:packages/kbn-doc-links", "@kbn/dom-drag-drop": "link:packages/kbn-dom-drag-drop", "@kbn/ebt-tools": "link:packages/kbn-ebt-tools", @@ -393,6 +394,8 @@ "@kbn/es-types": "link:packages/kbn-es-types", "@kbn/es-ui-shared-plugin": "link:src/plugins/es_ui_shared", "@kbn/eso-plugin": "link:x-pack/test/encrypted_saved_objects_api_integration/plugins/api_consumer_plugin", + "@kbn/event-annotation-common": "link:packages/kbn-event-annotation-common", + "@kbn/event-annotation-components": "link:packages/kbn-event-annotation-components", "@kbn/event-annotation-plugin": "link:src/plugins/event_annotation", "@kbn/event-log-fixture-plugin": "link:x-pack/test/plugin_api_integration/plugins/event_log", "@kbn/event-log-plugin": "link:x-pack/plugins/event_log", @@ -429,6 +432,7 @@ "@kbn/foo-plugin": "link:x-pack/test/ui_capabilities/common/plugins/foo_plugin", "@kbn/ftr-apis-plugin": "link:src/plugins/ftr_apis", "@kbn/functional-with-es-ssl-cases-test-plugin": "link:x-pack/test/functional_with_es_ssl/plugins/cases", + "@kbn/gen-ai-streaming-response-example-plugin": "link:x-pack/examples/gen_ai_streaming_response_example", "@kbn/generate-console-definitions": "link:packages/kbn-generate-console-definitions", "@kbn/generate-csv": "link:packages/kbn-generate-csv", "@kbn/generate-csv-types": "link:packages/kbn-generate-csv-types", @@ -498,6 +502,7 @@ "@kbn/maps-vector-tile-utils": "link:x-pack/packages/maps/vector_tile_utils", "@kbn/ml-agg-utils": "link:x-pack/packages/ml/agg_utils", "@kbn/ml-anomaly-utils": "link:x-pack/packages/ml/anomaly_utils", + "@kbn/ml-category-validator": "link:x-pack/packages/ml/category_validator", "@kbn/ml-data-frame-analytics-utils": "link:x-pack/packages/ml/data_frame_analytics_utils", "@kbn/ml-data-grid": "link:x-pack/packages/ml/data_grid", "@kbn/ml-date-picker": "link:x-pack/packages/ml/date_picker", @@ -747,7 +752,7 @@ "@kbn/vis-type-vega-plugin": "link:src/plugins/vis_types/vega", "@kbn/vis-type-vislib-plugin": "link:src/plugins/vis_types/vislib", "@kbn/vis-type-xy-plugin": "link:src/plugins/vis_types/xy", - "@kbn/visualization-ui-components": "link:src/plugins/visualization_ui_components", + "@kbn/visualization-ui-components": "link:packages/kbn-visualization-ui-components", "@kbn/visualizations-plugin": "link:src/plugins/visualizations", "@kbn/watcher-plugin": "link:x-pack/plugins/watcher", "@loaders.gl/core": "^2.3.1", @@ -756,6 +761,7 @@ "@mapbox/geojson-rewind": "^0.5.0", "@mapbox/mapbox-gl-draw": "1.3.0", "@mapbox/mapbox-gl-rtl-text": "0.2.3", + "@mapbox/mapbox-gl-supported": "2.0.1", "@mapbox/vector-tile": "1.3.1", "@opentelemetry/api": "^1.1.0", "@opentelemetry/api-metrics": "^0.31.0", @@ -824,7 +830,7 @@ "deepmerge": "^4.2.2", "del": "^6.1.0", "elastic-apm-http-client": "^11.0.1", - "elastic-apm-node": "^3.47.0", + "elastic-apm-node": "^3.48.0", "email-addresses": "^5.0.0", "execa": "^4.0.2", "expiry-js": "0.1.7", @@ -878,7 +884,7 @@ "luxon": "^2.5.2", "lz-string": "^1.4.4", "mapbox-gl-draw-rectangle-mode": "1.0.4", - "maplibre-gl": "2.1.9", + "maplibre-gl": "3.1.0", "markdown-it": "^12.3.2", "md5": "^2.1.0", "mdast-util-to-hast": "10.0.1", @@ -929,7 +935,6 @@ "react-dom": "^17.0.2", "react-dropzone": "^4.2.9", "react-fast-compare": "^2.0.4", - "react-focus-on": "^3.7.0", "react-grid-layout": "^1.3.4", "react-hook-form": "^7.44.2", "react-intl": "^2.8.0", @@ -1000,7 +1005,7 @@ "vinyl": "^2.2.0", "whatwg-fetch": "^3.0.0", "xml2js": "^0.5.0", - "xstate": "^4.37.2", + "xstate": "^4.38.1", "xterm": "^5.1.0", "yauzl": "^2.10.0", "yazl": "^2.5.1" @@ -1040,10 +1045,10 @@ "@emotion/jest": "^11.11.0", "@istanbuljs/nyc-config-typescript": "^1.0.2", "@istanbuljs/schema": "^0.1.2", - "@jest/console": "^29.3.1", - "@jest/reporters": "^29.3.1", - "@jest/transform": "^29.3.1", - "@jest/types": "^29.3.1", + "@jest/console": "^29.6.1", + "@jest/reporters": "^29.6.1", + "@jest/transform": "^29.6.1", + "@jest/types": "^29.6.1", "@kbn/alerting-api-integration-helpers": "link:x-pack/test/alerting_api_integration/packages/helpers", "@kbn/ambient-common-types": "link:packages/kbn-ambient-common-types", "@kbn/ambient-ftr-types": "link:packages/kbn-ambient-ftr-types", @@ -1260,13 +1265,13 @@ "@types/http-proxy": "^1.17.4", "@types/inquirer": "^7.3.1", "@types/intl-relativeformat": "^2.1.0", - "@types/jest": "29.2.0", + "@types/jest": "^29.5.3", "@types/jest-axe": "^3.5.3", "@types/jquery": "^3.3.31", "@types/js-levenshtein": "^1.1.0", "@types/js-search": "^1.4.0", "@types/js-yaml": "^3.11.1", - "@types/jsdom": "^16.2.14", + "@types/jsdom": "^20.0.1", "@types/json-schema": "^7", "@types/json-stable-stringify": "^1.0.32", "@types/json5": "^2.2.0", @@ -1339,7 +1344,7 @@ "@types/tapable": "^1.0.6", "@types/tar": "^6.1.3", "@types/tempy": "^0.2.0", - "@types/testing-library__jest-dom": "^5.14.5", + "@types/testing-library__jest-dom": "^5.14.7", "@types/tinycolor2": "^1.4.1", "@types/tough-cookie": "^4.0.2", "@types/type-detect": "^4.0.1", @@ -1369,7 +1374,7 @@ "argsplit": "^1.0.5", "autoprefixer": "^10.4.7", "axe-core": "^4.6.1", - "babel-jest": "^29.3.1", + "babel-jest": "^29.6.1", "babel-loader": "^8.2.5", "babel-plugin-add-module-exports": "^1.0.4", "babel-plugin-istanbul": "^6.1.1", @@ -1424,7 +1429,7 @@ "eslint-plugin-react-perf": "^3.3.0", "eslint-traverse": "^1.0.0", "exit-hook": "^2.2.0", - "expect": "^29.3.1", + "expect": "^29.6.1", "expose-loader": "^0.7.5", "faker": "^5.1.0", "fetch-mock": "^7.3.9", @@ -1443,21 +1448,20 @@ "html-loader": "^1.3.2", "http-proxy": "^1.18.1", "is-path-inside": "^3.0.2", - "jest": "^29.3.1", + "jest": "^29.6.1", "jest-axe": "^5.0.0", - "jest-canvas-mock": "^2.4.0", - "jest-cli": "^29.3.1", - "jest-config": "^29.3.1", - "jest-diff": "^29.3.1", - "jest-environment-jsdom": "^29.3.1", - "jest-matcher-utils": "^29.3.1", - "jest-mock": "^29.3.1", - "jest-runtime": "^29.3.1", - "jest-silent-reporter": "^0.5.0", - "jest-snapshot": "^29.3.1", - "jest-specific-snapshot": "^5.0.0", + "jest-canvas-mock": "^2.5.2", + "jest-cli": "^29.6.1", + "jest-config": "^29.6.1", + "jest-diff": "^29.6.1", + "jest-environment-jsdom": "^29.6.1", + "jest-matcher-utils": "^29.6.1", + "jest-mock": "^29.6.1", + "jest-runtime": "^29.6.1", + "jest-snapshot": "^29.6.1", + "jest-specific-snapshot": "^8.0.0", "jest-styled-components": "7.0.3", - "jsdom": "^16.4.0", + "jsdom": "^20.0.1", "json-schema-typed": "^8.0.1", "json5": "^2.2.3", "jsondiffpatch": "0.4.1", diff --git a/packages/content-management/tabbed_table_list_view/src/tabbed_table_list_view.tsx b/packages/content-management/tabbed_table_list_view/src/tabbed_table_list_view.tsx index 9872e35d90c88..e1cd59f9a1378 100644 --- a/packages/content-management/tabbed_table_list_view/src/tabbed_table_list_view.tsx +++ b/packages/content-management/tabbed_table_list_view/src/tabbed_table_list_view.tsx @@ -47,23 +47,23 @@ export const TabbedTableListView = ({ [activeTabId, tabs] ); + const onFetchSuccess = useCallback(() => { + setHasInitialFetchReturned(true); + }, []); + const [tableList, setTableList] = useState(null); useEffect(() => { async function loadTableList() { const newTableList = await getActiveTab().getTableList({ - onFetchSuccess: () => { - if (!hasInitialFetchReturned) { - setHasInitialFetchReturned(true); - } - }, + onFetchSuccess, setPageDataTestSubject, }); setTableList(newTableList); } loadTableList(); - }, [hasInitialFetchReturned, activeTabId, tabs, getActiveTab]); + }, [activeTabId, tabs, getActiveTab, onFetchSuccess]); return ( diff --git a/packages/content-management/table_list_view/src/table_list_view.tsx b/packages/content-management/table_list_view/src/table_list_view.tsx index 71b08f82174bb..71e9f95bbf581 100644 --- a/packages/content-management/table_list_view/src/table_list_view.tsx +++ b/packages/content-management/table_list_view/src/table_list_view.tsx @@ -82,10 +82,8 @@ export const TableListView = ({ const [pageDataTestSubject, setPageDataTestSubject] = useState(); const onFetchSuccess = useCallback(() => { - if (!hasInitialFetchReturned) { - setHasInitialFetchReturned(true); - } - }, [hasInitialFetchReturned]); + setHasInitialFetchReturned(true); + }, []); return ( diff --git a/packages/content-management/table_list_view_table/src/reducer.tsx b/packages/content-management/table_list_view_table/src/reducer.tsx index c8486d92caced..0a8a89db80d92 100644 --- a/packages/content-management/table_list_view_table/src/reducer.tsx +++ b/packages/content-management/table_list_view_table/src/reducer.tsx @@ -39,11 +39,21 @@ export function getReducer() { } } + let hasNoItems = state.hasNoItems; + + const hasQuery = state.searchQuery.text !== ''; + if (hasQuery) { + hasNoItems = undefined; + } else { + hasNoItems = items.length === 0; + } + return { ...state, hasInitialFetchReturned: true, isFetchingItems: false, items, + hasNoItems, totalItems: action.data.response.total, hasUpdatedAtMetadata, tableSort: tableSort ?? state.tableSort, diff --git a/packages/content-management/table_list_view_table/src/table_list_view.test.helpers.ts b/packages/content-management/table_list_view_table/src/table_list_view.test.helpers.ts new file mode 100644 index 0000000000000..cbfa96198cc9d --- /dev/null +++ b/packages/content-management/table_list_view_table/src/table_list_view.test.helpers.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 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 { TestBed } from '@kbn/test-jest-helpers'; +import { act } from 'react-dom/test-utils'; + +export const getActions = ({ find, form, component }: TestBed) => { + /** Open the sort select drop down menu */ + const openSortSelect = () => { + find('tableSortSelectBtn').at(0).simulate('click'); + }; + + // --- Search Box --- + + /** Set the search box value */ + const updateSearchText = async (value: string) => { + await act(async () => { + find('tableListSearchBox').simulate('keyup', { + key: 'Enter', + target: { value }, + }); + }); + component.update(); + }; + + /** Get the Search box value */ + const getSearchBoxValue = () => find('tableListSearchBox').props().defaultValue; + + // --- Row Actions --- + const selectRow = (rowId: string) => { + act(() => { + form.selectCheckBox(`checkboxSelectRow-${rowId}`); + }); + component.update(); + }; + + const clickDeleteSelectedItemsButton = () => { + act(() => { + find('deleteSelectedItems').simulate('click'); + }); + component.update(); + }; + + const clickConfirmModalButton = async () => { + await act(async () => { + find('confirmModalConfirmButton').simulate('click'); + }); + component.update(); + }; + + return { + openSortSelect, + updateSearchText, + getSearchBoxValue, + selectRow, + clickDeleteSelectedItemsButton, + clickConfirmModalButton, + }; +}; diff --git a/packages/content-management/table_list_view_table/src/table_list_view.test.tsx b/packages/content-management/table_list_view_table/src/table_list_view.test.tsx index 0fc1840f26613..94c1ca5ab6753 100644 --- a/packages/content-management/table_list_view_table/src/table_list_view.test.tsx +++ b/packages/content-management/table_list_view_table/src/table_list_view.test.tsx @@ -22,6 +22,7 @@ import { type TableListViewTableProps, type UserContentCommonSchema, } from './table_list_view_table'; +import { getActions } from './table_list_view.test.helpers'; const mockUseEffect = useEffect; @@ -54,12 +55,6 @@ const twoDaysAgoToString = new Date(twoDaysAgo.getTime()).toDateString(); const yesterday = new Date(new Date().setDate(new Date().getDate() - 1)); const yesterdayToString = new Date(yesterday.getTime()).toDateString(); -const getActions = (testBed: TestBed) => ({ - openSortSelect() { - testBed.find('tableSortSelectBtn').at(0).simulate('click'); - }, -}); - describe('TableListView', () => { const requiredProps: TableListViewTableProps = { entityName: 'test', @@ -91,50 +86,102 @@ describe('TableListView', () => { } ); - test('render default empty prompt', async () => { - let testBed: TestBed; + describe('empty prompt', () => { + test('render default empty prompt', async () => { + let testBed: TestBed; - await act(async () => { - testBed = await setup(); + await act(async () => { + testBed = await setup(); + }); + + const { component, exists } = testBed!; + component.update(); + + expect(component.find(EuiEmptyPrompt).length).toBe(1); + expect(exists('newItemButton')).toBe(false); }); - const { component, exists } = testBed!; - component.update(); + // avoid trapping users in empty prompt that can not create new items + test('render default empty prompt with create action when createItem supplied', async () => { + let testBed: TestBed; - expect(component.find(EuiEmptyPrompt).length).toBe(1); - expect(exists('newItemButton')).toBe(false); - }); + await act(async () => { + testBed = await setup({ createItem: () => undefined }); + }); - // avoid trapping users in empty prompt that can not create new items - test('render default empty prompt with create action when createItem supplied', async () => { - let testBed: TestBed; + const { component, exists } = testBed!; + component.update(); - await act(async () => { - testBed = await setup({ createItem: () => undefined }); + expect(component.find(EuiEmptyPrompt).length).toBe(1); + expect(exists('newItemButton')).toBe(true); }); - const { component, exists } = testBed!; - component.update(); + test('render custom empty prompt', async () => { + let testBed: TestBed; - expect(component.find(EuiEmptyPrompt).length).toBe(1); - expect(exists('newItemButton')).toBe(true); - }); + const CustomEmptyPrompt = () => { + return Table empty} />; + }; - test('render custom empty prompt', async () => { - let testBed: TestBed; + await act(async () => { + testBed = await setup({ emptyPrompt: }); + }); - const CustomEmptyPrompt = () => { - return Table empty} />; - }; + const { component, exists } = testBed!; + component.update(); - await act(async () => { - testBed = await setup({ emptyPrompt: }); + expect(exists('custom-empty-prompt')).toBe(true); }); - const { component, exists } = testBed!; - component.update(); + test('render empty prompt after deleting all items from table', async () => { + // NOTE: this test is using helpers that are being tested in the + // "should allow select items to be deleted" test below. + // If this test fails, check that one first. + + const hits: UserContentCommonSchema[] = [ + { + id: 'item-1', + type: 'dashboard', + updatedAt: '2020-01-01T00:00:00Z', + attributes: { + title: 'Item 1', + }, + references: [], + }, + ]; - expect(exists('custom-empty-prompt')).toBe(true); + const findItems = jest.fn().mockResolvedValue({ total: 1, hits }); + const deleteItems = jest.fn(); + + let testBed: TestBed; + + const EmptyPrompt = () => { + return Table empty} />; + }; + + await act(async () => { + testBed = await setup({ emptyPrompt: , findItems, deleteItems }); + }); + + const { component, exists, table } = testBed!; + const { selectRow, clickConfirmModalButton, clickDeleteSelectedItemsButton } = getActions( + testBed! + ); + component.update(); + + expect(exists('custom-empty-prompt')).toBe(false); + const { tableCellsValues } = table.getMetaData('itemsInMemTable'); + const [row] = tableCellsValues; + expect(row[1]).toBe('Item 1'); // Note: row[0] is the checkbox + + // We delete the item in the table and expect the empty prompt to show + findItems.mockResolvedValue({ total: 0, hits: [] }); + selectRow('item-1'); + clickDeleteSelectedItemsButton(); + await clickConfirmModalButton(); + + expect(exists('custom-empty-prompt')).toBe(true); + }); }); describe('default columns', () => { @@ -798,7 +845,20 @@ describe('TableListView', () => { let testBed: TestBed; const initialFilter = 'tag:(tag-1)'; - const findItems = jest.fn().mockResolvedValue({ total: 0, hits: [] }); + const findItems = jest.fn().mockResolvedValue({ + total: 1, + hits: [ + { + id: 'item-1', + type: 'dashboard', + updatedAt: new Date('2023-07-15').toISOString(), + attributes: { + title: 'Item 1', + }, + references: [], + }, + ], + }); await act(async () => { testBed = await setupInitialFilter({ @@ -824,6 +884,173 @@ describe('TableListView', () => { }); }); + describe('search', () => { + const updatedAt = new Date('2023-07-15').toISOString(); + + const hits: UserContentCommonSchema[] = [ + { + id: 'item-1', + type: 'dashboard', + updatedAt, + attributes: { + title: 'Item 1', + }, + references: [], + }, + { + id: 'item-2', + type: 'dashboard', + updatedAt, + attributes: { + title: 'Item 2', + }, + references: [], + }, + ]; + + const findItems = jest.fn(); + + const setupSearch = (...args: Parameters>) => { + const testBed = registerTestBed( + WithServices(TableListViewTable), + { + defaultProps: { + ...requiredProps, + findItems, + urlStateEnabled: false, + entityName: 'Foo', + entityNamePlural: 'Foos', + }, + memoryRouter: { wrapComponent: true }, + } + )(...args); + + const { updateSearchText, getSearchBoxValue } = getActions(testBed); + + return { + testBed, + updateSearchText, + getSearchBoxValue, + getLastCallArgsFromFindItems: () => findItems.mock.calls[findItems.mock.calls.length - 1], + }; + }; + + beforeEach(() => { + findItems.mockReset().mockResolvedValue({ total: hits.length, hits }); + }); + + test('should search the table items', async () => { + let testBed: TestBed; + let updateSearchText: (value: string) => Promise; + let getLastCallArgsFromFindItems: () => Parameters; + let getSearchBoxValue: () => string; + + await act(async () => { + ({ testBed, getLastCallArgsFromFindItems, getSearchBoxValue, updateSearchText } = + await setupSearch()); + }); + + const { component, table } = testBed!; + component.update(); + + let searchTerm = ''; + let expected = ''; + [searchTerm] = getLastCallArgsFromFindItems!(); + expect(getSearchBoxValue!()).toBe(expected); + expect(searchTerm).toBe(expected); + + const { tableCellsValues } = table.getMetaData('itemsInMemTable'); + expect(tableCellsValues).toMatchInlineSnapshot(` + Array [ + Array [ + "Item 1", + "Sat Jul 15 2023", + ], + Array [ + "Item 2", + "Sat Jul 15 2023", + ], + ] + `); + + findItems.mockResolvedValueOnce({ + total: 1, + hits: [ + { + id: 'item-from-search', + type: 'dashboard', + updatedAt: new Date('2023-07-01').toISOString(), + attributes: { + title: 'Item from search', + }, + references: [], + }, + ], + }); + + expected = 'foo'; + await updateSearchText!(expected); + [searchTerm] = getLastCallArgsFromFindItems!(); + expect(getSearchBoxValue!()).toBe(expected); + expect(searchTerm).toBe(expected); + + expect(table.getMetaData('itemsInMemTable').tableCellsValues).toMatchInlineSnapshot(` + Array [ + Array [ + "Item from search", + "July 1, 2023", + ], + ] + `); + }); + + test('should search and render empty list if no result', async () => { + let testBed: TestBed; + let updateSearchText: (value: string) => Promise; + + await act(async () => { + ({ testBed, updateSearchText } = await setupSearch()); + }); + + const { component, table, find } = testBed!; + component.update(); + + findItems.mockResolvedValueOnce({ + total: 0, + hits: [], + }); + + await updateSearchText!('unknown items'); + + expect(table.getMetaData('itemsInMemTable').tableCellsValues).toMatchInlineSnapshot(` + Array [ + Array [ + "No Foos matched your search.", + ], + ] + `); + + await act(async () => { + find('clearSearchButton').simulate('click'); + }); + component.update(); + + // We should get back the initial 2 items (Item 1 and Item 2) + expect(table.getMetaData('itemsInMemTable').tableCellsValues).toMatchInlineSnapshot(` + Array [ + Array [ + "Item 1", + "Sat Jul 15 2023", + ], + Array [ + "Item 2", + "Sat Jul 15 2023", + ], + ] + `); + }); + }); + describe('url state', () => { let router: Router | undefined; @@ -1153,10 +1380,11 @@ describe('TableListView', () => { }; test('should allow select items to be deleted', async () => { - const { - testBed: { table, find, exists, component, form }, - deleteItems, - } = await setupTest(); + const { testBed, deleteItems } = await setupTest(); + + const { table, exists, component } = testBed; + const { selectRow, clickDeleteSelectedItemsButton, clickConfirmModalButton } = + getActions(testBed); const { tableCellsValues } = table.getMetaData('itemsInMemTable'); @@ -1165,28 +1393,21 @@ describe('TableListView', () => { ['', 'Item 1Item 1 description', twoDaysAgoToString], ]); + // Select the second item const selectedHit = hits[1]; expect(exists('deleteSelectedItems')).toBe(false); - act(() => { - // Select the second item - form.selectCheckBox(`checkboxSelectRow-${selectedHit.id}`); - }); - component.update(); + + selectRow(selectedHit.id); // Delete button is now visible expect(exists('deleteSelectedItems')).toBe(true); // Click delete and validate that confirm modal opens expect(component.exists('.euiModal--confirmation')).toBe(false); - act(() => { - find('deleteSelectedItems').simulate('click'); - }); - component.update(); + clickDeleteSelectedItemsButton(); expect(component.exists('.euiModal--confirmation')).toBe(true); - await act(async () => { - find('confirmModalConfirmButton').simulate('click'); - }); + await clickConfirmModalButton(); expect(deleteItems).toHaveBeenCalledWith([selectedHit]); }); diff --git a/packages/content-management/table_list_view_table/src/table_list_view_table.tsx b/packages/content-management/table_list_view_table/src/table_list_view_table.tsx index 33ef91dc65e4b..9d7613c6a122d 100644 --- a/packages/content-management/table_list_view_table/src/table_list_view_table.tsx +++ b/packages/content-management/table_list_view_table/src/table_list_view_table.tsx @@ -108,6 +108,7 @@ export interface TableListViewTableProps< contentEditor?: ContentEditorConfig; tableCaption: string; + /** Flag to force a new fetch of the table items. Whenever it changes, the `findItems()` will be called. */ refreshListBouncer?: boolean; onFetchSuccess: () => void; setPageDataTestSubject: (subject: string) => void; @@ -115,6 +116,12 @@ export interface TableListViewTableProps< export interface State { items: T[]; + /** + * Flag to indicate if there aren't any item when **no filteres are applied**. + * When there are no item we render an empty prompt. + * Default to `undefined` to indicate that we don't know yet if there are items or not. + */ + hasNoItems: boolean | undefined; hasInitialFetchReturned: boolean; isFetchingItems: boolean; isDeletingItems: boolean; @@ -293,6 +300,7 @@ function TableListViewTableComp({ const isMounted = useRef(false); const fetchIdx = useRef(0); + /** * The "onTableSearchChange()" handler has an async behavior. We want to be able to discard * previsous search changes and only handle the last one. For that we keep a counter of the changes. @@ -335,9 +343,10 @@ function TableListViewTableComp({ const initialState = useMemo>( () => ({ items: [], + hasNoItems: undefined, totalItems: 0, hasInitialFetchReturned: false, - isFetchingItems: false, + isFetchingItems: true, isDeletingItems: false, showDeleteModal: false, hasUpdatedAtMetadata: false, @@ -364,6 +373,7 @@ function TableListViewTableComp({ hasInitialFetchReturned, isFetchingItems, items, + hasNoItems, fetchError, showDeleteModal, isDeletingItems, @@ -374,8 +384,6 @@ function TableListViewTableComp({ tableSort, } = state; - const hasQuery = searchQuery.text !== ''; - const hasNoItems = hasInitialFetchReturned && items.length === 0 && !hasQuery; const showFetchError = Boolean(fetchError); const showLimitError = !showFetchError && totalItems > listingLimit; @@ -857,17 +865,7 @@ function TableListViewTableComp({ // ------------ // Effects // ------------ - useDebounce( - () => { - // Do not call fetchItems on dependency changes when initial fetch does not load any items - // to avoid flashing between empty table and no items view - if (!hasNoItems) { - fetchItems(); - } - }, - 300, - [fetchItems, refreshListBouncer] - ); + useDebounce(fetchItems, 300, [fetchItems, refreshListBouncer]); useEffect(() => { if (!urlStateEnabled) { diff --git a/packages/core/application/core-application-browser-internal/src/application_service.test.ts b/packages/core/application/core-application-browser-internal/src/application_service.test.ts index 09e7ed5a385a4..baf0947913d01 100644 --- a/packages/core/application/core-application-browser-internal/src/application_service.test.ts +++ b/packages/core/application/core-application-browser-internal/src/application_service.test.ts @@ -1145,7 +1145,7 @@ describe('#start()', () => { removeListenerSpy = jest.spyOn(window, 'removeEventListener'); }); afterEach(() => { - jest.restoreAllMocks(); + jest.clearAllMocks(); }); it('calls `navigateToApp` with `skipAppLeave` option', async () => { @@ -1232,7 +1232,7 @@ describe('#stop()', () => { }); afterEach(() => { - jest.restoreAllMocks(); + jest.clearAllMocks(); }); it('removes the beforeunload listener', async () => { diff --git a/packages/core/chrome/core-chrome-browser-internal/src/project_navigation/home_breadcrumbs.tsx b/packages/core/chrome/core-chrome-browser-internal/src/project_navigation/home_breadcrumbs.tsx index d11b614fe2ac2..62bfad1b78090 100644 --- a/packages/core/chrome/core-chrome-browser-internal/src/project_navigation/home_breadcrumbs.tsx +++ b/packages/core/chrome/core-chrome-browser-internal/src/project_navigation/home_breadcrumbs.tsx @@ -20,5 +20,6 @@ export const createHomeBreadcrumb = ({ text: , title: i18n.translate('core.ui.chrome.breadcrumbs.homeLink', { defaultMessage: 'Home' }), href: homeHref, + 'data-test-subj': 'breadcrumb-home', }; }; diff --git a/packages/core/chrome/core-chrome-browser-internal/src/project_navigation/project_navigation_service.test.ts b/packages/core/chrome/core-chrome-browser-internal/src/project_navigation/project_navigation_service.test.ts index 8b7424bf0d019..ef0c33330a57d 100644 --- a/packages/core/chrome/core-chrome-browser-internal/src/project_navigation/project_navigation_service.test.ts +++ b/packages/core/chrome/core-chrome-browser-internal/src/project_navigation/project_navigation_service.test.ts @@ -80,6 +80,7 @@ describe('breadcrumbs', () => { expect(breadcrumbs).toMatchInlineSnapshot(` Array [ Object { + "data-test-subj": "breadcrumb-home", "href": "/", "text": { "title": "Home", }, Object { + "data-test-subj": "breadcrumb-deepLinkId-navItem1", "href": "/foo/item1", "text": "Nav Item 1", }, @@ -117,6 +119,7 @@ describe('breadcrumbs', () => { expect(breadcrumbs).toMatchInlineSnapshot(` Array [ Object { + "data-test-subj": "breadcrumb-home", "href": "/", "text": ({ href: node.deepLink?.url ?? node.href, text: node.title, + 'data-test-subj': classnames({ + [`breadcrumb-deepLinkId-${node.deepLink?.id}`]: !!node.deepLink, + }), }) ); @@ -140,7 +144,8 @@ export class ProjectNavigationService { const activeNodes = findActiveNodes( currentPathname, this.projectNavigationNavTreeFlattened, - location + location, + this.http?.basePath.prepend ); // Each time we call findActiveNodes() we create a new array of activeNodes. As this array is used diff --git a/packages/core/chrome/core-chrome-browser-internal/src/project_navigation/utils.test.ts b/packages/core/chrome/core-chrome-browser-internal/src/project_navigation/utils.test.ts index 940a350f47c06..93abfd5d5a1f7 100644 --- a/packages/core/chrome/core-chrome-browser-internal/src/project_navigation/utils.test.ts +++ b/packages/core/chrome/core-chrome-browser-internal/src/project_navigation/utils.test.ts @@ -254,6 +254,29 @@ describe('findActiveNodes', () => { ]); }); + test('should find active node at the root', () => { + const flattendNavTree: Record = { + '[0]': { + id: 'root', + title: 'Root', + deepLink: getDeepLink('root', `root`), + path: ['root'], + }, + }; + + expect(findActiveNodes(`/foo/root`, flattendNavTree)).toEqual([ + [ + { + id: 'root', + title: 'Root', + isActive: true, + deepLink: getDeepLink('root', `root`), + path: ['root'], + }, + ], + ]); + }); + test('should match the longest matching node', () => { const flattendNavTree: Record = { '[0]': { @@ -345,7 +368,7 @@ describe('findActiveNodes', () => { id: 'item1', title: 'Item 1', path: ['root', 'item1'], - getIsActive: (loc) => loc.pathname.startsWith('/foo'), // Should match + getIsActive: ({ location }) => location.pathname.startsWith('/foo'), // Should match }, '[0][2]': { id: 'item2', diff --git a/packages/core/chrome/core-chrome-browser-internal/src/project_navigation/utils.ts b/packages/core/chrome/core-chrome-browser-internal/src/project_navigation/utils.ts index e8a3750ade156..48158025414cb 100644 --- a/packages/core/chrome/core-chrome-browser-internal/src/project_navigation/utils.ts +++ b/packages/core/chrome/core-chrome-browser-internal/src/project_navigation/utils.ts @@ -73,9 +73,12 @@ function serializeDeeplinkUrl(url?: string) { * @param key The key to extract parent paths from * @returns An array of parent paths */ -function extractParentPaths(key: string) { +function extractParentPaths(key: string, navTree: Record) { // Split the string on every '][' to get an array of values without the brackets. const arr = key.split(']['); + if (arr.length === 1) { + return arr; + } // Add the brackets back in for the first and last elements, and all elements in between. arr[0] = `${arr[0]}]`; arr[arr.length - 1] = `[${arr[arr.length - 1]}`; @@ -83,10 +86,12 @@ function extractParentPaths(key: string) { arr[i] = `[${arr[i]}]`; } - return arr.reduce((acc, currentValue, currentIndex) => { - acc.push(arr.slice(0, currentIndex + 1).join('')); - return acc; - }, []); + return arr + .reduce((acc, currentValue, currentIndex) => { + acc.push(arr.slice(0, currentIndex + 1).join('')); + return acc; + }, []) + .filter((k) => Boolean(navTree[k])); } /** @@ -101,7 +106,8 @@ function extractParentPaths(key: string) { export const findActiveNodes = ( currentPathname: string, navTree: Record, - location?: Location + location?: Location, + prepend: (path: string) => string = (path) => path ): ChromeProjectNavigationNode[][] => { const activeNodes: ChromeProjectNavigationNode[][] = []; const matches: string[][] = []; @@ -113,9 +119,9 @@ export const findActiveNodes = ( Object.entries(navTree).forEach(([key, node]) => { if (node.getIsActive && location) { - const isActive = node.getIsActive(location); + const isActive = node.getIsActive({ pathNameSerialized: currentPathname, location, prepend }); if (isActive) { - const keysWithParents = extractParentPaths(key); + const keysWithParents = extractParentPaths(key, navTree); activeNodes.push(keysWithParents.map(activeNodeFromKey)); } return; @@ -139,7 +145,7 @@ export const findActiveNodes = ( if (matches.length > 0) { const longestMatch = matches[matches.length - 1]; longestMatch.forEach((key) => { - const keysWithParents = extractParentPaths(key); + const keysWithParents = extractParentPaths(key, navTree); activeNodes.push(keysWithParents.map(activeNodeFromKey)); }); } diff --git a/packages/core/chrome/core-chrome-browser-internal/src/ui/header/__snapshots__/collapsible_nav.test.tsx.snap b/packages/core/chrome/core-chrome-browser-internal/src/ui/header/__snapshots__/collapsible_nav.test.tsx.snap index a2c9d6044173b..476776a40a155 100644 --- a/packages/core/chrome/core-chrome-browser-internal/src/ui/header/__snapshots__/collapsible_nav.test.tsx.snap +++ b/packages/core/chrome/core-chrome-browser-internal/src/ui/header/__snapshots__/collapsible_nav.test.tsx.snap @@ -162,7 +162,7 @@ Array [ >
    onClick(e, forceNavigation, navLinks, navigateToApp)} - className="euiHeaderLogo" + className="chrHeaderLogo" href={href} data-test-subj="logo" aria-label={i18n.translate('core.ui.chrome.headerGlobalNav.goHomePageIconAriaLabel', { diff --git a/packages/core/chrome/core-chrome-browser/index.ts b/packages/core/chrome/core-chrome-browser/index.ts index d42d859cc6f3b..2e587cbcda497 100644 --- a/packages/core/chrome/core-chrome-browser/index.ts +++ b/packages/core/chrome/core-chrome-browser/index.ts @@ -34,6 +34,7 @@ export type { ChromeUserBanner, ChromeProjectNavigation, ChromeProjectNavigationNode, + CloudLinkId, SideNavCompProps, SideNavComponent, ChromeProjectBreadcrumb, diff --git a/packages/core/chrome/core-chrome-browser/src/index.ts b/packages/core/chrome/core-chrome-browser/src/index.ts index 7a414fc87164e..b931f05ecd327 100644 --- a/packages/core/chrome/core-chrome-browser/src/index.ts +++ b/packages/core/chrome/core-chrome-browser/src/index.ts @@ -33,6 +33,7 @@ export type { ChromeProjectNavigationNode, AppDeepLinkId, AppId, + CloudLinkId, SideNavCompProps, SideNavComponent, ChromeSetProjectBreadcrumbsParams, diff --git a/packages/core/chrome/core-chrome-browser/src/project_navigation.ts b/packages/core/chrome/core-chrome-browser/src/project_navigation.ts index 5be1d505f2ff9..38317cfc1e0f2 100644 --- a/packages/core/chrome/core-chrome-browser/src/project_navigation.ts +++ b/packages/core/chrome/core-chrome-browser/src/project_navigation.ts @@ -44,6 +44,18 @@ export type AppDeepLinkId = | SearchLink | ObservabilityLink; +/** @public */ +export type CloudLinkId = 'userAndRoles' | 'performance' | 'billingAndSub'; + +export type GetIsActiveFn = (params: { + /** The current path name including the basePath + hash value but **without** any query params */ + pathNameSerialized: string; + /** The history Location */ + location: Location; + /** Utiliy function to prepend a path with the basePath */ + prepend: (path: string) => string; +}) => boolean; + /** @public */ export interface ChromeProjectNavigationNode { /** Optional id, if not passed a "link" must be provided. */ @@ -69,7 +81,7 @@ export interface ChromeProjectNavigationNode { /** * Optional function to get the active state. This function is called whenever the location changes. */ - getIsActive?: (location: Location) => boolean; + getIsActive?: GetIsActiveFn; /** * Optional flag to indicate if the breadcrumb should be hidden when this node is active. @@ -123,6 +135,8 @@ export interface NodeDefinition< title?: string; /** App id or deeplink id */ link?: LinkId; + /** Cloud link id */ + cloudLink?: CloudLinkId; /** Optional icon for the navigation node. Note: not all navigation depth will render the icon */ icon?: string; /** Optional children of the navigation node */ @@ -134,7 +148,7 @@ export interface NodeDefinition< /** * Optional function to get the active state. This function is called whenever the location changes. */ - getIsActive?: (location: Location) => boolean; + getIsActive?: GetIsActiveFn; /** * Optional flag to indicate if the breadcrumb should be hidden when this node is active. diff --git a/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/get_ecs_response_log.test.ts b/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/get_ecs_response_log.test.ts index 03c8c118edcf2..af9470d18e892 100644 --- a/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/get_ecs_response_log.test.ts +++ b/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/get_ecs_response_log.test.ts @@ -91,6 +91,23 @@ describe('getEcsResponseLog', () => { `); }); + test('redacts es-client-authentication headers by default', () => { + const event = createResponseEvent({ + requestParams: { + headers: { 'es-client-authentication': 'ae3fda37-xxx', 'user-agent': 'world' }, + }, + response: { headers: { 'content-length': '123' } }, + }); + const log = getEcsResponseLog(event); + // @ts-expect-error ECS custom field + expect(log.http.request.headers).toMatchInlineSnapshot(` + Object { + "es-client-authentication": "[REDACTED]", + "user-agent": "world", + } + `); + }); + test('does not mutate original headers', () => { const reqHeaders = { a: 'foo', b: ['hello', 'world'] }; const resHeaders = { c: 'bar' }; diff --git a/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/get_ecs_response_log.ts b/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/get_ecs_response_log.ts index fa122166ada08..6b44c48925438 100644 --- a/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/get_ecs_response_log.ts +++ b/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/get_ecs_response_log.ts @@ -12,7 +12,13 @@ import { type LogMeta } from '@kbn/logging'; // If you are updating these, consider whether they should also be updated in the // http service `getResponseLog` -const FORBIDDEN_HEADERS = ['authorization', 'cookie', 'set-cookie', 'x-elastic-app-auth']; +const FORBIDDEN_HEADERS = [ + 'authorization', + 'cookie', + 'set-cookie', + 'x-elastic-app-auth', + 'es-client-authentication', +]; const REDACTED_HEADER_TEXT = '[REDACTED]'; // We are excluding sensitive headers by default, until we have a log filtering mechanism. diff --git a/packages/core/elasticsearch/core-elasticsearch-server-internal/src/is_valid_connection.ts b/packages/core/elasticsearch/core-elasticsearch-server-internal/src/is_valid_connection.ts index 609fa714243f4..b36f89cdc8317 100644 --- a/packages/core/elasticsearch/core-elasticsearch-server-internal/src/is_valid_connection.ts +++ b/packages/core/elasticsearch/core-elasticsearch-server-internal/src/is_valid_connection.ts @@ -6,9 +6,9 @@ * Side Public License, v 1. */ -import { filter, first } from 'rxjs/operators'; +import { filter } from 'rxjs/operators'; import { errors } from '@elastic/elasticsearch'; -import { Observable } from 'rxjs'; +import { Observable, firstValueFrom } from 'rxjs'; import { NodesVersionCompatibility } from './version_check/ensure_es_version'; /** @@ -23,8 +23,8 @@ import { NodesVersionCompatibility } from './version_check/ensure_es_version'; export async function isValidConnection( esNodesCompatibility$: Observable ) { - return await esNodesCompatibility$ - .pipe( + return await firstValueFrom( + esNodesCompatibility$.pipe( filter(({ nodesInfoRequestError, isCompatible }) => { if ( nodesInfoRequestError && @@ -35,8 +35,7 @@ export async function isValidConnection( throw nodesInfoRequestError; } return isCompatible; - }), - first() + }) ) - .toPromise(); + ); } diff --git a/packages/core/http/core-http-server-internal/src/logging/get_response_log.test.ts b/packages/core/http/core-http-server-internal/src/logging/get_response_log.test.ts index a8f607c5c6865..a77283b6575ff 100644 --- a/packages/core/http/core-http-server-internal/src/logging/get_response_log.test.ts +++ b/packages/core/http/core-http-server-internal/src/logging/get_response_log.test.ts @@ -211,6 +211,21 @@ describe('getEcsResponseLog', () => { `); }); + test('redacts es-client-authentication headers by default', () => { + const req = createMockHapiRequest({ + headers: { 'es-client-authentication': 'ae3fda37-xxx', 'user-agent': 'world' }, + response: { headers: { 'content-length': '123' } }, + }); + const result = getEcsResponseLog(req, logger); + // @ts-expect-error ECS custom field + expect(result.meta.http.request.headers).toMatchInlineSnapshot(` + Object { + "es-client-authentication": "[REDACTED]", + "user-agent": "world", + } + `); + }); + test('does not mutate original headers', () => { const reqHeaders = { a: 'foo', b: ['hello', 'world'] }; const resHeaders = { headers: { c: 'bar' } }; diff --git a/packages/core/http/core-http-server-internal/src/logging/get_response_log.ts b/packages/core/http/core-http-server-internal/src/logging/get_response_log.ts index f356bf077095a..2cc9c50a1b319 100644 --- a/packages/core/http/core-http-server-internal/src/logging/get_response_log.ts +++ b/packages/core/http/core-http-server-internal/src/logging/get_response_log.ts @@ -16,7 +16,13 @@ import { getResponsePayloadBytes } from './get_payload_size'; // If you are updating these, consider whether they should also be updated in the // elasticsearch service `getEcsResponseLog` -const FORBIDDEN_HEADERS = ['authorization', 'cookie', 'set-cookie', 'x-elastic-app-auth']; +const FORBIDDEN_HEADERS = [ + 'authorization', + 'cookie', + 'set-cookie', + 'x-elastic-app-auth', + 'es-client-authentication', +]; const REDACTED_HEADER_TEXT = '[REDACTED]'; type HapiHeaders = Record; diff --git a/packages/core/logging/core-logging-server-internal/src/logging_system.test.ts b/packages/core/logging/core-logging-server-internal/src/logging_system.test.ts index b28a95f731f72..81eb539a618fc 100644 --- a/packages/core/logging/core-logging-server-internal/src/logging_system.test.ts +++ b/packages/core/logging/core-logging-server-internal/src/logging_system.test.ts @@ -27,7 +27,7 @@ beforeEach(() => { }); afterEach(() => { - jest.restoreAllMocks(); + jest.clearAllMocks(); mockCreateWriteStream.mockClear(); mockStreamWrite.mockClear(); mockGetFlattenedObject.mockClear(); diff --git a/packages/core/metrics/core-metrics-collectors-server-internal/src/os.test.ts b/packages/core/metrics/core-metrics-collectors-server-internal/src/os.test.ts index 88522d3a9389d..b5775724fda7e 100644 --- a/packages/core/metrics/core-metrics-collectors-server-internal/src/os.test.ts +++ b/packages/core/metrics/core-metrics-collectors-server-internal/src/os.test.ts @@ -25,7 +25,7 @@ describe('OsMetricsCollector', () => { }); afterEach(() => { - jest.restoreAllMocks(); + jest.clearAllMocks(); }); it('collects platform info from the os package', async () => { diff --git a/packages/core/plugins/core-plugins-server-internal/src/discovery/plugins_discovery.test.ts b/packages/core/plugins/core-plugins-server-internal/src/discovery/plugins_discovery.test.ts index ec2605f7aa8af..9ab50d8786cca 100644 --- a/packages/core/plugins/core-plugins-server-internal/src/discovery/plugins_discovery.test.ts +++ b/packages/core/plugins/core-plugins-server-internal/src/discovery/plugins_discovery.test.ts @@ -217,7 +217,7 @@ describe('plugins discovery system', () => { afterEach(() => { mockFs.restore(); // restore the console.log behavior - jest.restoreAllMocks(); + jest.clearAllMocks(); }); it('discovers plugins in the search locations', async () => { diff --git a/packages/core/rendering/core-rendering-server-internal/src/bootstrap/bootstrap_renderer.test.ts b/packages/core/rendering/core-rendering-server-internal/src/bootstrap/bootstrap_renderer.test.ts index 668cbc96904fe..df9589b043d2b 100644 --- a/packages/core/rendering/core-rendering-server-internal/src/bootstrap/bootstrap_renderer.test.ts +++ b/packages/core/rendering/core-rendering-server-internal/src/bootstrap/bootstrap_renderer.test.ts @@ -93,7 +93,7 @@ describe('bootstrapRenderer', () => { expect(uiSettingsClient.get).toHaveBeenCalledWith('theme:darkMode'); }); - it('calls getThemeTag with the values from the UiSettingsClient when the UserSettingsService is not provided', async () => { + it('calls getThemeTag with the values from the UiSettingsClient (true/dark) when the UserSettingsService is not provided', async () => { uiSettingsClient.get.mockResolvedValue(true); const request = httpServerMock.createKibanaRequest(); @@ -110,7 +110,24 @@ describe('bootstrapRenderer', () => { }); }); - it('calls getThemeTag with values from the UserSettingsService when provided', async () => { + it('calls getThemeTag with the values from the UiSettingsClient (false/light) when the UserSettingsService is not provided', async () => { + uiSettingsClient.get.mockResolvedValue(false); + + const request = httpServerMock.createKibanaRequest(); + + await renderer({ + request, + uiSettingsClient, + }); + + expect(getThemeTagMock).toHaveBeenCalledTimes(1); + expect(getThemeTagMock).toHaveBeenCalledWith({ + themeVersion: 'v8', + darkMode: false, + }); + }); + + it('calls getThemeTag with values (true/dark) from the UserSettingsService when provided', async () => { userSettingsService.getUserSettingDarkMode.mockReturnValueOnce(true); renderer = bootstrapRendererFactory({ @@ -136,7 +153,33 @@ describe('bootstrapRenderer', () => { }); }); - it('calls getThemeTag with values from the UiSettingsClient when values from UserSettingsService are `undefined`', async () => { + it('calls getThemeTag with values (false/light) from the UserSettingsService when provided', async () => { + userSettingsService.getUserSettingDarkMode.mockReturnValueOnce(false); + + renderer = bootstrapRendererFactory({ + auth, + packageInfo, + uiPlugins, + serverBasePath: '/base-path', + userSettingsService, + }); + + uiSettingsClient.get.mockResolvedValue(true); + const request = httpServerMock.createKibanaRequest(); + + await renderer({ + request, + uiSettingsClient, + }); + + expect(getThemeTagMock).toHaveBeenCalledTimes(1); + expect(getThemeTagMock).toHaveBeenCalledWith({ + themeVersion: 'v8', + darkMode: false, + }); + }); + + it('calls getThemeTag with values from the UiSettingsClient when values (false/light) from UserSettingsService are `undefined`', async () => { userSettingsService.getUserSettingDarkMode.mockReturnValueOnce(undefined); renderer = bootstrapRendererFactory({ @@ -161,6 +204,32 @@ describe('bootstrapRenderer', () => { darkMode: false, }); }); + + it('calls getThemeTag with values from the UiSettingsClient when values (true/dark) from UserSettingsService are `undefined`', async () => { + userSettingsService.getUserSettingDarkMode.mockReturnValueOnce(undefined); + + renderer = bootstrapRendererFactory({ + auth, + packageInfo, + uiPlugins, + serverBasePath: '/base-path', + userSettingsService, + }); + + uiSettingsClient.get.mockResolvedValue(true); + const request = httpServerMock.createKibanaRequest(); + + await renderer({ + request, + uiSettingsClient, + }); + + expect(getThemeTagMock).toHaveBeenCalledTimes(1); + expect(getThemeTagMock).toHaveBeenCalledWith({ + themeVersion: 'v8', + darkMode: true, + }); + }); }); describe('when the auth status is `unknown`', () => { diff --git a/packages/core/rendering/core-rendering-server-internal/src/bootstrap/bootstrap_renderer.ts b/packages/core/rendering/core-rendering-server-internal/src/bootstrap/bootstrap_renderer.ts index abda18486657f..861cd7495ccce 100644 --- a/packages/core/rendering/core-rendering-server-internal/src/bootstrap/bootstrap_renderer.ts +++ b/packages/core/rendering/core-rendering-server-internal/src/bootstrap/bootstrap_renderer.ts @@ -63,7 +63,7 @@ export const bootstrapRendererFactory: BootstrapRendererFactory = ({ if (authenticated) { const userSettingDarkMode = await userSettingsService?.getUserSettingDarkMode(request); - if (userSettingDarkMode) { + if (userSettingDarkMode !== undefined) { darkMode = userSettingDarkMode; } else { darkMode = await uiSettingsClient.get('theme:darkMode'); diff --git a/packages/core/rendering/core-rendering-server-internal/src/views/template.tsx b/packages/core/rendering/core-rendering-server-internal/src/views/template.tsx index bbc8109e403da..bac48c88e1b23 100644 --- a/packages/core/rendering/core-rendering-server-internal/src/views/template.tsx +++ b/packages/core/rendering/core-rendering-server-internal/src/views/template.tsx @@ -54,8 +54,8 @@ export const Template: FunctionComponent = ({ {/* Inject EUI reset and global styles before all other component styles */} - + {/* Inject stylesheets into the before scripts so that KP plugins with bundled styles will override them */} diff --git a/packages/core/root/core-root-server-internal/src/root/index.test.ts b/packages/core/root/core-root-server-internal/src/root/index.test.ts index 5371c30a03cd6..0610d940053dc 100644 --- a/packages/core/root/core-root-server-internal/src/root/index.test.ts +++ b/packages/core/root/core-root-server-internal/src/root/index.test.ts @@ -29,7 +29,7 @@ beforeEach(() => { }); afterEach(() => { - jest.restoreAllMocks(); + jest.clearAllMocks(); logger.asLoggerFactory.mockClear(); logger.stop.mockClear(); rawConfigService.getConfig$.mockClear(); @@ -139,6 +139,21 @@ test('stops services on "shutdown" an calls `onShutdown` with error passed to `s expect(mockServer.stop).toHaveBeenCalledTimes(1); }); +test('only shutdowns once', async () => { + const mockOnShutdown = jest.fn(); + const root = new Root(rawConfigService, env, mockOnShutdown); + + await root.preboot(); + await root.setup(); + await root.start(); + + await root.shutdown(); + await root.shutdown(); + + expect(mockOnShutdown).toHaveBeenCalledTimes(1); + expect(mockServer.stop).toHaveBeenCalledTimes(1); +}); + test('fails and stops services if server preboot fails', async () => { const mockOnShutdown = jest.fn(); const root = new Root(rawConfigService, env, mockOnShutdown); diff --git a/packages/core/root/core-root-server-internal/src/root/index.ts b/packages/core/root/core-root-server-internal/src/root/index.ts index 42949fda6b31d..34f54fa1ebad8 100644 --- a/packages/core/root/core-root-server-internal/src/root/index.ts +++ b/packages/core/root/core-root-server-internal/src/root/index.ts @@ -34,6 +34,7 @@ export class Root { private readonly server: Server; private loggingConfigSubscription?: Subscription; private apmConfigSubscription?: Subscription; + private shuttingDown: boolean = false; constructor( rawConfigProvider: RawConfigurationProvider, @@ -81,6 +82,11 @@ export class Root { } public async shutdown(reason?: any) { + if (this.shuttingDown) { + return; + } + this.shuttingDown = true; + this.log.info('Kibana is shutting down'); if (reason) { diff --git a/packages/core/ui-settings/core-ui-settings-browser-internal/src/__snapshots__/ui_settings_api.test.ts.snap b/packages/core/ui-settings/core-ui-settings-browser-internal/src/__snapshots__/ui_settings_api.test.ts.snap index abee12da71e6b..b80765e3536c9 100644 --- a/packages/core/ui-settings/core-ui-settings-browser-internal/src/__snapshots__/ui_settings_api.test.ts.snap +++ b/packages/core/ui-settings/core-ui-settings-browser-internal/src/__snapshots__/ui_settings_api.test.ts.snap @@ -3,7 +3,7 @@ exports[`#batchSet Buffers are always clear of previously buffered changes: two requests, second only sends bar, not foo 1`] = ` Array [ Array [ - "/foo/bar/api/kibana/settings", + "/foo/bar/internal/kibana/settings", Object { "headers": Object { "accept": "application/json", @@ -15,7 +15,7 @@ Array [ }, ], Array [ - "/foo/bar/api/kibana/settings", + "/foo/bar/internal/kibana/settings", Object { "headers": Object { "accept": "application/json", @@ -32,7 +32,7 @@ Array [ exports[`#batchSet Overwrites previously buffered values with new values for the same key: two requests, foo=d in final 1`] = ` Array [ Array [ - "/foo/bar/api/kibana/settings", + "/foo/bar/internal/kibana/settings", Object { "headers": Object { "accept": "application/json", @@ -44,7 +44,7 @@ Array [ }, ], Array [ - "/foo/bar/api/kibana/settings", + "/foo/bar/internal/kibana/settings", Object { "headers": Object { "accept": "application/json", @@ -61,7 +61,7 @@ Array [ exports[`#batchSet buffers changes while first request is in progress, sends buffered changes after first request completes: final, includes both requests 1`] = ` Array [ Array [ - "/foo/bar/api/kibana/settings", + "/foo/bar/internal/kibana/settings", Object { "headers": Object { "accept": "application/json", @@ -73,7 +73,7 @@ Array [ }, ], Array [ - "/foo/bar/api/kibana/settings", + "/foo/bar/internal/kibana/settings", Object { "headers": Object { "accept": "application/json", @@ -113,7 +113,7 @@ exports[`#batchSet rejects on 500 1`] = `"Request failed with status code: 500"` exports[`#batchSet sends a single change immediately: single change 1`] = ` Array [ Array [ - "/foo/bar/api/kibana/settings", + "/foo/bar/internal/kibana/settings", Object { "headers": Object { "accept": "application/json", @@ -130,7 +130,7 @@ Array [ exports[`#batchSetGlobal Buffers are always clear of previously buffered changes: two requests, second only sends bar, not foo 1`] = ` Array [ Array [ - "/foo/bar/api/kibana/global_settings", + "/foo/bar/internal/kibana/global_settings", Object { "headers": Object { "accept": "application/json", @@ -142,7 +142,7 @@ Array [ }, ], Array [ - "/foo/bar/api/kibana/global_settings", + "/foo/bar/internal/kibana/global_settings", Object { "headers": Object { "accept": "application/json", @@ -159,7 +159,7 @@ Array [ exports[`#batchSetGlobal Overwrites previously buffered values with new values for the same key: two requests, foo=d in final 1`] = ` Array [ Array [ - "/foo/bar/api/kibana/global_settings", + "/foo/bar/internal/kibana/global_settings", Object { "headers": Object { "accept": "application/json", @@ -171,7 +171,7 @@ Array [ }, ], Array [ - "/foo/bar/api/kibana/global_settings", + "/foo/bar/internal/kibana/global_settings", Object { "headers": Object { "accept": "application/json", @@ -188,7 +188,7 @@ Array [ exports[`#batchSetGlobal buffers changes while first request is in progress, sends buffered changes after first request completes: final, includes both requests 1`] = ` Array [ Array [ - "/foo/bar/api/kibana/global_settings", + "/foo/bar/internal/kibana/global_settings", Object { "headers": Object { "accept": "application/json", @@ -200,7 +200,7 @@ Array [ }, ], Array [ - "/foo/bar/api/kibana/global_settings", + "/foo/bar/internal/kibana/global_settings", Object { "headers": Object { "accept": "application/json", @@ -240,7 +240,7 @@ exports[`#batchSetGlobal rejects on 500 1`] = `"Request failed with status code: exports[`#batchSetGlobal sends a single change immediately: single change 1`] = ` Array [ Array [ - "/foo/bar/api/kibana/global_settings", + "/foo/bar/internal/kibana/global_settings", Object { "headers": Object { "accept": "application/json", diff --git a/packages/core/ui-settings/core-ui-settings-browser-internal/src/ui_settings_api.ts b/packages/core/ui-settings/core-ui-settings-browser-internal/src/ui_settings_api.ts index 98141eb1163b5..c96232b9f9b48 100644 --- a/packages/core/ui-settings/core-ui-settings-browser-internal/src/ui_settings_api.ts +++ b/packages/core/ui-settings/core-ui-settings-browser-internal/src/ui_settings_api.ts @@ -137,7 +137,8 @@ export class UiSettingsApi { try { this.sendInProgress = true; - const path = scope === 'namespace' ? '/api/kibana/settings' : '/api/kibana/global_settings'; + const path = + scope === 'namespace' ? '/internal/kibana/settings' : '/internal/kibana/global_settings'; changes.callback( undefined, await this.sendRequest('POST', path, { diff --git a/packages/core/ui-settings/core-ui-settings-server-internal/src/routes/index.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/routes/index.ts index 22ca2ae38cde5..1fa1afa333e23 100644 --- a/packages/core/ui-settings/core-ui-settings-server-internal/src/routes/index.ts +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/routes/index.ts @@ -18,3 +18,5 @@ export function registerRoutes(router: InternalUiSettingsRouter) { registerSetRoute(router); registerSetManyRoute(router); } + +export { registerInternalRoutes } from './internal'; diff --git a/packages/core/ui-settings/core-ui-settings-server-internal/src/routes/internal/delete.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/routes/internal/delete.ts new file mode 100644 index 0000000000000..91a81a252edd2 --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/routes/internal/delete.ts @@ -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 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 { schema } from '@kbn/config-schema'; + +import { SavedObjectsErrorHelpers } from '@kbn/core-saved-objects-server'; +import { IUiSettingsClient } from '@kbn/core-ui-settings-server'; +import { KibanaRequest, KibanaResponseFactory } from '@kbn/core-http-server'; +import type { InternalUiSettingsRouter } from '../../internal_types'; +import { CannotOverrideError } from '../../ui_settings_errors'; +import { InternalUiSettingsRequestHandlerContext } from '../../internal_types'; + +const validate = { + params: schema.object({ + key: schema.string(), + }), +}; + +export function registerInternalDeleteRoute(router: InternalUiSettingsRouter) { + const deleteFromRequest = async ( + uiSettingsClient: IUiSettingsClient, + context: InternalUiSettingsRequestHandlerContext, + request: KibanaRequest, unknown, unknown, 'delete'>, + response: KibanaResponseFactory + ) => { + try { + await uiSettingsClient.remove(request.params.key); + + return response.ok({ + body: { + settings: await uiSettingsClient.getUserProvided(), + }, + }); + } catch (error) { + if (SavedObjectsErrorHelpers.isSavedObjectsClientError(error)) { + return response.customError({ + body: error, + statusCode: error.output.statusCode, + }); + } + + if (error instanceof CannotOverrideError) { + return response.badRequest({ body: error }); + } + + throw error; + } + }; + router.delete( + { path: '/internal/kibana/settings/{key}', validate, options: { access: 'internal' } }, + async (context, request, response) => { + const uiSettingsClient = (await context.core).uiSettings.client; + return await deleteFromRequest(uiSettingsClient, context, request, response); + } + ); + router.delete( + { path: '/internal/kibana/global_settings/{key}', validate, options: { access: 'internal' } }, + async (context, request, response) => { + const uiSettingsClient = (await context.core).uiSettings.globalClient; + return await deleteFromRequest(uiSettingsClient, context, request, response); + } + ); +} diff --git a/packages/core/ui-settings/core-ui-settings-server-internal/src/routes/internal/get.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/routes/internal/get.ts new file mode 100644 index 0000000000000..f9323f45e786d --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/routes/internal/get.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 { SavedObjectsErrorHelpers } from '@kbn/core-saved-objects-server'; +import { IUiSettingsClient } from '@kbn/core-ui-settings-server'; +import { KibanaRequest, KibanaResponseFactory } from '@kbn/core-http-server'; +import { InternalUiSettingsRequestHandlerContext } from '../../internal_types'; +import type { InternalUiSettingsRouter } from '../../internal_types'; + +export function registerInternalGetRoute(router: InternalUiSettingsRouter) { + const getFromRequest = async ( + uiSettingsClient: IUiSettingsClient, + context: InternalUiSettingsRequestHandlerContext, + request: KibanaRequest, + response: KibanaResponseFactory + ) => { + try { + return response.ok({ + body: { + settings: await uiSettingsClient.getUserProvided(), + }, + }); + } catch (error) { + if (SavedObjectsErrorHelpers.isSavedObjectsClientError(error)) { + return response.customError({ + body: error, + statusCode: error.output.statusCode, + }); + } + + throw error; + } + }; + router.get( + { path: '/internal/kibana/settings', validate: false, options: { access: 'internal' } }, + async (context, request, response) => { + const uiSettingsClient = (await context.core).uiSettings.client; + return await getFromRequest(uiSettingsClient, context, request, response); + } + ); + router.get( + { path: '/internal/kibana/global_settings', validate: false, options: { access: 'internal' } }, + async (context, request, response) => { + const uiSettingsClient = (await context.core).uiSettings.globalClient; + return await getFromRequest(uiSettingsClient, context, request, response); + } + ); +} diff --git a/packages/core/ui-settings/core-ui-settings-server-internal/src/routes/internal/index.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/routes/internal/index.ts new file mode 100644 index 0000000000000..e15ded76ab6b8 --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/routes/internal/index.ts @@ -0,0 +1,20 @@ +/* + * 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 { InternalUiSettingsRouter } from '../../internal_types'; +import { registerInternalDeleteRoute } from './delete'; +import { registerInternalGetRoute } from './get'; +import { registerInternalSetManyRoute } from './set_many'; +import { registerInternalSetRoute } from './set'; + +export function registerInternalRoutes(router: InternalUiSettingsRouter) { + registerInternalGetRoute(router); + registerInternalDeleteRoute(router); + registerInternalSetRoute(router); + registerInternalSetManyRoute(router); +} diff --git a/packages/core/ui-settings/core-ui-settings-server-internal/src/routes/internal/set.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/routes/internal/set.ts new file mode 100644 index 0000000000000..a7bc0f8589599 --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/routes/internal/set.ts @@ -0,0 +1,80 @@ +/* + * 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 { schema, ValidationError } from '@kbn/config-schema'; +import { KibanaRequest, KibanaResponseFactory } from '@kbn/core-http-server'; +import { SavedObjectsErrorHelpers } from '@kbn/core-saved-objects-server'; +import { IUiSettingsClient } from '@kbn/core-ui-settings-server'; +import type { + InternalUiSettingsRequestHandlerContext, + InternalUiSettingsRouter, +} from '../../internal_types'; +import { CannotOverrideError } from '../../ui_settings_errors'; + +const validate = { + params: schema.object({ + key: schema.string(), + }), + body: schema.object({ + value: schema.any(), + }), +}; + +export function registerInternalSetRoute(router: InternalUiSettingsRouter) { + const setFromRequest = async ( + uiSettingsClient: IUiSettingsClient, + context: InternalUiSettingsRequestHandlerContext, + request: KibanaRequest< + Readonly<{} & { key: string }>, + unknown, + Readonly<{ value?: any } & {}>, + 'post' + >, + response: KibanaResponseFactory + ) => { + try { + const { key } = request.params; + const { value } = request.body; + + await uiSettingsClient.set(key, value); + + return response.ok({ + body: { + settings: await uiSettingsClient.getUserProvided(), + }, + }); + } catch (error) { + if (SavedObjectsErrorHelpers.isSavedObjectsClientError(error)) { + return response.customError({ + body: error, + statusCode: error.output.statusCode, + }); + } + + if (error instanceof CannotOverrideError || error instanceof ValidationError) { + return response.badRequest({ body: error }); + } + + throw error; + } + }; + router.post( + { path: '/internal/kibana/settings/{key}', validate, options: { access: 'internal' } }, + async (context, request, response) => { + const uiSettingsClient = (await context.core).uiSettings.client; + return await setFromRequest(uiSettingsClient, context, request, response); + } + ); + router.post( + { path: '/internal/kibana/global_settings/{key}', validate, options: { access: 'internal' } }, + async (context, request, response) => { + const uiSettingsClient = (await context.core).uiSettings.globalClient; + return await setFromRequest(uiSettingsClient, context, request, response); + } + ); +} diff --git a/packages/core/ui-settings/core-ui-settings-server-internal/src/routes/internal/set_many.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/routes/internal/set_many.ts new file mode 100644 index 0000000000000..155f9c81120db --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/routes/internal/set_many.ts @@ -0,0 +1,71 @@ +/* + * 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 { schema, ValidationError } from '@kbn/config-schema'; +import { SavedObjectsErrorHelpers } from '@kbn/core-saved-objects-server'; +import { KibanaRequest, KibanaResponseFactory } from '@kbn/core-http-server'; +import { IUiSettingsClient } from '@kbn/core-ui-settings-server'; +import type { InternalUiSettingsRouter } from '../../internal_types'; +import { CannotOverrideError } from '../../ui_settings_errors'; +import { InternalUiSettingsRequestHandlerContext } from '../../internal_types'; + +const validate = { + body: schema.object({ + changes: schema.object({}, { unknowns: 'allow' }), + }), +}; + +export function registerInternalSetManyRoute(router: InternalUiSettingsRouter) { + const setManyFromRequest = async ( + uiSettingsClient: IUiSettingsClient, + context: InternalUiSettingsRequestHandlerContext, + request: KibanaRequest, 'post'>, + response: KibanaResponseFactory + ) => { + try { + const { changes } = request.body; + + await uiSettingsClient.setMany(changes); + + return response.ok({ + body: { + settings: await uiSettingsClient.getUserProvided(), + }, + }); + } catch (error) { + if (SavedObjectsErrorHelpers.isSavedObjectsClientError(error)) { + return response.customError({ + body: error, + statusCode: error.output.statusCode, + }); + } + + if (error instanceof CannotOverrideError || error instanceof ValidationError) { + return response.badRequest({ body: error }); + } + + throw error; + } + }; + + router.post( + { path: '/internal/kibana/settings', validate, options: { access: 'internal' } }, + async (context, request, response) => { + const uiSettingsClient = (await context.core).uiSettings.client; + return await setManyFromRequest(uiSettingsClient, context, request, response); + } + ); + + router.post( + { path: '/internal/kibana/global_settings', validate, options: { access: 'internal' } }, + async (context, request, response) => { + const uiSettingsClient = (await context.core).uiSettings.globalClient; + return await setManyFromRequest(uiSettingsClient, context, request, response); + } + ); +} diff --git a/packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_config.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_config.ts index 5e5d5a05345ba..bfcc5316a78a0 100644 --- a/packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_config.ts +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_config.ts @@ -17,6 +17,12 @@ const deprecations: ConfigDeprecationProvider = ({ unused, renameFromRoot }) => const configSchema = schema.object({ overrides: schema.object({}, { unknowns: 'allow' }), + publicApiEnabled: schema.conditional( + schema.contextRef('serverless'), + true, + schema.boolean({ defaultValue: false }), + schema.never() + ), }); export type UiSettingsConfigType = TypeOf; diff --git a/packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_service.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_service.ts index 473e7569e2179..3352ab0ab63b0 100644 --- a/packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_service.ts +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_service.ts @@ -25,7 +25,7 @@ import type { } from './types'; import type { InternalUiSettingsRequestHandlerContext } from './internal_types'; import { uiSettingsType, uiSettingsGlobalType } from './saved_objects'; -import { registerRoutes } from './routes'; +import { registerRoutes, registerInternalRoutes } from './routes'; import { getCoreSettings } from './settings'; import { UiSettingsDefaultsClient } from './clients/ui_settings_defaults_client'; @@ -78,12 +78,18 @@ export class UiSettingsService public async setup({ http, savedObjects }: SetupDeps): Promise { this.log.debug('Setting up ui settings service'); + const config = await firstValueFrom(this.config$); + this.overrides = config.overrides; savedObjects.registerType(uiSettingsType); savedObjects.registerType(uiSettingsGlobalType); - registerRoutes(http.createRouter('')); - const config = await firstValueFrom(this.config$); - this.overrides = config.overrides; + const router = http.createRouter(''); + registerInternalRoutes(router); + + // Register public routes by default unless the publicApiEnabled config setting is set to false + if (!config.hasOwnProperty('publicApiEnabled') || config.publicApiEnabled === true) { + registerRoutes(router); + } return { register: this.register, diff --git a/packages/deeplinks/ml/deep_links.ts b/packages/deeplinks/ml/deep_links.ts index f08a1c03e5d0d..d0c79bcec7648 100644 --- a/packages/deeplinks/ml/deep_links.ts +++ b/packages/deeplinks/ml/deep_links.ts @@ -19,7 +19,7 @@ export type LinkId = | 'resultExplorer' | 'analyticsMap' | 'aiOps' - | 'explainLogRateSpikes' + | 'logRateAnalysis' | 'logPatternAnalysis' | 'changePointDetections' | 'modelManagement' diff --git a/packages/default-nav/ml/default_navigation.ts b/packages/default-nav/ml/default_navigation.ts index 5eb99482fd68c..ebd72f5915201 100644 --- a/packages/default-nav/ml/default_navigation.ts +++ b/packages/default-nav/ml/default_navigation.ts @@ -121,7 +121,7 @@ export const defaultNavigation: MlNodeDefinition = { }), children: [ { - link: 'ml:explainLogRateSpikes', + link: 'ml:logRateAnalysis', }, { link: 'ml:logPatternAnalysis', diff --git a/packages/kbn-alerts-as-data-utils/src/schemas/generated/observability_apm_schema.ts b/packages/kbn-alerts-as-data-utils/src/schemas/generated/observability_apm_schema.ts index 2e05360a20f58..813ce72f84505 100644 --- a/packages/kbn-alerts-as-data-utils/src/schemas/generated/observability_apm_schema.ts +++ b/packages/kbn-alerts-as-data-utils/src/schemas/generated/observability_apm_schema.ts @@ -75,6 +75,7 @@ const ObservabilityApmAlertOptional = rt.partial({ }), error: rt.partial({ grouping_key: schemaString, + grouping_name: schemaString, }), kibana: rt.partial({ alert: rt.partial({ diff --git a/packages/kbn-coloring/package.json b/packages/kbn-coloring/package.json index ec8092b3c6130..6b68e62a9d220 100644 --- a/packages/kbn-coloring/package.json +++ b/packages/kbn-coloring/package.json @@ -2,5 +2,6 @@ "name": "@kbn/coloring", "private": true, "version": "1.0.0", - "license": "SSPL-1.0 OR Elastic License 2.0" -} \ No newline at end of file + "license": "SSPL-1.0 OR Elastic License 2.0", + "sideEffects": false +} diff --git a/packages/kbn-config/src/__fixtures__/merge_1.yml b/packages/kbn-config/src/__fixtures__/merge_1.yml new file mode 100644 index 0000000000000..0d540bd61f998 --- /dev/null +++ b/packages/kbn-config/src/__fixtures__/merge_1.yml @@ -0,0 +1,10 @@ +foo: 1 +bar: 3 +arr1: [1, 2, 3] +arr2: [42, 90] +nested: + str1: "foo" + str2: "hello" +obj_array: + - id: 1 + - id: 2 diff --git a/packages/kbn-config/src/__fixtures__/merge_2.yml b/packages/kbn-config/src/__fixtures__/merge_2.yml new file mode 100644 index 0000000000000..acf49c3856c64 --- /dev/null +++ b/packages/kbn-config/src/__fixtures__/merge_2.yml @@ -0,0 +1,8 @@ +foo: 2 +arr1: [4, 5] +arr2: [] +nested: + str1: "bar" + str3: "dolly" +obj_array: + - id: 3 diff --git a/packages/kbn-config/src/raw/__snapshots__/read_config.test.ts.snap b/packages/kbn-config/src/raw/__snapshots__/read_config.test.ts.snap index afdce4e76d3f5..4ad36abc1b481 100644 --- a/packages/kbn-config/src/raw/__snapshots__/read_config.test.ts.snap +++ b/packages/kbn-config/src/raw/__snapshots__/read_config.test.ts.snap @@ -22,6 +22,28 @@ Object { } `; +exports[`merging two configs 1`] = ` +Object { + "arr1": Array [ + 4, + 5, + ], + "arr2": Array [], + "bar": 3, + "foo": 2, + "nested": Object { + "str1": "bar", + "str2": "hello", + "str3": "dolly", + }, + "obj_array": Array [ + Object { + "id": 3, + }, + ], +} +`; + exports[`reads and merges multiple yaml files from file system and parses to json 1`] = ` Object { "abc": Object { diff --git a/packages/kbn-config/src/raw/read_config.test.ts b/packages/kbn-config/src/raw/read_config.test.ts index 5562772885690..0fdacd99d46cf 100644 --- a/packages/kbn-config/src/raw/read_config.test.ts +++ b/packages/kbn-config/src/raw/read_config.test.ts @@ -59,6 +59,11 @@ test('throws parsing another config with forbidden paths', () => { ).toThrowErrorMatchingInlineSnapshot(`"Forbidden path detected: test.hello.__proto__"`); }); +test('merging two configs', () => { + const config = getConfigFromFiles([fixtureFile('merge_1.yml'), fixtureFile('merge_2.yml')]); + expect(config).toMatchSnapshot(); +}); + describe('different cwd()', () => { const originalCwd = process.cwd(); const tempCwd = resolve(__dirname); diff --git a/packages/kbn-config/src/raw/read_config.ts b/packages/kbn-config/src/raw/read_config.ts index 1cf38b52fa3e6..eb8f8df4c8815 100644 --- a/packages/kbn-config/src/raw/read_config.ts +++ b/packages/kbn-config/src/raw/read_config.ts @@ -27,17 +27,29 @@ function replaceEnvVarRefs(val: string) { } function merge(target: Record, value: any, key?: string) { - if ((isPlainObject(value) || Array.isArray(value)) && Object.keys(value).length > 0) { + if (isPlainObject(value) && Object.keys(value).length > 0) { for (const [subKey, subVal] of Object.entries(value)) { merge(target, subVal, key ? `${key}.${subKey}` : subKey); } } else if (key !== undefined) { - set(target, key, typeof value === 'string' ? replaceEnvVarRefs(value) : value); + set(target, key, recursiveReplaceEnvVar(value)); } return target; } +function recursiveReplaceEnvVar(value: any) { + if (isPlainObject(value) || Array.isArray(value)) { + for (const [subKey, subVal] of Object.entries(value)) { + set(value, subKey, recursiveReplaceEnvVar(subVal)); + } + } + if (typeof value === 'string') { + return replaceEnvVarRefs(value); + } + return value; +} + /** @internal */ export const getConfigFromFiles = (configFiles: readonly string[]) => { let mergedYaml = {}; diff --git a/packages/kbn-discover-utils/README.md b/packages/kbn-discover-utils/README.md new file mode 100644 index 0000000000000..17f396f1ec929 --- /dev/null +++ b/packages/kbn-discover-utils/README.md @@ -0,0 +1,4 @@ +# @kbn/discover-utils + +This is the package contains extracting parts of Discover for the usage in other +unified components. This are mainly shared types, utils and mocks. \ No newline at end of file diff --git a/src/plugins/embeddable/public/lib/panel/index.ts b/packages/kbn-discover-utils/index.ts similarity index 81% rename from src/plugins/embeddable/public/lib/panel/index.ts rename to packages/kbn-discover-utils/index.ts index b5066d27c65ac..95cb148929060 100644 --- a/src/plugins/embeddable/public/lib/panel/index.ts +++ b/packages/kbn-discover-utils/index.ts @@ -6,5 +6,4 @@ * Side Public License, v 1. */ -export * from './embeddable_panel'; -export * from './panel_header'; +export { getDocId, buildDataTableRecord, buildDataTableRecordList } from './src'; diff --git a/packages/kbn-discover-utils/jest.config.js b/packages/kbn-discover-utils/jest.config.js new file mode 100644 index 0000000000000..d93b26e9943f4 --- /dev/null +++ b/packages/kbn-discover-utils/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test', + rootDir: '../..', + roots: ['/packages/kbn-discover-utils'], +}; diff --git a/packages/kbn-discover-utils/kibana.jsonc b/packages/kbn-discover-utils/kibana.jsonc new file mode 100644 index 0000000000000..bf77a20bdb863 --- /dev/null +++ b/packages/kbn-discover-utils/kibana.jsonc @@ -0,0 +1,5 @@ +{ + "type": "shared-common", + "id": "@kbn/discover-utils", + "owner": "@elastic/kibana-data-discovery" +} diff --git a/src/plugins/visualization_ui_components/package.json b/packages/kbn-discover-utils/package.json similarity index 65% rename from src/plugins/visualization_ui_components/package.json rename to packages/kbn-discover-utils/package.json index 4df9dbe5d1ee0..0a3257d65ec58 100644 --- a/src/plugins/visualization_ui_components/package.json +++ b/packages/kbn-discover-utils/package.json @@ -1,6 +1,6 @@ { - "name": "@kbn/visualization-ui-components", + "name": "@kbn/discover-utils", "private": true, "version": "1.0.0", "license": "SSPL-1.0 OR Elastic License 2.0" -} +} \ No newline at end of file diff --git a/src/plugins/discover/public/__mocks__/data_view.ts b/packages/kbn-discover-utils/src/__mocks__/data_view.ts similarity index 100% rename from src/plugins/discover/public/__mocks__/data_view.ts rename to packages/kbn-discover-utils/src/__mocks__/data_view.ts diff --git a/src/plugins/discover/public/__mocks__/es_hits.ts b/packages/kbn-discover-utils/src/__mocks__/es_hits.ts similarity index 97% rename from src/plugins/discover/public/__mocks__/es_hits.ts rename to packages/kbn-discover-utils/src/__mocks__/es_hits.ts index b4fa5c019f8dd..a23bb1af0ceaf 100644 --- a/src/plugins/discover/public/__mocks__/es_hits.ts +++ b/packages/kbn-discover-utils/src/__mocks__/es_hits.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -export const esHits = [ +export const esHitsMock = [ { _index: 'i', _id: '1', diff --git a/src/plugins/embeddable/public/lib/actions/index.ts b/packages/kbn-discover-utils/src/__mocks__/index.ts similarity index 86% rename from src/plugins/embeddable/public/lib/actions/index.ts rename to packages/kbn-discover-utils/src/__mocks__/index.ts index d6e1c06129ef5..c7e1333e83815 100644 --- a/src/plugins/embeddable/public/lib/actions/index.ts +++ b/packages/kbn-discover-utils/src/__mocks__/index.ts @@ -6,4 +6,5 @@ * Side Public License, v 1. */ -export * from './edit_panel_action'; +export * from './data_view'; +export * from './es_hits'; diff --git a/src/plugins/visualization_ui_components/common/index.ts b/packages/kbn-discover-utils/src/index.ts similarity index 93% rename from src/plugins/visualization_ui_components/common/index.ts rename to packages/kbn-discover-utils/src/index.ts index 3f66f3b659d8a..a50ff5c59e798 100644 --- a/src/plugins/visualization_ui_components/common/index.ts +++ b/packages/kbn-discover-utils/src/index.ts @@ -6,4 +6,4 @@ * Side Public License, v 1. */ -export {}; +export * from './utils'; diff --git a/packages/kbn-discover-utils/src/types.ts b/packages/kbn-discover-utils/src/types.ts new file mode 100644 index 0000000000000..0b436339f4db9 --- /dev/null +++ b/packages/kbn-discover-utils/src/types.ts @@ -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 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 { SearchHit } from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; + +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/packages/kbn-discover-utils/src/utils/build_data_record.test.ts b/packages/kbn-discover-utils/src/utils/build_data_record.test.ts new file mode 100644 index 0000000000000..ad486aba543a1 --- /dev/null +++ b/packages/kbn-discover-utils/src/utils/build_data_record.test.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 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 { buildDataTableRecord, buildDataTableRecordList } from './build_data_record'; +import { dataViewMock, esHitsMock } from '../__mocks__'; + +describe('Data table record utils', () => { + describe('buildDataTableRecord', () => { + test('should return a DataTableRecord', () => { + const result = buildDataTableRecord(esHitsMock[0], dataViewMock, false); + expect(result).toHaveProperty('id', 'i::1::'); + expect(result).toHaveProperty('raw', esHitsMock[0]); + expect(result).toHaveProperty('flattened'); + expect(result).toHaveProperty('isAnchor', false); + }); + }); + + describe('buildDataTableRecordList', () => { + test('should return a list of DataTableRecord', () => { + const result = buildDataTableRecordList(esHitsMock, dataViewMock); + result.forEach((doc) => { + expect(doc).toHaveProperty('id'); + expect(doc).toHaveProperty('raw'); + expect(doc).toHaveProperty('flattened'); + expect(doc).toHaveProperty('isAnchor'); + }); + }); + }); +}); diff --git a/src/plugins/discover/public/utils/build_data_record.ts b/packages/kbn-discover-utils/src/utils/build_data_record.ts similarity index 92% rename from src/plugins/discover/public/utils/build_data_record.ts rename to packages/kbn-discover-utils/src/utils/build_data_record.ts index 2691fddfb66a9..43adf7b9c8b66 100644 --- a/src/plugins/discover/public/utils/build_data_record.ts +++ b/packages/kbn-discover-utils/src/utils/build_data_record.ts @@ -6,10 +6,10 @@ * 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 { DataView } from '@kbn/data-views-plugin/common'; +import { flattenHit } from '@kbn/data-service'; import type { DataTableRecord, EsHitRecord } from '../types'; +import { getDocId } from './get_doc_id'; /** * Build a record for data table, explorer + classic one diff --git a/packages/kbn-discover-utils/src/utils/get_doc_id.test.ts b/packages/kbn-discover-utils/src/utils/get_doc_id.test.ts new file mode 100644 index 0000000000000..d0eb2b027671a --- /dev/null +++ b/packages/kbn-discover-utils/src/utils/get_doc_id.test.ts @@ -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 { esHitsMock } from '../__mocks__'; +import { getDocId } from './get_doc_id'; + +describe('getDocId', () => { + test('should return unique ID', () => { + const result = getDocId(esHitsMock[0]); + expect(result).toMatchInlineSnapshot(`"i::1::"`); + }); +}); diff --git a/src/plugins/discover/public/utils/get_doc_id.tsx b/packages/kbn-discover-utils/src/utils/get_doc_id.ts similarity index 100% rename from src/plugins/discover/public/utils/get_doc_id.tsx rename to packages/kbn-discover-utils/src/utils/get_doc_id.ts diff --git a/packages/kbn-discover-utils/src/utils/index.ts b/packages/kbn-discover-utils/src/utils/index.ts new file mode 100644 index 0000000000000..fe2ef094c3477 --- /dev/null +++ b/packages/kbn-discover-utils/src/utils/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 * from './build_data_record'; +export * from './get_doc_id'; diff --git a/packages/kbn-discover-utils/tsconfig.json b/packages/kbn-discover-utils/tsconfig.json new file mode 100644 index 0000000000000..2796ebd054d6b --- /dev/null +++ b/packages/kbn-discover-utils/tsconfig.json @@ -0,0 +1,22 @@ +{ + "extends": "../../tsconfig.base.json", + "compilerOptions": { + "outDir": "target/types", + "types": [ + "jest", + "node", + "react" + ] + }, + "include": [ + "**/*.ts", + "**/*.tsx", + ], + "exclude": [ + "target/**/*" + ], + "kbn_references": [ + "@kbn/data-views-plugin", + "@kbn/data-service", + ] +} diff --git a/src/plugins/visualization_ui_components/common/types.ts b/packages/kbn-discover-utils/types.ts similarity index 84% rename from src/plugins/visualization_ui_components/common/types.ts rename to packages/kbn-discover-utils/types.ts index 7da9f13aced8d..41101bba14887 100644 --- a/src/plugins/visualization_ui_components/common/types.ts +++ b/packages/kbn-discover-utils/types.ts @@ -6,4 +6,4 @@ * Side Public License, v 1. */ -export type LineStyle = 'solid' | 'dashed' | 'dotted'; +export type { DataTableRecord, EsHitRecord } from './src/types'; diff --git a/packages/kbn-doc-links/src/get_doc_links.ts b/packages/kbn-doc-links/src/get_doc_links.ts index def26211291d6..6be061f7aaa21 100644 --- a/packages/kbn-doc-links/src/get_doc_links.ts +++ b/packages/kbn-doc-links/src/get_doc_links.ts @@ -721,6 +721,8 @@ export const getDocLinks = ({ kibanaBranch }: GetDocLinkOptions): DocLinks => { datastreamsILM: `${FLEET_DOCS}data-streams.html#data-streams-ilm`, datastreamsNamingScheme: `${FLEET_DOCS}data-streams.html#data-streams-naming-scheme`, datastreamsManualRollover: `${ELASTICSEARCH_DOCS}use-a-data-stream.html#manually-roll-over-a-data-stream`, + datastreamsTSDS: `${ELASTICSEARCH_DOCS}tsds.html`, + datastreamsTSDSMetrics: `${ELASTICSEARCH_DOCS}tsds.html#time-series-metric`, installElasticAgent: `${FLEET_DOCS}install-fleet-managed-elastic-agent.html`, installElasticAgentStandalone: `${FLEET_DOCS}install-standalone-elastic-agent.html`, upgradeElasticAgent: `${FLEET_DOCS}upgrade-elastic-agent.html`, diff --git a/packages/kbn-doc-links/src/types.ts b/packages/kbn-doc-links/src/types.ts index c4fdc8657e2ac..0702c2bbe3f2e 100644 --- a/packages/kbn-doc-links/src/types.ts +++ b/packages/kbn-doc-links/src/types.ts @@ -489,6 +489,8 @@ export interface DocLinks { datastreamsILM: string; datastreamsNamingScheme: string; datastreamsManualRollover: string; + datastreamsTSDS: string; + datastreamsTSDSMetrics: string; installElasticAgent: string; installElasticAgentStandalone: string; packageSignatures: string; diff --git a/packages/kbn-es-archiver/src/lib/archives/parse.test.ts b/packages/kbn-es-archiver/src/lib/archives/parse.test.ts index 40ac21d666a98..b87e6f71400e0 100644 --- a/packages/kbn-es-archiver/src/lib/archives/parse.test.ts +++ b/packages/kbn-es-archiver/src/lib/archives/parse.test.ts @@ -10,7 +10,6 @@ import Stream, { PassThrough, Readable, Writable, Transform } from 'stream'; import { createGzip } from 'zlib'; import { createConcatStream, createListStream, createPromiseFromStreams } from '@kbn/utils'; -import { kibanaPackageJson } from '@kbn/repo-info'; import { createParseArchiveStreams } from './parse'; @@ -55,17 +54,6 @@ describe('esArchiver createParseArchiveStreams', () => { expect(output).toEqual([{ a: 1 }, 1]); }); - it('replaces $KIBANA_PACKAGE_VERSION with the current kibana version', async () => { - const output = await createPromiseFromStreams([ - createListStream([ - Buffer.from('{"$KIBANA'), - Buffer.from('_PACKAGE_VERSION": "enabled"}'), - ]), - ...createParseArchiveStreams({ gzip: false }), - ]); - return expect(output).toEqual({ [kibanaPackageJson.version]: 'enabled' }); - }); - it('provides each JSON object as soon as it is parsed', async () => { let onReceived: (resolved: any) => void; const receivedPromise = new Promise((resolve) => (onReceived = resolve)); @@ -150,18 +138,6 @@ describe('esArchiver createParseArchiveStreams', () => { expect(output).toEqual([{ a: 1 }, { a: 2 }]); }); - - it('replaces $KIBANA_PACKAGE_VERSION with the current kibana version', async () => { - const output = await createPromiseFromStreams([ - createListStream([ - Buffer.from('{"$KIBANA_PACKAGE'), - Buffer.from('_VERSION": "enabled"}'), - ]), - createGzip(), - ...createParseArchiveStreams({ gzip: true }), - ]); - return expect(output).toEqual({ [kibanaPackageJson.version]: 'enabled' }); - }); }); it('parses blank files', async () => { diff --git a/packages/kbn-es-archiver/src/lib/archives/parse.ts b/packages/kbn-es-archiver/src/lib/archives/parse.ts index d84846f3503d0..e13f5667c6aee 100644 --- a/packages/kbn-es-archiver/src/lib/archives/parse.ts +++ b/packages/kbn-es-archiver/src/lib/archives/parse.ts @@ -14,7 +14,6 @@ import { createReplaceStream, createMapStream, } from '@kbn/utils'; -import { kibanaPackageJson } from '@kbn/repo-info'; import { RECORD_SEPARATOR } from './constants'; @@ -22,7 +21,6 @@ export function createParseArchiveStreams({ gzip = false } = {}) { return [ gzip ? createGunzip() : new PassThrough(), createReplaceStream('\r\n', '\n'), - createReplaceStream('$KIBANA_PACKAGE_VERSION', kibanaPackageJson.version), createSplitStream(RECORD_SEPARATOR), createFilterStream((l) => !!l.match(/[^\s]/)), createMapStream((json) => JSON.parse(json.trim())), diff --git a/packages/kbn-es-query/index.ts b/packages/kbn-es-query/index.ts index b5358fbfa016c..e36c2dd329ea8 100644 --- a/packages/kbn-es-query/index.ts +++ b/packages/kbn-es-query/index.ts @@ -40,13 +40,7 @@ export type { CombinedFilter, } from './src/filters'; -export type { - DslQuery, - FunctionTypeBuildNode, - KueryNode, - KueryParseOptions, - KueryQueryOptions, -} from './src/kuery'; +export type { DslQuery, KueryNode, KueryParseOptions, KueryQueryOptions } from './src/kuery'; export { buildEsQuery, @@ -117,6 +111,7 @@ export { export { KQLSyntaxError, fromKueryExpression, + toKqlExpression, nodeBuilder, nodeTypes, toElasticsearchQuery, diff --git a/packages/kbn-es-query/src/kuery/ast/ast.test.ts b/packages/kbn-es-query/src/kuery/ast/ast.test.ts index 4cac1266670df..aae4bc9de42bd 100644 --- a/packages/kbn-es-query/src/kuery/ast/ast.test.ts +++ b/packages/kbn-es-query/src/kuery/ast/ast.test.ts @@ -6,7 +6,12 @@ * Side Public License, v 1. */ -import { fromKueryExpression, fromLiteralExpression, toElasticsearchQuery } from './ast'; +import { + fromKueryExpression, + fromLiteralExpression, + toElasticsearchQuery, + toKqlExpression, +} from './ast'; import { nodeTypes } from '../node_types'; import { DataViewBase } from '../../..'; import { KueryNode } from '../types'; @@ -387,4 +392,44 @@ describe('kuery AST API', () => { expect(result).toEqual(expected); }); }); + + describe('toKqlExpression', () => { + test('function node', () => { + const node = nodeTypes.function.buildNode('exists', 'response'); + const result = toKqlExpression(node); + expect(result).toEqual('response: *'); + }); + + test('literal node', () => { + const node = nodeTypes.literal.buildNode('foo'); + const result = toKqlExpression(node); + expect(result).toEqual('foo'); + }); + + test('wildcard node', () => { + const node = nodeTypes.wildcard.buildNode('foo*bar'); + const result = toKqlExpression(node); + expect(result).toEqual('foo*bar'); + }); + + test('should throw an error with invalid node type', () => { + const noTypeNode = nodeTypes.function.buildNode('exists', 'foo'); + + // @ts-expect-error + delete noTypeNode.type; + expect(() => toKqlExpression(noTypeNode)).toThrowErrorMatchingInlineSnapshot( + `"Unknown KQL node type: \\"undefined\\""` + ); + }); + + test('fromKueryExpression toKqlExpression', () => { + const node = fromKueryExpression( + 'field: (value AND value2 OR "value3") OR nested: { field2: value4 }' + ); + const result = toKqlExpression(node); + expect(result).toMatchInlineSnapshot( + `"(((field: value AND field: value2) OR field: \\"value3\\") OR nested: { field2: value4 })"` + ); + }); + }); }); diff --git a/packages/kbn-es-query/src/kuery/ast/ast.ts b/packages/kbn-es-query/src/kuery/ast/ast.ts index 5f86e6eeec7ab..079555ed83537 100644 --- a/packages/kbn-es-query/src/kuery/ast/ast.ts +++ b/packages/kbn-es-query/src/kuery/ast/ast.ts @@ -56,6 +56,18 @@ export const fromKueryExpression = ( } }; +/** + * Given a KQL AST node, generate the corresponding KQL expression. + * @public + * @param node + */ +export function toKqlExpression(node: KueryNode): string { + if (nodeTypes.function.isNode(node)) return nodeTypes.function.toKqlExpression(node); + if (nodeTypes.literal.isNode(node)) return nodeTypes.literal.toKqlExpression(node); + if (nodeTypes.wildcard.isNode(node)) return nodeTypes.wildcard.toKqlExpression(node); + throw new Error(`Unknown KQL node type: "${node.type}"`); +} + /** * @params {String} indexPattern * @params {Object} config - contains the dateFormatTZ diff --git a/packages/kbn-es-query/src/kuery/functions/and.test.ts b/packages/kbn-es-query/src/kuery/functions/and.test.ts index 07e431791b37a..3b9dcbff51fea 100644 --- a/packages/kbn-es-query/src/kuery/functions/and.test.ts +++ b/packages/kbn-es-query/src/kuery/functions/and.test.ts @@ -11,6 +11,7 @@ import { fields } from '../../filters/stubs'; import * as ast from '../ast'; import * as and from './and'; import { DataViewBase } from '../../es_query'; +import { KqlAndFunctionNode } from './and'; jest.mock('../grammar'); @@ -42,15 +43,18 @@ describe('kuery functions', () => { describe('toElasticsearchQuery', () => { test("should wrap subqueries in an ES bool query's filter clause", () => { - const node = nodeTypes.function.buildNode('and', [childNode1, childNode2]); + const node = nodeTypes.function.buildNode('and', [ + childNode1, + childNode2, + ]) as KqlAndFunctionNode; const result = and.toElasticsearchQuery(node, indexPattern); expect(result).toHaveProperty('bool'); expect(Object.keys(result).length).toBe(1); expect(result.bool).toHaveProperty('filter'); - expect(Object.keys(result.bool).length).toBe(1); + expect(Object.keys(result.bool!).length).toBe(1); - expect(result.bool.filter).toEqual( + expect(result.bool!.filter).toEqual( [childNode1, childNode2].map((childNode) => ast.toElasticsearchQuery(childNode, indexPattern) ) @@ -58,7 +62,10 @@ describe('kuery functions', () => { }); test("should wrap subqueries in an ES bool query's must clause for scoring if enabled", () => { - const node = nodeTypes.function.buildNode('and', [childNode1, childNode2]); + const node = nodeTypes.function.buildNode('and', [ + childNode1, + childNode2, + ]) as KqlAndFunctionNode; const result = and.toElasticsearchQuery(node, indexPattern, { filtersInMustClause: true, }); @@ -66,14 +73,31 @@ describe('kuery functions', () => { expect(result).toHaveProperty('bool'); expect(Object.keys(result).length).toBe(1); expect(result.bool).toHaveProperty('must'); - expect(Object.keys(result.bool).length).toBe(1); + expect(Object.keys(result.bool!).length).toBe(1); - expect(result.bool.must).toEqual( + expect(result.bool!.must).toEqual( [childNode1, childNode2].map((childNode) => ast.toElasticsearchQuery(childNode, indexPattern) ) ); }); }); + + describe('toKqlExpression', () => { + test('with one sub-expression', () => { + const node = nodeTypes.function.buildNode('and', [childNode1]) as KqlAndFunctionNode; + const result = and.toKqlExpression(node); + expect(result).toBe('(machine.os: osx)'); + }); + + test('with two sub-expressions', () => { + const node = nodeTypes.function.buildNode('and', [ + childNode1, + childNode2, + ]) as KqlAndFunctionNode; + const result = and.toKqlExpression(node); + expect(result).toBe('(machine.os: osx AND extension: jpg)'); + }); + }); }); }); diff --git a/packages/kbn-es-query/src/kuery/functions/and.ts b/packages/kbn-es-query/src/kuery/functions/and.ts index ea620eeb83cc7..577928d881023 100644 --- a/packages/kbn-es-query/src/kuery/functions/and.ts +++ b/packages/kbn-es-query/src/kuery/functions/and.ts @@ -6,10 +6,23 @@ * Side Public License, v 1. */ +import type { QueryDslQueryContainer } from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import * as ast from '../ast'; import type { DataViewBase, KueryNode, KueryQueryOptions } from '../../..'; +import type { KqlFunctionNode } from '../node_types'; import type { KqlContext } from '../types'; +export const KQL_FUNCTION_AND = 'and'; + +export interface KqlAndFunctionNode extends KqlFunctionNode { + function: typeof KQL_FUNCTION_AND; + arguments: KqlFunctionNode[]; +} + +export function isNode(node: KqlFunctionNode): node is KqlAndFunctionNode { + return node.function === KQL_FUNCTION_AND; +} + export function buildNodeParams(children: KueryNode[]) { return { arguments: children, @@ -17,11 +30,11 @@ export function buildNodeParams(children: KueryNode[]) { } export function toElasticsearchQuery( - node: KueryNode, + node: KqlAndFunctionNode, indexPattern?: DataViewBase, config: KueryQueryOptions = {}, context: KqlContext = {} -) { +): QueryDslQueryContainer { const { filtersInMustClause } = config; const children = node.arguments || []; const key = filtersInMustClause ? 'must' : 'filter'; @@ -34,3 +47,7 @@ export function toElasticsearchQuery( }, }; } + +export function toKqlExpression(node: KqlAndFunctionNode): string { + return `(${node.arguments.map(ast.toKqlExpression).join(' AND ')})`; +} diff --git a/packages/kbn-es-query/src/kuery/functions/exists.test.ts b/packages/kbn-es-query/src/kuery/functions/exists.test.ts index 27d0c18498df7..69340ab96c752 100644 --- a/packages/kbn-es-query/src/kuery/functions/exists.test.ts +++ b/packages/kbn-es-query/src/kuery/functions/exists.test.ts @@ -10,12 +10,11 @@ import { nodeTypes } from '../node_types'; import { fields } from '../../filters/stubs'; import { DataViewBase } from '../../..'; import { KQL_NODE_TYPE_LITERAL } from '../node_types/literal'; +import * as exists from './exists'; +import type { KqlExistsFunctionNode } from './exists'; jest.mock('../grammar'); -// @ts-ignore -import * as exists from './exists'; - describe('kuery functions', () => { describe('exists', () => { let indexPattern: DataViewBase; @@ -50,7 +49,10 @@ describe('kuery functions', () => { const expected = { exists: { field: 'response' }, }; - const existsNode = nodeTypes.function.buildNode('exists', 'response'); + const existsNode = nodeTypes.function.buildNode( + 'exists', + 'response' + ) as KqlExistsFunctionNode; const result = exists.toElasticsearchQuery(existsNode, indexPattern); expect(expected).toEqual(result); @@ -60,14 +62,20 @@ describe('kuery functions', () => { const expected = { exists: { field: 'response' }, }; - const existsNode = nodeTypes.function.buildNode('exists', 'response'); + const existsNode = nodeTypes.function.buildNode( + 'exists', + 'response' + ) as KqlExistsFunctionNode; const result = exists.toElasticsearchQuery(existsNode); expect(expected).toEqual(result); }); test('should throw an error for scripted fields', () => { - const existsNode = nodeTypes.function.buildNode('exists', 'script string'); + const existsNode = nodeTypes.function.buildNode( + 'exists', + 'script string' + ) as KqlExistsFunctionNode; expect(() => exists.toElasticsearchQuery(existsNode, indexPattern)).toThrowError( /Exists query does not support scripted fields/ ); @@ -77,7 +85,10 @@ describe('kuery functions', () => { const expected = { exists: { field: 'nestedField.response' }, }; - const existsNode = nodeTypes.function.buildNode('exists', 'response'); + const existsNode = nodeTypes.function.buildNode( + 'exists', + 'response' + ) as KqlExistsFunctionNode; const result = exists.toElasticsearchQuery( existsNode, indexPattern, @@ -88,5 +99,16 @@ describe('kuery functions', () => { expect(expected).toEqual(result); }); }); + + describe('toKqlExpression', () => { + test('should return a KQL expression', () => { + const existsNode = nodeTypes.function.buildNode( + 'exists', + 'response' + ) as KqlExistsFunctionNode; + const result = exists.toKqlExpression(existsNode); + expect(result).toBe('response: *'); + }); + }); }); }); diff --git a/packages/kbn-es-query/src/kuery/functions/exists.ts b/packages/kbn-es-query/src/kuery/functions/exists.ts index 8290406d99384..bcc693b53f6e6 100644 --- a/packages/kbn-es-query/src/kuery/functions/exists.ts +++ b/packages/kbn-es-query/src/kuery/functions/exists.ts @@ -6,23 +6,39 @@ * Side Public License, v 1. */ -import * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; -import type { DataViewFieldBase, DataViewBase, KueryNode, KueryQueryOptions } from '../../..'; -import * as literal from '../node_types/literal'; +import type { QueryDslQueryContainer } from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; +import type { DataViewFieldBase, DataViewBase, KueryQueryOptions } from '../../..'; +import type { KqlFunctionNode, KqlLiteralNode } from '../node_types'; import type { KqlContext } from '../types'; +import { + buildNode as buildLiteralNode, + toElasticsearchQuery as literalToElasticsearchQuery, + toKqlExpression as literalToKqlExpression, +} from '../node_types/literal'; + +export const KQL_FUNCTION_EXISTS = 'exists'; + +export interface KqlExistsFunctionNode extends KqlFunctionNode { + function: typeof KQL_FUNCTION_EXISTS; + arguments: [KqlLiteralNode]; +} + +export function isNode(node: KqlFunctionNode): node is KqlExistsFunctionNode { + return node.function === KQL_FUNCTION_EXISTS; +} export function buildNodeParams(fieldName: string) { return { - arguments: [literal.buildNode(fieldName)], + arguments: [buildLiteralNode(fieldName)], }; } export function toElasticsearchQuery( - node: KueryNode, + node: KqlExistsFunctionNode, indexPattern?: DataViewBase, config: KueryQueryOptions = {}, context: KqlContext = {} -): estypes.QueryDslQueryContainer { +): QueryDslQueryContainer { const { arguments: [fieldNameArg], } = node; @@ -30,7 +46,7 @@ export function toElasticsearchQuery( ...fieldNameArg, value: context?.nested ? `${context.nested.path}.${fieldNameArg.value}` : fieldNameArg.value, }; - const fieldName = literal.toElasticsearchQuery(fullFieldNameArg) as string; + const fieldName = literalToElasticsearchQuery(fullFieldNameArg) as string; const field = indexPattern?.fields?.find((fld: DataViewFieldBase) => fld.name === fieldName); if (field?.scripted) { @@ -40,3 +56,8 @@ export function toElasticsearchQuery( exists: { field: fieldName }, }; } + +export function toKqlExpression(node: KqlExistsFunctionNode): string { + const [field] = node.arguments; + return `${literalToKqlExpression(field)}: *`; +} diff --git a/packages/kbn-es-query/src/kuery/functions/index.ts b/packages/kbn-es-query/src/kuery/functions/index.ts index 8e1b44517d3a1..9705d6793ac13 100644 --- a/packages/kbn-es-query/src/kuery/functions/index.ts +++ b/packages/kbn-es-query/src/kuery/functions/index.ts @@ -14,6 +14,14 @@ import * as range from './range'; import * as exists from './exists'; import * as nested from './nested'; +export { KQL_FUNCTION_AND } from './and'; +export { KQL_FUNCTION_EXISTS } from './exists'; +export { KQL_FUNCTION_IS } from './is'; +export { KQL_FUNCTION_NESTED } from './nested'; +export { KQL_FUNCTION_NOT } from './not'; +export { KQL_FUNCTION_OR } from './or'; +export { KQL_FUNCTION_RANGE } from './range'; + export const functions = { is, and, 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 75974e019efd0..a19c951c184a9 100644 --- a/packages/kbn-es-query/src/kuery/functions/is.test.ts +++ b/packages/kbn-es-query/src/kuery/functions/is.test.ts @@ -14,6 +14,7 @@ import { DataViewBase } from '../../..'; import * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import { KQL_NODE_TYPE_WILDCARD } from '../node_types/wildcard'; import { KQL_NODE_TYPE_LITERAL } from '../node_types/literal'; +import { KqlIsFunctionNode } from './is'; jest.mock('../grammar'); @@ -69,7 +70,7 @@ describe('kuery functions', () => { const expected = { match_all: {}, }; - const node = nodeTypes.function.buildNode('is', '*', '*'); + const node = nodeTypes.function.buildNode('is', '*', '*') as KqlIsFunctionNode; const result = is.toElasticsearchQuery(node, indexPattern); expect(result).toEqual(expected); @@ -79,7 +80,7 @@ describe('kuery functions', () => { const expected = { match_all: {}, }; - const node = nodeTypes.function.buildNode('is', 'n*', '*'); + const node = nodeTypes.function.buildNode('is', 'n*', '*') as KqlIsFunctionNode; const result = is.toElasticsearchQuery(node, { ...indexPattern, fields: indexPattern.fields.filter((field) => field.name.startsWith('n')), @@ -92,7 +93,7 @@ describe('kuery functions', () => { const expected = { match_all: {}, }; - const node = nodeTypes.function.buildNode('is', '*', '*'); + const node = nodeTypes.function.buildNode('is', '*', '*') as KqlIsFunctionNode; const result = is.toElasticsearchQuery(node); expect(result).toEqual(expected); @@ -106,7 +107,7 @@ describe('kuery functions', () => { lenient: true, }, }; - const node = nodeTypes.function.buildNode('is', null, 200); + const node = nodeTypes.function.buildNode('is', null, 200) as KqlIsFunctionNode; const result = is.toElasticsearchQuery(node, indexPattern); expect(result).toEqual(expected); @@ -118,14 +119,14 @@ describe('kuery functions', () => { query: 'jpg*', }, }; - const node = nodeTypes.function.buildNode('is', null, 'jpg*'); + const node = nodeTypes.function.buildNode('is', null, 'jpg*') as KqlIsFunctionNode; const result = is.toElasticsearchQuery(node, indexPattern); expect(result).toEqual(expected); }); test('should return an ES bool query with a sub-query for each field when fieldName is "*"', () => { - const node = nodeTypes.function.buildNode('is', '*', 200); + const node = nodeTypes.function.buildNode('is', '*', 200) as KqlIsFunctionNode; const result = is.toElasticsearchQuery(node, indexPattern); expect(result).toHaveProperty('bool'); @@ -141,7 +142,7 @@ describe('kuery functions', () => { minimum_should_match: 1, }, }; - const node = nodeTypes.function.buildNode('is', 'extension', '*'); + const node = nodeTypes.function.buildNode('is', 'extension', '*') as KqlIsFunctionNode; const result = is.toElasticsearchQuery(node, indexPattern); expect(result).toEqual(expected); @@ -154,7 +155,7 @@ describe('kuery functions', () => { minimum_should_match: 1, }, }; - const node = nodeTypes.function.buildNode('is', 'extension', 'jpg'); + const node = nodeTypes.function.buildNode('is', 'extension', 'jpg') as KqlIsFunctionNode; const result = is.toElasticsearchQuery(node, indexPattern); expect(result).toEqual(expected); @@ -167,7 +168,7 @@ describe('kuery functions', () => { minimum_should_match: 1, }, }; - const node = nodeTypes.function.buildNode('is', 'extension', 'jpg'); + const node = nodeTypes.function.buildNode('is', 'extension', 'jpg') as KqlIsFunctionNode; const result = is.toElasticsearchQuery(node); expect(result).toEqual(expected); @@ -180,7 +181,7 @@ describe('kuery functions', () => { minimum_should_match: 1, }, }; - const node = nodeTypes.function.buildNode('is', 'extension', '"jpg"'); + const node = nodeTypes.function.buildNode('is', 'extension', '"jpg"') as KqlIsFunctionNode; const result = is.toElasticsearchQuery(node, indexPattern); expect(result).toEqual(expected); @@ -200,7 +201,7 @@ describe('kuery functions', () => { minimum_should_match: 1, }, }; - const node = nodeTypes.function.buildNode('is', 'extension', 'jpg*'); + const node = nodeTypes.function.buildNode('is', 'extension', 'jpg*') as KqlIsFunctionNode; const result = is.toElasticsearchQuery(node, indexPattern); expect(result).toEqual(expected); @@ -219,7 +220,11 @@ describe('kuery functions', () => { minimum_should_match: 1, }, }; - const node = nodeTypes.function.buildNode('is', 'machine.os.keyword', 'win*'); + const node = nodeTypes.function.buildNode( + 'is', + 'machine.os.keyword', + 'win*' + ) as KqlIsFunctionNode; const result = is.toElasticsearchQuery(node, indexPattern); expect(result).toEqual(expected); @@ -238,14 +243,22 @@ describe('kuery functions', () => { minimum_should_match: 1, }, }; - const node = nodeTypes.function.buildNode('is', 'machine.os.keyword', 'win*'); + const node = nodeTypes.function.buildNode( + 'is', + 'machine.os.keyword', + 'win*' + ) as KqlIsFunctionNode; const result = is.toElasticsearchQuery(node, indexPattern, { caseInsensitive: true }); expect(result).toEqual(expected); }); test('should support scripted fields', () => { - const node = nodeTypes.function.buildNode('is', 'script string', 'foo'); + const node = nodeTypes.function.buildNode( + 'is', + 'script string', + 'foo' + ) as KqlIsFunctionNode; const result = is.toElasticsearchQuery(node, indexPattern); expect((result.bool!.should as estypes.QueryDslQueryContainer[])[0]).toHaveProperty( @@ -269,7 +282,11 @@ describe('kuery functions', () => { minimum_should_match: 1, }, }; - const node = nodeTypes.function.buildNode('is', '@timestamp', '"2018-04-03T19:04:17"'); + const node = nodeTypes.function.buildNode( + 'is', + '@timestamp', + '"2018-04-03T19:04:17"' + ) as KqlIsFunctionNode; const result = is.toElasticsearchQuery(node, indexPattern); expect(result).toEqual(expected); @@ -293,7 +310,11 @@ describe('kuery functions', () => { minimum_should_match: 1, }, }; - const node = nodeTypes.function.buildNode('is', '@timestamp', '"2018-04-03T19:04:17"'); + const node = nodeTypes.function.buildNode( + 'is', + '@timestamp', + '"2018-04-03T19:04:17"' + ) as KqlIsFunctionNode; const result = is.toElasticsearchQuery(node, indexPattern, config); expect(result).toEqual(expected); @@ -306,7 +327,7 @@ describe('kuery functions', () => { minimum_should_match: 1, }, }; - const node = nodeTypes.function.buildNode('is', 'extension', 'jpg'); + const node = nodeTypes.function.buildNode('is', 'extension', 'jpg') as KqlIsFunctionNode; const result = is.toElasticsearchQuery( node, indexPattern, @@ -324,7 +345,7 @@ describe('kuery functions', () => { minimum_should_match: 1, }, }; - const node = nodeTypes.function.buildNode('is', 'ext*', 'jpg'); + const node = nodeTypes.function.buildNode('is', 'ext*', 'jpg') as KqlIsFunctionNode; const result = is.toElasticsearchQuery(node, indexPattern); expect(result).toEqual(expected); @@ -349,7 +370,11 @@ describe('kuery functions', () => { minimum_should_match: 1, }, }; - const node = nodeTypes.function.buildNode('is', '*doublyNested*', 'foo'); + const node = nodeTypes.function.buildNode( + 'is', + '*doublyNested*', + 'foo' + ) as KqlIsFunctionNode; const result = is.toElasticsearchQuery(node, indexPattern); expect(result).toEqual(expected); @@ -375,14 +400,22 @@ describe('kuery functions', () => { minimum_should_match: 1, }, }; - const node = nodeTypes.function.buildNode('is', '*doublyNested*', 'foo'); + const node = nodeTypes.function.buildNode( + 'is', + '*doublyNested*', + 'foo' + ) as KqlIsFunctionNode; const result = is.toElasticsearchQuery(node, indexPattern, { nestedIgnoreUnmapped: true }); expect(result).toEqual(expected); }); test('should use a term query for keyword fields', () => { - const node = nodeTypes.function.buildNode('is', 'machine.os.keyword', 'Win 7'); + const node = nodeTypes.function.buildNode( + 'is', + 'machine.os.keyword', + 'Win 7' + ) as KqlIsFunctionNode; const result = is.toElasticsearchQuery(node, indexPattern); expect(result).toEqual({ bool: { @@ -399,7 +432,11 @@ describe('kuery functions', () => { }); test('should use a case-insensitive term query for keyword fields', () => { - const node = nodeTypes.function.buildNode('is', 'machine.os.keyword', 'Win 7'); + const node = nodeTypes.function.buildNode( + 'is', + 'machine.os.keyword', + 'Win 7' + ) as KqlIsFunctionNode; const result = is.toElasticsearchQuery(node, indexPattern, { caseInsensitive: true }); expect(result).toEqual({ bool: { @@ -415,5 +452,71 @@ describe('kuery functions', () => { }); }); }); + + describe('toKqlExpression', () => { + test('match all fields and all values', () => { + const node = nodeTypes.function.buildNode('is', '*', '*') as KqlIsFunctionNode; + const result = is.toKqlExpression(node); + expect(result).toMatchInlineSnapshot(`"*: *"`); + }); + + test('no field with literal value', () => { + const node = nodeTypes.function.buildNode('is', null, 200) as KqlIsFunctionNode; + const result = is.toKqlExpression(node); + expect(result).toMatchInlineSnapshot(`"200"`); + }); + + test('no field with wildcard value', () => { + const node = nodeTypes.function.buildNode('is', null, 'jpg*') as KqlIsFunctionNode; + const result = is.toKqlExpression(node); + expect(result).toMatchInlineSnapshot(`"jpg*"`); + }); + + test('match all fields with value', () => { + const node = nodeTypes.function.buildNode('is', '*', 200) as KqlIsFunctionNode; + const result = is.toKqlExpression(node); + expect(result).toMatchInlineSnapshot(`"*: 200"`); + }); + + test('field with match all value"', () => { + const node = nodeTypes.function.buildNode('is', 'extension', '*') as KqlIsFunctionNode; + const result = is.toKqlExpression(node); + expect(result).toMatchInlineSnapshot(`"extension: *"`); + }); + + test('field with value', () => { + const node = nodeTypes.function.buildNode('is', 'extension', 'jpg') as KqlIsFunctionNode; + const result = is.toKqlExpression(node); + expect(result).toMatchInlineSnapshot(`"extension: jpg"`); + }); + + test('field with phrase value', () => { + const node = nodeTypes.function.buildNode('is', 'extension', '"jpg"') as KqlIsFunctionNode; + const result = is.toKqlExpression(node); + expect(result).toMatchInlineSnapshot(`"extension: \\"jpg\\""`); + }); + + test('phrase field with phrase value', () => { + const node = nodeTypes.function.buildNode( + 'is', + '"extension"', + '"jpg"' + ) as KqlIsFunctionNode; + const result = is.toKqlExpression(node); + expect(result).toMatchInlineSnapshot(`"\\"extension\\": \\"jpg\\""`); + }); + + test('field with wildcard value', () => { + const node = nodeTypes.function.buildNode('is', 'extension', 'jpg*') as KqlIsFunctionNode; + const result = is.toKqlExpression(node); + expect(result).toMatchInlineSnapshot(`"extension: jpg*"`); + }); + + test('wildcard field with value', () => { + const node = nodeTypes.function.buildNode('is', 'ext*', 'jpg') as KqlIsFunctionNode; + const result = is.toKqlExpression(node); + expect(result).toMatchInlineSnapshot(`"ext*: jpg"`); + }); + }); }); }); diff --git a/packages/kbn-es-query/src/kuery/functions/is.ts b/packages/kbn-es-query/src/kuery/functions/is.ts index 95563e6c429f6..55bce74973741 100644 --- a/packages/kbn-es-query/src/kuery/functions/is.ts +++ b/packages/kbn-es-query/src/kuery/functions/is.ts @@ -7,18 +7,30 @@ */ import { isUndefined } from 'lodash'; -import * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; +import type { QueryDslQueryContainer } from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import { getPhraseScript } from '../../filters'; import { getFields } from './utils/get_fields'; import { getTimeZoneFromSettings, getDataViewFieldSubtypeNested } from '../../utils'; import { getFullFieldNameNode } from './utils/get_full_field_name_node'; -import type { DataViewBase, KueryNode, DataViewFieldBase, KueryQueryOptions } from '../../..'; +import type { DataViewBase, DataViewFieldBase, KueryQueryOptions } from '../../..'; +import type { KqlFunctionNode, KqlLiteralNode, KqlWildcardNode } from '../node_types'; import type { KqlContext } from '../types'; import * as ast from '../ast'; import * as literal from '../node_types/literal'; import * as wildcard from '../node_types/wildcard'; +export const KQL_FUNCTION_IS = 'is'; + +export interface KqlIsFunctionNode extends KqlFunctionNode { + function: typeof KQL_FUNCTION_IS; + arguments: [KqlLiteralNode | KqlWildcardNode, KqlLiteralNode | KqlWildcardNode]; +} + +export function isNode(node: KqlFunctionNode): node is KqlIsFunctionNode { + return node.function === KQL_FUNCTION_IS; +} + export function buildNodeParams(fieldName: string, value: any) { if (isUndefined(fieldName)) { throw new Error('fieldName is a required argument'); @@ -38,11 +50,11 @@ export function buildNodeParams(fieldName: string, value: any) { } export function toElasticsearchQuery( - node: KueryNode, + node: KqlIsFunctionNode, indexPattern?: DataViewBase, config: KueryQueryOptions = {}, context: KqlContext = {} -): estypes.QueryDslQueryContainer { +): QueryDslQueryContainer { const { arguments: [fieldNameArg, valueArg], } = node; @@ -216,3 +228,9 @@ export function toElasticsearchQuery( }, }; } + +export function toKqlExpression(node: KqlIsFunctionNode): string { + const [field, value] = node.arguments; + if (field.value === null) return `${ast.toKqlExpression(value)}`; + return `${ast.toKqlExpression(field)}: ${ast.toKqlExpression(value)}`; +} diff --git a/packages/kbn-es-query/src/kuery/functions/nested.test.ts b/packages/kbn-es-query/src/kuery/functions/nested.test.ts index ea5c4959f21c3..5078f3899cd8e 100644 --- a/packages/kbn-es-query/src/kuery/functions/nested.test.ts +++ b/packages/kbn-es-query/src/kuery/functions/nested.test.ts @@ -9,10 +9,9 @@ import { nodeTypes } from '../node_types'; import { fields } from '../../filters/stubs'; import { DataViewBase } from '../../..'; - import * as ast from '../ast'; - import * as nested from './nested'; +import type { KqlNestedFunctionNode } from './nested'; jest.mock('../grammar'); @@ -43,7 +42,11 @@ describe('kuery functions', () => { describe('toElasticsearchQuery', () => { test('should wrap subqueries in an ES nested query', () => { - const node = nodeTypes.function.buildNode('nested', 'nestedField', childNode); + const node = nodeTypes.function.buildNode( + 'nested', + 'nestedField', + childNode + ) as KqlNestedFunctionNode; const result = nested.toElasticsearchQuery(node, indexPattern); expect(result).toHaveProperty('nested'); @@ -54,7 +57,11 @@ describe('kuery functions', () => { }); test('should pass the nested path to subqueries so the full field name can be used', () => { - const node = nodeTypes.function.buildNode('nested', 'nestedField', childNode); + const node = nodeTypes.function.buildNode( + 'nested', + 'nestedField', + childNode + ) as KqlNestedFunctionNode; const result = nested.toElasticsearchQuery(node, indexPattern); const expectedSubQuery = ast.toElasticsearchQuery( nodeTypes.function.buildNode('is', 'nestedField.child', 'foo') @@ -63,5 +70,41 @@ describe('kuery functions', () => { expect(result.nested!.query).toEqual(expectedSubQuery); }); }); + + describe('toKqlExpression', () => { + test('single nested query', () => { + const node = nodeTypes.function.buildNode( + 'nested', + 'nestedField', + childNode + ) as KqlNestedFunctionNode; + const result = nested.toKqlExpression(node); + expect(result).toMatchInlineSnapshot(`"nestedField: { child: foo }"`); + }); + + test('multiple nested queries', () => { + const andNode = nodeTypes.function.buildNode('and', [childNode, childNode]); + const node = nodeTypes.function.buildNode( + 'nested', + 'nestedField', + andNode + ) as KqlNestedFunctionNode; + const result = nested.toKqlExpression(node); + expect(result).toMatchInlineSnapshot(`"nestedField: { (child: foo AND child: foo) }"`); + }); + + test('doubly nested query', () => { + const subNode = nodeTypes.function.buildNode('nested', 'anotherNestedField', childNode); + const node = nodeTypes.function.buildNode( + 'nested', + 'nestedField', + subNode + ) as KqlNestedFunctionNode; + const result = nested.toKqlExpression(node); + expect(result).toMatchInlineSnapshot( + `"nestedField: { anotherNestedField: { child: foo } }"` + ); + }); + }); }); }); diff --git a/packages/kbn-es-query/src/kuery/functions/nested.ts b/packages/kbn-es-query/src/kuery/functions/nested.ts index d125889354437..163c68bc4274f 100644 --- a/packages/kbn-es-query/src/kuery/functions/nested.ts +++ b/packages/kbn-es-query/src/kuery/functions/nested.ts @@ -6,12 +6,24 @@ * Side Public License, v 1. */ -import * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; +import type { QueryDslQueryContainer } from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import * as ast from '../ast'; import * as literal from '../node_types/literal'; -import type { DataViewBase, KueryNode, KueryQueryOptions } from '../../..'; +import type { DataViewBase, KueryQueryOptions } from '../../..'; +import type { KqlFunctionNode, KqlLiteralNode } from '../node_types'; import type { KqlContext } from '../types'; +export const KQL_FUNCTION_NESTED = 'nested'; + +export interface KqlNestedFunctionNode extends KqlFunctionNode { + function: typeof KQL_FUNCTION_NESTED; + arguments: [KqlLiteralNode, KqlFunctionNode]; +} + +export function isNode(node: KqlFunctionNode): node is KqlNestedFunctionNode { + return node.function === KQL_FUNCTION_NESTED; +} + export function buildNodeParams(path: any, child: any) { const pathNode = typeof path === 'string' ? ast.fromLiteralExpression(path) : literal.buildNode(path); @@ -21,11 +33,11 @@ export function buildNodeParams(path: any, child: any) { } export function toElasticsearchQuery( - node: KueryNode, + node: KqlNestedFunctionNode, indexPattern?: DataViewBase, config: KueryQueryOptions = {}, context: KqlContext = {} -): estypes.QueryDslQueryContainer { +): QueryDslQueryContainer { const [path, child] = node.arguments; const stringPath = ast.toElasticsearchQuery(path) as unknown as string; const fullPath = context?.nested?.path ? `${context.nested.path}.${stringPath}` : stringPath; @@ -36,7 +48,7 @@ export function toElasticsearchQuery( query: ast.toElasticsearchQuery(child, indexPattern, config, { ...context, nested: { path: fullPath }, - }) as estypes.QueryDslQueryContainer, + }), score_mode: 'none', ...(typeof config.nestedIgnoreUnmapped === 'boolean' && { ignore_unmapped: config.nestedIgnoreUnmapped, @@ -44,3 +56,8 @@ export function toElasticsearchQuery( }, }; } + +export function toKqlExpression(node: KqlNestedFunctionNode): string { + const [path, child] = node.arguments; + return `${literal.toKqlExpression(path)}: { ${ast.toKqlExpression(child)} }`; +} diff --git a/packages/kbn-es-query/src/kuery/functions/not.test.ts b/packages/kbn-es-query/src/kuery/functions/not.test.ts index e84893bdfde6a..84163620e72ce 100644 --- a/packages/kbn-es-query/src/kuery/functions/not.test.ts +++ b/packages/kbn-es-query/src/kuery/functions/not.test.ts @@ -12,6 +12,7 @@ import { DataViewBase } from '../../..'; import * as ast from '../ast'; import * as not from './not'; +import { KqlNotFunctionNode } from './not'; jest.mock('../grammar'); @@ -40,7 +41,7 @@ describe('kuery functions', () => { describe('toElasticsearchQuery', () => { test("should wrap a subquery in an ES bool query's must_not clause", () => { - const node = nodeTypes.function.buildNode('not', childNode); + const node = nodeTypes.function.buildNode('not', childNode) as KqlNotFunctionNode; const result = not.toElasticsearchQuery(node, indexPattern); expect(result).toHaveProperty('bool'); @@ -52,5 +53,13 @@ describe('kuery functions', () => { expect(result.bool!.must_not).toEqual(ast.toElasticsearchQuery(childNode, indexPattern)); }); }); + + describe('toKqlExpression', () => { + test('with one sub-expression', () => { + const node = nodeTypes.function.buildNode('not', childNode) as KqlNotFunctionNode; + const result = not.toKqlExpression(node); + expect(result).toBe('NOT extension: jpg'); + }); + }); }); }); diff --git a/packages/kbn-es-query/src/kuery/functions/not.ts b/packages/kbn-es-query/src/kuery/functions/not.ts index 428b40be521ee..457dd91cb9377 100644 --- a/packages/kbn-es-query/src/kuery/functions/not.ts +++ b/packages/kbn-es-query/src/kuery/functions/not.ts @@ -6,11 +6,23 @@ * Side Public License, v 1. */ -import * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; +import type { QueryDslQueryContainer } from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import * as ast from '../ast'; import type { DataViewBase, KueryNode, KueryQueryOptions } from '../../..'; +import type { KqlFunctionNode } from '../node_types'; import type { KqlContext } from '../types'; +export const KQL_FUNCTION_NOT = 'not'; + +export interface KqlNotFunctionNode extends KqlFunctionNode { + function: typeof KQL_FUNCTION_NOT; + arguments: [KqlFunctionNode]; +} + +export function isNode(node: KqlFunctionNode): node is KqlNotFunctionNode { + return node.function === KQL_FUNCTION_NOT; +} + export function buildNodeParams(child: KueryNode) { return { arguments: [child], @@ -18,21 +30,21 @@ export function buildNodeParams(child: KueryNode) { } export function toElasticsearchQuery( - node: KueryNode, + node: KqlNotFunctionNode, indexPattern?: DataViewBase, config: KueryQueryOptions = {}, context: KqlContext = {} -): estypes.QueryDslQueryContainer { +): QueryDslQueryContainer { const [argument] = node.arguments; return { bool: { - must_not: ast.toElasticsearchQuery( - argument, - indexPattern, - config, - context - ) as estypes.QueryDslQueryContainer, + must_not: ast.toElasticsearchQuery(argument, indexPattern, config, context), }, }; } + +export function toKqlExpression(node: KqlNotFunctionNode): string { + const [child] = node.arguments; + return `NOT ${ast.toKqlExpression(child)}`; +} diff --git a/packages/kbn-es-query/src/kuery/functions/or.test.ts b/packages/kbn-es-query/src/kuery/functions/or.test.ts index 1c8238acc59f0..26eeb25f7b605 100644 --- a/packages/kbn-es-query/src/kuery/functions/or.test.ts +++ b/packages/kbn-es-query/src/kuery/functions/or.test.ts @@ -13,6 +13,7 @@ import { DataViewBase } from '../../..'; import * as ast from '../ast'; import * as or from './or'; +import { KqlOrFunctionNode } from './or'; jest.mock('../grammar'); const childNode1 = nodeTypes.function.buildNode('is', 'machine.os', 'osx'); @@ -43,7 +44,10 @@ describe('kuery functions', () => { describe('toElasticsearchQuery', () => { test("should wrap subqueries in an ES bool query's should clause", () => { - const node = nodeTypes.function.buildNode('or', [childNode1, childNode2]); + const node = nodeTypes.function.buildNode('or', [ + childNode1, + childNode2, + ]) as KqlOrFunctionNode; const result = or.toElasticsearchQuery(node, indexPattern); expect(result).toHaveProperty('bool'); @@ -57,11 +61,31 @@ describe('kuery functions', () => { }); test('should require one of the clauses to match', () => { - const node = nodeTypes.function.buildNode('or', [childNode1, childNode2]); + const node = nodeTypes.function.buildNode('or', [ + childNode1, + childNode2, + ]) as KqlOrFunctionNode; const result = or.toElasticsearchQuery(node, indexPattern); expect(result.bool).toHaveProperty('minimum_should_match', 1); }); }); + + describe('toKqlExpression', () => { + test('with one sub-expression', () => { + const node = nodeTypes.function.buildNode('or', [childNode1]) as KqlOrFunctionNode; + const result = or.toKqlExpression(node); + expect(result).toBe('(machine.os: osx)'); + }); + + test('with two sub-expressions', () => { + const node = nodeTypes.function.buildNode('or', [ + childNode1, + childNode2, + ]) as KqlOrFunctionNode; + const result = or.toKqlExpression(node); + expect(result).toBe('(machine.os: osx OR extension: jpg)'); + }); + }); }); }); diff --git a/packages/kbn-es-query/src/kuery/functions/or.ts b/packages/kbn-es-query/src/kuery/functions/or.ts index 52a038600d45f..45e5f574149fb 100644 --- a/packages/kbn-es-query/src/kuery/functions/or.ts +++ b/packages/kbn-es-query/src/kuery/functions/or.ts @@ -6,11 +6,23 @@ * Side Public License, v 1. */ -import * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; +import type { QueryDslQueryContainer } from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import * as ast from '../ast'; import type { DataViewBase, KueryNode, KueryQueryOptions } from '../../..'; +import type { KqlFunctionNode } from '../node_types'; import type { KqlContext } from '../types'; +export const KQL_FUNCTION_OR = 'or'; + +export interface KqlOrFunctionNode extends KqlFunctionNode { + function: typeof KQL_FUNCTION_OR; + arguments: KqlFunctionNode[]; +} + +export function isNode(node: KqlFunctionNode): node is KqlOrFunctionNode { + return node.function === KQL_FUNCTION_OR; +} + export function buildNodeParams(children: KueryNode[]) { return { arguments: children, @@ -18,11 +30,11 @@ export function buildNodeParams(children: KueryNode[]) { } export function toElasticsearchQuery( - node: KueryNode, + node: KqlOrFunctionNode, indexPattern?: DataViewBase, config: KueryQueryOptions = {}, context: KqlContext = {} -): estypes.QueryDslQueryContainer { +): QueryDslQueryContainer { const children = node.arguments || []; return { @@ -34,3 +46,7 @@ export function toElasticsearchQuery( }, }; } + +export function toKqlExpression(node: KqlOrFunctionNode): string { + return `(${node.arguments.map(ast.toKqlExpression).join(' OR ')})`; +} 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 d3a09ae907d7d..510eb4efbc7f7 100644 --- a/packages/kbn-es-query/src/kuery/functions/range.test.ts +++ b/packages/kbn-es-query/src/kuery/functions/range.test.ts @@ -13,6 +13,7 @@ import { DataViewBase } from '../../..'; import * as range from './range'; import * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import { KQL_NODE_TYPE_LITERAL } from '../node_types/literal'; +import { KqlRangeFunctionNode } from './range'; jest.mock('../grammar'); @@ -65,7 +66,12 @@ describe('kuery functions', () => { minimum_should_match: 1, }, }; - const node = nodeTypes.function.buildNode('range', 'bytes', 'gt', 1000); + const node = nodeTypes.function.buildNode( + 'range', + 'bytes', + 'gt', + 1000 + ) as KqlRangeFunctionNode; const result = range.toElasticsearchQuery(node, indexPattern); expect(result).toEqual(expected); @@ -87,7 +93,12 @@ describe('kuery functions', () => { }, }; - const node = nodeTypes.function.buildNode('range', 'bytes', 'gt', 1000); + const node = nodeTypes.function.buildNode( + 'range', + 'bytes', + 'gt', + 1000 + ) as KqlRangeFunctionNode; const result = range.toElasticsearchQuery(node); expect(result).toEqual(expected); @@ -109,14 +120,24 @@ describe('kuery functions', () => { }, }; - const node = nodeTypes.function.buildNode('range', 'byt*', 'gt', 1000); + const node = nodeTypes.function.buildNode( + 'range', + 'byt*', + 'gt', + 1000 + ) as KqlRangeFunctionNode; const result = range.toElasticsearchQuery(node, indexPattern); expect(result).toEqual(expected); }); test('should support scripted fields', () => { - const node = nodeTypes.function.buildNode('range', 'script number', 'gt', 1000); + const node = nodeTypes.function.buildNode( + 'range', + 'script number', + 'gt', + 1000 + ) as KqlRangeFunctionNode; const result = range.toElasticsearchQuery(node, indexPattern); expect((result.bool!.should as estypes.QueryDslQueryContainer[])[0]).toHaveProperty( @@ -144,7 +165,7 @@ describe('kuery functions', () => { '@timestamp', 'gt', '2018-01-03T19:04:17' - ); + ) as KqlRangeFunctionNode; const result = range.toElasticsearchQuery(node, indexPattern); expect(result).toEqual(expected); @@ -172,7 +193,7 @@ describe('kuery functions', () => { '@timestamp', 'gt', '2018-01-03T19:04:17' - ); + ) as KqlRangeFunctionNode; const result = range.toElasticsearchQuery(node, indexPattern, config); expect(result).toEqual(expected); @@ -193,7 +214,12 @@ describe('kuery functions', () => { minimum_should_match: 1, }, }; - const node = nodeTypes.function.buildNode('range', 'bytes', 'gt', 1000); + const node = nodeTypes.function.buildNode( + 'range', + 'bytes', + 'gt', + 1000 + ) as KqlRangeFunctionNode; const result = range.toElasticsearchQuery( node, indexPattern, @@ -225,7 +251,12 @@ describe('kuery functions', () => { minimum_should_match: 1, }, }; - const node = nodeTypes.function.buildNode('range', '*doublyNested*', 'lt', 8000); + const node = nodeTypes.function.buildNode( + 'range', + '*doublyNested*', + 'lt', + 8000 + ) as KqlRangeFunctionNode; const result = range.toElasticsearchQuery(node, indexPattern); expect(result).toEqual(expected); @@ -253,7 +284,12 @@ describe('kuery functions', () => { minimum_should_match: 1, }, }; - const node = nodeTypes.function.buildNode('range', '*doublyNested*', 'lt', 8000); + const node = nodeTypes.function.buildNode( + 'range', + '*doublyNested*', + 'lt', + 8000 + ) as KqlRangeFunctionNode; const result = range.toElasticsearchQuery(node, indexPattern, { nestedIgnoreUnmapped: true, }); @@ -261,5 +297,75 @@ describe('kuery functions', () => { expect(result).toEqual(expected); }); }); + + describe('toKqlExpression', () => { + describe('operators', () => { + test('gt', () => { + const node = nodeTypes.function.buildNode( + 'range', + 'bytes', + 'gt', + 1000 + ) as KqlRangeFunctionNode; + const result = range.toKqlExpression(node); + expect(result).toMatchInlineSnapshot(`"bytes > 1000"`); + }); + + test('gte', () => { + const node = nodeTypes.function.buildNode( + 'range', + 'bytes', + 'gte', + 1000 + ) as KqlRangeFunctionNode; + const result = range.toKqlExpression(node); + expect(result).toMatchInlineSnapshot(`"bytes >= 1000"`); + }); + + test('lt', () => { + const node = nodeTypes.function.buildNode( + 'range', + 'bytes', + 'lt', + 1000 + ) as KqlRangeFunctionNode; + const result = range.toKqlExpression(node); + expect(result).toMatchInlineSnapshot(`"bytes < 1000"`); + }); + + test('lte', () => { + const node = nodeTypes.function.buildNode( + 'range', + 'bytes', + 'lte', + 1000 + ) as KqlRangeFunctionNode; + const result = range.toKqlExpression(node); + expect(result).toMatchInlineSnapshot(`"bytes <= 1000"`); + }); + }); + + test('with wildcard field & literal value', () => { + const node = nodeTypes.function.buildNode( + 'range', + 'byt*', + 'gt', + 1000 + ) as KqlRangeFunctionNode; + const result = range.toKqlExpression(node); + expect(result).toMatchInlineSnapshot(`"byt* > 1000"`); + }); + + test('with wildcard field & wildcard value', () => { + const node = nodeTypes.function.buildNode( + 'range', + 'byt*', + 'gt', + '100*' + ) as KqlRangeFunctionNode; + const result = range.toKqlExpression(node); + expect(result).toMatchInlineSnapshot(`"byt* > 100*"`); + }); + }); }); }); diff --git a/packages/kbn-es-query/src/kuery/functions/range.ts b/packages/kbn-es-query/src/kuery/functions/range.ts index 1d280fbbd563e..3c14d6d726fc5 100644 --- a/packages/kbn-es-query/src/kuery/functions/range.ts +++ b/packages/kbn-es-query/src/kuery/functions/range.ts @@ -6,16 +6,38 @@ * Side Public License, v 1. */ -import * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; -import { nodeTypes } from '../node_types'; +import type { QueryDslQueryContainer } from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; +import { buildNode as buildLiteralNode } from '../node_types/literal'; +import { type KqlFunctionNode, type KqlLiteralNode, nodeTypes } from '../node_types'; import * as ast from '../ast'; import { getRangeScript, RangeFilterParams } from '../../filters'; import { getFields } from './utils/get_fields'; import { getDataViewFieldSubtypeNested, getTimeZoneFromSettings } from '../../utils'; import { getFullFieldNameNode } from './utils/get_full_field_name_node'; -import type { DataViewBase, KueryNode, KueryQueryOptions } from '../../..'; +import type { DataViewBase, KueryQueryOptions } from '../../..'; import type { KqlContext } from '../types'; +export const KQL_FUNCTION_RANGE = 'range'; +export const KQL_RANGE_OPERATOR_MAP = { + gt: '>', + gte: '>=', + lt: '<', + lte: '<=', +}; + +export interface KqlRangeFunctionNode extends KqlFunctionNode { + function: typeof KQL_FUNCTION_RANGE; + arguments: [ + KqlLiteralNode, + keyof Pick, + KqlLiteralNode + ]; +} + +export function isNode(node: KqlFunctionNode): node is KqlRangeFunctionNode { + return node.function === KQL_FUNCTION_RANGE; +} + export function buildNodeParams( fieldName: string, operator: keyof Pick, @@ -23,16 +45,16 @@ export function buildNodeParams( ) { // Run through the parser instead treating it as a literal because it may contain wildcards const fieldNameArg = ast.fromLiteralExpression(fieldName); - const valueArg = nodeTypes.literal.buildNode(value); + const valueArg = buildLiteralNode(value); return { arguments: [fieldNameArg, operator, valueArg] }; } export function toElasticsearchQuery( - node: KueryNode, + node: KqlRangeFunctionNode, indexPattern?: DataViewBase, config: KueryQueryOptions = {}, context: KqlContext = {} -): estypes.QueryDslQueryContainer { +): QueryDslQueryContainer { const [fieldNameArg, operatorArg, valueArg] = node.arguments; const fullFieldNameArg = getFullFieldNameNode( fieldNameArg, @@ -114,3 +136,10 @@ export function toElasticsearchQuery( }, }; } + +export function toKqlExpression(node: KqlRangeFunctionNode): string { + const [field, operator, value] = node.arguments; + return `${ast.toKqlExpression(field)} ${KQL_RANGE_OPERATOR_MAP[operator]} ${ast.toKqlExpression( + value + )}`; +} diff --git a/packages/kbn-es-query/src/kuery/index.ts b/packages/kbn-es-query/src/kuery/index.ts index b48d40d187515..c7faf0cb4154a 100644 --- a/packages/kbn-es-query/src/kuery/index.ts +++ b/packages/kbn-es-query/src/kuery/index.ts @@ -22,7 +22,6 @@ export const toElasticsearchQuery = (...params: Parameters { describe('toElasticsearchQuery', () => { test("should return the given function type's ES query representation", () => { - const node = buildNode('is', 'extension', 'jpg'); + const node = buildNode('is', 'extension', 'jpg') as KqlIsFunctionNode; const expected = isFunctionToElasticsearchQuery(node, indexPattern); const result = toElasticsearchQuery(node, indexPattern); expect(expected).toEqual(result); }); }); + + describe('toKqlExpression', () => { + test("should return the given function type's KQL representation", () => { + const node = buildNode('is', 'extension', 'jpg') as KqlIsFunctionNode; + const result = toKqlExpression(node); + expect(result).toEqual('extension: jpg'); + }); + }); }); }); diff --git a/packages/kbn-es-query/src/kuery/node_types/function.ts b/packages/kbn-es-query/src/kuery/node_types/function.ts index c3a46a0aec5f7..5d2ce82048360 100644 --- a/packages/kbn-es-query/src/kuery/node_types/function.ts +++ b/packages/kbn-es-query/src/kuery/node_types/function.ts @@ -8,19 +8,48 @@ import _ from 'lodash'; -import { functions } from '../functions'; +import { + functions, + KQL_FUNCTION_AND, + KQL_FUNCTION_EXISTS, + KQL_FUNCTION_NESTED, + KQL_FUNCTION_IS, + KQL_FUNCTION_NOT, + KQL_FUNCTION_OR, + KQL_FUNCTION_RANGE, +} from '../functions'; import type { DataViewBase, KueryNode, KueryQueryOptions } from '../../..'; -import type { FunctionName, FunctionTypeBuildNode } from './types'; import type { KqlContext } from '../types'; -export function buildNode(functionName: FunctionName, ...args: any[]) { +export const KQL_NODE_TYPE_FUNCTION = 'function'; + +export type KqlFunctionName = + | typeof KQL_FUNCTION_AND + | typeof KQL_FUNCTION_EXISTS + | typeof KQL_FUNCTION_IS + | typeof KQL_FUNCTION_NESTED + | typeof KQL_FUNCTION_NOT + | typeof KQL_FUNCTION_OR + | typeof KQL_FUNCTION_RANGE; + +export interface KqlFunctionNode extends KueryNode { + arguments: unknown[]; + function: KqlFunctionName; + type: typeof KQL_NODE_TYPE_FUNCTION; +} + +export function isNode(node: KueryNode): node is KqlFunctionNode { + return node.type === KQL_NODE_TYPE_FUNCTION; +} + +export function buildNode(functionName: KqlFunctionName, ...args: any[]): KqlFunctionNode { const kueryFunction = functions[functionName]; if (_.isUndefined(kueryFunction)) { throw new Error(`Unknown function "${functionName}"`); } return { - type: 'function' as 'function', + type: KQL_NODE_TYPE_FUNCTION, function: functionName, // This requires better typing of the different typings and their return types. // @ts-ignore @@ -30,26 +59,50 @@ export function buildNode(functionName: FunctionName, ...args: any[]) { // Mainly only useful in the grammar where we'll already have real argument nodes in hand export function buildNodeWithArgumentNodes( - functionName: FunctionName, + functionName: KqlFunctionName, args: any[] -): FunctionTypeBuildNode { +): KqlFunctionNode { if (_.isUndefined(functions[functionName])) { throw new Error(`Unknown function "${functionName}"`); } return { - type: 'function', + type: KQL_NODE_TYPE_FUNCTION, function: functionName, arguments: args, }; } export function toElasticsearchQuery( - node: KueryNode, + node: KqlFunctionNode, indexPattern?: DataViewBase, config?: KueryQueryOptions, context?: KqlContext ) { - const kueryFunction = functions[node.function as FunctionName]; - return kueryFunction.toElasticsearchQuery(node, indexPattern, config, context); + if (functions.and.isNode(node)) + return functions.and.toElasticsearchQuery(node, indexPattern, config, context); + if (functions.exists.isNode(node)) + return functions.exists.toElasticsearchQuery(node), indexPattern, config, context; + if (functions.is.isNode(node)) + return functions.is.toElasticsearchQuery(node, indexPattern, config, context); + if (functions.nested.isNode(node)) + return functions.nested.toElasticsearchQuery(node, indexPattern, config, context); + if (functions.not.isNode(node)) + return functions.not.toElasticsearchQuery(node, indexPattern, config, context); + if (functions.or.isNode(node)) + return functions.or.toElasticsearchQuery(node, indexPattern, config, context); + if (functions.range.isNode(node)) + return functions.range.toElasticsearchQuery(node, indexPattern, config, context); + throw new Error(`Unknown KQL function: "${node.function}"`); +} + +export function toKqlExpression(node: KqlFunctionNode): string { + if (functions.and.isNode(node)) return functions.and.toKqlExpression(node); + if (functions.exists.isNode(node)) return functions.exists.toKqlExpression(node); + if (functions.is.isNode(node)) return functions.is.toKqlExpression(node); + if (functions.nested.isNode(node)) return functions.nested.toKqlExpression(node); + if (functions.not.isNode(node)) return functions.not.toKqlExpression(node); + if (functions.or.isNode(node)) return functions.or.toKqlExpression(node); + if (functions.range.isNode(node)) return functions.range.toKqlExpression(node); + throw new Error(`Unknown KQL function: "${node.function}"`); } diff --git a/packages/kbn-es-query/src/kuery/node_types/index.ts b/packages/kbn-es-query/src/kuery/node_types/index.ts index 99cde81d15887..246cacc66684a 100644 --- a/packages/kbn-es-query/src/kuery/node_types/index.ts +++ b/packages/kbn-es-query/src/kuery/node_types/index.ts @@ -9,11 +9,13 @@ import * as functionType from './function'; import * as literal from './literal'; import * as wildcard from './wildcard'; -import { FunctionTypeBuildNode } from './types'; -export type { FunctionTypeBuildNode }; export { nodeBuilder } from './node_builder'; +export { type KqlFunctionNode, KQL_NODE_TYPE_FUNCTION } from './function'; +export { type KqlLiteralNode, KQL_NODE_TYPE_LITERAL } from './literal'; +export { type KqlWildcardNode, KQL_NODE_TYPE_WILDCARD } from './wildcard'; + /** * @public */ diff --git a/packages/kbn-es-query/src/kuery/node_types/literal.test.ts b/packages/kbn-es-query/src/kuery/node_types/literal.test.ts index d2427844fd2f8..d3319cb3b1c81 100644 --- a/packages/kbn-es-query/src/kuery/node_types/literal.test.ts +++ b/packages/kbn-es-query/src/kuery/node_types/literal.test.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { buildNode, KQL_NODE_TYPE_LITERAL, toElasticsearchQuery } from './literal'; +import { buildNode, KQL_NODE_TYPE_LITERAL, toElasticsearchQuery, toKqlExpression } from './literal'; jest.mock('../grammar'); @@ -29,5 +29,19 @@ describe('kuery node types', () => { expect(result).toBe('foo'); }); }); + + describe('toKqlExpression', () => { + test('quoted', () => { + const node = buildNode('foo'); + const result = toKqlExpression(node); + expect(result).toBe('foo'); + }); + + test('unquoted', () => { + const node = buildNode('foo', true); + const result = toKqlExpression(node); + expect(result).toBe('"foo"'); + }); + }); }); }); diff --git a/packages/kbn-es-query/src/kuery/node_types/literal.ts b/packages/kbn-es-query/src/kuery/node_types/literal.ts index 8f0028cb0d19e..ce1541a806ef6 100644 --- a/packages/kbn-es-query/src/kuery/node_types/literal.ts +++ b/packages/kbn-es-query/src/kuery/node_types/literal.ts @@ -33,3 +33,7 @@ export function buildNode(value: KqlLiteralType, isQuoted: boolean = false): Kql export function toElasticsearchQuery(node: KqlLiteralNode) { return node.value; } + +export function toKqlExpression(node: KqlLiteralNode): string { + return node.isQuoted ? `"${node.value}"` : `${node.value}`; +} diff --git a/packages/kbn-es-query/src/kuery/node_types/types.ts b/packages/kbn-es-query/src/kuery/node_types/types.ts deleted file mode 100644 index 8492f4069ae8b..0000000000000 --- a/packages/kbn-es-query/src/kuery/node_types/types.ts +++ /dev/null @@ -1,20 +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. - */ - -/** - * WARNING: these typings are incomplete - */ - -export type FunctionName = 'is' | 'and' | 'or' | 'not' | 'range' | 'exists' | 'nested'; - -export interface FunctionTypeBuildNode { - type: 'function'; - function: FunctionName; - // TODO -> Need to define a better type for DSL query - arguments: any[]; -} diff --git a/packages/kbn-es-query/src/kuery/node_types/wildcard.test.ts b/packages/kbn-es-query/src/kuery/node_types/wildcard.test.ts index 7230476ea7ffd..40cbfc00e8284 100644 --- a/packages/kbn-es-query/src/kuery/node_types/wildcard.test.ts +++ b/packages/kbn-es-query/src/kuery/node_types/wildcard.test.ts @@ -7,14 +7,15 @@ */ import { - buildNode, + type KqlWildcardNode, + KQL_NODE_TYPE_WILDCARD, KQL_WILDCARD_SYMBOL, + buildNode, hasLeadingWildcard, - toElasticsearchQuery, test as testNode, + toElasticsearchQuery, + toKqlExpression, toQueryStringQuery, - KQL_NODE_TYPE_WILDCARD, - // @ts-ignore } from './wildcard'; jest.mock('../grammar'); @@ -98,5 +99,16 @@ describe('kuery node types', () => { expect(hasLeadingWildcard(leadingWildcardNode)).toBe(false); }); }); + + describe('toKqlExpression', () => { + test('should return the string representation of the wildcard literal', () => { + const node: KqlWildcardNode = { + type: 'wildcard', + value: 'foo*bar@kuery-wildcard@baz', + }; + const result = toKqlExpression(node); + expect(result).toBe('foo\\*bar*baz'); + }); + }); }); }); diff --git a/packages/kbn-es-query/src/kuery/node_types/wildcard.ts b/packages/kbn-es-query/src/kuery/node_types/wildcard.ts index 2cd3d9cb164e4..d12a6baece892 100644 --- a/packages/kbn-es-query/src/kuery/node_types/wildcard.ts +++ b/packages/kbn-es-query/src/kuery/node_types/wildcard.ts @@ -71,3 +71,7 @@ export function isLoneWildcard({ value }: KqlWildcardNode) { export function hasLeadingWildcard(node: KqlWildcardNode) { return !isLoneWildcard(node) && node.value.startsWith(KQL_WILDCARD_SYMBOL); } + +export function toKqlExpression(node: KqlWildcardNode): string { + return toQueryStringQuery(node); +} diff --git a/packages/kbn-es-query/src/kuery/types.ts b/packages/kbn-es-query/src/kuery/types.ts index 57cc2a52beeee..118e7a6434f10 100644 --- a/packages/kbn-es-query/src/kuery/types.ts +++ b/packages/kbn-es-query/src/kuery/types.ts @@ -8,11 +8,15 @@ import * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import { SerializableRecord } from '@kbn/utility-types'; +import { KQL_NODE_TYPE_FUNCTION } from './node_types/function'; import { KQL_NODE_TYPE_LITERAL } from './node_types/literal'; import { KQL_NODE_TYPE_WILDCARD } from './node_types/wildcard'; /** @public */ -export type KqlNodeType = typeof KQL_NODE_TYPE_LITERAL | 'function' | typeof KQL_NODE_TYPE_WILDCARD; +export type KqlNodeType = + | typeof KQL_NODE_TYPE_LITERAL + | typeof KQL_NODE_TYPE_FUNCTION + | typeof KQL_NODE_TYPE_WILDCARD; /** @public */ export interface KueryNode { diff --git a/packages/kbn-event-annotation-common/README.md b/packages/kbn-event-annotation-common/README.md new file mode 100644 index 0000000000000..afeed89bbcfee --- /dev/null +++ b/packages/kbn-event-annotation-common/README.md @@ -0,0 +1,3 @@ +# @kbn/event-annotation-common + +A few core annotation-related types and utilities that are available in both server and browser contexts. diff --git a/packages/kbn-event-annotation-common/index.ts b/packages/kbn-event-annotation-common/index.ts new file mode 100644 index 0000000000000..f6df6a02171d1 --- /dev/null +++ b/packages/kbn-event-annotation-common/index.ts @@ -0,0 +1,52 @@ +/* + * 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 const AvailableAnnotationIcons = { + ASTERISK: 'asterisk', + ALERT: 'alert', + BELL: 'bell', + BOLT: 'bolt', + BUG: 'bug', + CIRCLE: 'circle', + EDITOR_COMMENT: 'editorComment', + FLAG: 'flag', + HEART: 'heart', + MAP_MARKER: 'mapMarker', + PIN_FILLED: 'pinFilled', + STAR_EMPTY: 'starEmpty', + STAR_FILLED: 'starFilled', + TAG: 'tag', + TRIANGLE: 'triangle', +} as const; + +export const EVENT_ANNOTATION_GROUP_TYPE = 'event-annotation-group'; + +export { + defaultAnnotationColor, + defaultAnnotationRangeColor, + defaultAnnotationLabel, + getDefaultManualAnnotation, + getDefaultQueryAnnotation, + createCopiedAnnotation, + isRangeAnnotationConfig, + isManualPointAnnotationConfig, + isQueryAnnotationConfig, +} from './util'; + +export type { + EventAnnotationGroupContent, + AvailableAnnotationIcon, + PointStyleProps, + EventAnnotationConfig, + EventAnnotationGroupConfig, + RangeStyleProps, + ManualAnnotationType, + PointInTimeEventAnnotationConfig, + RangeEventAnnotationConfig, + QueryPointEventAnnotationConfig, +} from './types'; diff --git a/packages/kbn-event-annotation-common/jest.config.js b/packages/kbn-event-annotation-common/jest.config.js new file mode 100644 index 0000000000000..07c7e2e2142da --- /dev/null +++ b/packages/kbn-event-annotation-common/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-event-annotation-common'], +}; diff --git a/packages/kbn-event-annotation-common/kibana.jsonc b/packages/kbn-event-annotation-common/kibana.jsonc new file mode 100644 index 0000000000000..cdf2a346730ee --- /dev/null +++ b/packages/kbn-event-annotation-common/kibana.jsonc @@ -0,0 +1,5 @@ +{ + "type": "shared-common", + "id": "@kbn/event-annotation-common", + "owner": "@elastic/kibana-visualizations" +} diff --git a/packages/kbn-event-annotation-common/package.json b/packages/kbn-event-annotation-common/package.json new file mode 100644 index 0000000000000..b5b8c70f4f85a --- /dev/null +++ b/packages/kbn-event-annotation-common/package.json @@ -0,0 +1,7 @@ +{ + "name": "@kbn/event-annotation-common", + "private": true, + "version": "1.0.0", + "license": "SSPL-1.0 OR Elastic License 2.0", + "sideEffects": false +} diff --git a/packages/kbn-event-annotation-common/tsconfig.json b/packages/kbn-event-annotation-common/tsconfig.json new file mode 100644 index 0000000000000..c146bae7d9efa --- /dev/null +++ b/packages/kbn-event-annotation-common/tsconfig.json @@ -0,0 +1,23 @@ +{ + "extends": "../../tsconfig.base.json", + "compilerOptions": { + "outDir": "target/types", + "types": [ + "jest", + "node" + ] + }, + "include": [ + "**/*.ts", + ], + "exclude": [ + "target/**/*" + ], + "kbn_references": [ + "@kbn/data-plugin", + "@kbn/content-management-table-list-view-table", + "@kbn/visualization-ui-components", + "@kbn/ui-theme", + "@kbn/i18n", + ] +} diff --git a/packages/kbn-event-annotation-common/types.ts b/packages/kbn-event-annotation-common/types.ts new file mode 100644 index 0000000000000..3c1c12bca8c80 --- /dev/null +++ b/packages/kbn-event-annotation-common/types.ts @@ -0,0 +1,89 @@ +/* + * 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 { $Values } from 'utility-types'; +import { DataViewSpec, KibanaQueryOutput } from '@kbn/data-plugin/common'; +import { UserContentCommonSchema } from '@kbn/content-management-table-list-view-table'; +import type { LineStyle } from '@kbn/visualization-ui-components'; +import { AvailableAnnotationIcons } from '.'; + +export type AvailableAnnotationIcon = $Values; + +export type PointStyleProps = StyleSharedProps & { + icon?: AvailableAnnotationIcon; + lineWidth?: number; + lineStyle?: LineStyle; + textVisibility?: boolean; +}; + +export type PointInTimeEventAnnotationConfig = { + id: string; + type: ManualAnnotationType; + key: { + type: 'point_in_time'; + timestamp: string; + }; +} & PointStyleProps; + +export type Fill = 'inside' | 'outside' | 'none'; +export type ManualAnnotationType = 'manual'; +export type QueryAnnotationType = 'query'; +export type KeyType = 'point_in_time' | 'range'; + +interface StyleSharedProps { + label: string; + color?: string; + isHidden?: boolean; +} + +export type RangeStyleProps = StyleSharedProps & { + outside?: boolean; +}; + +export type RangeEventAnnotationConfig = { + type: ManualAnnotationType; + id: string; + key: { + type: 'range'; + timestamp: string; + endTimestamp: string; + }; +} & RangeStyleProps; + +export type StyleProps = PointStyleProps & RangeStyleProps; + +export type QueryPointEventAnnotationConfig = { + id: string; + type: QueryAnnotationType; + filter: KibanaQueryOutput; + timeField?: string; + textField?: string; + extraFields?: string[]; + key: { + type: 'point_in_time'; + }; +} & PointStyleProps; + +export type EventAnnotationConfig = + | PointInTimeEventAnnotationConfig + | RangeEventAnnotationConfig + | QueryPointEventAnnotationConfig; + +export interface EventAnnotationGroupConfig { + annotations: EventAnnotationConfig[]; + indexPatternId: string; + ignoreGlobalFilters: boolean; + title: string; + description: string; + tags: string[]; + dataViewSpec?: DataViewSpec; +} + +export type EventAnnotationGroupContent = UserContentCommonSchema & { + attributes: { indexPatternId: string; dataViewSpec?: DataViewSpec }; +}; diff --git a/src/plugins/event_annotation/public/event_annotation_service/helpers.ts b/packages/kbn-event-annotation-common/util.ts similarity index 56% rename from src/plugins/event_annotation/public/event_annotation_service/helpers.ts rename to packages/kbn-event-annotation-common/util.ts index 31dabb34cdc09..40c7a07e626c1 100644 --- a/src/plugins/event_annotation/public/event_annotation_service/helpers.ts +++ b/packages/kbn-event-annotation-common/util.ts @@ -6,12 +6,14 @@ * Side Public License, v 1. */ import { euiLightVars } from '@kbn/ui-theme'; +import { i18n } from '@kbn/i18n'; import { EventAnnotationConfig, RangeEventAnnotationConfig, PointInTimeEventAnnotationConfig, QueryPointEventAnnotationConfig, -} from '../../common'; +} from './types'; + export const defaultAnnotationColor = euiLightVars.euiColorAccent; // Do not compute it live as dependencies will add tens of Kbs to the plugin export const defaultAnnotationRangeColor = `#F04E981A`; // defaultAnnotationColor with opacity 0.1 @@ -33,3 +35,57 @@ export const isQueryAnnotationConfig = ( ): annotation is QueryPointEventAnnotationConfig => { return Boolean(annotation && annotation.type === 'query'); }; + +export const createCopiedAnnotation = ( + newId: string, + timestamp: string, + source?: EventAnnotationConfig +): EventAnnotationConfig => { + if (!source) { + return getDefaultManualAnnotation(newId, timestamp); + } + return { + ...source, + id: newId, + }; +}; + +export const defaultAnnotationLabel = i18n.translate( + 'eventAnnotationCommon.manualAnnotation.defaultAnnotationLabel', + { + defaultMessage: 'Event', + } +); + +export const getDefaultManualAnnotation = ( + id: string, + timestamp: string +): EventAnnotationConfig => ({ + label: defaultAnnotationLabel, + type: 'manual', + key: { + type: 'point_in_time', + timestamp, + }, + icon: 'triangle', + id, +}); + +export const getDefaultQueryAnnotation = ( + id: string, + fieldName: string, + timeField: string +): EventAnnotationConfig => ({ + filter: { + type: 'kibana_query', + query: `${fieldName}: *`, + language: 'kuery', + }, + timeField, + type: 'query', + key: { + type: 'point_in_time', + }, + id, + label: `${fieldName}: *`, +}); diff --git a/packages/kbn-event-annotation-components/README.md b/packages/kbn-event-annotation-components/README.md new file mode 100644 index 0000000000000..4c3283fa6714e --- /dev/null +++ b/packages/kbn-event-annotation-components/README.md @@ -0,0 +1,3 @@ +# @kbn/event-annotation-components + +A collection of static components used for interacting with event annotations. diff --git a/src/plugins/event_annotation/public/components/__snapshots__/group_editor_flyout.test.tsx.snap b/packages/kbn-event-annotation-components/components/__snapshots__/group_editor_flyout.test.tsx.snap similarity index 100% rename from src/plugins/event_annotation/public/components/__snapshots__/group_editor_flyout.test.tsx.snap rename to packages/kbn-event-annotation-components/components/__snapshots__/group_editor_flyout.test.tsx.snap diff --git a/src/plugins/event_annotation/public/components/annotation_editor_controls/annotation_editor_controls.tsx b/packages/kbn-event-annotation-components/components/annotation_editor_controls/annotation_editor_controls.tsx similarity index 89% rename from src/plugins/event_annotation/public/components/annotation_editor_controls/annotation_editor_controls.tsx rename to packages/kbn-event-annotation-components/components/annotation_editor_controls/annotation_editor_controls.tsx index 01116e3806a5a..21b7870db45db 100644 --- a/src/plugins/event_annotation/public/components/annotation_editor_controls/annotation_editor_controls.tsx +++ b/packages/kbn-event-annotation-components/components/annotation_editor_controls/annotation_editor_controls.tsx @@ -7,7 +7,7 @@ */ import './index.scss'; -import { isFieldLensCompatible } from '@kbn/visualization-ui-components/public'; +import { isFieldLensCompatible } from '@kbn/visualization-ui-components'; import React, { useCallback, useEffect } from 'react'; import { i18n } from '@kbn/i18n'; import { EuiFormRow, EuiSwitch, EuiSwitchEvent, EuiButtonGroup, EuiSpacer } from '@elastic/eui'; @@ -21,19 +21,19 @@ import { FieldPicker, FieldOption, type QueryInputServices, -} from '@kbn/visualization-ui-components/public'; -import type { FieldOptionValue } from '@kbn/visualization-ui-components/public'; +} from '@kbn/visualization-ui-components'; +import type { FieldOptionValue } from '@kbn/visualization-ui-components'; import { DataView } from '@kbn/data-views-plugin/common'; import { useExistingFieldsReader } from '@kbn/unified-field-list/src/hooks/use_existing_fields'; import moment from 'moment'; import { htmlIdGenerator } from '@elastic/eui'; -import { isQueryAnnotationConfig, isRangeAnnotationConfig } from '../..'; -import { +import type { AvailableAnnotationIcon, EventAnnotationConfig, PointInTimeEventAnnotationConfig, QueryPointEventAnnotationConfig, -} from '../../../common'; +} from '@kbn/event-annotation-common'; +import { isQueryAnnotationConfig, isRangeAnnotationConfig } from '../..'; import { defaultAnnotationColor, defaultAnnotationLabel, @@ -88,35 +88,38 @@ const AnnotationEditorControls = ({ return ( <> @@ -276,14 +279,14 @@ const AnnotationEditorControls = ({ )} {isRange && ( {isQueryBased && currentAnnotation && ( @@ -347,7 +350,7 @@ const AnnotationEditorControls = ({ display="rowCompressed" className="lnsRowCompressedMargin" fullWidth - label={i18n.translate('eventAnnotation.xyChart.annotation.tooltip', { + label={i18n.translate('eventAnnotationComponents.xyChart.annotation.tooltip', { defaultMessage: 'Show additional fields', })} > diff --git a/src/plugins/event_annotation/public/components/annotation_editor_controls/helpers.ts b/packages/kbn-event-annotation-components/components/annotation_editor_controls/helpers.ts similarity index 93% rename from src/plugins/event_annotation/public/components/annotation_editor_controls/helpers.ts rename to packages/kbn-event-annotation-components/components/annotation_editor_controls/helpers.ts index f823dab7e7357..ce40c8a71ed48 100644 --- a/src/plugins/event_annotation/public/components/annotation_editor_controls/helpers.ts +++ b/packages/kbn-event-annotation-components/components/annotation_editor_controls/helpers.ts @@ -11,27 +11,27 @@ import { pick } from 'lodash'; import { euiLightVars } from '@kbn/ui-theme'; import { i18n } from '@kbn/i18n'; import chroma from 'chroma-js'; -import { isQueryAnnotationConfig, isRangeAnnotationConfig } from '../..'; import type { EventAnnotationConfig, RangeEventAnnotationConfig, PointInTimeEventAnnotationConfig, QueryPointEventAnnotationConfig, -} from '../../../common'; +} from '@kbn/event-annotation-common'; +import { isQueryAnnotationConfig, isRangeAnnotationConfig } from '../..'; export const defaultAnnotationColor = euiLightVars.euiColorAccent; // Do not compute it live as dependencies will add tens of Kbs to the plugin export const defaultAnnotationRangeColor = `#F04E981A`; // defaultAnnotationColor with opacity 0.1 export const defaultAnnotationLabel = i18n.translate( - 'eventAnnotation.xyChart.defaultAnnotationLabel', + 'eventAnnotationComponents.xyChart.defaultAnnotationLabel', { defaultMessage: 'Event', } ); export const defaultRangeAnnotationLabel = i18n.translate( - 'eventAnnotation.xyChart.defaultRangeAnnotationLabel', + 'eventAnnotationComponents.xyChart.defaultRangeAnnotationLabel', { defaultMessage: 'Event range', } diff --git a/src/plugins/event_annotation/public/components/annotation_editor_controls/icon_set.ts b/packages/kbn-event-annotation-components/components/annotation_editor_controls/icon_set.ts similarity index 52% rename from src/plugins/event_annotation/public/components/annotation_editor_controls/icon_set.ts rename to packages/kbn-event-annotation-components/components/annotation_editor_controls/icon_set.ts index 36f8d4de9e7d4..fc221c598ef20 100644 --- a/src/plugins/event_annotation/public/components/annotation_editor_controls/icon_set.ts +++ b/packages/kbn-event-annotation-components/components/annotation_editor_controls/icon_set.ts @@ -8,43 +8,43 @@ import { i18n } from '@kbn/i18n'; import { IconTriangle, IconCircle } from '@kbn/chart-icons'; -import type { IconSet } from '@kbn/visualization-ui-components/public'; -import { AvailableAnnotationIcon } from '../../../common'; +import type { IconSet } from '@kbn/visualization-ui-components'; +import type { AvailableAnnotationIcon } from '@kbn/event-annotation-common'; export const annotationsIconSet: IconSet = [ { value: 'asterisk', - label: i18n.translate('eventAnnotation.xyChart.iconSelect.asteriskIconLabel', { + label: i18n.translate('eventAnnotationComponents.xyChart.iconSelect.asteriskIconLabel', { defaultMessage: 'Asterisk', }), }, { value: 'alert', - label: i18n.translate('eventAnnotation.xyChart.iconSelect.alertIconLabel', { + label: i18n.translate('eventAnnotationComponents.xyChart.iconSelect.alertIconLabel', { defaultMessage: 'Alert', }), }, { value: 'bell', - label: i18n.translate('eventAnnotation.xyChart.iconSelect.bellIconLabel', { + label: i18n.translate('eventAnnotationComponents.xyChart.iconSelect.bellIconLabel', { defaultMessage: 'Bell', }), }, { value: 'bolt', - label: i18n.translate('eventAnnotation.xyChart.iconSelect.boltIconLabel', { + label: i18n.translate('eventAnnotationComponents.xyChart.iconSelect.boltIconLabel', { defaultMessage: 'Bolt', }), }, { value: 'bug', - label: i18n.translate('eventAnnotation.xyChart.iconSelect.bugIconLabel', { + label: i18n.translate('eventAnnotationComponents.xyChart.iconSelect.bugIconLabel', { defaultMessage: 'Bug', }), }, { value: 'circle', - label: i18n.translate('eventAnnotation.xyChart.iconSelect.circleIconLabel', { + label: i18n.translate('eventAnnotationComponents.xyChart.iconSelect.circleIconLabel', { defaultMessage: 'Circle', }), icon: IconCircle, @@ -52,55 +52,55 @@ export const annotationsIconSet: IconSet = [ { value: 'editorComment', - label: i18n.translate('eventAnnotation.xyChart.iconSelect.commentIconLabel', { + label: i18n.translate('eventAnnotationComponents.xyChart.iconSelect.commentIconLabel', { defaultMessage: 'Comment', }), }, { value: 'flag', - label: i18n.translate('eventAnnotation.xyChart.iconSelect.flagIconLabel', { + label: i18n.translate('eventAnnotationComponents.xyChart.iconSelect.flagIconLabel', { defaultMessage: 'Flag', }), }, { value: 'heart', - label: i18n.translate('eventAnnotation.xyChart.iconSelect.heartLabel', { + label: i18n.translate('eventAnnotationComponents.xyChart.iconSelect.heartLabel', { defaultMessage: 'Heart', }), }, { value: 'mapMarker', - label: i18n.translate('eventAnnotation.xyChart.iconSelect.mapMarkerLabel', { + label: i18n.translate('eventAnnotationComponents.xyChart.iconSelect.mapMarkerLabel', { defaultMessage: 'Map Marker', }), }, { value: 'pinFilled', - label: i18n.translate('eventAnnotation.xyChart.iconSelect.mapPinLabel', { + label: i18n.translate('eventAnnotationComponents.xyChart.iconSelect.mapPinLabel', { defaultMessage: 'Map Pin', }), }, { value: 'starEmpty', - label: i18n.translate('eventAnnotation.xyChart.iconSelect.starLabel', { + label: i18n.translate('eventAnnotationComponents.xyChart.iconSelect.starLabel', { defaultMessage: 'Star', }), }, { value: 'starFilled', - label: i18n.translate('eventAnnotation.xyChart.iconSelect.starFilledLabel', { + label: i18n.translate('eventAnnotationComponents.xyChart.iconSelect.starFilledLabel', { defaultMessage: 'Star filled', }), }, { value: 'tag', - label: i18n.translate('eventAnnotation.xyChart.iconSelect.tagIconLabel', { + label: i18n.translate('eventAnnotationComponents.xyChart.iconSelect.tagIconLabel', { defaultMessage: 'Tag', }), }, { value: 'triangle', - label: i18n.translate('eventAnnotation.xyChart.iconSelect.triangleIconLabel', { + label: i18n.translate('eventAnnotationComponents.xyChart.iconSelect.triangleIconLabel', { defaultMessage: 'Triangle', }), icon: IconTriangle, diff --git a/src/plugins/event_annotation/public/components/annotation_editor_controls/index.scss b/packages/kbn-event-annotation-components/components/annotation_editor_controls/index.scss similarity index 100% rename from src/plugins/event_annotation/public/components/annotation_editor_controls/index.scss rename to packages/kbn-event-annotation-components/components/annotation_editor_controls/index.scss diff --git a/src/plugins/event_annotation/public/components/annotation_editor_controls/index.test.tsx b/packages/kbn-event-annotation-components/components/annotation_editor_controls/index.test.tsx similarity index 99% rename from src/plugins/event_annotation/public/components/annotation_editor_controls/index.test.tsx rename to packages/kbn-event-annotation-components/components/annotation_editor_controls/index.test.tsx index bfbd8a5d65b44..3aaa034bdcc99 100644 --- a/src/plugins/event_annotation/public/components/annotation_editor_controls/index.test.tsx +++ b/packages/kbn-event-annotation-components/components/annotation_editor_controls/index.test.tsx @@ -11,8 +11,11 @@ import AnnotationEditorControls from './annotation_editor_controls'; import React from 'react'; import { mount } from 'enzyme'; -import { EventAnnotationConfig, RangeEventAnnotationConfig } from '../../../common'; -import { QueryInputServices } from '@kbn/visualization-ui-components/public'; +import type { + EventAnnotationConfig, + RangeEventAnnotationConfig, +} from '@kbn/event-annotation-common'; +import { QueryInputServices } from '@kbn/visualization-ui-components'; import moment from 'moment'; import { act } from 'react-dom/test-utils'; import { EuiButtonGroup } from '@elastic/eui'; diff --git a/src/plugins/event_annotation/public/components/annotation_editor_controls/index.tsx b/packages/kbn-event-annotation-components/components/annotation_editor_controls/index.tsx similarity index 100% rename from src/plugins/event_annotation/public/components/annotation_editor_controls/index.tsx rename to packages/kbn-event-annotation-components/components/annotation_editor_controls/index.tsx diff --git a/src/plugins/event_annotation/public/components/annotation_editor_controls/manual_annotation_panel.tsx b/packages/kbn-event-annotation-components/components/annotation_editor_controls/manual_annotation_panel.tsx similarity index 92% rename from src/plugins/event_annotation/public/components/annotation_editor_controls/manual_annotation_panel.tsx rename to packages/kbn-event-annotation-components/components/annotation_editor_controls/manual_annotation_panel.tsx index 8ddac6c6173c4..df03c451bca14 100644 --- a/src/plugins/event_annotation/public/components/annotation_editor_controls/manual_annotation_panel.tsx +++ b/packages/kbn-event-annotation-components/components/annotation_editor_controls/manual_annotation_panel.tsx @@ -35,7 +35,7 @@ export const ConfigPanelManualAnnotation = ({ @@ -92,7 +92,7 @@ export const ConfigPanelQueryAnnotation = ({ diff --git a/src/plugins/event_annotation/public/components/annotation_editor_controls/range_annotation_panel.tsx b/packages/kbn-event-annotation-components/components/annotation_editor_controls/range_annotation_panel.tsx similarity index 95% rename from src/plugins/event_annotation/public/components/annotation_editor_controls/range_annotation_panel.tsx rename to packages/kbn-event-annotation-components/components/annotation_editor_controls/range_annotation_panel.tsx index 0418994677947..4db4a1fbe9784 100644 --- a/src/plugins/event_annotation/public/components/annotation_editor_controls/range_annotation_panel.tsx +++ b/packages/kbn-event-annotation-components/components/annotation_editor_controls/range_annotation_panel.tsx @@ -17,8 +17,11 @@ import { EuiDatePicker, } from '@elastic/eui'; import moment from 'moment'; +import type { + PointInTimeEventAnnotationConfig, + RangeEventAnnotationConfig, +} from '@kbn/event-annotation-common'; import { isRangeAnnotationConfig } from '../..'; -import type { PointInTimeEventAnnotationConfig, RangeEventAnnotationConfig } from '../../../common'; import { defaultRangeAnnotationLabel, defaultAnnotationLabel } from './helpers'; import { toLineAnnotationColor, toRangeAnnotationColor } from './helpers'; import type { ManualEventAnnotationType } from './types'; @@ -39,7 +42,7 @@ export const ConfigPanelApplyAsRangeSwitch = ({ data-test-subj="lns-xyAnnotation-rangeSwitch" label={ - {i18n.translate('eventAnnotation.xyChart.applyAsRange', { + {i18n.translate('eventAnnotationComponents.xyChart.applyAsRange', { defaultMessage: 'Apply as range', })} diff --git a/src/plugins/event_annotation/public/components/annotation_editor_controls/tooltip_annotation_panel.tsx b/packages/kbn-event-annotation-components/components/annotation_editor_controls/tooltip_annotation_panel.tsx similarity index 93% rename from src/plugins/event_annotation/public/components/annotation_editor_controls/tooltip_annotation_panel.tsx rename to packages/kbn-event-annotation-components/components/annotation_editor_controls/tooltip_annotation_panel.tsx index b44868b440071..f1ed8ccc7ccb2 100644 --- a/src/plugins/event_annotation/public/components/annotation_editor_controls/tooltip_annotation_panel.tsx +++ b/packages/kbn-event-annotation-components/components/annotation_editor_controls/tooltip_annotation_panel.tsx @@ -19,10 +19,10 @@ import { DragDropBuckets, DraggableBucketContainer, FieldsBucketContainer, -} from '@kbn/visualization-ui-components/public'; + isFieldLensCompatible, +} from '@kbn/visualization-ui-components'; import { DataView } from '@kbn/data-views-plugin/common'; -import { isFieldLensCompatible } from '@kbn/visualization-ui-components/public'; -import { QueryPointEventAnnotationConfig } from '../../../common'; +import type { QueryPointEventAnnotationConfig } from '@kbn/event-annotation-common'; export const MAX_TOOLTIP_FIELDS_SIZE = 2; @@ -98,7 +98,7 @@ export function TooltipSection({ onClick={() => { handleInputChange([...localValues, { id: generateId(), value: undefined, isNew: true }]); }} - label={i18n.translate('eventAnnotation.xyChart.annotation.tooltip.addField', { + label={i18n.translate('eventAnnotationComponents.xyChart.annotation.tooltip.addField', { defaultMessage: 'Add field', })} isDisabled={localValues.length > MAX_TOOLTIP_FIELDS_SIZE} @@ -115,7 +115,7 @@ export function TooltipSection({ className="lnsConfigPanelAnnotations__noFieldsPrompt" > - {i18n.translate('eventAnnotation.xyChart.annotation.tooltip.noFields', { + {i18n.translate('eventAnnotationComponents.xyChart.annotation.tooltip.noFields', { defaultMessage: 'None selected', })} @@ -170,7 +170,7 @@ export function TooltipSection({ handleInputChange(arrayRef.filter((_, i) => i !== index)); }} removeTitle={i18n.translate( - 'eventAnnotation.xyChart.annotation.tooltip.deleteButtonLabel', + 'eventAnnotationComponents.xyChart.annotation.tooltip.deleteButtonLabel', { defaultMessage: 'Delete', } diff --git a/src/plugins/event_annotation/public/components/annotation_editor_controls/types.ts b/packages/kbn-event-annotation-components/components/annotation_editor_controls/types.ts similarity index 79% rename from src/plugins/event_annotation/public/components/annotation_editor_controls/types.ts rename to packages/kbn-event-annotation-components/components/annotation_editor_controls/types.ts index 094543e4f71d8..137cefb6407d7 100644 --- a/src/plugins/event_annotation/public/components/annotation_editor_controls/types.ts +++ b/packages/kbn-event-annotation-components/components/annotation_editor_controls/types.ts @@ -6,7 +6,10 @@ * Side Public License, v 1. */ -import type { PointInTimeEventAnnotationConfig, RangeEventAnnotationConfig } from '../../../common'; +import type { + PointInTimeEventAnnotationConfig, + RangeEventAnnotationConfig, +} from '@kbn/event-annotation-common'; export type ManualEventAnnotationType = | PointInTimeEventAnnotationConfig diff --git a/packages/kbn-event-annotation-components/components/event_annotation_group_saved_object_finder.tsx b/packages/kbn-event-annotation-components/components/event_annotation_group_saved_object_finder.tsx new file mode 100644 index 0000000000000..4ccdb6164a5a6 --- /dev/null +++ b/packages/kbn-event-annotation-components/components/event_annotation_group_saved_object_finder.tsx @@ -0,0 +1,135 @@ +/* + * 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, { useEffect, useState } from 'react'; +import { i18n } from '@kbn/i18n'; +import type { CoreStart } from '@kbn/core/public'; +import { FormattedMessage } from '@kbn/i18n-react'; +import type { IUiSettingsClient } from '@kbn/core-ui-settings-browser'; +import type { SavedObjectCommon } from '@kbn/saved-objects-finder-plugin/common'; +import { SavedObjectFinder } from '@kbn/saved-objects-finder-plugin/public'; +import type { SavedObjectsManagementPluginStart } from '@kbn/saved-objects-management-plugin/public'; +import { + EuiButton, + EuiEmptyPrompt, + EuiFlexGroup, + EuiFlexItem, + EuiLoadingSpinner, + EuiText, +} from '@elastic/eui'; +import { css } from '@emotion/react'; +import { EVENT_ANNOTATION_GROUP_TYPE } from '@kbn/event-annotation-common'; + +export const EventAnnotationGroupSavedObjectFinder = ({ + uiSettings, + http, + savedObjectsManagement, + fixedPageSize = 10, + checkHasAnnotationGroups, + onChoose, + onCreateNew, +}: { + uiSettings: IUiSettingsClient; + http: CoreStart['http']; + savedObjectsManagement: SavedObjectsManagementPluginStart; + fixedPageSize?: number; + checkHasAnnotationGroups: () => Promise; + onChoose: (value: { + id: string; + type: string; + fullName: string; + savedObject: SavedObjectCommon; + }) => void; + onCreateNew: () => void; +}) => { + const [hasAnnotationGroups, setHasAnnotationGroups] = useState(); + + useEffect(() => { + checkHasAnnotationGroups().then(setHasAnnotationGroups); + }, [checkHasAnnotationGroups]); + + return hasAnnotationGroups === undefined ? ( + + + + + + ) : hasAnnotationGroups === false ? ( + + + + + + } + body={ + +

    + +

    +
    + } + actions={ + onCreateNew()} size="s"> + + + } + /> +
    +
    + ) : ( + { + onChoose({ id, type, fullName, savedObject }); + }} + showFilter={false} + noItemsMessage={ + + } + savedObjectMetaData={savedObjectMetaData} + services={{ + uiSettings, + http, + savedObjectsManagement, + }} + /> + ); +}; + +const savedObjectMetaData = [ + { + type: EVENT_ANNOTATION_GROUP_TYPE, + getIconForSavedObject: () => 'annotation', + name: i18n.translate('eventAnnotationComponents.eventAnnotationGroup.metadata.name', { + defaultMessage: 'Annotations Groups', + }), + includeFields: ['*'], + }, +]; diff --git a/src/plugins/event_annotation/public/components/get_annotation_accessor.ts b/packages/kbn-event-annotation-components/components/get_annotation_accessor.ts similarity index 91% rename from src/plugins/event_annotation/public/components/get_annotation_accessor.ts rename to packages/kbn-event-annotation-components/components/get_annotation_accessor.ts index 1ece7164f2557..16cdc0175338e 100644 --- a/src/plugins/event_annotation/public/components/get_annotation_accessor.ts +++ b/packages/kbn-event-annotation-components/components/get_annotation_accessor.ts @@ -6,13 +6,13 @@ * Side Public License, v 1. */ -import type { AccessorConfig } from '@kbn/visualization-ui-components/public'; -import { EventAnnotationConfig } from '../../common'; +import type { AccessorConfig } from '@kbn/visualization-ui-components'; +import type { EventAnnotationConfig } from '@kbn/event-annotation-common'; import { defaultAnnotationColor, defaultAnnotationRangeColor, isRangeAnnotationConfig, -} from '../event_annotation_service/helpers'; +} from '@kbn/event-annotation-common'; import { annotationsIconSet } from './annotation_editor_controls/icon_set'; export const getAnnotationAccessor = (annotation: EventAnnotationConfig): AccessorConfig => { diff --git a/src/plugins/event_annotation/public/components/group_editor_controls/annotation_list.tsx b/packages/kbn-event-annotation-components/components/group_editor_controls/annotation_list.tsx similarity index 93% rename from src/plugins/event_annotation/public/components/group_editor_controls/annotation_list.tsx rename to packages/kbn-event-annotation-components/components/group_editor_controls/annotation_list.tsx index c81552100ccc6..72a4546659420 100644 --- a/src/plugins/event_annotation/public/components/group_editor_controls/annotation_list.tsx +++ b/packages/kbn-event-annotation-components/components/group_editor_controls/annotation_list.tsx @@ -17,12 +17,13 @@ import { DimensionButton, DimensionTrigger, EmptyDimensionButton, -} from '@kbn/visualization-ui-components/public'; +} from '@kbn/visualization-ui-components'; import React, { useCallback, useEffect, useState } from 'react'; import { v4 as uuidv4 } from 'uuid'; import { euiThemeVars } from '@kbn/ui-theme'; import { i18n } from '@kbn/i18n'; -import { createCopiedAnnotation, EventAnnotationConfig } from '../../../common'; +import type { EventAnnotationConfig } from '@kbn/event-annotation-common'; +import { createCopiedAnnotation } from '@kbn/event-annotation-common'; import { getAnnotationAccessor } from '..'; export const AnnotationList = ({ @@ -39,7 +40,7 @@ export const AnnotationList = ({ setNewAnnotationId(uuidv4()); }, [annotations.length]); - const addAnnotationText = i18n.translate('eventAnnotation.annotationList.add', { + const addAnnotationText = i18n.translate('eventAnnotationComponents.annotationList.add', { defaultMessage: 'Add annotation', }); @@ -118,7 +119,7 @@ export const AnnotationList = ({ }} > selectAnnotation(annotation)} diff --git a/src/plugins/event_annotation/public/components/group_editor_controls/group_editor_controls.test.tsx b/packages/kbn-event-annotation-components/components/group_editor_controls/group_editor_controls.test.tsx similarity index 97% rename from src/plugins/event_annotation/public/components/group_editor_controls/group_editor_controls.test.tsx rename to packages/kbn-event-annotation-components/components/group_editor_controls/group_editor_controls.test.tsx index d3b9f384a185f..5af119599ca6b 100644 --- a/src/plugins/event_annotation/public/components/group_editor_controls/group_editor_controls.test.tsx +++ b/packages/kbn-event-annotation-components/components/group_editor_controls/group_editor_controls.test.tsx @@ -7,14 +7,15 @@ */ import React, { ChangeEvent, FormEvent } from 'react'; -import { EventAnnotationGroupConfig, getDefaultManualAnnotation } from '../../../common'; +import type { EventAnnotationGroupConfig } from '@kbn/event-annotation-common'; +import { getDefaultManualAnnotation } from '@kbn/event-annotation-common'; import { ReactWrapper } from 'enzyme'; import { mountWithIntl } from '@kbn/test-jest-helpers'; import { GroupEditorControls } from './group_editor_controls'; import { EuiTextAreaProps, EuiTextProps } from '@elastic/eui'; import type { DataView } from '@kbn/data-views-plugin/common'; import { act } from 'react-dom/test-utils'; -import type { QueryInputServices } from '@kbn/visualization-ui-components/public'; +import type { QueryInputServices } from '@kbn/visualization-ui-components'; import { AnnotationEditorControls, ENABLE_INDIVIDUAL_ANNOTATION_EDITING } from '..'; jest.mock('@elastic/eui', () => { diff --git a/src/plugins/event_annotation/public/components/group_editor_controls/group_editor_controls.tsx b/packages/kbn-event-annotation-components/components/group_editor_controls/group_editor_controls.tsx similarity index 87% rename from src/plugins/event_annotation/public/components/group_editor_controls/group_editor_controls.tsx rename to packages/kbn-event-annotation-components/components/group_editor_controls/group_editor_controls.tsx index c0a07a6fcb72b..eb5a0dc7ad2fb 100644 --- a/src/plugins/event_annotation/public/components/group_editor_controls/group_editor_controls.tsx +++ b/packages/kbn-event-annotation-components/components/group_editor_controls/group_editor_controls.tsx @@ -19,12 +19,15 @@ import { css } from '@emotion/react'; import type { DataView, DataViewSpec } from '@kbn/data-views-plugin/common'; import { i18n } from '@kbn/i18n'; import { FormattedMessage } from '@kbn/i18n-react'; -import { SavedObjectsTaggingApiUiComponent } from '@kbn/saved-objects-tagging-oss-plugin/public'; +import type { SavedObjectsTaggingApiUiComponent } from '@kbn/saved-objects-tagging-oss-plugin/public'; import { euiThemeVars } from '@kbn/ui-theme'; -import { QueryInputServices } from '@kbn/visualization-ui-components/public'; +import { QueryInputServices } from '@kbn/visualization-ui-components'; import React, { useCallback, useEffect, useMemo, useState } from 'react'; -import { EVENT_ANNOTATION_APP_NAME } from '../../../common/constants'; -import { EventAnnotationConfig, EventAnnotationGroupConfig } from '../../../common'; +import type { + EventAnnotationConfig, + EventAnnotationGroupConfig, +} from '@kbn/event-annotation-common'; +import { EVENT_ANNOTATION_APP_NAME } from '../../constants'; import { AnnotationEditorControls } from '../annotation_editor_controls'; import { AnnotationList } from './annotation_list'; @@ -99,16 +102,19 @@ export const GroupEditorControls = ({ `} >

    - +

    @@ -125,13 +131,13 @@ export const GroupEditorControls = ({ /> @@ -163,7 +169,7 @@ export const GroupEditorControls = ({ {ENABLE_INDIVIDUAL_ANNOTATION_EDITING && ( <> @@ -185,7 +191,7 @@ export const GroupEditorControls = ({ /> diff --git a/src/plugins/event_annotation/public/components/group_editor_controls/index.ts b/packages/kbn-event-annotation-components/components/group_editor_controls/index.ts similarity index 100% rename from src/plugins/event_annotation/public/components/group_editor_controls/index.ts rename to packages/kbn-event-annotation-components/components/group_editor_controls/index.ts diff --git a/src/plugins/event_annotation/public/components/group_editor_flyout.test.tsx b/packages/kbn-event-annotation-components/components/group_editor_flyout.test.tsx similarity index 96% rename from src/plugins/event_annotation/public/components/group_editor_flyout.test.tsx rename to packages/kbn-event-annotation-components/components/group_editor_flyout.test.tsx index 7f732aa882ffb..72ba259e1ad49 100644 --- a/src/plugins/event_annotation/public/components/group_editor_flyout.test.tsx +++ b/packages/kbn-event-annotation-components/components/group_editor_flyout.test.tsx @@ -7,14 +7,15 @@ */ import { EuiButton, EuiFlyout } from '@elastic/eui'; -import { EventAnnotationGroupConfig, getDefaultManualAnnotation } from '../../common'; +import { getDefaultManualAnnotation } from '@kbn/event-annotation-common'; +import type { EventAnnotationGroupConfig } from '@kbn/event-annotation-common'; import { taggingApiMock } from '@kbn/saved-objects-tagging-oss-plugin/public/api.mock'; import { shallow, ShallowWrapper } from 'enzyme'; import React from 'react'; import { GroupEditorControls } from './group_editor_controls'; import { GroupEditorFlyout } from './group_editor_flyout'; import { DataView } from '@kbn/data-views-plugin/common'; -import type { QueryInputServices } from '@kbn/visualization-ui-components/public'; +import type { QueryInputServices } from '@kbn/visualization-ui-components'; const simulateButtonClick = (component: ShallowWrapper, selector: string) => { (component.find(selector) as ShallowWrapper[0]>).prop('onClick')!( diff --git a/src/plugins/event_annotation/public/components/group_editor_flyout.tsx b/packages/kbn-event-annotation-components/components/group_editor_flyout.tsx similarity index 88% rename from src/plugins/event_annotation/public/components/group_editor_flyout.tsx rename to packages/kbn-event-annotation-components/components/group_editor_flyout.tsx index 3e296951542a8..9403a69a5d8b4 100644 --- a/src/plugins/event_annotation/public/components/group_editor_flyout.tsx +++ b/packages/kbn-event-annotation-components/components/group_editor_flyout.tsx @@ -20,10 +20,13 @@ import { } from '@elastic/eui'; import React, { useCallback, useEffect, useMemo, useRef, useState } from 'react'; import { FormattedMessage } from '@kbn/i18n-react'; -import { SavedObjectsTaggingApi } from '@kbn/saved-objects-tagging-oss-plugin/public'; +import type { SavedObjectsTaggingApi } from '@kbn/saved-objects-tagging-oss-plugin/public'; import { DataView, DataViewSpec } from '@kbn/data-views-plugin/common'; -import type { QueryInputServices } from '@kbn/visualization-ui-components/public'; -import { EventAnnotationConfig, EventAnnotationGroupConfig } from '../../common'; +import type { QueryInputServices } from '@kbn/visualization-ui-components'; +import type { + EventAnnotationConfig, + EventAnnotationGroupConfig, +} from '@kbn/event-annotation-common'; import { GroupEditorControls, isGroupValid } from './group_editor_controls'; export const GroupEditorFlyout = ({ @@ -78,7 +81,7 @@ export const GroupEditorFlyout = ({

    @@ -108,14 +111,17 @@ export const GroupEditorFlyout = ({ data-test-subj="backToGroupSettings" onClick={() => setSelectedAnnotation(undefined)} > - + ) : ( <> - + @@ -132,7 +138,7 @@ export const GroupEditorFlyout = ({ }} > diff --git a/src/plugins/event_annotation/public/components/index.ts b/packages/kbn-event-annotation-components/components/index.ts similarity index 89% rename from src/plugins/event_annotation/public/components/index.ts rename to packages/kbn-event-annotation-components/components/index.ts index 5433625c6344b..d2a46bce9ef8c 100644 --- a/src/plugins/event_annotation/public/components/index.ts +++ b/packages/kbn-event-annotation-components/components/index.ts @@ -6,8 +6,11 @@ * Side Public License, v 1. */ +// TODO - is this file needed? export { AnnotationEditorControls, annotationsIconSet } from './annotation_editor_controls'; export * from './group_editor_controls'; export * from './get_annotation_accessor'; + +export * from './table_list'; diff --git a/src/plugins/event_annotation/public/components/table_list.test.tsx b/packages/kbn-event-annotation-components/components/table_list.test.tsx similarity index 97% rename from src/plugins/event_annotation/public/components/table_list.test.tsx rename to packages/kbn-event-annotation-components/components/table_list.test.tsx index 66f3a7eedb397..d8e124e37ef6e 100644 --- a/src/plugins/event_annotation/public/components/table_list.test.tsx +++ b/packages/kbn-event-annotation-components/components/table_list.test.tsx @@ -16,16 +16,19 @@ import { TableListViewTable, type UserContentCommonSchema, } from '@kbn/content-management-table-list-view-table'; -import { EventAnnotationServiceType } from '../event_annotation_service/types'; +import type { EventAnnotationServiceType } from '../types'; import { IUiSettingsClient } from '@kbn/core-ui-settings-browser'; import { shallow, ShallowWrapper } from 'enzyme'; -import { EventAnnotationGroupConfig, EVENT_ANNOTATION_GROUP_TYPE } from '../../common'; +import { + EventAnnotationGroupConfig, + EVENT_ANNOTATION_GROUP_TYPE, +} from '@kbn/event-annotation-common'; import { taggingApiMock } from '@kbn/saved-objects-tagging-oss-plugin/public/mocks'; import { act } from 'react-dom/test-utils'; import { GroupEditorFlyout } from './group_editor_flyout'; import { DataView } from '@kbn/data-views-plugin/common'; -import { QueryInputServices } from '@kbn/visualization-ui-components/public'; +import { QueryInputServices } from '@kbn/visualization-ui-components'; import { toastsServiceMock } from '@kbn/core-notifications-browser-mocks/src/toasts_service.mock'; import { IToasts } from '@kbn/core-notifications-browser'; diff --git a/src/plugins/event_annotation/public/components/table_list.tsx b/packages/kbn-event-annotation-components/components/table_list.tsx similarity index 86% rename from src/plugins/event_annotation/public/components/table_list.tsx rename to packages/kbn-event-annotation-components/components/table_list.tsx index afc94b11e8fc6..0085678cbd786 100644 --- a/src/plugins/event_annotation/public/components/table_list.tsx +++ b/packages/kbn-event-annotation-components/components/table_list.tsx @@ -11,16 +11,18 @@ import { TableListViewTable } from '@kbn/content-management-table-list-view-tabl import type { TableListTabParentProps } from '@kbn/content-management-tabbed-table-list-view'; import { i18n } from '@kbn/i18n'; import type { IUiSettingsClient } from '@kbn/core-ui-settings-browser'; -import { SavedObjectsFindOptionsReference } from '@kbn/core-saved-objects-api-browser'; -import { SavedObjectsTaggingApi } from '@kbn/saved-objects-tagging-oss-plugin/public'; +import type { SavedObjectsFindOptionsReference } from '@kbn/core-saved-objects-api-browser'; +import type { SavedObjectsTaggingApi } from '@kbn/saved-objects-tagging-oss-plugin/public'; import { DataView, DataViewSpec } from '@kbn/data-views-plugin/common'; -import type { QueryInputServices } from '@kbn/visualization-ui-components/public'; +import type { QueryInputServices } from '@kbn/visualization-ui-components'; import { IToasts } from '@kbn/core-notifications-browser'; import { EuiButton, EuiEmptyPrompt, EuiTitle } from '@elastic/eui'; import { FormattedMessage } from '@kbn/i18n-react'; -import { EventAnnotationGroupConfig } from '../../common'; -import type { EventAnnotationServiceType } from '../event_annotation_service/types'; -import { EventAnnotationGroupContent } from '../../common/types'; +import type { + EventAnnotationGroupConfig, + EventAnnotationGroupContent, +} from '@kbn/event-annotation-common'; +import type { EventAnnotationServiceType } from '../types'; import { GroupEditorFlyout } from './group_editor_flyout'; export const SAVED_OBJECTS_LIMIT_SETTING = 'savedObjects:listingLimit'; @@ -33,7 +35,7 @@ const getCustomColumn = (dataViews: DataView[]) => { return { field: 'dataView', - name: i18n.translate('eventAnnotation.tableList.dataView', { + name: i18n.translate('eventAnnotationComponents.tableList.dataView', { defaultMessage: 'Data view', }), sortable: false, @@ -77,8 +79,8 @@ export const EventAnnotationGroupTableList = ({ const [refreshListBouncer, setRefreshListBouncer] = useState(false); const refreshList = useCallback(() => { - setRefreshListBouncer(!refreshListBouncer); - }, [refreshListBouncer]); + setRefreshListBouncer((prev) => !prev); + }, []); const fetchItems = useCallback( ( @@ -144,7 +146,7 @@ export const EventAnnotationGroupTableList = ({ <> refreshListBouncer={refreshListBouncer} - tableCaption={i18n.translate('eventAnnotation.tableList.listTitle', { + tableCaption={i18n.translate('eventAnnotationComponents.tableList.listTitle', { defaultMessage: 'Annotation Library', })} findItems={fetchItems} @@ -164,7 +166,7 @@ export const EventAnnotationGroupTableList = ({

    @@ -173,7 +175,7 @@ export const EventAnnotationGroupTableList = ({ body={

    @@ -182,7 +184,7 @@ export const EventAnnotationGroupTableList = ({ actions={ @@ -190,10 +192,10 @@ export const EventAnnotationGroupTableList = ({ iconType="flag" /> } - entityName={i18n.translate('eventAnnotation.tableList.entityName', { + entityName={i18n.translate('eventAnnotationComponents.tableList.entityName', { defaultMessage: 'annotation group', })} - entityNamePlural={i18n.translate('eventAnnotation.tableList.entityNamePlural', { + entityNamePlural={i18n.translate('eventAnnotationComponents.tableList.entityNamePlural', { defaultMessage: 'annotation groups', })} onClickTitle={editItem} diff --git a/src/plugins/embeddable/public/lib/panel/panel_header/index.ts b/packages/kbn-event-annotation-components/constants.ts similarity index 85% rename from src/plugins/embeddable/public/lib/panel/panel_header/index.ts rename to packages/kbn-event-annotation-components/constants.ts index fd06a4e4ad5d6..7e057b92c5b4c 100644 --- a/src/plugins/embeddable/public/lib/panel/panel_header/index.ts +++ b/packages/kbn-event-annotation-components/constants.ts @@ -6,4 +6,4 @@ * Side Public License, v 1. */ -export * from './panel_actions'; +export const EVENT_ANNOTATION_APP_NAME = 'event-annotations'; diff --git a/packages/kbn-event-annotation-components/index.ts b/packages/kbn-event-annotation-components/index.ts new file mode 100644 index 0000000000000..5364609ab7e1e --- /dev/null +++ b/packages/kbn-event-annotation-components/index.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 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 { + AnnotationEditorControls, + annotationsIconSet, +} from './components/annotation_editor_controls'; +export { EventAnnotationGroupTableList, getAnnotationAccessor } from './components'; +export { + defaultAnnotationColor, + defaultAnnotationRangeColor, + defaultAnnotationLabel, + createCopiedAnnotation, + isRangeAnnotationConfig, + isManualPointAnnotationConfig, + isQueryAnnotationConfig, +} from '@kbn/event-annotation-common'; +export { EVENT_ANNOTATION_APP_NAME } from './constants'; +export type { EventAnnotationServiceType } from './types'; diff --git a/packages/kbn-event-annotation-components/jest.config.js b/packages/kbn-event-annotation-components/jest.config.js new file mode 100644 index 0000000000000..542264f8faaa4 --- /dev/null +++ b/packages/kbn-event-annotation-components/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test', + rootDir: '../..', + roots: ['/packages/kbn-event-annotation-components'], +}; diff --git a/packages/kbn-event-annotation-components/kibana.jsonc b/packages/kbn-event-annotation-components/kibana.jsonc new file mode 100644 index 0000000000000..af30ffe6d3277 --- /dev/null +++ b/packages/kbn-event-annotation-components/kibana.jsonc @@ -0,0 +1,5 @@ +{ + "type": "shared-browser", + "id": "@kbn/event-annotation-components", + "owner": "@elastic/kibana-visualizations" +} diff --git a/packages/kbn-event-annotation-components/package.json b/packages/kbn-event-annotation-components/package.json new file mode 100644 index 0000000000000..763ddeaaaf949 --- /dev/null +++ b/packages/kbn-event-annotation-components/package.json @@ -0,0 +1,9 @@ +{ + "name": "@kbn/event-annotation-components", + "private": true, + "version": "1.0.0", + "license": "SSPL-1.0 OR Elastic License 2.0", + "sideEffects": [ + "*.scss" + ] +} diff --git a/packages/kbn-event-annotation-components/tsconfig.json b/packages/kbn-event-annotation-components/tsconfig.json new file mode 100644 index 0000000000000..09fa401ec12c7 --- /dev/null +++ b/packages/kbn-event-annotation-components/tsconfig.json @@ -0,0 +1,41 @@ +{ + "extends": "../../tsconfig.base.json", + "compilerOptions": { + "outDir": "target/types", + "types": [ + "jest", + "node", + "@emotion/react/types/css-prop", + ] + }, + "include": [ + "**/*", + ], + "exclude": [ + "target/**/*" + ], + "kbn_references": [ + "@kbn/i18n", + "@kbn/visualization-ui-components", + "@kbn/ui-theme", + "@kbn/chart-icons", + "@kbn/unified-field-list", + "@kbn/data-views-plugin", + "@kbn/data-plugin", + "@kbn/test-jest-helpers", + "@kbn/saved-objects-tagging-oss-plugin", + "@kbn/core-ui-settings-browser", + "@kbn/dom-drag-drop", + "@kbn/content-management-table-list-view-table", + "@kbn/content-management-tabbed-table-list-view", + "@kbn/event-annotation-common", + "@kbn/core", + "@kbn/i18n-react", + "@kbn/saved-objects-finder-plugin", + "@kbn/saved-objects-management-plugin", + "@kbn/core-notifications-browser-mocks", + "@kbn/core-notifications-browser", + "@kbn/core-saved-objects-api-browser", + "@kbn/expressions-plugin", + ] +} diff --git a/src/plugins/event_annotation/public/event_annotation_service/types.ts b/packages/kbn-event-annotation-components/types.ts similarity index 87% rename from src/plugins/event_annotation/public/event_annotation_service/types.ts rename to packages/kbn-event-annotation-components/types.ts index 35b4ae910ad7b..495e204c1f4aa 100644 --- a/src/plugins/event_annotation/public/event_annotation_service/types.ts +++ b/packages/kbn-event-annotation-components/types.ts @@ -6,10 +6,13 @@ * Side Public License, v 1. */ -import { ExpressionAstExpression } from '@kbn/expressions-plugin/common/ast'; -import type { SavedObjectCommon } from '@kbn/saved-objects-finder-plugin/common'; -import { EventAnnotationGroupContent } from '../../common/types'; -import { EventAnnotationConfig, EventAnnotationGroupConfig } from '../../common'; +import { ExpressionAstExpression } from '@kbn/expressions-plugin/common'; +import { SavedObjectCommon } from '@kbn/saved-objects-finder-plugin/common'; +import type { + EventAnnotationConfig, + EventAnnotationGroupConfig, + EventAnnotationGroupContent, +} from '@kbn/event-annotation-common'; export interface EventAnnotationServiceType { loadAnnotationGroup: (savedObjectId: string) => Promise; diff --git a/packages/kbn-generate-console-definitions/src/generate_availability.test.ts b/packages/kbn-generate-console-definitions/src/generate_availability.test.ts new file mode 100644 index 0000000000000..e70f29b1025b3 --- /dev/null +++ b/packages/kbn-generate-console-definitions/src/generate_availability.test.ts @@ -0,0 +1,169 @@ +/* + * 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 { SpecificationTypes } from './types'; +import { generateAvailability } from './generate_availability'; + +describe('generateAvailability', () => { + const mockEndpoint: SpecificationTypes.Endpoint = { + name: 'test-endpoint', + description: 'test-endpoint', + docUrl: 'test-endpoint', + availability: {}, + request: null, + requestBodyRequired: false, + response: null, + urls: [], + }; + + it('converts empty availability to true', () => { + const endpoint = mockEndpoint; + + const availability = generateAvailability(endpoint); + expect(availability).toEqual({ + stack: true, + serverless: true, + }); + }); + + describe('converts correctly stack visibility', function () { + it('public visibility to true', () => { + const endpoint = { + ...mockEndpoint, + availability: { + stack: { + visibility: SpecificationTypes.Visibility.public, + }, + }, + }; + + const availability = generateAvailability(endpoint); + expect(availability).toEqual({ + stack: true, + serverless: true, + }); + }); + + it('private visibility to false', () => { + const endpoint = { + ...mockEndpoint, + availability: { + stack: { + visibility: SpecificationTypes.Visibility.private, + }, + }, + }; + + const availability = generateAvailability(endpoint); + expect(availability).toEqual({ + stack: false, + serverless: true, + }); + }); + + it('feature_flag visibility to false', () => { + const endpoint = { + ...mockEndpoint, + availability: { + stack: { + visibility: SpecificationTypes.Visibility.feature_flag, + }, + }, + }; + + const availability = generateAvailability(endpoint); + expect(availability).toEqual({ + stack: false, + serverless: true, + }); + }); + + it('missing visibility to true', () => { + const endpoint = { + ...mockEndpoint, + availability: { + stack: {}, + }, + }; + + const availability = generateAvailability(endpoint); + expect(availability).toEqual({ + stack: true, + serverless: true, + }); + }); + }); + + describe('converts correctly serverless visibility', function () { + it('public visibility to true', () => { + const endpoint = { + ...mockEndpoint, + availability: { + serverless: { + visibility: SpecificationTypes.Visibility.public, + }, + }, + }; + + const availability = generateAvailability(endpoint); + expect(availability).toEqual({ + stack: true, + serverless: true, + }); + }); + + it('private visibility to false', () => { + const endpoint = { + ...mockEndpoint, + availability: { + serverless: { + visibility: SpecificationTypes.Visibility.private, + }, + }, + }; + + const availability = generateAvailability(endpoint); + expect(availability).toEqual({ + stack: true, + serverless: false, + }); + }); + + it('feature_flag visibility to false', () => { + const endpoint = { + ...mockEndpoint, + availability: { + serverless: { + visibility: SpecificationTypes.Visibility.feature_flag, + }, + }, + }; + + const availability = generateAvailability(endpoint); + expect(availability).toEqual({ + stack: true, + serverless: false, + }); + }); + + it('missing visibility to true', () => { + const endpoint = { + ...mockEndpoint, + availability: { + serverless: {}, + }, + }; + + const availability = generateAvailability(endpoint); + expect(availability).toEqual({ + stack: true, + serverless: true, + }); + }); + }); +}); diff --git a/packages/kbn-generate-console-definitions/src/generate_availability.ts b/packages/kbn-generate-console-definitions/src/generate_availability.ts new file mode 100644 index 0000000000000..fe995e270a079 --- /dev/null +++ b/packages/kbn-generate-console-definitions/src/generate_availability.ts @@ -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 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 { AutocompleteAvailability } from './types'; +import type { SpecificationTypes } from './types'; + +const DEFAULT_ENDPOINT_AVAILABILITY = true; + +export const generateAvailability = ( + endpoint: SpecificationTypes.Endpoint +): AutocompleteAvailability => { + const availability: AutocompleteAvailability = { + stack: DEFAULT_ENDPOINT_AVAILABILITY, + serverless: DEFAULT_ENDPOINT_AVAILABILITY, + }; + if (endpoint.availability.stack?.visibility) { + availability.stack = endpoint.availability.stack?.visibility === 'public'; + } + if (endpoint.availability.serverless?.visibility) { + availability.serverless = endpoint.availability.serverless?.visibility === 'public'; + } + return availability; +}; diff --git a/packages/kbn-generate-console-definitions/src/generate_console_definitions.ts b/packages/kbn-generate-console-definitions/src/generate_console_definitions.ts index 1d4918f44c6b1..42afed13eed22 100644 --- a/packages/kbn-generate-console-definitions/src/generate_console_definitions.ts +++ b/packages/kbn-generate-console-definitions/src/generate_console_definitions.ts @@ -10,6 +10,7 @@ import fs from 'fs'; import Path, { join } from 'path'; import { ToolingLog } from '@kbn/tooling-log'; import { generateQueryParams } from './generate_query_params'; +import { generateAvailability } from './generate_availability'; import type { AutocompleteBodyParams, AutocompleteDefinition, @@ -86,12 +87,13 @@ const generateDefinition = ( const methods = generateMethods(endpoint); const patterns = generatePatterns(endpoint); const documentation = generateDocumentation(endpoint); + const availability = generateAvailability(endpoint); let definition: AutocompleteDefinition = {}; const params = generateParams(endpoint, schema); if (params) { definition = addParams(definition, params); } - definition = { ...definition, methods, patterns, documentation }; + definition = { ...definition, methods, patterns, documentation, availability }; return definition; }; diff --git a/packages/kbn-generate-console-definitions/src/types/autocomplete_definition_types.ts b/packages/kbn-generate-console-definitions/src/types/autocomplete_definition_types.ts index edbb9bd74d9a8..67bcbc5d131a2 100644 --- a/packages/kbn-generate-console-definitions/src/types/autocomplete_definition_types.ts +++ b/packages/kbn-generate-console-definitions/src/types/autocomplete_definition_types.ts @@ -14,10 +14,16 @@ export interface AutocompleteBodyParams { [key: string]: number | string; } +export interface AutocompleteAvailability { + stack: boolean; + serverless: boolean; +} + export interface AutocompleteDefinition { documentation?: string; methods?: string[]; patterns?: string[]; url_params?: AutocompleteUrlParams; data_autocomplete_rules?: AutocompleteBodyParams; + availability?: AutocompleteAvailability; } diff --git a/packages/kbn-generate-console-definitions/src/types/index.ts b/packages/kbn-generate-console-definitions/src/types/index.ts index a182592350681..ab2b036d39cf0 100644 --- a/packages/kbn-generate-console-definitions/src/types/index.ts +++ b/packages/kbn-generate-console-definitions/src/types/index.ts @@ -10,6 +10,7 @@ export type { AutocompleteDefinition, AutocompleteUrlParams, AutocompleteBodyParams, + AutocompleteAvailability, } from './autocomplete_definition_types'; export * as SpecificationTypes from './specification_types'; diff --git a/packages/kbn-io-ts-utils/src/strict_keys_rt/index.test.ts b/packages/kbn-io-ts-utils/src/strict_keys_rt/index.test.ts index 77a20a014093b..6bca714e81a8a 100644 --- a/packages/kbn-io-ts-utils/src/strict_keys_rt/index.test.ts +++ b/packages/kbn-io-ts-utils/src/strict_keys_rt/index.test.ts @@ -202,6 +202,11 @@ describe('strictKeysRt', () => { { body: { duration: false } }, ], }, + { + type: t.array(t.type({ foo: t.string })), + passes: [[{ foo: 'bar' }], [{ foo: 'baz' }, { foo: 'bar' }]], + fails: [], + }, ]; checks.forEach((check) => { diff --git a/packages/kbn-io-ts-utils/src/strict_keys_rt/index.ts b/packages/kbn-io-ts-utils/src/strict_keys_rt/index.ts index f0bd5bb056c00..8af4d690db0fd 100644 --- a/packages/kbn-io-ts-utils/src/strict_keys_rt/index.ts +++ b/packages/kbn-io-ts-utils/src/strict_keys_rt/index.ts @@ -23,7 +23,8 @@ type ParsableType = | t.ExactType | t.InterfaceType | MergeType - | t.DictionaryType; + | t.DictionaryType + | t.ArrayType; const tags = [ 'DictionaryType', @@ -33,6 +34,7 @@ const tags = [ 'PartialType', 'ExactType', 'UnionType', + 'ArrayType', ]; function isParsableType(type: t.Mixed): type is ParsableType { @@ -45,6 +47,9 @@ function getHandlingTypes(type: t.Mixed, key: string, value: object): t.Mixed[] } switch (type._tag) { + case 'ArrayType': + return [type.type]; + case 'DictionaryType': return [type.codomain]; diff --git a/packages/kbn-optimizer/limits.yml b/packages/kbn-optimizer/limits.yml index ac968b0d84dcc..aa52cb20178f1 100644 --- a/packages/kbn-optimizer/limits.yml +++ b/packages/kbn-optimizer/limits.yml @@ -161,5 +161,4 @@ pageLoadAssetSize: visTypeVislib: 242838 visTypeXy: 46868 visualizations: 90000 - visualizationUiComponents: 76424 watcher: 43598 diff --git a/packages/kbn-securitysolution-exception-list-components/src/exception_item_card/comments/__snapshots__/comments.test.tsx.snap b/packages/kbn-securitysolution-exception-list-components/src/exception_item_card/comments/__snapshots__/comments.test.tsx.snap index 92aa17170f1fa..f194c0af3908a 100644 --- a/packages/kbn-securitysolution-exception-list-components/src/exception_item_card/comments/__snapshots__/comments.test.tsx.snap +++ b/packages/kbn-securitysolution-exception-list-components/src/exception_item_card/comments/__snapshots__/comments.test.tsx.snap @@ -105,7 +105,7 @@ Object { >

    +

    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 079f0f39144c7..27612db490f4b 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,5 +1,5 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP -exports[`UnauthenticatedPage renders as expected 1`] = `"ElasticMockedFonts

    We hit an authentication error

    Try logging in again, and if the problem persists, contact your system administrator.

    "`; +exports[`UnauthenticatedPage renders as expected 1`] = `"ElasticMockedFonts
    "`; -exports[`UnauthenticatedPage renders as expected with custom title 1`] = `"My Company NameMockedFonts"`; +exports[`UnauthenticatedPage renders as expected with custom title 1`] = `"My Company NameMockedFonts"`; 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 b85edba9b79a7..a6b592367d47b 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,5 +1,5 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP -exports[`ResetSessionPage renders as expected 1`] = `"ElasticMockedFonts"`; +exports[`ResetSessionPage renders as expected 1`] = `"ElasticMockedFonts"`; -exports[`ResetSessionPage renders as expected with custom page title 1`] = `"My Company NameMockedFonts"`; +exports[`ResetSessionPage renders as expected with custom page title 1`] = `"My Company NameMockedFonts"`; diff --git a/x-pack/plugins/security/server/session_management/session_management_service.test.ts b/x-pack/plugins/security/server/session_management/session_management_service.test.ts index 267f99b3761c4..69a1508588220 100644 --- a/x-pack/plugins/security/server/session_management/session_management_service.test.ts +++ b/x-pack/plugins/security/server/session_management/session_management_service.test.ts @@ -41,8 +41,8 @@ describe('SessionManagementService', () => { }); afterEach(() => { - mockSessionIndexInitialize.mockReset(); - mockSessionIndexCleanUp.mockReset(); + mockSessionIndexInitialize.mockClear(); + mockSessionIndexCleanUp.mockClear(); }); describe('setup()', () => { diff --git a/x-pack/plugins/security_solution/README.md b/x-pack/plugins/security_solution/README.md index 4d57947bd67ac..1bca44e88e721 100644 --- a/x-pack/plugins/security_solution/README.md +++ b/x-pack/plugins/security_solution/README.md @@ -128,3 +128,17 @@ In another terminal, run: ```bash yarn test:ftr:runner --config x-pack/test/security_solution_endpoint/config.ts ``` + +#### Generate huge amount of indices with huge amount of fields + +The result of this operation will be 10 separate bucket folders within `mappings_folder`. Each bucket folder will contain a `mappings.json` file describing 50 indices. + +```bash +yarn mappings:generate --fieldsCount=10000 --indexCount=500 --indexPrefix='.ds-huge' --unmappedRate=.2 --buckets=10 --outputDirectory='mappings_folder' +``` + +#### Load generated mappings + +```bash +yarn mappings:load --mappings-dir='mappings_folder' --es-url=http://username:password@localhost:9200 --kibana-url=http://username:password@localhost:5601/app +``` diff --git a/x-pack/plugins/security_solution/common/api/detection_engine/alert_tags/index.ts b/x-pack/plugins/security_solution/common/api/detection_engine/alert_tags/index.ts new file mode 100644 index 0000000000000..7adc565a09c8e --- /dev/null +++ b/x-pack/plugins/security_solution/common/api/detection_engine/alert_tags/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 * from './set_alert_tags/set_alert_tags_route'; diff --git a/x-pack/plugins/security_solution/common/api/detection_engine/alert_tags/mocks.ts b/x-pack/plugins/security_solution/common/api/detection_engine/alert_tags/mocks.ts new file mode 100644 index 0000000000000..985a74f34e669 --- /dev/null +++ b/x-pack/plugins/security_solution/common/api/detection_engine/alert_tags/mocks.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 * from './set_alert_tags/set_alert_tags_route.mock'; diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/request/set_alert_tags_schema.mock.ts b/x-pack/plugins/security_solution/common/api/detection_engine/alert_tags/set_alert_tags/set_alert_tags_route.mock.ts similarity index 67% rename from x-pack/plugins/security_solution/common/detection_engine/schemas/request/set_alert_tags_schema.mock.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/alert_tags/set_alert_tags/set_alert_tags_route.mock.ts index 4f3bf93550223..f1e05ad7f125a 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/schemas/request/set_alert_tags_schema.mock.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/alert_tags/set_alert_tags/set_alert_tags_route.mock.ts @@ -5,10 +5,13 @@ * 2.0. */ -import type { SetAlertTagsSchema } from './set_alert_tags_schema'; +import type { SetAlertTagsRequestBody } from './set_alert_tags_route'; export const getSetAlertTagsRequestMock = ( tagsToAdd: string[] = [], tagsToRemove: string[] = [], ids: string[] = [] -): SetAlertTagsSchema => ({ tags: { tags_to_add: tagsToAdd, tags_to_remove: tagsToRemove }, ids }); +): SetAlertTagsRequestBody => ({ + tags: { tags_to_add: tagsToAdd, tags_to_remove: tagsToRemove }, + ids, +}); diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/request/set_alert_tags_schema.ts b/x-pack/plugins/security_solution/common/api/detection_engine/alert_tags/set_alert_tags/set_alert_tags_route.ts similarity index 57% rename from x-pack/plugins/security_solution/common/detection_engine/schemas/request/set_alert_tags_schema.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/alert_tags/set_alert_tags/set_alert_tags_route.ts index cb11c8c70c8ab..8a6f93c20b770 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/schemas/request/set_alert_tags_schema.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/alert_tags/set_alert_tags/set_alert_tags_route.ts @@ -7,14 +7,14 @@ import * as t from 'io-ts'; -import { alert_tag_ids, alert_tags } from '../common/schemas'; +import { alert_tag_ids, alert_tags } from '../../model'; -export const setAlertTagsSchema = t.exact( +export const setAlertTagsRequestBody = t.exact( t.type({ tags: alert_tags, ids: alert_tag_ids, }) ); -export type SetAlertTagsSchema = t.TypeOf; -export type SetAlertTagsSchemaDecoded = SetAlertTagsSchema; +export type SetAlertTagsRequestBody = t.TypeOf; +export type SetAlertTagsRequestBodyDecoded = SetAlertTagsRequestBody; diff --git a/x-pack/plugins/security_solution/common/detection_engine/fleet_integrations/api/get_installed_integrations/response_schema.ts b/x-pack/plugins/security_solution/common/api/detection_engine/fleet_integrations/get_installed_integrations/get_installed_integrations_route.ts similarity index 80% rename from x-pack/plugins/security_solution/common/detection_engine/fleet_integrations/api/get_installed_integrations/response_schema.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/fleet_integrations/get_installed_integrations/get_installed_integrations_route.ts index d970fb7061a44..4f3c4e6f942da 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/fleet_integrations/api/get_installed_integrations/response_schema.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/fleet_integrations/get_installed_integrations/get_installed_integrations_route.ts @@ -5,7 +5,7 @@ * 2.0. */ -import type { InstalledIntegrationArray } from '../../model/installed_integrations'; +import type { InstalledIntegrationArray } from '../model/installed_integrations'; export interface GetInstalledIntegrationsResponse { installed_integrations: InstalledIntegrationArray; diff --git a/x-pack/plugins/security_solution/common/detection_engine/fleet_integrations/index.ts b/x-pack/plugins/security_solution/common/api/detection_engine/fleet_integrations/index.ts similarity index 74% rename from x-pack/plugins/security_solution/common/detection_engine/fleet_integrations/index.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/fleet_integrations/index.ts index e79ebecbdb1cd..63a824a430c6e 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/fleet_integrations/index.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/fleet_integrations/index.ts @@ -5,7 +5,7 @@ * 2.0. */ -export * from './api/get_installed_integrations/response_schema'; -export * from './api/urls'; +export * from './get_installed_integrations/get_installed_integrations_route'; +export * from './urls'; export * from './model/installed_integrations'; diff --git a/x-pack/plugins/security_solution/common/detection_engine/fleet_integrations/model/installed_integrations.ts b/x-pack/plugins/security_solution/common/api/detection_engine/fleet_integrations/model/installed_integrations.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/fleet_integrations/model/installed_integrations.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/fleet_integrations/model/installed_integrations.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/fleet_integrations/api/urls.ts b/x-pack/plugins/security_solution/common/api/detection_engine/fleet_integrations/urls.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/fleet_integrations/api/urls.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/fleet_integrations/urls.ts diff --git a/x-pack/plugins/security_solution/common/api/detection_engine/index.ts b/x-pack/plugins/security_solution/common/api/detection_engine/index.ts new file mode 100644 index 0000000000000..093cc2d43bc33 --- /dev/null +++ b/x-pack/plugins/security_solution/common/api/detection_engine/index.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. + */ + +export * from './alert_tags'; +export * from './fleet_integrations'; +export * from './model'; +export * from './prebuilt_rules'; +export * from './rule_exceptions'; +export * from './rule_management'; +export * from './rule_monitoring'; +export * from './signals'; +export * from './signals_migration'; diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/alerts/8.0.0/index.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/alerts/8.0.0/index.ts similarity index 97% rename from x-pack/plugins/security_solution/common/detection_engine/schemas/alerts/8.0.0/index.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/model/alerts/8.0.0/index.ts index b347ffbd67ea5..3dd5d8362a497 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/schemas/alerts/8.0.0/index.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/model/alerts/8.0.0/index.ts @@ -68,9 +68,9 @@ import type { ALERT_RULE_TIMELINE_ID, ALERT_RULE_TIMELINE_TITLE, ALERT_RULE_TIMESTAMP_OVERRIDE, -} from '../../../../field_maps/field_names'; +} from '../../../../../field_maps/field_names'; // TODO: Create and import 8.0.0 versioned RuleAlertAction type -import type { RuleAlertAction, SearchTypes } from '../../../types'; +import type { RuleAlertAction, SearchTypes } from '../../../../../detection_engine/types'; /* DO NOT MODIFY THIS SCHEMA TO ADD NEW FIELDS. These types represent the alerts that shipped in 8.0.0. Any changes to these types should be bug fixes so the types more accurately represent the alerts from 8.0.0. diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/alerts/8.4.0/index.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/alerts/8.4.0/index.ts similarity index 98% rename from x-pack/plugins/security_solution/common/detection_engine/schemas/alerts/8.4.0/index.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/model/alerts/8.4.0/index.ts index 703e324a4fb24..b7136cf1213eb 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/schemas/alerts/8.4.0/index.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/model/alerts/8.4.0/index.ts @@ -12,7 +12,7 @@ import type { ALERT_GROUP_INDEX, ALERT_NEW_TERMS, ALERT_RULE_INDICES, -} from '../../../../field_maps/field_names'; +} from '../../../../../field_maps/field_names'; import type { Ancestor800, BaseFields800, diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/alerts/8.6.0/index.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/alerts/8.6.0/index.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/schemas/alerts/8.6.0/index.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/model/alerts/8.6.0/index.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/alerts/8.7.0/index.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/alerts/8.7.0/index.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/schemas/alerts/8.7.0/index.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/model/alerts/8.7.0/index.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/alerts/8.8.0/index.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/alerts/8.8.0/index.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/schemas/alerts/8.8.0/index.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/model/alerts/8.8.0/index.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/alerts/8.9.0/index.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/alerts/8.9.0/index.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/schemas/alerts/8.9.0/index.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/model/alerts/8.9.0/index.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/alerts/README.md b/x-pack/plugins/security_solution/common/api/detection_engine/model/alerts/README.md similarity index 89% rename from x-pack/plugins/security_solution/common/detection_engine/schemas/alerts/README.md rename to x-pack/plugins/security_solution/common/api/detection_engine/model/alerts/README.md index c7acf84813f08..481fb04e5d3f7 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/schemas/alerts/README.md +++ b/x-pack/plugins/security_solution/common/api/detection_engine/model/alerts/README.md @@ -20,7 +20,7 @@ Static types are a powerful tool for ensuring code correctness. However, each de The schemas in this directory have 2 primary purposes: (1) separate the alert document schemas from the FieldMaps, and (2) set up a code structure that enables easy versioning of alert schemas. During the Detection Engine migration to the rule registry we used the FieldMaps to define the alert schema, but ended up with numerous type casts and some bugs in the process. This common directory stores the various alert schemas by Kibana version. -x-pack/plugins/security_solution/common/detection_engine/schemas/alerts initially contains index.ts and one folder, 8.0.0. index.ts imports the schemas from 8.0.0 and re-exports them as ...Latest, denoting that those are the "write" schemas. The reason for this is that as we add new schemas, there are many places server side where we want to ensure that we're writing the latest alert schema. By having index.ts re-export 8.0.0 schemas, when we add make a new alert schema in the future (e.g. adding an additional field in 8.x) we can simply update index.ts to re-export the new schema instead of the previous schema. index.ts also exports a DetectionAlert which is the "read" schema - this type will be maintained as a union of all versioned alert schemas, which is needed to accurately type alerts that are read from the alerts index. +x-pack/plugins/security_solution/common/api/detection_engine/model/alerts initially contains index.ts and one folder, 8.0.0. index.ts imports the schemas from 8.0.0 and re-exports them as ...Latest, denoting that those are the "write" schemas. The reason for this is that as we add new schemas, there are many places server side where we want to ensure that we're writing the latest alert schema. By having index.ts re-export 8.0.0 schemas, when we add make a new alert schema in the future (e.g. adding an additional field in 8.x) we can simply update index.ts to re-export the new schema instead of the previous schema. index.ts also exports a DetectionAlert which is the "read" schema - this type will be maintained as a union of all versioned alert schemas, which is needed to accurately type alerts that are read from the alerts index. ## Reading vs writing alerts diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/alerts/index.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/alerts/index.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/schemas/alerts/index.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/model/alerts/index.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/response/error_schema.mocks.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/error_schema.mocks.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/schemas/response/error_schema.mocks.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/model/error_schema.mocks.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/response/error_schema.test.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/error_schema.test.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/schemas/response/error_schema.test.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/model/error_schema.test.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/response/error_schema.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/error_schema.ts similarity index 89% rename from x-pack/plugins/security_solution/common/detection_engine/schemas/response/error_schema.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/model/error_schema.ts index 2c1cf288afe03..e6f2fecbf7e16 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/schemas/response/error_schema.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/model/error_schema.ts @@ -8,8 +8,8 @@ import { NonEmptyString } from '@kbn/securitysolution-io-ts-types'; import * as t from 'io-ts'; -import { RuleSignatureId } from '../../rule_schema'; -import { status_code, message } from '../common/schemas'; +import { RuleSignatureId } from './rule_schema'; +import { status_code, message } from './schemas'; // We use id: t.string intentionally and _never_ the id from global schemas as // sometimes echo back out the id that the user gave us and it is not guaranteed diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/common/index.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/index.ts similarity index 67% rename from x-pack/plugins/security_solution/common/detection_engine/schemas/common/index.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/model/index.ts index e129a72362ed7..00d17d55817a5 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/schemas/common/index.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/model/index.ts @@ -5,6 +5,11 @@ * 2.0. */ +export * from './alerts'; +export * from './rule_response_actions'; +export * from './rule_schema'; +export * from './error_schema'; export * from './pagination'; export * from './schemas'; export * from './sorting'; +export * from './warning_schema'; diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/common/pagination.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/pagination.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/schemas/common/pagination.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/model/pagination.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_response_actions/schemas/endpoint.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/rule_response_actions/endpoint.ts similarity index 93% rename from x-pack/plugins/security_solution/common/detection_engine/rule_response_actions/schemas/endpoint.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/model/rule_response_actions/endpoint.ts index 27d68c4e816d0..0aa3f97509f80 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_response_actions/schemas/endpoint.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/model/rule_response_actions/endpoint.ts @@ -6,7 +6,7 @@ */ import * as t from 'io-ts'; -import { ENABLED_AUTOMATED_RESPONSE_ACTION_COMMANDS } from '../../../endpoint/service/response_actions/constants'; +import { ENABLED_AUTOMATED_RESPONSE_ACTION_COMMANDS } from '../../../../endpoint/service/response_actions/constants'; // to enable using RESPONSE_ACTION_API_COMMANDS_NAMES as a type function keyObject(arr: T): { [K in T[number]]: null } { diff --git a/x-pack/plugins/security_solution/common/api/detection_engine/model/rule_response_actions/index.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/rule_response_actions/index.ts new file mode 100644 index 0000000000000..6738515699814 --- /dev/null +++ b/x-pack/plugins/security_solution/common/api/detection_engine/model/rule_response_actions/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 * from './response_actions'; +export * from './endpoint'; +export * from './osquery'; diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_response_actions/schemas/osquery.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/rule_response_actions/osquery.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_response_actions/schemas/osquery.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/model/rule_response_actions/osquery.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_response_actions/schemas/response_actions.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/rule_response_actions/response_actions.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_response_actions/schemas/response_actions.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/model/rule_response_actions/response_actions.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/build_rule_schemas.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/build_rule_schemas.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/build_rule_schemas.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/build_rule_schemas.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/common_attributes/field_overrides.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/common_attributes/field_overrides.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/common_attributes/field_overrides.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/common_attributes/field_overrides.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/common_attributes/misc_attributes.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/common_attributes/misc_attributes.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/common_attributes/misc_attributes.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/common_attributes/misc_attributes.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/common_attributes/related_integrations.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/common_attributes/related_integrations.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/common_attributes/related_integrations.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/common_attributes/related_integrations.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/common_attributes/required_fields.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/common_attributes/required_fields.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/common_attributes/required_fields.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/common_attributes/required_fields.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/common_attributes/saved_objects.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/common_attributes/saved_objects.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/common_attributes/saved_objects.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/common_attributes/saved_objects.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/common_attributes/timeline_template.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/common_attributes/timeline_template.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/common_attributes/timeline_template.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/common_attributes/timeline_template.ts diff --git a/x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/index.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/index.ts new file mode 100644 index 0000000000000..0c207b17a548b --- /dev/null +++ b/x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/index.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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +export * from './common_attributes/field_overrides'; +export * from './common_attributes/misc_attributes'; +export * from './common_attributes/related_integrations'; +export * from './common_attributes/required_fields'; +export * from './common_attributes/saved_objects'; +export * from './common_attributes/timeline_template'; + +export * from './specific_attributes/eql_attributes'; +export * from './specific_attributes/new_terms_attributes'; +export * from './specific_attributes/query_attributes'; +export * from './specific_attributes/threshold_attributes'; + +export * from './rule_schemas'; +export * from './build_rule_schemas'; diff --git a/x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/mocks.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/mocks.ts new file mode 100644 index 0000000000000..9ae3e0672efc5 --- /dev/null +++ b/x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/mocks.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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +export * from './rule_request_schema.mock'; +export * from './rule_response_schema.mock'; diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/rule_request_schema.mock.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/rule_request_schema.mock.ts similarity index 98% rename from x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/rule_request_schema.mock.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/rule_request_schema.mock.ts index d76450a0e0425..9ff3e50ea5877 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/rule_request_schema.mock.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/rule_request_schema.mock.ts @@ -5,7 +5,7 @@ * 2.0. */ -import { DEFAULT_INDICATOR_SOURCE_PATH } from '../../../constants'; +import { DEFAULT_INDICATOR_SOURCE_PATH } from '../../../../constants'; import type { MachineLearningRuleCreateProps, MachineLearningRuleUpdateProps, diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/rule_request_schema.test.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/rule_request_schema.test.ts similarity index 99% rename from x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/rule_request_schema.test.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/rule_request_schema.test.ts index dab249557cc5a..a49112a98f81d 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/rule_request_schema.test.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/rule_request_schema.test.ts @@ -10,7 +10,7 @@ import { left } from 'fp-ts/lib/Either'; import { pipe } from 'fp-ts/lib/pipeable'; import { exactCheck, foldLeftRight, getPaths } from '@kbn/securitysolution-io-ts-utils'; -import { getListArrayMock } from '../../schemas/types/lists.mock'; +import { getListArrayMock } from '../../../../detection_engine/schemas/types/lists.mock'; import type { SavedQueryRuleCreateProps } from './rule_schemas'; import { RuleCreateProps } from './rule_schemas'; import { diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/rule_response_schema.mock.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/rule_response_schema.mock.ts similarity index 97% rename from x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/rule_response_schema.mock.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/rule_response_schema.mock.ts index 7ccdd03b1355c..521e9918a6521 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/rule_response_schema.mock.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/rule_response_schema.mock.ts @@ -5,7 +5,7 @@ * 2.0. */ -import { DEFAULT_INDICATOR_SOURCE_PATH } from '../../../constants'; +import { DEFAULT_INDICATOR_SOURCE_PATH } from '../../../../constants'; import type { EqlRule, MachineLearningRule, @@ -14,7 +14,7 @@ import type { SharedResponseProps, ThreatMatchRule, } from './rule_schemas'; -import { getListArrayMock } from '../../schemas/types/lists.mock'; +import { getListArrayMock } from '../../../../detection_engine/schemas/types/lists.mock'; export const ANCHOR_DATE = '2020-02-20T03:57:54.037Z'; diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/rule_response_schema.test.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/rule_response_schema.test.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/rule_response_schema.test.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/rule_response_schema.test.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/rule_schemas.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/rule_schemas.ts similarity index 99% rename from x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/rule_schemas.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/rule_schemas.ts index ff4bb72a5eb65..93fd0aa8d0af8 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/rule_schemas.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/rule_schemas.ts @@ -27,8 +27,8 @@ import { threat_query, } from '@kbn/securitysolution-io-ts-alerting-types'; -import { RuleExecutionSummary } from '../../rule_monitoring'; -import { ResponseActionArray } from '../../rule_response_actions/schemas'; +import { RuleExecutionSummary } from '../../rule_monitoring/model'; +import { ResponseActionArray } from '../rule_response_actions'; import { saved_id, anomaly_threshold, @@ -37,7 +37,7 @@ import { created_at, created_by, revision, -} from '../../schemas/common'; +} from '../schemas'; import { AlertsIndex, diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/specific_attributes/eql_attributes.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/specific_attributes/eql_attributes.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/specific_attributes/eql_attributes.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/specific_attributes/eql_attributes.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/specific_attributes/new_terms_attributes.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/specific_attributes/new_terms_attributes.ts similarity index 92% rename from x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/specific_attributes/new_terms_attributes.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/specific_attributes/new_terms_attributes.ts index 6d9f39011b675..fa3e8e5860116 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/specific_attributes/new_terms_attributes.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/specific_attributes/new_terms_attributes.ts @@ -7,7 +7,7 @@ import * as t from 'io-ts'; import { LimitedSizeArray, NonEmptyString } from '@kbn/securitysolution-io-ts-types'; -import { MAX_NUMBER_OF_NEW_TERMS_FIELDS } from '../../../../constants'; +import { MAX_NUMBER_OF_NEW_TERMS_FIELDS } from '../../../../../constants'; // Attributes specific to New Terms rules diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/specific_attributes/query_attributes.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/specific_attributes/query_attributes.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/specific_attributes/query_attributes.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/specific_attributes/query_attributes.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/specific_attributes/threshold_attributes.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/specific_attributes/threshold_attributes.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_schema/model/specific_attributes/threshold_attributes.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/model/rule_schema/specific_attributes/threshold_attributes.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/common/schemas.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/schemas.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/schemas/common/schemas.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/model/schemas.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/common/sorting.test.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/sorting.test.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/schemas/common/sorting.test.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/model/sorting.test.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/common/sorting.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/sorting.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/schemas/common/sorting.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/model/sorting.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/response/warning_schema/index.ts b/x-pack/plugins/security_solution/common/api/detection_engine/model/warning_schema.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/schemas/response/warning_schema/index.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/model/warning_schema.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/api/get_prebuilt_rules_and_timelines_status/response_schema.test.ts b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/get_prebuilt_rules_and_timelines_status/get_prebuilt_rules_and_timelines_status_route.test.ts similarity index 98% rename from x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/api/get_prebuilt_rules_and_timelines_status/response_schema.test.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/get_prebuilt_rules_and_timelines_status/get_prebuilt_rules_and_timelines_status_route.test.ts index e721e6f41cc19..83c09d2dcab26 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/api/get_prebuilt_rules_and_timelines_status/response_schema.test.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/get_prebuilt_rules_and_timelines_status/get_prebuilt_rules_and_timelines_status_route.test.ts @@ -9,7 +9,7 @@ import { left } from 'fp-ts/lib/Either'; import { pipe } from 'fp-ts/lib/pipeable'; import { exactCheck, foldLeftRight, getPaths } from '@kbn/securitysolution-io-ts-utils'; -import { GetPrebuiltRulesAndTimelinesStatusResponse } from './response_schema'; +import { GetPrebuiltRulesAndTimelinesStatusResponse } from './get_prebuilt_rules_and_timelines_status_route'; describe('Get prebuilt rules and timelines status response schema', () => { test('it should validate an empty prepackaged response with defaults', () => { diff --git a/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/api/get_prebuilt_rules_and_timelines_status/response_schema.ts b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/get_prebuilt_rules_and_timelines_status/get_prebuilt_rules_and_timelines_status_route.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/api/get_prebuilt_rules_and_timelines_status/response_schema.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/get_prebuilt_rules_and_timelines_status/get_prebuilt_rules_and_timelines_status_route.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/api/get_prebuilt_rules_status/response_schema.ts b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/get_prebuilt_rules_status/get_prebuilt_rules_status_route.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/api/get_prebuilt_rules_status/response_schema.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/get_prebuilt_rules_status/get_prebuilt_rules_status_route.ts diff --git a/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/index.ts b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/index.ts new file mode 100644 index 0000000000000..38607fbd30513 --- /dev/null +++ b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/index.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. + */ + +export * from './get_prebuilt_rules_and_timelines_status/get_prebuilt_rules_and_timelines_status_route'; +export * from './get_prebuilt_rules_status/get_prebuilt_rules_status_route'; +export * from './install_prebuilt_rules_and_timelines/install_prebuilt_rules_and_timelines_route'; +export * from './perform_rule_installation/perform_rule_installation_route'; +export * from './perform_rule_upgrade/perform_rule_upgrade_route'; +export * from './review_rule_installation/review_rule_installation_route'; +export * from './review_rule_upgrade/review_rule_upgrade_route'; +export * from './urls'; +export * from './model/aggregated_prebuilt_rules_error'; +export * from './model/diff/diffable_rule/build_schema'; +export * from './model/diff/diffable_rule/diffable_field_types'; +export * from './model/diff/diffable_rule/diffable_rule'; +export * from './model/diff/rule_diff/fields_diff'; +export * from './model/diff/rule_diff/rule_diff'; +export * from './model/diff/three_way_diff/three_way_diff_outcome'; +export * from './model/diff/three_way_diff/three_way_diff'; +export * from './model/diff/three_way_diff/three_way_merge_outcome'; diff --git a/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/api/install_prebuilt_rules_and_timelines/response_schema.test.ts b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/install_prebuilt_rules_and_timelines/install_prebuilt_rules_and_timelines_route.test.ts similarity index 97% rename from x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/api/install_prebuilt_rules_and_timelines/response_schema.test.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/install_prebuilt_rules_and_timelines/install_prebuilt_rules_and_timelines_route.test.ts index 6833a5891a2c2..7f049af0d78b8 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/api/install_prebuilt_rules_and_timelines/response_schema.test.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/install_prebuilt_rules_and_timelines/install_prebuilt_rules_and_timelines_route.test.ts @@ -9,7 +9,7 @@ import { left } from 'fp-ts/lib/Either'; import { pipe } from 'fp-ts/lib/pipeable'; import { exactCheck, foldLeftRight, getPaths } from '@kbn/securitysolution-io-ts-utils'; -import { InstallPrebuiltRulesAndTimelinesResponse } from './response_schema'; +import { InstallPrebuiltRulesAndTimelinesResponse } from './install_prebuilt_rules_and_timelines_route'; describe('Install prebuilt rules and timelines response schema', () => { test('it should validate an empty prepackaged response with defaults', () => { diff --git a/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/api/install_prebuilt_rules_and_timelines/response_schema.ts b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/install_prebuilt_rules_and_timelines/install_prebuilt_rules_and_timelines_route.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/api/install_prebuilt_rules_and_timelines/response_schema.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/install_prebuilt_rules_and_timelines/install_prebuilt_rules_and_timelines_route.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/model/prebuilt_rules/aggregated_prebuilt_rules_error.ts b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/model/aggregated_prebuilt_rules_error.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/model/prebuilt_rules/aggregated_prebuilt_rules_error.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/model/aggregated_prebuilt_rules_error.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/model/diff/diffable_rule/build_schema.ts b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/model/diff/diffable_rule/build_schema.ts similarity index 89% rename from x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/model/diff/diffable_rule/build_schema.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/model/diff/diffable_rule/build_schema.ts index b0b60f70d1e63..b57882ffdfc5c 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/model/diff/diffable_rule/build_schema.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/model/diff/diffable_rule/build_schema.ts @@ -6,7 +6,7 @@ */ import * as t from 'io-ts'; -import { orUndefined } from '../../../../rule_schema/model/build_rule_schemas'; +import { orUndefined } from '../../../../model'; interface RuleFields { required: TRequired; diff --git a/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/model/diff/diffable_rule/diffable_field_types.ts b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/model/diff/diffable_rule/diffable_field_types.ts similarity index 97% rename from x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/model/diff/diffable_rule/diffable_field_types.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/model/diff/diffable_rule/diffable_field_types.ts index 3e07566afbf96..e2f0480d092aa 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/model/diff/diffable_rule/diffable_field_types.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/model/diff/diffable_rule/diffable_field_types.ts @@ -19,8 +19,8 @@ import { TimelineTemplateTitle, TimestampOverride as TimestampOverrideFieldName, TimestampOverrideFallbackDisabled, -} from '../../../../rule_schema'; -import { saved_id } from '../../../../schemas/common'; + saved_id, +} from '../../../../model'; // ------------------------------------------------------------------------------------------------- // Rule data source diff --git a/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/model/diff/diffable_rule/diffable_rule.ts b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/model/diff/diffable_rule/diffable_rule.ts similarity index 98% rename from x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/model/diff/diffable_rule/diffable_rule.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/model/diff/diffable_rule/diffable_rule.ts index 8ce2fb9bf7f1a..6dad2ff0cf6df 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/model/diff/diffable_rule/diffable_rule.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/model/diff/diffable_rule/diffable_rule.ts @@ -47,9 +47,8 @@ import { Threshold, TiebreakerField, TimestampField, -} from '../../../../rule_schema'; - -import { anomaly_threshold } from '../../../../schemas/common'; + anomaly_threshold, +} from '../../../../model'; import { BuildingBlockObject, diff --git a/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/model/diff/rule_diff/fields_diff.ts b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/model/diff/rule_diff/fields_diff.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/model/diff/rule_diff/fields_diff.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/model/diff/rule_diff/fields_diff.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/model/diff/rule_diff/rule_diff.ts b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/model/diff/rule_diff/rule_diff.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/model/diff/rule_diff/rule_diff.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/model/diff/rule_diff/rule_diff.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/model/diff/three_way_diff/three_way_diff.ts b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/model/diff/three_way_diff/three_way_diff.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/model/diff/three_way_diff/three_way_diff.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/model/diff/three_way_diff/three_way_diff.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/model/diff/three_way_diff/three_way_diff_outcome.ts b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/model/diff/three_way_diff/three_way_diff_outcome.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/model/diff/three_way_diff/three_way_diff_outcome.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/model/diff/three_way_diff/three_way_diff_outcome.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/model/diff/three_way_diff/three_way_merge_outcome.ts b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/model/diff/three_way_diff/three_way_merge_outcome.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/model/diff/three_way_diff/three_way_merge_outcome.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/model/diff/three_way_diff/three_way_merge_outcome.ts diff --git a/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/model/index.ts b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/model/index.ts new file mode 100644 index 0000000000000..7e550633d8efc --- /dev/null +++ b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/model/index.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. + */ + +export * from './aggregated_prebuilt_rules_error'; +export * from './diff/diffable_rule/build_schema'; +export * from './diff/diffable_rule/diffable_field_types'; +export * from './diff/diffable_rule/diffable_rule'; +export * from './diff/rule_diff/fields_diff'; +export * from './diff/rule_diff/rule_diff'; +export * from './diff/three_way_diff/three_way_diff_outcome'; +export * from './diff/three_way_diff/three_way_diff'; +export * from './diff/three_way_diff/three_way_merge_outcome'; diff --git a/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/api/perform_rule_installation/perform_rule_installation_request_schema.ts b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/perform_rule_installation/perform_rule_installation_route.ts similarity index 66% rename from x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/api/perform_rule_installation/perform_rule_installation_request_schema.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/perform_rule_installation/perform_rule_installation_route.ts index 3dc0c3619b2ee..fca8ce25d3ba1 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/api/perform_rule_installation/perform_rule_installation_request_schema.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/perform_rule_installation/perform_rule_installation_route.ts @@ -5,6 +5,8 @@ * 2.0. */ import * as t from 'io-ts'; +import type { RuleResponse } from '../../model'; +import type { AggregatedPrebuiltRuleError } from '../model'; export const RuleVersionSpecifier = t.exact( t.type({ @@ -39,3 +41,26 @@ export const PerformRuleInstallationRequestBody = t.union([ export type PerformRuleInstallationRequestBody = t.TypeOf< typeof PerformRuleInstallationRequestBody >; + +export enum SkipRuleInstallReason { + ALREADY_INSTALLED = 'ALREADY_INSTALLED', +} + +export interface SkippedRuleInstall { + rule_id: string; + reason: SkipRuleInstallReason; +} + +export interface PerformRuleInstallationResponseBody { + summary: { + total: number; + succeeded: number; + skipped: number; + failed: number; + }; + results: { + created: RuleResponse[]; + skipped: SkippedRuleInstall[]; + }; + errors: AggregatedPrebuiltRuleError[]; +} diff --git a/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/api/perform_rule_upgrade/perform_rule_upgrade_request_schema.ts b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/perform_rule_upgrade/perform_rule_upgrade_route.ts similarity index 79% rename from x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/api/perform_rule_upgrade/perform_rule_upgrade_request_schema.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/perform_rule_upgrade/perform_rule_upgrade_route.ts index eb92782f4d916..b1d3b166a513e 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/api/perform_rule_upgrade/perform_rule_upgrade_request_schema.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/perform_rule_upgrade/perform_rule_upgrade_route.ts @@ -8,6 +8,9 @@ import { enumeration } from '@kbn/securitysolution-io-ts-types'; import * as t from 'io-ts'; +import type { RuleResponse } from '../../model'; +import type { AggregatedPrebuiltRuleError } from '../model'; + export enum PickVersionValues { BASE = 'BASE', CURRENT = 'CURRENT', @@ -70,3 +73,26 @@ export const PerformRuleUpgradeRequestBody = t.union([ UpgradeSpecificRulesRequest, ]); export type PerformRuleUpgradeRequestBody = t.TypeOf; + +export enum SkipRuleUpgradeReason { + RULE_UP_TO_DATE = 'RULE_UP_TO_DATE', +} + +export interface SkippedRuleUpgrade { + rule_id: string; + reason: SkipRuleUpgradeReason; +} + +export interface PerformRuleUpgradeResponseBody { + summary: { + total: number; + succeeded: number; + skipped: number; + failed: number; + }; + results: { + updated: RuleResponse[]; + skipped: SkippedRuleUpgrade[]; + }; + errors: AggregatedPrebuiltRuleError[]; +} diff --git a/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/api/review_rule_installation/response_schema.ts b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/review_rule_installation/review_rule_installation_route.ts similarity index 90% rename from x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/api/review_rule_installation/response_schema.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/review_rule_installation/review_rule_installation_route.ts index 49757b80630a7..7a7f4878defb3 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/api/review_rule_installation/response_schema.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/review_rule_installation/review_rule_installation_route.ts @@ -5,8 +5,8 @@ * 2.0. */ -import type { RuleSignatureId, RuleTagArray, RuleVersion } from '../../../rule_schema'; -import type { DiffableRule } from '../../model/diff/diffable_rule/diffable_rule'; +import type { RuleSignatureId, RuleTagArray, RuleVersion } from '../../model'; +import type { DiffableRule } from '../model'; export interface ReviewRuleInstallationResponseBody { /** Aggregated info about all rules available for installation */ diff --git a/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/api/review_rule_upgrade/response_schema.ts b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/review_rule_upgrade/review_rule_upgrade_route.ts similarity index 84% rename from x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/api/review_rule_upgrade/response_schema.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/review_rule_upgrade/review_rule_upgrade_route.ts index 52e12bc49fac6..99249cfab1cbc 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/api/review_rule_upgrade/response_schema.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/review_rule_upgrade/review_rule_upgrade_route.ts @@ -5,9 +5,8 @@ * 2.0. */ -import type { RuleObjectId, RuleSignatureId, RuleTagArray } from '../../../rule_schema'; -import type { DiffableRule } from '../../model/diff/diffable_rule/diffable_rule'; -import type { PartialRuleDiff } from '../../model/diff/rule_diff/rule_diff'; +import type { RuleObjectId, RuleSignatureId, RuleTagArray } from '../../model'; +import type { DiffableRule, PartialRuleDiff } from '../model'; export interface ReviewRuleUpgradeResponseBody { /** Aggregated info about all rules available for upgrade */ diff --git a/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/api/urls.ts b/x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/urls.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/api/urls.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/prebuilt_rules/urls.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_exceptions/api/create_rule_exceptions/request_schema.test.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_exceptions/create_rule_exceptions/create_rule_exceptions_route.test.ts similarity index 99% rename from x-pack/plugins/security_solution/common/detection_engine/rule_exceptions/api/create_rule_exceptions/request_schema.test.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_exceptions/create_rule_exceptions/create_rule_exceptions_route.test.ts index 93b4e9f128a7b..b05cc35ce75fa 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_exceptions/api/create_rule_exceptions/request_schema.test.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_exceptions/create_rule_exceptions/create_rule_exceptions_route.test.ts @@ -13,7 +13,7 @@ import { getCreateExceptionListItemSchemaMock } from '@kbn/lists-plugin/common/s import { CreateRuleExceptionsRequestBody, CreateRuleExceptionsRequestParams, -} from './request_schema'; +} from './create_rule_exceptions_route'; describe('CreateRuleExceptionsRequestParams', () => { test('empty objects do not validate', () => { diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_exceptions/api/create_rule_exceptions/request_schema.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_exceptions/create_rule_exceptions/create_rule_exceptions_route.ts similarity index 83% rename from x-pack/plugins/security_solution/common/detection_engine/rule_exceptions/api/create_rule_exceptions/request_schema.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_exceptions/create_rule_exceptions/create_rule_exceptions_route.ts index 57ef1f8974708..42ef5482b5b5a 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_exceptions/api/create_rule_exceptions/request_schema.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_exceptions/create_rule_exceptions/create_rule_exceptions_route.ts @@ -7,10 +7,13 @@ import * as t from 'io-ts'; -import type { CreateRuleExceptionListItemSchemaDecoded } from '@kbn/securitysolution-io-ts-list-types'; +import type { + CreateRuleExceptionListItemSchemaDecoded, + ExceptionListItemSchema, +} from '@kbn/securitysolution-io-ts-list-types'; import { createRuleExceptionListItemSchema } from '@kbn/securitysolution-io-ts-list-types'; -import { RuleObjectId } from '../../../rule_schema'; +import { RuleObjectId } from '../../model'; /** * URL path parameters of the API route. @@ -43,3 +46,5 @@ export type CreateRuleExceptionsRequestBodyDecoded = Omit< > & { items: CreateRuleExceptionListItemSchemaDecoded[]; }; + +export type CreateRuleExceptionsResponse = ExceptionListItemSchema[]; diff --git a/x-pack/plugins/security_solution/common/api/detection_engine/rule_exceptions/find_exception_references/find_exception_references_route.test.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_exceptions/find_exception_references/find_exception_references_route.test.ts new file mode 100644 index 0000000000000..003060f4421aa --- /dev/null +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_exceptions/find_exception_references/find_exception_references_route.test.ts @@ -0,0 +1,247 @@ +/* + * 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 { exactCheck, formatErrors, foldLeftRight } from '@kbn/securitysolution-io-ts-utils'; +import { getExceptionListSchemaMock } from '@kbn/lists-plugin/common/schemas/response/exception_list_schema.mock'; +import { + exceptionListRuleReferencesSchema, + rulesReferencedByExceptionListsSchema, + findExceptionReferencesOnRuleSchema, +} from './find_exception_references_route'; +import type { + ExceptionListRuleReferencesSchema, + RulesReferencedByExceptionListsSchema, + FindExceptionReferencesOnRuleSchema, +} from './find_exception_references_route'; + +describe('Find exception list references', () => { + describe('request schema', () => { + test('validates all fields', () => { + const payload: FindExceptionReferencesOnRuleSchema = { + ids: 'abc,def', + list_ids: '123,456', + namespace_types: 'single,agnostic', + }; + + const decoded = findExceptionReferencesOnRuleSchema.decode(payload); + const checked = exactCheck(payload, decoded); + const output = foldLeftRight(checked); + expect(formatErrors(output.errors)).toEqual([]); + expect(output.schema).toEqual({ + ids: ['abc', 'def'], + list_ids: ['123', '456'], + namespace_types: ['single', 'agnostic'], + }); + }); + + test('"ids" can be optional', () => { + const payload: Omit = { + list_ids: '123,456', + namespace_types: 'single,agnostic', + }; + + const decoded = findExceptionReferencesOnRuleSchema.decode(payload); + const checked = exactCheck(payload, decoded); + const output = foldLeftRight(checked); + expect(formatErrors(output.errors)).toEqual([]); + expect(output.schema).toEqual({ + list_ids: ['123', '456'], + namespace_types: ['single', 'agnostic'], + }); + }); + + test('"list_ids" can be undefined', () => { + const payload: Omit = { + ids: 'abc', + namespace_types: 'single', + }; + + const decoded = findExceptionReferencesOnRuleSchema.decode(payload); + const checked = exactCheck(payload, decoded); + const output = foldLeftRight(checked); + expect(formatErrors(output.errors)).toEqual([]); + expect(output.schema).toEqual({ + ids: ['abc'], + namespace_types: ['single'], + }); + }); + + test('defaults "namespacetypes" to ["single"] if none set', () => { + const payload: Omit = { + ids: 'abc', + list_ids: '123', + }; + + const decoded = findExceptionReferencesOnRuleSchema.decode(payload); + const checked = exactCheck(payload, decoded); + const output = foldLeftRight(checked); + expect(formatErrors(output.errors)).toEqual([]); + expect(output.schema).toEqual({ + ids: ['abc'], + list_ids: ['123'], + namespace_types: ['single'], + }); + }); + + test('cannot add extra values', () => { + const payload: FindExceptionReferencesOnRuleSchema & { extra_value?: string } = { + ids: 'abc,def', + list_ids: '123,456', + namespace_types: 'single,agnostic', + extra_value: 'aaa', + }; + + const decoded = findExceptionReferencesOnRuleSchema.decode(payload); + const checked = exactCheck(payload, decoded); + const output = foldLeftRight(checked); + expect(formatErrors(output.errors)).toEqual(['invalid keys "extra_value"']); + expect(output.schema).toEqual({}); + }); + }); + + describe('response schema', () => { + describe('exceptionListRuleReferencesSchema', () => { + test('validates all fields', () => { + const payload: ExceptionListRuleReferencesSchema = { + ...getExceptionListSchemaMock(), + referenced_rules: [ + { + name: 'My rule', + id: '4656dc92-5832-11ea-8e2d-0242ac130003', + rule_id: 'my-rule-id', + exception_lists: [ + { + id: 'myListId', + list_id: 'my-list-id', + namespace_type: 'single', + type: 'detection', + }, + ], + }, + ], + }; + + const decoded = exceptionListRuleReferencesSchema.decode(payload); + const checked = exactCheck(payload, decoded); + const output = foldLeftRight(checked); + expect(formatErrors(output.errors)).toEqual([]); + expect(output.schema).toEqual(payload); + }); + + test('cannot add extra values', () => { + const payload: ExceptionListRuleReferencesSchema & { extra_value?: string } = { + extra_value: 'foo', + ...getExceptionListSchemaMock(), + referenced_rules: [ + { + name: 'My rule', + id: '4656dc92-5832-11ea-8e2d-0242ac130003', + rule_id: 'my-rule-id', + exception_lists: [ + { + id: 'myListId', + list_id: 'my-list-id', + namespace_type: 'single', + type: 'detection', + }, + ], + }, + ], + }; + + const decoded = exceptionListRuleReferencesSchema.decode(payload); + const checked = exactCheck(payload, decoded); + const output = foldLeftRight(checked); + expect(formatErrors(output.errors)).toEqual(['invalid keys "extra_value"']); + expect(output.schema).toEqual({}); + }); + }); + + describe('rulesReferencedByExceptionListsSchema', () => { + test('validates all fields', () => { + const payload: RulesReferencedByExceptionListsSchema = { + references: [ + { + 'my-list-id': { + ...getExceptionListSchemaMock(), + referenced_rules: [ + { + name: 'My rule', + id: '4656dc92-5832-11ea-8e2d-0242ac130003', + rule_id: 'my-rule-id', + exception_lists: [ + { + id: 'myListId', + list_id: 'my-list-id', + namespace_type: 'single', + type: 'detection', + }, + ], + }, + ], + }, + }, + ], + }; + + const decoded = rulesReferencedByExceptionListsSchema.decode(payload); + const checked = exactCheck(payload, decoded); + const output = foldLeftRight(checked); + expect(formatErrors(output.errors)).toEqual([]); + expect(output.schema).toEqual(payload); + }); + + test('validates "references" with empty array', () => { + const payload: RulesReferencedByExceptionListsSchema = { + references: [], + }; + + const decoded = rulesReferencedByExceptionListsSchema.decode(payload); + const checked = exactCheck(payload, decoded); + const output = foldLeftRight(checked); + expect(formatErrors(output.errors)).toEqual([]); + expect(output.schema).toEqual({ + references: [], + }); + }); + + test('cannot add extra values', () => { + const payload: RulesReferencedByExceptionListsSchema & { extra_value?: string } = { + extra_value: 'foo', + references: [ + { + 'my-list-id': { + ...getExceptionListSchemaMock(), + referenced_rules: [ + { + name: 'My rule', + id: '4656dc92-5832-11ea-8e2d-0242ac130003', + rule_id: 'my-rule-id', + exception_lists: [ + { + id: 'myListId', + list_id: 'my-list-id', + namespace_type: 'single', + type: 'detection', + }, + ], + }, + ], + }, + }, + ], + }; + + const decoded = rulesReferencedByExceptionListsSchema.decode(payload); + const checked = exactCheck(payload, decoded); + const output = foldLeftRight(checked); + expect(formatErrors(output.errors)).toEqual(['invalid keys "extra_value"']); + expect(output.schema).toEqual({}); + }); + }); + }); +}); diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_exceptions/api/find_exception_references/response_schema.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_exceptions/find_exception_references/find_exception_references_route.ts similarity index 60% rename from x-pack/plugins/security_solution/common/detection_engine/rule_exceptions/api/find_exception_references/response_schema.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_exceptions/find_exception_references/find_exception_references_route.ts index 32589e2d165ea..e495ab9647725 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_exceptions/api/find_exception_references/response_schema.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_exceptions/find_exception_references/find_exception_references_route.ts @@ -6,8 +6,38 @@ */ import * as t from 'io-ts'; -import { exceptionListSchema, listArray, list_id } from '@kbn/securitysolution-io-ts-list-types'; -import { RuleName, RuleObjectId, RuleSignatureId } from '../../../rule_schema'; +import { + exceptionListSchema, + listArray, + list_id, + DefaultNamespaceArray, +} from '@kbn/securitysolution-io-ts-list-types'; +import { NonEmptyStringArray } from '@kbn/securitysolution-io-ts-types'; +import { RuleName, RuleObjectId, RuleSignatureId } from '../../model'; + +// If ids and list_ids are undefined, route will fetch all lists matching the +// specified namespace type +export const findExceptionReferencesOnRuleSchema = t.intersection([ + t.exact( + t.type({ + namespace_types: DefaultNamespaceArray, + }) + ), + t.exact( + t.partial({ + ids: NonEmptyStringArray, + list_ids: NonEmptyStringArray, + }) + ), +]); + +export type FindExceptionReferencesOnRuleSchema = t.OutputOf< + typeof findExceptionReferencesOnRuleSchema +>; + +export type FindExceptionReferencesOnRuleSchemaDecoded = t.TypeOf< + typeof findExceptionReferencesOnRuleSchema +>; export const ruleReferenceRuleInfoSchema = t.exact( t.type({ diff --git a/x-pack/plugins/security_solution/common/api/detection_engine/rule_exceptions/index.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_exceptions/index.ts new file mode 100644 index 0000000000000..0b5ccc3b3a648 --- /dev/null +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_exceptions/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 * from './create_rule_exceptions/create_rule_exceptions_route'; +export * from './find_exception_references/find_exception_references_route'; +export * from './urls'; diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_exceptions/api/urls.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_exceptions/urls.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_exceptions/api/urls.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_exceptions/urls.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_actions/request_schema.mock.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route.mock.ts similarity index 81% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_actions/request_schema.mock.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route.mock.ts index fd210ad99680f..66ce78ff9b615 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_actions/request_schema.mock.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route.mock.ts @@ -5,8 +5,8 @@ * 2.0. */ -import { BulkActionType, BulkActionEditType } from './request_schema'; -import type { PerformBulkActionRequestBody } from './request_schema'; +import { BulkActionType, BulkActionEditType } from './bulk_actions_route'; +import type { PerformBulkActionRequestBody } from './bulk_actions_route'; export const getPerformBulkActionSchemaMock = (): PerformBulkActionRequestBody => ({ query: '', diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_actions/request_schema.test.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route.test.ts similarity index 99% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_actions/request_schema.test.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route.test.ts index 712312c50140d..70ae548674332 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_actions/request_schema.test.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route.test.ts @@ -7,7 +7,11 @@ import { left } from 'fp-ts/lib/Either'; import { exactCheck, foldLeftRight, getPaths } from '@kbn/securitysolution-io-ts-utils'; -import { PerformBulkActionRequestBody, BulkActionType, BulkActionEditType } from './request_schema'; +import { + PerformBulkActionRequestBody, + BulkActionType, + BulkActionEditType, +} from './bulk_actions_route'; const retrieveValidationMessage = (payload: unknown) => { const decoded = PerformBulkActionRequestBody.decode(payload); diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_actions/request_schema.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route.ts similarity index 83% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_actions/request_schema.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route.ts index 118c886e94042..c87b9e9a088ba 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_actions/request_schema.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route.ts @@ -16,13 +16,17 @@ import { RuleActionParams, } from '@kbn/securitysolution-io-ts-alerting-types'; +import type { BulkActionSkipResult } from '@kbn/alerting-plugin/common'; +import type { RuleResponse } from '../../model'; +import type { BulkActionsDryRunErrCode } from '../../../../constants'; + import { IndexPatternArray, RuleQuery, RuleTagArray, TimelineTemplateId, TimelineTemplateTitle, -} from '../../../../rule_schema'; +} from '../../model'; export enum BulkActionType { 'enable' = 'enable', @@ -218,3 +222,46 @@ export const PerformBulkActionRequestQuery = t.exact( dry_run: t.union([t.literal('true'), t.literal('false')]), }) ); + +export interface RuleDetailsInError { + id: string; + name?: string; +} +export interface NormalizedRuleError { + message: string; + status_code: number; + err_code?: BulkActionsDryRunErrCode; + rules: RuleDetailsInError[]; +} +export interface BulkEditActionResults { + updated: RuleResponse[]; + created: RuleResponse[]; + deleted: RuleResponse[]; + skipped: BulkActionSkipResult[]; +} + +export interface BulkEditActionSummary { + failed: number; + skipped: number; + succeeded: number; + total: number; +} +export interface BulkEditActionSuccessResponse { + success: boolean; + rules_count: number; + attributes: { + results: BulkEditActionResults; + summary: BulkEditActionSummary; + }; +} +export interface BulkEditActionErrorResponse { + status_code: number; + message: string; + attributes: { + results: BulkEditActionResults; + summary: BulkEditActionSummary; + errors?: NormalizedRuleError[]; + }; +} + +export type BulkEditActionResponse = BulkEditActionSuccessResponse | BulkEditActionErrorResponse; diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_crud/bulk_create_rules/request_schema.test.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_crud/bulk_create_rules/bulk_create_rules_route.test.ts similarity index 98% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_crud/bulk_create_rules/request_schema.test.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_crud/bulk_create_rules/bulk_create_rules_route.test.ts index d2c297d401edb..bf06b41aef39b 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_crud/bulk_create_rules/request_schema.test.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_crud/bulk_create_rules/bulk_create_rules_route.test.ts @@ -5,9 +5,9 @@ * 2.0. */ -import { BulkCreateRulesRequestBody } from './request_schema'; +import { BulkCreateRulesRequestBody } from './bulk_create_rules_route'; import { exactCheck, foldLeftRight, formatErrors } from '@kbn/securitysolution-io-ts-utils'; -import { getCreateRulesSchemaMock } from '../../../../../rule_schema/mocks'; +import { getCreateRulesSchemaMock } from '../../../model/rule_schema/mocks'; // only the basics of testing are here. // see: rule_schemas.test.ts for the bulk of the validation tests diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_crud/bulk_create_rules/request_schema.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_crud/bulk_create_rules/bulk_create_rules_route.ts similarity index 88% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_crud/bulk_create_rules/request_schema.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_crud/bulk_create_rules/bulk_create_rules_route.ts index 846da78b4cbba..18f16cfdd3ce2 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_crud/bulk_create_rules/request_schema.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_crud/bulk_create_rules/bulk_create_rules_route.ts @@ -6,7 +6,7 @@ */ import * as t from 'io-ts'; -import { RuleCreateProps } from '../../../../../rule_schema'; +import { RuleCreateProps } from '../../../model'; /** * Request body parameters of the API route. diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_crud/bulk_delete_rules/request_schema.test.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_crud/bulk_delete_rules/bulk_delete_rules_route.test.ts similarity index 98% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_crud/bulk_delete_rules/request_schema.test.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_crud/bulk_delete_rules/bulk_delete_rules_route.test.ts index 6a709db317109..cdb4085eea1eb 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_crud/bulk_delete_rules/request_schema.test.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_crud/bulk_delete_rules/bulk_delete_rules_route.test.ts @@ -6,7 +6,7 @@ */ import { exactCheck, formatErrors, foldLeftRight } from '@kbn/securitysolution-io-ts-utils'; -import { BulkDeleteRulesRequestBody } from './request_schema'; +import { BulkDeleteRulesRequestBody } from './bulk_delete_rules_route'; // only the basics of testing are here. // see: query_rules_schema.test.ts for the bulk of the validation tests diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_crud/bulk_delete_rules/request_schema.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_crud/bulk_delete_rules/bulk_delete_rules_route.ts similarity index 87% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_crud/bulk_delete_rules/request_schema.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_crud/bulk_delete_rules/bulk_delete_rules_route.ts index e290b57b4c404..0da4acf82f546 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_crud/bulk_delete_rules/request_schema.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_crud/bulk_delete_rules/bulk_delete_rules_route.ts @@ -6,7 +6,7 @@ */ import * as t from 'io-ts'; -import { QueryRuleByIds } from '../../crud/read_rule/query_rule_by_ids'; +import { QueryRuleByIds } from '../../model/query_rule_by_ids'; /** * Request body parameters of the API route. diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_crud/bulk_patch_rules/request_schema.test.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_crud/bulk_patch_rules/bulk_patch_rules_route.test.ts similarity index 97% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_crud/bulk_patch_rules/request_schema.test.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_crud/bulk_patch_rules/bulk_patch_rules_route.test.ts index 3d466d7d23894..9e1351c7f25f0 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_crud/bulk_patch_rules/request_schema.test.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_crud/bulk_patch_rules/bulk_patch_rules_route.test.ts @@ -6,8 +6,8 @@ */ import { exactCheck, formatErrors, foldLeftRight } from '@kbn/securitysolution-io-ts-utils'; -import type { PatchRuleRequestBody } from '../../crud/patch_rule/request_schema'; -import { BulkPatchRulesRequestBody } from './request_schema'; +import type { PatchRuleRequestBody } from '../../crud/patch_rule/patch_rule_route'; +import { BulkPatchRulesRequestBody } from './bulk_patch_rules_route'; // only the basics of testing are here. // see: patch_rules_schema.test.ts for the bulk of the validation tests diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_crud/bulk_patch_rules/request_schema.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_crud/bulk_patch_rules/bulk_patch_rules_route.ts similarity index 86% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_crud/bulk_patch_rules/request_schema.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_crud/bulk_patch_rules/bulk_patch_rules_route.ts index 2dcd0c2a22d4b..ee8e4be710084 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_crud/bulk_patch_rules/request_schema.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_crud/bulk_patch_rules/bulk_patch_rules_route.ts @@ -6,7 +6,7 @@ */ import * as t from 'io-ts'; -import { PatchRuleRequestBody } from '../../crud/patch_rule/request_schema'; +import { PatchRuleRequestBody } from '../../crud/patch_rule/patch_rule_route'; /** * Request body parameters of the API route. diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_crud/bulk_update_rules/request_schema.test.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_crud/bulk_update_rules/bulk_update_rules_route.test.ts similarity index 98% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_crud/bulk_update_rules/request_schema.test.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_crud/bulk_update_rules/bulk_update_rules_route.test.ts index f2b3437273d01..46dbbd22b7aaa 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_crud/bulk_update_rules/request_schema.test.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_crud/bulk_update_rules/bulk_update_rules_route.test.ts @@ -6,9 +6,9 @@ */ import { exactCheck, formatErrors, foldLeftRight } from '@kbn/securitysolution-io-ts-utils'; -import type { RuleUpdateProps } from '../../../../../rule_schema'; -import { getUpdateRulesSchemaMock } from '../../../../../rule_schema/mocks'; -import { BulkUpdateRulesRequestBody } from './request_schema'; +import type { RuleUpdateProps } from '../../../model'; +import { getUpdateRulesSchemaMock } from '../../../model/rule_schema/mocks'; +import { BulkUpdateRulesRequestBody } from './bulk_update_rules_route'; // only the basics of testing are here. // see: update_rules_schema.test.ts for the bulk of the validation tests diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_crud/bulk_update_rules/request_schema.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_crud/bulk_update_rules/bulk_update_rules_route.ts similarity index 88% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_crud/bulk_update_rules/request_schema.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_crud/bulk_update_rules/bulk_update_rules_route.ts index 5409e7b2bda43..649898adc9e37 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_crud/bulk_update_rules/request_schema.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_crud/bulk_update_rules/bulk_update_rules_route.ts @@ -6,7 +6,7 @@ */ import * as t from 'io-ts'; -import { RuleUpdateProps } from '../../../../../rule_schema'; +import { RuleUpdateProps } from '../../../model'; /** * Request body parameters of the API route. diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_crud/response_schema.test.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_crud/response_schema.test.ts similarity index 95% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_crud/response_schema.test.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_crud/response_schema.test.ts index 044af119f99ec..a149d73d333d4 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_crud/response_schema.test.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_crud/response_schema.test.ts @@ -9,10 +9,9 @@ import { left } from 'fp-ts/lib/Either'; import { pipe } from 'fp-ts/lib/pipeable'; import { exactCheck, foldLeftRight, getPaths } from '@kbn/securitysolution-io-ts-utils'; -import type { RuleResponse } from '../../../../rule_schema'; -import { getRulesSchemaMock } from '../../../../rule_schema/mocks'; -import type { ErrorSchema } from '../../../../schemas/response/error_schema'; -import { getErrorSchemaMock } from '../../../../schemas/response/error_schema.mocks'; +import type { RuleResponse, ErrorSchema } from '../../model'; +import { getRulesSchemaMock } from '../../model/rule_schema/mocks'; +import { getErrorSchemaMock } from '../../model/error_schema.mocks'; import { BulkCrudRulesResponse } from './response_schema'; diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_crud/response_schema.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_crud/response_schema.ts similarity index 77% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_crud/response_schema.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_crud/response_schema.ts index 9a0144e2cf758..b6f9bb359344b 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_crud/response_schema.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/bulk_crud/response_schema.ts @@ -7,8 +7,7 @@ import * as t from 'io-ts'; -import { RuleResponse } from '../../../../rule_schema'; -import { errorSchema } from '../../../../schemas/response/error_schema'; +import { RuleResponse, errorSchema } from '../../model'; export type BulkCrudRulesResponse = t.TypeOf; export const BulkCrudRulesResponse = t.array(t.union([RuleResponse, errorSchema])); diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/coverage_overview/request_schema.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/coverage_overview/coverage_overview_route.ts similarity index 76% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/coverage_overview/request_schema.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/coverage_overview/coverage_overview_route.ts index 48c3e4679702a..0f85a1fdc609a 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/coverage_overview/request_schema.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/coverage_overview/coverage_overview_route.ts @@ -79,3 +79,27 @@ export const CoverageOverviewRequestBody = t.exact( filter: CoverageOverviewFilter, }) ); + +export type CoverageOverviewRuleAttributes = t.TypeOf; +export const CoverageOverviewRuleAttributes = t.type({ + name: t.string, + activity: CoverageOverviewRuleActivitySchema, +}); + +export type CoverageOverviewResponse = t.TypeOf; +export const CoverageOverviewResponse = t.exact( + t.type({ + /** + * Map having (tacticId, techniqueId or subtechniqueId) as the key and an array of rule ids as the value + */ + coverage: t.record(t.string, NonEmptyArray(t.string)), + /** + * Array of unmapped rule ids + */ + unmapped_rule_ids: t.array(t.string), + /** + * Map having ruleId as the key and coverage overview rule data as the value + */ + rules_data: t.record(t.string, CoverageOverviewRuleAttributes), + }) +); diff --git a/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/create_rule/create_rule_route.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/create_rule/create_rule_route.ts new file mode 100644 index 0000000000000..cc71d7da3fbed --- /dev/null +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/create_rule/create_rule_route.ts @@ -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. + */ + +import type * as t from 'io-ts'; +import { RuleCreateProps } from '../../../model'; + +export const CreateRuleRequestBody = RuleCreateProps; +export type CreateRuleRequestBody = t.TypeOf; diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/crud/create_rule/request_schema_validation.test.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/create_rule/request_schema_validation.test.ts similarity index 96% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/crud/create_rule/request_schema_validation.test.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/create_rule/request_schema_validation.test.ts index 39ed8b028f054..733645dcb3aa9 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/crud/create_rule/request_schema_validation.test.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/create_rule/request_schema_validation.test.ts @@ -5,11 +5,11 @@ * 2.0. */ -import type { RuleCreateProps } from '../../../../../rule_schema'; +import type { RuleCreateProps } from '../../../model/rule_schema'; import { getCreateRulesSchemaMock, getCreateThreatMatchRulesSchemaMock, -} from '../../../../../rule_schema/mocks'; +} from '../../../model/rule_schema/mocks'; import { validateCreateRuleProps } from './request_schema_validation'; describe('Create rule request schema, additional validation', () => { diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/crud/create_rule/request_schema_validation.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/create_rule/request_schema_validation.ts similarity index 97% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/crud/create_rule/request_schema_validation.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/create_rule/request_schema_validation.ts index fd2e4b06b63d6..519ef874c422e 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/crud/create_rule/request_schema_validation.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/create_rule/request_schema_validation.ts @@ -5,7 +5,7 @@ * 2.0. */ -import type { RuleCreateProps } from '../../../../../rule_schema'; +import type { RuleCreateProps } from '../../../model'; /** * Additional validation that is implemented outside of the schema itself. diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/crud/patch_rule/request_schema.mock.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/patch_rule/patch_rule_route.mock.ts similarity index 96% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/crud/patch_rule/request_schema.mock.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/patch_rule/patch_rule_route.mock.ts index 285e773456d98..4346c05333038 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/crud/patch_rule/request_schema.mock.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/patch_rule/patch_rule_route.mock.ts @@ -5,7 +5,7 @@ * 2.0. */ -import type { PatchRuleRequestBody, ThresholdPatchRuleRequestBody } from './request_schema'; +import type { PatchRuleRequestBody, ThresholdPatchRuleRequestBody } from './patch_rule_route'; export const getPatchRulesSchemaMock = (): PatchRuleRequestBody => ({ description: 'some description', diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/crud/patch_rule/request_schema.test.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/patch_rule/patch_rule_route.test.ts similarity index 99% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/crud/patch_rule/request_schema.test.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/patch_rule/patch_rule_route.test.ts index 36613736e3274..902b5d0c50899 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/crud/patch_rule/request_schema.test.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/patch_rule/patch_rule_route.test.ts @@ -9,9 +9,9 @@ import { left } from 'fp-ts/lib/Either'; import { pipe } from 'fp-ts/lib/pipeable'; import { exactCheck, foldLeftRight, getPaths } from '@kbn/securitysolution-io-ts-utils'; -import { getListArrayMock } from '../../../../../schemas/types/lists.mock'; -import { PatchRuleRequestBody } from './request_schema'; -import { getPatchRulesSchemaMock } from './request_schema.mock'; +import { getListArrayMock } from '../../../../../detection_engine/schemas/types/lists.mock'; +import { PatchRuleRequestBody } from './patch_rule_route'; +import { getPatchRulesSchemaMock } from './patch_rule_route.mock'; describe('Patch rule request schema', () => { test('[id] does validate', () => { diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/crud/patch_rule/request_schema.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/patch_rule/patch_rule_route.ts similarity index 96% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/crud/patch_rule/request_schema.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/patch_rule/patch_rule_route.ts index 27a1f14687aa4..e74e406141c26 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/crud/patch_rule/request_schema.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/patch_rule/patch_rule_route.ts @@ -5,7 +5,7 @@ * 2.0. */ -import { RulePatchProps, ThresholdRulePatchProps } from '../../../../../rule_schema'; +import { RulePatchProps, ThresholdRulePatchProps } from '../../../model'; /** * Request body parameters of the API route. diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/crud/patch_rule/request_schema_validation.test.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/patch_rule/request_schema_validation.test.ts similarity index 98% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/crud/patch_rule/request_schema_validation.test.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/patch_rule/request_schema_validation.test.ts index c00e3c38fb91b..647bdd2c8be94 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/crud/patch_rule/request_schema_validation.test.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/patch_rule/request_schema_validation.test.ts @@ -5,8 +5,8 @@ * 2.0. */ -import type { PatchRuleRequestBody, ThresholdPatchRuleRequestBody } from './request_schema'; -import { getPatchRulesSchemaMock, getPatchThresholdRulesSchemaMock } from './request_schema.mock'; +import type { PatchRuleRequestBody, ThresholdPatchRuleRequestBody } from './patch_rule_route'; +import { getPatchRulesSchemaMock, getPatchThresholdRulesSchemaMock } from './patch_rule_route.mock'; import { validatePatchRuleRequestBody } from './request_schema_validation'; describe('Patch rule request schema, additional validation', () => { diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/crud/patch_rule/request_schema_validation.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/patch_rule/request_schema_validation.ts similarity index 97% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/crud/patch_rule/request_schema_validation.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/patch_rule/request_schema_validation.ts index 72d10bf5e58de..f27237b563b21 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/crud/patch_rule/request_schema_validation.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/patch_rule/request_schema_validation.ts @@ -5,7 +5,7 @@ * 2.0. */ -import type { PatchRuleRequestBody } from './request_schema'; +import type { PatchRuleRequestBody } from './patch_rule_route'; /** * Additional validation that is implemented outside of the schema itself. diff --git a/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/read_rule/read_rule_route.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/read_rule/read_rule_route.ts new file mode 100644 index 0000000000000..e133c754ac327 --- /dev/null +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/read_rule/read_rule_route.ts @@ -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. + */ + +import type * as t from 'io-ts'; +import { QueryRuleByIds } from '../../model/query_rule_by_ids'; + +export const ReadRuleRequestQuery = QueryRuleByIds; +export type ReadRuleRequestQuery = t.TypeOf; diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/crud/update_rule/request_schema_validation.test.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/update_rule/request_schema_validation.test.ts similarity index 95% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/crud/update_rule/request_schema_validation.test.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/update_rule/request_schema_validation.test.ts index f6a8d0bb39340..6bec7b1de3aba 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/crud/update_rule/request_schema_validation.test.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/update_rule/request_schema_validation.test.ts @@ -5,8 +5,8 @@ * 2.0. */ -import type { RuleUpdateProps } from '../../../../../rule_schema'; -import { getUpdateRulesSchemaMock } from '../../../../../rule_schema/mocks'; +import type { RuleUpdateProps } from '../../../model/rule_schema'; +import { getUpdateRulesSchemaMock } from '../../../model/rule_schema/mocks'; import { validateUpdateRuleProps } from './request_schema_validation'; describe('Update rule request schema, additional validation', () => { diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/crud/update_rule/request_schema_validation.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/update_rule/request_schema_validation.ts similarity index 97% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/crud/update_rule/request_schema_validation.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/update_rule/request_schema_validation.ts index 09d1e1e7b0a99..d58bbdc4bee05 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/crud/update_rule/request_schema_validation.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/update_rule/request_schema_validation.ts @@ -5,7 +5,7 @@ * 2.0. */ -import type { RuleUpdateProps } from '../../../../../rule_schema'; +import type { RuleUpdateProps } from '../../../model'; /** * Additional validation that is implemented outside of the schema itself. diff --git a/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/update_rule/update_rule_route.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/update_rule/update_rule_route.ts new file mode 100644 index 0000000000000..528dfd1d6f648 --- /dev/null +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/crud/update_rule/update_rule_route.ts @@ -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. + */ + +import type * as t from 'io-ts'; +import { RuleUpdateProps } from '../../../model'; + +export const UpdateRuleRequestBody = RuleUpdateProps; +export type UpdateRuleRequestBody = t.TypeOf; diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/model/export/export_rules_details_schema.mock.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/export_rules/export_rules_details_schema.mock.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/model/export/export_rules_details_schema.mock.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/export_rules/export_rules_details_schema.mock.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/model/export/export_rules_details_schema.test.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/export_rules/export_rules_details_schema.test.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/model/export/export_rules_details_schema.test.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/export_rules/export_rules_details_schema.test.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/model/export/export_rules_details_schema.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/export_rules/export_rules_details_schema.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/model/export/export_rules_details_schema.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/export_rules/export_rules_details_schema.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/export_rules/request_schema.test.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/export_rules/export_rules_route.test.ts similarity index 98% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/export_rules/request_schema.test.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/export_rules/export_rules_route.test.ts index 0e0ec3cbaca3b..1edb1cfa499f0 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/export_rules/request_schema.test.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/export_rules/export_rules_route.test.ts @@ -9,8 +9,8 @@ import { left } from 'fp-ts/lib/Either'; import { pipe } from 'fp-ts/lib/pipeable'; import { exactCheck, foldLeftRight, getPaths } from '@kbn/securitysolution-io-ts-utils'; -import { ExportRulesRequestBody, ExportRulesRequestQuery } from './request_schema'; -import type { ExportRulesRequestQueryDecoded } from './request_schema'; +import { ExportRulesRequestBody, ExportRulesRequestQuery } from './export_rules_route'; +import type { ExportRulesRequestQueryDecoded } from './export_rules_route'; describe('Export rules request schema', () => { describe('ExportRulesRequestBody', () => { diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/export_rules/request_schema.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/export_rules/export_rules_route.ts similarity index 89% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/export_rules/request_schema.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/export_rules/export_rules_route.ts index 682e69e55d5a4..00042f6ed554c 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/export_rules/request_schema.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/export_rules/export_rules_route.ts @@ -9,8 +9,8 @@ import * as t from 'io-ts'; import { DefaultExportFileName } from '@kbn/securitysolution-io-ts-alerting-types'; import { DefaultStringBooleanFalse } from '@kbn/securitysolution-io-ts-types'; -import type { FileName, ExcludeExportDetails } from '../../../../schemas/common/schemas'; -import { RuleSignatureId } from '../../../../rule_schema'; +import type { FileName, ExcludeExportDetails } from '../../model'; +import { RuleSignatureId } from '../../model'; const ObjectsWithRuleId = t.array(t.exact(t.type({ rule_id: RuleSignatureId }))); diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/find_rules/request_schema.test.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/find_rules/request_schema.test.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/find_rules/request_schema.test.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/find_rules/request_schema.test.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/find_rules/request_schema.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/find_rules/request_schema.ts similarity index 88% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/find_rules/request_schema.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/find_rules/request_schema.ts index 08d05a54a5753..f97002f92d562 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/find_rules/request_schema.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/find_rules/request_schema.ts @@ -7,8 +7,8 @@ import * as t from 'io-ts'; import { DefaultPerPage, DefaultPage } from '@kbn/securitysolution-io-ts-alerting-types'; -import type { PerPage, Page } from '../../../../schemas/common'; -import { queryFilter, fields, SortOrder } from '../../../../schemas/common'; +import type { PerPage, Page, RuleResponse } from '../../model'; +import { SortOrder, queryFilter, fields } from '../../model'; export type FindRulesSortField = t.TypeOf; export const FindRulesSortField = t.union([ @@ -50,3 +50,10 @@ export type FindRulesRequestQueryDecoded = Omit { test('it should validate an empty response with defaults', () => { - const payload: RuleManagementFiltersResponse = { + const payload: GetRuleManagementFiltersResponse = { rules_summary: { custom_count: 0, prebuilt_installed_count: 0, @@ -21,7 +21,7 @@ describe('Rule management filters response schema', () => { tags: [], }, }; - const decoded = RuleManagementFiltersResponse.decode(payload); + const decoded = GetRuleManagementFiltersResponse.decode(payload); const checked = exactCheck(payload, decoded); const message = foldLeftRight(checked); @@ -30,7 +30,7 @@ describe('Rule management filters response schema', () => { }); test('it should validate an non empty response with defaults', () => { - const payload: RuleManagementFiltersResponse = { + const payload: GetRuleManagementFiltersResponse = { rules_summary: { custom_count: 10, prebuilt_installed_count: 20, @@ -39,7 +39,7 @@ describe('Rule management filters response schema', () => { tags: ['a', 'b', 'c'], }, }; - const decoded = RuleManagementFiltersResponse.decode(payload); + const decoded = GetRuleManagementFiltersResponse.decode(payload); const checked = exactCheck(payload, decoded); const message = foldLeftRight(checked); @@ -48,7 +48,7 @@ describe('Rule management filters response schema', () => { }); test('it should not validate an extra invalid field added', () => { - const payload: RuleManagementFiltersResponse & { invalid_field: string } = { + const payload: GetRuleManagementFiltersResponse & { invalid_field: string } = { rules_summary: { custom_count: 0, prebuilt_installed_count: 0, @@ -58,7 +58,7 @@ describe('Rule management filters response schema', () => { }, invalid_field: 'invalid', }; - const decoded = RuleManagementFiltersResponse.decode(payload); + const decoded = GetRuleManagementFiltersResponse.decode(payload); const checked = exactCheck(payload, decoded); const message = foldLeftRight(checked); @@ -67,7 +67,7 @@ describe('Rule management filters response schema', () => { }); test('it should NOT validate an empty response with a negative "summary.prebuilt_installed_count" number', () => { - const payload: RuleManagementFiltersResponse = { + const payload: GetRuleManagementFiltersResponse = { rules_summary: { custom_count: 0, prebuilt_installed_count: -1, @@ -76,7 +76,7 @@ describe('Rule management filters response schema', () => { tags: [], }, }; - const decoded = RuleManagementFiltersResponse.decode(payload); + const decoded = GetRuleManagementFiltersResponse.decode(payload); const checked = exactCheck(payload, decoded); const message = foldLeftRight(checked); @@ -87,7 +87,7 @@ describe('Rule management filters response schema', () => { }); test('it should NOT validate an empty response with a negative "summary.custom_count"', () => { - const payload: RuleManagementFiltersResponse = { + const payload: GetRuleManagementFiltersResponse = { rules_summary: { custom_count: -1, prebuilt_installed_count: 0, @@ -96,7 +96,7 @@ describe('Rule management filters response schema', () => { tags: [], }, }; - const decoded = RuleManagementFiltersResponse.decode(payload); + const decoded = GetRuleManagementFiltersResponse.decode(payload); const checked = exactCheck(payload, decoded); const message = foldLeftRight(checked); @@ -107,7 +107,7 @@ describe('Rule management filters response schema', () => { }); test('it should NOT validate an empty prepackaged response if "summary.prebuilt_installed_count" is not there', () => { - const payload: RuleManagementFiltersResponse = { + const payload: GetRuleManagementFiltersResponse = { rules_summary: { custom_count: 0, prebuilt_installed_count: 0, @@ -118,7 +118,7 @@ describe('Rule management filters response schema', () => { }; // @ts-expect-error delete payload.rules_summary.prebuilt_installed_count; - const decoded = RuleManagementFiltersResponse.decode(payload); + const decoded = GetRuleManagementFiltersResponse.decode(payload); const checked = exactCheck(payload, decoded); const message = foldLeftRight(checked); @@ -129,7 +129,7 @@ describe('Rule management filters response schema', () => { }); test('it should NOT validate an empty response with wrong "aggregated_fields.tags"', () => { - const payload: RuleManagementFiltersResponse = { + const payload: GetRuleManagementFiltersResponse = { rules_summary: { custom_count: 0, prebuilt_installed_count: 0, @@ -139,7 +139,7 @@ describe('Rule management filters response schema', () => { tags: [1], }, }; - const decoded = RuleManagementFiltersResponse.decode(payload); + const decoded = GetRuleManagementFiltersResponse.decode(payload); const checked = exactCheck(payload, decoded); const message = foldLeftRight(checked); diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/filters/response_schema.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/get_rule_management_filters/get_rule_management_filters_route.ts similarity index 78% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/filters/response_schema.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/get_rule_management_filters/get_rule_management_filters_route.ts index 89d12bff729b3..bf786239d703d 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/filters/response_schema.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/get_rule_management_filters/get_rule_management_filters_route.ts @@ -8,8 +8,8 @@ import * as t from 'io-ts'; import { PositiveInteger } from '@kbn/securitysolution-io-ts-types'; -export type RuleManagementFiltersResponse = t.TypeOf; -export const RuleManagementFiltersResponse = t.exact( +export type GetRuleManagementFiltersResponse = t.TypeOf; +export const GetRuleManagementFiltersResponse = t.exact( t.type({ rules_summary: t.type({ custom_count: PositiveInteger, diff --git a/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/import_rules/import_rules_route.test.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/import_rules/import_rules_route.test.ts new file mode 100644 index 0000000000000..64630dca05610 --- /dev/null +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/import_rules/import_rules_route.test.ts @@ -0,0 +1,502 @@ +/* + * 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 { pipe } from 'fp-ts/lib/pipeable'; +import type { Either } from 'fp-ts/lib/Either'; +import { left } from 'fp-ts/lib/Either'; +import type { Errors } from 'io-ts'; + +import { exactCheck, foldLeftRight, getPaths } from '@kbn/securitysolution-io-ts-utils'; +import type { ErrorSchema } from '../../model/error_schema'; + +import { ImportRulesResponse } from './import_rules_route'; + +describe('Import rules schema', () => { + describe('response schema', () => { + test('it should validate an empty import response with no errors', () => { + const payload: ImportRulesResponse = { + success: true, + success_count: 0, + rules_count: 0, + errors: [], + exceptions_errors: [], + exceptions_success: true, + exceptions_success_count: 0, + action_connectors_success: true, + action_connectors_success_count: 0, + action_connectors_errors: [], + action_connectors_warnings: [], + }; + const decoded = ImportRulesResponse.decode(payload); + const checked = exactCheck(payload, decoded); + const message = pipe(checked, foldLeftRight); + + expect(getPaths(left(message.errors))).toEqual([]); + expect(message.schema).toEqual(payload); + }); + + test('it should validate an empty import response with a single error', () => { + const payload: ImportRulesResponse = { + success: false, + success_count: 0, + rules_count: 0, + errors: [{ error: { status_code: 400, message: 'some message' } }], + exceptions_errors: [], + exceptions_success: true, + exceptions_success_count: 0, + action_connectors_success: true, + action_connectors_success_count: 0, + action_connectors_errors: [], + action_connectors_warnings: [], + }; + const decoded = ImportRulesResponse.decode(payload); + const checked = exactCheck(payload, decoded); + const message = pipe(checked, foldLeftRight); + + expect(getPaths(left(message.errors))).toEqual([]); + expect(message.schema).toEqual(payload); + }); + + test('it should validate an empty import response with a single exceptions error', () => { + const payload: ImportRulesResponse = { + success: false, + success_count: 0, + rules_count: 0, + errors: [], + exceptions_errors: [{ error: { status_code: 400, message: 'some message' } }], + exceptions_success: true, + exceptions_success_count: 0, + action_connectors_success: true, + action_connectors_success_count: 0, + action_connectors_errors: [], + action_connectors_warnings: [], + }; + const decoded = ImportRulesResponse.decode(payload); + const checked = exactCheck(payload, decoded); + const message = pipe(checked, foldLeftRight); + + expect(getPaths(left(message.errors))).toEqual([]); + expect(message.schema).toEqual(payload); + }); + + test('it should validate an empty import response with two errors', () => { + const payload: ImportRulesResponse = { + success: false, + success_count: 0, + rules_count: 0, + errors: [ + { error: { status_code: 400, message: 'some message' } }, + { error: { status_code: 500, message: 'some message' } }, + ], + exceptions_errors: [], + exceptions_success: true, + exceptions_success_count: 0, + action_connectors_success: true, + action_connectors_success_count: 0, + action_connectors_errors: [], + action_connectors_warnings: [], + }; + const decoded = ImportRulesResponse.decode(payload); + const checked = exactCheck(payload, decoded); + const message = pipe(checked, foldLeftRight); + + expect(getPaths(left(message.errors))).toEqual([]); + expect(message.schema).toEqual(payload); + }); + + test('it should validate an empty import response with two exception errors', () => { + const payload: ImportRulesResponse = { + success: false, + success_count: 0, + rules_count: 0, + errors: [], + exceptions_errors: [ + { error: { status_code: 400, message: 'some message' } }, + { error: { status_code: 500, message: 'some message' } }, + ], + exceptions_success: true, + exceptions_success_count: 0, + action_connectors_success: true, + action_connectors_success_count: 0, + action_connectors_errors: [], + action_connectors_warnings: [], + }; + const decoded = ImportRulesResponse.decode(payload); + const checked = exactCheck(payload, decoded); + const message = pipe(checked, foldLeftRight); + + expect(getPaths(left(message.errors))).toEqual([]); + expect(message.schema).toEqual(payload); + }); + + test('it should NOT validate a success_count that is a negative number', () => { + const payload: ImportRulesResponse = { + success: false, + success_count: -1, + rules_count: 0, + errors: [], + exceptions_errors: [], + exceptions_success: true, + exceptions_success_count: 0, + action_connectors_success: true, + action_connectors_success_count: 0, + action_connectors_errors: [], + action_connectors_warnings: [], + }; + const decoded = ImportRulesResponse.decode(payload); + const checked = exactCheck(payload, decoded); + const message = pipe(checked, foldLeftRight); + + expect(getPaths(left(message.errors))).toEqual([ + 'Invalid value "-1" supplied to "success_count"', + ]); + expect(message.schema).toEqual({}); + }); + + test('it should NOT validate a exceptions_success_count that is a negative number', () => { + const payload: ImportRulesResponse = { + success: false, + success_count: 0, + rules_count: 0, + errors: [], + exceptions_errors: [], + exceptions_success: true, + exceptions_success_count: -1, + action_connectors_success: true, + action_connectors_success_count: 0, + action_connectors_errors: [], + action_connectors_warnings: [], + }; + const decoded = ImportRulesResponse.decode(payload); + const checked = exactCheck(payload, decoded); + const message = pipe(checked, foldLeftRight); + + expect(getPaths(left(message.errors))).toEqual([ + 'Invalid value "-1" supplied to "exceptions_success_count"', + ]); + expect(message.schema).toEqual({}); + }); + + test('it should NOT validate a success that is not a boolean', () => { + type UnsafeCastForTest = Either< + Errors, + { + success: string; + success_count: number; + errors: Array< + { + id?: string | undefined; + rule_id?: string | undefined; + } & { + error: { + status_code: number; + message: string; + }; + } + >; + } + >; + const payload: Omit & { success: string } = { + success: 'hello', + success_count: 0, + rules_count: 0, + errors: [], + exceptions_errors: [], + exceptions_success: true, + exceptions_success_count: 0, + action_connectors_success: true, + action_connectors_success_count: 0, + action_connectors_errors: [], + action_connectors_warnings: [], + }; + const decoded = ImportRulesResponse.decode(payload); + const checked = exactCheck(payload, decoded as UnsafeCastForTest); + const message = pipe(checked, foldLeftRight); + + expect(getPaths(left(message.errors))).toEqual([ + 'Invalid value "hello" supplied to "success"', + ]); + expect(message.schema).toEqual({}); + }); + + test('it should NOT validate a exceptions_success that is not a boolean', () => { + type UnsafeCastForTest = Either< + Errors, + { + success: boolean; + exceptions_success: string; + success_count: number; + errors: Array< + { + id?: string | undefined; + rule_id?: string | undefined; + } & { + error: { + status_code: number; + message: string; + }; + } + >; + } + >; + const payload: Omit & { + exceptions_success: string; + } = { + success: true, + success_count: 0, + rules_count: 0, + errors: [], + exceptions_errors: [], + exceptions_success: 'hello', + exceptions_success_count: 0, + action_connectors_success: true, + action_connectors_success_count: 0, + action_connectors_errors: [], + action_connectors_warnings: [], + }; + const decoded = ImportRulesResponse.decode(payload); + const checked = exactCheck(payload, decoded as UnsafeCastForTest); + const message = pipe(checked, foldLeftRight); + + expect(getPaths(left(message.errors))).toEqual([ + 'Invalid value "hello" supplied to "exceptions_success"', + ]); + expect(message.schema).toEqual({}); + }); + + test('it should NOT validate a success an extra invalid field', () => { + const payload: ImportRulesResponse & { invalid_field: string } = { + success: true, + success_count: 0, + rules_count: 0, + errors: [], + invalid_field: 'invalid_data', + exceptions_errors: [], + exceptions_success: true, + exceptions_success_count: 0, + action_connectors_success: true, + action_connectors_success_count: 0, + action_connectors_errors: [], + action_connectors_warnings: [], + }; + const decoded = ImportRulesResponse.decode(payload); + const checked = exactCheck(payload, decoded); + const message = pipe(checked, foldLeftRight); + + expect(getPaths(left(message.errors))).toEqual(['invalid keys "invalid_field"']); + expect(message.schema).toEqual({}); + }); + + test('it should NOT validate an extra field in the second position of the errors array', () => { + type InvalidError = ErrorSchema & { invalid_data?: string }; + const payload: Omit & { + errors: InvalidError[]; + } = { + success: true, + success_count: 0, + rules_count: 0, + errors: [ + { error: { status_code: 400, message: 'some message' } }, + { invalid_data: 'something', error: { status_code: 500, message: 'some message' } }, + ], + exceptions_errors: [], + exceptions_success: true, + exceptions_success_count: 0, + action_connectors_success: true, + action_connectors_success_count: 0, + action_connectors_errors: [], + action_connectors_warnings: [], + }; + const decoded = ImportRulesResponse.decode(payload); + const checked = exactCheck(payload, decoded); + const message = pipe(checked, foldLeftRight); + + expect(getPaths(left(message.errors))).toEqual(['invalid keys "invalid_data"']); + expect(message.schema).toEqual({}); + }); + + test('it should validate an empty import response with a single connectors error', () => { + const payload: ImportRulesResponse = { + success: false, + success_count: 0, + rules_count: 0, + errors: [], + exceptions_errors: [], + exceptions_success: true, + exceptions_success_count: 0, + action_connectors_success: true, + action_connectors_success_count: 0, + action_connectors_errors: [{ error: { status_code: 400, message: 'some message' } }], + action_connectors_warnings: [], + }; + const decoded = ImportRulesResponse.decode(payload); + const checked = exactCheck(payload, decoded); + const message = pipe(checked, foldLeftRight); + + expect(getPaths(left(message.errors))).toEqual([]); + expect(message.schema).toEqual(payload); + }); + test('it should validate an empty import response with multiple errors', () => { + const payload: ImportRulesResponse = { + success: false, + success_count: 0, + rules_count: 0, + errors: [ + { error: { status_code: 400, message: 'some message' } }, + { error: { status_code: 500, message: 'some message' } }, + ], + exceptions_errors: [], + exceptions_success: true, + exceptions_success_count: 0, + action_connectors_success: true, + action_connectors_success_count: 0, + action_connectors_errors: [{ error: { status_code: 400, message: 'some message' } }], + action_connectors_warnings: [], + }; + const decoded = ImportRulesResponse.decode(payload); + const checked = exactCheck(payload, decoded); + const message = pipe(checked, foldLeftRight); + + expect(getPaths(left(message.errors))).toEqual([]); + expect(message.schema).toEqual(payload); + }); + test('it should NOT validate action_connectors_success that is not boolean', () => { + type UnsafeCastForTest = Either< + Errors, + { + success: boolean; + action_connectors_success: string; + success_count: number; + errors: Array< + { + id?: string | undefined; + rule_id?: string | undefined; + } & { + error: { + status_code: number; + message: string; + }; + } + >; + } + >; + const payload: Omit & { + action_connectors_success: string; + } = { + success: true, + success_count: 0, + rules_count: 0, + errors: [], + exceptions_errors: [], + exceptions_success: true, + exceptions_success_count: 0, + action_connectors_success: 'invalid', + action_connectors_success_count: 0, + action_connectors_errors: [], + action_connectors_warnings: [], + }; + const decoded = ImportRulesResponse.decode(payload); + const checked = exactCheck(payload, decoded as UnsafeCastForTest); + const message = pipe(checked, foldLeftRight); + + expect(getPaths(left(message.errors))).toEqual([ + 'Invalid value "invalid" supplied to "action_connectors_success"', + ]); + expect(message.schema).toEqual({}); + }); + test('it should NOT validate a action_connectors_success_count that is a negative number', () => { + const payload: ImportRulesResponse = { + success: false, + success_count: 0, + rules_count: 0, + errors: [], + exceptions_errors: [], + exceptions_success: true, + exceptions_success_count: 0, + action_connectors_success: true, + action_connectors_success_count: -1, + action_connectors_errors: [], + action_connectors_warnings: [], + }; + const decoded = ImportRulesResponse.decode(payload); + const checked = exactCheck(payload, decoded); + const message = pipe(checked, foldLeftRight); + + expect(getPaths(left(message.errors))).toEqual([ + 'Invalid value "-1" supplied to "action_connectors_success_count"', + ]); + expect(message.schema).toEqual({}); + }); + test('it should validate a action_connectors_warnings after importing successfully', () => { + const payload: ImportRulesResponse = { + success: false, + success_count: 0, + rules_count: 0, + errors: [], + exceptions_errors: [], + exceptions_success: true, + exceptions_success_count: 0, + action_connectors_success: true, + action_connectors_success_count: 1, + action_connectors_errors: [], + action_connectors_warnings: [ + { type: 'type', message: 'message', actionPath: 'actionPath' }, + ], + }; + const decoded = ImportRulesResponse.decode(payload); + const checked = exactCheck(payload, decoded); + const message = pipe(checked, foldLeftRight); + + expect(getPaths(left(message.errors))).toEqual([]); + expect(message.schema).toEqual(payload); + }); + test('it should NOT validate a action_connectors_warnings that is not WarningSchema', () => { + type UnsafeCastForTest = Either< + Errors, + { + success: boolean; + action_connectors_warnings: string; + success_count: number; + errors: Array< + { + id?: string | undefined; + rule_id?: string | undefined; + } & { + error: { + status_code: number; + message: string; + }; + } + >; + } + >; + const payload: Omit & { + action_connectors_warnings: string; + } = { + success: true, + success_count: 0, + rules_count: 0, + errors: [], + exceptions_errors: [], + exceptions_success: true, + exceptions_success_count: 0, + action_connectors_success: true, + action_connectors_success_count: 0, + action_connectors_errors: [], + action_connectors_warnings: 'invalid', + }; + const decoded = ImportRulesResponse.decode(payload); + const checked = exactCheck(payload, decoded as UnsafeCastForTest); + const message = pipe(checked, foldLeftRight); + + expect(getPaths(left(message.errors))).toEqual([ + 'Invalid value "invalid" supplied to "action_connectors_warnings"', + ]); + expect(message.schema).toEqual({}); + }); + }); +}); diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/import_rules/response_schema.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/import_rules/import_rules_route.ts similarity index 52% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/import_rules/response_schema.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/import_rules/import_rules_route.ts index 99212b902c4d3..46e8721c45679 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/import_rules/response_schema.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/import_rules/import_rules_route.ts @@ -6,8 +6,28 @@ */ import * as t from 'io-ts'; -import { PositiveInteger } from '@kbn/securitysolution-io-ts-types'; -import { errorSchema, warningSchema } from '../../../../schemas/response'; +import { DefaultStringBooleanFalse, PositiveInteger } from '@kbn/securitysolution-io-ts-types'; +import { errorSchema, warningSchema } from '../../model'; + +export const ImportRulesRequestQuery = t.exact( + t.partial({ + overwrite: DefaultStringBooleanFalse, + overwrite_exceptions: DefaultStringBooleanFalse, + overwrite_action_connectors: DefaultStringBooleanFalse, + as_new_list: DefaultStringBooleanFalse, + }) +); + +export type ImportRulesRequestQuery = t.TypeOf; +export type ImportRulesRequestQueryDecoded = Omit< + ImportRulesRequestQuery, + 'overwrite' | 'overwrite_exceptions' | 'as_new_list' | 'overwrite_action_connectors' +> & { + overwrite: boolean; + overwrite_exceptions: boolean; + overwrite_action_connectors: boolean; + as_new_list: boolean; +}; export type ImportRulesResponse = t.TypeOf; export const ImportRulesResponse = t.exact( diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/model/import/rule_to_import.mock.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/import_rules/rule_to_import.mock.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/model/import/rule_to_import.mock.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/import_rules/rule_to_import.mock.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/model/import/rule_to_import.test.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/import_rules/rule_to_import.test.ts similarity index 99% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/model/import/rule_to_import.test.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/import_rules/rule_to_import.test.ts index 84478b4af27fe..29ad45c10bf84 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/model/import/rule_to_import.test.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/import_rules/rule_to_import.test.ts @@ -9,7 +9,7 @@ import { left } from 'fp-ts/lib/Either'; import { pipe } from 'fp-ts/lib/pipeable'; import { exactCheck, foldLeftRight, getPaths } from '@kbn/securitysolution-io-ts-utils'; -import { getListArrayMock } from '../../../schemas/types/lists.mock'; +import { getListArrayMock } from '../../../../detection_engine/schemas/types/lists.mock'; import { RuleToImport } from './rule_to_import'; import { getImportRulesSchemaMock, diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/model/import/rule_to_import.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/import_rules/rule_to_import.ts similarity index 92% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/model/import/rule_to_import.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/import_rules/rule_to_import.ts index 8d9cee09a9f7b..1b01d913eaee2 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/model/import/rule_to_import.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/import_rules/rule_to_import.ts @@ -16,8 +16,12 @@ import { SetupGuide, BaseCreateProps, TypeSpecificCreateProps, -} from '../../../rule_schema'; -import { created_at, updated_at, created_by, updated_by, revision } from '../../../schemas/common'; + created_at, + updated_at, + created_by, + updated_by, + revision, +} from '../../model'; /** * Differences from this and the createRulesSchema are diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/model/import/rule_to_import_validation.test.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/import_rules/rule_to_import_validation.test.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/model/import/rule_to_import_validation.test.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/import_rules/rule_to_import_validation.test.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/model/import/rule_to_import_validation.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/import_rules/rule_to_import_validation.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/model/import/rule_to_import_validation.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/import_rules/rule_to_import_validation.ts diff --git a/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/index.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/index.ts new file mode 100644 index 0000000000000..bd9066d90a96e --- /dev/null +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/index.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. + */ + +export * from './bulk_actions/bulk_actions_route'; +export * from './bulk_crud/bulk_create_rules/bulk_create_rules_route'; +export * from './bulk_crud/bulk_delete_rules/bulk_delete_rules_route'; +export * from './bulk_crud/bulk_patch_rules/bulk_patch_rules_route'; +export * from './bulk_crud/bulk_update_rules/bulk_update_rules_route'; +export * from './bulk_crud/response_schema'; +export * from './coverage_overview/coverage_overview_route'; +export * from './crud/create_rule/request_schema_validation'; +export * from './crud/patch_rule/request_schema_validation'; +export * from './crud/patch_rule/patch_rule_route'; +export * from './crud/read_rule/read_rule_route'; +export * from './crud/update_rule/update_rule_route'; +export * from './crud/update_rule/request_schema_validation'; +export * from './export_rules/export_rules_details_schema'; +export * from './export_rules/export_rules_route'; +export * from './get_rule_management_filters/get_rule_management_filters_route'; +export * from './find_rules/request_schema'; +export * from './find_rules/request_schema_validation'; +export * from './import_rules/import_rules_route'; +export * from './import_rules/rule_to_import_validation'; +export * from './import_rules/rule_to_import'; +export * from './urls'; +export * from './model/query_rule_by_ids'; +export * from './model/query_rule_by_ids_validation'; diff --git a/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/mocks.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/mocks.ts new file mode 100644 index 0000000000000..24e6f6120238b --- /dev/null +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/mocks.ts @@ -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. + */ + +export * from './bulk_actions/bulk_actions_route.mock'; +export * from './crud/patch_rule/patch_rule_route.mock'; + +export * from './export_rules/export_rules_details_schema.mock'; +export * from './import_rules/rule_to_import.mock'; diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/crud/read_rule/query_rule_by_ids.test.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/model/query_rule_by_ids.test.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/crud/read_rule/query_rule_by_ids.test.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/model/query_rule_by_ids.test.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/crud/read_rule/query_rule_by_ids.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/model/query_rule_by_ids.ts similarity index 85% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/crud/read_rule/query_rule_by_ids.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/model/query_rule_by_ids.ts index d52d8c66125e6..2de0116d2875f 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/crud/read_rule/query_rule_by_ids.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/model/query_rule_by_ids.ts @@ -6,7 +6,7 @@ */ import * as t from 'io-ts'; -import { RuleObjectId, RuleSignatureId } from '../../../../../rule_schema'; +import { RuleObjectId, RuleSignatureId } from '../../model'; export type QueryRuleByIds = t.TypeOf; export const QueryRuleByIds = t.exact( diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/crud/read_rule/query_rule_by_ids_validation.test.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/model/query_rule_by_ids_validation.test.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/crud/read_rule/query_rule_by_ids_validation.test.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/model/query_rule_by_ids_validation.test.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/crud/read_rule/query_rule_by_ids_validation.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/model/query_rule_by_ids_validation.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/crud/read_rule/query_rule_by_ids_validation.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/model/query_rule_by_ids_validation.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/urls.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_management/urls.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_management/api/urls.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_management/urls.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/api/detection_engine_health/README.md b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/README.md similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/api/detection_engine_health/README.md rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/README.md diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/api/detection_engine_health/get_cluster_health_schemas.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/get_cluster_health/get_cluster_health_route.ts similarity index 83% rename from x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/api/detection_engine_health/get_cluster_health_schemas.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/get_cluster_health/get_cluster_health_route.ts index a4b28a2d1bc31..dafa1e4a4a1df 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/api/detection_engine_health/get_cluster_health_schemas.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/get_cluster_health/get_cluster_health_route.ts @@ -7,13 +7,13 @@ import * as t from 'io-ts'; import type { IsoDateString } from '@kbn/securitysolution-io-ts-types'; -import type { HealthInterval } from '../../model/detection_engine_health/health_interval'; -import { HealthIntervalParameters } from '../../model/detection_engine_health/health_interval'; -import type { HealthTimings } from '../../model/detection_engine_health/health_metadata'; import type { ClusterHealthParameters, ClusterHealthSnapshot, -} from '../../model/detection_engine_health/cluster_health'; + HealthInterval, + HealthTimings, +} from '../model'; +import { HealthIntervalParameters } from '../model'; /** * Schema for the request body of the endpoint. diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/api/detection_engine_health/get_rule_health_schemas.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/get_rule_health/get_rule_health_route.ts similarity index 84% rename from x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/api/detection_engine_health/get_rule_health_schemas.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/get_rule_health/get_rule_health_route.ts index 8f810549f54ee..c3c32edfd9a19 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/api/detection_engine_health/get_rule_health_schemas.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/get_rule_health/get_rule_health_route.ts @@ -9,13 +9,13 @@ import * as t from 'io-ts'; import type { IsoDateString } from '@kbn/securitysolution-io-ts-types'; import { NonEmptyString } from '@kbn/securitysolution-io-ts-types'; -import type { HealthInterval } from '../../model/detection_engine_health/health_interval'; -import { HealthIntervalParameters } from '../../model/detection_engine_health/health_interval'; -import type { HealthTimings } from '../../model/detection_engine_health/health_metadata'; import type { + HealthInterval, + HealthTimings, RuleHealthParameters, RuleHealthSnapshot, -} from '../../model/detection_engine_health/rule_health'; +} from '../model'; +import { HealthIntervalParameters } from '../model'; /** * Schema for the request body of the endpoint. diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/api/detection_engine_health/get_space_health_schemas.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/get_space_health/get_space_health_route.ts similarity index 82% rename from x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/api/detection_engine_health/get_space_health_schemas.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/get_space_health/get_space_health_route.ts index 4ad9a95a3f938..fe10178e5de9d 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/api/detection_engine_health/get_space_health_schemas.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/get_space_health/get_space_health_route.ts @@ -7,13 +7,13 @@ import * as t from 'io-ts'; import type { IsoDateString } from '@kbn/securitysolution-io-ts-types'; -import type { HealthInterval } from '../../model/detection_engine_health/health_interval'; -import { HealthIntervalParameters } from '../../model/detection_engine_health/health_interval'; -import type { HealthTimings } from '../../model/detection_engine_health/health_metadata'; import type { + HealthInterval, + HealthTimings, SpaceHealthParameters, SpaceHealthSnapshot, -} from '../../model/detection_engine_health/space_health'; +} from '../model'; +import { HealthIntervalParameters } from '../model'; /** * Schema for the request body of the endpoint. diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/detection_engine_health/cluster_health.mock.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/model/cluster_health.mock.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/detection_engine_health/cluster_health.mock.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/model/cluster_health.mock.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/detection_engine_health/cluster_health.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/model/cluster_health.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/detection_engine_health/cluster_health.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/model/cluster_health.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/detection_engine_health/health_interval.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/model/health_interval.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/detection_engine_health/health_interval.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/model/health_interval.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/detection_engine_health/health_metadata.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/model/health_metadata.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/detection_engine_health/health_metadata.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/model/health_metadata.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/detection_engine_health/health_stats.mock.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/model/health_stats.mock.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/detection_engine_health/health_stats.mock.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/model/health_stats.mock.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/detection_engine_health/health_stats.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/model/health_stats.ts similarity index 99% rename from x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/detection_engine_health/health_stats.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/model/health_stats.ts index e43a5bfbd3073..4af7ea8c6bd07 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/detection_engine_health/health_stats.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/model/health_stats.ts @@ -7,7 +7,7 @@ import type { IsoDateString } from '@kbn/securitysolution-io-ts-types'; import type { RuleLastRunOutcomes } from '@kbn/alerting-plugin/common'; -import type { LogLevel } from '../log_level'; +import type { LogLevel } from '../../model'; // ------------------------------------------------------------------------------------------------- // Stats history (date histogram) diff --git a/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/model/index.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/model/index.ts new file mode 100644 index 0000000000000..10d72d2241ec0 --- /dev/null +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/model/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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +export * from './cluster_health'; +export * from './health_interval'; +export * from './health_metadata'; +export * from './health_stats'; +export * from './rule_health'; +export * from './space_health'; diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/detection_engine_health/rule_health.mock.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/model/rule_health.mock.ts similarity index 92% rename from x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/detection_engine_health/rule_health.mock.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/model/rule_health.mock.ts index 2ae5b8a7a8205..961a057b2603e 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/detection_engine_health/rule_health.mock.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/model/rule_health.mock.ts @@ -5,7 +5,7 @@ * 2.0. */ -import { getRulesSchemaMock } from '../../../rule_schema/mocks'; +import { getRulesSchemaMock } from '../../../model/rule_schema/mocks'; import { healthStatsMock } from './health_stats.mock'; import type { RuleHealthSnapshot } from './rule_health'; diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/detection_engine_health/rule_health.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/model/rule_health.ts similarity index 94% rename from x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/detection_engine_health/rule_health.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/model/rule_health.ts index b0b3577a46967..59756df926e27 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/detection_engine_health/rule_health.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/model/rule_health.ts @@ -5,7 +5,7 @@ * 2.0. */ -import type { RuleResponse } from '../../../rule_schema/model/rule_schemas'; +import type { RuleResponse } from '../../../model'; import type { HealthParameters, HealthSnapshot } from './health_metadata'; import type { RuleExecutionStats, StatsHistory } from './health_stats'; diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/detection_engine_health/space_health.mock.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/model/space_health.mock.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/detection_engine_health/space_health.mock.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/model/space_health.mock.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/detection_engine_health/space_health.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/model/space_health.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/detection_engine_health/space_health.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/detection_engine_health/model/space_health.ts diff --git a/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/index.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/index.ts new file mode 100644 index 0000000000000..a2f5f76f00b08 --- /dev/null +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/index.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. + */ + +export * from './detection_engine_health/get_cluster_health/get_cluster_health_route'; +export * from './detection_engine_health/get_rule_health/get_rule_health_route'; +export * from './detection_engine_health/get_space_health/get_space_health_route'; +export * from './detection_engine_health/model'; +export * from './rule_execution_logs/get_rule_execution_events/get_rule_execution_events_route'; +export * from './rule_execution_logs/get_rule_execution_results/get_rule_execution_results_route'; +export * from './urls'; + +export * from './model/execution_event'; +export * from './model/execution_metrics'; +export * from './model/execution_result'; +export * from './model/execution_settings'; +export * from './model/execution_status'; +export * from './model/execution_summary'; +export * from './model/log_level'; diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/mocks.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/mocks.ts similarity index 50% rename from x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/mocks.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/mocks.ts index 1a93749849cdf..0c8c7a1cafad3 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/mocks.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/mocks.ts @@ -5,12 +5,12 @@ * 2.0. */ -export * from './api/rule_execution_logs/get_rule_execution_events_schemas.mock'; -export * from './api/rule_execution_logs/get_rule_execution_results_schemas.mock'; +export * from './rule_execution_logs/get_rule_execution_events/get_rule_execution_events_route.mock'; +export * from './rule_execution_logs/get_rule_execution_results/get_rule_execution_results_route.mock'; -export * from './model/detection_engine_health/cluster_health.mock'; -export * from './model/detection_engine_health/rule_health.mock'; -export * from './model/detection_engine_health/space_health.mock'; +export * from './detection_engine_health/model/cluster_health.mock'; +export * from './detection_engine_health/model/rule_health.mock'; +export * from './detection_engine_health/model/space_health.mock'; export * from './model/execution_event.mock'; export * from './model/execution_result.mock'; export * from './model/execution_summary.mock'; diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/execution_event.mock.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/execution_event.mock.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/execution_event.mock.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/execution_event.mock.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/execution_event.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/execution_event.ts similarity index 96% rename from x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/execution_event.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/execution_event.ts index 0e269b39ff8f1..3eaa2ca7efad0 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/execution_event.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/execution_event.ts @@ -7,7 +7,7 @@ import * as t from 'io-ts'; import { enumeration, IsoDateString } from '@kbn/securitysolution-io-ts-types'; -import { enumFromString } from '../../../utils/enum_from_string'; +import { enumFromString } from '../../../../utils/enum_from_string'; import { TLogLevel } from './log_level'; /** diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/execution_metrics.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/execution_metrics.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/execution_metrics.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/execution_metrics.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/execution_result.mock.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/execution_result.mock.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/execution_result.mock.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/execution_result.mock.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/execution_result.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/execution_result.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/execution_result.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/execution_result.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/execution_settings.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/execution_settings.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/execution_settings.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/execution_settings.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/execution_status.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/execution_status.ts similarity index 98% rename from x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/execution_status.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/execution_status.ts index af5049c8f9bf0..1e95e3a812054 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/execution_status.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/execution_status.ts @@ -8,7 +8,7 @@ import type * as t from 'io-ts'; import { enumeration, PositiveInteger } from '@kbn/securitysolution-io-ts-types'; import type { RuleLastRunOutcomes } from '@kbn/alerting-plugin/common'; -import { assertUnreachable } from '../../../utility_types'; +import { assertUnreachable } from '../../../../utility_types'; /** * Custom execution status of Security rules that is different from the status diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/execution_summary.mock.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/execution_summary.mock.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/execution_summary.mock.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/execution_summary.mock.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/execution_summary.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/execution_summary.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/execution_summary.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/execution_summary.ts diff --git a/x-pack/plugins/cases/common/api/connectors/index.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/index.ts similarity index 50% rename from x-pack/plugins/cases/common/api/connectors/index.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/index.ts index 33bb10cbcac1b..b486b9d80957a 100644 --- a/x-pack/plugins/cases/common/api/connectors/index.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/index.ts @@ -5,11 +5,10 @@ * 2.0. */ -export * from './jira'; -export * from './servicenow_itsm'; -export * from './servicenow_sir'; -export * from './resilient'; -export * from './mappings'; -export * from './swimlane'; -export * from './get_connectors'; -export * from './connector'; +export * from './execution_event'; +export * from './execution_metrics'; +export * from './execution_result'; +export * from './execution_settings'; +export * from './execution_status'; +export * from './execution_summary'; +export * from './log_level'; diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/log_level.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/log_level.ts similarity index 93% rename from x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/log_level.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/log_level.ts index b37ce62ad4891..9add3b46b3ef3 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/model/log_level.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/model/log_level.ts @@ -6,8 +6,8 @@ */ import { enumeration } from '@kbn/securitysolution-io-ts-types'; -import { enumFromString } from '../../../utils/enum_from_string'; -import { assertUnreachable } from '../../../utility_types'; +import { enumFromString } from '../../../../utils/enum_from_string'; +import { assertUnreachable } from '../../../../utility_types'; import { RuleExecutionStatus } from './execution_status'; export enum LogLevel { diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_events_schemas.mock.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/rule_execution_logs/get_rule_execution_events/get_rule_execution_events_route.mock.ts similarity index 96% rename from x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_events_schemas.mock.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/rule_execution_logs/get_rule_execution_events/get_rule_execution_events_route.mock.ts index 4d647b5f10094..b46f8d9b13870 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_events_schemas.mock.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/rule_execution_logs/get_rule_execution_events/get_rule_execution_events_route.mock.ts @@ -6,7 +6,7 @@ */ import { ruleExecutionEventMock } from '../../model/execution_event.mock'; -import type { GetRuleExecutionEventsResponse } from './get_rule_execution_events_schemas'; +import type { GetRuleExecutionEventsResponse } from './get_rule_execution_events_route'; const getSomeResponse = (): GetRuleExecutionEventsResponse => { const events = ruleExecutionEventMock.getSomeEvents(); diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_events_schemas.test.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/rule_execution_logs/get_rule_execution_events/get_rule_execution_events_route.test.ts similarity index 99% rename from x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_events_schemas.test.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/rule_execution_logs/get_rule_execution_events/get_rule_execution_events_route.test.ts index 89b7b992fbbad..ecf94032039ac 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_events_schemas.test.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/rule_execution_logs/get_rule_execution_events/get_rule_execution_events_route.test.ts @@ -12,7 +12,7 @@ import { foldLeftRight, getPaths } from '@kbn/securitysolution-io-ts-utils'; import { GetRuleExecutionEventsRequestParams, GetRuleExecutionEventsRequestQuery, -} from './get_rule_execution_events_schemas'; +} from './get_rule_execution_events_route'; describe('Request schema of Get rule execution events', () => { describe('GetRuleExecutionEventsRequestParams', () => { diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_events_schemas.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/rule_execution_logs/get_rule_execution_events/get_rule_execution_events_route.ts similarity index 90% rename from x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_events_schemas.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/rule_execution_logs/get_rule_execution_events/get_rule_execution_events_route.ts index 8c3c76e2286d9..9f5bd8d273efc 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_events_schemas.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/rule_execution_logs/get_rule_execution_events/get_rule_execution_events_route.ts @@ -10,9 +10,8 @@ import * as t from 'io-ts'; import { DefaultPerPage, DefaultPage } from '@kbn/securitysolution-io-ts-alerting-types'; import { defaultCsvArray, NonEmptyString } from '@kbn/securitysolution-io-ts-types'; -import { DefaultSortOrderDesc, PaginationResult } from '../../../schemas/common'; -import { RuleExecutionEvent, TRuleExecutionEventType } from '../../model/execution_event'; -import { TLogLevel } from '../../model/log_level'; +import { DefaultSortOrderDesc, PaginationResult } from '../../../model'; +import { RuleExecutionEvent, TRuleExecutionEventType, TLogLevel } from '../../model'; /** * URL path parameters of the API route. diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_results_schemas.mock.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/rule_execution_logs/get_rule_execution_results/get_rule_execution_results_route.mock.ts similarity index 95% rename from x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_results_schemas.mock.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/rule_execution_logs/get_rule_execution_results/get_rule_execution_results_route.mock.ts index b8e323e6fb1f3..9584616343332 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_results_schemas.mock.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/rule_execution_logs/get_rule_execution_results/get_rule_execution_results_route.mock.ts @@ -6,7 +6,7 @@ */ import { ruleExecutionResultMock } from '../../model/execution_result.mock'; -import type { GetRuleExecutionResultsResponse } from './get_rule_execution_results_schemas'; +import type { GetRuleExecutionResultsResponse } from './get_rule_execution_results_route'; const getSomeResponse = (): GetRuleExecutionResultsResponse => { const results = ruleExecutionResultMock.getSomeResults(); diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_results_schemas.test.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/rule_execution_logs/get_rule_execution_results/get_rule_execution_results_route.test.ts similarity index 99% rename from x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_results_schemas.test.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/rule_execution_logs/get_rule_execution_results/get_rule_execution_results_route.test.ts index 375047b935d24..53ed03003487e 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_results_schemas.test.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/rule_execution_logs/get_rule_execution_results/get_rule_execution_results_route.test.ts @@ -13,7 +13,7 @@ import { RULE_EXECUTION_STATUSES } from '../../model/execution_status'; import { DefaultSortField, DefaultRuleExecutionStatusCsvArray, -} from './get_rule_execution_results_schemas'; +} from './get_rule_execution_results_route'; describe('Request schema of Get rule execution results', () => { describe('DefaultRuleExecutionStatusCsvArray', () => { diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_results_schemas.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/rule_execution_logs/get_rule_execution_results/get_rule_execution_results_route.ts similarity index 91% rename from x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_results_schemas.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/rule_execution_logs/get_rule_execution_results/get_rule_execution_results_route.ts index e2cec9b7a3b29..56370acbce5bd 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/api/rule_execution_logs/get_rule_execution_results_schemas.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/rule_execution_logs/get_rule_execution_results/get_rule_execution_results_route.ts @@ -16,9 +16,12 @@ import { NonEmptyString, } from '@kbn/securitysolution-io-ts-types'; -import { DefaultSortOrderDesc } from '../../../schemas/common'; -import { RuleExecutionResult, SortFieldOfRuleExecutionResult } from '../../model/execution_result'; -import { TRuleExecutionStatus } from '../../model/execution_status'; +import { DefaultSortOrderDesc } from '../../../model'; +import { + RuleExecutionResult, + SortFieldOfRuleExecutionResult, + TRuleExecutionStatus, +} from '../../model'; /** * Types the DefaultRuleExecutionStatusCsvArray as: diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/api/urls.ts b/x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/urls.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/api/urls.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/rule_monitoring/urls.ts diff --git a/x-pack/plugins/security_solution/common/api/detection_engine/signals/index.ts b/x-pack/plugins/security_solution/common/api/detection_engine/signals/index.ts new file mode 100644 index 0000000000000..636728ee2525d --- /dev/null +++ b/x-pack/plugins/security_solution/common/api/detection_engine/signals/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 * from './query_signals/query_signals_route'; +export * from './set_signal_status/set_signal_status_route'; +export * from './set_signal_status/set_signal_status_type_dependents'; diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/request/query_signals_index_schema.test.ts b/x-pack/plugins/security_solution/common/api/detection_engine/signals/query_signals/query_signals_route.test.ts similarity index 96% rename from x-pack/plugins/security_solution/common/detection_engine/schemas/request/query_signals_index_schema.test.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/signals/query_signals/query_signals_route.test.ts index 41677055d6adf..6afdc9a07e8ab 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/schemas/request/query_signals_index_schema.test.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/signals/query_signals/query_signals_route.test.ts @@ -5,8 +5,8 @@ * 2.0. */ -import type { QuerySignalsSchema } from './query_signals_index_schema'; -import { querySignalsSchema } from './query_signals_index_schema'; +import type { QuerySignalsSchema } from './query_signals_route'; +import { querySignalsSchema } from './query_signals_route'; import { exactCheck, foldLeftRight, getPaths } from '@kbn/securitysolution-io-ts-utils'; import { pipe } from 'fp-ts/lib/pipeable'; import { left } from 'fp-ts/lib/Either'; diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/request/query_signals_index_schema.ts b/x-pack/plugins/security_solution/common/api/detection_engine/signals/query_signals/query_signals_route.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/schemas/request/query_signals_index_schema.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/signals/query_signals/query_signals_route.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/request/set_signal_status_schema.test.ts b/x-pack/plugins/security_solution/common/api/detection_engine/signals/set_signal_status/set_signal_status_route.test.ts similarity index 97% rename from x-pack/plugins/security_solution/common/detection_engine/schemas/request/set_signal_status_schema.test.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/signals/set_signal_status/set_signal_status_route.test.ts index ef5353c91213c..3f9e432fbc4f9 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/schemas/request/set_signal_status_schema.test.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/signals/set_signal_status/set_signal_status_route.test.ts @@ -5,8 +5,8 @@ * 2.0. */ -import type { SetSignalsStatusSchema } from './set_signal_status_schema'; -import { setSignalsStatusSchema } from './set_signal_status_schema'; +import type { SetSignalsStatusSchema } from './set_signal_status_route'; +import { setSignalsStatusSchema } from './set_signal_status_route'; import { exactCheck, foldLeftRight, getPaths } from '@kbn/securitysolution-io-ts-utils'; import { pipe } from 'fp-ts/lib/pipeable'; import { left } from 'fp-ts/lib/Either'; diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/request/set_signal_status_schema.ts b/x-pack/plugins/security_solution/common/api/detection_engine/signals/set_signal_status/set_signal_status_route.ts similarity index 96% rename from x-pack/plugins/security_solution/common/detection_engine/schemas/request/set_signal_status_schema.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/signals/set_signal_status/set_signal_status_route.ts index e6f07f973a098..78d62031d5eb3 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/schemas/request/set_signal_status_schema.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/signals/set_signal_status/set_signal_status_route.ts @@ -7,7 +7,7 @@ import * as t from 'io-ts'; -import { conflicts, signal_ids, signal_status_query, status } from '../common/schemas'; +import { conflicts, signal_ids, signal_status_query, status } from '../../model'; export const setSignalsStatusSchema = t.intersection([ t.type({ diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/request/set_signal_status_type_dependents.test.ts b/x-pack/plugins/security_solution/common/api/detection_engine/signals/set_signal_status/set_signal_status_type_dependents.test.ts similarity index 99% rename from x-pack/plugins/security_solution/common/detection_engine/schemas/request/set_signal_status_type_dependents.test.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/signals/set_signal_status/set_signal_status_type_dependents.test.ts index efe5e6cedd303..97cf74435c294 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/schemas/request/set_signal_status_type_dependents.test.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/signals/set_signal_status/set_signal_status_type_dependents.test.ts @@ -6,7 +6,7 @@ */ import { setSignalStatusValidateTypeDependents } from './set_signal_status_type_dependents'; -import type { SetSignalsStatusSchema } from './set_signal_status_schema'; +import type { SetSignalsStatusSchema } from './set_signal_status_route'; describe('update_rules_type_dependents', () => { test('You can have just a "signals_id"', () => { diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/request/set_signal_status_type_dependents.ts b/x-pack/plugins/security_solution/common/api/detection_engine/signals/set_signal_status/set_signal_status_type_dependents.ts similarity index 98% rename from x-pack/plugins/security_solution/common/detection_engine/schemas/request/set_signal_status_type_dependents.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/signals/set_signal_status/set_signal_status_type_dependents.ts index 38ec66493ea39..a484fde33d107 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/schemas/request/set_signal_status_type_dependents.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/signals/set_signal_status/set_signal_status_type_dependents.ts @@ -5,7 +5,7 @@ * 2.0. */ -import type { SetSignalsStatusSchema } from './set_signal_status_schema'; +import type { SetSignalsStatusSchema } from './set_signal_status_route'; export const validateId = (signalStatus: SetSignalsStatusSchema): string[] => { if (signalStatus.signal_ids != null && signalStatus.query != null) { diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/request/create_signals_migration_schema.mock.ts b/x-pack/plugins/security_solution/common/api/detection_engine/signals_migration/create_signals_migration/create_signals_migration_route.mock.ts similarity index 95% rename from x-pack/plugins/security_solution/common/detection_engine/schemas/request/create_signals_migration_schema.mock.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/signals_migration/create_signals_migration/create_signals_migration_route.mock.ts index 19b409e8eab95..ccb5543ef72d2 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/schemas/request/create_signals_migration_schema.mock.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/signals_migration/create_signals_migration/create_signals_migration_route.mock.ts @@ -5,7 +5,7 @@ * 2.0. */ -import type { CreateSignalsMigrationSchema } from './create_signals_migration_schema'; +import type { CreateSignalsMigrationSchema } from './create_signals_migration_route'; export const getCreateSignalsMigrationSchemaMock = ( index: string = 'signals-index' diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/request/create_signals_migration_schema.ts b/x-pack/plugins/security_solution/common/api/detection_engine/signals_migration/create_signals_migration/create_signals_migration_route.ts similarity index 94% rename from x-pack/plugins/security_solution/common/detection_engine/schemas/request/create_signals_migration_schema.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/signals_migration/create_signals_migration/create_signals_migration_route.ts index 1eba4855bf0d3..cb67964ea7745 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/schemas/request/create_signals_migration_schema.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/signals_migration/create_signals_migration/create_signals_migration_route.ts @@ -8,7 +8,7 @@ import * as t from 'io-ts'; import { PositiveInteger, PositiveIntegerGreaterThanZero } from '@kbn/securitysolution-io-ts-types'; -import { IndexPatternArray } from '../../rule_schema'; +import { IndexPatternArray } from '../../model'; export const signalsReindexOptions = t.partial({ requests_per_second: t.number, diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/request/delete_signals_migration_schema.ts b/x-pack/plugins/security_solution/common/api/detection_engine/signals_migration/delete_signals_migration/delete_signals_migration_route.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/schemas/request/delete_signals_migration_schema.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/signals_migration/delete_signals_migration/delete_signals_migration_route.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/request/finalize_signals_migration_schema.mock.ts b/x-pack/plugins/security_solution/common/api/detection_engine/signals_migration/finalize_signals_migration/finalize_signals_migration_route.mock.ts similarity index 94% rename from x-pack/plugins/security_solution/common/detection_engine/schemas/request/finalize_signals_migration_schema.mock.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/signals_migration/finalize_signals_migration/finalize_signals_migration_route.mock.ts index b6b7a54cd533b..25d66c5b68d09 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/schemas/request/finalize_signals_migration_schema.mock.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/signals_migration/finalize_signals_migration/finalize_signals_migration_route.mock.ts @@ -5,7 +5,7 @@ * 2.0. */ -import type { FinalizeSignalsMigrationSchema } from './finalize_signals_migration_schema'; +import type { FinalizeSignalsMigrationSchema } from './finalize_signals_migration_route'; export const getFinalizeSignalsMigrationSchemaMock = (): FinalizeSignalsMigrationSchema => ({ migration_ids: ['migrationSOIdentifier'], diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/request/finalize_signals_migration_schema.ts b/x-pack/plugins/security_solution/common/api/detection_engine/signals_migration/finalize_signals_migration/finalize_signals_migration_route.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/schemas/request/finalize_signals_migration_schema.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/signals_migration/finalize_signals_migration/finalize_signals_migration_route.ts diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/request/get_signals_migration_status_schema.mock.ts b/x-pack/plugins/security_solution/common/api/detection_engine/signals_migration/get_signals_migration_status/get_signals_migration_status_route.mock.ts similarity index 93% rename from x-pack/plugins/security_solution/common/detection_engine/schemas/request/get_signals_migration_status_schema.mock.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/signals_migration/get_signals_migration_status/get_signals_migration_status_route.mock.ts index 0de1cf9ea8456..8cc78ffa9700e 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/schemas/request/get_signals_migration_status_schema.mock.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/signals_migration/get_signals_migration_status/get_signals_migration_status_route.mock.ts @@ -5,7 +5,7 @@ * 2.0. */ -import type { GetSignalsMigrationStatusSchema } from './get_signals_migration_status_schema'; +import type { GetSignalsMigrationStatusSchema } from './get_signals_migration_status_route'; export const getSignalsMigrationStatusSchemaMock = (): GetSignalsMigrationStatusSchema => ({ from: 'now-30d', diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/request/get_signals_migration_status_schema.ts b/x-pack/plugins/security_solution/common/api/detection_engine/signals_migration/get_signals_migration_status/get_signals_migration_status_route.ts similarity index 100% rename from x-pack/plugins/security_solution/common/detection_engine/schemas/request/get_signals_migration_status_schema.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/signals_migration/get_signals_migration_status/get_signals_migration_status_route.ts diff --git a/x-pack/plugins/security_solution/common/api/detection_engine/signals_migration/index.ts b/x-pack/plugins/security_solution/common/api/detection_engine/signals_migration/index.ts new file mode 100644 index 0000000000000..78452dc62f46c --- /dev/null +++ b/x-pack/plugins/security_solution/common/api/detection_engine/signals_migration/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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +export * from './create_signals_migration/create_signals_migration_route'; +export * from './delete_signals_migration/delete_signals_migration_route'; +export * from './finalize_signals_migration/finalize_signals_migration_route'; +export * from './get_signals_migration_status/get_signals_migration_status_route'; diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_schema/mocks.ts b/x-pack/plugins/security_solution/common/api/detection_engine/signals_migration/mocks.ts similarity index 50% rename from x-pack/plugins/security_solution/common/detection_engine/rule_schema/mocks.ts rename to x-pack/plugins/security_solution/common/api/detection_engine/signals_migration/mocks.ts index 6cf0d49e9560a..90713ec3a1881 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_schema/mocks.ts +++ b/x-pack/plugins/security_solution/common/api/detection_engine/signals_migration/mocks.ts @@ -5,5 +5,6 @@ * 2.0. */ -export * from './model/rule_request_schema.mock'; -export * from './model/rule_response_schema.mock'; +export * from './create_signals_migration/create_signals_migration_route.mock'; +export * from './finalize_signals_migration/finalize_signals_migration_route.mock'; +export * from './get_signals_migration_status/get_signals_migration_status_route.mock'; diff --git a/x-pack/plugins/security_solution/server/lib/timeline/schemas/draft_timelines/clean_draft_timelines_schema.ts b/x-pack/plugins/security_solution/common/api/timeline/clean_draft_timelines/clean_draft_timelines_route.ts similarity index 82% rename from x-pack/plugins/security_solution/server/lib/timeline/schemas/draft_timelines/clean_draft_timelines_schema.ts rename to x-pack/plugins/security_solution/common/api/timeline/clean_draft_timelines/clean_draft_timelines_route.ts index 7dd0de2258a6b..fd967824370ea 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/schemas/draft_timelines/clean_draft_timelines_schema.ts +++ b/x-pack/plugins/security_solution/common/api/timeline/clean_draft_timelines/clean_draft_timelines_route.ts @@ -7,7 +7,7 @@ import * as rt from 'io-ts'; -import { TimelineTypeLiteralRt } from '../../../../../common/types/timeline/api'; +import { TimelineTypeLiteralRt } from '../model/api'; export const cleanDraftTimelineSchema = rt.type({ timelineType: TimelineTypeLiteralRt, diff --git a/x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/create_timelines_schema.ts b/x-pack/plugins/security_solution/common/api/timeline/create_timelines/create_timelines_route.ts similarity index 77% rename from x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/create_timelines_schema.ts rename to x-pack/plugins/security_solution/common/api/timeline/create_timelines/create_timelines_route.ts index 800fba1477c41..1911df3941a35 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/create_timelines_schema.ts +++ b/x-pack/plugins/security_solution/common/api/timeline/create_timelines/create_timelines_route.ts @@ -7,12 +7,13 @@ import * as rt from 'io-ts'; +import type { ResponseTimeline } from '../model/api'; import { SavedTimelineRuntimeType, TimelineStatusLiteralRt, TimelineTypeLiteralRt, -} from '../../../../../common/types/timeline/api'; -import { unionWithNullType } from '../../../../../common/utility_types'; +} from '../model/api'; +import { unionWithNullType } from '../../../utility_types'; export const createTimelineSchema = rt.intersection([ rt.type({ @@ -27,3 +28,9 @@ export const createTimelineSchema = rt.intersection([ version: unionWithNullType(rt.string), }), ]); + +export interface CreateTimelinesResponse { + data: { + persistTimeline: ResponseTimeline; + }; +} diff --git a/x-pack/plugins/security_solution/common/api/timeline/delete_note/delete_note_route.ts b/x-pack/plugins/security_solution/common/api/timeline/delete_note/delete_note_route.ts new file mode 100644 index 0000000000000..af5dbaf394d81 --- /dev/null +++ b/x-pack/plugins/security_solution/common/api/timeline/delete_note/delete_note_route.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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import * as runtimeTypes from 'io-ts'; +import { unionWithNullType } from '../../../utility_types'; + +export const deleteNoteSchema = runtimeTypes.partial({ + noteId: unionWithNullType(runtimeTypes.string), +}); diff --git a/x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/delete_timelines_schema.ts b/x-pack/plugins/security_solution/common/api/timeline/delete_timelines/delete_timelines_route.ts similarity index 100% rename from x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/delete_timelines_schema.ts rename to x-pack/plugins/security_solution/common/api/timeline/delete_timelines/delete_timelines_route.ts diff --git a/x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/export_timelines_schema.ts b/x-pack/plugins/security_solution/common/api/timeline/export_timelines/export_timelines_route.ts similarity index 86% rename from x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/export_timelines_schema.ts rename to x-pack/plugins/security_solution/common/api/timeline/export_timelines/export_timelines_route.ts index 778e692b2c0ed..cc391a47e0b9e 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/export_timelines_schema.ts +++ b/x-pack/plugins/security_solution/common/api/timeline/export_timelines/export_timelines_route.ts @@ -6,7 +6,7 @@ */ import * as rt from 'io-ts'; -import { unionWithNullType } from '../../../../../common/utility_types'; +import { unionWithNullType } from '../../../utility_types'; export const exportTimelinesQuerySchema = rt.type({ file_name: rt.string, diff --git a/x-pack/plugins/security_solution/server/lib/timeline/schemas/draft_timelines/get_draft_timelines_schema.ts b/x-pack/plugins/security_solution/common/api/timeline/get_draft_timelines/get_draft_timelines_route.ts similarity index 82% rename from x-pack/plugins/security_solution/server/lib/timeline/schemas/draft_timelines/get_draft_timelines_schema.ts rename to x-pack/plugins/security_solution/common/api/timeline/get_draft_timelines/get_draft_timelines_route.ts index d995bcedbfb2b..13625715289f6 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/schemas/draft_timelines/get_draft_timelines_schema.ts +++ b/x-pack/plugins/security_solution/common/api/timeline/get_draft_timelines/get_draft_timelines_route.ts @@ -7,7 +7,7 @@ import * as rt from 'io-ts'; -import { TimelineTypeLiteralRt } from '../../../../../common/types/timeline/api'; +import { TimelineTypeLiteralRt } from '../model/api'; export const getDraftTimelineSchema = rt.type({ timelineType: TimelineTypeLiteralRt, diff --git a/x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/get_timeline_schema.ts b/x-pack/plugins/security_solution/common/api/timeline/get_timeline/get_timeline_route.ts similarity index 100% rename from x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/get_timeline_schema.ts rename to x-pack/plugins/security_solution/common/api/timeline/get_timeline/get_timeline_route.ts diff --git a/x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/get_timelines_schema.ts b/x-pack/plugins/security_solution/common/api/timeline/get_timelines/get_timelines_route.ts similarity index 87% rename from x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/get_timelines_schema.ts rename to x-pack/plugins/security_solution/common/api/timeline/get_timelines/get_timelines_route.ts index 3fedcab33d83d..9f35197358aea 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/get_timelines_schema.ts +++ b/x-pack/plugins/security_solution/common/api/timeline/get_timelines/get_timelines_route.ts @@ -11,8 +11,8 @@ import { sortFieldTimeline, TimelineStatusLiteralRt, TimelineTypeLiteralRt, -} from '../../../../../common/types/timeline/api'; -import { unionWithNullType } from '../../../../../common/utility_types'; +} from '../model/api'; +import { unionWithNullType } from '../../../utility_types'; const BoolFromString = rt.union([rt.literal('true'), rt.literal('false')]); diff --git a/x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/import_timelines_schema.ts b/x-pack/plugins/security_solution/common/api/timeline/import_timelines/import_timelines_route.ts similarity index 78% rename from x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/import_timelines_schema.ts rename to x-pack/plugins/security_solution/common/api/timeline/import_timelines/import_timelines_route.ts index 3858f3886084f..ecd40bab9476b 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/import_timelines_schema.ts +++ b/x-pack/plugins/security_solution/common/api/timeline/import_timelines/import_timelines_route.ts @@ -7,11 +7,13 @@ import * as rt from 'io-ts'; -import { SavedTimelineRuntimeType } from '../../../../../common/types/timeline/api'; -import { unionWithNullType } from '../../../../../common/utility_types'; +import { BareNoteSchema, SavedTimelineRuntimeType } from '../model/api'; +import { unionWithNullType } from '../../../utility_types'; -import { eventNotes, globalNotes } from '../notes'; -import { pinnedEventIds } from '../pinned_events'; +import { pinnedEventIds } from '../pinned_events/pinned_events_route'; + +export const eventNotes = unionWithNullType(rt.array(BareNoteSchema)); +export const globalNotes = unionWithNullType(rt.array(BareNoteSchema)); export const ImportTimelinesSchemaRt = rt.intersection([ SavedTimelineRuntimeType, diff --git a/x-pack/plugins/security_solution/common/api/timeline/index.ts b/x-pack/plugins/security_solution/common/api/timeline/index.ts new file mode 100644 index 0000000000000..4a0858b72fea3 --- /dev/null +++ b/x-pack/plugins/security_solution/common/api/timeline/index.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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +export * from './model/api'; +export * from './clean_draft_timelines/clean_draft_timelines_route'; +export * from './get_draft_timelines/get_draft_timelines_route'; +export * from './create_timelines/create_timelines_route'; +export * from './delete_note/delete_note_route'; +export * from './delete_timelines/delete_timelines_route'; +export * from './export_timelines/export_timelines_route'; +export * from './get_timeline/get_timeline_route'; +export * from './get_timelines/get_timelines_route'; +export * from './import_timelines/import_timelines_route'; +export * from './patch_timelines/patch_timelines_schema'; +export * from './persist_favorite/persist_favorite_schema'; +export * from './persist_note/persist_note_route'; +export * from './pinned_events/pinned_events_route'; diff --git a/x-pack/plugins/security_solution/common/types/timeline/api.ts b/x-pack/plugins/security_solution/common/api/timeline/model/api.ts similarity index 92% rename from x-pack/plugins/security_solution/common/types/timeline/api.ts rename to x-pack/plugins/security_solution/common/api/timeline/model/api.ts index 896405d30ac82..230cf122dcbf6 100644 --- a/x-pack/plugins/security_solution/common/types/timeline/api.ts +++ b/x-pack/plugins/security_solution/common/api/timeline/model/api.ts @@ -8,24 +8,61 @@ import * as runtimeTypes from 'io-ts'; import { PositiveInteger } from '@kbn/securitysolution-io-ts-types'; -import { stringEnum, unionWithNullType } from '../../utility_types'; +import { stringEnum, unionWithNullType } from '../../../utility_types'; -import type { Maybe } from '../../search_strategy'; -import { Direction } from '../../search_strategy'; -import type { PinnedEvent } from './pinned_event/api'; -import { PinnedEventRuntimeType } from './pinned_event/api'; +import type { Maybe } from '../../../search_strategy'; +import { Direction } from '../../../search_strategy'; +import type { PinnedEvent } from '../pinned_events/pinned_events_route'; +import { PinnedEventRuntimeType } from '../pinned_events/pinned_events_route'; import { SavedObjectResolveAliasPurpose, SavedObjectResolveAliasTargetId, SavedObjectResolveOutcome, -} from '../../detection_engine/rule_schema'; -import { - success, - success_count as successCount, -} from '../../detection_engine/schemas/common/schemas'; -import { errorSchema } from '../../detection_engine/schemas/response/error_schema'; -import type { Note } from './note/api'; -import { NoteRuntimeType } from './note/api'; +} from '../../detection_engine/model/rule_schema'; +import { errorSchema, success, success_count as successCount } from '../../detection_engine'; + +export const BareNoteSchema = runtimeTypes.intersection([ + runtimeTypes.type({ + timelineId: unionWithNullType(runtimeTypes.string), + }), + runtimeTypes.partial({ + eventId: unionWithNullType(runtimeTypes.string), + note: unionWithNullType(runtimeTypes.string), + created: unionWithNullType(runtimeTypes.number), + createdBy: unionWithNullType(runtimeTypes.string), + updated: unionWithNullType(runtimeTypes.number), + updatedBy: unionWithNullType(runtimeTypes.string), + }), +]); + +export type BareNote = runtimeTypes.TypeOf; + +/** + * This type represents a note type stored in a saved object that does not include any fields that reference + * other saved objects. + */ +export type BareNoteWithoutExternalRefs = Omit; + +export const NoteRuntimeType = runtimeTypes.intersection([ + BareNoteSchema, + runtimeTypes.type({ + noteId: runtimeTypes.string, + version: runtimeTypes.string, + }), + runtimeTypes.partial({ + timelineVersion: unionWithNullType(runtimeTypes.string), + }), +]); + +export type Note = runtimeTypes.TypeOf; + +export interface ResponseNote { + code?: Maybe; + + message?: Maybe; + + note: Note; +} /* * ColumnHeader Types @@ -636,6 +673,7 @@ export interface ResponseTimeline { message?: Maybe; timeline: TimelineResult; } + export interface SortTimeline { sortField: SortFieldTimeline; sortOrder: Direction; diff --git a/x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/patch_timelines_schema.ts b/x-pack/plugins/security_solution/common/api/timeline/patch_timelines/patch_timelines_schema.ts similarity index 62% rename from x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/patch_timelines_schema.ts rename to x-pack/plugins/security_solution/common/api/timeline/patch_timelines/patch_timelines_schema.ts index c5061730c3c54..149dc24480d2d 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/patch_timelines_schema.ts +++ b/x-pack/plugins/security_solution/common/api/timeline/patch_timelines/patch_timelines_schema.ts @@ -7,11 +7,18 @@ import * as rt from 'io-ts'; -import { SavedTimelineRuntimeType } from '../../../../../common/types/timeline/api'; -import { unionWithNullType } from '../../../../../common/utility_types'; +import type { ResponseTimeline } from '../model/api'; +import { SavedTimelineRuntimeType } from '../model/api'; +import { unionWithNullType } from '../../../utility_types'; export const patchTimelineSchema = rt.type({ timeline: SavedTimelineRuntimeType, timelineId: unionWithNullType(rt.string), version: unionWithNullType(rt.string), }); + +export interface PatchTimelinesResponse { + data: { + persistTimeline: ResponseTimeline; + }; +} diff --git a/x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/persist_favorite_schema.ts b/x-pack/plugins/security_solution/common/api/timeline/persist_favorite/persist_favorite_schema.ts similarity index 77% rename from x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/persist_favorite_schema.ts rename to x-pack/plugins/security_solution/common/api/timeline/persist_favorite/persist_favorite_schema.ts index 7b3be78b426f9..0f4adff41c910 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/schemas/timelines/persist_favorite_schema.ts +++ b/x-pack/plugins/security_solution/common/api/timeline/persist_favorite/persist_favorite_schema.ts @@ -7,8 +7,8 @@ import * as rt from 'io-ts'; -import { TimelineTypeLiteralRt } from '../../../../../common/types/timeline/api'; -import { unionWithNullType } from '../../../../../common/utility_types'; +import { TimelineTypeLiteralRt } from '../model/api'; +import { unionWithNullType } from '../../../utility_types'; export const persistFavoriteSchema = rt.type({ timelineId: unionWithNullType(rt.string), diff --git a/x-pack/plugins/security_solution/server/lib/timeline/schemas/notes/index.ts b/x-pack/plugins/security_solution/common/api/timeline/persist_note/persist_note_route.ts similarity index 58% rename from x-pack/plugins/security_solution/server/lib/timeline/schemas/notes/index.ts rename to x-pack/plugins/security_solution/common/api/timeline/persist_note/persist_note_route.ts index 9aa18b93ef60a..b588e6829aaba 100644 --- a/x-pack/plugins/security_solution/server/lib/timeline/schemas/notes/index.ts +++ b/x-pack/plugins/security_solution/common/api/timeline/persist_note/persist_note_route.ts @@ -6,11 +6,8 @@ */ import * as runtimeTypes from 'io-ts'; -import { unionWithNullType } from '../../../../../common/utility_types'; -import { BareNoteSchema } from '../../../../../common/types/timeline/note/api'; - -export const eventNotes = unionWithNullType(runtimeTypes.array(BareNoteSchema)); -export const globalNotes = unionWithNullType(runtimeTypes.array(BareNoteSchema)); +import { unionWithNullType } from '../../../utility_types'; +import { BareNoteSchema } from '../model/api'; export const persistNoteSchema = runtimeTypes.intersection([ runtimeTypes.type({ @@ -22,7 +19,3 @@ export const persistNoteSchema = runtimeTypes.intersection([ version: unionWithNullType(runtimeTypes.string), }), ]); - -export const deleteNoteSchema = runtimeTypes.partial({ - noteId: unionWithNullType(runtimeTypes.string), -}); diff --git a/x-pack/plugins/security_solution/common/types/timeline/pinned_event/api.ts b/x-pack/plugins/security_solution/common/api/timeline/pinned_events/pinned_events_route.ts similarity index 81% rename from x-pack/plugins/security_solution/common/types/timeline/pinned_event/api.ts rename to x-pack/plugins/security_solution/common/api/timeline/pinned_events/pinned_events_route.ts index f5e9e2373a268..f446e4e065b35 100644 --- a/x-pack/plugins/security_solution/common/types/timeline/pinned_event/api.ts +++ b/x-pack/plugins/security_solution/common/api/timeline/pinned_events/pinned_events_route.ts @@ -8,9 +8,19 @@ /* eslint-disable @typescript-eslint/no-empty-interface */ import * as runtimeTypes from 'io-ts'; - import { unionWithNullType } from '../../../utility_types'; +export const pinnedEventIds = unionWithNullType(runtimeTypes.array(runtimeTypes.string)); +export const persistPinnedEventSchema = runtimeTypes.intersection([ + runtimeTypes.type({ + eventId: runtimeTypes.string, + }), + runtimeTypes.partial({ + pinnedEventId: unionWithNullType(runtimeTypes.string), + timelineId: unionWithNullType(runtimeTypes.string), + }), +]); + /* * Note Types */ diff --git a/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/api/perform_rule_installation/perform_rule_installation_response_schema.ts b/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/api/perform_rule_installation/perform_rule_installation_response_schema.ts deleted file mode 100644 index fdd51dc256333..0000000000000 --- a/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/api/perform_rule_installation/perform_rule_installation_response_schema.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 type { RuleResponse } from '../../../rule_schema/model/rule_schemas'; -import type { AggregatedPrebuiltRuleError } from '../../model/prebuilt_rules/aggregated_prebuilt_rules_error'; - -export enum SkipRuleInstallReason { - ALREADY_INSTALLED = 'ALREADY_INSTALLED', -} - -export interface SkippedRuleInstall { - rule_id: string; - reason: SkipRuleInstallReason; -} - -export interface PerformRuleInstallationResponseBody { - summary: { - total: number; - succeeded: number; - skipped: number; - failed: number; - }; - results: { - created: RuleResponse[]; - skipped: SkippedRuleInstall[]; - }; - errors: AggregatedPrebuiltRuleError[]; -} diff --git a/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/api/perform_rule_upgrade/perform_rule_upgrade_response_schema.ts b/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/api/perform_rule_upgrade/perform_rule_upgrade_response_schema.ts deleted file mode 100644 index 875d9fe42e790..0000000000000 --- a/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/api/perform_rule_upgrade/perform_rule_upgrade_response_schema.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 type { RuleResponse } from '../../../rule_schema'; -import type { AggregatedPrebuiltRuleError } from '../../model/prebuilt_rules/aggregated_prebuilt_rules_error'; - -export enum SkipRuleUpgradeReason { - RULE_UP_TO_DATE = 'RULE_UP_TO_DATE', -} - -export interface SkippedRuleUpgrade { - rule_id: string; - reason: SkipRuleUpgradeReason; -} - -export interface PerformRuleUpgradeResponseBody { - summary: { - total: number; - succeeded: number; - skipped: number; - failed: number; - }; - results: { - updated: RuleResponse[]; - skipped: SkippedRuleUpgrade[]; - }; - errors: AggregatedPrebuiltRuleError[]; -} diff --git a/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/index.ts b/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/index.ts deleted file mode 100644 index 20669682c63f9..0000000000000 --- a/x-pack/plugins/security_solution/common/detection_engine/prebuilt_rules/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; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -export * from './api/get_prebuilt_rules_and_timelines_status/response_schema'; -export * from './api/install_prebuilt_rules_and_timelines/response_schema'; -export * from './api/urls'; diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_exceptions/api/find_exception_references/request_schema.test.ts b/x-pack/plugins/security_solution/common/detection_engine/rule_exceptions/api/find_exception_references/request_schema.test.ts deleted file mode 100644 index 644924e362d08..0000000000000 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_exceptions/api/find_exception_references/request_schema.test.ts +++ /dev/null @@ -1,94 +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 { exactCheck, formatErrors, foldLeftRight } from '@kbn/securitysolution-io-ts-utils'; -import { findExceptionReferencesOnRuleSchema } from './request_schema'; -import type { FindExceptionReferencesOnRuleSchema } from './request_schema'; - -describe('Find exception list references schema', () => { - test('validates all fields', () => { - const payload: FindExceptionReferencesOnRuleSchema = { - ids: 'abc,def', - list_ids: '123,456', - namespace_types: 'single,agnostic', - }; - - const decoded = findExceptionReferencesOnRuleSchema.decode(payload); - const checked = exactCheck(payload, decoded); - const output = foldLeftRight(checked); - expect(formatErrors(output.errors)).toEqual([]); - expect(output.schema).toEqual({ - ids: ['abc', 'def'], - list_ids: ['123', '456'], - namespace_types: ['single', 'agnostic'], - }); - }); - - test('"ids" can be optional', () => { - const payload: Omit = { - list_ids: '123,456', - namespace_types: 'single,agnostic', - }; - - const decoded = findExceptionReferencesOnRuleSchema.decode(payload); - const checked = exactCheck(payload, decoded); - const output = foldLeftRight(checked); - expect(formatErrors(output.errors)).toEqual([]); - expect(output.schema).toEqual({ - list_ids: ['123', '456'], - namespace_types: ['single', 'agnostic'], - }); - }); - - test('"list_ids" can be undefined', () => { - const payload: Omit = { - ids: 'abc', - namespace_types: 'single', - }; - - const decoded = findExceptionReferencesOnRuleSchema.decode(payload); - const checked = exactCheck(payload, decoded); - const output = foldLeftRight(checked); - expect(formatErrors(output.errors)).toEqual([]); - expect(output.schema).toEqual({ - ids: ['abc'], - namespace_types: ['single'], - }); - }); - - test('defaults "namespacetypes" to ["single"] if none set', () => { - const payload: Omit = { - ids: 'abc', - list_ids: '123', - }; - - const decoded = findExceptionReferencesOnRuleSchema.decode(payload); - const checked = exactCheck(payload, decoded); - const output = foldLeftRight(checked); - expect(formatErrors(output.errors)).toEqual([]); - expect(output.schema).toEqual({ - ids: ['abc'], - list_ids: ['123'], - namespace_types: ['single'], - }); - }); - - test('cannot add extra values', () => { - const payload: FindExceptionReferencesOnRuleSchema & { extra_value?: string } = { - ids: 'abc,def', - list_ids: '123,456', - namespace_types: 'single,agnostic', - extra_value: 'aaa', - }; - - const decoded = findExceptionReferencesOnRuleSchema.decode(payload); - const checked = exactCheck(payload, decoded); - const output = foldLeftRight(checked); - expect(formatErrors(output.errors)).toEqual(['invalid keys "extra_value"']); - expect(output.schema).toEqual({}); - }); -}); diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_exceptions/api/find_exception_references/request_schema.ts b/x-pack/plugins/security_solution/common/detection_engine/rule_exceptions/api/find_exception_references/request_schema.ts deleted file mode 100644 index 367f0c157ebfc..0000000000000 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_exceptions/api/find_exception_references/request_schema.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; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import * as t from 'io-ts'; -import { NonEmptyStringArray } from '@kbn/securitysolution-io-ts-types'; -import { DefaultNamespaceArray } from '@kbn/securitysolution-io-ts-list-types'; - -// If ids and list_ids are undefined, route will fetch all lists matching the -// specified namespace type -export const findExceptionReferencesOnRuleSchema = t.intersection([ - t.exact( - t.type({ - namespace_types: DefaultNamespaceArray, - }) - ), - t.exact( - t.partial({ - ids: NonEmptyStringArray, - list_ids: NonEmptyStringArray, - }) - ), -]); - -export type FindExceptionReferencesOnRuleSchema = t.OutputOf< - typeof findExceptionReferencesOnRuleSchema ->; - -export type FindExceptionReferencesOnRuleSchemaDecoded = t.TypeOf< - typeof findExceptionReferencesOnRuleSchema ->; diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_exceptions/api/find_exception_references/response_schema.test.ts b/x-pack/plugins/security_solution/common/detection_engine/rule_exceptions/api/find_exception_references/response_schema.test.ts deleted file mode 100644 index c899ad46c3628..0000000000000 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_exceptions/api/find_exception_references/response_schema.test.ts +++ /dev/null @@ -1,159 +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 { exactCheck, formatErrors, foldLeftRight } from '@kbn/securitysolution-io-ts-utils'; -import { getExceptionListSchemaMock } from '@kbn/lists-plugin/common/schemas/response/exception_list_schema.mock'; -import { - exceptionListRuleReferencesSchema, - rulesReferencedByExceptionListsSchema, -} from './response_schema'; -import type { - ExceptionListRuleReferencesSchema, - RulesReferencedByExceptionListsSchema, -} from './response_schema'; - -describe('Find exception list references response schema', () => { - describe('exceptionListRuleReferencesSchema', () => { - test('validates all fields', () => { - const payload: ExceptionListRuleReferencesSchema = { - ...getExceptionListSchemaMock(), - referenced_rules: [ - { - name: 'My rule', - id: '4656dc92-5832-11ea-8e2d-0242ac130003', - rule_id: 'my-rule-id', - exception_lists: [ - { - id: 'myListId', - list_id: 'my-list-id', - namespace_type: 'single', - type: 'detection', - }, - ], - }, - ], - }; - - const decoded = exceptionListRuleReferencesSchema.decode(payload); - const checked = exactCheck(payload, decoded); - const output = foldLeftRight(checked); - expect(formatErrors(output.errors)).toEqual([]); - expect(output.schema).toEqual(payload); - }); - - test('cannot add extra values', () => { - const payload: ExceptionListRuleReferencesSchema & { extra_value?: string } = { - extra_value: 'foo', - ...getExceptionListSchemaMock(), - referenced_rules: [ - { - name: 'My rule', - id: '4656dc92-5832-11ea-8e2d-0242ac130003', - rule_id: 'my-rule-id', - exception_lists: [ - { - id: 'myListId', - list_id: 'my-list-id', - namespace_type: 'single', - type: 'detection', - }, - ], - }, - ], - }; - - const decoded = exceptionListRuleReferencesSchema.decode(payload); - const checked = exactCheck(payload, decoded); - const output = foldLeftRight(checked); - expect(formatErrors(output.errors)).toEqual(['invalid keys "extra_value"']); - expect(output.schema).toEqual({}); - }); - }); - - describe('rulesReferencedByExceptionListsSchema', () => { - test('validates all fields', () => { - const payload: RulesReferencedByExceptionListsSchema = { - references: [ - { - 'my-list-id': { - ...getExceptionListSchemaMock(), - referenced_rules: [ - { - name: 'My rule', - id: '4656dc92-5832-11ea-8e2d-0242ac130003', - rule_id: 'my-rule-id', - exception_lists: [ - { - id: 'myListId', - list_id: 'my-list-id', - namespace_type: 'single', - type: 'detection', - }, - ], - }, - ], - }, - }, - ], - }; - - const decoded = rulesReferencedByExceptionListsSchema.decode(payload); - const checked = exactCheck(payload, decoded); - const output = foldLeftRight(checked); - expect(formatErrors(output.errors)).toEqual([]); - expect(output.schema).toEqual(payload); - }); - - test('validates "references" with empty array', () => { - const payload: RulesReferencedByExceptionListsSchema = { - references: [], - }; - - const decoded = rulesReferencedByExceptionListsSchema.decode(payload); - const checked = exactCheck(payload, decoded); - const output = foldLeftRight(checked); - expect(formatErrors(output.errors)).toEqual([]); - expect(output.schema).toEqual({ - references: [], - }); - }); - - test('cannot add extra values', () => { - const payload: RulesReferencedByExceptionListsSchema & { extra_value?: string } = { - extra_value: 'foo', - references: [ - { - 'my-list-id': { - ...getExceptionListSchemaMock(), - referenced_rules: [ - { - name: 'My rule', - id: '4656dc92-5832-11ea-8e2d-0242ac130003', - rule_id: 'my-rule-id', - exception_lists: [ - { - id: 'myListId', - list_id: 'my-list-id', - namespace_type: 'single', - type: 'detection', - }, - ], - }, - ], - }, - }, - ], - }; - - const decoded = rulesReferencedByExceptionListsSchema.decode(payload); - const checked = exactCheck(payload, decoded); - const output = foldLeftRight(checked); - expect(formatErrors(output.errors)).toEqual(['invalid keys "extra_value"']); - expect(output.schema).toEqual({}); - }); - }); -}); diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_actions/response_schema.ts b/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_actions/response_schema.ts deleted file mode 100644 index e9b4ad6bbc1e5..0000000000000 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/bulk_actions/response_schema.ts +++ /dev/null @@ -1,53 +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 { BulkActionSkipResult } from '@kbn/alerting-plugin/common'; -import type { RuleResponse } from '../../../../rule_schema'; -import type { BulkActionsDryRunErrCode } from '../../../../../constants'; - -export interface RuleDetailsInError { - id: string; - name?: string; -} -export interface NormalizedRuleError { - message: string; - status_code: number; - err_code?: BulkActionsDryRunErrCode; - rules: RuleDetailsInError[]; -} -export interface BulkEditActionResults { - updated: RuleResponse[]; - created: RuleResponse[]; - deleted: RuleResponse[]; - skipped: BulkActionSkipResult[]; -} - -export interface BulkEditActionSummary { - failed: number; - skipped: number; - succeeded: number; - total: number; -} -export interface BulkEditActionSuccessResponse { - success: boolean; - rules_count: number; - attributes: { - results: BulkEditActionResults; - summary: BulkEditActionSummary; - }; -} -export interface BulkEditActionErrorResponse { - status_code: number; - message: string; - attributes: { - results: BulkEditActionResults; - summary: BulkEditActionSummary; - errors?: NormalizedRuleError[]; - }; -} - -export type BulkEditActionResponse = BulkEditActionSuccessResponse | BulkEditActionErrorResponse; diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/coverage_overview/response_schema.ts b/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/coverage_overview/response_schema.ts deleted file mode 100644 index 61406700b1443..0000000000000 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/coverage_overview/response_schema.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; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import * as t from 'io-ts'; -import { NonEmptyArray } from '@kbn/securitysolution-io-ts-types'; -import { CoverageOverviewRuleActivitySchema } from './request_schema'; - -export type CoverageOverviewRuleAttributes = t.TypeOf; -export const CoverageOverviewRuleAttributes = t.type({ - name: t.string, - activity: CoverageOverviewRuleActivitySchema, -}); - -export type CoverageOverviewResponse = t.TypeOf; -export const CoverageOverviewResponse = t.exact( - t.type({ - /** - * Map having (tacticId, techniqueId or subtechniqueId) as the key and an array of rule ids as the value - */ - coverage: t.record(t.string, NonEmptyArray(t.string)), - /** - * Array of unmapped rule ids - */ - unmapped_rule_ids: t.array(t.string), - /** - * Map having ruleId as the key and coverage overview rule data as the value - */ - rules_data: t.record(t.string, CoverageOverviewRuleAttributes), - }) -); diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/import_rules/request_schema.test.ts b/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/import_rules/request_schema.test.ts deleted file mode 100644 index bd63dd7472aaf..0000000000000 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/import_rules/request_schema.test.ts +++ /dev/null @@ -1,52 +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 { left } from 'fp-ts/lib/Either'; -import { pipe } from 'fp-ts/lib/pipeable'; -import { exactCheck, foldLeftRight, getPaths } from '@kbn/securitysolution-io-ts-utils'; - -import { ImportRulesRequestBody } from './request_schema'; - -describe('Import rules schema', () => { - describe('ImportRulesRequestBody', () => { - test('does not validate with an empty object', () => { - const payload = {}; - - const decoded = ImportRulesRequestBody.decode(payload); - const checked = exactCheck(payload, decoded); - const message = pipe(checked, foldLeftRight); - expect(getPaths(left(message.errors))).toEqual([ - 'Invalid value "undefined" supplied to "file"', - ]); - expect(message.schema).toEqual({}); - }); - - test('does not validate with a made string', () => { - const payload: Omit & { madeUpKey: string } = { - madeUpKey: 'madeupstring', - }; - - const decoded = ImportRulesRequestBody.decode(payload); - const checked = exactCheck(payload, decoded); - const message = pipe(checked, foldLeftRight); - expect(getPaths(left(message.errors))).toEqual([ - 'Invalid value "undefined" supplied to "file"', - ]); - expect(message.schema).toEqual({}); - }); - - test('does validate with a file object', () => { - const payload: ImportRulesRequestBody = { file: {} }; - - const decoded = ImportRulesRequestBody.decode(payload); - const checked = exactCheck(payload, decoded); - const message = pipe(checked, foldLeftRight); - expect(getPaths(left(message.errors))).toEqual([]); - expect(message.schema).toEqual(payload); - }); - }); -}); diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/import_rules/request_schema.ts b/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/import_rules/request_schema.ts deleted file mode 100644 index 8f64df3ea71b1..0000000000000 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/import_rules/request_schema.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 * as t from 'io-ts'; - -/** - * Request body parameters of the API route. - */ -export type ImportRulesRequestBody = t.TypeOf; -export const ImportRulesRequestBody = t.exact( - t.type({ - file: t.object, - }) -); diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/import_rules/response_schema.test.ts b/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/import_rules/response_schema.test.ts deleted file mode 100644 index b2ff257ba2c4e..0000000000000 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/api/rules/import_rules/response_schema.test.ts +++ /dev/null @@ -1,495 +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 { pipe } from 'fp-ts/lib/pipeable'; -import type { Either } from 'fp-ts/lib/Either'; -import { left } from 'fp-ts/lib/Either'; -import type { Errors } from 'io-ts'; - -import { exactCheck, foldLeftRight, getPaths } from '@kbn/securitysolution-io-ts-utils'; -import type { ErrorSchema } from '../../../../schemas/response/error_schema'; -import { ImportRulesResponse } from './response_schema'; - -describe('Import rules response schema', () => { - test('it should validate an empty import response with no errors', () => { - const payload: ImportRulesResponse = { - success: true, - success_count: 0, - rules_count: 0, - errors: [], - exceptions_errors: [], - exceptions_success: true, - exceptions_success_count: 0, - action_connectors_success: true, - action_connectors_success_count: 0, - action_connectors_errors: [], - action_connectors_warnings: [], - }; - const decoded = ImportRulesResponse.decode(payload); - const checked = exactCheck(payload, decoded); - const message = pipe(checked, foldLeftRight); - - expect(getPaths(left(message.errors))).toEqual([]); - expect(message.schema).toEqual(payload); - }); - - test('it should validate an empty import response with a single error', () => { - const payload: ImportRulesResponse = { - success: false, - success_count: 0, - rules_count: 0, - errors: [{ error: { status_code: 400, message: 'some message' } }], - exceptions_errors: [], - exceptions_success: true, - exceptions_success_count: 0, - action_connectors_success: true, - action_connectors_success_count: 0, - action_connectors_errors: [], - action_connectors_warnings: [], - }; - const decoded = ImportRulesResponse.decode(payload); - const checked = exactCheck(payload, decoded); - const message = pipe(checked, foldLeftRight); - - expect(getPaths(left(message.errors))).toEqual([]); - expect(message.schema).toEqual(payload); - }); - - test('it should validate an empty import response with a single exceptions error', () => { - const payload: ImportRulesResponse = { - success: false, - success_count: 0, - rules_count: 0, - errors: [], - exceptions_errors: [{ error: { status_code: 400, message: 'some message' } }], - exceptions_success: true, - exceptions_success_count: 0, - action_connectors_success: true, - action_connectors_success_count: 0, - action_connectors_errors: [], - action_connectors_warnings: [], - }; - const decoded = ImportRulesResponse.decode(payload); - const checked = exactCheck(payload, decoded); - const message = pipe(checked, foldLeftRight); - - expect(getPaths(left(message.errors))).toEqual([]); - expect(message.schema).toEqual(payload); - }); - - test('it should validate an empty import response with two errors', () => { - const payload: ImportRulesResponse = { - success: false, - success_count: 0, - rules_count: 0, - errors: [ - { error: { status_code: 400, message: 'some message' } }, - { error: { status_code: 500, message: 'some message' } }, - ], - exceptions_errors: [], - exceptions_success: true, - exceptions_success_count: 0, - action_connectors_success: true, - action_connectors_success_count: 0, - action_connectors_errors: [], - action_connectors_warnings: [], - }; - const decoded = ImportRulesResponse.decode(payload); - const checked = exactCheck(payload, decoded); - const message = pipe(checked, foldLeftRight); - - expect(getPaths(left(message.errors))).toEqual([]); - expect(message.schema).toEqual(payload); - }); - - test('it should validate an empty import response with two exception errors', () => { - const payload: ImportRulesResponse = { - success: false, - success_count: 0, - rules_count: 0, - errors: [], - exceptions_errors: [ - { error: { status_code: 400, message: 'some message' } }, - { error: { status_code: 500, message: 'some message' } }, - ], - exceptions_success: true, - exceptions_success_count: 0, - action_connectors_success: true, - action_connectors_success_count: 0, - action_connectors_errors: [], - action_connectors_warnings: [], - }; - const decoded = ImportRulesResponse.decode(payload); - const checked = exactCheck(payload, decoded); - const message = pipe(checked, foldLeftRight); - - expect(getPaths(left(message.errors))).toEqual([]); - expect(message.schema).toEqual(payload); - }); - - test('it should NOT validate a success_count that is a negative number', () => { - const payload: ImportRulesResponse = { - success: false, - success_count: -1, - rules_count: 0, - errors: [], - exceptions_errors: [], - exceptions_success: true, - exceptions_success_count: 0, - action_connectors_success: true, - action_connectors_success_count: 0, - action_connectors_errors: [], - action_connectors_warnings: [], - }; - const decoded = ImportRulesResponse.decode(payload); - const checked = exactCheck(payload, decoded); - const message = pipe(checked, foldLeftRight); - - expect(getPaths(left(message.errors))).toEqual([ - 'Invalid value "-1" supplied to "success_count"', - ]); - expect(message.schema).toEqual({}); - }); - - test('it should NOT validate a exceptions_success_count that is a negative number', () => { - const payload: ImportRulesResponse = { - success: false, - success_count: 0, - rules_count: 0, - errors: [], - exceptions_errors: [], - exceptions_success: true, - exceptions_success_count: -1, - action_connectors_success: true, - action_connectors_success_count: 0, - action_connectors_errors: [], - action_connectors_warnings: [], - }; - const decoded = ImportRulesResponse.decode(payload); - const checked = exactCheck(payload, decoded); - const message = pipe(checked, foldLeftRight); - - expect(getPaths(left(message.errors))).toEqual([ - 'Invalid value "-1" supplied to "exceptions_success_count"', - ]); - expect(message.schema).toEqual({}); - }); - - test('it should NOT validate a success that is not a boolean', () => { - type UnsafeCastForTest = Either< - Errors, - { - success: string; - success_count: number; - errors: Array< - { - id?: string | undefined; - rule_id?: string | undefined; - } & { - error: { - status_code: number; - message: string; - }; - } - >; - } - >; - const payload: Omit & { success: string } = { - success: 'hello', - success_count: 0, - rules_count: 0, - errors: [], - exceptions_errors: [], - exceptions_success: true, - exceptions_success_count: 0, - action_connectors_success: true, - action_connectors_success_count: 0, - action_connectors_errors: [], - action_connectors_warnings: [], - }; - const decoded = ImportRulesResponse.decode(payload); - const checked = exactCheck(payload, decoded as UnsafeCastForTest); - const message = pipe(checked, foldLeftRight); - - expect(getPaths(left(message.errors))).toEqual(['Invalid value "hello" supplied to "success"']); - expect(message.schema).toEqual({}); - }); - - test('it should NOT validate a exceptions_success that is not a boolean', () => { - type UnsafeCastForTest = Either< - Errors, - { - success: boolean; - exceptions_success: string; - success_count: number; - errors: Array< - { - id?: string | undefined; - rule_id?: string | undefined; - } & { - error: { - status_code: number; - message: string; - }; - } - >; - } - >; - const payload: Omit & { - exceptions_success: string; - } = { - success: true, - success_count: 0, - rules_count: 0, - errors: [], - exceptions_errors: [], - exceptions_success: 'hello', - exceptions_success_count: 0, - action_connectors_success: true, - action_connectors_success_count: 0, - action_connectors_errors: [], - action_connectors_warnings: [], - }; - const decoded = ImportRulesResponse.decode(payload); - const checked = exactCheck(payload, decoded as UnsafeCastForTest); - const message = pipe(checked, foldLeftRight); - - expect(getPaths(left(message.errors))).toEqual([ - 'Invalid value "hello" supplied to "exceptions_success"', - ]); - expect(message.schema).toEqual({}); - }); - - test('it should NOT validate a success an extra invalid field', () => { - const payload: ImportRulesResponse & { invalid_field: string } = { - success: true, - success_count: 0, - rules_count: 0, - errors: [], - invalid_field: 'invalid_data', - exceptions_errors: [], - exceptions_success: true, - exceptions_success_count: 0, - action_connectors_success: true, - action_connectors_success_count: 0, - action_connectors_errors: [], - action_connectors_warnings: [], - }; - const decoded = ImportRulesResponse.decode(payload); - const checked = exactCheck(payload, decoded); - const message = pipe(checked, foldLeftRight); - - expect(getPaths(left(message.errors))).toEqual(['invalid keys "invalid_field"']); - expect(message.schema).toEqual({}); - }); - - test('it should NOT validate an extra field in the second position of the errors array', () => { - type InvalidError = ErrorSchema & { invalid_data?: string }; - const payload: Omit & { - errors: InvalidError[]; - } = { - success: true, - success_count: 0, - rules_count: 0, - errors: [ - { error: { status_code: 400, message: 'some message' } }, - { invalid_data: 'something', error: { status_code: 500, message: 'some message' } }, - ], - exceptions_errors: [], - exceptions_success: true, - exceptions_success_count: 0, - action_connectors_success: true, - action_connectors_success_count: 0, - action_connectors_errors: [], - action_connectors_warnings: [], - }; - const decoded = ImportRulesResponse.decode(payload); - const checked = exactCheck(payload, decoded); - const message = pipe(checked, foldLeftRight); - - expect(getPaths(left(message.errors))).toEqual(['invalid keys "invalid_data"']); - expect(message.schema).toEqual({}); - }); - - test('it should validate an empty import response with a single connectors error', () => { - const payload: ImportRulesResponse = { - success: false, - success_count: 0, - rules_count: 0, - errors: [], - exceptions_errors: [], - exceptions_success: true, - exceptions_success_count: 0, - action_connectors_success: true, - action_connectors_success_count: 0, - action_connectors_errors: [{ error: { status_code: 400, message: 'some message' } }], - action_connectors_warnings: [], - }; - const decoded = ImportRulesResponse.decode(payload); - const checked = exactCheck(payload, decoded); - const message = pipe(checked, foldLeftRight); - - expect(getPaths(left(message.errors))).toEqual([]); - expect(message.schema).toEqual(payload); - }); - test('it should validate an empty import response with multiple errors', () => { - const payload: ImportRulesResponse = { - success: false, - success_count: 0, - rules_count: 0, - errors: [ - { error: { status_code: 400, message: 'some message' } }, - { error: { status_code: 500, message: 'some message' } }, - ], - exceptions_errors: [], - exceptions_success: true, - exceptions_success_count: 0, - action_connectors_success: true, - action_connectors_success_count: 0, - action_connectors_errors: [{ error: { status_code: 400, message: 'some message' } }], - action_connectors_warnings: [], - }; - const decoded = ImportRulesResponse.decode(payload); - const checked = exactCheck(payload, decoded); - const message = pipe(checked, foldLeftRight); - - expect(getPaths(left(message.errors))).toEqual([]); - expect(message.schema).toEqual(payload); - }); - test('it should NOT validate action_connectors_success that is not boolean', () => { - type UnsafeCastForTest = Either< - Errors, - { - success: boolean; - action_connectors_success: string; - success_count: number; - errors: Array< - { - id?: string | undefined; - rule_id?: string | undefined; - } & { - error: { - status_code: number; - message: string; - }; - } - >; - } - >; - const payload: Omit & { - action_connectors_success: string; - } = { - success: true, - success_count: 0, - rules_count: 0, - errors: [], - exceptions_errors: [], - exceptions_success: true, - exceptions_success_count: 0, - action_connectors_success: 'invalid', - action_connectors_success_count: 0, - action_connectors_errors: [], - action_connectors_warnings: [], - }; - const decoded = ImportRulesResponse.decode(payload); - const checked = exactCheck(payload, decoded as UnsafeCastForTest); - const message = pipe(checked, foldLeftRight); - - expect(getPaths(left(message.errors))).toEqual([ - 'Invalid value "invalid" supplied to "action_connectors_success"', - ]); - expect(message.schema).toEqual({}); - }); - test('it should NOT validate a action_connectors_success_count that is a negative number', () => { - const payload: ImportRulesResponse = { - success: false, - success_count: 0, - rules_count: 0, - errors: [], - exceptions_errors: [], - exceptions_success: true, - exceptions_success_count: 0, - action_connectors_success: true, - action_connectors_success_count: -1, - action_connectors_errors: [], - action_connectors_warnings: [], - }; - const decoded = ImportRulesResponse.decode(payload); - const checked = exactCheck(payload, decoded); - const message = pipe(checked, foldLeftRight); - - expect(getPaths(left(message.errors))).toEqual([ - 'Invalid value "-1" supplied to "action_connectors_success_count"', - ]); - expect(message.schema).toEqual({}); - }); - test('it should validate a action_connectors_warnings after importing successfully', () => { - const payload: ImportRulesResponse = { - success: false, - success_count: 0, - rules_count: 0, - errors: [], - exceptions_errors: [], - exceptions_success: true, - exceptions_success_count: 0, - action_connectors_success: true, - action_connectors_success_count: 1, - action_connectors_errors: [], - action_connectors_warnings: [{ type: 'type', message: 'message', actionPath: 'actionPath' }], - }; - const decoded = ImportRulesResponse.decode(payload); - const checked = exactCheck(payload, decoded); - const message = pipe(checked, foldLeftRight); - - expect(getPaths(left(message.errors))).toEqual([]); - expect(message.schema).toEqual(payload); - }); - test('it should NOT validate a action_connectors_warnings that is not WarningSchema', () => { - type UnsafeCastForTest = Either< - Errors, - { - success: boolean; - action_connectors_warnings: string; - success_count: number; - errors: Array< - { - id?: string | undefined; - rule_id?: string | undefined; - } & { - error: { - status_code: number; - message: string; - }; - } - >; - } - >; - const payload: Omit & { - action_connectors_warnings: string; - } = { - success: true, - success_count: 0, - rules_count: 0, - errors: [], - exceptions_errors: [], - exceptions_success: true, - exceptions_success_count: 0, - action_connectors_success: true, - action_connectors_success_count: 0, - action_connectors_errors: [], - action_connectors_warnings: 'invalid', - }; - const decoded = ImportRulesResponse.decode(payload); - const checked = exactCheck(payload, decoded as UnsafeCastForTest); - const message = pipe(checked, foldLeftRight); - - expect(getPaths(left(message.errors))).toEqual([ - 'Invalid value "invalid" supplied to "action_connectors_warnings"', - ]); - expect(message.schema).toEqual({}); - }); -}); diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_management/index.ts b/x-pack/plugins/security_solution/common/detection_engine/rule_management/index.ts deleted file mode 100644 index 266a7e30d311c..0000000000000 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_management/index.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. - */ - -export * from './api/rules/bulk_crud/bulk_create_rules/request_schema'; -export * from './api/rules/bulk_crud/bulk_delete_rules/request_schema'; -export * from './api/rules/bulk_crud/bulk_patch_rules/request_schema'; -export * from './api/rules/bulk_crud/bulk_update_rules/request_schema'; -export * from './api/rules/bulk_crud/response_schema'; - -export * from './api/rules/crud/create_rule/request_schema_validation'; -export * from './api/rules/crud/patch_rule/request_schema_validation'; -export * from './api/rules/crud/patch_rule/request_schema'; -export * from './api/rules/crud/read_rule/query_rule_by_ids_validation'; -export * from './api/rules/crud/read_rule/query_rule_by_ids'; -export * from './api/rules/crud/update_rule/request_schema_validation'; - -export * from './api/rules/export_rules/request_schema'; -export * from './api/rules/find_rules/request_schema_validation'; -export * from './api/rules/find_rules/request_schema'; -export * from './api/rules/import_rules/request_schema'; -export * from './api/rules/import_rules/response_schema'; - -// TODO: https://github.com/elastic/kibana/pull/142950 -// export * from './api/urls'; - -export * from './model/export/export_rules_details_schema'; -export * from './model/import/rule_to_import_validation'; -export * from './model/import/rule_to_import'; diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/index.ts b/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/index.ts deleted file mode 100644 index c4e6ccc4f1b3a..0000000000000 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring/index.ts +++ /dev/null @@ -1,27 +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 * from './api/detection_engine_health/get_cluster_health_schemas'; -export * from './api/detection_engine_health/get_rule_health_schemas'; -export * from './api/detection_engine_health/get_space_health_schemas'; -export * from './api/rule_execution_logs/get_rule_execution_events_schemas'; -export * from './api/rule_execution_logs/get_rule_execution_results_schemas'; -export * from './api/urls'; - -export * from './model/detection_engine_health/cluster_health'; -export * from './model/detection_engine_health/health_interval'; -export * from './model/detection_engine_health/health_metadata'; -export * from './model/detection_engine_health/health_stats'; -export * from './model/detection_engine_health/rule_health'; -export * from './model/detection_engine_health/space_health'; -export * from './model/execution_event'; -export * from './model/execution_metrics'; -export * from './model/execution_result'; -export * from './model/execution_settings'; -export * from './model/execution_status'; -export * from './model/execution_summary'; -export * from './model/log_level'; diff --git a/x-pack/plugins/security_solution/common/detection_engine/rule_schema/index.ts b/x-pack/plugins/security_solution/common/detection_engine/rule_schema/index.ts deleted file mode 100644 index b63c27f71f79a..0000000000000 --- a/x-pack/plugins/security_solution/common/detection_engine/rule_schema/index.ts +++ /dev/null @@ -1,20 +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 * from './model/common_attributes/field_overrides'; -export * from './model/common_attributes/misc_attributes'; -export * from './model/common_attributes/related_integrations'; -export * from './model/common_attributes/required_fields'; -export * from './model/common_attributes/saved_objects'; -export * from './model/common_attributes/timeline_template'; - -export * from './model/specific_attributes/eql_attributes'; -export * from './model/specific_attributes/new_terms_attributes'; -export * from './model/specific_attributes/query_attributes'; -export * from './model/specific_attributes/threshold_attributes'; - -export * from './model/rule_schemas'; diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/request/index.ts b/x-pack/plugins/security_solution/common/detection_engine/schemas/request/index.ts deleted file mode 100644 index 56ea598c58b0d..0000000000000 --- a/x-pack/plugins/security_solution/common/detection_engine/schemas/request/index.ts +++ /dev/null @@ -1,9 +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 * from './query_signals_index_schema'; -export * from './set_signal_status_schema'; diff --git a/x-pack/plugins/security_solution/common/detection_engine/schemas/response/index.ts b/x-pack/plugins/security_solution/common/detection_engine/schemas/response/index.ts deleted file mode 100644 index 76da687604028..0000000000000 --- a/x-pack/plugins/security_solution/common/detection_engine/schemas/response/index.ts +++ /dev/null @@ -1,9 +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 * from './error_schema'; -export * from './warning_schema'; diff --git a/x-pack/plugins/security_solution/common/detection_engine/transform_actions.test.ts b/x-pack/plugins/security_solution/common/detection_engine/transform_actions.test.ts index df8a56e999a06..6bdce7573ed4c 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/transform_actions.test.ts +++ b/x-pack/plugins/security_solution/common/detection_engine/transform_actions.test.ts @@ -13,9 +13,12 @@ import { transformRuleToAlertResponseAction, transformAlertToRuleResponseAction, } from './transform_actions'; -import type { ResponseAction, RuleResponseAction } from './rule_response_actions/schemas'; -import { RESPONSE_ACTION_TYPES } from './rule_response_actions/schemas'; -import type { NormalizedRuleAction } from './rule_management/api/rules/bulk_actions/request_schema'; +import type { + ResponseAction, + RuleResponseAction, +} from '../api/detection_engine/model/rule_response_actions'; +import { RESPONSE_ACTION_TYPES } from '../api/detection_engine/model/rule_response_actions'; +import type { NormalizedRuleAction } from '../api/detection_engine/rule_management/bulk_actions/bulk_actions_route'; import type { RuleAction } from '@kbn/alerting-plugin/common'; describe('transform_actions', () => { diff --git a/x-pack/plugins/security_solution/common/detection_engine/transform_actions.ts b/x-pack/plugins/security_solution/common/detection_engine/transform_actions.ts index b17b4d5276c19..49d06ce33a78b 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/transform_actions.ts +++ b/x-pack/plugins/security_solution/common/detection_engine/transform_actions.ts @@ -7,9 +7,12 @@ import type { RuleAction } from '@kbn/alerting-plugin/common'; import type { NormalizedAlertAction } from '@kbn/alerting-plugin/server/rules_client'; -import type { NormalizedRuleAction } from './rule_management/api/rules/bulk_actions/request_schema'; -import type { ResponseAction, RuleResponseAction } from './rule_response_actions/schemas'; -import { RESPONSE_ACTION_TYPES } from './rule_response_actions/schemas'; +import type { NormalizedRuleAction } from '../api/detection_engine/rule_management/bulk_actions/bulk_actions_route'; +import type { + ResponseAction, + RuleResponseAction, +} from '../api/detection_engine/model/rule_response_actions'; +import { RESPONSE_ACTION_TYPES } from '../api/detection_engine/model/rule_response_actions'; import type { RuleAlertAction } from './types'; export const transformRuleToAlertAction = ({ diff --git a/x-pack/plugins/security_solution/common/detection_engine/utils.ts b/x-pack/plugins/security_solution/common/detection_engine/utils.ts index 36f7ee8977f5f..361bf25b27c26 100644 --- a/x-pack/plugins/security_solution/common/detection_engine/utils.ts +++ b/x-pack/plugins/security_solution/common/detection_engine/utils.ts @@ -16,7 +16,7 @@ import type { import type { Type } from '@kbn/securitysolution-io-ts-alerting-types'; import { hasLargeValueList } from '@kbn/securitysolution-list-utils'; -import type { Threshold, ThresholdNormalized } from './rule_schema'; +import type { Threshold, ThresholdNormalized } from '../api/detection_engine/model/rule_schema'; export const hasLargeValueItem = ( exceptionItems: Array diff --git a/x-pack/plugins/security_solution/common/endpoint/data_loaders/index_case.ts b/x-pack/plugins/security_solution/common/endpoint/data_loaders/index_case.ts index fffdd11815112..ed7e70e6e5207 100644 --- a/x-pack/plugins/security_solution/common/endpoint/data_loaders/index_case.ts +++ b/x-pack/plugins/security_solution/common/endpoint/data_loaders/index_case.ts @@ -7,9 +7,9 @@ import type { KbnClient } from '@kbn/test'; import type { Case } from '@kbn/cases-plugin/common'; -import { CASES_URL } from '@kbn/cases-plugin/common'; +import { CASES_URL, ConnectorTypes } from '@kbn/cases-plugin/common'; import type { CasePostRequest } from '@kbn/cases-plugin/common/api'; -import { CaseSeverity, ConnectorTypes } from '@kbn/cases-plugin/common/api'; +import { CaseSeverity } from '@kbn/cases-plugin/common/api'; import type { AxiosError } from 'axios'; import { EndpointError } from '../errors'; diff --git a/x-pack/plugins/security_solution/common/risk_engine/risk_score_preview/request_schema.ts b/x-pack/plugins/security_solution/common/risk_engine/risk_score_preview/request_schema.ts index e76b0673c6d83..87fdee201362a 100644 --- a/x-pack/plugins/security_solution/common/risk_engine/risk_score_preview/request_schema.ts +++ b/x-pack/plugins/security_solution/common/risk_engine/risk_score_preview/request_schema.ts @@ -6,7 +6,7 @@ */ import * as t from 'io-ts'; -import { DataViewId } from '../../detection_engine/rule_schema'; +import { DataViewId } from '../../api/detection_engine/model/rule_schema'; import { afterKeysSchema } from '../after_keys'; import { identifierTypeSchema } from '../identifier_types'; import { riskWeightsSchema } from '../risk_weights/schema'; diff --git a/x-pack/plugins/security_solution/common/search_strategy/timeline/index.ts b/x-pack/plugins/security_solution/common/search_strategy/timeline/index.ts index 9ca84a4cbb8d1..b71b48e425258 100644 --- a/x-pack/plugins/security_solution/common/search_strategy/timeline/index.ts +++ b/x-pack/plugins/security_solution/common/search_strategy/timeline/index.ts @@ -11,7 +11,7 @@ import type { TimelineType, TimelineStatus, RowRendererId, -} from '../../types/timeline/api'; +} from '../../api/timeline/model/api'; export * from './events'; diff --git a/x-pack/plugins/security_solution/common/types/index.ts b/x-pack/plugins/security_solution/common/types/index.ts index 8bee53d80db5a..42a3c10fc48e4 100644 --- a/x-pack/plugins/security_solution/common/types/index.ts +++ b/x-pack/plugins/security_solution/common/types/index.ts @@ -5,7 +5,7 @@ * 2.0. */ -import type { Status } from '../detection_engine/schemas/common'; +import type { Status } from '../api/detection_engine'; export * from './timeline'; export * from './detail_panel'; diff --git a/x-pack/plugins/security_solution/common/types/timeline/note/api.ts b/x-pack/plugins/security_solution/common/types/timeline/note/api.ts deleted file mode 100644 index a0968e85b30f2..0000000000000 --- a/x-pack/plugins/security_solution/common/types/timeline/note/api.ts +++ /dev/null @@ -1,56 +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-empty-interface */ - -import * as runtimeTypes from 'io-ts'; -import type { Maybe } from '../../../search_strategy/common'; - -import { unionWithNullType } from '../../../utility_types'; - -export const BareNoteSchema = runtimeTypes.intersection([ - runtimeTypes.type({ - timelineId: unionWithNullType(runtimeTypes.string), - }), - runtimeTypes.partial({ - eventId: unionWithNullType(runtimeTypes.string), - note: unionWithNullType(runtimeTypes.string), - created: unionWithNullType(runtimeTypes.number), - createdBy: unionWithNullType(runtimeTypes.string), - updated: unionWithNullType(runtimeTypes.number), - updatedBy: unionWithNullType(runtimeTypes.string), - }), -]); - -export interface BareNote extends runtimeTypes.TypeOf {} - -/** - * This type represents a note type stored in a saved object that does not include any fields that reference - * other saved objects. - */ -export type BareNoteWithoutExternalRefs = Omit; - -export const NoteRuntimeType = runtimeTypes.intersection([ - BareNoteSchema, - runtimeTypes.type({ - noteId: runtimeTypes.string, - version: runtimeTypes.string, - }), - runtimeTypes.partial({ - timelineVersion: unionWithNullType(runtimeTypes.string), - }), -]); - -export interface Note extends runtimeTypes.TypeOf {} - -export interface ResponseNote { - code?: Maybe; - - message?: Maybe; - - note: Note; -} diff --git a/x-pack/plugins/security_solution/common/types/timeline/rows/index.ts b/x-pack/plugins/security_solution/common/types/timeline/rows/index.ts index c46965635e90d..771000adb6b6f 100644 --- a/x-pack/plugins/security_solution/common/types/timeline/rows/index.ts +++ b/x-pack/plugins/security_solution/common/types/timeline/rows/index.ts @@ -6,7 +6,7 @@ */ import type { EcsSecurityExtension as Ecs } from '@kbn/securitysolution-ecs'; -import type { RowRendererId } from '../api'; +import type { RowRendererId } from '../../../api/timeline'; export interface RowRenderer { id: RowRendererId; diff --git a/x-pack/plugins/security_solution/common/types/timeline/store.ts b/x-pack/plugins/security_solution/common/types/timeline/store.ts index 8bb5a6218faaa..ceed44c45e03c 100644 --- a/x-pack/plugins/security_solution/common/types/timeline/store.ts +++ b/x-pack/plugins/security_solution/common/types/timeline/store.ts @@ -6,7 +6,7 @@ */ import type { Filter } from '@kbn/es-query'; -import type { RowRendererId, TimelineTypeLiteral } from './api'; +import type { RowRendererId, TimelineTypeLiteral } from '../../api/timeline/model/api'; import type { Direction } from '../../search_strategy'; import type { ExpandedDetailTimeline } from '../detail_panel'; diff --git a/x-pack/plugins/security_solution/common/utils/kql.ts b/x-pack/plugins/security_solution/common/utils/kql.ts index d96385e429cf6..cf55d16e91c9d 100644 --- a/x-pack/plugins/security_solution/common/utils/kql.ts +++ b/x-pack/plugins/security_solution/common/utils/kql.ts @@ -7,7 +7,7 @@ import { escapeKuery } from '@kbn/es-query'; import type { Type } from '@kbn/securitysolution-io-ts-alerting-types'; -import { RuleExecutionStatus } from '../detection_engine/rule_monitoring'; +import { RuleExecutionStatus } from '../api/detection_engine'; import { ENABLED_FIELD, LAST_RUN_OUTCOME_FIELD, diff --git a/x-pack/plugins/security_solution/cypress/data/detection_engine.ts b/x-pack/plugins/security_solution/cypress/data/detection_engine.ts index cdd72af22b785..d05ca3c1a1542 100644 --- a/x-pack/plugins/security_solution/cypress/data/detection_engine.ts +++ b/x-pack/plugins/security_solution/cypress/data/detection_engine.ts @@ -24,7 +24,7 @@ import type { RuleName, RuleReferenceArray, RuleTagArray, -} from '../../common/detection_engine/rule_schema'; +} from '../../common/api/detection_engine'; interface RuleFields { defaultIndexPatterns: IndexPatternArray; diff --git a/x-pack/plugins/security_solution/cypress/e2e/detection_rules/prebuilt_rules_install_update_authorization.cy.ts b/x-pack/plugins/security_solution/cypress/e2e/detection_rules/prebuilt_rules_install_update_authorization.cy.ts new file mode 100644 index 0000000000000..8b211447897c5 --- /dev/null +++ b/x-pack/plugins/security_solution/cypress/e2e/detection_rules/prebuilt_rules_install_update_authorization.cy.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 { APP_PATH, RULES_ADD_PATH, RULES_UPDATES } from '../../../common/constants'; +import { createRuleAssetSavedObject } from '../../helpers/rules'; +import { waitForRulesTableToBeLoaded } from '../../tasks/alerts_detection_rules'; +import { createAndInstallMockedPrebuiltRules } from '../../tasks/api_calls/prebuilt_rules'; +import { resetRulesTableState, deleteAlertsAndRules } from '../../tasks/common'; +import { esArchiverResetKibana } from '../../tasks/es_archiver'; +import { login, waitForPageWithoutDateRange } from '../../tasks/login'; +import { SECURITY_DETECTIONS_RULES_URL } from '../../urls/navigation'; +import { ROLES } from '../../../common/test'; +import { + ADD_ELASTIC_RULES_BTN, + getInstallSingleRuleButtonByRuleId, + getUpgradeSingleRuleButtonByRuleId, + INSTALL_ALL_RULES_BUTTON, + RULES_UPDATES_TAB, + RULE_CHECKBOX, + UPGRADE_ALL_RULES_BUTTON, +} from '../../screens/alerts_detection_rules'; + +const RULE_1_ID = 'rule_1'; +const RULE_2_ID = 'rule_2'; +const OUTDATED_RULE_1 = createRuleAssetSavedObject({ + name: 'Outdated rule 1', + rule_id: RULE_1_ID, + version: 1, +}); +const UPDATED_RULE_1 = createRuleAssetSavedObject({ + name: 'Updated rule 1', + rule_id: RULE_1_ID, + version: 2, +}); +const OUTDATED_RULE_2 = createRuleAssetSavedObject({ + name: 'Outdated rule 2', + rule_id: RULE_2_ID, + version: 1, +}); +const UPDATED_RULE_2 = createRuleAssetSavedObject({ + name: 'Updated rule 2', + rule_id: RULE_2_ID, + version: 2, +}); + +const loadPageAsReadOnlyUser = (url: string) => { + login(ROLES.reader); + waitForPageWithoutDateRange(url, ROLES.reader); +}; + +describe('Detection rules, Prebuilt Rules Installation and Update - Authorization/RBAC', () => { + beforeEach(() => { + login(); + resetRulesTableState(); + deleteAlertsAndRules(); + esArchiverResetKibana(); + waitForRulesTableToBeLoaded(); + createAndInstallMockedPrebuiltRules({ rules: [OUTDATED_RULE_1, OUTDATED_RULE_2] }); + }); + + describe('User with read privileges on Security Solution', () => { + const RULE_1 = createRuleAssetSavedObject({ + name: 'Test rule 1', + rule_id: 'rule_1', + }); + const RULE_2 = createRuleAssetSavedObject({ + name: 'Test rule 2', + rule_id: 'rule_2', + }); + beforeEach(() => { + // Now login with read-only user in preparation for test + createAndInstallMockedPrebuiltRules({ rules: [RULE_1, RULE_2], installToKibana: false }); + loadPageAsReadOnlyUser(SECURITY_DETECTIONS_RULES_URL); + waitForRulesTableToBeLoaded(); + }); + + it('should not be able to install prebuilt rules', () => { + // Check that Add Elastic Rules button is disabled + cy.get(ADD_ELASTIC_RULES_BTN).should('be.disabled'); + + // Navigate to Add Elastic Rules page anyways via URL + // and assert that rules cannot be selected and all + // installation buttons are disabled + cy.visit(`${APP_PATH}${RULES_ADD_PATH}`); + cy.get(INSTALL_ALL_RULES_BUTTON).should('be.disabled'); + cy.get(getInstallSingleRuleButtonByRuleId(RULE_1['security-rule'].rule_id)).should( + 'not.exist' + ); + cy.get(RULE_CHECKBOX).should('not.exist'); + }); + }); + + describe('User with read privileges on Security Solution', () => { + beforeEach(() => { + /* Create a second version of the rule, making it available for update */ + createAndInstallMockedPrebuiltRules({ + rules: [UPDATED_RULE_1, UPDATED_RULE_2], + installToKibana: false, + }); + // Now login with read-only user in preparation for test + loadPageAsReadOnlyUser(SECURITY_DETECTIONS_RULES_URL); + waitForRulesTableToBeLoaded(); + }); + + it('should not be able to upgrade prebuilt rules', () => { + // Check that Rule Update tab is not shown + cy.get(RULES_UPDATES_TAB).should('not.exist'); + + // Navigate to Rule Update tab anyways via URL + // and assert that rules cannot be selected and all + // upgrade buttons are disabled + cy.visit(`${APP_PATH}${RULES_UPDATES}`); + cy.get(UPGRADE_ALL_RULES_BUTTON).should('be.disabled'); + cy.get(getUpgradeSingleRuleButtonByRuleId(OUTDATED_RULE_1['security-rule'].rule_id)).should( + 'not.exist' + ); + cy.get(RULE_CHECKBOX).should('not.exist'); + }); + }); +}); diff --git a/x-pack/plugins/security_solution/cypress/e2e/detection_rules/prebuilt_rules_install_update_error_handling.cy.ts b/x-pack/plugins/security_solution/cypress/e2e/detection_rules/prebuilt_rules_install_update_error_handling.cy.ts new file mode 100644 index 0000000000000..b029a934fd1da --- /dev/null +++ b/x-pack/plugins/security_solution/cypress/e2e/detection_rules/prebuilt_rules_install_update_error_handling.cy.ts @@ -0,0 +1,143 @@ +/* + * 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 { createRuleAssetSavedObject } from '../../helpers/rules'; +import { waitForRulesTableToBeLoaded } from '../../tasks/alerts_detection_rules'; +import { createAndInstallMockedPrebuiltRules } from '../../tasks/api_calls/prebuilt_rules'; +import { resetRulesTableState, deleteAlertsAndRules, reload } from '../../tasks/common'; +import { esArchiverResetKibana } from '../../tasks/es_archiver'; +import { login, visitWithoutDateRange } from '../../tasks/login'; +import { SECURITY_DETECTIONS_RULES_URL } from '../../urls/navigation'; +import { + addElasticRulesButtonClick, + assertRuleAvailableForInstallAndInstallOne, + assertRuleAvailableForInstallAndInstallSelected, + assertRuleAvailableForInstallAndInstallAllInPage, + assertRuleAvailableForInstallAndInstallAll, + assertRuleUpgradeAvailableAndUpgradeOne, + assertRuleUpgradeAvailableAndUpgradeSelected, + assertRuleUpgradeAvailableAndUpgradeAllInPage, + assertRuleUpgradeAvailableAndUpgradeAll, + ruleUpdatesTabClick, +} from '../../tasks/prebuilt_rules'; + +describe('Detection rules, Prebuilt Rules Installation and Update - Error handling', () => { + beforeEach(() => { + login(); + resetRulesTableState(); + deleteAlertsAndRules(); + esArchiverResetKibana(); + + visitWithoutDateRange(SECURITY_DETECTIONS_RULES_URL); + }); + + describe('Installation of prebuilt rules - Should fail gracefully with toast error message when', () => { + const RULE_1 = createRuleAssetSavedObject({ + name: 'Test rule 1', + rule_id: 'rule_1', + }); + const RULE_2 = createRuleAssetSavedObject({ + name: 'Test rule 2', + rule_id: 'rule_2', + }); + beforeEach(() => { + createAndInstallMockedPrebuiltRules({ rules: [RULE_1, RULE_2], installToKibana: false }); + waitForRulesTableToBeLoaded(); + }); + + it('installing prebuilt rules one by one', () => { + addElasticRulesButtonClick(); + assertRuleAvailableForInstallAndInstallOne({ rules: [RULE_1], didRequestFail: true }); + }); + + it('installing multiple selected prebuilt rules by selecting them individually', () => { + addElasticRulesButtonClick(); + assertRuleAvailableForInstallAndInstallSelected({ + rules: [RULE_1, RULE_2], + didRequestFail: true, + }); + }); + + it('installing multiple selected prebuilt rules by selecting all in page', () => { + addElasticRulesButtonClick(); + assertRuleAvailableForInstallAndInstallAllInPage({ + rules: [RULE_1, RULE_2], + didRequestFail: true, + }); + }); + + it('installing all available rules at once', () => { + addElasticRulesButtonClick(); + assertRuleAvailableForInstallAndInstallAll({ rules: [RULE_1, RULE_2], didRequestFail: true }); + }); + }); + + describe('Update of prebuilt rules - Should fail gracefully with toast error message when', () => { + const RULE_1_ID = 'rule_1'; + const RULE_2_ID = 'rule_2'; + const OUTDATED_RULE_1 = createRuleAssetSavedObject({ + name: 'Outdated rule 1', + rule_id: RULE_1_ID, + version: 1, + }); + const UPDATED_RULE_1 = createRuleAssetSavedObject({ + name: 'Updated rule 1', + rule_id: RULE_1_ID, + version: 2, + }); + const OUTDATED_RULE_2 = createRuleAssetSavedObject({ + name: 'Outdated rule 2', + rule_id: RULE_2_ID, + version: 1, + }); + const UPDATED_RULE_2 = createRuleAssetSavedObject({ + name: 'Updated rule 2', + rule_id: RULE_2_ID, + version: 2, + }); + beforeEach(() => { + /* Create a new rule and install it */ + createAndInstallMockedPrebuiltRules({ rules: [OUTDATED_RULE_1, OUTDATED_RULE_2] }); + /* Create a second version of the rule, making it available for update */ + createAndInstallMockedPrebuiltRules({ + rules: [UPDATED_RULE_1, UPDATED_RULE_2], + installToKibana: false, + }); + waitForRulesTableToBeLoaded(); + reload(); + }); + + it('upgrading prebuilt rules one by one', () => { + ruleUpdatesTabClick(); + assertRuleUpgradeAvailableAndUpgradeOne({ rules: [OUTDATED_RULE_1], didRequestFail: true }); + }); + + it('upgrading multiple selected prebuilt rules by selecting them individually', () => { + ruleUpdatesTabClick(); + assertRuleUpgradeAvailableAndUpgradeSelected({ + rules: [OUTDATED_RULE_1, OUTDATED_RULE_2], + didRequestFail: true, + }); + }); + + it('upgrading multiple selected prebuilt rules by selecting all in page', () => { + ruleUpdatesTabClick(); + assertRuleUpgradeAvailableAndUpgradeAllInPage({ + rules: [OUTDATED_RULE_1, OUTDATED_RULE_2], + didRequestFail: true, + }); + }); + + it('upgrading all rules with available upgrades at once', () => { + ruleUpdatesTabClick(); + assertRuleUpgradeAvailableAndUpgradeAll({ + rules: [OUTDATED_RULE_1, OUTDATED_RULE_2], + didRequestFail: true, + }); + }); + }); +}); diff --git a/x-pack/plugins/security_solution/cypress/e2e/detection_rules/prebuilt_rules_install_update_workflows.cy.ts b/x-pack/plugins/security_solution/cypress/e2e/detection_rules/prebuilt_rules_install_update_workflows.cy.ts index bec5b77de52c9..1a416da168ce9 100644 --- a/x-pack/plugins/security_solution/cypress/e2e/detection_rules/prebuilt_rules_install_update_workflows.cy.ts +++ b/x-pack/plugins/security_solution/cypress/e2e/detection_rules/prebuilt_rules_install_update_workflows.cy.ts @@ -12,9 +12,10 @@ import { GO_BACK_TO_RULES_TABLE_BUTTON, INSTALL_ALL_RULES_BUTTON, INSTALL_SELECTED_RULES_BUTTON, - RULES_MANAGEMENT_TABLE, - RULES_ROW, - RULES_UPDATES_TABLE, + NO_RULES_AVAILABLE_FOR_INSTALL_MESSSAGE, + NO_RULES_AVAILABLE_FOR_UPGRADE_MESSSAGE, + RULES_UPDATES_TAB, + RULE_CHECKBOX, SELECT_ALL_RULES_ON_PAGE_CHECKBOX, TOASTER, } from '../../screens/alerts_detection_rules'; @@ -29,6 +30,13 @@ import { login, visitWithoutDateRange } from '../../tasks/login'; import { SECURITY_DETECTIONS_RULES_URL } from '../../urls/navigation'; import { addElasticRulesButtonClick, + assertRuleAvailableForInstallAndInstallOne, + assertRuleAvailableForInstallAndInstallSelected, + assertRuleAvailableForInstallAndInstallAllInPage, + assertRuleAvailableForInstallAndInstallAll, + assertRuleUpgradeAvailableAndUpgradeOne, + assertRuleUpgradeAvailableAndUpgradeSelected, + assertRuleUpgradeAvailableAndUpgradeAllInPage, assertRuleUpgradeAvailableAndUpgradeAll, ruleUpdatesTabClick, } from '../../tasks/prebuilt_rules'; @@ -45,35 +53,57 @@ describe('Detection rules, Prebuilt Rules Installation and Update workflow', () describe('Installation of prebuilt rules package via Fleet', () => { beforeEach(() => { - cy.intercept('POST', '/api/fleet/epm/packages/_bulk*').as('installPackage'); + cy.intercept('POST', '/api/fleet/epm/packages/_bulk*').as('installPackageBulk'); + cy.intercept('POST', '/api/fleet/epm/packages/security_detection_engine/*').as( + 'installPackage' + ); waitForRulesTableToBeLoaded(); }); it('should install package from Fleet in the background', () => { /* Assert that the package in installed from Fleet by checking that /* the installSource is "registry", as opposed to "bundle" */ - cy.wait('@installPackage', { + cy.wait('@installPackageBulk', { timeout: 60000, - }).then(({ response }) => { - cy.wrap(response?.statusCode).should('eql', 200); - - const packages = response?.body.items.map(({ name, result }: BulkInstallPackageInfo) => ({ - name, - installSource: result.installSource, - })); - - expect(packages.length).to.have.greaterThan(0); - expect(packages).to.deep.include.members([ - { name: 'security_detection_engine', installSource: 'registry' }, - ]); + }).then(({ response: bulkResponse }) => { + cy.wrap(bulkResponse?.statusCode).should('eql', 200); + + const packages = bulkResponse?.body.items.map( + ({ name, result }: BulkInstallPackageInfo) => ({ + name, + installSource: result.installSource, + }) + ); + + const packagesBulkInstalled = packages.map(({ name }: { name: string }) => name); + + // Under normal flow the package is installed via the Fleet bulk install API. + // However, for testing purposes the package can be installed via the Fleet individual install API, + // so we need to intercept and wait for that request as well. + if (!packagesBulkInstalled.includes('security_detection_engine')) { + // Should happen only during testing when the `xpack.securitySolution.prebuiltRulesPackageVersion` flag is set + cy.wait('@installPackage').then(({ response }) => { + cy.wrap(response?.statusCode).should('eql', 200); + cy.wrap(response?.body) + .should('have.property', 'items') + .should('have.length.greaterThan', 0); + cy.wrap(response?.body) + .should('have.property', '_meta') + .should('have.property', 'install_source') + .should('eql', 'registry'); + }); + } else { + // Normal flow, install via the Fleet bulk install API + expect(packages.length).to.have.greaterThan(0); + expect(packages).to.deep.include.members([ + { name: 'security_detection_engine', installSource: 'registry' }, + ]); + } }); }); it('should install rules from the Fleet package when user clicks on CTA', () => { - /* Retrieve how many rules were installed from the Fleet package */ - cy.wait('@installPackage', { - timeout: 60000, - }).then(() => { + const getRulesAndAssertNumberInstalled = () => { getRuleAssets().then((response) => { const ruleIds = response.body.hits.hits.map( (hit: { _source: { ['security-rule']: Rule } }) => hit._source['security-rule'].rule_id @@ -82,11 +112,30 @@ describe('Detection rules, Prebuilt Rules Installation and Update workflow', () const numberOfRulesToInstall = new Set(ruleIds).size; addElasticRulesButtonClick(); - cy.get(INSTALL_ALL_RULES_BUTTON).click(); + cy.get(INSTALL_ALL_RULES_BUTTON).should('be.enabled').click(); cy.get(TOASTER) .should('be.visible') .should('have.text', `${numberOfRulesToInstall} rules installed successfully.`); }); + }; + /* Retrieve how many rules were installed from the Fleet package */ + /* See comments in test above for more details */ + cy.wait('@installPackageBulk', { + timeout: 60000, + }).then(({ response: bulkResponse }) => { + cy.wrap(bulkResponse?.statusCode).should('eql', 200); + + const packagesBulkInstalled = bulkResponse?.body.items.map( + ({ name }: { name: string }) => name + ); + + if (!packagesBulkInstalled.includes('security_detection_engine')) { + cy.wait('@installPackage').then(() => { + getRulesAndAssertNumberInstalled(); + }); + } else { + getRulesAndAssertNumberInstalled(); + } }); }); }); @@ -103,17 +152,38 @@ describe('Detection rules, Prebuilt Rules Installation and Update workflow', () beforeEach(() => { createAndInstallMockedPrebuiltRules({ rules: [RULE_1, RULE_2], installToKibana: false }); waitForRulesTableToBeLoaded(); + cy.intercept('POST', '/internal/detection_engine/prebuilt_rules/installation/_perform').as( + 'installPrebuiltRules' + ); }); - it('should install selected rules when user clicks on Install selected rules', () => { + it('should install prebuilt rules one by one', () => { addElasticRulesButtonClick(); - cy.get(SELECT_ALL_RULES_ON_PAGE_CHECKBOX).click(); - cy.get(INSTALL_SELECTED_RULES_BUTTON).click(); + assertRuleAvailableForInstallAndInstallOne({ rules: [RULE_1] }); + }); + + it('should install multiple selected prebuilt rules by selecting them individually', () => { + addElasticRulesButtonClick(); + assertRuleAvailableForInstallAndInstallSelected({ rules: [RULE_1, RULE_2] }); + }); + + it('should install multiple selected prebuilt rules by selecting all in page', () => { + addElasticRulesButtonClick(); + assertRuleAvailableForInstallAndInstallAllInPage({ rules: [RULE_1, RULE_2] }); + }); + + it('should install all available rules at once', () => { + addElasticRulesButtonClick(); + assertRuleAvailableForInstallAndInstallAll({ rules: [RULE_1, RULE_2] }); + }); + + it('should display an empty screen when all available prebuilt rules have been installed', () => { + addElasticRulesButtonClick(); + cy.get(INSTALL_ALL_RULES_BUTTON).click(); cy.get(TOASTER).should('be.visible').should('have.text', `2 rules installed successfully.`); - cy.get(GO_BACK_TO_RULES_TABLE_BUTTON).click(); - cy.get(RULES_MANAGEMENT_TABLE).find(RULES_ROW).should('have.length', 2); - cy.get(RULES_MANAGEMENT_TABLE).contains(RULE_1['security-rule'].name); - cy.get(RULES_MANAGEMENT_TABLE).contains(RULE_2['security-rule'].name); + cy.get(RULE_CHECKBOX).should('not.exist'); + cy.get(NO_RULES_AVAILABLE_FOR_INSTALL_MESSSAGE).should('exist'); + cy.get(GO_BACK_TO_RULES_TABLE_BUTTON).should('exist'); }); it('should fail gracefully with toast error message when request to install rules fails', () => { @@ -129,47 +199,70 @@ describe('Detection rules, Prebuilt Rules Installation and Update workflow', () }); }); - describe('Update of prebuilt rules', () => { - const RULE_ID = 'rule_id'; - const OUTDATED_RULE = createRuleAssetSavedObject({ - name: 'Outdated rule', - rule_id: RULE_ID, + describe('Upgrade of prebuilt rules', () => { + const RULE_1_ID = 'rule_1'; + const RULE_2_ID = 'rule_2'; + const OUTDATED_RULE_1 = createRuleAssetSavedObject({ + name: 'Outdated rule 1', + rule_id: RULE_1_ID, + version: 1, + }); + const UPDATED_RULE_1 = createRuleAssetSavedObject({ + name: 'Updated rule 1', + rule_id: RULE_1_ID, + version: 2, + }); + const OUTDATED_RULE_2 = createRuleAssetSavedObject({ + name: 'Outdated rule 2', + rule_id: RULE_2_ID, version: 1, }); - const UPDATED_RULE = createRuleAssetSavedObject({ - name: 'Updated rule', - rule_id: RULE_ID, + const UPDATED_RULE_2 = createRuleAssetSavedObject({ + name: 'Updated rule 2', + rule_id: RULE_2_ID, version: 2, }); beforeEach(() => { + cy.intercept('POST', '/internal/detection_engine/prebuilt_rules/upgrade/_perform').as( + 'updatePrebuiltRules' + ); /* Create a new rule and install it */ - createAndInstallMockedPrebuiltRules({ rules: [OUTDATED_RULE] }); + createAndInstallMockedPrebuiltRules({ rules: [OUTDATED_RULE_1, OUTDATED_RULE_2] }); /* Create a second version of the rule, making it available for update */ - createAndInstallMockedPrebuiltRules({ rules: [UPDATED_RULE], installToKibana: false }); + createAndInstallMockedPrebuiltRules({ + rules: [UPDATED_RULE_1, UPDATED_RULE_2], + installToKibana: false, + }); waitForRulesTableToBeLoaded(); reload(); }); - it('should update rule succesfully', () => { - cy.intercept('POST', '/internal/detection_engine/prebuilt_rules/upgrade/_perform').as( - 'updatePrebuiltRules' - ); + it('should upgrade prebuilt rules one by one', () => { ruleUpdatesTabClick(); - assertRuleUpgradeAvailableAndUpgradeAll(OUTDATED_RULE); - cy.get(TOASTER).should('be.visible').should('have.text', `1 rule updated successfully.`); + assertRuleUpgradeAvailableAndUpgradeOne({ rules: [OUTDATED_RULE_1] }); }); - it('should fail gracefully with toast error message when request to update rules fails', () => { - /* Stub request to force rules update to fail */ - cy.intercept('POST', '/internal/detection_engine/prebuilt_rules/upgrade/_perform', { - statusCode: 500, - }).as('updatePrebuiltRules'); + it('should upgrade multiple selected prebuilt rules by selecting them individually', () => { ruleUpdatesTabClick(); - assertRuleUpgradeAvailableAndUpgradeAll(OUTDATED_RULE); - cy.get(TOASTER).should('be.visible').should('have.text', 'Rule update failed'); + assertRuleUpgradeAvailableAndUpgradeSelected({ rules: [OUTDATED_RULE_1, OUTDATED_RULE_2] }); + }); - /* Assert that the rule has not been updated in the UI */ - cy.get(RULES_UPDATES_TABLE).should('contain', OUTDATED_RULE['security-rule'].name); + it('should upgrade multiple selected prebuilt rules by selecting all in page', () => { + ruleUpdatesTabClick(); + assertRuleUpgradeAvailableAndUpgradeAllInPage({ rules: [OUTDATED_RULE_1, OUTDATED_RULE_2] }); + }); + + it('should upgrade all rules with available upgrades at once', () => { + ruleUpdatesTabClick(); + assertRuleUpgradeAvailableAndUpgradeAll({ rules: [OUTDATED_RULE_1, OUTDATED_RULE_2] }); + cy.get(RULES_UPDATES_TAB).should('not.exist'); + }); + + it('should display an empty screen when all rules with available updates have been upgraded', () => { + ruleUpdatesTabClick(); + assertRuleUpgradeAvailableAndUpgradeAll({ rules: [OUTDATED_RULE_1, OUTDATED_RULE_2] }); + cy.get(RULES_UPDATES_TAB).should('not.exist'); + cy.get(NO_RULES_AVAILABLE_FOR_UPGRADE_MESSSAGE).should('exist'); }); }); }); diff --git a/x-pack/plugins/security_solution/cypress/e2e/detection_rules/prebuilt_rules_notifications.cy.ts b/x-pack/plugins/security_solution/cypress/e2e/detection_rules/prebuilt_rules_notifications.cy.ts index e5216705ab7d1..9648d565e5f73 100644 --- a/x-pack/plugins/security_solution/cypress/e2e/detection_rules/prebuilt_rules_notifications.cy.ts +++ b/x-pack/plugins/security_solution/cypress/e2e/detection_rules/prebuilt_rules_notifications.cy.ts @@ -12,38 +12,41 @@ import { installAllPrebuiltRulesRequest, createAndInstallMockedPrebuiltRules, } from '../../tasks/api_calls/prebuilt_rules'; -import { resetRulesTableState, deleteAlertsAndRules, reload } from '../../tasks/common'; +import { + resetRulesTableState, + deleteAlertsAndRules, + reload, + deletePrebuiltRulesAssets, +} from '../../tasks/common'; import { login, visitWithoutDateRange } from '../../tasks/login'; import { SECURITY_DETECTIONS_RULES_URL } from '../../urls/navigation'; -describe('Detection rules, Prebuilt Rules Installation and Update workflow', () => { +const RULE_1 = createRuleAssetSavedObject({ + name: 'Test rule 1', + rule_id: 'rule_1', +}); + +describe('Detection rules, Prebuilt Rules Installation and Update Notifications', () => { beforeEach(() => { login(); /* Make sure persisted rules table state is cleared */ resetRulesTableState(); deleteAlertsAndRules(); - - const RULE_1 = createRuleAssetSavedObject({ - name: 'Test rule 1', - rule_id: 'rule_1', - }); - createAndInstallMockedPrebuiltRules({ rules: [RULE_1], installToKibana: false }); + deletePrebuiltRulesAssets(); }); - describe('Rules installation notification when no rules have been installed', () => { - beforeEach(() => { + describe('No notifications', () => { + it('should NOT display install or update notifications when no prebuilt assets and no rules are installed', () => { visitWithoutDateRange(SECURITY_DETECTIONS_RULES_URL); + waitForRulesTableToBeLoaded(); + // TODO: test plan asserts "should NOT see a CTA to install prebuilt rules" + // but current behavior is to always show the CTA, even with no prebuilt rule assets installed + // Update that behaviour and then update this test. + cy.get(RULES_UPDATES_TAB).should('not.exist'); }); - it('should notify user about prebuilt rules available for installation', () => { - cy.get(ADD_ELASTIC_RULES_BTN).should('be.visible'); - }); - }); - - describe('No notifications', () => { - it('should display no install or update notifications when latest rules are installed', () => { - /* Install current available rules */ - installAllPrebuiltRulesRequest(); + it('should NOT display install or update notifications when latest rules are installed', () => { + createAndInstallMockedPrebuiltRules({ rules: [RULE_1], installToKibana: true }); visitWithoutDateRange(SECURITY_DETECTIONS_RULES_URL); waitForRulesTableToBeLoaded(); @@ -55,64 +58,123 @@ describe('Detection rules, Prebuilt Rules Installation and Update workflow', () }); }); - describe('Rule installation notification when at least one rule already installed', () => { + describe('Notifications', () => { beforeEach(() => { - installAllPrebuiltRulesRequest(); - /* Create new rule assets with a different rule_id as the one that was */ - /* installed before in order to trigger the installation notification */ - const RULE_2 = createRuleAssetSavedObject({ - name: 'Test rule 2', - rule_id: 'rule_2', - }); - const RULE_3 = createRuleAssetSavedObject({ - name: 'Test rule 3', - rule_id: 'rule_3', + createAndInstallMockedPrebuiltRules({ rules: [RULE_1], installToKibana: false }); + }); + + describe('Rules installation notification when no rules have been installed', () => { + beforeEach(() => { + visitWithoutDateRange(SECURITY_DETECTIONS_RULES_URL); }); - createAndInstallMockedPrebuiltRules({ rules: [RULE_2, RULE_3], installToKibana: false }); - visitWithoutDateRange(SECURITY_DETECTIONS_RULES_URL); - waitForRulesTableToBeLoaded(); + it('should notify user about prebuilt rules available for installation', () => { + cy.get(ADD_ELASTIC_RULES_BTN).should('be.visible'); + cy.get(ADD_ELASTIC_RULES_BTN).should('have.text', `Add Elastic rules${1}`); + cy.get(RULES_UPDATES_TAB).should('not.exist'); + }); }); - it('should notify user about prebuilt rules package available for installation', () => { - const numberOfAvailableRules = 2; - cy.get(ADD_ELASTIC_RULES_BTN).should('be.visible'); - cy.get(ADD_ELASTIC_RULES_BTN).should( - 'have.text', - `Add Elastic rules${numberOfAvailableRules}` - ); - }); + describe('Rule installation notification when at least one rule already installed', () => { + beforeEach(() => { + installAllPrebuiltRulesRequest().then(() => { + /* Create new rule assets with a different rule_id as the one that was */ + /* installed before in order to trigger the installation notification */ + const RULE_2 = createRuleAssetSavedObject({ + name: 'Test rule 2', + rule_id: 'rule_2', + }); + const RULE_3 = createRuleAssetSavedObject({ + name: 'Test rule 3', + rule_id: 'rule_3', + }); + + createAndInstallMockedPrebuiltRules({ rules: [RULE_2, RULE_3], installToKibana: false }); + visitWithoutDateRange(SECURITY_DETECTIONS_RULES_URL); + waitForRulesTableToBeLoaded(); + }); + }); - it('should notify user a rule is again available for installation if it is deleted', () => { - /* Install available rules, assert that the notification is gone */ - /* then delete one rule and assert that the notification is back */ - installAllPrebuiltRulesRequest(); - reload(); - deleteFirstRule(); - cy.get(ADD_ELASTIC_RULES_BTN).should('be.visible'); - cy.get(ADD_ELASTIC_RULES_BTN).should('have.text', `Add Elastic rules${1}`); + it('should notify user about prebuilt rules available for installation', () => { + const numberOfAvailableRules = 2; + cy.get(ADD_ELASTIC_RULES_BTN).should('be.visible'); + cy.get(ADD_ELASTIC_RULES_BTN).should( + 'have.text', + `Add Elastic rules${numberOfAvailableRules}` + ); + cy.get(RULES_UPDATES_TAB).should('not.exist'); + }); + + it('should notify user a rule is again available for installation if it is deleted', () => { + /* Install available rules, assert that the notification is gone */ + /* then delete one rule and assert that the notification is back */ + installAllPrebuiltRulesRequest().then(() => { + reload(); + deleteFirstRule(); + cy.get(ADD_ELASTIC_RULES_BTN).should('be.visible'); + cy.get(ADD_ELASTIC_RULES_BTN).should('have.text', `Add Elastic rules${1}`); + }); + }); }); - }); - describe('Rule update notification', () => { - beforeEach(() => { - installAllPrebuiltRulesRequest(); - /* Create new rule asset with the same rule_id as the one that was installed */ - /* but with a higher version, in order to trigger the update notification */ - const UPDATED_RULE = createRuleAssetSavedObject({ - name: 'Test rule 1.1 (updated)', - rule_id: 'rule_1', - version: 2, + describe('Rule update notification', () => { + beforeEach(() => { + installAllPrebuiltRulesRequest().then(() => { + /* Create new rule asset with the same rule_id as the one that was installed */ + /* but with a higher version, in order to trigger the update notification */ + const UPDATED_RULE = createRuleAssetSavedObject({ + name: 'Test rule 1.1 (updated)', + rule_id: 'rule_1', + version: 2, + }); + createAndInstallMockedPrebuiltRules({ rules: [UPDATED_RULE], installToKibana: false }); + visitWithoutDateRange(SECURITY_DETECTIONS_RULES_URL); + waitForRulesTableToBeLoaded(); + reload(); + }); + }); + + it('should notify user about prebuilt rules package available for update', () => { + // No rules available for installation + cy.get(ADD_ELASTIC_RULES_BTN).should('have.text', `Add Elastic rules`); + // But 1 rule available for update + cy.get(RULES_UPDATES_TAB).should('be.visible'); + cy.get(RULES_UPDATES_TAB).should('have.text', `Rule Updates${1}`); }); - createAndInstallMockedPrebuiltRules({ rules: [UPDATED_RULE], installToKibana: false }); - visitWithoutDateRange(SECURITY_DETECTIONS_RULES_URL); - waitForRulesTableToBeLoaded(); - reload(); }); - it('should notify user about prebuilt rules package available for update', () => { - cy.get(RULES_UPDATES_TAB).should('be.visible'); - cy.get(RULES_UPDATES_TAB).should('have.text', `Rule Updates${1}`); + describe('Rule installation available and rule update available notifications', () => { + beforeEach(() => { + installAllPrebuiltRulesRequest().then(() => { + /* Create new rule assets with a different rule_id as the one that was */ + /* installed before in order to trigger the installation notification */ + const RULE_2 = createRuleAssetSavedObject({ + name: 'Test rule 2', + rule_id: 'rule_2', + }); + /* Create new rule asset with the same rule_id as the one that was installed */ + /* but with a higher version, in order to trigger the update notification */ + const UPDATED_RULE = createRuleAssetSavedObject({ + name: 'Test rule 1.1 (updated)', + rule_id: 'rule_1', + version: 2, + }); + createAndInstallMockedPrebuiltRules({ + rules: [RULE_2, UPDATED_RULE], + installToKibana: false, + }); + visitWithoutDateRange(SECURITY_DETECTIONS_RULES_URL); + waitForRulesTableToBeLoaded(); + }); + }); + + it('should notify user about prebuilt rules available for installation and for upgrade', () => { + // 1 rule available for installation + cy.get(ADD_ELASTIC_RULES_BTN).should('have.text', `Add Elastic rules${1}`); + // 1 rule available for update + cy.get(RULES_UPDATES_TAB).should('be.visible'); + cy.get(RULES_UPDATES_TAB).should('have.text', `Rule Updates${1}`); + }); }); }); }); diff --git a/x-pack/plugins/security_solution/cypress/e2e/detection_rules/rule_snoozing.cy.ts b/x-pack/plugins/security_solution/cypress/e2e/detection_rules/rule_snoozing.cy.ts index c8bbbfe7756c3..20c48ebe9afbf 100644 --- a/x-pack/plugins/security_solution/cypress/e2e/detection_rules/rule_snoozing.cy.ts +++ b/x-pack/plugins/security_solution/cypress/e2e/detection_rules/rule_snoozing.cy.ts @@ -6,7 +6,7 @@ */ import { INTERNAL_ALERTING_API_FIND_RULES_PATH } from '@kbn/alerting-plugin/common'; -import type { RuleResponse } from '../../../common/detection_engine/rule_schema'; +import type { RuleResponse } from '../../../common/api/detection_engine'; import { createRule, snoozeRule as snoozeRuleViaAPI } from '../../tasks/api_calls/rules'; import { cleanKibana, deleteAlertsAndRules, deleteConnectors } from '../../tasks/common'; import { login, visitWithoutDateRange } from '../../tasks/login'; diff --git a/x-pack/plugins/security_solution/cypress/e2e/explore/dashboards/entity_analytics.cy.ts b/x-pack/plugins/security_solution/cypress/e2e/explore/dashboards/entity_analytics.cy.ts index 1827c5586c7ee..4829a8d939331 100644 --- a/x-pack/plugins/security_solution/cypress/e2e/explore/dashboards/entity_analytics.cy.ts +++ b/x-pack/plugins/security_solution/cypress/e2e/explore/dashboards/entity_analytics.cy.ts @@ -10,7 +10,12 @@ import { login, visit } from '../../../tasks/login'; import { ALERTS_URL, ENTITY_ANALYTICS_URL } from '../../../urls/navigation'; import { esArchiverLoad, esArchiverUnload } from '../../../tasks/es_archiver'; -import { cleanKibana, deleteAlertsAndRules } from '../../../tasks/common'; +import { + cleanKibana, + deleteAlertsAndRules, + waitForPageToBeLoaded, + waitForTableToLoad, +} from '../../../tasks/common'; import { ANOMALIES_TABLE, ANOMALIES_TABLE_ROWS, @@ -149,7 +154,8 @@ describe('Entity Analytics Dashboard', () => { cy.get(HOSTS_TABLE_ALERT_CELL).should('have.length', 5); }); - it('filters by risk classification', () => { + // tracked by https://github.com/elastic/kibana/issues/161874 + it.skip('filters by risk classification', () => { openRiskTableFilterAndSelectTheLowOption(); cy.get(HOSTS_DONUT_CHART).should('include.text', '1Total'); @@ -299,7 +305,8 @@ describe('Entity Analytics Dashboard', () => { }); }); - describe('With anomalies data', () => { + // tracked by https://github.com/elastic/kibana/issues/161874 + describe.skip('With anomalies data', () => { before(() => { esArchiverLoad('network'); }); @@ -311,11 +318,15 @@ describe('Entity Analytics Dashboard', () => { beforeEach(() => { login(); visit(ENTITY_ANALYTICS_URL); + waitForPageToBeLoaded(); }); it('renders table with pagination', () => { cy.get(ANOMALIES_TABLE).should('be.visible'); - cy.get(ANOMALIES_TABLE_ROWS).should('have.length', 10); + waitForTableToLoad(); + + // Increase default timeout because anomalies table takes a while to load + cy.get(ANOMALIES_TABLE_ROWS, { timeout: 20000 }).should('have.length', 10); // navigates to next page cy.get(ANOMALIES_TABLE_NEXT_PAGE_BUTTON).click(); diff --git a/x-pack/plugins/security_solution/cypress/e2e/explore/host_details/risk_tab.cy.ts b/x-pack/plugins/security_solution/cypress/e2e/explore/host_details/risk_tab.cy.ts index 6bcb5cd9532ee..a57d49a602c53 100644 --- a/x-pack/plugins/security_solution/cypress/e2e/explore/host_details/risk_tab.cy.ts +++ b/x-pack/plugins/security_solution/cypress/e2e/explore/host_details/risk_tab.cy.ts @@ -7,7 +7,7 @@ import { login, visitHostDetailsPage } from '../../../tasks/login'; -import { cleanKibana } from '../../../tasks/common'; +import { cleanKibana, waitForTableToLoad } from '../../../tasks/common'; import { esArchiverLoad, esArchiverUnload } from '../../../tasks/es_archiver'; import { TABLE_CELL, TABLE_ROWS } from '../../../screens/alerts_details'; @@ -49,8 +49,3 @@ describe('risk tab', () => { ); }); }); - -export const waitForTableToLoad = () => { - cy.get('.euiBasicTable-loading').should('exist'); - cy.get('.euiBasicTable-loading').should('not.exist'); -}; diff --git a/x-pack/plugins/security_solution/cypress/e2e/explore/network/hover_actions.cy.ts b/x-pack/plugins/security_solution/cypress/e2e/explore/network/hover_actions.cy.ts index 69bac9bd2767e..5c056272652e6 100644 --- a/x-pack/plugins/security_solution/cypress/e2e/explore/network/hover_actions.cy.ts +++ b/x-pack/plugins/security_solution/cypress/e2e/explore/network/hover_actions.cy.ts @@ -24,7 +24,8 @@ import { esArchiverLoad, esArchiverUnload } from '../../../tasks/es_archiver'; const testDomain = 'myTest'; -describe('Hover actions', () => { +// tracked by https://github.com/elastic/kibana/issues/161874 +describe.skip('Hover actions', () => { const onBeforeLoadCallback = (win: Cypress.AUTWindow) => { // avoid cypress being held by windows prompt and timeout cy.stub(win, 'prompt').returns(true); diff --git a/x-pack/plugins/security_solution/cypress/e2e/investigations/alerts/expandable_flyout/alert_details_right_panel.cy.ts b/x-pack/plugins/security_solution/cypress/e2e/investigations/alerts/expandable_flyout/alert_details_right_panel.cy.ts index fb21d9d5a445d..44a2326aebc8e 100644 --- a/x-pack/plugins/security_solution/cypress/e2e/investigations/alerts/expandable_flyout/alert_details_right_panel.cy.ts +++ b/x-pack/plugins/security_solution/cypress/e2e/investigations/alerts/expandable_flyout/alert_details_right_panel.cy.ts @@ -43,6 +43,7 @@ import { DOCUMENT_DETAILS_FLYOUT_HEADER_RISK_SCORE_VALUE, DOCUMENT_DETAILS_FLYOUT_HEADER_SEVERITY, DOCUMENT_DETAILS_FLYOUT_HEADER_SEVERITY_VALUE, + DOCUMENT_DETAILS_FLYOUT_HEADER_STATUS, DOCUMENT_DETAILS_FLYOUT_HEADER_TITLE, DOCUMENT_DETAILS_FLYOUT_JSON_TAB, DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB, @@ -85,6 +86,8 @@ describe( cy.get(DOCUMENT_DETAILS_FLYOUT_HEADER_CHAT_BUTTON).should('be.visible'); + cy.get(DOCUMENT_DETAILS_FLYOUT_HEADER_STATUS).should('be.visible'); + cy.get(DOCUMENT_DETAILS_FLYOUT_HEADER_RISK_SCORE).should('be.visible'); cy.get(DOCUMENT_DETAILS_FLYOUT_HEADER_RISK_SCORE_VALUE) .should('be.visible') diff --git a/x-pack/plugins/security_solution/cypress/helpers/rules.ts b/x-pack/plugins/security_solution/cypress/helpers/rules.ts index a9a6594301384..86b5255d100c9 100644 --- a/x-pack/plugins/security_solution/cypress/helpers/rules.ts +++ b/x-pack/plugins/security_solution/cypress/helpers/rules.ts @@ -9,7 +9,7 @@ import moment from 'moment'; import type { PrebuiltRuleAsset } from '../../server/lib/detection_engine/prebuilt_rules'; import { getPrebuiltRuleMock } from '../../server/lib/detection_engine/prebuilt_rules/mocks'; -import type { ThreatArray } from '../../common/detection_engine/rule_schema'; +import type { ThreatArray } from '../../common/api/detection_engine'; export const formatMitreAttackDescription = (mitre: ThreatArray) => { return mitre diff --git a/x-pack/plugins/security_solution/cypress/objects/rule.ts b/x-pack/plugins/security_solution/cypress/objects/rule.ts index 371b81a346d0e..8488d94e9d329 100644 --- a/x-pack/plugins/security_solution/cypress/objects/rule.ts +++ b/x-pack/plugins/security_solution/cypress/objects/rule.ts @@ -16,7 +16,7 @@ import type { SavedQueryRuleCreateProps, ThreatMatchRuleCreateProps, ThresholdRuleCreateProps, -} from '../../common/detection_engine/rule_schema'; +} from '../../common/api/detection_engine'; import type { CreateRulePropsRewrites } from './types'; const ccsRemoteName: string = Cypress.env('CCS_REMOTE_NAME'); diff --git a/x-pack/plugins/security_solution/cypress/objects/timeline.ts b/x-pack/plugins/security_solution/cypress/objects/timeline.ts index 27f66b0072732..885734f93f734 100644 --- a/x-pack/plugins/security_solution/cypress/objects/timeline.ts +++ b/x-pack/plugins/security_solution/cypress/objects/timeline.ts @@ -5,7 +5,7 @@ * 2.0. */ -import type { TimelineResponse } from '../../common/types/timeline/api'; +import type { TimelineResponse } from '../../common/api/timeline'; export interface Timeline { title: string; diff --git a/x-pack/plugins/security_solution/cypress/screens/alerts_detection_rules.ts b/x-pack/plugins/security_solution/cypress/screens/alerts_detection_rules.ts index 1431fa097b7ac..5ba64892e741a 100644 --- a/x-pack/plugins/security_solution/cypress/screens/alerts_detection_rules.ts +++ b/x-pack/plugins/security_solution/cypress/screens/alerts_detection_rules.ts @@ -107,6 +107,8 @@ export const RULES_MONITORING_TABLE = '[data-test-subj="rules-monitoring-table"] export const RULES_UPDATES_TABLE = '[data-test-subj="rules-upgrades-table"]'; +export const ADD_ELASTIC_RULES_TABLE = '[data-test-subj="add-prebuilt-rules-table"]'; + export const RULES_ROW = '.euiTableRow'; export const SEVERITY = '[data-test-subj="severity"]'; @@ -182,3 +184,16 @@ export const RULE_EXECUTION_STATUS_BADGE = '[data-test-subj="ruleExecutionStatus export const EXECUTION_STATUS_FILTER_BUTTON = '[data-test-subj="executionStatusFilterButton"]'; export const EXECUTION_STATUS_FILTER_OPTION = '[data-test-subj="executionStatusFilterOption"]'; + +export const getInstallSingleRuleButtonByRuleId = (ruleId: string) => { + return `[data-test-subj="installSinglePrebuiltRuleButton-${ruleId}"]`; +}; + +export const getUpgradeSingleRuleButtonByRuleId = (ruleId: string) => { + return `[data-test-subj="upgradeSinglePrebuiltRuleButton-${ruleId}"]`; +}; + +export const NO_RULES_AVAILABLE_FOR_INSTALL_MESSSAGE = + '[data-test-subj="noPrebuiltRulesAvailableForInstall"]'; +export const NO_RULES_AVAILABLE_FOR_UPGRADE_MESSSAGE = + '[data-test-subj="noPrebuiltRulesAvailableForUpgrade"]'; diff --git a/x-pack/plugins/security_solution/cypress/screens/expandable_flyout/alert_details_right_panel.ts b/x-pack/plugins/security_solution/cypress/screens/expandable_flyout/alert_details_right_panel.ts index 50de0eb348264..60ebbe7fdd071 100644 --- a/x-pack/plugins/security_solution/cypress/screens/expandable_flyout/alert_details_right_panel.ts +++ b/x-pack/plugins/security_solution/cypress/screens/expandable_flyout/alert_details_right_panel.ts @@ -20,6 +20,7 @@ import { FLYOUT_HEADER_RISK_SCORE_VALUE_TEST_ID, FLYOUT_HEADER_SEVERITY_TITLE_TEST_ID, FLYOUT_HEADER_SEVERITY_VALUE_TEST_ID, + FLYOUT_HEADER_STATUS_BUTTON_TEST_ID, FLYOUT_HEADER_TITLE_TEST_ID, } from '../../../public/flyout/right/components/test_ids'; @@ -42,6 +43,9 @@ export const DOCUMENT_DETAILS_FLYOUT_OVERVIEW_TAB = getDataTestSubjectSelector(OVERVIEW_TAB_TEST_ID); export const DOCUMENT_DETAILS_FLYOUT_TABLE_TAB = getDataTestSubjectSelector(TABLE_TAB_TEST_ID); export const DOCUMENT_DETAILS_FLYOUT_JSON_TAB = getDataTestSubjectSelector(JSON_TAB_TEST_ID); +export const DOCUMENT_DETAILS_FLYOUT_HEADER_STATUS = getDataTestSubjectSelector( + FLYOUT_HEADER_STATUS_BUTTON_TEST_ID +); export const DOCUMENT_DETAILS_FLYOUT_HEADER_RISK_SCORE = getDataTestSubjectSelector( FLYOUT_HEADER_RISK_SCORE_TITLE_TEST_ID ); diff --git a/x-pack/plugins/security_solution/cypress/tasks/api_calls/kibana_advanced_settings.ts b/x-pack/plugins/security_solution/cypress/tasks/api_calls/kibana_advanced_settings.ts index 859df059f742d..0cadb50d72fe1 100644 --- a/x-pack/plugins/security_solution/cypress/tasks/api_calls/kibana_advanced_settings.ts +++ b/x-pack/plugins/security_solution/cypress/tasks/api_calls/kibana_advanced_settings.ts @@ -10,7 +10,7 @@ import { rootRequest } from '../common'; const kibanaSettings = (body: Cypress.RequestBody) => { rootRequest({ method: 'POST', - url: 'api/kibana/settings', + url: 'internal/kibana/settings', body, headers: { 'kbn-xsrf': 'cypress-creds' }, }); diff --git a/x-pack/plugins/security_solution/cypress/tasks/api_calls/prebuilt_rules.ts b/x-pack/plugins/security_solution/cypress/tasks/api_calls/prebuilt_rules.ts index 1a079cb43ec20..76cb7fb86661b 100644 --- a/x-pack/plugins/security_solution/cypress/tasks/api_calls/prebuilt_rules.ts +++ b/x-pack/plugins/security_solution/cypress/tasks/api_calls/prebuilt_rules.ts @@ -170,6 +170,7 @@ export const getRuleAssets = (index: string | undefined = '.kibana_security_solu /* during e2e tests, and allow for manual installation of mock rules instead. */ export const preventPrebuiltRulesPackageInstallation = () => { cy.intercept('POST', '/api/fleet/epm/packages/_bulk*', {}); + cy.intercept('POST', '/api/fleet/epm/packages/security_detection_engine/*', {}); }; /** @@ -198,6 +199,6 @@ export const createAndInstallMockedPrebuiltRules = ({ createNewRuleAsset({ rule }); }); if (installToKibana) { - installAllPrebuiltRulesRequest(); + return installAllPrebuiltRulesRequest(); } }; diff --git a/x-pack/plugins/security_solution/cypress/tasks/api_calls/rules.ts b/x-pack/plugins/security_solution/cypress/tasks/api_calls/rules.ts index bd4e9122c34d7..6c87b812046dc 100644 --- a/x-pack/plugins/security_solution/cypress/tasks/api_calls/rules.ts +++ b/x-pack/plugins/security_solution/cypress/tasks/api_calls/rules.ts @@ -11,7 +11,7 @@ import { DETECTION_ENGINE_RULES_URL, DETECTION_ENGINE_RULES_URL_FIND, } from '../../../common/constants'; -import type { RuleCreateProps, RuleResponse } from '../../../common/detection_engine/rule_schema'; +import type { RuleCreateProps, RuleResponse } from '../../../common/api/detection_engine'; import { internalAlertingSnoozeRule } from '../../urls/routes'; import type { FetchRulesResponse } from '../../../public/detection_engine/rule_management/logic/types'; diff --git a/x-pack/plugins/security_solution/cypress/tasks/api_calls/timelines.ts b/x-pack/plugins/security_solution/cypress/tasks/api_calls/timelines.ts index e30ffe7648063..ab64ac02698ca 100644 --- a/x-pack/plugins/security_solution/cypress/tasks/api_calls/timelines.ts +++ b/x-pack/plugins/security_solution/cypress/tasks/api_calls/timelines.ts @@ -5,7 +5,7 @@ * 2.0. */ -import type { TimelineResponse } from '../../../common/types/timeline/api'; +import type { TimelineResponse } from '../../../common/api/timeline'; import type { CompleteTimeline } from '../../objects/timeline'; import { rootRequest } from '../common'; diff --git a/x-pack/plugins/security_solution/cypress/tasks/common.ts b/x-pack/plugins/security_solution/cypress/tasks/common.ts index 1767b70fe33fe..fc6a7096e1814 100644 --- a/x-pack/plugins/security_solution/cypress/tasks/common.ts +++ b/x-pack/plugins/security_solution/cypress/tasks/common.ts @@ -12,6 +12,7 @@ import { LOADING_INDICATOR, LOADING_INDICATOR_HIDDEN, } from '../screens/security_header'; +import { EUI_BASIC_TABLE_LOADING } from '../screens/common/controls'; const primaryButton = 0; @@ -280,3 +281,8 @@ export const waitForWelcomePanelToBeLoaded = () => { cy.get(KIBANA_LOADING_ICON).should('exist'); cy.get(KIBANA_LOADING_ICON).should('not.exist'); }; + +export const waitForTableToLoad = () => { + cy.get(EUI_BASIC_TABLE_LOADING).should('exist'); + cy.get(EUI_BASIC_TABLE_LOADING).should('not.exist'); +}; diff --git a/x-pack/plugins/security_solution/cypress/tasks/create_new_rule.ts b/x-pack/plugins/security_solution/cypress/tasks/create_new_rule.ts index 2e9dc9630b8e6..c193245912fb6 100644 --- a/x-pack/plugins/security_solution/cypress/tasks/create_new_rule.ts +++ b/x-pack/plugins/security_solution/cypress/tasks/create_new_rule.ts @@ -123,7 +123,7 @@ import type { RuleCreateProps, ThreatMatchRuleCreateProps, ThresholdRuleCreateProps, -} from '../../common/detection_engine/rule_schema'; +} from '../../common/api/detection_engine/model'; import { waitForAlerts } from './alerts'; import { refreshPage } from './security_header'; import { EMPTY_ALERT_TABLE } from '../screens/alerts'; diff --git a/x-pack/plugins/security_solution/cypress/tasks/prebuilt_rules.ts b/x-pack/plugins/security_solution/cypress/tasks/prebuilt_rules.ts index 5035b50acaff9..bf9199aa1f81e 100644 --- a/x-pack/plugins/security_solution/cypress/tasks/prebuilt_rules.ts +++ b/x-pack/plugins/security_solution/cypress/tasks/prebuilt_rules.ts @@ -8,11 +8,21 @@ import { RULES_ADD_PATH, RULES_UPDATES } from '../../common/constants'; import { ADD_ELASTIC_RULES_BTN, - RULES_ROW, + ADD_ELASTIC_RULES_TABLE, + getInstallSingleRuleButtonByRuleId, + getUpgradeSingleRuleButtonByRuleId, + INSTALL_ALL_RULES_BUTTON, + INSTALL_SELECTED_RULES_BUTTON, + RULES_MANAGEMENT_TABLE, RULES_UPDATES_TAB, RULES_UPDATES_TABLE, + RULE_CHECKBOX, + SELECT_ALL_RULES_ON_PAGE_CHECKBOX, + TOASTER, UPGRADE_ALL_RULES_BUTTON, + UPGRADE_SELECTED_RULES_BUTTON, } from '../screens/alerts_detection_rules'; +import { BACK_TO_RULES_TABLE } from '../screens/rule_details'; import type { SAMPLE_PREBUILT_RULE } from './api_calls/prebuilt_rules'; export const addElasticRulesButtonClick = () => { @@ -25,9 +35,190 @@ export const ruleUpdatesTabClick = () => { cy.location('pathname').should('include', RULES_UPDATES); }; -export const assertRuleUpgradeAvailableAndUpgradeAll = (rule: typeof SAMPLE_PREBUILT_RULE) => { - cy.get(RULES_UPDATES_TABLE).find(RULES_ROW).should('have.length', 1); - cy.get(RULES_UPDATES_TABLE).contains(rule['security-rule'].name); +interface RuleInstallUpgradeAssertionPayload { + rules: Array; + didRequestFail?: boolean; +} + +export const assertRuleAvailableForInstallAndInstallOne = ({ + rules, + didRequestFail = false, +}: RuleInstallUpgradeAssertionPayload) => { + interceptInstallationRequestToFail(rules, didRequestFail); + const rule = rules[0]; + cy.get(getInstallSingleRuleButtonByRuleId(rule['security-rule'].rule_id)).click(); + cy.wait('@installPrebuiltRules'); + assertInstallationSuccessOrFailure([rule], didRequestFail); +}; + +export const assertRuleAvailableForInstallAndInstallSelected = ({ + rules, + didRequestFail = false, +}: RuleInstallUpgradeAssertionPayload) => { + interceptInstallationRequestToFail(rules, didRequestFail); + let i = 0; + for (const rule of rules) { + cy.get(RULE_CHECKBOX).eq(i).click(); + cy.get(ADD_ELASTIC_RULES_TABLE).contains(rule['security-rule'].name); + i++; + } + cy.get(INSTALL_SELECTED_RULES_BUTTON).click(); + cy.wait('@installPrebuiltRules'); + assertInstallationSuccessOrFailure(rules, didRequestFail); +}; + +export const assertRuleAvailableForInstallAndInstallAllInPage = ({ + rules, + didRequestFail = false, +}: RuleInstallUpgradeAssertionPayload) => { + interceptInstallationRequestToFail(rules, didRequestFail); + for (const rule of rules) { + cy.get(ADD_ELASTIC_RULES_TABLE).contains(rule['security-rule'].name); + } + cy.get(SELECT_ALL_RULES_ON_PAGE_CHECKBOX).click(); + cy.get(INSTALL_SELECTED_RULES_BUTTON).click(); + cy.wait('@installPrebuiltRules'); + assertInstallationSuccessOrFailure(rules, didRequestFail); +}; + +export const assertRuleAvailableForInstallAndInstallAll = ({ + rules, + didRequestFail = false, +}: RuleInstallUpgradeAssertionPayload) => { + interceptInstallationRequestToFail(rules, didRequestFail); + for (const rule of rules) { + cy.get(ADD_ELASTIC_RULES_TABLE).contains(rule['security-rule'].name); + } + cy.get(INSTALL_ALL_RULES_BUTTON).click(); + cy.wait('@installPrebuiltRules'); + assertInstallationSuccessOrFailure(rules, didRequestFail); +}; + +const assertInstallationSuccessOrFailure = ( + rules: Array, + didRequestFail: boolean +) => { + const rulesString = rules.length > 1 ? 'rules' : 'rule'; + const toastMessage = didRequestFail + ? `${rules.length} ${rulesString} failed to install.` + : `${rules.length} ${rulesString} installed successfully.`; + cy.get(TOASTER).should('be.visible').should('have.text', toastMessage); + if (didRequestFail) { + for (const rule of rules) { + cy.get(ADD_ELASTIC_RULES_TABLE).contains(rule['security-rule'].name); + } + } else { + cy.get(BACK_TO_RULES_TABLE).click(); + for (const rule of rules) { + cy.get(RULES_MANAGEMENT_TABLE).contains(rule['security-rule'].name); + } + } +}; + +const interceptInstallationRequestToFail = ( + rules: Array, + didRequestFail: boolean +) => { + if (didRequestFail) { + cy.intercept('POST', '/internal/detection_engine/prebuilt_rules/installation/_perform', { + body: { + summary: { + succeeded: [], + skipped: [], + failed: rules.length, + }, + }, + }).as('installPrebuiltRules'); + } +}; + +export const assertRuleUpgradeAvailableAndUpgradeOne = ({ + rules, + didRequestFail = false, +}: RuleInstallUpgradeAssertionPayload) => { + interceptUpgradeRequestToFail(rules, didRequestFail); + const rule = rules[0]; + cy.get(getUpgradeSingleRuleButtonByRuleId(rule['security-rule'].rule_id)).click(); + cy.wait('@updatePrebuiltRules'); + assertUpgradeSuccessOrFailure([rule], didRequestFail); +}; + +export const assertRuleUpgradeAvailableAndUpgradeSelected = ({ + rules, + didRequestFail = false, +}: RuleInstallUpgradeAssertionPayload) => { + interceptUpgradeRequestToFail(rules, didRequestFail); + let i = 0; + for (const rule of rules) { + cy.get(RULE_CHECKBOX).eq(i).click(); + cy.get(RULES_UPDATES_TABLE).contains(rule['security-rule'].name); + i++; + } + cy.get(UPGRADE_SELECTED_RULES_BUTTON).click(); + cy.wait('@updatePrebuiltRules'); + assertUpgradeSuccessOrFailure(rules, didRequestFail); +}; + +export const assertRuleUpgradeAvailableAndUpgradeAllInPage = ({ + rules, + didRequestFail = false, +}: RuleInstallUpgradeAssertionPayload) => { + interceptUpgradeRequestToFail(rules, didRequestFail); + for (const rule of rules) { + cy.get(RULES_UPDATES_TABLE).contains(rule['security-rule'].name); + } + cy.get(SELECT_ALL_RULES_ON_PAGE_CHECKBOX).click(); + cy.get(UPGRADE_SELECTED_RULES_BUTTON).click(); + cy.wait('@updatePrebuiltRules'); + assertUpgradeSuccessOrFailure(rules, didRequestFail); +}; + +export const assertRuleUpgradeAvailableAndUpgradeAll = ({ + rules, + didRequestFail = false, +}: RuleInstallUpgradeAssertionPayload) => { + interceptUpgradeRequestToFail(rules, didRequestFail); + for (const rule of rules) { + cy.get(RULES_UPDATES_TABLE).contains(rule['security-rule'].name); + } cy.get(UPGRADE_ALL_RULES_BUTTON).click(); cy.wait('@updatePrebuiltRules'); + assertUpgradeSuccessOrFailure(rules, didRequestFail); +}; + +const assertUpgradeSuccessOrFailure = ( + rules: Array, + didRequestFail: boolean +) => { + const rulesString = rules.length > 1 ? 'rules' : 'rule'; + const toastMessage = didRequestFail + ? `${rules.length} ${rulesString} failed to update.` + : `${rules.length} ${rulesString} updated successfully.`; + cy.get(TOASTER).should('be.visible').should('have.text', toastMessage); + if (didRequestFail) { + for (const rule of rules) { + cy.get(RULES_UPDATES_TABLE).contains(rule['security-rule'].name); + } + } else { + for (const rule of rules) { + cy.get(rule['security-rule'].name).should('not.exist'); + } + } +}; + +const interceptUpgradeRequestToFail = ( + rules: Array, + didRequestFail: boolean +) => { + if (didRequestFail) { + cy.intercept('POST', '/internal/detection_engine/prebuilt_rules/upgrade/_perform', { + body: { + summary: { + succeeded: [], + skipped: [], + failed: rules.length, + }, + }, + }).as('updatePrebuiltRules'); + } }; diff --git a/x-pack/plugins/security_solution/cypress/tasks/timeline.ts b/x-pack/plugins/security_solution/cypress/tasks/timeline.ts index d42d3ecfede31..05d08ba9702bf 100644 --- a/x-pack/plugins/security_solution/cypress/tasks/timeline.ts +++ b/x-pack/plugins/security_solution/cypress/tasks/timeline.ts @@ -471,7 +471,7 @@ export const setKibanaTimezoneToUTC = () => cy .request({ method: 'POST', - url: 'api/kibana/settings', + url: 'internal/kibana/settings', body: { changes: { 'dateFormat:tz': 'UTC' } }, headers: { 'kbn-xsrf': 'set-kibana-timezone-utc' }, }) diff --git a/x-pack/plugins/security_solution/docs/testing/test_plans/detection_response/prebuilt_rules/installation_and_upgrade.md b/x-pack/plugins/security_solution/docs/testing/test_plans/detection_response/prebuilt_rules/installation_and_upgrade.md index f07c134e37110..09198dd2d9ef8 100644 --- a/x-pack/plugins/security_solution/docs/testing/test_plans/detection_response/prebuilt_rules/installation_and_upgrade.md +++ b/x-pack/plugins/security_solution/docs/testing/test_plans/detection_response/prebuilt_rules/installation_and_upgrade.md @@ -61,7 +61,7 @@ Then the package gets installed in the background from EPR #### **Scenario: Package is installed via bundled Fleet package in Kibana** -**Automation**: 1 integration test. +**Automation**: 2 integration tests. ```Gherkin Given the package is not installed @@ -173,6 +173,8 @@ TODO: Check why for the legacy API Dmitrii has added 2 integration tests for `ru - `should update outdated prebuilt rules when previous historical versions available` - `should update outdated prebuilt rules when previous historical versions unavailable` +(NOTE: the second scenario tests that, if a new version of a rule is released, it can upgrade the current instance of that rule even if the historical versions of that rule are no longer in the package) + Notes: - Legacy API: @@ -220,7 +222,7 @@ Notes: ### Scenarios for the real package -#### **Scenario: User can install prebuilt rules from scratch, then install new rules and upgrade existing rules from the new pckage** +#### **Scenario: User can install prebuilt rules from scratch, then install new rules and upgrade existing rules from the new package** **Automation**: 1 integration test with real packages. @@ -250,28 +252,27 @@ Then rules returned in this response should exist as alert saved objects ### Rule installation and upgrade notifications on the Rule Management page -#### **Scenario: User is notified when no prebuilt rules are installed and there are rules available to install** +#### **Scenario: User is NOT notified when no prebuilt rules are installed and there are no prebuilt rules assets** **Automation**: 1 e2e test with mock rules + 1 integration test with mock rules for the /status endpoint. ```Gherkin Given no prebuilt rules are installed in Kibana -And there are X prebuilt rules available to install +And no prebuilt rule assets exist When user opens the Rule Management page -Then user should see a CTA to install prebuilt rules -And user should see a number of rules available to install (X) +Then user should NOT see a CTA to install prebuilt rules +And user should NOT see a number of rules available to install And user should NOT see a CTA to upgrade prebuilt rules And user should NOT see a number of rules available to upgrade And user should NOT see the Rule Updates table ``` -#### **Scenario: User is NOT notified when no prebuilt rules are installed and there are no prebuilt rules assets** +#### **Scenario: User is NOT notified when all prebuilt rules are installed and up to date** **Automation**: 1 e2e test with mock rules + 1 integration test with mock rules for the /status endpoint. ```Gherkin -Given no prebuilt rules are installed in Kibana -And no prebuilt rule assets exist +Given all the latest prebuilt rules are installed in Kibana When user opens the Rule Management page Then user should NOT see a CTA to install prebuilt rules And user should NOT see a number of rules available to install @@ -280,15 +281,16 @@ And user should NOT see a number of rules available to upgrade And user should NOT see the Rule Updates table ``` -#### **Scenario: User is NOT notified when all prebuilt rules are installed and up to date** +#### **Scenario: User is notified when no prebuilt rules are installed and there are rules available to install** **Automation**: 1 e2e test with mock rules + 1 integration test with mock rules for the /status endpoint. ```Gherkin -Given all the latest prebuilt rules are installed in Kibana +Given no prebuilt rules are installed in Kibana +And there are X prebuilt rules available to install When user opens the Rule Management page -Then user should NOT see a CTA to install prebuilt rules -And user should NOT see a number of rules available to install +Then user should see a CTA to install prebuilt rules +And user should see a number of rules available to install (X) And user should NOT see a CTA to upgrade prebuilt rules And user should NOT see a number of rules available to upgrade And user should NOT see the Rule Updates table @@ -323,7 +325,6 @@ Then user should NOT see a CTA to install prebuilt rules And user should NOT see a number of rules available to install And user should see a CTA to upgrade prebuilt rules And user should see the number of rules available to upgrade (Z) -And user should see the Rule Updates table ``` #### **Scenario: User is notified when both rules to install and upgrade are available** @@ -339,7 +340,6 @@ Then user should see a CTA to install prebuilt rules And user should see the number of rules available to install (Y) And user should see a CTA to upgrade prebuilt rules And user should see the number of rules available to upgrade (Z) -And user should see the Rule Updates table ``` #### **Scenario: User is notified after a prebuilt rule gets deleted** @@ -533,7 +533,7 @@ Then user should NOT see the Rule Updates tab until the package installation is #### **Scenario: Error is handled when any operation on prebuilt rules fails** -**Automation**: unit tests. +**Automation**: e2e test with mock rules ```Gherkin When user is prebuilt rules diff --git a/x-pack/plugins/security_solution/package.json b/x-pack/plugins/security_solution/package.json index e5f6125107859..01419bb09e470 100644 --- a/x-pack/plugins/security_solution/package.json +++ b/x-pack/plugins/security_solution/package.json @@ -26,6 +26,8 @@ "cypress:investigations:run": "yarn cypress:run:reporter --browser chrome --spec './cypress/e2e/investigations/**/*.cy.ts' --ftr-config-file ../../../../../../x-pack/test/security_solution_cypress/cli_config; status=$?; yarn junit:merge && exit $status", "cypress:explore:run": "yarn cypress:run:reporter --browser chrome --spec './cypress/e2e/explore/**/*.cy.ts' --ftr-config-file ../../../../../../x-pack/test/security_solution_cypress/cli_config; status=$?; yarn junit:merge && exit $status", "junit:merge": "../../../node_modules/.bin/mochawesome-merge ../../../target/kibana-security-solution/cypress/results/mochawesome*.json > ../../../target/kibana-security-solution/cypress/results/output.json && ../../../node_modules/.bin/marge ../../../target/kibana-security-solution/cypress/results/output.json --reportDir ../../../target/kibana-security-solution/cypress/results && mkdir -p ../../../target/junit && cp ../../../target/kibana-security-solution/cypress/results/*.xml ../../../target/junit/", - "test:generate": "node scripts/endpoint/resolver_generator" + "test:generate": "node scripts/endpoint/resolver_generator", + "mappings:generate": "node scripts/mappings/mappings_generator", + "mappings:load": "node scripts/mappings/mappings_loader" } } diff --git a/x-pack/plugins/security_solution/public/assistant/content/conversations/index.tsx b/x-pack/plugins/security_solution/public/assistant/content/conversations/index.tsx index eb93ae100e00f..61bd9fd3c937f 100644 --- a/x-pack/plugins/security_solution/public/assistant/content/conversations/index.tsx +++ b/x-pack/plugins/security_solution/public/assistant/content/conversations/index.tsx @@ -5,10 +5,7 @@ * 2.0. */ -import { - ELASTIC_AI_ASSISTANT_TITLE, - WELCOME_CONVERSATION_TITLE, -} from '@kbn/elastic-assistant/impl/assistant/use_conversation/translations'; +import { ELASTIC_AI_ASSISTANT_TITLE, WELCOME_CONVERSATION_TITLE } from '@kbn/elastic-assistant'; import type { Conversation } from '@kbn/elastic-assistant'; import { DATA_QUALITY_DASHBOARD_CONVERSATION_ID } from '@kbn/ecs-data-quality-dashboard/impl/data_quality/data_quality_panel/tabs/summary_tab/callout_summary/translations'; import { DETECTION_RULES_CONVERSATION_ID } from '../../../detections/pages/detection_engine/rules/translations'; diff --git a/x-pack/plugins/security_solution/public/assistant/helpers.tsx b/x-pack/plugins/security_solution/public/assistant/helpers.tsx index 8e397399dea9c..6915796ca89ca 100644 --- a/x-pack/plugins/security_solution/public/assistant/helpers.tsx +++ b/x-pack/plugins/security_solution/public/assistant/helpers.tsx @@ -51,6 +51,26 @@ export const getPromptContextFromEventDetailsItem = (data: TimelineEventsDetails const sendToTimelineEligibleQueryTypes: Array = ['kql', 'dsl', 'eql']; +/** + * Returns message contents with replacements applied. + * + * @param message + * @param replacements + */ +export const getMessageContentWithReplacements = ({ + messageContent, + replacements, +}: { + messageContent: string; + replacements: Record | undefined; +}): string => + replacements != null + ? Object.keys(replacements).reduce( + (acc, replacement) => acc.replaceAll(replacement, replacements[replacement]), + messageContent + ) + : messageContent; + /** * Augments the messages in a conversation with code block details, including * the start and end indices of the code block in the message, the type of the @@ -61,7 +81,14 @@ const sendToTimelineEligibleQueryTypes: Array = ['kql' export const augmentMessageCodeBlocks = ( currentConversation: Conversation ): CodeBlockDetails[][] => { - const cbd = currentConversation.messages.map(({ content }) => analyzeMarkdown(content)); + const cbd = currentConversation.messages.map(({ content }) => + analyzeMarkdown( + getMessageContentWithReplacements({ + messageContent: content, + replacements: currentConversation.replacements, + }) + ) + ); const output = cbd.map((codeBlocks, messageIndex) => codeBlocks.map((codeBlock, codeBlockIndex) => { diff --git a/x-pack/plugins/security_solution/public/assistant/send_to_timeline/index.tsx b/x-pack/plugins/security_solution/public/assistant/send_to_timeline/index.tsx index 6651ef2b96533..9e7f5c0320b28 100644 --- a/x-pack/plugins/security_solution/public/assistant/send_to_timeline/index.tsx +++ b/x-pack/plugins/security_solution/public/assistant/send_to_timeline/index.tsx @@ -18,7 +18,7 @@ import { InputsModelId } from '../../common/store/inputs/constants'; import type { TimeRange } from '../../common/store/inputs/model'; import { SourcererScopeName } from '../../common/store/sourcerer/model'; import { TimelineTabs, TimelineId } from '../../../common/types/timeline'; -import { TimelineType } from '../../../common/types/timeline/api'; +import { TimelineType } from '../../../common/api/timeline'; import { ACTION_INVESTIGATE_IN_TIMELINE } from '../../detections/components/alerts_table/translations'; import type { DataProvider } from '../../timelines/components/timeline/data_providers/data_provider'; import { useCreateTimeline } from '../../timelines/components/timeline/properties/use_create_timeline'; diff --git a/x-pack/plugins/security_solution/public/common/components/alert_count_by_status/alert_count_by_rule_by_status.tsx b/x-pack/plugins/security_solution/public/common/components/alert_count_by_status/alert_count_by_rule_by_status.tsx index 78e36e10f04eb..f76254364d83d 100644 --- a/x-pack/plugins/security_solution/public/common/components/alert_count_by_status/alert_count_by_rule_by_status.tsx +++ b/x-pack/plugins/security_solution/public/common/components/alert_count_by_status/alert_count_by_rule_by_status.tsx @@ -12,7 +12,7 @@ import { EuiBasicTable, EuiEmptyPrompt, EuiLink, EuiPanel, EuiToolTip } from '@e import { euiStyled } from '@kbn/kibana-react-plugin/common'; import type { ESBoolQuery } from '../../../../common/typed_json'; -import type { Status } from '../../../../common/detection_engine/schemas/common'; +import type { Status } from '../../../../common/api/detection_engine'; import { SecurityPageName } from '../../../../common/constants'; import type { Filter } from '../../../overview/components/detection_response/hooks/use_navigate_to_timeline'; import { useNavigateToTimeline } from '../../../overview/components/detection_response/hooks/use_navigate_to_timeline'; diff --git a/x-pack/plugins/security_solution/public/common/components/alert_count_by_status/use_alert_count_by_rule_by_status.ts b/x-pack/plugins/security_solution/public/common/components/alert_count_by_status/use_alert_count_by_rule_by_status.ts index 515a5306ae913..c49fdb19310af 100644 --- a/x-pack/plugins/security_solution/public/common/components/alert_count_by_status/use_alert_count_by_rule_by_status.ts +++ b/x-pack/plugins/security_solution/public/common/components/alert_count_by_status/use_alert_count_by_rule_by_status.ts @@ -9,7 +9,7 @@ import { useCallback, useEffect, useState } from 'react'; import { firstNonNullValue } from '../../../../common/endpoint/models/ecs_safety_helpers'; import type { ESBoolQuery } from '../../../../common/typed_json'; -import type { Status } from '../../../../common/detection_engine/schemas/common'; +import type { Status } from '../../../../common/api/detection_engine'; import type { GenericBuckets } from '../../../../common/search_strategy'; import { ALERTS_QUERY_NAMES } from '../../../detections/containers/detection_engine/alerts/constants'; import { useQueryAlerts } from '../../../detections/containers/detection_engine/alerts/use_query'; diff --git a/x-pack/plugins/security_solution/public/common/components/drag_and_drop/drag_drop_context_wrapper.tsx b/x-pack/plugins/security_solution/public/common/components/drag_and_drop/drag_drop_context_wrapper.tsx index d29f34068a173..dd719f1cf83fd 100644 --- a/x-pack/plugins/security_solution/public/common/components/drag_and_drop/drag_drop_context_wrapper.tsx +++ b/x-pack/plugins/security_solution/public/common/components/drag_and_drop/drag_drop_context_wrapper.tsx @@ -27,7 +27,7 @@ import { } from '../../hooks/translations'; import { displaySuccessToast, useStateToaster } from '../toasters'; import { TimelineId } from '../../../../common/types/timeline'; -import { TimelineType } from '../../../../common/types/timeline/api'; +import { TimelineType } from '../../../../common/api/timeline'; import { addProviderToTimeline, fieldWasDroppedOnTimelineColumns, 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 840ccf19ddd1b..d222c5969046d 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 @@ -1,451 +1,20 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP exports[`LinkToApp component should render with href 1`] = ` - - - - - - - - - - - - - , - , - , - , - , - , - , - , - ], - }, - } - } - isStringTag={true} - serialized={ - Object { - "map": undefined, - "name": "zxmf4e-euiLink-primary", - "next": undefined, - "styles": " - font-weight: 500; - text-align: start; - - &:hover { - - text-decoration: underline; - - } - - &:focus { - - outline: 2px solid currentColor; - outline-offset: 2px; - - // 👀 Chrome respects :focus-visible and allows coloring the \`auto\` style - &:focus-visible { - outline-style: auto; - } - - // 🙅‍♀️ But Chrome also needs to have the outline forcefully removed from regular \`:focus\` state - &:not(:focus-visible) { - outline: none; - } - - - text-decoration: underline; - text-decoration-thickness: 2px !important; - - } - user-select:text;&[target='_blank']{position:relative;};label:euiLink;;;; - color: #006bb8; - - &:hover, - &:focus, - &:target { - text-decoration: underline; - } - - &:target { - color: darken(#006bb8, 10%); - } - ;label:primary;;;", - "toString": [Function], - } - } - /> - - link - - - - + link + `; exports[`LinkToApp component should render with minimum input 1`] = ` - - - - - - + link + `; diff --git a/x-pack/plugins/security_solution/public/common/components/endpoint/link_to_app.test.tsx b/x-pack/plugins/security_solution/public/common/components/endpoint/link_to_app.test.tsx index 724d0489a6dbc..4290cff8c2b1f 100644 --- a/x-pack/plugins/security_solution/public/common/components/endpoint/link_to_app.test.tsx +++ b/x-pack/plugins/security_solution/public/common/components/endpoint/link_to_app.test.tsx @@ -32,7 +32,7 @@ describe('LinkToApp component', () => { }); it('should render with minimum input', () => { - expect(render({'link'})).toMatchSnapshot(); + expect(render({'link'}).render()).toMatchSnapshot(); }); it('should render with href', () => { expect( @@ -40,7 +40,7 @@ describe('LinkToApp component', () => { {'link'} - ) + ).render() ).toMatchSnapshot(); }); it('should support onClick prop', () => { diff --git a/x-pack/plugins/security_solution/public/common/components/event_details/osquery_tab.tsx b/x-pack/plugins/security_solution/public/common/components/event_details/osquery_tab.tsx index 67957f2a38133..4edc6b7ae08de 100644 --- a/x-pack/plugins/security_solution/public/common/components/event_details/osquery_tab.tsx +++ b/x-pack/plugins/security_solution/public/common/components/event_details/osquery_tab.tsx @@ -20,7 +20,7 @@ import { useIsExperimentalFeatureEnabled } from '../../hooks/use_experimental_fe import { useKibana } from '../../lib/kibana'; import { EventsViewType } from './event_details'; import * as i18n from './translations'; -import { RESPONSE_ACTION_TYPES } from '../../../../common/detection_engine/rule_response_actions/schemas/response_actions'; +import { RESPONSE_ACTION_TYPES } from '../../../../common/api/detection_engine/model/rule_response_actions'; const TabContentWrapper = styled.div` height: 100%; 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 6ee4557d2ee22..c676809c3c2a5 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 @@ -91,6 +91,7 @@ exports[`Event Details Overview Cards renders rows and spacers correctly 1`] = `