diff --git a/.buildkite/ftr_configs.yml b/.buildkite/ftr_configs.yml index 812d22fec913b..3fd459ffc64c1 100644 --- a/.buildkite/ftr_configs.yml +++ b/.buildkite/ftr_configs.yml @@ -45,12 +45,9 @@ disabled: - x-pack/plugins/observability/e2e/synthetics_run.ts # Configs that exist but weren't running in CI when this file was introduced - - test/visual_regression/config.ts - - x-pack/test/visual_regression/config.ts - x-pack/test/alerting_api_integration/security_and_spaces/group2/tests/actions/config.ts - x-pack/test/alerting_api_integration/security_and_spaces/group2/tests/telemetry/config.ts - x-pack/test/alerting_api_integration/spaces_only_legacy/config.ts - - x-pack/test/banners_functional/config.ts - x-pack/test/cloud_integration/config.ts - x-pack/test/performance/config.playwright.ts - x-pack/test/load/config.ts @@ -129,6 +126,7 @@ enabled: - x-pack/test/apm_api_integration/basic/config.ts - x-pack/test/apm_api_integration/rules/config.ts - x-pack/test/apm_api_integration/trial/config.ts + - x-pack/test/banners_functional/config.ts - x-pack/test/cases_api_integration/security_and_spaces/config_basic.ts - x-pack/test/cases_api_integration/security_and_spaces/config_trial.ts - x-pack/test/cases_api_integration/spaces_only/config.ts @@ -142,6 +140,7 @@ enabled: - x-pack/test/detection_engine_api_integration/security_and_spaces/group7/config.ts - x-pack/test/detection_engine_api_integration/security_and_spaces/group8/config.ts - x-pack/test/detection_engine_api_integration/security_and_spaces/group9/config.ts + - x-pack/test/detection_engine_api_integration/security_and_spaces/group10/config.ts - x-pack/test/encrypted_saved_objects_api_integration/config.ts - x-pack/test/endpoint_api_integration_no_ingest/config.ts - x-pack/test/examples/config.ts @@ -183,7 +182,9 @@ enabled: - x-pack/test/functional/apps/maps/group2/config.ts - x-pack/test/functional/apps/maps/group3/config.ts - x-pack/test/functional/apps/maps/group4/config.ts - - x-pack/test/functional/apps/ml/anomaly_detection/config.ts + - x-pack/test/functional/apps/ml/anomaly_detection_jobs/config.ts + - x-pack/test/functional/apps/ml/anomaly_detection_integrations/config.ts + - x-pack/test/functional/apps/ml/anomaly_detection_result_views/config.ts - x-pack/test/functional/apps/ml/data_frame_analytics/config.ts - x-pack/test/functional/apps/ml/data_visualizer/config.ts - x-pack/test/functional/apps/ml/permissions/config.ts @@ -272,3 +273,4 @@ enabled: - x-pack/test/performance/journeys/many_fields_discover/config.ts - x-pack/test/performance/journeys/promotion_tracking_dashboard/config.ts - x-pack/test/performance/journeys/web_logs_dashboard/config.ts + - x-pack/test/performance/journeys/data_stress_test_lens/config.ts diff --git a/.buildkite/scripts/steps/cloud/deploy.json b/.buildkite/scripts/steps/cloud/deploy.json index c43294a42a83b..da1918a2a6953 100644 --- a/.buildkite/scripts/steps/cloud/deploy.json +++ b/.buildkite/scripts/steps/cloud/deploy.json @@ -10,8 +10,8 @@ "instance_configuration_id": "gcp.integrationsserver.1", "zone_count": 1, "size": { - "value": 512, - "resource": "memory" + "resource": "memory", + "value": 1024 } } ], @@ -32,7 +32,7 @@ "autoscaling_enabled": false, "cluster_topology": [ { - "zone_count": 2, + "zone_count": 1, "instance_configuration_id": "gcp.coordinating.1", "node_roles": [ "ingest", @@ -42,9 +42,6 @@ "size": { "resource": "memory", "value": 0 - }, - "elasticsearch": { - "enabled_built_in_plugins": [] } }, { @@ -52,8 +49,7 @@ "elasticsearch": { "node_attributes": { "data": "hot" - }, - "enabled_built_in_plugins": [] + } }, "instance_configuration_id": "gcp.data.highio.1", "node_roles": [ @@ -66,17 +62,16 @@ ], "id": "hot_content", "size": { - "value": 1024, + "value": 2048, "resource": "memory" } }, { - "zone_count": 2, + "zone_count": 1, "elasticsearch": { "node_attributes": { "data": "warm" - }, - "enabled_built_in_plugins": [] + } }, "instance_configuration_id": "gcp.data.highstorage.1", "node_roles": [ @@ -94,8 +89,7 @@ "elasticsearch": { "node_attributes": { "data": "cold" - }, - "enabled_built_in_plugins": [] + } }, "instance_configuration_id": "gcp.data.highstorage.1", "node_roles": [ @@ -113,8 +107,7 @@ "elasticsearch": { "node_attributes": { "data": "frozen" - }, - "enabled_built_in_plugins": [] + } }, "instance_configuration_id": "gcp.es.datafrozen.n1.64x10x95", "node_roles": [ @@ -127,7 +120,7 @@ } }, { - "zone_count": 3, + "zone_count": 1, "instance_configuration_id": "gcp.master.1", "node_roles": [ "master", @@ -137,9 +130,6 @@ "size": { "resource": "memory", "value": 0 - }, - "elasticsearch": { - "enabled_built_in_plugins": [] } }, { @@ -153,14 +143,12 @@ "size": { "value": 1024, "resource": "memory" - }, - "elasticsearch": { - "enabled_built_in_plugins": [] } } ], "elasticsearch": { - "version": null + "version": null, + "enabled_built_in_plugins": [] }, "deployment_template": { "id": "gcp-io-optimized-v2" @@ -206,8 +194,8 @@ "instance_configuration_id": "gcp.kibana.1", "zone_count": 1, "size": { - "resource": "memory", - "value": 2048 + "value": 2048, + "resource": "memory" } } ], @@ -220,6 +208,7 @@ } ] }, + "settings": {}, "name": null, "metadata": { "system_owned": false diff --git a/.buildkite/scripts/steps/cloud/purge_deployments.ts b/.buildkite/scripts/steps/cloud/purge_deployments.ts index 127e3df5f7580..3553404aeec54 100644 --- a/.buildkite/scripts/steps/cloud/purge_deployments.ts +++ b/.buildkite/scripts/steps/cloud/purge_deployments.ts @@ -18,6 +18,7 @@ const prDeployments = deployments.filter((deployment: any) => const deploymentsToPurge = []; const NOW = new Date().getTime() / 1000; +const DAY_IN_SECONDS = 60 * 60 * 24; for (const deployment of prDeployments) { try { @@ -37,12 +38,12 @@ for (const deployment of prDeployments) { ) ) { console.log( - `Pull Request #${prNumber} no longer has the a cloud deployment label, will delete associated deployment` + `Pull Request #${prNumber} no longer has a cloud deployment label, will delete associated deployment` ); deploymentsToPurge.push(deployment); - } else if (lastCommitTimestamp < NOW - 60 * 60 * 24 * 7) { + } else if (lastCommitTimestamp < NOW - DAY_IN_SECONDS * 2) { console.log( - `Pull Request #${prNumber} has not been updated in more than 7 days, will delete associated deployment` + `Pull Request #${prNumber} has not been updated in more than 2 days, will delete associated deployment` ); deploymentsToPurge.push(deployment); } diff --git a/.buildkite/scripts/steps/functional/performance_playwright.sh b/.buildkite/scripts/steps/functional/performance_playwright.sh index a5271c58f6c4c..adab313e4c382 100644 --- a/.buildkite/scripts/steps/functional/performance_playwright.sh +++ b/.buildkite/scripts/steps/functional/performance_playwright.sh @@ -39,7 +39,7 @@ curl --retry 120 \ --retry-all-errors \ -I -XGET "${TEST_ES_URL}/_cluster/health?wait_for_nodes=>=1&wait_for_status=yellow" -journeys=("login" "ecommerce_dashboard" "flight_dashboard" "web_logs_dashboard" "promotion_tracking_dashboard" "many_fields_discover") +journeys=("login" "ecommerce_dashboard" "flight_dashboard" "web_logs_dashboard" "promotion_tracking_dashboard" "many_fields_discover" "data_stress_test_lens") for i in "${journeys[@]}"; do echo "JOURNEY[${i}] is running" diff --git a/.buildkite/scripts/steps/scalability/benchmarking.sh b/.buildkite/scripts/steps/scalability/benchmarking.sh index 3bd762796e189..00d530b7a44af 100755 --- a/.buildkite/scripts/steps/scalability/benchmarking.sh +++ b/.buildkite/scripts/steps/scalability/benchmarking.sh @@ -57,7 +57,10 @@ checkout_and_compile_load_runner() { upload_test_results() { cd "${KIBANA_DIR}" - echo "--- Archive Gatling reports and upload as build artifacts" + echo "Upload server logs as build artifacts" + tar -czf server-logs.tar.gz data/ftr_servers_logs/**/* + buildkite-agent artifact upload server-logs.tar.gz + echo "--- Upload Gatling reports as build artifacts" tar -czf "scalability_test_report.tar.gz" --exclude=simulation.log -C kibana-load-testing/target gatling buildkite-agent artifact upload "scalability_test_report.tar.gz" cd "${LATEST_RUN_ARTIFACTS_DIR}" @@ -115,6 +118,7 @@ for journey in scalability_traces/server/*; do node scripts/functional_tests \ --config x-pack/test/performance/scalability/config.ts \ --kibana-install-dir "$KIBANA_BUILD_LOCATION" \ + --logToFile \ --debug done diff --git a/.eslintrc.js b/.eslintrc.js index 406e58e17d7a6..c36e8b5e7e668 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -593,7 +593,6 @@ module.exports = { 'test/*/config_open.ts', 'test/*/*.config.ts', 'test/*/{tests,test_suites,apis,apps}/**/*', - 'test/visual_regression/tests/**/*', 'x-pack/test/*/{tests,test_suites,apis,apps}/**/*', 'x-pack/test/*/*config.*ts', 'x-pack/test/saved_object_api_integration/*/apis/**/*', @@ -898,7 +897,14 @@ module.exports = { ], }, }, - + // Profiling + { + files: ['x-pack/plugins/profiling/**/*.{js,mjs,ts,tsx}'], + rules: { + 'react-hooks/rules-of-hooks': 'error', // Checks rules of Hooks + 'react-hooks/exhaustive-deps': ['error', { additionalHooks: '^(useAsync)$' }], + }, + }, { // disable imports from legacy uptime plugin files: ['x-pack/plugins/synthetics/public/apps/synthetics/**/*.{js,mjs,ts,tsx}'], @@ -1307,7 +1313,7 @@ module.exports = { { // typescript for front and back end files: [ - 'x-pack/plugins/{alerting,stack_alerts,actions,task_manager,event_log}/**/*.{ts,tsx}', + 'x-pack/plugins/{alerting,stack_alerts,stack_connectors,actions,task_manager,event_log}/**/*.{ts,tsx}', ], rules: { '@typescript-eslint/no-explicit-any': 'error', diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 9d53eb7795943..c78de33572f14 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -13,6 +13,7 @@ /src/plugins/saved_search/ @elastic/kibana-data-discovery /x-pack/plugins/discover_enhanced/ @elastic/kibana-data-discovery /test/functional/apps/discover/ @elastic/kibana-data-discovery +/test/functional/apps/context/ @elastic/kibana-data-discovery /test/api_integration/apis/unified_field_list/ @elastic/kibana-data-discovery /x-pack/plugins/graph/ @elastic/kibana-data-discovery /x-pack/test/functional/apps/graph @elastic/kibana-data-discovery @@ -96,6 +97,7 @@ x-pack/examples/files_example @elastic/kibana-app-services # Unified Observability - on hold due to team capacity shortage # For now, if you're changing these pages, get a review from someone who understand the changes # /x-pack/plugins/observability/public/context @elastic/unified-observability +# /x-pack/test/observability_functional @elastic/unified-observability # Home/Overview/Landing Pages /x-pack/plugins/observability/public/pages/home @elastic/observability-design @@ -109,6 +111,7 @@ x-pack/examples/files_example @elastic/kibana-app-services /x-pack/plugins/observability/public/pages/cases @elastic/actionable-observability /x-pack/plugins/observability/public/pages/rules @elastic/actionable-observability /x-pack/plugins/observability/public/pages/rule_details @elastic/actionable-observability +/x-pack/test/observability_functional @elastic/actionable-observability # Infra Monitoring /x-pack/plugins/infra/ @elastic/infra-monitoring-ui @@ -133,7 +136,6 @@ x-pack/examples/files_example @elastic/kibana-app-services /x-pack/test/functional/apps/apm/ @elastic/apm-ui /x-pack/test/apm_api_integration/ @elastic/apm-ui /src/apm.js @elastic/kibana-core @vigneshshanmugam -/packages/kbn-apm-config-loader/ @vigneshshanmugam /src/core/types/elasticsearch @elastic/apm-ui /packages/kbn-utility-types/src/dot.ts @dgieselaar /packages/kbn-utility-types/src/dot_test.ts @dgieselaar @@ -156,6 +158,9 @@ x-pack/examples/files_example @elastic/kibana-app-services /x-pack/plugins/apm/public/components/app/rum_dashboard @elastic/uptime /x-pack/test/apm_api_integration/tests/csm/ @elastic/uptime +# Profiling +/x-pack/plugins/profiling @elastic/profiling-ui + # Observability onboarding tour /x-pack/plugins/observability/public/components/shared/tour @elastic/platform-onboarding /x-pack/test/functional/apps/infra/tour.ts @elastic/platform-onboarding @@ -218,7 +223,6 @@ x-pack/examples/files_example @elastic/kibana-app-services /x-pack/test/api_integration/apis/maps/ @elastic/kibana-gis /x-pack/test/functional/apps/maps/ @elastic/kibana-gis /x-pack/test/functional/es_archives/maps/ @elastic/kibana-gis -/x-pack/test/visual_regression/tests/maps/index.js @elastic/kibana-gis /x-pack/plugins/stack_alerts/server/alert_types/geo_containment @elastic/kibana-gis /x-pack/plugins/stack_alerts/public/alert_types/geo_containment @elastic/kibana-gis #CC# /x-pack/plugins/file_upload @elastic/kibana-gis @@ -261,6 +265,7 @@ x-pack/examples/files_example @elastic/kibana-app-services /x-pack/plugins/licensing/ @elastic/kibana-core /x-pack/plugins/global_search/ @elastic/kibana-core /x-pack/plugins/cloud/ @elastic/kibana-core +/x-pack/plugins/cloud_integrations/ @elastic/kibana-core /x-pack/plugins/saved_objects_tagging/ @elastic/kibana-core /x-pack/test/saved_objects_field_count/ @elastic/kibana-core /x-pack/test/saved_object_tagging/ @elastic/kibana-core @@ -322,6 +327,9 @@ x-pack/examples/files_example @elastic/kibana-app-services /x-pack/plugins/actions/ @elastic/response-ops /x-pack/plugins/event_log/ @elastic/response-ops /x-pack/plugins/task_manager/ @elastic/response-ops +/x-pack/plugins/stack_connectors/ @elastic/response-ops +/x-pack/plugins/stack_connectors/server/connector_types/stack/ @elastic/response-ops-execution +/x-pack/plugins/stack_connectors/server/connector_types/cases/ @elastic/response-ops-cases /x-pack/test/alerting_api_integration/ @elastic/response-ops /x-pack/test/plugin_api_integration/test_suites/task_manager/ @elastic/response-ops /x-pack/plugins/triggers_actions_ui/ @elastic/response-ops @@ -361,6 +369,10 @@ x-pack/examples/files_example @elastic/kibana-app-services /x-pack/plugins/ingest_pipelines/ @elastic/platform-deployment-management #CC# /x-pack/plugins/cross_cluster_replication/ @elastic/platform-deployment-management +# Management Experience - Platform Onboarding +/src/plugins/guided_onboarding/ @elastic/platform-onboarding +/examples/guided_onboarding_example/ @elastic/platform-onboarding + # Security Solution /x-pack/test/endpoint_api_integration_no_ingest/ @elastic/security-solution /x-pack/test/security_solution_endpoint/ @elastic/security-solution @@ -381,10 +393,10 @@ x-pack/examples/files_example @elastic/kibana-app-services /x-pack/plugins/security_solution/common/search_strategy/timeline @elastic/security-threat-hunting-investigations /x-pack/plugins/security_solution/common/types/timeline @elastic/security-threat-hunting-investigations -/x-pack/plugins/security_solution/cypress/integration/timeline_templates @elastic/security-threat-hunting-investigations -/x-pack/plugins/security_solution/cypress/integration/timeline @elastic/security-threat-hunting-investigations -/x-pack/plugins/security_solution/cypress/integration/detection_alerts @elastic/security-threat-hunting-investigations -/x-pack/plugins/security_solution/cypress/integration/urls @elastic/security-threat-hunting-investigations +/x-pack/plugins/security_solution/cypress/e2e/timeline_templates @elastic/security-threat-hunting-investigations +/x-pack/plugins/security_solution/cypress/e2e/timeline @elastic/security-threat-hunting-investigations +/x-pack/plugins/security_solution/cypress/e2e/detection_alerts @elastic/security-threat-hunting-investigations +/x-pack/plugins/security_solution/cypress/e2e/urls @elastic/security-threat-hunting-investigations /x-pack/plugins/security_solution/public/common/components/alerts_viewer @elastic/security-threat-hunting-investigations /x-pack/plugins/security_solution/public/detections/components/alerts_table/timeline_action @elastic/security-threat-hunting-investigations @@ -405,18 +417,18 @@ x-pack/examples/files_example @elastic/kibana-app-services /x-pack/plugins/security_solution/common/search_strategy/security_solution/network @elastic/security-threat-hunting-explore /x-pack/plugins/security_solution/common/search_strategy/security_solution/user @elastic/security-threat-hunting-explore -/x-pack/plugins/security_solution/cypress/integration/cases @elastic/security-threat-hunting-explore -/x-pack/plugins/security_solution/cypress/integration/host_details @elastic/security-threat-hunting-explore -/x-pack/plugins/security_solution/cypress/integration/hosts @elastic/security-threat-hunting-explore -/x-pack/plugins/security_solution/cypress/integration/network @elastic/security-threat-hunting-explore -/x-pack/plugins/security_solution/cypress/integration/overview @elastic/security-threat-hunting-explore -/x-pack/plugins/security_solution/cypress/integration/pagination @elastic/security-threat-hunting-explore -/x-pack/plugins/security_solution/cypress/integration/users @elastic/security-threat-hunting-explore +/x-pack/plugins/security_solution/cypress/e2e/cases @elastic/security-threat-hunting-explore +/x-pack/plugins/security_solution/cypress/e2e/host_details @elastic/security-threat-hunting-explore +/x-pack/plugins/security_solution/cypress/e2e/hosts @elastic/security-threat-hunting-explore +/x-pack/plugins/security_solution/cypress/e2e/network @elastic/security-threat-hunting-explore +/x-pack/plugins/security_solution/cypress/e2e/overview @elastic/security-threat-hunting-explore +/x-pack/plugins/security_solution/cypress/e2e/pagination @elastic/security-threat-hunting-explore +/x-pack/plugins/security_solution/cypress/e2e/users @elastic/security-threat-hunting-explore /x-pack/plugins/security_solution/cypress/screens/hosts @elastic/security-threat-hunting-explore /x-pack/plugins/security_solution/cypress/screens/network @elastic/security-threat-hunting-explore /x-pack/plugins/security_solution/cypress/tasks/hosts @elastic/security-threat-hunting-explore /x-pack/plugins/security_solution/cypress/tasks/network @elastic/security-threat-hunting-explore -/x-pack/plugins/security_solution/cypress/upgrade_integration/threat_hunting/cases @elastic/security-threat-hunting-explore +/x-pack/plugins/security_solution/cypress/upgrade_e2e/threat_hunting/cases @elastic/security-threat-hunting-explore /x-pack/plugins/security_solution/public/common/components/charts @elastic/security-threat-hunting-explore /x-pack/plugins/security_solution/public/common/components/header_page @elastic/security-threat-hunting-explore @@ -449,6 +461,9 @@ x-pack/examples/files_example @elastic/kibana-app-services /x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users @elastic/security-threat-hunting-explore ## Security Solution sub teams - Detections and Response Alerts +/x-pack/plugins/security_solution/common/detection_engine/schemas/alerts @elastic/security-detections-response-alerts +/x-pack/plugins/security_solution/common/field_maps @elastic/security-detections-response-alerts + /x-pack/plugins/security_solution/public/detections/pages/alerts @elastic/security-detections-response-alerts /x-pack/plugins/security_solution/server/lib/detection_engine/migrations @elastic/security-detections-response-alerts @@ -459,37 +474,42 @@ x-pack/examples/files_example @elastic/kibana-app-services /x-pack/plugins/security_solution/server/lib/detection_engine/routes/index @elastic/security-detections-response-alerts /x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals @elastic/security-detections-response-alerts - ## Security Solution sub teams - Detections and Response Rules -/x-pack/plugins/security_solution/cypress/integration/detection_rules @elastic/security-detections-response-rules +/x-pack/plugins/security_solution/common/detection_engine/rule_monitoring @elastic/security-detections-response-rules +/x-pack/plugins/security_solution/common/detection_engine/schemas/common @elastic/security-detections-response-rules +/x-pack/plugins/security_solution/common/detection_engine/schemas/request @elastic/security-detections-response-rules +/x-pack/plugins/security_solution/common/detection_engine/schemas/response @elastic/security-detections-response-rules -/x-pack/plugins/security_solution/public/detections/components/rules @elastic/security-detections-response-rules -/x-pack/plugins/security_solution/public/detections/components/severity @elastic/security-detections-response-rules -/x-pack/plugins/security_solution/public/detections/components/status @elastic/security-detections-response-rules -/x-pack/plugins/security_solution/public/rules @elastic/security-detections-response-rules /x-pack/plugins/security_solution/public/common/components/health_truncate_text @elastic/security-detections-response-rules /x-pack/plugins/security_solution/public/common/components/links_to_docs @elastic/security-detections-response-rules -/x-pack/plugins/security_solution/public/common/components/callouts @elastic/security-detections-response-rules /x-pack/plugins/security_solution/public/common/components/ml_popover @elastic/security-detections-response-rules +/x-pack/plugins/security_solution/public/common/components/popover_items @elastic/security-detections-response-rules +/x-pack/plugins/security_solution/public/detection_engine/rule_monitoring @elastic/security-detections-response-rules /x-pack/plugins/security_solution/public/detections/components/callouts @elastic/security-detections-response-rules +/x-pack/plugins/security_solution/public/detections/components/modals/ml_job_upgrade_modal @elastic/security-detections-response-rules +/x-pack/plugins/security_solution/public/detections/components/rules @elastic/security-detections-response-rules +/x-pack/plugins/security_solution/public/detections/components/rules/rule_preview @elastic/security-detections-response-alerts +/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules @elastic/security-detections-response-rules /x-pack/plugins/security_solution/public/detections/mitre @elastic/security-detections-response-rules /x-pack/plugins/security_solution/public/detections/pages/detection_engine/rules @elastic/security-detections-response-rules -/x-pack/plugins/security_solution/public/detections/containers/detection_engine/rules @elastic/security-detections-response-rules +/x-pack/plugins/security_solution/public/rules @elastic/security-detections-response-rules -/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions @elastic/security-detections-response-rules -/x-pack/plugins/security_solution/server/lib/detection_engine/rule_execution_log @elastic/security-detections-response-rules +/x-pack/plugins/security_solution/server/lib/detection_engine/routes/fleet @elastic/security-detections-response-rules +/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules @elastic/security-detections-response-rules +/x-pack/plugins/security_solution/server/lib/detection_engine/routes/tags @elastic/security-detections-response-rules +/x-pack/plugins/security_solution/server/lib/detection_engine/rule_monitoring @elastic/security-detections-response-rules /x-pack/plugins/security_solution/server/lib/detection_engine/rules @elastic/security-detections-response-rules -/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories @elastic/security-detections-response-rules -/x-pack/plugins/security_solution/server/utils @elastic/security-detections-response-rules /x-pack/plugins/security_solution/server/lib/detection_engine/tags @elastic/security-detections-response-rules +/x-pack/plugins/security_solution/server/utils @elastic/security-detections-response-rules ## Security Solution sub teams - Security Platform /x-pack/plugins/lists @elastic/security-solution-platform -/x-pack/plugins/security_solution/cypress/integration/data_sources @elastic/security-solution-platform -/x-pack/plugins/security_solution/cypress/integration/exceptions @elastic/security-solution-platform -/x-pack/plugins/security_solution/cypress/integration/value_lists @elastic/security-solution-platform +/x-pack/plugins/security_solution/cypress/e2e/data_sources @elastic/security-solution-platform +/x-pack/plugins/security_solution/cypress/e2e/exceptions @elastic/security-solution-platform +/x-pack/plugins/security_solution/cypress/e2e/value_lists @elastic/security-solution-platform +/x-pack/plugins/security_solution/public/detection_engine/rule_exceptions @elastic/security-solution-platform /x-pack/plugins/security_solution/public/common/components/exceptions @elastic/security-solution-platform /x-pack/plugins/security_solution/public/exceptions @elastic/security-solution-platform /x-pack/plugins/security_solution/public/detections/containers/detection_engine/lists @elastic/security-solution-platform @@ -501,22 +521,23 @@ x-pack/examples/files_example @elastic/kibana-app-services /x-pack/plugins/security_solution/public/common/components/threat_match @elastic/security-solution-platform ## Security Solution cross teams ownership -/x-pack/plugins/security_solution/cypress/downloads @elastic/security-detections-response @elastic/security-threat-hunting /x-pack/plugins/security_solution/cypress/fixtures @elastic/security-detections-response @elastic/security-threat-hunting /x-pack/plugins/security_solution/cypress/helpers @elastic/security-detections-response @elastic/security-threat-hunting +/x-pack/plugins/security_solution/cypress/e2e/detection_rules @elastic/security-detections-response-rules @elastic/security-detections-response-alerts /x-pack/plugins/security_solution/cypress/objects @elastic/security-detections-response @elastic/security-threat-hunting /x-pack/plugins/security_solution/cypress/plugins @elastic/security-detections-response @elastic/security-threat-hunting +/x-pack/plugins/security_solution/cypress/screens/common @elastic/security-detections-response @elastic/security-threat-hunting /x-pack/plugins/security_solution/cypress/support @elastic/security-detections-response @elastic/security-threat-hunting /x-pack/plugins/security_solution/cypress/urls @elastic/security-threat-hunting-investigations @elastic/security-solution-platform -/x-pack/plugins/security_solution/screens/common @elastic/security-detections-response @elastic/security-threat-hunting - -/x-pack/plugins/security_solution/common/ecs @elastic/security-detections-response-rules @elastic/security-threat-hunting-investigations +/x-pack/plugins/security_solution/common/ecs @elastic/security-threat-hunting-investigations /x-pack/plugins/security_solution/common/test @elastic/security-detections-response-rules @elastic/security-detections-response-alerts +/x-pack/plugins/security_solution/public/common/components/callouts @elastic/security-detections-response /x-pack/plugins/security_solution/public/common/components/hover_actions @elastic/security-threat-hunting-explore @elastic/security-threat-hunting-investigations -/x-pack/plugins/security_solution/server/routes @elastic/security-detections-response-alerts @elastic/security-detections-response-rules +/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions @elastic/security-solution-platform @elastic/security-detections-response-rules +/x-pack/plugins/security_solution/server/routes @elastic/security-detections-response @elastic/security-threat-hunting ## Security Solution sub teams - security-onboarding-and-lifecycle-mgt @@ -538,8 +559,8 @@ x-pack/plugins/security_solution/server/usage/ @elastic/security-data-analytics x-pack/plugins/security_solution/server/lib/telemetry/ @elastic/security-data-analytics ## Security Solution sub teams - security-engineering-productivity -x-pack/plugins/security_solution/cypress/ccs_integration @elastic/security-engineering-productivity -x-pack/plugins/security_solution/cypress/upgrade_integration @elastic/security-engineering-productivity +x-pack/plugins/security_solution/cypress/ccs_e2e @elastic/security-engineering-productivity +x-pack/plugins/security_solution/cypress/upgrade_e2e @elastic/security-engineering-productivity x-pack/plugins/security_solution/cypress/README.md @elastic/security-engineering-productivity x-pack/test/security_solution_cypress @elastic/security-engineering-productivity @@ -561,6 +582,9 @@ x-pack/test/threat_intelligence_cypress @elastic/protections-experience # Security Asset Management /x-pack/plugins/osquery @elastic/security-asset-management +/x-pack/plugins/security_solution/common/detection_engine/rule_response_actions @elastic/security-asset-management +/x-pack/plugins/security_solution/public/detection_engine/rule_response_actions @elastic/security-asset-management +/x-pack/plugins/security_solution/server/lib/detection_engine/rule_response_actions @elastic/security-asset-management # Cloud Security Posture /x-pack/plugins/cloud_security_posture/ @elastic/kibana-cloud-security-posture @@ -569,7 +593,7 @@ x-pack/test/threat_intelligence_cypress @elastic/protections-experience # Security Solution onboarding tour /x-pack/plugins/security_solution/public/common/components/guided_onboarding @elastic/platform-onboarding -/x-pack/plugins/security_solution/cypress/integration/guided_onboarding @elastic/platform-onboarding +/x-pack/plugins/security_solution/cypress/e2e/guided_onboarding @elastic/platform-onboarding # Design (at the bottom for specificity of SASS files) **/*.scss @elastic/kibana-design @@ -646,6 +670,7 @@ packages/analytics/shippers/elastic_v3/browser @elastic/kibana-core packages/analytics/shippers/elastic_v3/common @elastic/kibana-core packages/analytics/shippers/elastic_v3/server @elastic/kibana-core packages/analytics/shippers/fullstory @elastic/kibana-core +packages/content-management/table_list @elastic/shared-ux packages/core/analytics/core-analytics-browser @elastic/kibana-core packages/core/analytics/core-analytics-browser-internal @elastic/kibana-core packages/core/analytics/core-analytics-browser-mocks @elastic/kibana-core @@ -656,6 +681,8 @@ packages/core/application/core-application-browser @elastic/kibana-core packages/core/application/core-application-browser-internal @elastic/kibana-core packages/core/application/core-application-browser-mocks @elastic/kibana-core packages/core/application/core-application-common @elastic/kibana-core +packages/core/apps/core-apps-browser-internal @elastic/kibana-core +packages/core/apps/core-apps-browser-mocks @elastic/kibana-core packages/core/base/core-base-browser-internal @elastic/kibana-core packages/core/base/core-base-browser-mocks @elastic/kibana-core packages/core/base/core-base-common @elastic/kibana-core @@ -781,6 +808,9 @@ packages/core/ui-settings/core-ui-settings-browser @elastic/kibana-core packages/core/ui-settings/core-ui-settings-browser-internal @elastic/kibana-core packages/core/ui-settings/core-ui-settings-browser-mocks @elastic/kibana-core packages/core/ui-settings/core-ui-settings-common @elastic/kibana-core +packages/core/ui-settings/core-ui-settings-server @elastic/kibana-core +packages/core/ui-settings/core-ui-settings-server-internal @elastic/kibana-core +packages/core/ui-settings/core-ui-settings-server-mocks @elastic/kibana-core packages/core/usage-data/core-usage-data-base-server-internal @elastic/kibana-core packages/core/usage-data/core-usage-data-server @elastic/kibana-core packages/core/usage-data/core-usage-data-server-internal @elastic/kibana-core @@ -793,7 +823,7 @@ packages/kbn-alerts @elastic/security-solution packages/kbn-ambient-storybook-types @elastic/kibana-operations packages/kbn-ambient-ui-types @elastic/kibana-operations packages/kbn-analytics @elastic/kibana-core -packages/kbn-apm-config-loader @elastic/kibana-core +packages/kbn-apm-config-loader @elastic/kibana-core @vigneshshanmugam packages/kbn-apm-synthtrace @elastic/apm-ui packages/kbn-apm-utils @elastic/apm-ui packages/kbn-axe-config @elastic/kibana-qa @@ -824,6 +854,7 @@ packages/kbn-es @elastic/kibana-operations packages/kbn-es-archiver @elastic/kibana-operations packages/kbn-es-errors @elastic/kibana-core packages/kbn-es-query @elastic/kibana-app-services +packages/kbn-es-types @elastic/kibana-core @elastic/apm-ui packages/kbn-eslint-config @elastic/kibana-operations packages/kbn-eslint-plugin-disable @elastic/kibana-operations packages/kbn-eslint-plugin-eslint @elastic/kibana-operations diff --git a/.i18nrc.json b/.i18nrc.json index 3d223732dddaf..20b2588ca2fab 100644 --- a/.i18nrc.json +++ b/.i18nrc.json @@ -7,6 +7,7 @@ "bfetch": "src/plugins/bfetch", "charts": "src/plugins/charts", "console": "src/plugins/console", + "contentManagement": "packages/content-management", "core": [ "src/core", "packages/core" @@ -40,6 +41,7 @@ "eventAnnotation": "src/plugins/event_annotation", "fieldFormats": "src/plugins/field_formats", "flot": "packages/kbn-flot-charts/lib", + "guidedOnboarding": "src/plugins/guided_onboarding", "home": "src/plugins/home", "homePackages": "packages/home", "indexPatternEditor": "src/plugins/data_view_editor", diff --git a/STYLEGUIDE.mdx b/STYLEGUIDE.mdx index 8e043cba92249..10815b1f0002c 100644 --- a/STYLEGUIDE.mdx +++ b/STYLEGUIDE.mdx @@ -630,7 +630,7 @@ Doing so ensures the styles are never separated or lost on import and allows for better modularization (smaller individual plugin asset footprint). All SASS (.scss) files will automatically build with the [EUI](https://elastic.github.io/eui/#/guidelines/sass) -& Kibana invisibles (SASS variables, mixins, functions) from the [`globals_[theme].scss` file](src/core/public/core_app/styles/_globals_v8light.scss). +& Kibana invisibles (SASS variables, mixins, functions) from the [`globals_[theme].scss` file](src/core/public/styles/core_app/_globals_v8light.scss). While the styles for this component will only be loaded if the component exists on the page, the styles **will** be global and so it is recommended to use a three letter prefix on your diff --git a/api_docs/actions.devdocs.json b/api_docs/actions.devdocs.json index c2759a6e70e0f..bf3e33e925837 100644 --- a/api_docs/actions.devdocs.json +++ b/api_docs/actions.devdocs.json @@ -1444,6 +1444,20 @@ "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "actions", + "id": "def-server.ActionTypeExecutorOptions.configurationUtilities", + "type": "Object", + "tags": [], + "label": "configurationUtilities", + "description": [], + "signature": [ + "ActionsConfigurationUtilities" + ], + "path": "x-pack/plugins/actions/server/types.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -1667,171 +1681,6 @@ "trackAdoption": false, "initialIsOpen": false }, - { - "parentPluginId": "actions", - "id": "def-server.ActionParamsType", - "type": "Type", - "tags": [], - "label": "ActionParamsType", - "description": [], - "signature": [ - "{ readonly subAction: \"pushToService\"; readonly subActionParams: Readonly<{} & { incident: Readonly<{} & { tags: string[] | null; title: string; description: string | null; externalId: string | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }" - ], - "path": "x-pack/plugins/actions/server/builtin_action_types/cases_webhook/index.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "actions", - "id": "def-server.ActionParamsType", - "type": "Type", - "tags": [], - "label": "ActionParamsType", - "description": [], - "signature": [ - "{ readonly message: string; readonly to: string[]; readonly subject: string; readonly cc: string[]; readonly bcc: string[]; readonly kibanaFooterLink: Readonly<{} & { path: string; text: string; }>; }" - ], - "path": "x-pack/plugins/actions/server/builtin_action_types/email.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "actions", - "id": "def-server.ActionParamsType", - "type": "Type", - "tags": [], - "label": "ActionParamsType", - "description": [], - "signature": [ - "{ readonly documents: Record[]; readonly indexOverride: string | null; }" - ], - "path": "x-pack/plugins/actions/server/builtin_action_types/es_index.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "actions", - "id": "def-server.ActionParamsType", - "type": "Type", - "tags": [], - "label": "ActionParamsType", - "description": [], - "signature": [ - "{ readonly source?: string | undefined; readonly summary?: string | undefined; readonly group?: string | undefined; readonly component?: string | undefined; readonly timestamp?: string | undefined; readonly eventAction?: \"resolve\" | \"trigger\" | \"acknowledge\" | undefined; readonly dedupKey?: string | undefined; readonly severity?: \"error\" | \"warning\" | \"info\" | \"critical\" | undefined; readonly class?: string | undefined; }" - ], - "path": "x-pack/plugins/actions/server/builtin_action_types/pagerduty.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "actions", - "id": "def-server.ActionParamsType", - "type": "Type", - "tags": [], - "label": "ActionParamsType", - "description": [], - "signature": [ - "{ readonly message: string; readonly level: \"error\" | \"info\" | \"debug\" | \"trace\" | \"warn\" | \"fatal\"; }" - ], - "path": "x-pack/plugins/actions/server/builtin_action_types/server_log.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "actions", - "id": "def-server.ActionParamsType", - "type": "Type", - "tags": [], - "label": "ActionParamsType", - "description": [], - "signature": [ - "{ readonly message: string; }" - ], - "path": "x-pack/plugins/actions/server/builtin_action_types/slack.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "actions", - "id": "def-server.ActionParamsType", - "type": "Type", - "tags": [], - "label": "ActionParamsType", - "description": [], - "signature": [ - "{ readonly body?: string | undefined; }" - ], - "path": "x-pack/plugins/actions/server/builtin_action_types/webhook.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "actions", - "id": "def-server.ActionParamsType", - "type": "Type", - "tags": [], - "label": "ActionParamsType", - "description": [], - "signature": [ - "Readonly<{} & { subAction: \"getFields\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"getIncident\"; subActionParams: Readonly<{} & { externalId: string; }>; }> | Readonly<{} & { subAction: \"handshake\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"pushToService\"; subActionParams: Readonly<{} & { incident: Readonly<{} & { description: string | null; category: string | null; externalId: string | null; severity: string | null; urgency: string | null; impact: string | null; short_description: string; subcategory: string | null; correlation_id: string | null; correlation_display: string | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"getChoices\"; subActionParams: Readonly<{} & { fields: string[]; }>; }> | Readonly<{} & { subAction: \"getFields\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"getIncident\"; subActionParams: Readonly<{} & { externalId: string; }>; }> | Readonly<{} & { subAction: \"handshake\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"pushToService\"; subActionParams: Readonly<{} & { incident: Readonly<{} & { description: string | null; category: string | null; externalId: string | null; short_description: string; subcategory: string | null; correlation_id: string | null; correlation_display: string | null; dest_ip: string | string[] | null; malware_hash: string | string[] | null; malware_url: string | string[] | null; source_ip: string | string[] | null; priority: string | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"getChoices\"; subActionParams: Readonly<{} & { fields: string[]; }>; }>" - ], - "path": "x-pack/plugins/actions/server/builtin_action_types/servicenow/index.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "actions", - "id": "def-server.ActionParamsType", - "type": "Type", - "tags": [], - "label": "ActionParamsType", - "description": [], - "signature": [ - "Readonly<{} & { subAction: \"getFields\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"getIncident\"; subActionParams: Readonly<{} & { externalId: string; }>; }> | Readonly<{} & { subAction: \"handshake\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"pushToService\"; subActionParams: Readonly<{} & { incident: Readonly<{} & { description: string | null; parent: string | null; summary: string; externalId: string | null; priority: string | null; issueType: string | null; labels: string[] | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"issueTypes\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"fieldsByIssueType\"; subActionParams: Readonly<{} & { id: string; }>; }> | Readonly<{} & { subAction: \"issues\"; subActionParams: Readonly<{} & { title: string; }>; }> | Readonly<{} & { subAction: \"issue\"; subActionParams: Readonly<{} & { id: string; }>; }>" - ], - "path": "x-pack/plugins/actions/server/builtin_action_types/jira/index.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "actions", - "id": "def-server.ActionParamsType", - "type": "Type", - "tags": [], - "label": "ActionParamsType", - "description": [], - "signature": [ - "Readonly<{} & { subAction: \"getFields\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"getIncident\"; subActionParams: Readonly<{} & { externalId: string; }>; }> | Readonly<{} & { subAction: \"handshake\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"pushToService\"; subActionParams: Readonly<{} & { incident: Readonly<{} & { description: string | null; name: string; externalId: string | null; incidentTypes: number[] | null; severityCode: number | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"incidentTypes\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"severity\"; subActionParams: Readonly<{} & {}>; }>" - ], - "path": "x-pack/plugins/actions/server/builtin_action_types/resilient/index.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "actions", - "id": "def-server.ActionParamsType", - "type": "Type", - "tags": [], - "label": "ActionParamsType", - "description": [], - "signature": [ - "{ readonly message: string; }" - ], - "path": "x-pack/plugins/actions/server/builtin_action_types/teams.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, { "parentPluginId": "actions", "id": "def-server.ActionsAuthorization", @@ -1947,186 +1796,6 @@ "deprecated": false, "trackAdoption": false, "initialIsOpen": false - }, - { - "parentPluginId": "actions", - "id": "def-server.ActionTypeId", - "type": "string", - "tags": [], - "label": "ActionTypeId", - "description": [], - "signature": [ - "\".cases-webhook\"" - ], - "path": "x-pack/plugins/actions/server/builtin_action_types/cases_webhook/index.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "actions", - "id": "def-server.ActionTypeId", - "type": "string", - "tags": [], - "label": "ActionTypeId", - "description": [], - "signature": [ - "\".email\"" - ], - "path": "x-pack/plugins/actions/server/builtin_action_types/email.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "actions", - "id": "def-server.ActionTypeId", - "type": "string", - "tags": [], - "label": "ActionTypeId", - "description": [], - "signature": [ - "\".index\"" - ], - "path": "x-pack/plugins/actions/server/builtin_action_types/es_index.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "actions", - "id": "def-server.ActionTypeId", - "type": "string", - "tags": [], - "label": "ActionTypeId", - "description": [], - "signature": [ - "\".pagerduty\"" - ], - "path": "x-pack/plugins/actions/server/builtin_action_types/pagerduty.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "actions", - "id": "def-server.ActionTypeId", - "type": "string", - "tags": [], - "label": "ActionTypeId", - "description": [], - "signature": [ - "\".server-log\"" - ], - "path": "x-pack/plugins/actions/server/builtin_action_types/server_log.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "actions", - "id": "def-server.ActionTypeId", - "type": "string", - "tags": [], - "label": "ActionTypeId", - "description": [], - "signature": [ - "\".slack\"" - ], - "path": "x-pack/plugins/actions/server/builtin_action_types/slack.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "actions", - "id": "def-server.ActionTypeId", - "type": "string", - "tags": [], - "label": "ActionTypeId", - "description": [], - "signature": [ - "\".webhook\"" - ], - "path": "x-pack/plugins/actions/server/builtin_action_types/webhook.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "actions", - "id": "def-server.ActionTypeId", - "type": "string", - "tags": [], - "label": "ActionTypeId", - "description": [], - "signature": [ - "\".jira\"" - ], - "path": "x-pack/plugins/actions/server/builtin_action_types/jira/index.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "actions", - "id": "def-server.ActionTypeId", - "type": "string", - "tags": [], - "label": "ActionTypeId", - "description": [], - "signature": [ - "\".resilient\"" - ], - "path": "x-pack/plugins/actions/server/builtin_action_types/resilient/index.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "actions", - "id": "def-server.ActionTypeId", - "type": "string", - "tags": [], - "label": "ActionTypeId", - "description": [], - "signature": [ - "\".teams\"" - ], - "path": "x-pack/plugins/actions/server/builtin_action_types/teams.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "actions", - "id": "def-server.ServiceNowITSMActionTypeId", - "type": "string", - "tags": [], - "label": "ServiceNowITSMActionTypeId", - "description": [], - "signature": [ - "\".servicenow\"" - ], - "path": "x-pack/plugins/actions/server/builtin_action_types/servicenow/config.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "actions", - "id": "def-server.ServiceNowSIRActionTypeId", - "type": "string", - "tags": [], - "label": "ServiceNowSIRActionTypeId", - "description": [], - "signature": [ - "\".servicenow-sir\"" - ], - "path": "x-pack/plugins/actions/server/builtin_action_types/servicenow/config.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false } ], "objects": [], @@ -2310,6 +1979,22 @@ "trackAdoption": false, "children": [], "returnComment": [] + }, + { + "parentPluginId": "actions", + "id": "def-server.PluginSetupContract.getActionsHealth", + "type": "Function", + "tags": [], + "label": "getActionsHealth", + "description": [], + "signature": [ + "() => { hasPermanentEncryptionKey: boolean; }" + ], + "path": "x-pack/plugins/actions/server/plugin.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] } ], "lifecycle": "setup", @@ -3370,89 +3055,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "actions", - "id": "def-common.SNProductsConfigValue", - "type": "Interface", - "tags": [], - "label": "SNProductsConfigValue", - "description": [], - "path": "x-pack/plugins/actions/common/servicenow_config.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "actions", - "id": "def-common.SNProductsConfigValue.table", - "type": "string", - "tags": [], - "label": "table", - "description": [], - "path": "x-pack/plugins/actions/common/servicenow_config.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "actions", - "id": "def-common.SNProductsConfigValue.appScope", - "type": "string", - "tags": [], - "label": "appScope", - "description": [], - "path": "x-pack/plugins/actions/common/servicenow_config.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "actions", - "id": "def-common.SNProductsConfigValue.useImportAPI", - "type": "boolean", - "tags": [], - "label": "useImportAPI", - "description": [], - "path": "x-pack/plugins/actions/common/servicenow_config.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "actions", - "id": "def-common.SNProductsConfigValue.importSetTable", - "type": "string", - "tags": [], - "label": "importSetTable", - "description": [], - "path": "x-pack/plugins/actions/common/servicenow_config.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "actions", - "id": "def-common.SNProductsConfigValue.commentFieldKey", - "type": "string", - "tags": [], - "label": "commentFieldKey", - "description": [], - "path": "x-pack/plugins/actions/common/servicenow_config.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "actions", - "id": "def-common.SNProductsConfigValue.appId", - "type": "string", - "tags": [], - "label": "appId", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/actions/common/servicenow_config.ts", - "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "actions", "id": "def-common.ValidatedEmail", @@ -3544,18 +3146,6 @@ } ], "enums": [ - { - "parentPluginId": "actions", - "id": "def-common.AdditionalEmailServices", - "type": "Enum", - "tags": [], - "label": "AdditionalEmailServices", - "description": [], - "path": "x-pack/plugins/actions/common/index.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, { "parentPluginId": "actions", "id": "def-common.InvalidEmailReason", @@ -3724,36 +3314,6 @@ "trackAdoption": false, "initialIsOpen": false }, - { - "parentPluginId": "actions", - "id": "def-common.DEFAULT_ALERTS_GROUPING_KEY", - "type": "string", - "tags": [], - "label": "DEFAULT_ALERTS_GROUPING_KEY", - "description": [], - "signature": [ - "\"{{rule.id}}:{{alert.id}}\"" - ], - "path": "x-pack/plugins/actions/common/servicenow_config.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "actions", - "id": "def-common.FIELD_PREFIX", - "type": "string", - "tags": [], - "label": "FIELD_PREFIX", - "description": [], - "signature": [ - "\"u_\"" - ], - "path": "x-pack/plugins/actions/common/servicenow_config.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, { "parentPluginId": "actions", "id": "def-common.INTERNAL_BASE_ACTION_API_PATH", @@ -3872,104 +3432,6 @@ "trackAdoption": false, "initialIsOpen": false }, - { - "parentPluginId": "actions", - "id": "def-common.ServiceNowITOMActionTypeId", - "type": "string", - "tags": [], - "label": "ServiceNowITOMActionTypeId", - "description": [], - "signature": [ - "\".servicenow-itom\"" - ], - "path": "x-pack/plugins/actions/common/servicenow_config.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "actions", - "id": "def-common.ServiceNowITSMActionTypeId", - "type": "string", - "tags": [], - "label": "ServiceNowITSMActionTypeId", - "description": [], - "signature": [ - "\".servicenow\"" - ], - "path": "x-pack/plugins/actions/common/servicenow_config.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "actions", - "id": "def-common.serviceNowITSMTable", - "type": "string", - "tags": [], - "label": "serviceNowITSMTable", - "description": [], - "signature": [ - "\"incident\"" - ], - "path": "x-pack/plugins/actions/common/servicenow_config.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "actions", - "id": "def-common.ServiceNowSIRActionTypeId", - "type": "string", - "tags": [], - "label": "ServiceNowSIRActionTypeId", - "description": [], - "signature": [ - "\".servicenow-sir\"" - ], - "path": "x-pack/plugins/actions/common/servicenow_config.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "actions", - "id": "def-common.serviceNowSIRTable", - "type": "string", - "tags": [], - "label": "serviceNowSIRTable", - "description": [], - "signature": [ - "\"sn_si_incident\"" - ], - "path": "x-pack/plugins/actions/common/servicenow_config.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "actions", - "id": "def-common.SNProductsConfig", - "type": "Type", - "tags": [], - "label": "SNProductsConfig", - "description": [], - "signature": [ - "{ [x: string]: ", - { - "pluginId": "actions", - "scope": "common", - "docId": "kibActionsPluginApi", - "section": "def-common.SNProductsConfigValue", - "text": "SNProductsConfigValue" - }, - "; }" - ], - "path": "x-pack/plugins/actions/common/servicenow_config.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, { "parentPluginId": "actions", "id": "def-common.UptimeConnectorFeatureId", @@ -4143,255 +3605,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "actions", - "id": "def-common.snExternalServiceConfig", - "type": "Object", - "tags": [], - "label": "snExternalServiceConfig", - "description": [], - "path": "x-pack/plugins/actions/common/servicenow_config.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "actions", - "id": "def-common.snExternalServiceConfig..servicenow", - "type": "Object", - "tags": [], - "label": "'.servicenow'", - "description": [], - "path": "x-pack/plugins/actions/common/servicenow_config.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "actions", - "id": "def-common.snExternalServiceConfig..servicenow.importSetTable", - "type": "string", - "tags": [], - "label": "importSetTable", - "description": [], - "path": "x-pack/plugins/actions/common/servicenow_config.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "actions", - "id": "def-common.snExternalServiceConfig..servicenow.appScope", - "type": "string", - "tags": [], - "label": "appScope", - "description": [], - "path": "x-pack/plugins/actions/common/servicenow_config.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "actions", - "id": "def-common.snExternalServiceConfig..servicenow.table", - "type": "string", - "tags": [], - "label": "table", - "description": [], - "path": "x-pack/plugins/actions/common/servicenow_config.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "actions", - "id": "def-common.snExternalServiceConfig..servicenow.useImportAPI", - "type": "boolean", - "tags": [], - "label": "useImportAPI", - "description": [], - "signature": [ - "true" - ], - "path": "x-pack/plugins/actions/common/servicenow_config.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "actions", - "id": "def-common.snExternalServiceConfig..servicenow.commentFieldKey", - "type": "string", - "tags": [], - "label": "commentFieldKey", - "description": [], - "path": "x-pack/plugins/actions/common/servicenow_config.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "actions", - "id": "def-common.snExternalServiceConfig..servicenow.appId", - "type": "string", - "tags": [], - "label": "appId", - "description": [], - "path": "x-pack/plugins/actions/common/servicenow_config.ts", - "deprecated": false, - "trackAdoption": false - } - ] - }, - { - "parentPluginId": "actions", - "id": "def-common.snExternalServiceConfig..servicenowsir", - "type": "Object", - "tags": [], - "label": "'.servicenow-sir'", - "description": [], - "path": "x-pack/plugins/actions/common/servicenow_config.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "actions", - "id": "def-common.snExternalServiceConfig..servicenowsir.importSetTable", - "type": "string", - "tags": [], - "label": "importSetTable", - "description": [], - "path": "x-pack/plugins/actions/common/servicenow_config.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "actions", - "id": "def-common.snExternalServiceConfig..servicenowsir.appScope", - "type": "string", - "tags": [], - "label": "appScope", - "description": [], - "path": "x-pack/plugins/actions/common/servicenow_config.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "actions", - "id": "def-common.snExternalServiceConfig..servicenowsir.table", - "type": "string", - "tags": [], - "label": "table", - "description": [], - "path": "x-pack/plugins/actions/common/servicenow_config.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "actions", - "id": "def-common.snExternalServiceConfig..servicenowsir.useImportAPI", - "type": "boolean", - "tags": [], - "label": "useImportAPI", - "description": [], - "signature": [ - "true" - ], - "path": "x-pack/plugins/actions/common/servicenow_config.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "actions", - "id": "def-common.snExternalServiceConfig..servicenowsir.commentFieldKey", - "type": "string", - "tags": [], - "label": "commentFieldKey", - "description": [], - "path": "x-pack/plugins/actions/common/servicenow_config.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "actions", - "id": "def-common.snExternalServiceConfig..servicenowsir.appId", - "type": "string", - "tags": [], - "label": "appId", - "description": [], - "path": "x-pack/plugins/actions/common/servicenow_config.ts", - "deprecated": false, - "trackAdoption": false - } - ] - }, - { - "parentPluginId": "actions", - "id": "def-common.snExternalServiceConfig..servicenowitom", - "type": "Object", - "tags": [], - "label": "'.servicenow-itom'", - "description": [], - "path": "x-pack/plugins/actions/common/servicenow_config.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "actions", - "id": "def-common.snExternalServiceConfig..servicenowitom.importSetTable", - "type": "string", - "tags": [], - "label": "importSetTable", - "description": [], - "path": "x-pack/plugins/actions/common/servicenow_config.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "actions", - "id": "def-common.snExternalServiceConfig..servicenowitom.appScope", - "type": "string", - "tags": [], - "label": "appScope", - "description": [], - "path": "x-pack/plugins/actions/common/servicenow_config.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "actions", - "id": "def-common.snExternalServiceConfig..servicenowitom.table", - "type": "string", - "tags": [], - "label": "table", - "description": [], - "path": "x-pack/plugins/actions/common/servicenow_config.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "actions", - "id": "def-common.snExternalServiceConfig..servicenowitom.useImportAPI", - "type": "boolean", - "tags": [], - "label": "useImportAPI", - "description": [], - "signature": [ - "false" - ], - "path": "x-pack/plugins/actions/common/servicenow_config.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "actions", - "id": "def-common.snExternalServiceConfig..servicenowitom.commentFieldKey", - "type": "string", - "tags": [], - "label": "commentFieldKey", - "description": [], - "path": "x-pack/plugins/actions/common/servicenow_config.ts", - "deprecated": false, - "trackAdoption": false - } - ] - } - ], - "initialIsOpen": false - }, { "parentPluginId": "actions", "id": "def-common.UptimeConnectorFeature", diff --git a/api_docs/actions.mdx b/api_docs/actions.mdx index 7b77296a7abb9..dcbf086f39208 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions'] --- import actionsObj from './actions.devdocs.json'; @@ -21,7 +21,7 @@ Contact [Response Ops](https://github.com/orgs/elastic/teams/response-ops) for q | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 272 | 0 | 267 | 19 | +| 214 | 0 | 209 | 19 | ## Client diff --git a/api_docs/advanced_settings.devdocs.json b/api_docs/advanced_settings.devdocs.json index 04693d637ccb0..7942869bbf8cb 100644 --- a/api_docs/advanced_settings.devdocs.json +++ b/api_docs/advanced_settings.devdocs.json @@ -294,9 +294,201 @@ } ], "initialIsOpen": false + }, + { + "parentPluginId": "advancedSettings", + "id": "def-public.toEditableConfig", + "type": "Function", + "tags": [], + "label": "toEditableConfig", + "description": [], + "signature": [ + "({\n def,\n name,\n value,\n isCustom,\n isOverridden,\n}: { def: ", + "PublicUiSettingsParams", + " & ", + "UserProvidedValues", + "; name: string; value: ", + "SavedObjectAttribute", + "; isCustom: boolean; isOverridden: boolean; }) => ", + "FieldSetting" + ], + "path": "src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "advancedSettings", + "id": "def-public.toEditableConfig.$1", + "type": "Object", + "tags": [], + "label": "{\n def,\n name,\n value,\n isCustom,\n isOverridden,\n}", + "description": [], + "path": "src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "advancedSettings", + "id": "def-public.toEditableConfig.$1.def", + "type": "CompoundType", + "tags": [], + "label": "def", + "description": [], + "signature": [ + "PublicUiSettingsParams", + " & ", + "UserProvidedValues", + "" + ], + "path": "src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "advancedSettings", + "id": "def-public.toEditableConfig.$1.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "path": "src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "advancedSettings", + "id": "def-public.toEditableConfig.$1.value", + "type": "CompoundType", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "SavedObjectAttributeSingle", + " | ", + "SavedObjectAttributeSingle", + "[]" + ], + "path": "src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "advancedSettings", + "id": "def-public.toEditableConfig.$1.isCustom", + "type": "boolean", + "tags": [], + "label": "isCustom", + "description": [], + "path": "src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "advancedSettings", + "id": "def-public.toEditableConfig.$1.isOverridden", + "type": "boolean", + "tags": [], + "label": "isOverridden", + "description": [], + "path": "src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts", + "deprecated": false, + "trackAdoption": false + } + ] + } + ], + "returnComment": [ + "the editable config object" + ], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "advancedSettings", + "id": "def-public.FieldState", + "type": "Interface", + "tags": [], + "label": "FieldState", + "description": [], + "path": "src/plugins/advanced_settings/public/management_app/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "advancedSettings", + "id": "def-public.FieldState.value", + "type": "Any", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/advanced_settings/public/management_app/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "advancedSettings", + "id": "def-public.FieldState.changeImage", + "type": "CompoundType", + "tags": [], + "label": "changeImage", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/advanced_settings/public/management_app/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "advancedSettings", + "id": "def-public.FieldState.loading", + "type": "CompoundType", + "tags": [], + "label": "loading", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/advanced_settings/public/management_app/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "advancedSettings", + "id": "def-public.FieldState.isInvalid", + "type": "CompoundType", + "tags": [], + "label": "isInvalid", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/advanced_settings/public/management_app/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "advancedSettings", + "id": "def-public.FieldState.error", + "type": "CompoundType", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "string | null | undefined" + ], + "path": "src/plugins/advanced_settings/public/management_app/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false } ], - "interfaces": [], "enums": [], "misc": [], "objects": [], diff --git a/api_docs/advanced_settings.mdx b/api_docs/advanced_settings.mdx index 8497e2ae833d5..99d010dcd47bb 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings'] --- import advancedSettingsObj from './advanced_settings.devdocs.json'; @@ -21,7 +21,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 23 | 0 | 19 | 1 | +| 36 | 1 | 32 | 2 | ## Client @@ -37,3 +37,6 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que ### Classes +### Interfaces + + diff --git a/api_docs/aiops.devdocs.json b/api_docs/aiops.devdocs.json index ec6cbc9258812..52234380bb0a6 100644 --- a/api_docs/aiops.devdocs.json +++ b/api_docs/aiops.devdocs.json @@ -43,6 +43,47 @@ ], "returnComment": [], "initialIsOpen": false + }, + { + "parentPluginId": "aiops", + "id": "def-public.LogCategorization", + "type": "Function", + "tags": [], + "label": "LogCategorization", + "description": [ + "\nLazy-wrapped LogCategorizationAppStateProps React component" + ], + "signature": [ + "(props: React.PropsWithChildren<", + "LogCategorizationAppStateProps", + ">) => JSX.Element" + ], + "path": "x-pack/plugins/aiops/public/shared_lazy_components.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "aiops", + "id": "def-public.LogCategorization.$1", + "type": "CompoundType", + "tags": [], + "label": "props", + "description": [ + "- properties specifying the data on which to run the analysis." + ], + "signature": [ + "React.PropsWithChildren<", + "LogCategorizationAppStateProps", + ">" + ], + "path": "x-pack/plugins/aiops/public/shared_lazy_components.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false } ], "interfaces": [], diff --git a/api_docs/aiops.mdx b/api_docs/aiops.mdx index 28fd735f6e461..fb6b6937fc76b 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops'] --- import aiopsObj from './aiops.devdocs.json'; @@ -21,7 +21,7 @@ Contact [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) for q | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 7 | 0 | 0 | 1 | +| 9 | 0 | 0 | 2 | ## Client diff --git a/api_docs/alerting.devdocs.json b/api_docs/alerting.devdocs.json index 5eecc7808e303..a19bdb320740d 100644 --- a/api_docs/alerting.devdocs.json +++ b/api_docs/alerting.devdocs.json @@ -44,7 +44,7 @@ "The rule to view" ], "signature": [ - "{ params: never; tags: string[]; id: string; monitoring?: ", + "{ name: string; params: never; tags: string[]; id: string; monitoring?: ", { "pluginId": "alerting", "scope": "common", @@ -52,7 +52,7 @@ "section": "def-common.RuleMonitoring", "text": "RuleMonitoring" }, - " | undefined; name: string; enabled: boolean; actions: ", + " | undefined; enabled: boolean; actions: ", { "pluginId": "alerting", "scope": "common", @@ -1819,7 +1819,7 @@ "section": "def-common.SanitizedRule", "text": "SanitizedRule" }, - ", \"tags\" | \"name\" | \"enabled\" | \"actions\" | \"throttle\" | \"consumer\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"notifyWhen\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }" + ", \"name\" | \"tags\" | \"enabled\" | \"actions\" | \"throttle\" | \"consumer\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"notifyWhen\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, @@ -1969,13 +1969,7 @@ "label": "uiSettingsClient", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IUiSettingsClient", - "text": "IUiSettingsClient" - } + "IUiSettingsClient" ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, @@ -2569,7 +2563,15 @@ "section": "def-common.IntervalSchedule", "text": "IntervalSchedule" }, - "; } | { operation: \"set\"; field: \"throttle\"; value: string | null; } | { operation: \"set\"; field: \"notifyWhen\"; value: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; }" + "; } | { operation: \"set\"; field: \"throttle\"; value: string | null; } | { operation: \"set\"; field: \"notifyWhen\"; value: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; } | { operation: \"set\"; field: \"snoozeSchedule\"; value: ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RuleSnoozeSchedule", + "text": "RuleSnoozeSchedule" + }, + "; } | { operation: \"delete\"; field: \"snoozeSchedule\"; value?: string[] | undefined; } | { operation: \"set\"; field: \"apiKey\"; value?: undefined; }" ], "path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts", "deprecated": false, @@ -2810,6 +2812,16 @@ "section": "def-common.IExecutionLogResult", "text": "IExecutionLogResult" }, + ">; getGlobalExecutionLogWithAuth: ({ dateStart, dateEnd, filter, page, perPage, sort, }: ", + "GetGlobalExecutionLogParams", + ") => Promise<", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.IExecutionLogResult", + "text": "IExecutionLogResult" + }, ">; getActionErrorLog: ({ id, dateStart, dateEnd, filter, page, perPage, sort, }: ", "GetActionErrorLogByIdParams", ") => Promise<", @@ -2872,7 +2884,7 @@ "MuteOptions", ") => Promise; unmuteInstance: ({ alertId, alertInstanceId }: ", "MuteOptions", - ") => Promise; listAlertTypes: () => Promise Promise; runSoon: ({ id }: { id: string; }) => Promise; listAlertTypes: () => Promise>; getSpaceId: () => string | undefined; }" ], @@ -4128,6 +4140,28 @@ "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.IExecutionLog.rule_id", + "type": "string", + "tags": [], + "label": "rule_id", + "description": [], + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.IExecutionLog.rule_name", + "type": "string", + "tags": [], + "label": "rule_name", + "description": [], + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -6167,7 +6201,7 @@ "label": "SanitizedRule", "description": [], "signature": [ - "{ params: Params; tags: string[]; id: string; monitoring?: ", + "{ name: string; params: Params; tags: string[]; id: string; monitoring?: ", { "pluginId": "alerting", "scope": "common", @@ -6175,7 +6209,7 @@ "section": "def-common.RuleMonitoring", "text": "RuleMonitoring" }, - " | undefined; name: string; enabled: boolean; actions: ", + " | undefined; enabled: boolean; actions: ", { "pluginId": "alerting", "scope": "common", @@ -6238,7 +6272,7 @@ "section": "def-common.SanitizedRule", "text": "SanitizedRule" }, - ", \"tags\" | \"name\" | \"enabled\" | \"actions\" | \"throttle\" | \"consumer\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"notifyWhen\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }" + ", \"name\" | \"tags\" | \"enabled\" | \"actions\" | \"throttle\" | \"consumer\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"notifyWhen\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }" ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, diff --git a/api_docs/alerting.mdx b/api_docs/alerting.mdx index d331897a74bc2..70b1838415a1c 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting'] --- import alertingObj from './alerting.devdocs.json'; @@ -21,7 +21,7 @@ Contact [Response Ops](https://github.com/orgs/elastic/teams/response-ops) for q | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 368 | 0 | 359 | 21 | +| 370 | 0 | 361 | 22 | ## Client diff --git a/api_docs/apm.devdocs.json b/api_docs/apm.devdocs.json index efaf84a5b304a..b0e9d5757bffd 100644 --- a/api_docs/apm.devdocs.json +++ b/api_docs/apm.devdocs.json @@ -26,17 +26,6 @@ "deprecated": false, "trackAdoption": false }, - { - "parentPluginId": "apm", - "id": "def-public.ConfigSchema.profilingEnabled", - "type": "boolean", - "tags": [], - "label": "profilingEnabled", - "description": [], - "path": "x-pack/plugins/apm/public/index.ts", - "deprecated": false, - "trackAdoption": false - }, { "parentPluginId": "apm", "id": "def-public.ConfigSchema.ui", @@ -207,9 +196,9 @@ "APMPluginSetupDependencies", ") => { config$: ", "Observable", - "; autoCreateApmDataView: boolean; serviceMapEnabled: boolean; serviceMapFingerprintBucketSize: number; serviceMapTraceIdBucketSize: number; serviceMapFingerprintGlobalBucketSize: number; serviceMapTraceIdGlobalBucketSize: number; serviceMapMaxTracesPerRequest: number; ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; searchAggregatedTransactions: ", + "; autoCreateApmDataView: boolean; serviceMapEnabled: boolean; serviceMapFingerprintBucketSize: number; serviceMapTraceIdBucketSize: number; serviceMapFingerprintGlobalBucketSize: number; serviceMapTraceIdGlobalBucketSize: number; serviceMapMaxTracesPerRequest: number; ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; searchAggregatedTransactions: ", "SearchAggregatedTransactionSetting", - "; telemetryCollectionEnabled: boolean; metricsInterval: number; profilingEnabled: boolean; agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; }>>; getApmIndices: () => Promise<", + "; telemetryCollectionEnabled: boolean; metricsInterval: number; agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; }>>; getApmIndices: () => Promise<", "ApmIndicesConfig", ">; createApmEventClient: ({ request, context, debug, }: { debug?: boolean | undefined; request: ", "KibanaRequest", @@ -426,9 +415,9 @@ "label": "config", "description": [], "signature": [ - "{ readonly indices: Readonly<{} & { error: string; metric: string; span: string; transaction: string; sourcemap: string; onboarding: string; }>; readonly autoCreateApmDataView: boolean; readonly serviceMapEnabled: boolean; readonly serviceMapFingerprintBucketSize: number; readonly serviceMapTraceIdBucketSize: number; readonly serviceMapFingerprintGlobalBucketSize: number; readonly serviceMapTraceIdGlobalBucketSize: number; readonly serviceMapMaxTracesPerRequest: number; readonly ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; readonly searchAggregatedTransactions: ", + "{ readonly indices: Readonly<{} & { metric: string; error: string; span: string; transaction: string; sourcemap: string; onboarding: string; }>; readonly autoCreateApmDataView: boolean; readonly serviceMapEnabled: boolean; readonly serviceMapFingerprintBucketSize: number; readonly serviceMapTraceIdBucketSize: number; readonly serviceMapFingerprintGlobalBucketSize: number; readonly serviceMapTraceIdGlobalBucketSize: number; readonly serviceMapMaxTracesPerRequest: number; readonly ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; readonly searchAggregatedTransactions: ", "SearchAggregatedTransactionSetting", - "; readonly telemetryCollectionEnabled: boolean; readonly metricsInterval: number; readonly profilingEnabled: boolean; readonly agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; }" + "; readonly telemetryCollectionEnabled: boolean; readonly metricsInterval: number; readonly agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; }" ], "path": "x-pack/plugins/apm/server/routes/typings.ts", "deprecated": false, @@ -792,7 +781,7 @@ "label": "APIEndpoint", "description": [], "signature": [ - "\"POST /internal/apm/data_view/static\" | \"GET /internal/apm/data_view/title\" | \"GET /internal/apm/environments\" | \"GET /internal/apm/services/{serviceName}/errors/groups/main_statistics\" | \"GET /internal/apm/services/{serviceName}/errors/groups/main_statistics_by_transaction_name\" | \"POST /internal/apm/services/{serviceName}/errors/groups/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/errors/{groupId}\" | \"GET /internal/apm/services/{serviceName}/errors/distribution\" | \"GET /internal/apm/services/{serviceName}/errors/{groupId}/top_erroneous_transactions\" | \"POST /internal/apm/latency/overall_distribution/transactions\" | \"GET /internal/apm/services/{serviceName}/metrics/charts\" | \"GET /internal/apm/observability_overview\" | \"GET /internal/apm/observability_overview/has_data\" | \"GET /internal/apm/service-map\" | \"GET /internal/apm/service-map/service/{serviceName}\" | \"GET /internal/apm/service-map/dependency\" | \"GET /internal/apm/services/{serviceName}/serviceNodes\" | \"GET /internal/apm/services\" | \"POST /internal/apm/services/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/metadata/details\" | \"GET /internal/apm/services/{serviceName}/metadata/icons\" | \"GET /internal/apm/services/{serviceName}/agent\" | \"GET /internal/apm/services/{serviceName}/transaction_types\" | \"GET /internal/apm/services/{serviceName}/node/{serviceNodeName}/metadata\" | \"GET /api/apm/services/{serviceName}/annotation/search\" | \"POST /api/apm/services/{serviceName}/annotation\" | \"GET /internal/apm/services/{serviceName}/service_overview_instances/details/{serviceNodeName}\" | \"GET /internal/apm/services/{serviceName}/throughput\" | \"GET /internal/apm/services/{serviceName}/service_overview_instances/main_statistics\" | \"GET /internal/apm/services/{serviceName}/service_overview_instances/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/dependencies\" | \"GET /internal/apm/services/{serviceName}/dependencies/breakdown\" | \"GET /internal/apm/services/{serviceName}/profiling/timeline\" | \"GET /internal/apm/services/{serviceName}/profiling/statistics\" | \"GET /internal/apm/services/{serviceName}/anomaly_charts\" | \"GET /internal/apm/sorted_and_filtered_services\" | \"GET /internal/apm/service-groups\" | \"GET /internal/apm/service-group\" | \"POST /internal/apm/service-group\" | \"DELETE /internal/apm/service-group\" | \"GET /internal/apm/service-group/services\" | \"GET /internal/apm/suggestions\" | \"GET /internal/apm/traces/{traceId}\" | \"GET /internal/apm/traces\" | \"GET /internal/apm/traces/{traceId}/root_transaction\" | \"GET /internal/apm/transactions/{transactionId}\" | \"GET /internal/apm/traces/find\" | \"GET /internal/apm/services/{serviceName}/transactions/groups/main_statistics\" | \"GET /internal/apm/services/{serviceName}/transactions/groups/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/latency\" | \"GET /internal/apm/services/{serviceName}/transactions/traces/samples\" | \"GET /internal/apm/services/{serviceName}/transaction/charts/breakdown\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/error_rate\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/coldstart_rate\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/coldstart_rate_by_transaction_name\" | \"GET /internal/apm/alerts/chart_preview/transaction_error_rate\" | \"GET /internal/apm/alerts/chart_preview/transaction_duration\" | \"GET /internal/apm/alerts/chart_preview/transaction_error_count\" | \"GET /api/apm/settings/agent-configuration\" | \"GET /api/apm/settings/agent-configuration/view\" | \"DELETE /api/apm/settings/agent-configuration\" | \"PUT /api/apm/settings/agent-configuration\" | \"POST /api/apm/settings/agent-configuration/search\" | \"GET /api/apm/settings/agent-configuration/environments\" | \"GET /api/apm/settings/agent-configuration/agent_name\" | \"GET /internal/apm/settings/anomaly-detection/jobs\" | \"POST /internal/apm/settings/anomaly-detection/jobs\" | \"GET /internal/apm/settings/anomaly-detection/environments\" | \"POST /internal/apm/settings/anomaly-detection/update_to_v3\" | \"GET /internal/apm/settings/apm-index-settings\" | \"GET /internal/apm/settings/apm-indices\" | \"POST /internal/apm/settings/apm-indices/save\" | \"GET /internal/apm/settings/custom_links/transaction\" | \"GET /internal/apm/settings/custom_links\" | \"POST /internal/apm/settings/custom_links\" | \"PUT /internal/apm/settings/custom_links/{id}\" | \"DELETE /internal/apm/settings/custom_links/{id}\" | \"GET /api/apm/sourcemaps\" | \"POST /api/apm/sourcemaps\" | \"DELETE /api/apm/sourcemaps/{id}\" | \"GET /internal/apm/fleet/has_apm_policies\" | \"GET /internal/apm/fleet/agents\" | \"POST /api/apm/fleet/apm_server_schema\" | \"GET /internal/apm/fleet/apm_server_schema/unsupported\" | \"GET /internal/apm/fleet/migration_check\" | \"POST /internal/apm/fleet/cloud_apm_package_policy\" | \"GET /internal/apm/fleet/java_agent_versions\" | \"GET /internal/apm/dependencies/top_dependencies\" | \"GET /internal/apm/dependencies/upstream_services\" | \"GET /internal/apm/dependencies/metadata\" | \"GET /internal/apm/dependencies/charts/latency\" | \"GET /internal/apm/dependencies/charts/throughput\" | \"GET /internal/apm/dependencies/charts/error_rate\" | \"GET /internal/apm/dependencies/operations\" | \"GET /internal/apm/dependencies/charts/distribution\" | \"GET /internal/apm/dependencies/operations/spans\" | \"GET /internal/apm/correlations/field_candidates/transactions\" | \"POST /internal/apm/correlations/field_stats/transactions\" | \"GET /internal/apm/correlations/field_value_stats/transactions\" | \"POST /internal/apm/correlations/field_value_pairs/transactions\" | \"POST /internal/apm/correlations/significant_correlations/transactions\" | \"POST /internal/apm/correlations/p_values/transactions\" | \"GET /internal/apm/fallback_to_transactions\" | \"GET /internal/apm/has_data\" | \"GET /internal/apm/event_metadata/{processorEvent}/{id}\" | \"GET /internal/apm/agent_keys\" | \"GET /internal/apm/agent_keys/privileges\" | \"POST /internal/apm/api_key/invalidate\" | \"POST /api/apm/agent_keys\" | \"GET /internal/apm/storage_explorer\" | \"GET /internal/apm/services/{serviceName}/storage_details\" | \"GET /internal/apm/storage_chart\" | \"GET /internal/apm/traces/{traceId}/span_links/{spanId}/parents\" | \"GET /internal/apm/traces/{traceId}/span_links/{spanId}/children\" | \"GET /internal/apm/services/{serviceName}/infrastructure_attributes\" | \"GET /internal/apm/debug-telemetry\" | \"GET /internal/apm/time_range_metadata\"" + "\"POST /internal/apm/data_view/static\" | \"GET /internal/apm/data_view/title\" | \"GET /internal/apm/environments\" | \"GET /internal/apm/services/{serviceName}/errors/groups/main_statistics\" | \"GET /internal/apm/services/{serviceName}/errors/groups/main_statistics_by_transaction_name\" | \"POST /internal/apm/services/{serviceName}/errors/groups/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/errors/{groupId}\" | \"GET /internal/apm/services/{serviceName}/errors/distribution\" | \"GET /internal/apm/services/{serviceName}/errors/{groupId}/top_erroneous_transactions\" | \"POST /internal/apm/latency/overall_distribution/transactions\" | \"GET /internal/apm/services/{serviceName}/metrics/charts\" | \"GET /internal/apm/observability_overview\" | \"GET /internal/apm/observability_overview/has_data\" | \"GET /internal/apm/service-map\" | \"GET /internal/apm/service-map/service/{serviceName}\" | \"GET /internal/apm/service-map/dependency\" | \"GET /internal/apm/services/{serviceName}/serviceNodes\" | \"GET /internal/apm/services\" | \"POST /internal/apm/services/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/metadata/details\" | \"GET /internal/apm/services/{serviceName}/metadata/icons\" | \"GET /internal/apm/services/{serviceName}/agent\" | \"GET /internal/apm/services/{serviceName}/transaction_types\" | \"GET /internal/apm/services/{serviceName}/node/{serviceNodeName}/metadata\" | \"GET /api/apm/services/{serviceName}/annotation/search\" | \"POST /api/apm/services/{serviceName}/annotation\" | \"GET /internal/apm/services/{serviceName}/service_overview_instances/details/{serviceNodeName}\" | \"GET /internal/apm/services/{serviceName}/throughput\" | \"GET /internal/apm/services/{serviceName}/service_overview_instances/main_statistics\" | \"GET /internal/apm/services/{serviceName}/service_overview_instances/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/dependencies\" | \"GET /internal/apm/services/{serviceName}/dependencies/breakdown\" | \"GET /internal/apm/services/{serviceName}/anomaly_charts\" | \"GET /internal/apm/sorted_and_filtered_services\" | \"GET /internal/apm/service-groups\" | \"GET /internal/apm/service-group\" | \"POST /internal/apm/service-group\" | \"DELETE /internal/apm/service-group\" | \"GET /internal/apm/service-group/services\" | \"GET /internal/apm/suggestions\" | \"GET /internal/apm/traces/{traceId}\" | \"GET /internal/apm/traces\" | \"GET /internal/apm/traces/{traceId}/root_transaction\" | \"GET /internal/apm/transactions/{transactionId}\" | \"GET /internal/apm/traces/find\" | \"GET /internal/apm/services/{serviceName}/transactions/groups/main_statistics\" | \"GET /internal/apm/services/{serviceName}/transactions/groups/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/latency\" | \"GET /internal/apm/services/{serviceName}/transactions/traces/samples\" | \"GET /internal/apm/services/{serviceName}/transaction/charts/breakdown\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/error_rate\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/coldstart_rate\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/coldstart_rate_by_transaction_name\" | \"GET /internal/apm/alerts/chart_preview/transaction_error_rate\" | \"GET /internal/apm/alerts/chart_preview/transaction_duration\" | \"GET /internal/apm/alerts/chart_preview/transaction_error_count\" | \"GET /api/apm/settings/agent-configuration\" | \"GET /api/apm/settings/agent-configuration/view\" | \"DELETE /api/apm/settings/agent-configuration\" | \"PUT /api/apm/settings/agent-configuration\" | \"POST /api/apm/settings/agent-configuration/search\" | \"GET /api/apm/settings/agent-configuration/environments\" | \"GET /api/apm/settings/agent-configuration/agent_name\" | \"GET /internal/apm/settings/anomaly-detection/jobs\" | \"POST /internal/apm/settings/anomaly-detection/jobs\" | \"GET /internal/apm/settings/anomaly-detection/environments\" | \"POST /internal/apm/settings/anomaly-detection/update_to_v3\" | \"GET /internal/apm/settings/apm-index-settings\" | \"GET /internal/apm/settings/apm-indices\" | \"POST /internal/apm/settings/apm-indices/save\" | \"GET /internal/apm/settings/custom_links/transaction\" | \"GET /internal/apm/settings/custom_links\" | \"POST /internal/apm/settings/custom_links\" | \"PUT /internal/apm/settings/custom_links/{id}\" | \"DELETE /internal/apm/settings/custom_links/{id}\" | \"GET /api/apm/sourcemaps\" | \"POST /api/apm/sourcemaps\" | \"DELETE /api/apm/sourcemaps/{id}\" | \"GET /internal/apm/fleet/has_apm_policies\" | \"GET /internal/apm/fleet/agents\" | \"POST /api/apm/fleet/apm_server_schema\" | \"GET /internal/apm/fleet/apm_server_schema/unsupported\" | \"GET /internal/apm/fleet/migration_check\" | \"POST /internal/apm/fleet/cloud_apm_package_policy\" | \"GET /internal/apm/fleet/java_agent_versions\" | \"GET /internal/apm/dependencies/top_dependencies\" | \"GET /internal/apm/dependencies/upstream_services\" | \"GET /internal/apm/dependencies/metadata\" | \"GET /internal/apm/dependencies/charts/latency\" | \"GET /internal/apm/dependencies/charts/throughput\" | \"GET /internal/apm/dependencies/charts/error_rate\" | \"GET /internal/apm/dependencies/operations\" | \"GET /internal/apm/dependencies/charts/distribution\" | \"GET /internal/apm/dependencies/operations/spans\" | \"GET /internal/apm/correlations/field_candidates/transactions\" | \"POST /internal/apm/correlations/field_stats/transactions\" | \"GET /internal/apm/correlations/field_value_stats/transactions\" | \"POST /internal/apm/correlations/field_value_pairs/transactions\" | \"POST /internal/apm/correlations/significant_correlations/transactions\" | \"POST /internal/apm/correlations/p_values/transactions\" | \"GET /internal/apm/fallback_to_transactions\" | \"GET /internal/apm/has_data\" | \"GET /internal/apm/event_metadata/{processorEvent}/{id}\" | \"GET /internal/apm/agent_keys\" | \"GET /internal/apm/agent_keys/privileges\" | \"POST /internal/apm/api_key/invalidate\" | \"POST /api/apm/agent_keys\" | \"GET /internal/apm/storage_explorer\" | \"GET /internal/apm/services/{serviceName}/storage_details\" | \"GET /internal/apm/storage_chart\" | \"GET /internal/apm/storage_explorer/privileges\" | \"GET /internal/apm/storage_explorer_summary_stats\" | \"GET /internal/apm/traces/{traceId}/span_links/{spanId}/parents\" | \"GET /internal/apm/traces/{traceId}/span_links/{spanId}/children\" | \"GET /internal/apm/services/{serviceName}/infrastructure_attributes\" | \"GET /internal/apm/debug-telemetry\" | \"GET /internal/apm/time_range_metadata\" | \"GET /internal/apm/settings/labs\"" ], "path": "x-pack/plugins/apm/server/routes/apm_routes/get_global_apm_server_route_repository.ts", "deprecated": false, @@ -822,9 +811,9 @@ "label": "APMConfig", "description": [], "signature": [ - "{ readonly indices: Readonly<{} & { error: string; metric: string; span: string; transaction: string; sourcemap: string; onboarding: string; }>; readonly autoCreateApmDataView: boolean; readonly serviceMapEnabled: boolean; readonly serviceMapFingerprintBucketSize: number; readonly serviceMapTraceIdBucketSize: number; readonly serviceMapFingerprintGlobalBucketSize: number; readonly serviceMapTraceIdGlobalBucketSize: number; readonly serviceMapMaxTracesPerRequest: number; readonly ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; readonly searchAggregatedTransactions: ", + "{ readonly indices: Readonly<{} & { metric: string; error: string; span: string; transaction: string; sourcemap: string; onboarding: string; }>; readonly autoCreateApmDataView: boolean; readonly serviceMapEnabled: boolean; readonly serviceMapFingerprintBucketSize: number; readonly serviceMapTraceIdBucketSize: number; readonly serviceMapFingerprintGlobalBucketSize: number; readonly serviceMapTraceIdGlobalBucketSize: number; readonly serviceMapMaxTracesPerRequest: number; readonly ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; readonly searchAggregatedTransactions: ", "SearchAggregatedTransactionSetting", - "; readonly telemetryCollectionEnabled: boolean; readonly metricsInterval: number; readonly profilingEnabled: boolean; readonly agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; }" + "; readonly telemetryCollectionEnabled: boolean; readonly metricsInterval: number; readonly agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; }" ], "path": "x-pack/plugins/apm/server/index.ts", "deprecated": false, @@ -839,7 +828,7 @@ "label": "ApmIndicesConfigName", "description": [], "signature": [ - "\"error\" | \"metric\" | \"span\" | \"transaction\" | \"sourcemap\" | \"onboarding\"" + "\"metric\" | \"error\" | \"span\" | \"transaction\" | \"sourcemap\" | \"onboarding\"" ], "path": "x-pack/plugins/apm/server/index.ts", "deprecated": false, @@ -854,7 +843,19 @@ "label": "APMServerRouteRepository", "description": [], "signature": [ - "{ \"GET /internal/apm/time_range_metadata\": ", + "{ \"GET /internal/apm/settings/labs\": ", + "ServerRoute", + "<\"GET /internal/apm/settings/labs\", undefined, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { labsItems: string[]; }, ", + "APMRouteCreateOptions", + ">; \"GET /internal/apm/time_range_metadata\": ", "ServerRoute", "<\"GET /internal/apm/time_range_metadata\", ", "TypeC", @@ -1042,17 +1043,89 @@ "section": "def-common.ProcessorEvent", "text": "ProcessorEvent" }, - ".span>, ", + ".span>]>; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { spanLinksDetails: ", + "SpanLinkDetails", + "[]; }, ", + "APMRouteCreateOptions", + ">; \"GET /internal/apm/storage_explorer_summary_stats\": ", + "ServerRoute", + "<\"GET /internal/apm/storage_explorer_summary_stats\", ", + "TypeC", + "<{ query: ", + "IntersectionC", + "<[", + "TypeC", + "<{ indexLifecyclePhase: ", + "UnionC", + "<[", "LiteralC", "<", + "IndexLifecyclePhaseSelectOption", + ".All>, ", + "LiteralC", + "<", + "IndexLifecyclePhaseSelectOption", + ".Hot>, ", + "LiteralC", + "<", + "IndexLifecyclePhaseSelectOption", + ".Warm>, ", + "LiteralC", + "<", + "IndexLifecyclePhaseSelectOption", + ".Cold>, ", + "LiteralC", + "<", + "IndexLifecyclePhaseSelectOption", + ".Frozen>]>; }>, ", + "TypeC", + "<{ probability: ", + "Type", + "; }>, ", + "TypeC", + "<{ environment: ", + "UnionC", + "<[", + "LiteralC", + "<\"ENVIRONMENT_NOT_DEFINED\">, ", + "LiteralC", + "<\"ENVIRONMENT_ALL\">, ", + "BrandC", + "<", + "StringC", + ", ", + "NonEmptyStringBrand", + ">]>; }>, ", + "TypeC", + "<{ kuery: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>]>; }>, ", { - "pluginId": "observability", - "scope": "common", - "docId": "kibObservabilityPluginApi", - "section": "def-common.ProcessorEvent", - "text": "ProcessorEvent" + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" }, - ".profile>]>; }>]>; }>, ", + ", { tracesPerMinute: number; numberOfServices: number; estimatedSize: number; dailyDataGeneration: number; }, ", + "APMRouteCreateOptions", + ">; \"GET /internal/apm/storage_explorer/privileges\": ", + "ServerRoute", + "<\"GET /internal/apm/storage_explorer/privileges\", undefined, ", { "pluginId": "apm", "scope": "server", @@ -1060,9 +1133,7 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { spanLinksDetails: ", - "SpanLinkDetails", - "[]; }, ", + ", { hasPrivileges: boolean; }, ", "APMRouteCreateOptions", ">; \"GET /internal/apm/storage_chart\": ", "ServerRoute", @@ -1210,31 +1281,7 @@ "section": "def-common.ProcessorEvent", "text": "ProcessorEvent" }, - ".transaction | ", - { - "pluginId": "observability", - "scope": "common", - "docId": "kibObservabilityPluginApi", - "section": "def-common.ProcessorEvent", - "text": "ProcessorEvent" - }, - ".error | ", - { - "pluginId": "observability", - "scope": "common", - "docId": "kibObservabilityPluginApi", - "section": "def-common.ProcessorEvent", - "text": "ProcessorEvent" - }, - ".metric | ", - { - "pluginId": "observability", - "scope": "common", - "docId": "kibObservabilityPluginApi", - "section": "def-common.ProcessorEvent", - "text": "ProcessorEvent" - }, - ".span; docs: number; size: number; }[]; }, ", + "; docs: number; size: number; }[]; }, ", "APMRouteCreateOptions", ">; \"GET /internal/apm/storage_explorer\": ", "ServerRoute", @@ -1436,17 +1483,7 @@ "section": "def-common.ProcessorEvent", "text": "ProcessorEvent" }, - ".span>, ", - "LiteralC", - "<", - { - "pluginId": "observability", - "scope": "common", - "docId": "kibObservabilityPluginApi", - "section": "def-common.ProcessorEvent", - "text": "ProcessorEvent" - }, - ".profile>]>; id: ", + ".span>]>; id: ", "StringC", "; }>; }>, ", { @@ -2714,7 +2751,7 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { apmIndexSettings: { configurationName: \"error\" | \"metric\" | \"span\" | \"transaction\" | \"sourcemap\" | \"onboarding\"; defaultValue: string; savedValue: string | undefined; }[]; }, ", + ", { apmIndexSettings: { configurationName: \"metric\" | \"error\" | \"span\" | \"transaction\" | \"sourcemap\" | \"onboarding\"; defaultValue: string; savedValue: string | undefined; }[]; }, ", "APMRouteCreateOptions", ">; \"POST /internal/apm/settings/anomaly-detection/update_to_v3\": ", "ServerRoute", @@ -3564,13 +3601,17 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { currentPeriod: _.Dictionary<{ transactionName: string; latency: ", + ", { currentPeriod: ", + "Dictionary", + "<{ transactionName: string; latency: ", "Coordinate", "[]; throughput: ", "Coordinate", "[]; errorRate: ", "Coordinate", - "[]; impact: number; }>; previousPeriod: _.Dictionary<{ errorRate: { x: number; y: ", + "[]; impact: number; }>; previousPeriod: ", + "Dictionary", + "<{ errorRate: { x: number; y: ", "Maybe", "; }[]; throughput: { x: number; y: ", "Maybe", @@ -4056,128 +4097,6 @@ "ServiceAnomalyTimeseries", "[]; }, ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/profiling/statistics\": ", - "ServerRoute", - "<\"GET /internal/apm/services/{serviceName}/profiling/statistics\", ", - "TypeC", - "<{ path: ", - "TypeC", - "<{ serviceName: ", - "StringC", - "; }>; query: ", - "IntersectionC", - "<[", - "TypeC", - "<{ environment: ", - "UnionC", - "<[", - "LiteralC", - "<\"ENVIRONMENT_NOT_DEFINED\">, ", - "LiteralC", - "<\"ENVIRONMENT_ALL\">, ", - "BrandC", - "<", - "StringC", - ", ", - "NonEmptyStringBrand", - ">]>; }>, ", - "TypeC", - "<{ kuery: ", - "StringC", - "; }>, ", - "TypeC", - "<{ start: ", - "Type", - "; end: ", - "Type", - "; }>, ", - "TypeC", - "<{ valueType: ", - "UnionC", - "<[", - "LiteralC", - "<", - "ProfilingValueType", - ".wallTime>, ", - "LiteralC", - "<", - "ProfilingValueType", - ".cpuTime>, ", - "LiteralC", - "<", - "ProfilingValueType", - ".samples>, ", - "LiteralC", - "<", - "ProfilingValueType", - ".allocObjects>, ", - "LiteralC", - "<", - "ProfilingValueType", - ".allocSpace>, ", - "LiteralC", - "<", - "ProfilingValueType", - ".inuseObjects>, ", - "LiteralC", - "<", - "ProfilingValueType", - ".inuseSpace>]>; }>]>; }>, ", - { - "pluginId": "apm", - "scope": "server", - "docId": "kibApmPluginApi", - "section": "def-server.APMRouteHandlerResources", - "text": "APMRouteHandlerResources" - }, - ", { nodes: Record; rootNodes: string[]; }, ", - "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/profiling/timeline\": ", - "ServerRoute", - "<\"GET /internal/apm/services/{serviceName}/profiling/timeline\", ", - "TypeC", - "<{ path: ", - "TypeC", - "<{ serviceName: ", - "StringC", - "; }>; query: ", - "IntersectionC", - "<[", - "TypeC", - "<{ environment: ", - "UnionC", - "<[", - "LiteralC", - "<\"ENVIRONMENT_NOT_DEFINED\">, ", - "LiteralC", - "<\"ENVIRONMENT_ALL\">, ", - "BrandC", - "<", - "StringC", - ", ", - "NonEmptyStringBrand", - ">]>; }>, ", - "TypeC", - "<{ kuery: ", - "StringC", - "; }>, ", - "TypeC", - "<{ start: ", - "Type", - "; end: ", - "Type", - "; }>]>; }>, ", - { - "pluginId": "apm", - "scope": "server", - "docId": "kibApmPluginApi", - "section": "def-server.APMRouteHandlerResources", - "text": "APMRouteHandlerResources" - }, - ", { profilingTimeline: { x: number; valueTypes: { wall_time: number; cpu_time: number; samples: number; alloc_objects: number; alloc_space: number; inuse_objects: number; inuse_space: number; unknown: number; }; }[]; }, ", - "APMRouteCreateOptions", ">; \"GET /internal/apm/services/{serviceName}/dependencies/breakdown\": ", "ServerRoute", "<\"GET /internal/apm/services/{serviceName}/dependencies/breakdown\", ", @@ -4356,7 +4275,9 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { currentPeriod: _.Dictionary<{ serviceNodeName: string; errorRate?: ", + ", { currentPeriod: ", + "Dictionary", + "<{ serviceNodeName: string; errorRate?: ", "Coordinate", "[] | undefined; latency?: ", "Coordinate", @@ -4366,7 +4287,9 @@ "Coordinate", "[] | undefined; memoryUsage?: ", "Coordinate", - "[] | undefined; }>; previousPeriod: _.Dictionary<{ cpuUsage: { x: number; y: ", + "[] | undefined; }>; previousPeriod: ", + "Dictionary", + "<{ cpuUsage: { x: number; y: ", "Maybe", "; }[]; errorRate: { x: number; y: ", "Maybe", @@ -4820,7 +4743,11 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { currentPeriod: _.Dictionary<{ serviceName: string; latency: { x: number; y: number | null; }[]; transactionErrorRate: { x: number; y: number; }[]; throughput: { x: number; y: number; }[]; }>; previousPeriod: _.Dictionary<{ serviceName: string; latency: { x: number; y: number | null; }[]; transactionErrorRate: { x: number; y: number; }[]; throughput: { x: number; y: number; }[]; }>; }, ", + ", { currentPeriod: ", + "Dictionary", + "<{ serviceName: string; latency: { x: number; y: number | null; }[]; transactionErrorRate: { x: number; y: number; }[]; throughput: { x: number; y: number; }[]; }>; previousPeriod: ", + "Dictionary", + "<{ serviceName: string; latency: { x: number; y: number | null; }[]; transactionErrorRate: { x: number; y: number; }[]; throughput: { x: number; y: number; }[]; }>; }, ", "APMRouteCreateOptions", ">; \"GET /internal/apm/services\": ", "ServerRoute", @@ -5130,6 +5057,8 @@ "PartialC", "<{ serviceNodeName: ", "StringC", + "; serviceRuntimeName: ", + "StringC", "; }>, ", "TypeC", "<{ environment: ", @@ -5468,9 +5397,13 @@ "section": "def-server.APMRouteHandlerResources", "text": "APMRouteHandlerResources" }, - ", { currentPeriod: _.Dictionary<{ groupId: string; timeseries: ", + ", { currentPeriod: ", + "Dictionary", + "<{ groupId: string; timeseries: ", "Coordinate", - "[]; }>; previousPeriod: _.Dictionary<{ timeseries: { x: number; y: ", + "[]; }>; previousPeriod: ", + "Dictionary", + "<{ timeseries: { x: number; y: ", "Maybe", "; }[]; groupId: string; }>; }, ", "APMRouteCreateOptions", @@ -5671,9 +5604,9 @@ "description": [], "signature": [ "Observable", - "; autoCreateApmDataView: boolean; serviceMapEnabled: boolean; serviceMapFingerprintBucketSize: number; serviceMapTraceIdBucketSize: number; serviceMapFingerprintGlobalBucketSize: number; serviceMapTraceIdGlobalBucketSize: number; serviceMapMaxTracesPerRequest: number; ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; searchAggregatedTransactions: ", + "; autoCreateApmDataView: boolean; serviceMapEnabled: boolean; serviceMapFingerprintBucketSize: number; serviceMapTraceIdBucketSize: number; serviceMapFingerprintGlobalBucketSize: number; serviceMapTraceIdGlobalBucketSize: number; serviceMapMaxTracesPerRequest: number; ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; searchAggregatedTransactions: ", "SearchAggregatedTransactionSetting", - "; telemetryCollectionEnabled: boolean; metricsInterval: number; profilingEnabled: boolean; agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; }>>" + "; telemetryCollectionEnabled: boolean; metricsInterval: number; agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; }>>" ], "path": "x-pack/plugins/apm/server/types.ts", "deprecated": false, diff --git a/api_docs/apm.mdx b/api_docs/apm.mdx index 27c873e1cbc08..4e665c7bfea03 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm'] --- import apmObj from './apm.devdocs.json'; @@ -21,7 +21,7 @@ Contact [APM UI](https://github.com/orgs/elastic/teams/apm-ui) for questions reg | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 39 | 0 | 39 | 54 | +| 38 | 0 | 38 | 52 | ## Client diff --git a/api_docs/banners.mdx b/api_docs/banners.mdx index 167582665bb6d..dcb08b6198153 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: 2022-09-09 +date: 2022-09-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 363cb213dfa2c..dce7e1d14c5ca 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: 2022-09-09 +date: 2022-09-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 2910180b02cdf..46a35412e6ae1 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: 2022-09-09 +date: 2022-09-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 e68be19ab7203..46161fd8de3be 100644 --- a/api_docs/cases.devdocs.json +++ b/api_docs/cases.devdocs.json @@ -742,7 +742,25 @@ "section": "def-common.CommentType", "text": "CommentType" }, - ".alert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; } | { type: ", + ".alert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; } | { externalReferenceId: string; externalReferenceStorage: { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ExternalReferenceStorageType", + "text": "ExternalReferenceStorageType" + }, + ".elasticSearchDoc; }; externalReferenceAttachmentTypeId: string; externalReferenceMetadata: { [x: string]: ", + "JsonValue", + "; } | null; type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".externalReference; owner: string; } | { type: ", { "pluginId": "cases", "scope": "common", @@ -1509,6 +1527,18 @@ "deprecated": false, "trackAdoption": false, "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.ExternalReferenceStorageType", + "type": "Enum", + "tags": [], + "label": "ExternalReferenceStorageType", + "description": [], + "path": "x-pack/plugins/cases/common/api/cases/comment.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false } ], "misc": [ @@ -1544,7 +1574,7 @@ "ConnectorTypes", ".swimlane; fields: { caseId: string | null; } | null; name: string; }; settings: { syncAlerts: boolean; }; owner: string; severity: ", "CaseSeverity", - "; assignees: { uid: string; }[]; duration: number | null; closedAt: string | null; closedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; } | null; createdAt: string; createdBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; }; externalService: { connectorId: string; connectorName: string; externalId: string; externalTitle: string; externalUrl: string; pushedAt: string; pushedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; }; } | null; updatedAt: string | null; updatedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; } | null; id: string; totalComment: number; totalAlerts: number; version: string; comments?: ((({ comment: string; type: ", + "; assignees: { uid: string; }[]; duration: number | null; closedAt: string | null; closedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; } | null; createdAt: string; createdBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; }; externalService: { connectorId: string; connectorName: string; externalId: string; externalTitle: string; externalUrl: string; pushedAt: string; pushedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; }; } | null; updatedAt: string | null; updatedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; profileUid?: string | undefined; } | null; id: string; totalComment: number; totalAlerts: number; version: string; comments?: ((({ comment: string; type: ", { "pluginId": "cases", "scope": "common", @@ -1552,7 +1582,7 @@ "section": "def-common.CommentType", "text": "CommentType" }, - ".user; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; owner: string; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; }) | ({ type: ", + ".user; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; }) | ({ type: ", { "pluginId": "cases", "scope": "common", @@ -1560,7 +1590,7 @@ "section": "def-common.CommentType", "text": "CommentType" }, - ".alert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; owner: string; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; }) | ({ type: ", + ".alert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; }) | ({ type: ", { "pluginId": "cases", "scope": "common", @@ -1568,8 +1598,14 @@ "section": "def-common.CommentType", "text": "CommentType" }, - ".actions; comment: string; actions: { targets: { hostname: string; endpointId: string; }[]; type: string; }; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; owner: string; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; }) | (({ externalReferenceId: string; externalReferenceStorage: { type: ", - "ExternalReferenceStorageType", + ".actions; comment: string; actions: { targets: { hostname: string; endpointId: string; }[]; type: string; }; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; }) | (({ externalReferenceId: string; externalReferenceStorage: { type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ExternalReferenceStorageType", + "text": "ExternalReferenceStorageType" + }, ".elasticSearchDoc; }; externalReferenceAttachmentTypeId: string; externalReferenceMetadata: { [x: string]: ", "JsonValue", "; } | null; type: ", @@ -1581,7 +1617,13 @@ "text": "CommentType" }, ".externalReference; owner: string; } | { externalReferenceId: string; externalReferenceStorage: { type: ", - "ExternalReferenceStorageType", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.ExternalReferenceStorageType", + "text": "ExternalReferenceStorageType" + }, ".savedObject; soType: string; }; externalReferenceAttachmentTypeId: string; externalReferenceMetadata: { [x: string]: ", "JsonValue", "; } | null; type: ", @@ -1592,7 +1634,7 @@ "section": "def-common.CommentType", "text": "CommentType" }, - ".externalReference; owner: string; }) & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; owner: string; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; }) | ({ type: ", + ".externalReference; owner: string; }) & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; }) | ({ type: ", { "pluginId": "cases", "scope": "common", @@ -1602,7 +1644,7 @@ }, ".persistableState; owner: string; persistableStateAttachmentTypeId: string; persistableStateAttachmentState: { [x: string]: ", "JsonValue", - "; }; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; owner: string; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; })) & { id: string; version: string; })[] | undefined; }, \"comments\"> & { comments: ", + "; }; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; })) & { id: string; version: string; })[] | undefined; }, \"comments\"> & { comments: ", "Comment", "[]; }" ], @@ -1694,6 +1736,36 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "cases", + "id": "def-common.GENERAL_CASES_OWNER", + "type": "string", + "tags": [], + "label": "GENERAL_CASES_OWNER", + "description": [], + "signature": [ + "\"cases\"" + ], + "path": "x-pack/plugins/cases/common/constants.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "cases", + "id": "def-common.OBSERVABILITY_OWNER", + "type": "string", + "tags": [], + "label": "OBSERVABILITY_OWNER", + "description": [], + "signature": [ + "\"observability\"" + ], + "path": "x-pack/plugins/cases/common/constants.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "cases", "id": "def-common.PUSH_CASES_CAPABILITY", diff --git a/api_docs/cases.mdx b/api_docs/cases.mdx index cbc8bc0dcfd44..a6ee546714ecf 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases'] --- import casesObj from './cases.devdocs.json'; @@ -21,7 +21,7 @@ Contact [ResponseOps](https://github.com/orgs/elastic/teams/response-ops) for qu | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 84 | 0 | 68 | 29 | +| 87 | 0 | 71 | 28 | ## Client diff --git a/api_docs/charts.mdx b/api_docs/charts.mdx index ca9fc19e1213b..b62a72791c792 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts'] --- import chartsObj from './charts.devdocs.json'; diff --git a/api_docs/cloud.mdx b/api_docs/cloud.mdx index bffc54e20d6ab..d88f07961f1e9 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud'] --- import cloudObj from './cloud.devdocs.json'; diff --git a/api_docs/cloud_security_posture.mdx b/api_docs/cloud_security_posture.mdx index 40ee284d2734c..beeef9814456f 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture'] --- import cloudSecurityPostureObj from './cloud_security_posture.devdocs.json'; diff --git a/api_docs/console.mdx b/api_docs/console.mdx index 88390589d3835..266884e1d4607 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console'] --- import consoleObj from './console.devdocs.json'; diff --git a/api_docs/controls.devdocs.json b/api_docs/controls.devdocs.json index 78f856d45261e..0a54b22525152 100644 --- a/api_docs/controls.devdocs.json +++ b/api_docs/controls.devdocs.json @@ -448,9 +448,7 @@ "section": "def-public.ControlOutput", "text": "ControlOutput" }, - ">, ", - "SavedObjectAttributes", - ">, partial?: Partial) => ", + ">, unknown>, partial?: Partial) => ", { "pluginId": "controls", "scope": "common", @@ -507,9 +505,7 @@ "section": "def-public.ControlOutput", "text": "ControlOutput" }, - ">, ", - "SavedObjectAttributes", - ">" + ">, unknown>" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, @@ -736,9 +732,7 @@ "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, - ">, ", - "SavedObjectAttributes", - ">" + ">, unknown>" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container_factory.ts", "deprecated": false, @@ -1431,9 +1425,7 @@ "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, - ">, ", - "SavedObjectAttributes", - ">,", + ">, unknown>,", { "pluginId": "controls", "scope": "public", @@ -2341,9 +2333,7 @@ "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, - ">, ", - "SavedObjectAttributes", - ">,", + ">, unknown>,", { "pluginId": "controls", "scope": "public", @@ -3608,9 +3598,7 @@ "section": "def-public.ControlOutput", "text": "ControlOutput" }, - ">, ", - "SavedObjectAttributes", - ">" + ">, unknown>" ], "path": "src/plugins/controls/public/types.ts", "deprecated": false, diff --git a/api_docs/controls.mdx b/api_docs/controls.mdx index ae609d41255ab..6e0b9d0ebebfd 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls'] --- import controlsObj from './controls.devdocs.json'; diff --git a/api_docs/core.devdocs.json b/api_docs/core.devdocs.json index 35d2b408052f5..dd0a8f399f350 100644 --- a/api_docs/core.devdocs.json +++ b/api_docs/core.devdocs.json @@ -512,6 +512,14 @@ "plugin": "security", "path": "x-pack/plugins/security/server/analytics/analytics_service.ts" }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/services/analytics/types.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/services/analytics/analytics_service.ts" + }, { "plugin": "osquery", "path": "x-pack/plugins/osquery/server/lib/telemetry/sender.ts" @@ -576,6 +584,10 @@ "plugin": "@kbn/core-analytics-server-internal", "path": "packages/core/analytics/core-analytics-server-internal/src/analytics_service.ts" }, + { + "plugin": "@kbn/core-status-server-internal", + "path": "packages/core/status/core-status-server-internal/src/status_service.ts" + }, { "plugin": "security", "path": "x-pack/plugins/security/server/analytics/analytics_service.test.ts" @@ -588,6 +600,22 @@ "plugin": "@kbn/core-analytics-server-mocks", "path": "packages/core/analytics/core-analytics-server-mocks/src/analytics_service.mock.ts" }, + { + "plugin": "@kbn/core-status-server-internal", + "path": "packages/core/status/core-status-server-internal/src/status_service.test.ts" + }, + { + "plugin": "@kbn/core-status-server-internal", + "path": "packages/core/status/core-status-server-internal/src/status_service.test.ts" + }, + { + "plugin": "@kbn/core-status-server-internal", + "path": "packages/core/status/core-status-server-internal/src/status_service.test.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/services/analytics/analytics.stub.ts" + }, { "plugin": "@kbn/core-analytics-browser-mocks", "path": "packages/core/analytics/core-analytics-browser-mocks/src/analytics_service.mock.ts" @@ -918,6 +946,10 @@ "plugin": "@kbn/core-execution-context-browser-internal", "path": "packages/core/execution-context/core-execution-context-browser-internal/src/execution_context_service.ts" }, + { + "plugin": "@kbn/core-status-server-internal", + "path": "packages/core/status/core-status-server-internal/src/status_service.ts" + }, { "plugin": "cloud", "path": "x-pack/plugins/cloud/public/plugin.test.ts" @@ -982,6 +1014,14 @@ "plugin": "@kbn/core-elasticsearch-server-internal", "path": "packages/core/elasticsearch/core-elasticsearch-server-internal/src/register_analytics_context_provider.test.ts" }, + { + "plugin": "@kbn/core-status-server-internal", + "path": "packages/core/status/core-status-server-internal/src/status_service.test.ts" + }, + { + "plugin": "@kbn/core-status-server-internal", + "path": "packages/core/status/core-status-server-internal/src/status_service.test.ts" + }, { "plugin": "@kbn/core-analytics-browser-internal", "path": "packages/core/analytics/core-analytics-browser-internal/src/analytics_service.test.mocks.ts" @@ -2134,10 +2174,6 @@ "plugin": "dashboard", "path": "src/plugins/dashboard/public/types.ts" }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/dashboard_router.tsx" - }, { "plugin": "dashboard", "path": "src/plugins/dashboard/public/plugin.tsx" @@ -10559,7 +10595,7 @@ "tags": [], "label": "attributes", "description": [ - "{@inheritdoc SavedObjectAttributes}" + "The data for a Saved Object is stored as an object in the `attributes` property." ], "signature": [ "T" @@ -10657,7 +10693,9 @@ "parentPluginId": "core", "id": "def-public.SavedObjectAttributes", "type": "Interface", - "tags": [], + "tags": [ + "deprecated" + ], "label": "SavedObjectAttributes", "description": [ "\nThe data for a Saved Object is stored as an object in the `attributes`\nproperty.\n" @@ -10666,8 +10704,598 @@ "SavedObjectAttributes" ], "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", - "deprecated": false, + "deprecated": true, "trackAdoption": false, + "references": [ + { + "plugin": "actions", + "path": "x-pack/plugins/actions/server/actions_client.ts" + }, + { + "plugin": "actions", + "path": "x-pack/plugins/actions/server/actions_client.ts" + }, + { + "plugin": "actions", + "path": "x-pack/plugins/actions/server/actions_client.ts" + }, + { + "plugin": "actions", + "path": "x-pack/plugins/actions/server/actions_client.ts" + }, + { + "plugin": "actions", + "path": "x-pack/plugins/actions/server/actions_client.ts" + }, + { + "plugin": "actions", + "path": "x-pack/plugins/actions/server/actions_client.ts" + }, + { + "plugin": "actions", + "path": "x-pack/plugins/actions/server/actions_client.ts" + }, + { + "plugin": "actions", + "path": "x-pack/plugins/actions/server/types.ts" + }, + { + "plugin": "actions", + "path": "x-pack/plugins/actions/server/types.ts" + }, + { + "plugin": "actions", + "path": "x-pack/plugins/actions/server/types.ts" + }, + { + "plugin": "actions", + "path": "x-pack/plugins/actions/server/types.ts" + }, + { + "plugin": "actions", + "path": "x-pack/plugins/actions/server/types.ts" + }, + { + "plugin": "actions", + "path": "x-pack/plugins/actions/server/types.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/common/rule.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/common/rule.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/common/rule.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/common/rule.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/common/rule.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/common/rule.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/saved_objects/geo_containment/migrations.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/saved_objects/geo_containment/migrations.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/saved_objects/migrations.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/saved_objects/migrations.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/saved_objects/migrations.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/types.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/types.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/types.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/types.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/types.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/types.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/types.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/server/routes/custom_elements/find.ts" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/server/routes/custom_elements/find.ts" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/server/routes/workpad/find.ts" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/server/routes/workpad/find.ts" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/server/collectors/lib/telemetry.ts" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/server/collectors/lib/telemetry.ts" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/server/collectors/lib/telemetry.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions/legacy_types.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions/legacy_types.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions/legacy_migrations.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions/legacy_migrations.ts" + }, + { + "plugin": "taskManager", + "path": "x-pack/plugins/task_manager/server/task_store.test.ts" + }, + { + "plugin": "taskManager", + "path": "x-pack/plugins/task_manager/server/task_store.test.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/server/saved_objects/dashboard_migrations.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/server/saved_objects/dashboard_migrations.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/server/usage/dashboard_telemetry_collection_task.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/server/usage/dashboard_telemetry_collection_task.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/server/usage/dashboard_telemetry.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/server/usage/dashboard_telemetry.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/server/usage/find_by_value_embeddables.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/server/usage/find_by_value_embeddables.ts" + }, + { + "plugin": "savedSearch", + "path": "src/plugins/saved_search/server/saved_objects/search_migrations.ts" + }, + { + "plugin": "savedSearch", + "path": "src/plugins/saved_search/server/saved_objects/search_migrations.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/common/types.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/common/types.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/common/saved_dashboard_references.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/common/saved_dashboard_references.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/common/saved_dashboard_references.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/common/saved_dashboard_references.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/common/saved_dashboard_references.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/common/saved_dashboard_references.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/common/saved_dashboard_references.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/common/saved_dashboard_references.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/common/types/modules.ts" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/common/types/modules.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/types.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/types.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/types.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/types.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/types.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/helpers/create_source.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/helpers/create_source.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/helpers/find_object_by_title.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/helpers/find_object_by_title.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts" + }, + { + "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" + }, + { + "plugin": "embeddable", + "path": "src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts" + }, + { + "plugin": "embeddable", + "path": "src/plugins/embeddable/public/types.ts" + }, + { + "plugin": "embeddable", + "path": "src/plugins/embeddable/public/types.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/common/types/models/settings.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/common/types/models/settings.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/utils/saved_objects_utils/save_with_confirmation.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/utils/saved_objects_utils/save_with_confirmation.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/utils/saved_objects_utils/find_object_by_title.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/utils/saved_objects_utils/find_object_by_title.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/utils/saved_visualization_references/saved_visualization_references.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/utils/saved_visualization_references/saved_visualization_references.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/utils/saved_visualize_utils.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/utils/saved_visualize_utils.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/utils/saved_visualize_utils.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/utils/saved_visualize_utils.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/utils/saved_visualize_utils.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/utils/saved_visualize_utils.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/wizard/search_selection/search_selection.tsx" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/wizard/search_selection/search_selection.tsx" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable_factory.tsx" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable_factory.tsx" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_find_saved_object.tsx" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_find_saved_object.tsx" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_create_saved_object.tsx" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_create_saved_object.tsx" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_create_saved_object.tsx" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_get_saved_object.tsx" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_get_saved_object.tsx" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_update_saved_object.tsx" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_update_saved_object.tsx" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_update_saved_object.tsx" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/containers/saved_view/saved_view.tsx" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/containers/saved_view/saved_view.tsx" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/shareable_runtime/types.ts" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/shareable_runtime/types.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/saved_workspace_references.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/saved_workspace_references.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/helpers/saved_workspace_utils.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/helpers/saved_workspace_utils.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/saved_object.test.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/saved_object.test.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/saved_object.test.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/saved_object.test.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/saved_object.test.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/saved_object.test.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/saved_object.test.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/saved_object.test.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/saved_object.test.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/saved_object.test.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/saved_object.test.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.test.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.test.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.test.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/utils/saved_objects_utils/save_with_confirmation.test.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/utils/saved_objects_utils/save_with_confirmation.test.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/utils/saved_objects_utils/save_with_confirmation.test.ts" + }, + { + "plugin": "@kbn/core-saved-objects-server-internal", + "path": "packages/core/saved-objects/core-saved-objects-server-internal/src/routes/legacy_import_export/lib/collect_references_deep.test.ts" + }, + { + "plugin": "@kbn/core-saved-objects-server-internal", + "path": "packages/core/saved-objects/core-saved-objects-server-internal/src/routes/legacy_import_export/lib/collect_references_deep.test.ts" + } + ], "children": [ { "parentPluginId": "core", @@ -14617,11 +15245,11 @@ "\nA sub-set of {@link UiSettingsParams} exposed to the client-side." ], "signature": [ - "{ options?: string[] | number[] | undefined; type?: ", + "{ name?: string | undefined; value?: unknown; description?: string | undefined; category?: string[] | undefined; options?: string[] | number[] | undefined; optionLabels?: Record | undefined; requiresPageReload?: boolean | undefined; readonly?: boolean | undefined; sensitive?: boolean | undefined; type?: ", "UiSettingsType", - " | undefined; metric?: { type: string; name: string; } | undefined; value?: unknown; description?: string | undefined; name?: string | undefined; order?: number | undefined; category?: string[] | undefined; optionLabels?: Record | undefined; requiresPageReload?: boolean | undefined; readonly?: boolean | undefined; sensitive?: boolean | undefined; deprecation?: ", + " | undefined; deprecation?: ", "DeprecationSettings", - " | undefined; }" + " | undefined; order?: number | undefined; metric?: { type: string; name: string; } | undefined; }" ], "path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts", "deprecated": false, @@ -14920,16 +15548,13 @@ { "parentPluginId": "core", "id": "def-public.URL_MAX_LENGTH", - "type": "CompoundType", + "type": "number", "tags": [], "label": "URL_MAX_LENGTH", "description": [ "\nThe max URL length allowed by the current browser. Should be used to display warnings to users when query parameters\ncause URL to exceed this limit." ], - "signature": [ - "2000 | 25000" - ], - "path": "src/core/public/core_app/errors/url_overflow.tsx", + "path": "node_modules/@types/kbn__core-apps-browser-internal/index.d.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -18539,6 +19164,14 @@ "plugin": "security", "path": "x-pack/plugins/security/server/analytics/analytics_service.ts" }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/services/analytics/types.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/services/analytics/analytics_service.ts" + }, { "plugin": "osquery", "path": "x-pack/plugins/osquery/server/lib/telemetry/sender.ts" @@ -18603,6 +19236,10 @@ "plugin": "@kbn/core-analytics-server-internal", "path": "packages/core/analytics/core-analytics-server-internal/src/analytics_service.ts" }, + { + "plugin": "@kbn/core-status-server-internal", + "path": "packages/core/status/core-status-server-internal/src/status_service.ts" + }, { "plugin": "security", "path": "x-pack/plugins/security/server/analytics/analytics_service.test.ts" @@ -18615,6 +19252,22 @@ "plugin": "@kbn/core-analytics-server-mocks", "path": "packages/core/analytics/core-analytics-server-mocks/src/analytics_service.mock.ts" }, + { + "plugin": "@kbn/core-status-server-internal", + "path": "packages/core/status/core-status-server-internal/src/status_service.test.ts" + }, + { + "plugin": "@kbn/core-status-server-internal", + "path": "packages/core/status/core-status-server-internal/src/status_service.test.ts" + }, + { + "plugin": "@kbn/core-status-server-internal", + "path": "packages/core/status/core-status-server-internal/src/status_service.test.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/services/analytics/analytics.stub.ts" + }, { "plugin": "@kbn/core-analytics-browser-mocks", "path": "packages/core/analytics/core-analytics-browser-mocks/src/analytics_service.mock.ts" @@ -18945,6 +19598,10 @@ "plugin": "@kbn/core-execution-context-browser-internal", "path": "packages/core/execution-context/core-execution-context-browser-internal/src/execution_context_service.ts" }, + { + "plugin": "@kbn/core-status-server-internal", + "path": "packages/core/status/core-status-server-internal/src/status_service.ts" + }, { "plugin": "cloud", "path": "x-pack/plugins/cloud/public/plugin.test.ts" @@ -19009,6 +19666,14 @@ "plugin": "@kbn/core-elasticsearch-server-internal", "path": "packages/core/elasticsearch/core-elasticsearch-server-internal/src/register_analytics_context_provider.test.ts" }, + { + "plugin": "@kbn/core-status-server-internal", + "path": "packages/core/status/core-status-server-internal/src/status_service.test.ts" + }, + { + "plugin": "@kbn/core-status-server-internal", + "path": "packages/core/status/core-status-server-internal/src/status_service.test.ts" + }, { "plugin": "@kbn/core-analytics-browser-internal", "path": "packages/core/analytics/core-analytics-browser-internal/src/analytics_service.test.mocks.ts" @@ -20835,13 +21500,7 @@ "label": "uiSettings", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.UiSettingsRequestHandlerContext", - "text": "UiSettingsRequestHandlerContext" - } + "UiSettingsRequestHandlerContext" ], "path": "src/core/server/core_route_handler_context.ts", "deprecated": false, @@ -21123,13 +21782,7 @@ "{@link StatusServiceSetup}" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.StatusServiceSetup", - "text": "StatusServiceSetup" - } + "StatusServiceSetup" ], "path": "src/core/server/index.ts", "deprecated": false, @@ -21145,13 +21798,7 @@ "{@link UiSettingsServiceSetup}" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.UiSettingsServiceSetup", - "text": "UiSettingsServiceSetup" - } + "UiSettingsServiceSetup" ], "path": "src/core/server/index.ts", "deprecated": false, @@ -21359,13 +22006,7 @@ "{@link UiSettingsServiceStart}" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.UiSettingsServiceStart", - "text": "UiSettingsServiceStart" - } + "UiSettingsServiceStart" ], "path": "src/core/server/index.ts", "deprecated": false, @@ -21383,7 +22024,10 @@ "description": [ "\nStatus of core services.\n" ], - "path": "src/core/server/status/types.ts", + "signature": [ + "CoreStatus" + ], + "path": "node_modules/@types/kbn__core-status-common/index.d.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -21398,7 +22042,7 @@ "ServiceStatus", "" ], - "path": "src/core/server/status/types.ts", + "path": "node_modules/@types/kbn__core-status-common/index.d.ts", "deprecated": false, "trackAdoption": false }, @@ -21413,7 +22057,7 @@ "ServiceStatus", "" ], - "path": "src/core/server/status/types.ts", + "path": "node_modules/@types/kbn__core-status-common/index.d.ts", "deprecated": false, "trackAdoption": false } @@ -26374,7 +27018,7 @@ "\nA {@link ElasticsearchClient | client} to be used to query the ES cluster on behalf of the Kibana internal user" ], "signature": [ - "{ get: { (this: That, params: ", + "{ name: string | symbol; get: { (this: That, params: ", "GetRequest", " | ", "GetRequest", @@ -26492,7 +27136,7 @@ "default", "; security: ", "default", - "; name: string | symbol; index: { (this: That, params: ", + "; index: { (this: That, params: ", "IndexRequest", " | ", "IndexRequest", @@ -31516,7 +32160,7 @@ "\nA {@link ElasticsearchClient | client} to be used to query the elasticsearch cluster\non behalf of the internal Kibana user." ], "signature": [ - "{ get: { (this: That, params: ", + "{ name: string | symbol; get: { (this: That, params: ", "GetRequest", " | ", "GetRequest", @@ -31634,7 +32278,7 @@ "default", "; security: ", "default", - "; name: string | symbol; index: { (this: That, params: ", + "; index: { (this: That, params: ", "IndexRequest", " | ", "IndexRequest", @@ -32720,7 +33364,7 @@ "\nA {@link ElasticsearchClient | client} to be used to query the elasticsearch cluster\non behalf of the user that initiated the request to the Kibana server." ], "signature": [ - "{ get: { (this: That, params: ", + "{ name: string | symbol; get: { (this: That, params: ", "GetRequest", " | ", "GetRequest", @@ -32838,7 +33482,7 @@ "default", "; security: ", "default", - "; name: string | symbol; index: { (this: That, params: ", + "; index: { (this: That, params: ", "IndexRequest", " | ", "IndexRequest", @@ -34095,7 +34739,10 @@ "description": [ "\nServer-side client that provides access to the advanced settings stored in elasticsearch.\nThe settings provide control over the behavior of the Kibana application.\nFor example, a user can specify how to display numeric or date fields.\nUsers can adjust the settings via Management UI.\n" ], - "path": "src/core/server/ui_settings/types.ts", + "signature": [ + "IUiSettingsClient" + ], + "path": "node_modules/@types/kbn__core-ui-settings-server/index.d.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -34113,7 +34760,7 @@ "PublicUiSettingsParams", ">>" ], - "path": "src/core/server/ui_settings/types.ts", + "path": "node_modules/@types/kbn__core-ui-settings-server/index.d.ts", "deprecated": false, "trackAdoption": false, "children": [], @@ -34131,7 +34778,7 @@ "signature": [ "(key: string) => Promise" ], - "path": "src/core/server/ui_settings/types.ts", + "path": "node_modules/@types/kbn__core-ui-settings-server/index.d.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -34145,7 +34792,7 @@ "signature": [ "string" ], - "path": "src/core/server/ui_settings/types.ts", + "path": "node_modules/@types/kbn__core-ui-settings-server/index.d.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -34165,7 +34812,7 @@ "signature": [ "() => Promise>" ], - "path": "src/core/server/ui_settings/types.ts", + "path": "node_modules/@types/kbn__core-ui-settings-server/index.d.ts", "deprecated": false, "trackAdoption": false, "children": [], @@ -34185,7 +34832,7 @@ "UserProvidedValues", ">>" ], - "path": "src/core/server/ui_settings/types.ts", + "path": "node_modules/@types/kbn__core-ui-settings-server/index.d.ts", "deprecated": false, "trackAdoption": false, "children": [], @@ -34203,7 +34850,7 @@ "signature": [ "(changes: Record) => Promise" ], - "path": "src/core/server/ui_settings/types.ts", + "path": "node_modules/@types/kbn__core-ui-settings-server/index.d.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -34217,7 +34864,7 @@ "signature": [ "Record" ], - "path": "src/core/server/ui_settings/types.ts", + "path": "node_modules/@types/kbn__core-ui-settings-server/index.d.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -34237,7 +34884,7 @@ "signature": [ "(key: string, value: any) => Promise" ], - "path": "src/core/server/ui_settings/types.ts", + "path": "node_modules/@types/kbn__core-ui-settings-server/index.d.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -34251,7 +34898,7 @@ "signature": [ "string" ], - "path": "src/core/server/ui_settings/types.ts", + "path": "node_modules/@types/kbn__core-ui-settings-server/index.d.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -34266,7 +34913,7 @@ "signature": [ "any" ], - "path": "src/core/server/ui_settings/types.ts", + "path": "node_modules/@types/kbn__core-ui-settings-server/index.d.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -34286,7 +34933,7 @@ "signature": [ "(key: string) => Promise" ], - "path": "src/core/server/ui_settings/types.ts", + "path": "node_modules/@types/kbn__core-ui-settings-server/index.d.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -34300,7 +34947,7 @@ "signature": [ "string" ], - "path": "src/core/server/ui_settings/types.ts", + "path": "node_modules/@types/kbn__core-ui-settings-server/index.d.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -34320,7 +34967,7 @@ "signature": [ "(keys: string[]) => Promise" ], - "path": "src/core/server/ui_settings/types.ts", + "path": "node_modules/@types/kbn__core-ui-settings-server/index.d.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -34334,7 +34981,7 @@ "signature": [ "string[]" ], - "path": "src/core/server/ui_settings/types.ts", + "path": "node_modules/@types/kbn__core-ui-settings-server/index.d.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -34354,7 +35001,7 @@ "signature": [ "(key: string) => boolean" ], - "path": "src/core/server/ui_settings/types.ts", + "path": "node_modules/@types/kbn__core-ui-settings-server/index.d.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -34368,7 +35015,7 @@ "signature": [ "string" ], - "path": "src/core/server/ui_settings/types.ts", + "path": "node_modules/@types/kbn__core-ui-settings-server/index.d.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -34388,7 +35035,7 @@ "signature": [ "(key: string) => boolean" ], - "path": "src/core/server/ui_settings/types.ts", + "path": "node_modules/@types/kbn__core-ui-settings-server/index.d.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -34402,7 +35049,7 @@ "signature": [ "string" ], - "path": "src/core/server/ui_settings/types.ts", + "path": "node_modules/@types/kbn__core-ui-settings-server/index.d.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -34742,7 +35389,7 @@ "label": "options", "description": [], "signature": [ - "Method extends \"get\" | \"options\" ? Required, \"body\">> : Required<", "RouteConfigOptions", @@ -35200,7 +35847,7 @@ "label": "level", "description": [], "signature": [ - "\"error\" | \"all\" | \"info\" | \"debug\" | \"off\" | \"trace\" | \"warn\" | \"fatal\"" + "\"error\" | \"all\" | \"info\" | \"debug\" | \"off\" | \"warn\" | \"trace\" | \"fatal\"" ], "path": "node_modules/@types/kbn__core-logging-server/index.d.ts", "deprecated": false, @@ -36019,6 +36666,30 @@ "plugin": "kibanaUsageCollection", "path": "src/plugins/kibana_usage_collection/server/collectors/ops_stats/ops_stats_collector.ts" }, + { + "plugin": "@kbn/core-apps-browser-internal", + "path": "packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts" + }, + { + "plugin": "@kbn/core-apps-browser-internal", + "path": "packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts" + }, + { + "plugin": "@kbn/core-apps-browser-internal", + "path": "packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts" + }, + { + "plugin": "@kbn/core-apps-browser-internal", + "path": "packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts" + }, + { + "plugin": "@kbn/core-apps-browser-internal", + "path": "packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts" + }, + { + "plugin": "@kbn/core-apps-browser-internal", + "path": "packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts" + }, { "plugin": "@kbn/core-metrics-server-internal", "path": "packages/core/metrics/core-metrics-server-internal/src/ops_metrics_collector.ts" @@ -36027,6 +36698,14 @@ "plugin": "@kbn/core-metrics-server-internal", "path": "packages/core/metrics/core-metrics-server-internal/src/logging/get_ops_metrics_log.ts" }, + { + "plugin": "@kbn/core-status-server-internal", + "path": "packages/core/status/core-status-server-internal/src/routes/status.ts" + }, + { + "plugin": "@kbn/core-status-server-internal", + "path": "packages/core/status/core-status-server-internal/src/routes/status.ts" + }, { "plugin": "@kbn/core-usage-data-server-internal", "path": "packages/core/usage-data/core-usage-data-server-internal/src/core_usage_data_service.ts" @@ -36042,6 +36721,10 @@ { "plugin": "@kbn/core-metrics-server-internal", "path": "packages/core/metrics/core-metrics-server-internal/src/logging/get_ops_metrics_log.test.ts" + }, + { + "plugin": "@kbn/core-apps-browser-internal", + "path": "packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.test.ts" } ] }, @@ -36932,13 +37615,13 @@ "signature": [ "{ legacy: { globalConfig$: ", "Observable", - " moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly requestTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly pingTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; }>; path: Readonly<{ readonly data: string; }>; savedObjects: Readonly<{ readonly maxImportPayloadBytes: Readonly<{ isGreaterThan: (other: ", + " moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly shardTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly pingTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; }>; path: Readonly<{ readonly data: string; }>; savedObjects: Readonly<{ readonly maxImportPayloadBytes: Readonly<{ isGreaterThan: (other: ", "ByteSizeValue", ") => boolean; isLessThan: (other: ", "ByteSizeValue", ") => boolean; isEqualTo: (other: ", "ByteSizeValue", - ") => boolean; getValueInBytes: () => number; toString: (returnUnit?: ByteSizeValueUnit | undefined) => string; }>; }>; }>>; get: () => Readonly<{ elasticsearch: Readonly<{ readonly shardTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly requestTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly pingTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; }>; path: Readonly<{ readonly data: string; }>; savedObjects: Readonly<{ readonly maxImportPayloadBytes: Readonly<{ isGreaterThan: (other: ", + ") => boolean; getValueInBytes: () => number; toString: (returnUnit?: ByteSizeValueUnit | undefined) => string; }>; }>; }>>; get: () => Readonly<{ elasticsearch: Readonly<{ readonly requestTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly shardTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly pingTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; }>; path: Readonly<{ readonly data: string; }>; savedObjects: Readonly<{ readonly maxImportPayloadBytes: Readonly<{ isGreaterThan: (other: ", "ByteSizeValue", ") => boolean; isLessThan: (other: ", "ByteSizeValue", @@ -37219,7 +37902,7 @@ "label": "internalClient", "description": [], "signature": [ - "{ get: { (this: That, params: ", + "{ name: string | symbol; get: { (this: That, params: ", "GetRequest", " | ", "GetRequest", @@ -37337,7 +38020,7 @@ "default", "; security: ", "default", - "; name: string | symbol; index: { (this: That, params: ", + "; index: { (this: That, params: ", "IndexRequest", " | ", "IndexRequest", @@ -38845,7 +39528,7 @@ "\nAdditional body options {@link RouteConfigOptionsBody}." ], "signature": [ - "(Method extends \"get\" | \"options\" ? undefined : ", + "(Method extends \"options\" | \"get\" ? undefined : ", "RouteConfigOptionsBody", ") | undefined" ], @@ -38863,7 +39546,7 @@ "\nDefines per-route timeouts." ], "signature": [ - "{ payload?: (Method extends \"get\" | \"options\" ? undefined : number) | undefined; idleSocket?: number | undefined; } | undefined" + "{ payload?: (Method extends \"options\" | \"get\" ? undefined : number) | undefined; idleSocket?: number | undefined; } | undefined" ], "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, @@ -39258,7 +39941,7 @@ "tags": [], "label": "attributes", "description": [ - "{@inheritdoc SavedObjectAttributes}" + "The data for a Saved Object is stored as an object in the `attributes` property." ], "signature": [ "T" @@ -39356,7 +40039,9 @@ "parentPluginId": "core", "id": "def-server.SavedObjectAttributes", "type": "Interface", - "tags": [], + "tags": [ + "deprecated" + ], "label": "SavedObjectAttributes", "description": [ "\nThe data for a Saved Object is stored as an object in the `attributes`\nproperty.\n" @@ -39365,8 +40050,598 @@ "SavedObjectAttributes" ], "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", - "deprecated": false, + "deprecated": true, "trackAdoption": false, + "references": [ + { + "plugin": "actions", + "path": "x-pack/plugins/actions/server/actions_client.ts" + }, + { + "plugin": "actions", + "path": "x-pack/plugins/actions/server/actions_client.ts" + }, + { + "plugin": "actions", + "path": "x-pack/plugins/actions/server/actions_client.ts" + }, + { + "plugin": "actions", + "path": "x-pack/plugins/actions/server/actions_client.ts" + }, + { + "plugin": "actions", + "path": "x-pack/plugins/actions/server/actions_client.ts" + }, + { + "plugin": "actions", + "path": "x-pack/plugins/actions/server/actions_client.ts" + }, + { + "plugin": "actions", + "path": "x-pack/plugins/actions/server/actions_client.ts" + }, + { + "plugin": "actions", + "path": "x-pack/plugins/actions/server/types.ts" + }, + { + "plugin": "actions", + "path": "x-pack/plugins/actions/server/types.ts" + }, + { + "plugin": "actions", + "path": "x-pack/plugins/actions/server/types.ts" + }, + { + "plugin": "actions", + "path": "x-pack/plugins/actions/server/types.ts" + }, + { + "plugin": "actions", + "path": "x-pack/plugins/actions/server/types.ts" + }, + { + "plugin": "actions", + "path": "x-pack/plugins/actions/server/types.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/common/rule.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/common/rule.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/common/rule.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/common/rule.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/common/rule.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/common/rule.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/saved_objects/geo_containment/migrations.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/saved_objects/geo_containment/migrations.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/saved_objects/migrations.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/saved_objects/migrations.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/saved_objects/migrations.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/types.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/types.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/types.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/types.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/types.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/types.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/types.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/server/routes/custom_elements/find.ts" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/server/routes/custom_elements/find.ts" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/server/routes/workpad/find.ts" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/server/routes/workpad/find.ts" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/server/collectors/lib/telemetry.ts" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/server/collectors/lib/telemetry.ts" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/server/collectors/lib/telemetry.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions/legacy_types.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions/legacy_types.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions/legacy_migrations.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions/legacy_migrations.ts" + }, + { + "plugin": "taskManager", + "path": "x-pack/plugins/task_manager/server/task_store.test.ts" + }, + { + "plugin": "taskManager", + "path": "x-pack/plugins/task_manager/server/task_store.test.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/server/saved_objects/dashboard_migrations.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/server/saved_objects/dashboard_migrations.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/server/usage/dashboard_telemetry_collection_task.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/server/usage/dashboard_telemetry_collection_task.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/server/usage/dashboard_telemetry.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/server/usage/dashboard_telemetry.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/server/usage/find_by_value_embeddables.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/server/usage/find_by_value_embeddables.ts" + }, + { + "plugin": "savedSearch", + "path": "src/plugins/saved_search/server/saved_objects/search_migrations.ts" + }, + { + "plugin": "savedSearch", + "path": "src/plugins/saved_search/server/saved_objects/search_migrations.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/common/types.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/common/types.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/common/saved_dashboard_references.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/common/saved_dashboard_references.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/common/saved_dashboard_references.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/common/saved_dashboard_references.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/common/saved_dashboard_references.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/common/saved_dashboard_references.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/common/saved_dashboard_references.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/common/saved_dashboard_references.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/common/types/modules.ts" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/common/types/modules.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/types.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/types.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/types.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/types.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/types.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/helpers/create_source.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/helpers/create_source.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/helpers/find_object_by_title.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/helpers/find_object_by_title.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts" + }, + { + "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" + }, + { + "plugin": "embeddable", + "path": "src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts" + }, + { + "plugin": "embeddable", + "path": "src/plugins/embeddable/public/types.ts" + }, + { + "plugin": "embeddable", + "path": "src/plugins/embeddable/public/types.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/common/types/models/settings.ts" + }, + { + "plugin": "fleet", + "path": "x-pack/plugins/fleet/common/types/models/settings.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/utils/saved_objects_utils/save_with_confirmation.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/utils/saved_objects_utils/save_with_confirmation.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/utils/saved_objects_utils/find_object_by_title.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/utils/saved_objects_utils/find_object_by_title.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/utils/saved_visualization_references/saved_visualization_references.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/utils/saved_visualization_references/saved_visualization_references.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/utils/saved_visualize_utils.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/utils/saved_visualize_utils.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/utils/saved_visualize_utils.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/utils/saved_visualize_utils.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/utils/saved_visualize_utils.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/utils/saved_visualize_utils.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/wizard/search_selection/search_selection.tsx" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/wizard/search_selection/search_selection.tsx" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable_factory.tsx" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable_factory.tsx" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.tsx" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_find_saved_object.tsx" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_find_saved_object.tsx" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_create_saved_object.tsx" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_create_saved_object.tsx" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_create_saved_object.tsx" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_get_saved_object.tsx" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_get_saved_object.tsx" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_update_saved_object.tsx" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_update_saved_object.tsx" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/hooks/use_update_saved_object.tsx" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/containers/saved_view/saved_view.tsx" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/containers/saved_view/saved_view.tsx" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/shareable_runtime/types.ts" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/shareable_runtime/types.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/saved_workspace_references.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/services/persistence/saved_workspace_references.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/helpers/saved_workspace_utils.ts" + }, + { + "plugin": "graph", + "path": "x-pack/plugins/graph/public/helpers/saved_workspace_utils.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/saved_object.test.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/saved_object.test.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/saved_object.test.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/saved_object.test.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/saved_object.test.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/saved_object.test.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/saved_object.test.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/saved_object.test.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/saved_object.test.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/saved_object.test.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/saved_object.test.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.test.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.test.ts" + }, + { + "plugin": "savedObjects", + "path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.test.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/utils/saved_objects_utils/save_with_confirmation.test.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/utils/saved_objects_utils/save_with_confirmation.test.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/utils/saved_objects_utils/save_with_confirmation.test.ts" + }, + { + "plugin": "@kbn/core-saved-objects-server-internal", + "path": "packages/core/saved-objects/core-saved-objects-server-internal/src/routes/legacy_import_export/lib/collect_references_deep.test.ts" + }, + { + "plugin": "@kbn/core-saved-objects-server-internal", + "path": "packages/core/saved-objects/core-saved-objects-server-internal/src/routes/legacy_import_export/lib/collect_references_deep.test.ts" + } + ], "children": [ { "parentPluginId": "core", @@ -40213,7 +41488,7 @@ "tags": [], "label": "attributes", "description": [ - "{@inheritdoc SavedObjectAttributes}" + "The data for a Saved Object is stored as an object in the `attributes` property." ], "signature": [ "{ [P in keyof T]?: T[P] | undefined; }" @@ -45149,9 +46424,7 @@ "\nRegister a {@link SavedObjectsType | savedObjects type} definition.\n\nSee the {@link SavedObjectsTypeMappingDefinition | mappings format} and\n{@link SavedObjectMigrationMap | migration format} for more details about these.\n" ], "signature": [ - "(type: ", + "(type: ", "SavedObjectsType", ") => void" ], @@ -46420,7 +47693,7 @@ "ServiceStatus", "" ], - "path": "node_modules/@types/kbn__core-base-common/index.d.ts", + "path": "node_modules/@types/kbn__core-status-common/index.d.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -46436,7 +47709,7 @@ "signature": [ "Readonly<{ toString: () => \"available\"; valueOf: () => 0; toJSON: () => \"available\"; }> | Readonly<{ toString: () => \"degraded\"; valueOf: () => 1; toJSON: () => \"degraded\"; }> | Readonly<{ toString: () => \"unavailable\"; valueOf: () => 2; toJSON: () => \"unavailable\"; }> | Readonly<{ toString: () => \"critical\"; valueOf: () => 3; toJSON: () => \"critical\"; }>" ], - "path": "node_modules/@types/kbn__core-base-common/index.d.ts", + "path": "node_modules/@types/kbn__core-status-common/index.d.ts", "deprecated": false, "trackAdoption": false }, @@ -46449,7 +47722,7 @@ "description": [ "\nA high-level summary of the service status." ], - "path": "node_modules/@types/kbn__core-base-common/index.d.ts", + "path": "node_modules/@types/kbn__core-status-common/index.d.ts", "deprecated": false, "trackAdoption": false }, @@ -46465,7 +47738,7 @@ "signature": [ "string | undefined" ], - "path": "node_modules/@types/kbn__core-base-common/index.d.ts", + "path": "node_modules/@types/kbn__core-status-common/index.d.ts", "deprecated": false, "trackAdoption": false }, @@ -46481,7 +47754,7 @@ "signature": [ "string | undefined" ], - "path": "node_modules/@types/kbn__core-base-common/index.d.ts", + "path": "node_modules/@types/kbn__core-status-common/index.d.ts", "deprecated": false, "trackAdoption": false }, @@ -46497,7 +47770,7 @@ "signature": [ "Meta | undefined" ], - "path": "node_modules/@types/kbn__core-base-common/index.d.ts", + "path": "node_modules/@types/kbn__core-status-common/index.d.ts", "deprecated": false, "trackAdoption": false } @@ -46906,7 +48179,10 @@ "description": [ "\nAPI for accessing status of Core and this plugin's dependencies as well as for customizing this plugin's status.\n" ], - "path": "src/core/server/status/types.ts", + "signature": [ + "StatusServiceSetup" + ], + "path": "node_modules/@types/kbn__core-status-server/index.d.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -46922,16 +48198,10 @@ "signature": [ "Observable", "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreStatus", - "text": "CoreStatus" - }, + "CoreStatus", ">" ], - "path": "src/core/server/status/types.ts", + "path": "node_modules/@types/kbn__core-status-server/index.d.ts", "deprecated": false, "trackAdoption": false }, @@ -46950,7 +48220,7 @@ "ServiceStatus", ">" ], - "path": "src/core/server/status/types.ts", + "path": "node_modules/@types/kbn__core-status-server/index.d.ts", "deprecated": false, "trackAdoption": false }, @@ -46970,7 +48240,7 @@ "ServiceStatus", ">) => void" ], - "path": "src/core/server/status/types.ts", + "path": "node_modules/@types/kbn__core-status-server/index.d.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -46987,7 +48257,7 @@ "ServiceStatus", ">" ], - "path": "src/core/server/status/types.ts", + "path": "node_modules/@types/kbn__core-status-server/index.d.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -47010,7 +48280,7 @@ "ServiceStatus", ">>" ], - "path": "src/core/server/status/types.ts", + "path": "node_modules/@types/kbn__core-status-server/index.d.ts", "deprecated": false, "trackAdoption": false }, @@ -47029,7 +48299,7 @@ "ServiceStatus", ">" ], - "path": "src/core/server/status/types.ts", + "path": "node_modules/@types/kbn__core-status-server/index.d.ts", "deprecated": false, "trackAdoption": false }, @@ -47045,7 +48315,7 @@ "signature": [ "() => boolean" ], - "path": "src/core/server/status/types.ts", + "path": "node_modules/@types/kbn__core-status-server/index.d.ts", "deprecated": false, "trackAdoption": false, "children": [], @@ -47415,7 +48685,10 @@ "description": [ "\nCore's `uiSettings` request handler context." ], - "path": "src/core/server/ui_settings/ui_settings_route_handler_context.ts", + "signature": [ + "UiSettingsRequestHandlerContext" + ], + "path": "node_modules/@types/kbn__core-ui-settings-server/index.d.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -47427,15 +48700,9 @@ "label": "client", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IUiSettingsClient", - "text": "IUiSettingsClient" - } + "IUiSettingsClient" ], - "path": "src/core/server/ui_settings/ui_settings_route_handler_context.ts", + "path": "node_modules/@types/kbn__core-ui-settings-server/index.d.ts", "deprecated": false, "trackAdoption": false } @@ -47449,7 +48716,10 @@ "tags": [], "label": "UiSettingsServiceSetup", "description": [], - "path": "src/core/server/ui_settings/types.ts", + "signature": [ + "UiSettingsServiceSetup" + ], + "path": "node_modules/@types/kbn__core-ui-settings-server/index.d.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -47467,7 +48737,7 @@ "UiSettingsParams", ">) => void" ], - "path": "src/core/server/ui_settings/types.ts", + "path": "node_modules/@types/kbn__core-ui-settings-server/index.d.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -47483,7 +48753,7 @@ "UiSettingsParams", ">" ], - "path": "src/core/server/ui_settings/types.ts", + "path": "node_modules/@types/kbn__core-ui-settings-server/index.d.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -47501,7 +48771,10 @@ "tags": [], "label": "UiSettingsServiceStart", "description": [], - "path": "src/core/server/ui_settings/types.ts", + "signature": [ + "UiSettingsServiceStart" + ], + "path": "node_modules/@types/kbn__core-ui-settings-server/index.d.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -47518,15 +48791,9 @@ "(savedObjectsClient: ", "SavedObjectsClientContract", ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IUiSettingsClient", - "text": "IUiSettingsClient" - } + "IUiSettingsClient" ], - "path": "src/core/server/ui_settings/types.ts", + "path": "node_modules/@types/kbn__core-ui-settings-server/index.d.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -47540,7 +48807,7 @@ "signature": [ "SavedObjectsClientContract" ], - "path": "src/core/server/ui_settings/types.ts", + "path": "node_modules/@types/kbn__core-ui-settings-server/index.d.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -48623,7 +49890,7 @@ "label": "EcsEventKind", "description": [], "signature": [ - "\"metric\" | \"alert\" | \"state\" | \"event\" | \"signal\" | \"pipeline_error\"" + "\"metric\" | \"alert\" | \"signal\" | \"state\" | \"event\" | \"pipeline_error\"" ], "path": "node_modules/@types/kbn__logging/index.d.ts", "deprecated": false, @@ -48670,7 +49937,7 @@ "\nClient used to query the elasticsearch cluster.\n" ], "signature": [ - "{ get: { (this: That, params: ", + "{ name: string | symbol; get: { (this: That, params: ", "GetRequest", " | ", "GetRequest", @@ -48788,7 +50055,7 @@ "default", "; security: ", "default", - "; name: string | symbol; index: { (this: That, params: ", + "; index: { (this: That, params: ", "IndexRequest", " | ", "IndexRequest", @@ -50372,7 +51639,7 @@ "\nRoute options: If 'GET' or 'OPTIONS' method, body options won't be returned." ], "signature": [ - "Method extends \"get\" | \"options\" ? Required, \"body\">> : Required<", "RouteConfigOptions", @@ -51167,11 +52434,11 @@ "\nA sub-set of {@link UiSettingsParams} exposed to the client-side." ], "signature": [ - "{ options?: string[] | number[] | undefined; type?: ", + "{ name?: string | undefined; value?: unknown; description?: string | undefined; category?: string[] | undefined; options?: string[] | number[] | undefined; optionLabels?: Record | undefined; requiresPageReload?: boolean | undefined; readonly?: boolean | undefined; sensitive?: boolean | undefined; type?: ", "UiSettingsType", - " | undefined; metric?: { type: string; name: string; } | undefined; value?: unknown; description?: string | undefined; name?: string | undefined; order?: number | undefined; category?: string[] | undefined; optionLabels?: Record | undefined; requiresPageReload?: boolean | undefined; readonly?: boolean | undefined; sensitive?: boolean | undefined; deprecation?: ", + " | undefined; deprecation?: ", "DeprecationSettings", - " | undefined; }" + " | undefined; order?: number | undefined; metric?: { type: string; name: string; } | undefined; }" ], "path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts", "deprecated": false, @@ -51672,7 +52939,7 @@ "\nSet of HTTP methods not changing the state of the server." ], "signature": [ - "\"get\" | \"options\"" + "\"options\" | \"get\"" ], "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, @@ -52214,7 +53481,7 @@ "signature": [ "Readonly<{ toString: () => \"available\"; valueOf: () => 0; toJSON: () => \"available\"; }> | Readonly<{ toString: () => \"degraded\"; valueOf: () => 1; toJSON: () => \"degraded\"; }> | Readonly<{ toString: () => \"unavailable\"; valueOf: () => 2; toJSON: () => \"unavailable\"; }> | Readonly<{ toString: () => \"critical\"; valueOf: () => 3; toJSON: () => \"critical\"; }>" ], - "path": "node_modules/@types/kbn__core-base-common/index.d.ts", + "path": "node_modules/@types/kbn__core-status-common/index.d.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -52227,7 +53494,7 @@ "label": "SharedGlobalConfig", "description": [], "signature": [ - "{ readonly elasticsearch: Readonly<{ readonly shardTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly requestTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly pingTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; }>; readonly path: Readonly<{ readonly data: string; }>; readonly savedObjects: Readonly<{ readonly maxImportPayloadBytes: Readonly<{ isGreaterThan: (other: ", + "{ readonly elasticsearch: Readonly<{ readonly requestTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly shardTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly pingTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: moment.unitOfTime.DurationConstructor | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; }>; readonly path: Readonly<{ readonly data: string; }>; readonly savedObjects: Readonly<{ readonly maxImportPayloadBytes: Readonly<{ isGreaterThan: (other: ", "ByteSizeValue", ") => boolean; isLessThan: (other: ", "ByteSizeValue", @@ -52405,7 +53672,7 @@ "signature": [ "{ readonly available: Readonly<{ toString: () => \"available\"; valueOf: () => 0; toJSON: () => \"available\"; }>; readonly degraded: Readonly<{ toString: () => \"degraded\"; valueOf: () => 1; toJSON: () => \"degraded\"; }>; readonly unavailable: Readonly<{ toString: () => \"unavailable\"; valueOf: () => 2; toJSON: () => \"unavailable\"; }>; readonly critical: Readonly<{ toString: () => \"critical\"; valueOf: () => 3; toJSON: () => \"critical\"; }>; }" ], - "path": "node_modules/@types/kbn__core-base-common/index.d.ts", + "path": "node_modules/@types/kbn__core-status-common/index.d.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false diff --git a/api_docs/core.mdx b/api_docs/core.mdx index 1bd545035359a..ccf426c9b6909 100644 --- a/api_docs/core.mdx +++ b/api_docs/core.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/core title: "core" image: https://source.unsplash.com/400x175/?github description: API docs for the core plugin -date: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core'] --- import coreObj from './core.devdocs.json'; @@ -21,7 +21,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2657 | 1 | 61 | 2 | +| 2657 | 0 | 45 | 2 | ## Client diff --git a/api_docs/custom_integrations.devdocs.json b/api_docs/custom_integrations.devdocs.json index b808444c5bd7a..7a339106c7a6d 100644 --- a/api_docs/custom_integrations.devdocs.json +++ b/api_docs/custom_integrations.devdocs.json @@ -289,6 +289,20 @@ "trackAdoption": false } ] + }, + { + "parentPluginId": "customIntegrations", + "id": "def-public.CustomIntegrationsStart.languageClientsUiComponents", + "type": "Object", + "tags": [], + "label": "languageClientsUiComponents", + "description": [], + "signature": [ + "Map>" + ], + "path": "src/plugins/custom_integrations/public/types.ts", + "deprecated": false, + "trackAdoption": false } ], "lifecycle": "start", diff --git a/api_docs/custom_integrations.mdx b/api_docs/custom_integrations.mdx index daf36243e408d..6407c53bc8db9 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'customIntegrations'] --- import customIntegrationsObj from './custom_integrations.devdocs.json'; @@ -21,7 +21,7 @@ Contact [Fleet](https://github.com/orgs/elastic/teams/fleet) for questions regar | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 102 | 0 | 83 | 1 | +| 103 | 0 | 84 | 1 | ## Client diff --git a/api_docs/dashboard.devdocs.json b/api_docs/dashboard.devdocs.json index 7af8bf23811e4..447c0d0af07ee 100644 --- a/api_docs/dashboard.devdocs.json +++ b/api_docs/dashboard.devdocs.json @@ -235,21 +235,6 @@ "id": "def-public.DashboardContainer.Unnamed.$2", "type": "Object", "tags": [], - "label": "services", - "description": [], - "signature": [ - "DashboardContainerServices" - ], - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "dashboard", - "id": "def-public.DashboardContainer.Unnamed.$3", - "type": "Object", - "tags": [], "label": "parent", "description": [], "signature": [ @@ -285,7 +270,7 @@ }, { "parentPluginId": "dashboard", - "id": "def-public.DashboardContainer.Unnamed.$4", + "id": "def-public.DashboardContainer.Unnamed.$3", "type": "CompoundType", "tags": [], "label": "controlGroup", @@ -348,9 +333,7 @@ "section": "def-public.EmbeddableFactory", "text": "EmbeddableFactory" }, - ", partial?: Partial) => ", + ", partial?: Partial) => ", "DashboardPanelState", "" ], @@ -373,9 +356,7 @@ "section": "def-public.EmbeddableFactory", "text": "EmbeddableFactory" }, - "" + "" ], "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx", "deprecated": false, @@ -829,9 +810,7 @@ "section": "def-public.DashboardContainer", "text": "DashboardContainer" }, - ", ", - "SavedObjectAttributes", - ">" + ", unknown>" ], "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", "deprecated": false, @@ -994,23 +973,6 @@ { "parentPluginId": "dashboard", "id": "def-public.DashboardContainerFactoryDefinition.Unnamed.$1", - "type": "Function", - "tags": [], - "label": "getStartServices", - "description": [], - "signature": [ - "() => Promise<", - "DashboardContainerServices", - ">" - ], - "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "dashboard", - "id": "def-public.DashboardContainerFactoryDefinition.Unnamed.$2", "type": "Object", "tags": [], "label": "persistableStateService", @@ -1329,21 +1291,6 @@ "deprecated": false, "trackAdoption": false, "children": [ - { - "parentPluginId": "dashboard", - "id": "def-public.DashboardContainerInput.dashboardCapabilities", - "type": "Object", - "tags": [], - "label": "dashboardCapabilities", - "description": [], - "signature": [ - "DashboardAppCapabilities", - " | undefined" - ], - "path": "src/plugins/dashboard/public/types.ts", - "deprecated": false, - "trackAdoption": false - }, { "parentPluginId": "dashboard", "id": "def-public.DashboardContainerInput.controlGroupInput", @@ -1666,7 +1613,10 @@ "docId": "kibSavedObjectsPluginApi", "section": "def-public.SavedObject", "text": "SavedObject" - } + }, + "<", + "SavedObjectAttributes", + ">" ], "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", "deprecated": false, diff --git a/api_docs/dashboard.mdx b/api_docs/dashboard.mdx index d7da06c8bda6e..53da1adcb0d6e 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard'] --- import dashboardObj from './dashboard.devdocs.json'; @@ -21,7 +21,7 @@ Contact [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-prese | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 147 | 0 | 142 | 12 | +| 144 | 0 | 139 | 10 | ## Client diff --git a/api_docs/dashboard_enhanced.mdx b/api_docs/dashboard_enhanced.mdx index 7e58cc9e1a86a..d39b30e5de370 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: 2022-09-09 +date: 2022-09-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 bd569dc580afc..f2850615238c6 100644 --- a/api_docs/data.devdocs.json +++ b/api_docs/data.devdocs.json @@ -3532,16 +3532,16 @@ "trackAdoption": false, "references": [ { - "plugin": "discover", - "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/lib/wrap_search_source_client.ts" }, { "plugin": "discover", "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" }, { - "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/lib/wrap_search_source_client.ts" + "plugin": "discover", + "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" }, { "plugin": "securitySolution", @@ -7334,181 +7334,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "data", - "id": "def-public.IDataPluginServices", - "type": "Interface", - "tags": [], - "label": "IDataPluginServices", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataPluginApi", - "section": "def-public.IDataPluginServices", - "text": "IDataPluginServices" - }, - " extends Partial<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCorePluginApi", - "section": "def-public.CoreStart", - "text": "CoreStart" - }, - ">" - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-public.IDataPluginServices.appName", - "type": "string", - "tags": [], - "label": "appName", - "description": [], - "path": "src/plugins/data/public/types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "data", - "id": "def-public.IDataPluginServices.uiSettings", - "type": "Object", - "tags": [], - "label": "uiSettings", - "description": [], - "signature": [ - "IUiSettingsClient" - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "data", - "id": "def-public.IDataPluginServices.savedObjects", - "type": "Object", - "tags": [], - "label": "savedObjects", - "description": [], - "signature": [ - "SavedObjectsStart" - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "data", - "id": "def-public.IDataPluginServices.notifications", - "type": "Object", - "tags": [], - "label": "notifications", - "description": [], - "signature": [ - "NotificationsStart" - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "data", - "id": "def-public.IDataPluginServices.application", - "type": "Object", - "tags": [], - "label": "application", - "description": [], - "signature": [ - "ApplicationStart" - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "data", - "id": "def-public.IDataPluginServices.http", - "type": "Object", - "tags": [], - "label": "http", - "description": [], - "signature": [ - "HttpSetup" - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "data", - "id": "def-public.IDataPluginServices.storage", - "type": "Object", - "tags": [], - "label": "storage", - "description": [], - "signature": [ - { - "pluginId": "kibanaUtils", - "scope": "public", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-public.IStorageWrapper", - "text": "IStorageWrapper" - }, - "" - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "data", - "id": "def-public.IDataPluginServices.data", - "type": "Object", - "tags": [], - "label": "data", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataPluginApi", - "section": "def-public.DataPublicPluginStart", - "text": "DataPublicPluginStart" - } - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "data", - "id": "def-public.IDataPluginServices.usageCollection", - "type": "Object", - "tags": [], - "label": "usageCollection", - "description": [], - "signature": [ - { - "pluginId": "usageCollection", - "scope": "public", - "docId": "kibUsageCollectionPluginApi", - "section": "def-public.UsageCollectionStart", - "text": "UsageCollectionStart" - }, - " | undefined" - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "data", "id": "def-public.IEsSearchRequest", @@ -7915,6 +7740,24 @@ "path": "src/plugins/data/common/search/types.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "data", + "id": "def-public.ISearchOptions.transport", + "type": "Object", + "tags": [], + "label": "transport", + "description": [ + "\nTransportRequestOptions, other than `signal`, to pass through to the ES client.\nTo pass an abort signal, use {@link ISearchOptions.abortSignal}" + ], + "signature": [ + "Omit<", + "TransportRequestOptions", + ", \"signal\"> | undefined" + ], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -8234,7 +8077,7 @@ "tags": [], "label": "attributes", "description": [ - "{@inheritdoc SavedObjectAttributes}" + "The data for a Saved Object is stored as an object in the `attributes` property." ], "signature": [ "T" @@ -8769,7 +8612,7 @@ "label": "AggConfigOptions", "description": [], "signature": [ - "{ type: ", + "{ schema?: string | undefined; type: ", { "pluginId": "data", "scope": "common", @@ -8779,7 +8622,7 @@ }, "; params?: {} | ", "SerializableRecord", - " | undefined; id?: string | undefined; enabled?: boolean | undefined; schema?: string | undefined; }" + " | undefined; id?: string | undefined; enabled?: boolean | undefined; }" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, @@ -11676,7 +11519,15 @@ "references": [ { "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/actions/export_csv_action.tsx" + "path": "src/plugins/dashboard/public/services/data/types.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/services/data/data_service.ts" + }, + { + "plugin": "dataVisualizer", + "path": "x-pack/plugins/data_visualizer/public/application/common/components/top_values/top_values.tsx" }, { "plugin": "stackAlerts", @@ -15578,7 +15429,7 @@ "label": "elasticsearchClient", "description": [], "signature": [ - "{ get: { (this: That, params: ", + "{ name: string | symbol; get: { (this: That, params: ", "GetRequest", " | ", "GetRequest", @@ -15696,7 +15547,7 @@ "default", "; security: ", "default", - "; name: string | symbol; index: { (this: That, params: ", + "; index: { (this: That, params: ", "IndexRequest", " | ", "IndexRequest", @@ -17173,6 +17024,24 @@ "path": "src/plugins/data/common/search/types.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "data", + "id": "def-server.ISearchOptions.transport", + "type": "Object", + "tags": [], + "label": "transport", + "description": [ + "\nTransportRequestOptions, other than `signal`, to pass through to the ES client.\nTo pass an abort signal, use {@link ISearchOptions.abortSignal}" + ], + "signature": [ + "Omit<", + "TransportRequestOptions", + ", \"signal\"> | undefined" + ], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -20274,7 +20143,7 @@ "section": "def-common.RuntimeFieldSpec", "text": "RuntimeFieldSpec" }, - " | undefined; fixedInterval?: string[] | undefined; timeZone?: string[] | undefined; timeSeriesDimension?: boolean | undefined; timeSeriesMetric?: \"gauge\" | \"histogram\" | \"summary\" | \"counter\" | undefined; shortDotsEnable?: boolean | undefined; isMapped?: boolean | undefined; }" + " | undefined; fixedInterval?: string[] | undefined; timeZone?: string[] | undefined; timeSeriesDimension?: boolean | undefined; timeSeriesMetric?: \"gauge\" | \"histogram\" | \"summary\" | \"counter\" | undefined; shortDotsEnable?: boolean | undefined; isMapped?: boolean | undefined; parentName?: string | undefined; }" ], "path": "src/plugins/data_views/common/fields/data_view_field.ts", "deprecated": false, @@ -23303,83 +23172,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "data", - "id": "def-common.FilterValueFormatter", - "type": "Interface", - "tags": [], - "label": "FilterValueFormatter", - "description": [], - "path": "src/plugins/data/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.FilterValueFormatter.convert", - "type": "Function", - "tags": [], - "label": "convert", - "description": [], - "signature": [ - "(value: any) => string" - ], - "path": "src/plugins/data/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-common.FilterValueFormatter.convert.$1", - "type": "Any", - "tags": [], - "label": "value", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data/common/types.ts", - "deprecated": false, - "trackAdoption": false - } - ] - }, - { - "parentPluginId": "data", - "id": "def-common.FilterValueFormatter.getConverterFor", - "type": "Function", - "tags": [], - "label": "getConverterFor", - "description": [], - "signature": [ - "(type: string) => FilterFormatterFunction" - ], - "path": "src/plugins/data/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-common.FilterValueFormatter.getConverterFor.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/data/common/types.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, { "parentPluginId": "data", "id": "def-common.GetFieldsOptions", @@ -23826,7 +23618,7 @@ "tags": [], "label": "attributes", "description": [ - "{@inheritdoc SavedObjectAttributes}" + "The data for a Saved Object is stored as an object in the `attributes` property." ], "signature": [ "T" @@ -24594,7 +24386,7 @@ "section": "def-common.RuntimeFieldSpec", "text": "RuntimeFieldSpec" }, - " | undefined; fixedInterval?: string[] | undefined; timeZone?: string[] | undefined; timeSeriesDimension?: boolean | undefined; timeSeriesMetric?: \"gauge\" | \"histogram\" | \"summary\" | \"counter\" | undefined; shortDotsEnable?: boolean | undefined; isMapped?: boolean | undefined; }" + " | undefined; fixedInterval?: string[] | undefined; timeZone?: string[] | undefined; timeSeriesDimension?: boolean | undefined; timeSeriesMetric?: \"gauge\" | \"histogram\" | \"summary\" | \"counter\" | undefined; shortDotsEnable?: boolean | undefined; isMapped?: boolean | undefined; parentName?: string | undefined; }" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false, diff --git a/api_docs/data.mdx b/api_docs/data.mdx index f7f878ec5cf74..5c4d12a6cb3d5 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data'] --- import dataObj from './data.devdocs.json'; @@ -21,7 +21,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 3144 | 34 | 2444 | 23 | +| 3132 | 33 | 2429 | 23 | ## Client diff --git a/api_docs/data_query.devdocs.json b/api_docs/data_query.devdocs.json index 99b35ae9ab7dd..2507050e905fc 100644 --- a/api_docs/data_query.devdocs.json +++ b/api_docs/data_query.devdocs.json @@ -1863,14 +1863,6 @@ "plugin": "dashboard", "path": "src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts" }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/listing/dashboard_listing.tsx" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/public/application/listing/dashboard_listing.tsx" - }, { "plugin": "maps", "path": "x-pack/plugins/maps/public/routes/map_page/url_state/global_sync.ts" diff --git a/api_docs/data_query.mdx b/api_docs/data_query.mdx index 5206f1ec46730..09c1081a7ca5a 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query'] --- import dataQueryObj from './data_query.devdocs.json'; @@ -21,7 +21,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 3144 | 34 | 2444 | 23 | +| 3132 | 33 | 2429 | 23 | ## Client diff --git a/api_docs/data_search.devdocs.json b/api_docs/data_search.devdocs.json index 399c9e5b7f188..c3cfd123f1166 100644 --- a/api_docs/data_search.devdocs.json +++ b/api_docs/data_search.devdocs.json @@ -9723,16 +9723,16 @@ "trackAdoption": false, "references": [ { - "plugin": "discover", - "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/lib/wrap_search_source_client.ts" }, { "plugin": "discover", "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" }, { - "plugin": "alerting", - "path": "x-pack/plugins/alerting/server/lib/wrap_search_source_client.ts" + "plugin": "discover", + "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" }, { "plugin": "securitySolution", @@ -23757,7 +23757,9 @@ "parentPluginId": "data", "id": "def-common.EqlSearchStrategyRequest.options", "type": "Object", - "tags": [], + "tags": [ + "deprecated" + ], "label": "options", "description": [], "signature": [ @@ -23765,8 +23767,14 @@ " | undefined" ], "path": "src/plugins/data/common/search/strategies/eql_search/types.ts", - "deprecated": false, - "trackAdoption": false + "deprecated": true, + "trackAdoption": false, + "references": [ + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/hooks/eql/api.ts" + } + ] } ], "initialIsOpen": false @@ -25326,6 +25334,24 @@ "path": "src/plugins/data/common/search/types.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "data", + "id": "def-common.ISearchOptions.transport", + "type": "Object", + "tags": [], + "label": "transport", + "description": [ + "\nTransportRequestOptions, other than `signal`, to pass through to the ES client.\nTo pass an abort signal, use {@link ISearchOptions.abortSignal}" + ], + "signature": [ + "Omit<", + "TransportRequestOptions", + ", \"signal\"> | undefined" + ], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -27953,7 +27979,7 @@ "label": "AggConfigOptions", "description": [], "signature": [ - "{ type: ", + "{ schema?: string | undefined; type: ", { "pluginId": "data", "scope": "common", @@ -27963,7 +27989,7 @@ }, "; params?: {} | ", "SerializableRecord", - " | undefined; id?: string | undefined; enabled?: boolean | undefined; schema?: string | undefined; }" + " | undefined; id?: string | undefined; enabled?: boolean | undefined; }" ], "path": "src/plugins/data/common/search/aggs/agg_config.ts", "deprecated": false, @@ -28815,7 +28841,7 @@ "label": "CreateAggConfigParams", "description": [], "signature": [ - "{ type: string | ", + "{ schema?: string | undefined; type: string | ", { "pluginId": "data", "scope": "common", @@ -28825,7 +28851,7 @@ }, "; params?: {} | ", "SerializableRecord", - " | undefined; id?: string | undefined; enabled?: boolean | undefined; schema?: string | undefined; }" + " | undefined; id?: string | undefined; enabled?: boolean | undefined; }" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, diff --git a/api_docs/data_search.mdx b/api_docs/data_search.mdx index 948da55a39f74..3c16e2d5fedae 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search'] --- import dataSearchObj from './data_search.devdocs.json'; @@ -21,7 +21,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 3144 | 34 | 2444 | 23 | +| 3132 | 33 | 2429 | 23 | ## Client diff --git a/api_docs/data_view_editor.mdx b/api_docs/data_view_editor.mdx index 95fa4182594f8..21f01d16fd2a4 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewEditor'] --- import dataViewEditorObj from './data_view_editor.devdocs.json'; diff --git a/api_docs/data_view_field_editor.devdocs.json b/api_docs/data_view_field_editor.devdocs.json index 7843f117d57e9..50c48bbe6aed2 100644 --- a/api_docs/data_view_field_editor.devdocs.json +++ b/api_docs/data_view_field_editor.devdocs.json @@ -26,7 +26,13 @@ "text": "FormatEditorProps" }, "

, ", - "FormatEditorState", + { + "pluginId": "dataViewFieldEditor", + "scope": "public", + "docId": "kibDataViewFieldEditorPluginApi", + "section": "def-public.FormatEditorState", + "text": "FormatEditorState" + }, " & S, any>" ], "path": "src/plugins/data_view_field_editor/public/components/field_format_editor/editors/default/default.tsx", @@ -52,7 +58,13 @@ "label": "state", "description": [], "signature": [ - "FormatEditorState", + { + "pluginId": "dataViewFieldEditor", + "scope": "public", + "docId": "kibDataViewFieldEditorPluginApi", + "section": "def-public.FormatEditorState", + "text": "FormatEditorState" + }, " & S" ], "path": "src/plugins/data_view_field_editor/public/components/field_format_editor/editors/default/default.tsx", @@ -76,9 +88,21 @@ "text": "FormatEditorProps" }, "<{}>, state: ", - "FormatEditorState", + { + "pluginId": "dataViewFieldEditor", + "scope": "public", + "docId": "kibDataViewFieldEditorPluginApi", + "section": "def-public.FormatEditorState", + "text": "FormatEditorState" + }, ") => { error: string | undefined; samples: ", - "Sample", + { + "pluginId": "dataViewFieldEditor", + "scope": "public", + "docId": "kibDataViewFieldEditorPluginApi", + "section": "def-public.Sample", + "text": "Sample" + }, "[]; }" ], "path": "src/plugins/data_view_field_editor/public/components/field_format_editor/editors/default/default.tsx", @@ -115,7 +139,13 @@ "label": "state", "description": [], "signature": [ - "FormatEditorState" + { + "pluginId": "dataViewFieldEditor", + "scope": "public", + "docId": "kibDataViewFieldEditorPluginApi", + "section": "def-public.FormatEditorState", + "text": "FormatEditorState" + } ], "path": "src/plugins/data_view_field_editor/public/components/field_format_editor/editors/default/default.tsx", "deprecated": false, @@ -175,6 +205,64 @@ } ], "initialIsOpen": false + }, + { + "parentPluginId": "dataViewFieldEditor", + "id": "def-public.DeleteCompositeSubfield", + "type": "Class", + "tags": [], + "label": "DeleteCompositeSubfield", + "description": [ + "\nError throw when there's an attempt to directly delete a composite subfield" + ], + "signature": [ + { + "pluginId": "dataViewFieldEditor", + "scope": "public", + "docId": "kibDataViewFieldEditorPluginApi", + "section": "def-public.DeleteCompositeSubfield", + "text": "DeleteCompositeSubfield" + }, + " extends Error" + ], + "path": "src/plugins/data_view_field_editor/public/open_delete_modal.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "dataViewFieldEditor", + "id": "def-public.DeleteCompositeSubfield.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/data_view_field_editor/public/open_delete_modal.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "dataViewFieldEditor", + "id": "def-public.DeleteCompositeSubfield.Unnamed.$1", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data_view_field_editor/public/open_delete_modal.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false } ], "functions": [], @@ -188,6 +276,23 @@ "description": [ "\nThe data model for the field editor" ], + "signature": [ + { + "pluginId": "dataViewFieldEditor", + "scope": "public", + "docId": "kibDataViewFieldEditorPluginApi", + "section": "def-public.Field", + "text": "Field" + }, + " extends ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeField", + "text": "RuntimeField" + } + ], "path": "src/plugins/data_view_field_editor/public/types.ts", "deprecated": false, "trackAdoption": false, @@ -207,44 +312,12 @@ }, { "parentPluginId": "dataViewFieldEditor", - "id": "def-public.Field.type", - "type": "CompoundType", - "tags": [], - "label": "type", - "description": [ - "\nES type" - ], - "signature": [ - "\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"geo_point\" | \"long\" | \"double\" | \"composite\"" - ], - "path": "src/plugins/data_view_field_editor/public/types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "dataViewFieldEditor", - "id": "def-public.Field.script", - "type": "Object", - "tags": [], - "label": "script", - "description": [ - "\nsource of the runtime field script" - ], - "signature": [ - "{ source: string; } | undefined" - ], - "path": "src/plugins/data_view_field_editor/public/types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "dataViewFieldEditor", - "id": "def-public.Field.customLabel", + "id": "def-public.Field.parentName", "type": "string", "tags": [], - "label": "customLabel", + "label": "parentName", "description": [ - "\ncustom label for display" + "\nName of parent field. Used for composite subfields" ], "signature": [ "string | undefined" @@ -252,47 +325,6 @@ "path": "src/plugins/data_view_field_editor/public/types.ts", "deprecated": false, "trackAdoption": false - }, - { - "parentPluginId": "dataViewFieldEditor", - "id": "def-public.Field.popularity", - "type": "number", - "tags": [], - "label": "popularity", - "description": [ - "\ncustom popularity" - ], - "signature": [ - "number | undefined" - ], - "path": "src/plugins/data_view_field_editor/public/types.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "dataViewFieldEditor", - "id": "def-public.Field.format", - "type": "Object", - "tags": [], - "label": "format", - "description": [ - "\nconfiguration of the field format" - ], - "signature": [ - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.SerializedFieldFormat", - "text": "SerializedFieldFormat" - }, - "<{}, ", - "SerializableRecord", - "> | undefined" - ], - "path": "src/plugins/data_view_field_editor/public/types.ts", - "deprecated": false, - "trackAdoption": false } ], "initialIsOpen": false @@ -433,13 +465,65 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "dataViewFieldEditor", + "id": "def-public.FormatEditorState", + "type": "Interface", + "tags": [], + "label": "FormatEditorState", + "description": [], + "path": "src/plugins/data_view_field_editor/public/components/field_format_editor/format_editor.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "dataViewFieldEditor", + "id": "def-public.FormatEditorState.EditorComponent", + "type": "CompoundType", + "tags": [], + "label": "EditorComponent", + "description": [], + "signature": [ + "React.LazyExoticComponent<", + { + "pluginId": "dataViewFieldEditor", + "scope": "public", + "docId": "kibDataViewFieldEditorPluginApi", + "section": "def-public.FieldFormatEditor", + "text": "FieldFormatEditor" + }, + "<{}>> | null" + ], + "path": "src/plugins/data_view_field_editor/public/components/field_format_editor/format_editor.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "dataViewFieldEditor", + "id": "def-public.FormatEditorState.fieldFormatId", + "type": "string", + "tags": [], + "label": "fieldFormatId", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data_view_field_editor/public/components/field_format_editor/format_editor.tsx", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "dataViewFieldEditor", "id": "def-public.OpenFieldDeleteModalOptions", "type": "Interface", "tags": [], "label": "OpenFieldDeleteModalOptions", - "description": [], + "description": [ + "\nOptions for opening the field editor" + ], "path": "src/plugins/data_view_field_editor/public/open_delete_modal.tsx", "deprecated": false, "trackAdoption": false, @@ -450,7 +534,9 @@ "type": "Object", "tags": [], "label": "ctx", - "description": [], + "description": [ + "\nConfig for the delete modal" + ], "signature": [ "{ dataView: ", { @@ -472,7 +558,9 @@ "type": "Function", "tags": [], "label": "onDelete", - "description": [], + "description": [ + "\nCallback fired when fields are deleted" + ], "signature": [ "((fieldNames: string[]) => void) | undefined" ], @@ -486,7 +574,9 @@ "type": "Array", "tags": [], "label": "fieldNames", - "description": [], + "description": [ + "- the names of the deleted fields" + ], "signature": [ "string[]" ], @@ -504,7 +594,9 @@ "type": "CompoundType", "tags": [], "label": "fieldName", - "description": [], + "description": [ + "\nNames of the fields to be deleted" + ], "signature": [ "string | string[]" ], @@ -570,7 +662,7 @@ "section": "def-common.DataViewField", "text": "DataViewField" }, - ") => void) | undefined" + "[]) => void) | undefined" ], "path": "src/plugins/data_view_field_editor/public/open_editor.tsx", "deprecated": false, @@ -579,10 +671,12 @@ { "parentPluginId": "dataViewFieldEditor", "id": "def-public.OpenFieldEditorOptions.onSave.$1", - "type": "Object", + "type": "Array", "tags": [], "label": "field", - "description": [], + "description": [ + "- the fields that were saved" + ], "signature": [ { "pluginId": "dataViews", @@ -590,7 +684,8 @@ "docId": "kibDataViewsPluginApi", "section": "def-common.DataViewField", "text": "DataViewField" - } + }, + "[]" ], "path": "src/plugins/data_view_field_editor/public/open_editor.tsx", "deprecated": false, @@ -641,6 +736,149 @@ } ], "initialIsOpen": false + }, + { + "parentPluginId": "dataViewFieldEditor", + "id": "def-public.Props", + "type": "Interface", + "tags": [], + "label": "Props", + "description": [], + "path": "src/plugins/data_view_field_editor/public/components/delete_field_provider.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "dataViewFieldEditor", + "id": "def-public.Props.children", + "type": "Function", + "tags": [], + "label": "children", + "description": [], + "signature": [ + "(deleteFieldHandler: DeleteFieldFunc) => React.ReactNode" + ], + "path": "src/plugins/data_view_field_editor/public/components/delete_field_provider.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "dataViewFieldEditor", + "id": "def-public.Props.children.$1", + "type": "Function", + "tags": [], + "label": "deleteFieldHandler", + "description": [], + "signature": [ + "DeleteFieldFunc" + ], + "path": "src/plugins/data_view_field_editor/public/components/delete_field_provider.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "dataViewFieldEditor", + "id": "def-public.Props.dataView", + "type": "Object", + "tags": [], + "label": "dataView", + "description": [ + "\nData view of fields to be deleted" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + } + ], + "path": "src/plugins/data_view_field_editor/public/components/delete_field_provider.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "dataViewFieldEditor", + "id": "def-public.Props.onDelete", + "type": "Function", + "tags": [], + "label": "onDelete", + "description": [ + "\nCallback fired when fields are deleted" + ], + "signature": [ + "((fieldNames: string[]) => void) | undefined" + ], + "path": "src/plugins/data_view_field_editor/public/components/delete_field_provider.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "dataViewFieldEditor", + "id": "def-public.Props.onDelete.$1", + "type": "Array", + "tags": [], + "label": "fieldNames", + "description": [ + "- the names of the deleted fields" + ], + "signature": [ + "string[]" + ], + "path": "src/plugins/data_view_field_editor/public/components/delete_field_provider.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "dataViewFieldEditor", + "id": "def-public.Sample", + "type": "Interface", + "tags": [], + "label": "Sample", + "description": [], + "path": "src/plugins/data_view_field_editor/public/components/field_format_editor/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "dataViewFieldEditor", + "id": "def-public.Sample.input", + "type": "CompoundType", + "tags": [], + "label": "input", + "description": [], + "signature": [ + "object | React.ReactText | React.ReactText[] | Record" + ], + "path": "src/plugins/data_view_field_editor/public/components/field_format_editor/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "dataViewFieldEditor", + "id": "def-public.Sample.output", + "type": "string", + "tags": [], + "label": "output", + "description": [], + "path": "src/plugins/data_view_field_editor/public/components/field_format_editor/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false } ], "enums": [], @@ -758,7 +996,7 @@ "tags": [], "label": "openEditor", "description": [ - "\nmethod to open the data view field editor fly-out" + "\nMethod to open the data view field editor fly-out" ], "signature": [ "(options: ", @@ -805,7 +1043,9 @@ "type": "Function", "tags": [], "label": "openDeleteModal", - "description": [], + "description": [ + "\nMethod to open the data view field delete fly-out" + ], "signature": [ "(options: ", { @@ -827,7 +1067,9 @@ "type": "Object", "tags": [], "label": "options", - "description": [], + "description": [ + "Configuration options for the fly-out" + ], "signature": [ { "pluginId": "dataViewFieldEditor", @@ -881,7 +1123,9 @@ "type": "Object", "tags": [], "label": "userPermissions", - "description": [], + "description": [ + "\nConvenience method for user permissions checks" + ], "signature": [ "{ editIndexPattern: () => boolean; }" ], @@ -895,10 +1139,18 @@ "type": "Function", "tags": [], "label": "DeleteRuntimeFieldProvider", - "description": [], + "description": [ + "\nContext provider for delete runtime field modal" + ], "signature": [ "React.FunctionComponent<", - "Props", + { + "pluginId": "dataViewFieldEditor", + "scope": "public", + "docId": "kibDataViewFieldEditorPluginApi", + "section": "def-public.Props", + "text": "Props" + }, ">" ], "path": "src/plugins/data_view_field_editor/public/types.ts", diff --git a/api_docs/data_view_field_editor.mdx b/api_docs/data_view_field_editor.mdx index 19de55351a8de..cbfd433f1a095 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewFieldEditor'] --- import dataViewFieldEditorObj from './data_view_field_editor.devdocs.json'; @@ -21,7 +21,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 49 | 0 | 29 | 3 | +| 60 | 0 | 30 | 0 | ## Client diff --git a/api_docs/data_view_management.mdx b/api_docs/data_view_management.mdx index b1851139b7d9e..b47e57d899dc9 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: 2022-09-09 +date: 2022-09-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 389500b91049c..0ba596a1b00b6 100644 --- a/api_docs/data_views.devdocs.json +++ b/api_docs/data_views.devdocs.json @@ -1705,7 +1705,7 @@ "section": "def-common.RuntimeFieldSpec", "text": "RuntimeFieldSpec" }, - " | undefined; fixedInterval?: string[] | undefined; timeZone?: string[] | undefined; timeSeriesDimension?: boolean | undefined; timeSeriesMetric?: \"gauge\" | \"histogram\" | \"summary\" | \"counter\" | undefined; shortDotsEnable?: boolean | undefined; isMapped?: boolean | undefined; }" + " | undefined; fixedInterval?: string[] | undefined; timeZone?: string[] | undefined; timeSeriesDimension?: boolean | undefined; timeSeriesMetric?: \"gauge\" | \"histogram\" | \"summary\" | \"counter\" | undefined; shortDotsEnable?: boolean | undefined; isMapped?: boolean | undefined; parentName?: string | undefined; }" ], "path": "src/plugins/data_views/common/fields/data_view_field.ts", "deprecated": false, @@ -5936,6 +5936,70 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "dataViews", + "id": "def-public.RuntimeField", + "type": "Interface", + "tags": [], + "label": "RuntimeField", + "description": [ + "\nThis is the RuntimeField interface enhanced with Data view field\nconfiguration: field format definition, customLabel or popularity." + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeField", + "text": "RuntimeField" + }, + " extends ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeFieldBase", + "text": "RuntimeFieldBase" + }, + ",", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.FieldConfiguration", + "text": "FieldConfiguration" + } + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-public.RuntimeField.fields", + "type": "Object", + "tags": [], + "label": "fields", + "description": [ + "\nSubfields of composite field" + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeFieldSubFields", + "text": "RuntimeFieldSubFields" + }, + " | undefined" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "dataViews", "id": "def-public.SavedObjectsClientCommon", @@ -6454,7 +6518,7 @@ "section": "def-common.RuntimeFieldSpec", "text": "RuntimeFieldSpec" }, - " | undefined; fixedInterval?: string[] | undefined; timeZone?: string[] | undefined; timeSeriesDimension?: boolean | undefined; timeSeriesMetric?: \"gauge\" | \"histogram\" | \"summary\" | \"counter\" | undefined; shortDotsEnable?: boolean | undefined; isMapped?: boolean | undefined; }" + " | undefined; fixedInterval?: string[] | undefined; timeZone?: string[] | undefined; timeSeriesDimension?: boolean | undefined; timeSeriesMetric?: \"gauge\" | \"histogram\" | \"summary\" | \"counter\" | undefined; shortDotsEnable?: boolean | undefined; isMapped?: boolean | undefined; parentName?: string | undefined; }" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false, @@ -6536,7 +6600,7 @@ "tags": [], "label": "RuntimeType", "description": [ - "\nRuntime field - type of value returned" + "\nRuntime field types" ], "signature": [ "\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"geo_point\" | \"long\" | \"double\" | \"composite\"" @@ -10667,7 +10731,9 @@ "\nA record of capabilities (aggregations) for an index rollup job" ], "signature": [ - "[index: string]: { aggs?: _.Dictionary<", + "[index: string]: { aggs?: ", + "Dictionary", + "<", { "pluginId": "dataViews", "scope": "common", @@ -11114,7 +11180,7 @@ "section": "def-common.RuntimeFieldSpec", "text": "RuntimeFieldSpec" }, - " | undefined; fixedInterval?: string[] | undefined; timeZone?: string[] | undefined; timeSeriesDimension?: boolean | undefined; timeSeriesMetric?: \"gauge\" | \"histogram\" | \"summary\" | \"counter\" | undefined; shortDotsEnable?: boolean | undefined; isMapped?: boolean | undefined; }" + " | undefined; fixedInterval?: string[] | undefined; timeZone?: string[] | undefined; timeSeriesDimension?: boolean | undefined; timeSeriesMetric?: \"gauge\" | \"histogram\" | \"summary\" | \"counter\" | undefined; shortDotsEnable?: boolean | undefined; isMapped?: boolean | undefined; parentName?: string | undefined; }" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false, @@ -11414,7 +11480,7 @@ "label": "elasticsearchClient", "description": [], "signature": [ - "{ get: { (this: That, params: ", + "{ name: string | symbol; get: { (this: That, params: ", "GetRequest", " | ", "GetRequest", @@ -11532,7 +11598,7 @@ "default", "; security: ", "default", - "; name: string | symbol; index: { (this: That, params: ", + "; index: { (this: That, params: ", "IndexRequest", " | ", "IndexRequest", @@ -14365,7 +14431,7 @@ "section": "def-common.RuntimeFieldSpec", "text": "RuntimeFieldSpec" }, - " | undefined; fixedInterval?: string[] | undefined; timeZone?: string[] | undefined; timeSeriesDimension?: boolean | undefined; timeSeriesMetric?: \"gauge\" | \"histogram\" | \"summary\" | \"counter\" | undefined; shortDotsEnable?: boolean | undefined; isMapped?: boolean | undefined; }" + " | undefined; fixedInterval?: string[] | undefined; timeZone?: string[] | undefined; timeSeriesDimension?: boolean | undefined; timeSeriesMetric?: \"gauge\" | \"histogram\" | \"summary\" | \"counter\" | undefined; shortDotsEnable?: boolean | undefined; isMapped?: boolean | undefined; parentName?: string | undefined; }" ], "path": "src/plugins/data_views/common/fields/data_view_field.ts", "deprecated": false, @@ -19607,15 +19673,14 @@ "\nSubfields of composite field" ], "signature": [ - "Record | undefined" + " | undefined" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false, @@ -19660,9 +19725,7 @@ "type": "CompoundType", "tags": [], "label": "type", - "description": [ - "\nType of runtime field, can only be primitive type" - ], + "description": [], "signature": [ "\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"geo_point\" | \"long\" | \"double\"" ], @@ -19768,7 +19831,7 @@ "tags": [], "label": "attributes", "description": [ - "{@inheritdoc SavedObjectAttributes}" + "The data for a Saved Object is stored as an object in the `attributes` property." ], "signature": [ "T" @@ -20695,7 +20758,7 @@ "label": "DataViewSavedObjectAttrs", "description": [], "signature": [ - "{ type?: string | undefined; title: string; name?: string | undefined; typeMeta?: string | undefined; }" + "{ name?: string | undefined; type?: string | undefined; title: string; typeMeta?: string | undefined; }" ], "path": "src/plugins/data_views/common/data_views/data_views.ts", "deprecated": false, @@ -21094,7 +21157,7 @@ "section": "def-common.RuntimeFieldSpec", "text": "RuntimeFieldSpec" }, - " | undefined; fixedInterval?: string[] | undefined; timeZone?: string[] | undefined; timeSeriesDimension?: boolean | undefined; timeSeriesMetric?: \"gauge\" | \"histogram\" | \"summary\" | \"counter\" | undefined; shortDotsEnable?: boolean | undefined; isMapped?: boolean | undefined; }" + " | undefined; fixedInterval?: string[] | undefined; timeZone?: string[] | undefined; timeSeriesDimension?: boolean | undefined; timeSeriesMetric?: \"gauge\" | \"histogram\" | \"summary\" | \"counter\" | undefined; shortDotsEnable?: boolean | undefined; isMapped?: boolean | undefined; parentName?: string | undefined; }" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false, @@ -21336,8 +21399,8 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.RuntimeTypeExceptComposite", - "text": "RuntimeTypeExceptComposite" + "section": "def-common.RuntimePrimitiveTypes", + "text": "RuntimePrimitiveTypes" }, "; }> | undefined; }" ], @@ -21348,15 +21411,38 @@ }, { "parentPluginId": "dataViews", - "id": "def-common.RuntimeType", + "id": "def-common.RuntimeFieldSubFields", "type": "Type", "tags": [], - "label": "RuntimeType", + "label": "RuntimeFieldSubFields", + "description": [], + "signature": [ + "{ [x: string]: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.RuntimeFieldSubField", + "text": "RuntimeFieldSubField" + }, + "; }" + ], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.RuntimePrimitiveTypes", + "type": "Type", + "tags": [], + "label": "RuntimePrimitiveTypes", "description": [ - "\nRuntime field - type of value returned" + "\nRuntime field primitive types - excluding composite" ], "signature": [ - "\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"geo_point\" | \"long\" | \"double\" | \"composite\"" + "\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"geo_point\" | \"long\" | \"double\"" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false, @@ -21365,15 +21451,15 @@ }, { "parentPluginId": "dataViews", - "id": "def-common.RuntimeTypeExceptComposite", + "id": "def-common.RuntimeType", "type": "Type", "tags": [], - "label": "RuntimeTypeExceptComposite", + "label": "RuntimeType", "description": [ - "\nPrimitive runtime field types" + "\nRuntime field types" ], "signature": [ - "\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"geo_point\" | \"long\" | \"double\"" + "\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"geo_point\" | \"long\" | \"double\" | \"composite\"" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false, diff --git a/api_docs/data_views.mdx b/api_docs/data_views.mdx index 892d584ba199e..cea8ef1557292 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews'] --- import dataViewsObj from './data_views.devdocs.json'; @@ -21,7 +21,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 963 | 0 | 206 | 1 | +| 966 | 0 | 208 | 1 | ## Client diff --git a/api_docs/data_visualizer.mdx b/api_docs/data_visualizer.mdx index 2dd8caad2c655..e415597a7fcb6 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: 2022-09-09 +date: 2022-09-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 df2ac0366eadf..2ca8394737f06 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana'] --- @@ -19,18 +19,21 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | visTypeGauge | - | | | visTypePie | - | | | visTypePie | - | -| | discover, alerting, securitySolution | - | +| | alerting, discover, securitySolution | - | +| | stackAlerts, alerting, securitySolution, inputControlVis | - | +| | alerting, discover, securitySolution | - | +| | stackAlerts, alerting, securitySolution, inputControlVis | - | +| | actions, alerting | - | +| | actions, alerting, canvas, enterpriseSearch, securitySolution, taskManager, dashboard, savedSearch, visualizations, ml, savedObjects, embeddable, fleet, infra, graph, @kbn/core-saved-objects-server-internal | - | +| | actions, alerting, canvas, enterpriseSearch, securitySolution, taskManager, dashboard, savedSearch, visualizations, ml, savedObjects, embeddable, fleet, infra, graph, @kbn/core-saved-objects-server-internal | - | | | discover, dashboard, maps, monitoring | - | | | unifiedSearch, discover, maps, infra, graph, securitySolution, stackAlerts, inputControlVis, savedObjects | - | -| | discover, alerting, securitySolution | - | | | data, discover, embeddable | - | | | advancedSettings, discover | - | | | advancedSettings, discover | - | -| | stackAlerts, alerting, securitySolution, inputControlVis | - | -| | stackAlerts, alerting, securitySolution, inputControlVis | - | -| | actions, alerting | - | +| | securitySolution | - | | | encryptedSavedObjects, actions, data, cloud, ml, logstash, securitySolution | - | -| | dashboard, stackAlerts, expressionPartitionVis | - | +| | dashboard, dataVisualizer, stackAlerts, expressionPartitionVis | - | | | dashboard | - | | | dataViews, maps | - | | | dataViews, maps | - | @@ -40,14 +43,14 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | visTypeTimeseries, graph, dataViewManagement, dataViews | - | | | visTypeTimeseries, graph, dataViewManagement, dataViews | - | | | visTypeTimeseries, graph, dataViewManagement | - | +| | lens, observability, dataVisualizer, fleet, cloudSecurityPosture, discoverEnhanced, osquery, synthetics | - | | | dataViewManagement, dataViews | - | | | dataViews, dataViewManagement | - | | | dataViewManagement, dataViews | - | | | dataViews, dataViewManagement | - | | | dataViewManagement | - | | | dataViewManagement | - | -| | lens, observability, dataVisualizer, fleet, cloudSecurityPosture, discoverEnhanced, osquery, synthetics | - | -| | esUiShared, home, data, spaces, savedObjectsManagement, fleet, observability, ml, apm, indexLifecycleManagement, synthetics, upgradeAssistant, ux, kibanaOverview | - | +| | home, data, esUiShared, spaces, savedObjectsManagement, fleet, observability, ml, apm, indexLifecycleManagement, synthetics, upgradeAssistant, ux, kibanaOverview | - | | | spaces, ml, canvas, osquery | - | | | canvas | - | | | canvas | - | @@ -64,9 +67,9 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | actions, ml, savedObjectsTagging, enterpriseSearch | - | | | enterpriseSearch | - | | | console, @kbn/core-elasticsearch-server-internal | - | -| | embeddable, discover, presentationUtil, dashboard, graph | 8.8.0 | | | spaces, security, alerting | 8.8.0 | | | spaces, security, actions, alerting, ml, remoteClusters, graph, indexLifecycleManagement, mapsEms, painlessLab, rollup, searchprofiler, snapshotRestore, transform, upgradeAssistant | 8.8.0 | +| | embeddable, discover, presentationUtil, dashboard, graph | 8.8.0 | | | apm, security, securitySolution | 8.8.0 | | | apm, security, securitySolution | 8.8.0 | | | visualizations, dashboard, lens, maps, ml, securitySolution, security, @kbn/core-application-browser-internal, @kbn/core-application-browser-mocks | 8.8.0 | @@ -74,7 +77,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] | | savedObjectsTaggingOss, dashboard | 8.8.0 | | | dashboard | 8.8.0 | | | maps, dashboard, @kbn/core-saved-objects-migration-server-internal | 8.8.0 | -| | monitoring, kibanaUsageCollection, @kbn/core-metrics-server-internal, @kbn/core-usage-data-server-internal | 8.8.0 | +| | monitoring, kibanaUsageCollection, @kbn/core-apps-browser-internal, @kbn/core-metrics-server-internal, @kbn/core-status-server-internal, @kbn/core-usage-data-server-internal | 8.8.0 | | | security, fleet | 8.8.0 | | | security, fleet | 8.8.0 | | | security, fleet | 8.8.0 | @@ -147,6 +150,7 @@ Safe to remove. | | @kbn/core-injected-metadata-browser | | | @kbn/core-injected-metadata-browser | | | @kbn/core-metrics-server | +| | @kbn/core-saved-objects-common | | | @kbn/core-saved-objects-common | | | @kbn/core-saved-objects-server | | | @kbn/core-ui-settings-common | \ No newline at end of file diff --git a/api_docs/deprecations_by_plugin.mdx b/api_docs/deprecations_by_plugin.mdx index 600739e4a9fde..2d9fa24ea5276 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana'] --- @@ -31,6 +31,14 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana'] +## @kbn/core-apps-browser-internal + +| Deprecated API | Reference location(s) | Remove By | +| ---------------|-----------|-----------| +| | [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.test.ts#:~:text=process) | 8.8.0 | + + + ## @kbn/core-elasticsearch-server-internal | Deprecated API | Reference location(s) | Remove By | @@ -70,6 +78,23 @@ so TS and code-reference navigation might not highlight them. | +## @kbn/core-saved-objects-server-internal + +| Deprecated API | Reference location(s) | Remove By | +| ---------------|-----------|-----------| +| | [collect_references_deep.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-server-internal/src/routes/legacy_import_export/lib/collect_references_deep.test.ts#:~:text=SavedObjectAttributes), [collect_references_deep.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-server-internal/src/routes/legacy_import_export/lib/collect_references_deep.test.ts#:~:text=SavedObjectAttributes) | - | +| | [collect_references_deep.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-server-internal/src/routes/legacy_import_export/lib/collect_references_deep.test.ts#:~:text=SavedObjectAttributes), [collect_references_deep.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-server-internal/src/routes/legacy_import_export/lib/collect_references_deep.test.ts#:~:text=SavedObjectAttributes) | - | + + + +## @kbn/core-status-server-internal + +| Deprecated API | Reference location(s) | Remove By | +| ---------------|-----------|-----------| +| | [status.ts](https://github.com/elastic/kibana/tree/main/packages/core/status/core-status-server-internal/src/routes/status.ts#:~:text=process), [status.ts](https://github.com/elastic/kibana/tree/main/packages/core/status/core-status-server-internal/src/routes/status.ts#:~:text=process) | 8.8.0 | + + + ## @kbn/core-usage-data-server-internal | Deprecated API | Reference location(s) | Remove By | @@ -86,6 +111,8 @@ so TS and code-reference navigation might not highlight them. | | | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/plugin.ts#:~:text=authc) | - | | | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/plugin.ts#:~:text=authz) | - | | | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/plugin.ts#:~:text=index), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/plugin.ts#:~:text=index) | - | +| | [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/types.ts#:~:text=SavedObjectAttributes)+ 3 more | - | +| | [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/types.ts#:~:text=SavedObjectAttributes)+ 3 more | - | @@ -109,6 +136,8 @@ so TS and code-reference navigation might not highlight them. | | | [plugin.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/plugin.test.ts#:~:text=getKibanaFeatures) | 8.8.0 | | | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/plugin.ts#:~:text=license%24), [license_state.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/lib/license_state.test.ts#:~:text=license%24), [license_state.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/lib/license_state.test.ts#:~:text=license%24) | 8.8.0 | | | [task.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/usage/task.ts#:~:text=index) | - | +| | [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/saved_objects/geo_containment/migrations.ts#:~:text=SavedObjectAttributes), [migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/saved_objects/geo_containment/migrations.ts#:~:text=SavedObjectAttributes), [migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/saved_objects/migrations.ts#:~:text=SavedObjectAttributes), [migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/saved_objects/migrations.ts#:~:text=SavedObjectAttributes)+ 10 more | - | +| | [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/saved_objects/geo_containment/migrations.ts#:~:text=SavedObjectAttributes), [migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/saved_objects/geo_containment/migrations.ts#:~:text=SavedObjectAttributes), [migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/saved_objects/migrations.ts#:~:text=SavedObjectAttributes), [migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/saved_objects/migrations.ts#:~:text=SavedObjectAttributes)+ 10 more | - | @@ -139,6 +168,8 @@ so TS and code-reference navigation might not highlight them. | | | [setup_expressions.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/setup_expressions.ts#:~:text=getTypes), [application.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/application.tsx#:~:text=getTypes), [functions.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/server/routes/functions/functions.ts#:~:text=getTypes) | - | | | [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/canvas_plugin_src/functions/server/demodata/index.ts#:~:text=context), [embeddable.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/canvas_plugin_src/functions/external/embeddable.ts#:~:text=context), [esdocs.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/esdocs.ts#:~:text=context), [escount.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/escount.ts#:~:text=context), [filters.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/common/functions/filters.ts#:~:text=context), [neq.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/canvas_plugin_src/functions/common/neq.ts#:~:text=context), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/canvas_plugin_src/functions/server/pointseries/index.ts#:~:text=context) | - | | | [home.component.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/home/home.component.tsx#:~:text=KibanaPageTemplate), [home.component.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/home/home.component.tsx#:~:text=KibanaPageTemplate), [home.component.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/home/home.component.tsx#:~:text=KibanaPageTemplate) | - | +| | [find.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/server/routes/custom_elements/find.ts#:~:text=SavedObjectAttributes), [find.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/server/routes/custom_elements/find.ts#:~:text=SavedObjectAttributes), [find.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/server/routes/workpad/find.ts#:~:text=SavedObjectAttributes), [find.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/server/routes/workpad/find.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/shareable_runtime/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/shareable_runtime/types.ts#:~:text=SavedObjectAttributes) | - | +| | [find.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/server/routes/custom_elements/find.ts#:~:text=SavedObjectAttributes), [find.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/server/routes/custom_elements/find.ts#:~:text=SavedObjectAttributes), [find.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/server/routes/workpad/find.ts#:~:text=SavedObjectAttributes), [find.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/server/routes/workpad/find.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/shareable_runtime/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/shareable_runtime/types.ts#:~:text=SavedObjectAttributes) | - | @@ -179,13 +210,15 @@ so TS and code-reference navigation might not highlight them. | | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [sync_dashboard_filter_state.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts#:~:text=syncQueryStateWithUrl), [sync_dashboard_filter_state.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts#:~:text=syncQueryStateWithUrl), [dashboard_listing.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/listing/dashboard_listing.tsx#:~:text=syncQueryStateWithUrl), [dashboard_listing.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/listing/dashboard_listing.tsx#:~:text=syncQueryStateWithUrl) | - | -| | [export_csv_action.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/actions/export_csv_action.tsx#:~:text=fieldFormats) | - | -| | [kibana_react.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/kibana_react.ts#:~:text=ExitFullScreenButton), [plugin.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/plugin.tsx#:~:text=ExitFullScreenButton), [plugin.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/plugin.tsx#:~:text=ExitFullScreenButton), [plugin.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/plugin.tsx#:~:text=ExitFullScreenButton) | - | -| | [saved_objects.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/saved_objects.ts#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/top_nav/save_modal.tsx#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/top_nav/save_modal.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 | -| | [saved_object_loader.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/saved_object_loader.ts#:~:text=SavedObject), [saved_object_loader.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/saved_object_loader.ts#:~:text=SavedObject), [saved_object_loader.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/saved_object_loader.ts#:~:text=SavedObject), [saved_objects.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/saved_objects.ts#:~:text=SavedObject), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=SavedObject), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=SavedObject), [dashboard_tagging.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/lib/dashboard_tagging.ts#:~:text=SavedObject), [dashboard_tagging.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/lib/dashboard_tagging.ts#:~:text=SavedObject), [clone_panel_action.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/actions/clone_panel_action.tsx#:~:text=SavedObject), [clone_panel_action.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/actions/clone_panel_action.tsx#:~:text=SavedObject)+ 1 more | 8.8.0 | +| | [sync_dashboard_filter_state.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts#:~:text=syncQueryStateWithUrl), [sync_dashboard_filter_state.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts#:~:text=syncQueryStateWithUrl) | - | +| | [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/data/types.ts#:~:text=fieldFormats), [data_service.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/data/data_service.ts#:~:text=fieldFormats) | - | +| | [dashboard_viewport.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/embeddable/viewport/dashboard_viewport.tsx#:~:text=ExitFullScreenButton), [dashboard_viewport.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/embeddable/viewport/dashboard_viewport.tsx#:~:text=ExitFullScreenButton), [dashboard_viewport.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/embeddable/viewport/dashboard_viewport.tsx#:~:text=ExitFullScreenButton) | - | +| | [save_modal.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/top_nav/save_modal.tsx#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/top_nav/save_modal.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 | +| | [saved_object_loader.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/saved_object_loader.ts#:~:text=SavedObject), [saved_object_loader.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/saved_object_loader.ts#:~:text=SavedObject), [saved_object_loader.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/saved_object_loader.ts#:~:text=SavedObject), [clone_panel_action.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/actions/clone_panel_action.tsx#:~:text=SavedObject), [clone_panel_action.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/actions/clone_panel_action.tsx#:~:text=SavedObject), [clone_panel_action.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/actions/clone_panel_action.tsx#:~:text=SavedObject), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=SavedObject), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=SavedObject), [dashboard_tagging.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/lib/dashboard_tagging.ts#:~:text=SavedObject), [dashboard_tagging.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/lib/dashboard_tagging.ts#:~:text=SavedObject) | 8.8.0 | | | [saved_dashboard.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=SavedObjectClass) | 8.8.0 | -| | [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/types.ts#:~:text=onAppLeave), [dashboard_router.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/dashboard_router.tsx#:~:text=onAppLeave), [plugin.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/plugin.tsx#:~:text=onAppLeave) | 8.8.0 | +| | [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/types.ts#:~:text=onAppLeave), [plugin.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/plugin.tsx#:~:text=onAppLeave) | 8.8.0 | +| | [dashboard_migrations.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/saved_objects/dashboard_migrations.ts#:~:text=SavedObjectAttributes), [dashboard_migrations.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/saved_objects/dashboard_migrations.ts#:~:text=SavedObjectAttributes), [dashboard_telemetry_collection_task.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/dashboard_telemetry_collection_task.ts#:~:text=SavedObjectAttributes), [dashboard_telemetry_collection_task.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/dashboard_telemetry_collection_task.ts#:~:text=SavedObjectAttributes), [dashboard_telemetry.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/dashboard_telemetry.ts#:~:text=SavedObjectAttributes), [dashboard_telemetry.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/dashboard_telemetry.ts#:~:text=SavedObjectAttributes), [find_by_value_embeddables.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/find_by_value_embeddables.ts#:~:text=SavedObjectAttributes), [find_by_value_embeddables.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/find_by_value_embeddables.ts#:~:text=SavedObjectAttributes), [saved_dashboard_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/common/saved_dashboard_references.ts#:~:text=SavedObjectAttributes), [saved_dashboard_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/common/saved_dashboard_references.ts#:~:text=SavedObjectAttributes)+ 8 more | - | +| | [dashboard_migrations.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/saved_objects/dashboard_migrations.ts#:~:text=SavedObjectAttributes), [dashboard_migrations.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/saved_objects/dashboard_migrations.ts#:~:text=SavedObjectAttributes), [dashboard_telemetry_collection_task.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/dashboard_telemetry_collection_task.ts#:~:text=SavedObjectAttributes), [dashboard_telemetry_collection_task.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/dashboard_telemetry_collection_task.ts#:~:text=SavedObjectAttributes), [dashboard_telemetry.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/dashboard_telemetry.ts#:~:text=SavedObjectAttributes), [dashboard_telemetry.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/dashboard_telemetry.ts#:~:text=SavedObjectAttributes), [find_by_value_embeddables.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/find_by_value_embeddables.ts#:~:text=SavedObjectAttributes), [find_by_value_embeddables.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/find_by_value_embeddables.ts#:~:text=SavedObjectAttributes), [saved_dashboard_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/common/saved_dashboard_references.ts#:~:text=SavedObjectAttributes), [saved_dashboard_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/common/saved_dashboard_references.ts#:~:text=SavedObjectAttributes)+ 8 more | - | | | [migrations_730.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/saved_objects/migrations_730.ts#:~:text=warning), [migrations_730.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/saved_objects/migrations_730.ts#:~:text=warning) | 8.8.0 | @@ -235,6 +268,7 @@ so TS and code-reference navigation might not highlight them. | | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| +| | [top_values.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/data_visualizer/public/application/common/components/top_values/top_values.tsx#:~:text=fieldFormats) | - | | | [results_links.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx#:~:text=indexPatternId), [actions_panel.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/actions_panel/actions_panel.tsx#:~:text=indexPatternId) | - | @@ -268,6 +302,8 @@ so TS and code-reference navigation might not highlight them. | | ---------------|-----------|-----------| | | [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=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) | - | +| | [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) | - | @@ -285,6 +321,8 @@ so TS and code-reference navigation might not highlight them. | | ---------------|-----------|-----------| | | [account_settings.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/account_settings/account_settings.tsx#:~:text=uiApi), [account_settings.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/account_settings/account_settings.tsx#:~:text=uiApi), [account_settings.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/account_settings/account_settings.tsx#:~:text=uiApi), [account_settings.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/account_settings/account_settings.tsx#:~:text=uiApi) | - | | | [check_access.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/lib/check_access.ts#:~:text=authz), [check_access.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/lib/check_access.ts#:~:text=authz), [check_access.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/lib/check_access.ts#:~:text=authz) | - | +| | [telemetry.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/collectors/lib/telemetry.ts#:~:text=SavedObjectAttributes), [telemetry.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/collectors/lib/telemetry.ts#:~:text=SavedObjectAttributes), [telemetry.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/collectors/lib/telemetry.ts#:~:text=SavedObjectAttributes) | - | +| | [telemetry.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/collectors/lib/telemetry.ts#:~:text=SavedObjectAttributes), [telemetry.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/collectors/lib/telemetry.ts#:~:text=SavedObjectAttributes), [telemetry.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/collectors/lib/telemetry.ts#:~:text=SavedObjectAttributes) | - | @@ -314,6 +352,8 @@ so TS and code-reference navigation might not highlight them. | | | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | 8.8.0 | | | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | 8.8.0 | | | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/integrations/index.tsx#:~:text=appBasePath) | 8.8.0 | +| | [epm.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/epm.ts#:~:text=SavedObjectAttributes), [epm.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/epm.ts#:~:text=SavedObjectAttributes), [settings.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/settings.ts#:~:text=SavedObjectAttributes), [settings.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/settings.ts#:~:text=SavedObjectAttributes) | - | +| | [epm.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/epm.ts#:~:text=SavedObjectAttributes), [epm.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/epm.ts#:~:text=SavedObjectAttributes), [settings.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/settings.ts#:~:text=SavedObjectAttributes), [settings.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/settings.ts#:~:text=SavedObjectAttributes) | - | @@ -327,6 +367,8 @@ so TS and code-reference navigation might not highlight them. | | | [deserialize.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/services/persistence/deserialize.ts#:~:text=getNonScriptedFields), [datasource.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/state_management/datasource.test.ts#:~:text=getNonScriptedFields), [deserialize.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/services/persistence/deserialize.test.ts#:~:text=getNonScriptedFields), [deserialize.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/services/persistence/deserialize.test.ts#:~:text=getNonScriptedFields) | - | | | [save_modal.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/components/save_modal.tsx#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/components/save_modal.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 | | | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/server/plugin.ts#:~:text=license%24) | 8.8.0 | +| | [saved_workspace_references.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/services/persistence/saved_workspace_references.ts#:~:text=SavedObjectAttributes), [saved_workspace_references.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/services/persistence/saved_workspace_references.ts#:~:text=SavedObjectAttributes), [saved_workspace_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/helpers/saved_workspace_utils.ts#:~:text=SavedObjectAttributes), [saved_workspace_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/helpers/saved_workspace_utils.ts#:~:text=SavedObjectAttributes) | - | +| | [saved_workspace_references.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/services/persistence/saved_workspace_references.ts#:~:text=SavedObjectAttributes), [saved_workspace_references.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/services/persistence/saved_workspace_references.ts#:~:text=SavedObjectAttributes), [saved_workspace_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/helpers/saved_workspace_utils.ts#:~:text=SavedObjectAttributes), [saved_workspace_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/helpers/saved_workspace_utils.ts#:~:text=SavedObjectAttributes) | - | @@ -352,6 +394,8 @@ so TS and code-reference navigation might not highlight them. | | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| | | [use_kibana_index_patterns.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_kibana_index_patterns.ts#:~:text=indexPatterns) | - | +| | [use_find_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_find_saved_object.tsx#:~:text=SavedObjectAttributes), [use_find_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_find_saved_object.tsx#:~:text=SavedObjectAttributes), [use_create_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_create_saved_object.tsx#:~:text=SavedObjectAttributes), [use_create_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_create_saved_object.tsx#:~:text=SavedObjectAttributes), [use_create_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_create_saved_object.tsx#:~:text=SavedObjectAttributes), [use_get_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_get_saved_object.tsx#:~:text=SavedObjectAttributes), [use_get_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_get_saved_object.tsx#:~:text=SavedObjectAttributes), [use_update_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_update_saved_object.tsx#:~:text=SavedObjectAttributes), [use_update_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_update_saved_object.tsx#:~:text=SavedObjectAttributes), [use_update_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_update_saved_object.tsx#:~:text=SavedObjectAttributes)+ 2 more | - | +| | [use_find_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_find_saved_object.tsx#:~:text=SavedObjectAttributes), [use_find_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_find_saved_object.tsx#:~:text=SavedObjectAttributes), [use_create_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_create_saved_object.tsx#:~:text=SavedObjectAttributes), [use_create_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_create_saved_object.tsx#:~:text=SavedObjectAttributes), [use_create_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_create_saved_object.tsx#:~:text=SavedObjectAttributes), [use_get_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_get_saved_object.tsx#:~:text=SavedObjectAttributes), [use_get_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_get_saved_object.tsx#:~:text=SavedObjectAttributes), [use_update_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_update_saved_object.tsx#:~:text=SavedObjectAttributes), [use_update_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_update_saved_object.tsx#:~:text=SavedObjectAttributes), [use_update_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_update_saved_object.tsx#:~:text=SavedObjectAttributes)+ 2 more | - | @@ -445,15 +489,17 @@ so TS and code-reference navigation might not highlight them. | | ---------------|-----------|-----------| | | [ml_page.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/components/ml_page/ml_page.tsx#:~:text=KibanaPageTemplate), [ml_page.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/components/ml_page/ml_page.tsx#:~:text=KibanaPageTemplate), [ml_page.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/components/ml_page/ml_page.tsx#:~:text=KibanaPageTemplate) | - | | | [ml_page.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/components/ml_page/ml_page.tsx#:~:text=RedirectAppLinks), [ml_page.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/components/ml_page/ml_page.tsx#:~:text=RedirectAppLinks), [ml_page.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/components/ml_page/ml_page.tsx#:~:text=RedirectAppLinks), [jobs_list_page.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/management/jobs_list/components/jobs_list_page/jobs_list_page.tsx#:~:text=RedirectAppLinks), [jobs_list_page.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/management/jobs_list/components/jobs_list_page/jobs_list_page.tsx#:~:text=RedirectAppLinks), [jobs_list_page.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/management/jobs_list/components/jobs_list_page/jobs_list_page.tsx#:~:text=RedirectAppLinks) | - | -| | [check_license.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/license/check_license.tsx#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/plugin.ts#:~:text=license%24) | 8.8.0 | +| | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/plugin.ts#:~:text=license%24) | 8.8.0 | | | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/server/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/server/plugin.ts#:~:text=license%24) | 8.8.0 | | | [annotations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/server/routes/annotations.ts#:~:text=authc) | - | | | [initialization.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/server/saved_objects/initialization/initialization.ts#:~:text=authz), [sync_task.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/server/saved_objects/sync_task.ts#:~:text=authz), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/server/plugin.ts#:~:text=authz), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/server/plugin.ts#:~:text=authz) | - | | | [app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/app.tsx#:~:text=onAppLeave) | 8.8.0 | +| | [modules.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/common/types/modules.ts#:~:text=SavedObjectAttributes), [modules.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/common/types/modules.ts#:~:text=SavedObjectAttributes) | - | | | [errors.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/common/util/errors/errors.test.ts#:~:text=req), [errors.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/common/util/errors/errors.test.ts#:~:text=req) | 8.8.0 Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block, so TS and code-reference navigation might not highlight them. | +| | [modules.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/common/types/modules.ts#:~:text=SavedObjectAttributes), [modules.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/common/types/modules.ts#:~:text=SavedObjectAttributes) | - | @@ -522,6 +568,8 @@ so TS and code-reference navigation might not highlight them. | | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| | | [saved_object.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/saved_object.test.ts#:~:text=indexPatterns), [saved_object.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/saved_object.test.ts#:~:text=indexPatterns) | - | +| | [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/types.ts#:~:text=SavedObjectAttributes), [create_source.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/helpers/create_source.ts#:~:text=SavedObjectAttributes), [create_source.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/helpers/create_source.ts#:~:text=SavedObjectAttributes), [find_object_by_title.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/helpers/find_object_by_title.ts#:~:text=SavedObjectAttributes), [find_object_by_title.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/helpers/find_object_by_title.ts#:~:text=SavedObjectAttributes), [save_with_confirmation.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts#:~:text=SavedObjectAttributes)+ 15 more | - | +| | [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/types.ts#:~:text=SavedObjectAttributes), [create_source.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/helpers/create_source.ts#:~:text=SavedObjectAttributes), [create_source.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/helpers/create_source.ts#:~:text=SavedObjectAttributes), [find_object_by_title.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/helpers/find_object_by_title.ts#:~:text=SavedObjectAttributes), [find_object_by_title.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/helpers/find_object_by_title.ts#:~:text=SavedObjectAttributes), [save_with_confirmation.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts#:~:text=SavedObjectAttributes)+ 15 more | - | @@ -551,6 +599,15 @@ so TS and code-reference navigation might not highlight them. | +## savedSearch + +| Deprecated API | Reference location(s) | Remove By | +| ---------------|-----------|-----------| +| | [search_migrations.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/server/saved_objects/search_migrations.ts#:~:text=SavedObjectAttributes), [search_migrations.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/server/saved_objects/search_migrations.ts#:~:text=SavedObjectAttributes) | - | +| | [search_migrations.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/server/saved_objects/search_migrations.ts#:~:text=SavedObjectAttributes), [search_migrations.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/server/saved_objects/search_migrations.ts#:~:text=SavedObjectAttributes) | - | + + + ## searchprofiler | Deprecated API | Reference location(s) | Remove By | @@ -577,9 +634,9 @@ This is relied on by the reporting feature, and should be removed once reporting migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/issues/19914 | | | [app_authorization.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/app_authorization.ts#:~:text=getKibanaFeatures), [privileges.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.ts#:~:text=getKibanaFeatures), [authorization_service.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/authorization_service.tsx#:~:text=getKibanaFeatures), [app_authorization.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/app_authorization.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures)+ 14 more | 8.8.0 | | | [authorization_service.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/authorization_service.tsx#:~:text=getElasticsearchFeatures) | 8.8.0 | -| | [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode) | 8.8.0 | +| | [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode) | 8.8.0 | | | [plugin.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/plugin.tsx#:~:text=license%24) | 8.8.0 | -| | [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode) | 8.8.0 | +| | [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode) | 8.8.0 | | | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/plugin.ts#:~:text=license%24) | 8.8.0 | | | [logout_app.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/authentication/logout/logout_app.test.ts#:~:text=appBasePath) | 8.8.0 | | | [logout_app.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/authentication/logout/logout_app.test.ts#:~:text=onAppLeave) | 8.8.0 | @@ -595,11 +652,14 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | | [middleware.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#:~:text=indexPatterns), [dependencies_start_mock.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/mock/endpoint/dependencies_start_mock.ts#:~:text=indexPatterns) | - | | | [wrap_search_source_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.ts#:~:text=create) | - | | | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch) | - | +| | [api.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/hooks/eql/api.ts#:~:text=options) | - | | | [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [list.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/routes/actions/list.test.ts#:~:text=mode), [response_actions.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/routes/actions/response_actions.test.ts#:~:text=mode)+ 3 more | 8.8.0 | | | [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [list.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/routes/actions/list.test.ts#:~:text=mode), [response_actions.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/routes/actions/response_actions.test.ts#:~:text=mode)+ 3 more | 8.8.0 | | | [request_context_factory.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/request_context_factory.ts#:~:text=authc), [request_context_factory.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/request_context_factory.ts#:~:text=authc), [create_signals_migration_route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/create_signals_migration_route.ts#:~:text=authc), [delete_signals_migration_route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/delete_signals_migration_route.ts#:~:text=authc), [finalize_signals_migration_route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/finalize_signals_migration_route.ts#:~:text=authc), [open_close_signals_route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/open_close_signals_route.ts#:~:text=authc), [preview_rules_route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/preview_rules_route.ts#:~:text=authc), [common.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/timeline/utils/common.ts#:~:text=authc) | - | | | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/index.tsx#:~:text=onAppLeave), [plugin.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/plugin.tsx#:~:text=onAppLeave) | 8.8.0 | | | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/timelines/components/flyout/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/timelines/components/flyout/index.tsx#:~:text=AppLeaveHandler), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/types.ts#:~:text=AppLeaveHandler), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/types.ts#:~:text=AppLeaveHandler), [routes.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/routes.tsx#:~:text=AppLeaveHandler), [routes.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/routes.tsx#:~:text=AppLeaveHandler), [app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/app.tsx#:~:text=AppLeaveHandler), [app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/app.tsx#:~:text=AppLeaveHandler), [app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/app.tsx#:~:text=AppLeaveHandler) | 8.8.0 | +| | [legacy_types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions/legacy_types.ts#:~:text=SavedObjectAttributes), [legacy_types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions/legacy_types.ts#:~:text=SavedObjectAttributes), [legacy_migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions/legacy_migrations.ts#:~:text=SavedObjectAttributes), [legacy_migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions/legacy_migrations.ts#:~:text=SavedObjectAttributes) | - | +| | [legacy_types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions/legacy_types.ts#:~:text=SavedObjectAttributes), [legacy_types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions/legacy_types.ts#:~:text=SavedObjectAttributes), [legacy_migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions/legacy_migrations.ts#:~:text=SavedObjectAttributes), [legacy_migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions/legacy_migrations.ts#:~:text=SavedObjectAttributes) | - | @@ -644,6 +704,15 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ +## taskManager + +| Deprecated API | Reference location(s) | Remove By | +| ---------------|-----------|-----------| +| | [task_store.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/task_manager/server/task_store.test.ts#:~:text=SavedObjectAttributes), [task_store.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/task_manager/server/task_store.test.ts#:~:text=SavedObjectAttributes) | - | +| | [task_store.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/task_manager/server/task_store.test.ts#:~:text=SavedObjectAttributes), [task_store.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/task_manager/server/task_store.test.ts#:~:text=SavedObjectAttributes) | - | + + + ## transform | Deprecated API | Reference location(s) | Remove By | @@ -711,6 +780,8 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| | | [visualize_top_nav.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx#:~:text=onAppLeave), [visualize_editor_common.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/components/visualize_editor_common.tsx#:~:text=onAppLeave), [app.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/app.tsx#:~:text=onAppLeave), [index.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/index.tsx#:~:text=onAppLeave) | 8.8.0 | +| | [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/common/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/common/types.ts#:~:text=SavedObjectAttributes), [save_with_confirmation.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_objects_utils/save_with_confirmation.ts#:~:text=SavedObjectAttributes), [save_with_confirmation.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_objects_utils/save_with_confirmation.ts#:~:text=SavedObjectAttributes), [find_object_by_title.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_objects_utils/find_object_by_title.ts#:~:text=SavedObjectAttributes), [find_object_by_title.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_objects_utils/find_object_by_title.ts#:~:text=SavedObjectAttributes), [saved_visualization_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualization_references/saved_visualization_references.ts#:~:text=SavedObjectAttributes), [saved_visualization_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualization_references/saved_visualization_references.ts#:~:text=SavedObjectAttributes), [saved_visualize_utils.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualize_utils.ts#:~:text=SavedObjectAttributes), [saved_visualize_utils.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualize_utils.ts#:~:text=SavedObjectAttributes)+ 13 more | - | +| | [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/common/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/common/types.ts#:~:text=SavedObjectAttributes), [save_with_confirmation.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_objects_utils/save_with_confirmation.ts#:~:text=SavedObjectAttributes), [save_with_confirmation.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_objects_utils/save_with_confirmation.ts#:~:text=SavedObjectAttributes), [find_object_by_title.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_objects_utils/find_object_by_title.ts#:~:text=SavedObjectAttributes), [find_object_by_title.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_objects_utils/find_object_by_title.ts#:~:text=SavedObjectAttributes), [saved_visualization_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualization_references/saved_visualization_references.ts#:~:text=SavedObjectAttributes), [saved_visualization_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualization_references/saved_visualization_references.ts#:~:text=SavedObjectAttributes), [saved_visualize_utils.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualize_utils.ts#:~:text=SavedObjectAttributes), [saved_visualize_utils.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualize_utils.ts#:~:text=SavedObjectAttributes)+ 13 more | - | diff --git a/api_docs/deprecations_by_team.mdx b/api_docs/deprecations_by_team.mdx index 8545316f77c0f..6275c5e9b7f53 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana'] --- @@ -80,7 +80,7 @@ so TS and code-reference navigation might not highlight them. | Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block, so TS and code-reference navigation might not highlight them. | | @kbn/core-saved-objects-migration-server-internal | | [document_migrator.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/core/document_migrator.test.ts#:~:text=warning), [migration_logger.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/core/migration_logger.ts#:~:text=warning) | 8.8.0 | -| @kbn/core-metrics-server-internal | | [ops_metrics_collector.ts](https://github.com/elastic/kibana/tree/main/packages/core/metrics/core-metrics-server-internal/src/ops_metrics_collector.ts#:~:text=process), [get_ops_metrics_log.ts](https://github.com/elastic/kibana/tree/main/packages/core/metrics/core-metrics-server-internal/src/logging/get_ops_metrics_log.ts#:~:text=process), [get_ops_metrics_log.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/metrics/core-metrics-server-internal/src/logging/get_ops_metrics_log.test.ts#:~:text=process), [core_usage_data_service.ts](https://github.com/elastic/kibana/tree/main/packages/core/usage-data/core-usage-data-server-internal/src/core_usage_data_service.ts#:~:text=process), [core_usage_data_service.ts](https://github.com/elastic/kibana/tree/main/packages/core/usage-data/core-usage-data-server-internal/src/core_usage_data_service.ts#:~:text=process), [core_usage_data_service.ts](https://github.com/elastic/kibana/tree/main/packages/core/usage-data/core-usage-data-server-internal/src/core_usage_data_service.ts#:~:text=process) | 8.8.0 | +| @kbn/core-apps-browser-internal | | [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.test.ts#:~:text=process), [ops_metrics_collector.ts](https://github.com/elastic/kibana/tree/main/packages/core/metrics/core-metrics-server-internal/src/ops_metrics_collector.ts#:~:text=process), [get_ops_metrics_log.ts](https://github.com/elastic/kibana/tree/main/packages/core/metrics/core-metrics-server-internal/src/logging/get_ops_metrics_log.ts#:~:text=process), [get_ops_metrics_log.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/metrics/core-metrics-server-internal/src/logging/get_ops_metrics_log.test.ts#:~:text=process)+ 5 more | 8.8.0 | @@ -88,10 +88,10 @@ so TS and code-reference navigation might not highlight them. | | Plugin | Deprecated API | Reference location(s) | Remove By | | --------|-------|-----------|-----------| -| dashboard | | [saved_objects.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/saved_objects.ts#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/top_nav/save_modal.tsx#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/top_nav/save_modal.tsx#:~:text=SavedObjectSaveModal), [saved_object_save_modal_dashboard.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx#:~:text=SavedObjectSaveModal), [saved_object_save_modal_dashboard.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 | -| dashboard | | [saved_object_loader.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/saved_object_loader.ts#:~:text=SavedObject), [saved_object_loader.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/saved_object_loader.ts#:~:text=SavedObject), [saved_object_loader.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/saved_object_loader.ts#:~:text=SavedObject), [saved_objects.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/saved_objects.ts#:~:text=SavedObject), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=SavedObject), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=SavedObject), [dashboard_tagging.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/lib/dashboard_tagging.ts#:~:text=SavedObject), [dashboard_tagging.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/lib/dashboard_tagging.ts#:~:text=SavedObject), [clone_panel_action.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/actions/clone_panel_action.tsx#:~:text=SavedObject), [clone_panel_action.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/actions/clone_panel_action.tsx#:~:text=SavedObject)+ 1 more | 8.8.0 | +| dashboard | | [save_modal.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/top_nav/save_modal.tsx#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/top_nav/save_modal.tsx#:~:text=SavedObjectSaveModal), [saved_object_save_modal_dashboard.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx#:~:text=SavedObjectSaveModal), [saved_object_save_modal_dashboard.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 | +| dashboard | | [saved_object_loader.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/saved_object_loader.ts#:~:text=SavedObject), [saved_object_loader.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/saved_object_loader.ts#:~:text=SavedObject), [saved_object_loader.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/saved_object_loader.ts#:~:text=SavedObject), [clone_panel_action.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/actions/clone_panel_action.tsx#:~:text=SavedObject), [clone_panel_action.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/actions/clone_panel_action.tsx#:~:text=SavedObject), [clone_panel_action.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/actions/clone_panel_action.tsx#:~:text=SavedObject), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=SavedObject), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=SavedObject), [dashboard_tagging.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/lib/dashboard_tagging.ts#:~:text=SavedObject), [dashboard_tagging.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/lib/dashboard_tagging.ts#:~:text=SavedObject) | 8.8.0 | | dashboard | | [saved_dashboard.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=SavedObjectClass) | 8.8.0 | -| dashboard | | [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/types.ts#:~:text=onAppLeave), [dashboard_router.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/dashboard_router.tsx#:~:text=onAppLeave), [plugin.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/plugin.tsx#:~:text=onAppLeave) | 8.8.0 | +| dashboard | | [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/types.ts#:~:text=onAppLeave), [plugin.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/plugin.tsx#:~:text=onAppLeave) | 8.8.0 | | dashboard | | [migrations_730.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/saved_objects/migrations_730.ts#:~:text=warning), [migrations_730.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/saved_objects/migrations_730.ts#:~:text=warning) | 8.8.0 | @@ -116,7 +116,7 @@ so TS and code-reference navigation might not highlight them. | | Plugin | Deprecated API | Reference location(s) | Remove By | | --------|-------|-----------|-----------| -| ml | | [check_license.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/license/check_license.tsx#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/plugin.ts#:~:text=license%24) | 8.8.0 | +| ml | | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/plugin.ts#:~:text=license%24) | 8.8.0 | | ml | | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/server/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/server/plugin.ts#:~:text=license%24), [license.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/transform/server/services/license.ts#:~:text=license%24) | 8.8.0 | | ml | | [app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/app.tsx#:~:text=onAppLeave) | 8.8.0 | | ml | | [errors.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/common/util/errors/errors.test.ts#:~:text=req), [errors.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/common/util/errors/errors.test.ts#:~:text=req) | 8.8.0 @@ -144,9 +144,9 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ This is relied on by the reporting feature, and should be removed once reporting migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/issues/19914 | | security | | [authorization_service.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/authorization_service.tsx#:~:text=getElasticsearchFeatures) | 8.8.0 | -| security | | [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode) | 8.8.0 | +| security | | [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode) | 8.8.0 | | security | | [plugin.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/plugin.tsx#:~:text=license%24) | 8.8.0 | -| security | | [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode) | 8.8.0 | +| security | | [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode) | 8.8.0 | | security | | [logout_app.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/authentication/logout/logout_app.test.ts#:~:text=appBasePath) | 8.8.0 | | security | | [logout_app.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/authentication/logout/logout_app.test.ts#:~:text=onAppLeave) | 8.8.0 | diff --git a/api_docs/dev_tools.mdx b/api_docs/dev_tools.mdx index 334a2c08e23c3..f43e7dccfe704 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools'] --- import devToolsObj from './dev_tools.devdocs.json'; diff --git a/api_docs/discover.devdocs.json b/api_docs/discover.devdocs.json index 87e0d53a57078..c9ebfdee37434 100644 --- a/api_docs/discover.devdocs.json +++ b/api_docs/discover.devdocs.json @@ -1873,6 +1873,21 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "discover", + "id": "def-common.SHOW_LEGACY_FIELD_TOP_VALUES", + "type": "string", + "tags": [], + "label": "SHOW_LEGACY_FIELD_TOP_VALUES", + "description": [], + "signature": [ + "\"discover:showLegacyFieldTopValues\"" + ], + "path": "src/plugins/discover/common/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "discover", "id": "def-common.SHOW_MULTIFIELDS", diff --git a/api_docs/discover.mdx b/api_docs/discover.mdx index 6eb89f79f4807..d0066edd11e12 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover'] --- import discoverObj from './discover.devdocs.json'; @@ -21,7 +21,7 @@ Contact [Data Discovery](https://github.com/orgs/elastic/teams/kibana-data-disco | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 95 | 0 | 78 | 4 | +| 96 | 0 | 79 | 4 | ## Client diff --git a/api_docs/discover_enhanced.mdx b/api_docs/discover_enhanced.mdx index 3ddbd42c2bc73..7b8b8601af087 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced'] --- import discoverEnhancedObj from './discover_enhanced.devdocs.json'; diff --git a/api_docs/embeddable.devdocs.json b/api_docs/embeddable.devdocs.json index 939fe8507b095..4f8a65cb51f05 100644 --- a/api_docs/embeddable.devdocs.json +++ b/api_docs/embeddable.devdocs.json @@ -137,9 +137,7 @@ "section": "def-public.EmbeddableFactory", "text": "EmbeddableFactory" }, - " | undefined" + " | undefined" ], "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", "deprecated": false, @@ -202,9 +200,7 @@ "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, - ">, ", - "SavedObjectAttributes", - ">>" + ">, unknown>>" ], "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", "deprecated": false, @@ -585,9 +581,7 @@ "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, - ">, ", - "SavedObjectAttributes", - ">) | undefined" + ">, unknown>) | undefined" ], "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "deprecated": false, @@ -975,9 +969,7 @@ "section": "def-public.EmbeddableFactory", "text": "EmbeddableFactory" }, - " | undefined" + " | undefined" ], "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, @@ -1782,9 +1774,7 @@ "section": "def-public.EmbeddableFactory", "text": "EmbeddableFactory" }, - ", partial?: Partial) => ", + ", partial?: Partial) => ", { "pluginId": "embeddable", "scope": "common", @@ -1813,9 +1803,7 @@ "section": "def-public.EmbeddableFactory", "text": "EmbeddableFactory" }, - "" + "" ], "path": "src/plugins/embeddable/public/lib/containers/container.ts", "deprecated": false, @@ -2093,9 +2081,7 @@ "section": "def-public.EmbeddableFactory", "text": "EmbeddableFactory" }, - " | undefined" + " | undefined" ], "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", "deprecated": false, @@ -4675,9 +4661,7 @@ "section": "def-public.IEmbeddable", "text": "IEmbeddable" }, - ", T extends ", - "SavedObjectAttributes", - " = ", + ", T = ", "SavedObjectAttributes", ">(def: ", { @@ -5676,9 +5660,7 @@ "section": "def-public.EmbeddableFactory", "text": "EmbeddableFactory" }, - " | undefined; getAllFactories: () => IterableIterator<", + " | undefined; getAllFactories: () => IterableIterator<", { "pluginId": "embeddable", "scope": "public", @@ -5726,9 +5708,7 @@ "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, - ">, ", - "SavedObjectAttributes", - ">>; overlays: ", + ">, unknown>>; overlays: ", "OverlayStart", "; notifications: ", "NotificationsStart", @@ -5853,9 +5833,7 @@ "section": "def-public.EmbeddableFactory", "text": "EmbeddableFactory" }, - " | undefined" + " | undefined" ], "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", "deprecated": false, @@ -5931,9 +5909,7 @@ "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, - ">, ", - "SavedObjectAttributes", - ">>" + ">, unknown>>" ], "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", "deprecated": false, @@ -10203,9 +10179,7 @@ "section": "def-public.EmbeddableFactoryDefinition", "text": "EmbeddableFactoryDefinition" }, - ") => () => ", + ") => () => ", { "pluginId": "embeddable", "scope": "public", @@ -10213,9 +10187,7 @@ "section": "def-public.EmbeddableFactory", "text": "EmbeddableFactory" }, - "" + "" ], "path": "src/plugins/embeddable/public/plugin.tsx", "deprecated": false, @@ -10251,9 +10223,7 @@ "section": "def-public.EmbeddableFactoryDefinition", "text": "EmbeddableFactoryDefinition" }, - "" + "" ], "path": "src/plugins/embeddable/public/plugin.tsx", "deprecated": false, @@ -10453,9 +10423,7 @@ "section": "def-public.EmbeddableFactory", "text": "EmbeddableFactory" }, - " | undefined" + " | undefined" ], "path": "src/plugins/embeddable/public/plugin.tsx", "deprecated": false, @@ -10535,9 +10503,7 @@ "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, - ">, ", - "SavedObjectAttributes", - ">>" + ">, unknown>>" ], "path": "src/plugins/embeddable/public/plugin.tsx", "deprecated": false, diff --git a/api_docs/embeddable.mdx b/api_docs/embeddable.mdx index 362609d3d6d49..d938439ede797 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable'] --- import embeddableObj from './embeddable.devdocs.json'; diff --git a/api_docs/embeddable_enhanced.mdx b/api_docs/embeddable_enhanced.mdx index 58bb7cbddd42b..bf199f204fba2 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: 2022-09-09 +date: 2022-09-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 002dd9eb27139..19aca55bed367 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: 2022-09-09 +date: 2022-09-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 8ee7ecbb68c9a..b42b4016faf40 100644 --- a/api_docs/enterprise_search.devdocs.json +++ b/api_docs/enterprise_search.devdocs.json @@ -118,6 +118,21 @@ "deprecated": false, "trackAdoption": false, "initialIsOpen": false + }, + { + "parentPluginId": "enterpriseSearch", + "id": "def-server.CURRENT_CONNECTORS_INDEX", + "type": "string", + "tags": [], + "label": "CURRENT_CONNECTORS_INDEX", + "description": [], + "signature": [ + "\".elastic-connectors-v1\"" + ], + "path": "x-pack/plugins/enterprise_search/server/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false } ], "objects": [ diff --git a/api_docs/enterprise_search.mdx b/api_docs/enterprise_search.mdx index 5a45b7486d4c9..a7d4bd56a4065 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch'] --- import enterpriseSearchObj from './enterprise_search.devdocs.json'; @@ -21,7 +21,7 @@ Contact [Enterprise Search](https://github.com/orgs/elastic/teams/enterprise-sea | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 8 | 0 | 8 | 0 | +| 9 | 0 | 9 | 0 | ## Server diff --git a/api_docs/es_ui_shared.mdx b/api_docs/es_ui_shared.mdx index b3f3fc87bda00..24b08955cb1ab 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: 2022-09-09 +date: 2022-09-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 45ace5e5039e6..35e2988d5b946 100644 --- a/api_docs/event_annotation.devdocs.json +++ b/api_docs/event_annotation.devdocs.json @@ -872,7 +872,7 @@ "section": "def-common.KibanaQueryOutput", "text": "KibanaQueryOutput" }, - "; timeField?: string | undefined; extraFields?: string[] | undefined; textField?: string | undefined; } & StyleSharedProps & { icon?: ", + "; timeField?: string | undefined; extraFields?: string[] | undefined; textField?: string | undefined; ignoreGlobalFilters?: boolean | undefined; } & StyleSharedProps & { icon?: ", { "pluginId": "eventAnnotation", "scope": "common", @@ -905,7 +905,7 @@ "section": "def-common.KibanaQueryOutput", "text": "KibanaQueryOutput" }, - "; timeField?: string | undefined; textField?: string | undefined; extraFields?: string[] | undefined; key: { type: \"point_in_time\"; }; } & StyleSharedProps & { icon?: ", + "; timeField?: string | undefined; textField?: string | undefined; extraFields?: string[] | undefined; ignoreGlobalFilters?: boolean | undefined; key: { type: \"point_in_time\"; }; } & StyleSharedProps & { icon?: ", { "pluginId": "eventAnnotation", "scope": "common", @@ -938,7 +938,7 @@ "section": "def-common.KibanaQueryOutput", "text": "KibanaQueryOutput" }, - "; timeField?: string | undefined; extraFields?: string[] | undefined; textField?: string | undefined; } & StyleSharedProps & { icon?: ", + "; timeField?: string | undefined; extraFields?: string[] | undefined; textField?: string | undefined; ignoreGlobalFilters?: boolean | undefined; } & StyleSharedProps & { icon?: ", { "pluginId": "eventAnnotation", "scope": "common", @@ -2606,6 +2606,58 @@ "trackAdoption": false } ] + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.queryPointEventAnnotation.args.ignoreGlobalFilters", + "type": "Object", + "tags": [], + "label": "ignoreGlobalFilters", + "description": [], + "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "eventAnnotation", + "id": "def-common.queryPointEventAnnotation.args.ignoreGlobalFilters.types", + "type": "Array", + "tags": [], + "label": "types", + "description": [], + "signature": [ + "\"boolean\"[]" + ], + "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.queryPointEventAnnotation.args.ignoreGlobalFilters.help", + "type": "string", + "tags": [], + "label": "help", + "description": [], + "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.queryPointEventAnnotation.args.ignoreGlobalFilters.default", + "type": "boolean", + "tags": [], + "label": "default", + "description": [], + "signature": [ + "true" + ], + "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", + "deprecated": false, + "trackAdoption": false + } + ] } ] }, @@ -2633,7 +2685,7 @@ "section": "def-common.KibanaQueryOutput", "text": "KibanaQueryOutput" }, - "; timeField?: string | undefined; extraFields?: string[] | undefined; textField?: string | undefined; label: string; color?: string | undefined; isHidden?: boolean | undefined; icon?: ", + "; timeField?: string | undefined; extraFields?: string[] | undefined; textField?: string | undefined; ignoreGlobalFilters?: boolean | undefined; label: string; color?: string | undefined; isHidden?: boolean | undefined; icon?: ", { "pluginId": "eventAnnotation", "scope": "common", @@ -2680,7 +2732,7 @@ "section": "def-common.KibanaQueryOutput", "text": "KibanaQueryOutput" }, - "; timeField?: string | undefined; extraFields?: string[] | undefined; textField?: string | undefined; } & StyleSharedProps & { icon?: ", + "; timeField?: string | undefined; extraFields?: string[] | undefined; textField?: string | undefined; ignoreGlobalFilters?: boolean | undefined; } & StyleSharedProps & { icon?: ", { "pluginId": "eventAnnotation", "scope": "common", diff --git a/api_docs/event_annotation.mdx b/api_docs/event_annotation.mdx index 0161dd80da0d7..d5e087678a1d0 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation'] --- import eventAnnotationObj from './event_annotation.devdocs.json'; @@ -21,7 +21,7 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 170 | 0 | 170 | 3 | +| 174 | 0 | 174 | 3 | ## Client diff --git a/api_docs/event_log.devdocs.json b/api_docs/event_log.devdocs.json index 8e717efd4ad23..f821ced3a76e0 100644 --- a/api_docs/event_log.devdocs.json +++ b/api_docs/event_log.devdocs.json @@ -696,6 +696,48 @@ } ], "returnComment": [] + }, + { + "parentPluginId": "eventLog", + "id": "def-server.ClusterClientAdapter.aggregateEventsWithAuthFilter", + "type": "Function", + "tags": [], + "label": "aggregateEventsWithAuthFilter", + "description": [], + "signature": [ + "(queryOptions: ", + "AggregateEventsWithAuthFilter", + ") => Promise<", + { + "pluginId": "eventLog", + "scope": "server", + "docId": "kibEventLogPluginApi", + "section": "def-server.AggregateEventsBySavedObjectResult", + "text": "AggregateEventsBySavedObjectResult" + }, + ">" + ], + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "eventLog", + "id": "def-server.ClusterClientAdapter.aggregateEventsWithAuthFilter.$1", + "type": "Object", + "tags": [], + "label": "queryOptions", + "description": [], + "signature": [ + "AggregateEventsWithAuthFilter" + ], + "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -1007,6 +1049,82 @@ } ], "returnComment": [] + }, + { + "parentPluginId": "eventLog", + "id": "def-server.IEventLogClient.aggregateEventsWithAuthFilter", + "type": "Function", + "tags": [], + "label": "aggregateEventsWithAuthFilter", + "description": [], + "signature": [ + "(type: string, authFilter: ", + "KueryNode", + ", options?: Partial<", + "AggregateOptionsType", + "> | undefined) => Promise<", + { + "pluginId": "eventLog", + "scope": "server", + "docId": "kibEventLogPluginApi", + "section": "def-server.AggregateEventsBySavedObjectResult", + "text": "AggregateEventsBySavedObjectResult" + }, + ">" + ], + "path": "x-pack/plugins/event_log/server/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "eventLog", + "id": "def-server.IEventLogClient.aggregateEventsWithAuthFilter.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/event_log/server/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "eventLog", + "id": "def-server.IEventLogClient.aggregateEventsWithAuthFilter.$2", + "type": "Object", + "tags": [], + "label": "authFilter", + "description": [], + "signature": [ + "KueryNode" + ], + "path": "x-pack/plugins/event_log/server/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "eventLog", + "id": "def-server.IEventLogClient.aggregateEventsWithAuthFilter.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "Partial<", + "AggregateOptionsType", + "> | undefined" + ], + "path": "x-pack/plugins/event_log/server/types.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -1194,7 +1312,7 @@ "label": "data", "description": [], "signature": [ - "(Readonly<{ error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; outcome?: string | undefined; created?: string | undefined; category?: string[] | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; code?: string | undefined; url?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}> | undefined)[]" + "(Readonly<{ error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ name?: string | undefined; description?: string | undefined; category?: string | undefined; id?: string | undefined; version?: string | undefined; license?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; category?: string[] | undefined; type?: string[] | undefined; id?: string | undefined; outcome?: string | undefined; created?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; code?: string | undefined; url?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}> | undefined)[]" ], "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", "deprecated": false, @@ -1214,7 +1332,7 @@ "label": "IEvent", "description": [], "signature": [ - "DeepPartial | undefined; tags?: string[] | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; outcome?: string | undefined; created?: string | undefined; category?: string[] | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; code?: string | undefined; url?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}>>> | undefined" + "DeepPartial | undefined; tags?: string[] | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ name?: string | undefined; description?: string | undefined; category?: string | undefined; id?: string | undefined; version?: string | undefined; license?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; category?: string[] | undefined; type?: string[] | undefined; id?: string | undefined; outcome?: string | undefined; created?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; code?: string | undefined; url?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}>>> | undefined" ], "path": "x-pack/plugins/event_log/generated/schemas.ts", "deprecated": false, @@ -1229,7 +1347,7 @@ "label": "IValidatedEvent", "description": [], "signature": [ - "Readonly<{ error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; outcome?: string | undefined; created?: string | undefined; category?: string[] | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; code?: string | undefined; url?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}> | undefined" + "Readonly<{ error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ name?: string | undefined; description?: string | undefined; category?: string | undefined; id?: string | undefined; version?: string | undefined; license?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; category?: string[] | undefined; type?: string[] | undefined; id?: string | undefined; outcome?: string | undefined; created?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; code?: string | undefined; url?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}> | undefined" ], "path": "x-pack/plugins/event_log/generated/schemas.ts", "deprecated": false, diff --git a/api_docs/event_log.mdx b/api_docs/event_log.mdx index 3867ef968cdda..d730f68e18eab 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog'] --- import eventLogObj from './event_log.devdocs.json'; @@ -21,7 +21,7 @@ Contact [Response Ops](https://github.com/orgs/elastic/teams/response-ops) for q | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 100 | 0 | 100 | 9 | +| 106 | 0 | 106 | 10 | ## Server diff --git a/api_docs/expression_error.mdx b/api_docs/expression_error.mdx index f8a6757785b98..a3ee129f44d7a 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: 2022-09-09 +date: 2022-09-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 9c151c832439f..3b708aa6953ee 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: 2022-09-09 +date: 2022-09-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 18e588eda0322..3a813a40fc8f4 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: 2022-09-09 +date: 2022-09-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 7c7fcf1e51a85..9c315a54f4499 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: 2022-09-09 +date: 2022-09-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 227caffdd86ae..b821534dec8b8 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: 2022-09-09 +date: 2022-09-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 73127734fb39d..45ed0cf31366f 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: 2022-09-09 +date: 2022-09-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 ee91044586ad4..c9463ec11ba52 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: 2022-09-09 +date: 2022-09-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 30188432c4589..1518c761b6a23 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: 2022-09-09 +date: 2022-09-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 abbd5e0f52ab5..0f12cfcfe0367 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: 2022-09-09 +date: 2022-09-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 ae05b346c5294..74cf96e0e3b2c 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: 2022-09-09 +date: 2022-09-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 3df0f71990ee1..2897faff88580 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: 2022-09-09 +date: 2022-09-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 312da9ec73cca..c4dd54fe09f32 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionTagcloud'] --- import expressionTagcloudObj from './expression_tagcloud.devdocs.json'; diff --git a/api_docs/expression_x_y.devdocs.json b/api_docs/expression_x_y.devdocs.json index 86ab5bf035752..46ce5d448b1e5 100644 --- a/api_docs/expression_x_y.devdocs.json +++ b/api_docs/expression_x_y.devdocs.json @@ -78,6 +78,17 @@ "deprecated": false, "trackAdoption": false, "children": [ + { + "parentPluginId": "expressionXY", + "id": "def-common.AnnotationLayerArgs.layerId", + "type": "string", + "tags": [], + "label": "layerId", + "description": [], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "expressionXY", "id": "def-common.AnnotationLayerArgs.annotations", @@ -1042,34 +1053,21 @@ }, { "parentPluginId": "expressionXY", - "id": "def-common.MergedAnnotation.customTooltipDetails", - "type": "Function", + "id": "def-common.MergedAnnotation.customTooltip", + "type": "CompoundType", "tags": [], - "label": "customTooltipDetails", + "label": "customTooltip", "description": [], "signature": [ - "(details?: string | undefined) => JSX.Element | null" + "React.ComponentType<{ header?: string | undefined; details?: string | undefined; datum: ", + "LineAnnotationDatum", + " | ", + "RectAnnotationDatum", + "; }> | null" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_renderers.ts", "deprecated": false, - "trackAdoption": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.MergedAnnotation.customTooltipDetails.$1", - "type": "string", - "tags": [], - "label": "details", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "node_modules/@elastic/charts/dist/chart_types/xy_chart/annotations/types.d.ts", - "deprecated": false, - "trackAdoption": false - } - ] + "trackAdoption": false }, { "parentPluginId": "expressionXY", diff --git a/api_docs/expression_x_y.mdx b/api_docs/expression_x_y.mdx index 9720c8b749c92..d94ee04294bb3 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionXY'] --- import expressionXYObj from './expression_x_y.devdocs.json'; @@ -21,7 +21,7 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 153 | 0 | 142 | 9 | +| 153 | 0 | 143 | 9 | ## Client diff --git a/api_docs/expressions.devdocs.json b/api_docs/expressions.devdocs.json index 21faf370389c9..fc3d36b421afb 100644 --- a/api_docs/expressions.devdocs.json +++ b/api_docs/expressions.devdocs.json @@ -38020,7 +38020,9 @@ "section": "def-common.SerializedDatatable", "text": "SerializedDatatable" }, - ") => { rows: _.Dictionary[]; type: \"datatable\"; columns: ", + ") => { rows: ", + "Dictionary", + "[]; type: \"datatable\"; columns: ", { "pluginId": "expressions", "scope": "common", diff --git a/api_docs/expressions.mdx b/api_docs/expressions.mdx index 3bc004877bf6d..3d4b511820a01 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: 2022-09-09 +date: 2022-09-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 d3bfbec1eafaa..4589136f7b707 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features'] --- import featuresObj from './features.devdocs.json'; diff --git a/api_docs/field_formats.devdocs.json b/api_docs/field_formats.devdocs.json index 28bc24cfdcdfc..e072b2ca996b4 100644 --- a/api_docs/field_formats.devdocs.json +++ b/api_docs/field_formats.devdocs.json @@ -753,13 +753,7 @@ ], "signature": [ "(uiSettings: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IUiSettingsClient", - "text": "IUiSettingsClient" - }, + "IUiSettingsClient", ") => Promise<", { "pluginId": "fieldFormats", @@ -784,13 +778,7 @@ "- {@link IUiSettingsClient }" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IUiSettingsClient", - "text": "IUiSettingsClient" - } + "IUiSettingsClient" ], "path": "src/plugins/field_formats/server/types.ts", "deprecated": false, diff --git a/api_docs/field_formats.mdx b/api_docs/field_formats.mdx index 47ac9e94ccb6f..0583d1db89a25 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: 2022-09-09 +date: 2022-09-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 00ef1834df39b..260869a64bd85 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload'] --- import fileUploadObj from './file_upload.devdocs.json'; diff --git a/api_docs/files.devdocs.json b/api_docs/files.devdocs.json index e8c6d117ab46a..faee578b74688 100644 --- a/api_docs/files.devdocs.json +++ b/api_docs/files.devdocs.json @@ -972,7 +972,7 @@ "\nAn elasticsearch client that will be used to interact with the cluster" ], "signature": [ - "{ get: { (this: That, params: ", + "{ name: string | symbol; get: { (this: That, params: ", "GetRequest", " | ", "GetRequest", @@ -1090,7 +1090,7 @@ "default", "; security: ", "default", - "; name: string | symbol; index: { (this: That, params: ", + "; index: { (this: That, params: ", "IndexRequest", " | ", "IndexRequest", diff --git a/api_docs/files.mdx b/api_docs/files.mdx index b94441baeff07..98d50b6c79efc 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'files'] --- import filesObj from './files.devdocs.json'; diff --git a/api_docs/fleet.devdocs.json b/api_docs/fleet.devdocs.json index 267549af75838..24e0f4dce933a 100644 --- a/api_docs/fleet.devdocs.json +++ b/api_docs/fleet.devdocs.json @@ -979,6 +979,37 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "fleet", + "id": "def-public.PackageGenericErrorsListProps", + "type": "Interface", + "tags": [], + "label": "PackageGenericErrorsListProps", + "description": [], + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-public.PackageGenericErrorsListProps.packageErrors", + "type": "Array", + "tags": [], + "label": "packageErrors", + "description": [ + "A list of errors from a package" + ], + "signature": [ + "FleetServerAgentComponentUnit", + "[]" + ], + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "fleet", "id": "def-public.PackagePolicyCreateExtension", @@ -1894,10 +1925,10 @@ "id": "def-public.UIExtensionsStorage.Unnamed", "type": "IndexSignature", "tags": [], - "label": "[key: string]: Partial>", + "label": "[key: string]: Partial>", "description": [], "signature": [ - "[key: string]: Partial | React.FunctionComponent<", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.PackageGenericErrorsListProps", + "text": "PackageGenericErrorsListProps" + }, + ">" + ], + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "fleet", "id": "def-public.PackagePolicyCreateExtensionComponent", @@ -2197,6 +2261,8 @@ "text": "PackageAssetsExtension" }, " | ", + "PackageGenericErrorsListExtension", + " | ", { "pluginId": "fleet", "scope": "public", @@ -2291,6 +2357,8 @@ "text": "PackageAssetsExtension" }, " | ", + "PackageGenericErrorsListExtension", + " | ", { "pluginId": "fleet", "scope": "public", @@ -2771,6 +2839,52 @@ ], "returnComment": [] }, + { + "parentPluginId": "fleet", + "id": "def-public.pagePathGetters.integration_details_api_reference", + "type": "Function", + "tags": [], + "label": "integration_details_api_reference", + "description": [], + "signature": [ + "({ pkgkey, integration }: ", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + }, + ") => [string, string]" + ], + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-public.pagePathGetters.integration_details_api_reference.$1", + "type": "Object", + "tags": [], + "label": "{ pkgkey, integration }", + "description": [], + "signature": [ + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + } + ], + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, { "parentPluginId": "fleet", "id": "def-public.pagePathGetters.integration_policy_edit", @@ -2865,6 +2979,54 @@ ], "returnComment": [] }, + { + "parentPluginId": "fleet", + "id": "def-public.pagePathGetters.integration_details_language_clients", + "type": "Function", + "tags": [], + "label": "integration_details_language_clients", + "description": [ + "// This route allows rendering custom language integration pages registered in the language_client plugin" + ], + "signature": [ + "({ pkgkey }: ", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + }, + ") => [string, string]" + ], + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-public.pagePathGetters.integration_details_language_clients.$1", + "type": "Object", + "tags": [], + "label": "{ pkgkey }", + "description": [], + "signature": [ + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + } + ], + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, { "parentPluginId": "fleet", "id": "def-public.pagePathGetters.policies", @@ -3555,6 +3717,8 @@ "text": "PackageAssetsExtension" }, " | ", + "PackageGenericErrorsListExtension", + " | ", { "pluginId": "fleet", "scope": "public", @@ -3608,7 +3772,7 @@ "text": "AgentNotFoundError" }, " extends ", - "IngestManagerError" + "FleetError" ], "path": "x-pack/plugins/fleet/server/errors/index.ts", "deprecated": false, @@ -3632,7 +3796,7 @@ "text": "FleetUnauthorizedError" }, " extends ", - "IngestManagerError" + "FleetError" ], "path": "x-pack/plugins/fleet/server/errors/index.ts", "deprecated": false, @@ -4784,6 +4948,26 @@ "path": "x-pack/plugins/fleet/server/plugin.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "fleet", + "id": "def-server.FleetSetupDeps.taskManager", + "type": "Object", + "tags": [], + "label": "taskManager", + "description": [], + "signature": [ + { + "pluginId": "taskManager", + "scope": "server", + "docId": "kibTaskManagerPluginApi", + "section": "def-server.TaskManagerSetupContract", + "text": "TaskManagerSetupContract" + } + ], + "path": "x-pack/plugins/fleet/server/plugin.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -5093,18 +5277,18 @@ }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface", + "id": "def-server.PackagePolicyClient", "type": "Interface", "tags": [], - "label": "PackagePolicyServiceInterface", + "label": "PackagePolicyClient", "description": [], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.create", + "id": "def-server.PackagePolicyClient.create", "type": "Function", "tags": [], "label": "create", @@ -5148,13 +5332,13 @@ }, ">" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.create.$1", + "id": "def-server.PackagePolicyClient.create.$1", "type": "Object", "tags": [], "label": "soClient", @@ -5162,14 +5346,14 @@ "signature": [ "SavedObjectsClientContract" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.create.$2", + "id": "def-server.PackagePolicyClient.create.$2", "type": "Object", "tags": [], "label": "esClient", @@ -5177,14 +5361,14 @@ "signature": [ "ElasticsearchClient" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.create.$3", + "id": "def-server.PackagePolicyClient.create.$3", "type": "Object", "tags": [], "label": "packagePolicy", @@ -5198,25 +5382,25 @@ "text": "NewPackagePolicy" } ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.create.$4", + "id": "def-server.PackagePolicyClient.create.$4", "type": "Object", "tags": [], "label": "options", "description": [], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.create.$4.spaceId", + "id": "def-server.PackagePolicyClient.create.$4.spaceId", "type": "string", "tags": [], "label": "spaceId", @@ -5224,13 +5408,13 @@ "signature": [ "string | undefined" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.create.$4.id", + "id": "def-server.PackagePolicyClient.create.$4.id", "type": "string", "tags": [], "label": "id", @@ -5238,13 +5422,13 @@ "signature": [ "string | undefined" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.create.$4.user", + "id": "def-server.PackagePolicyClient.create.$4.user", "type": "Object", "tags": [], "label": "user", @@ -5259,13 +5443,13 @@ }, " | undefined" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.create.$4.bumpRevision", + "id": "def-server.PackagePolicyClient.create.$4.bumpRevision", "type": "CompoundType", "tags": [], "label": "bumpRevision", @@ -5273,13 +5457,13 @@ "signature": [ "boolean | undefined" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.create.$4.force", + "id": "def-server.PackagePolicyClient.create.$4.force", "type": "CompoundType", "tags": [], "label": "force", @@ -5287,13 +5471,13 @@ "signature": [ "boolean | undefined" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.create.$4.skipEnsureInstalled", + "id": "def-server.PackagePolicyClient.create.$4.skipEnsureInstalled", "type": "CompoundType", "tags": [], "label": "skipEnsureInstalled", @@ -5301,13 +5485,13 @@ "signature": [ "boolean | undefined" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.create.$4.skipUniqueNameVerification", + "id": "def-server.PackagePolicyClient.create.$4.skipUniqueNameVerification", "type": "CompoundType", "tags": [], "label": "skipUniqueNameVerification", @@ -5315,13 +5499,13 @@ "signature": [ "boolean | undefined" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.create.$4.overwrite", + "id": "def-server.PackagePolicyClient.create.$4.overwrite", "type": "CompoundType", "tags": [], "label": "overwrite", @@ -5329,13 +5513,13 @@ "signature": [ "boolean | undefined" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.create.$4.packageInfo", + "id": "def-server.PackagePolicyClient.create.$4.packageInfo", "type": "CompoundType", "tags": [], "label": "packageInfo", @@ -5350,7 +5534,7 @@ }, " | undefined" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false } @@ -5361,7 +5545,7 @@ }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.bulkCreate", + "id": "def-server.PackagePolicyClient.bulkCreate", "type": "Function", "tags": [], "label": "bulkCreate", @@ -5372,14 +5556,8 @@ ", esClient: ", "ElasticsearchClient", ", packagePolicies: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.NewPackagePolicy", - "text": "NewPackagePolicy" - }, - "[], agentPolicyId: string, options?: { user?: ", + "NewPackagePolicyWithId", + "[], options?: { user?: ", { "pluginId": "security", "scope": "common", @@ -5387,7 +5565,7 @@ "section": "def-common.AuthenticatedUser", "text": "AuthenticatedUser" }, - " | undefined; bumpRevision?: boolean | undefined; } | undefined) => Promise<", + " | undefined; bumpRevision?: boolean | undefined; force?: true | undefined; } | undefined) => Promise<", { "pluginId": "fleet", "scope": "common", @@ -5397,13 +5575,13 @@ }, "[]>" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.bulkCreate.$1", + "id": "def-server.PackagePolicyClient.bulkCreate.$1", "type": "Object", "tags": [], "label": "soClient", @@ -5411,14 +5589,14 @@ "signature": [ "SavedObjectsClientContract" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.bulkCreate.$2", + "id": "def-server.PackagePolicyClient.bulkCreate.$2", "type": "Object", "tags": [], "label": "esClient", @@ -5426,62 +5604,41 @@ "signature": [ "ElasticsearchClient" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.bulkCreate.$3", + "id": "def-server.PackagePolicyClient.bulkCreate.$3", "type": "Array", "tags": [], "label": "packagePolicies", "description": [], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.NewPackagePolicy", - "text": "NewPackagePolicy" - }, + "NewPackagePolicyWithId", "[]" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.bulkCreate.$4", - "type": "string", - "tags": [], - "label": "agentPolicyId", - "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.bulkCreate.$5", + "id": "def-server.PackagePolicyClient.bulkCreate.$4", "type": "Object", "tags": [], "label": "options", "description": [], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.bulkCreate.$5.user", + "id": "def-server.PackagePolicyClient.bulkCreate.$4.user", "type": "Object", "tags": [], "label": "user", @@ -5496,13 +5653,13 @@ }, " | undefined" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.bulkCreate.$5.bumpRevision", + "id": "def-server.PackagePolicyClient.bulkCreate.$4.bumpRevision", "type": "CompoundType", "tags": [], "label": "bumpRevision", @@ -5510,7 +5667,21 @@ "signature": [ "boolean | undefined" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "fleet", + "id": "def-server.PackagePolicyClient.bulkCreate.$4.force", + "type": "boolean", + "tags": [], + "label": "force", + "description": [], + "signature": [ + "true | undefined" + ], + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false } @@ -5521,7 +5692,7 @@ }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.get", + "id": "def-server.PackagePolicyClient.get", "type": "Function", "tags": [], "label": "get", @@ -5539,13 +5710,13 @@ }, " | null>" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.get.$1", + "id": "def-server.PackagePolicyClient.get.$1", "type": "Object", "tags": [], "label": "soClient", @@ -5553,14 +5724,14 @@ "signature": [ "SavedObjectsClientContract" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.get.$2", + "id": "def-server.PackagePolicyClient.get.$2", "type": "string", "tags": [], "label": "id", @@ -5568,7 +5739,7 @@ "signature": [ "string" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -5578,7 +5749,7 @@ }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.findAllForAgentPolicy", + "id": "def-server.PackagePolicyClient.findAllForAgentPolicy", "type": "Function", "tags": [], "label": "findAllForAgentPolicy", @@ -5596,13 +5767,13 @@ }, "[]>" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.findAllForAgentPolicy.$1", + "id": "def-server.PackagePolicyClient.findAllForAgentPolicy.$1", "type": "Object", "tags": [], "label": "soClient", @@ -5610,14 +5781,14 @@ "signature": [ "SavedObjectsClientContract" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.findAllForAgentPolicy.$2", + "id": "def-server.PackagePolicyClient.findAllForAgentPolicy.$2", "type": "string", "tags": [], "label": "agentPolicyId", @@ -5625,7 +5796,7 @@ "signature": [ "string" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -5635,7 +5806,7 @@ }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.getByIDs", + "id": "def-server.PackagePolicyClient.getByIDs", "type": "Function", "tags": [], "label": "getByIDs", @@ -5653,13 +5824,13 @@ }, "[] | null>" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.getByIDs.$1", + "id": "def-server.PackagePolicyClient.getByIDs.$1", "type": "Object", "tags": [], "label": "soClient", @@ -5667,14 +5838,14 @@ "signature": [ "SavedObjectsClientContract" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.getByIDs.$2", + "id": "def-server.PackagePolicyClient.getByIDs.$2", "type": "Array", "tags": [], "label": "ids", @@ -5682,25 +5853,25 @@ "signature": [ "string[]" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.getByIDs.$3", + "id": "def-server.PackagePolicyClient.getByIDs.$3", "type": "Object", "tags": [], "label": "options", "description": [], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.getByIDs.$3.ignoreMissing", + "id": "def-server.PackagePolicyClient.getByIDs.$3.ignoreMissing", "type": "CompoundType", "tags": [], "label": "ignoreMissing", @@ -5708,7 +5879,7 @@ "signature": [ "boolean | undefined" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false } @@ -5719,7 +5890,7 @@ }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.list", + "id": "def-server.PackagePolicyClient.list", "type": "Function", "tags": [], "label": "list", @@ -5753,13 +5924,13 @@ }, ">>" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.list.$1", + "id": "def-server.PackagePolicyClient.list.$1", "type": "Object", "tags": [], "label": "soClient", @@ -5767,14 +5938,14 @@ "signature": [ "SavedObjectsClientContract" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.list.$2", + "id": "def-server.PackagePolicyClient.list.$2", "type": "Object", "tags": [], "label": "options", @@ -5788,7 +5959,7 @@ "text": "ListWithKuery" } ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -5798,7 +5969,7 @@ }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.listIds", + "id": "def-server.PackagePolicyClient.listIds", "type": "Function", "tags": [], "label": "listIds", @@ -5824,13 +5995,13 @@ }, ">" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.listIds.$1", + "id": "def-server.PackagePolicyClient.listIds.$1", "type": "Object", "tags": [], "label": "soClient", @@ -5838,14 +6009,14 @@ "signature": [ "SavedObjectsClientContract" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.listIds.$2", + "id": "def-server.PackagePolicyClient.listIds.$2", "type": "Object", "tags": [], "label": "options", @@ -5859,7 +6030,7 @@ "text": "ListWithKuery" } ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -5869,7 +6040,7 @@ }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.update", + "id": "def-server.PackagePolicyClient.update", "type": "Function", "tags": [], "label": "update", @@ -5905,13 +6076,13 @@ }, ">" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.update.$1", + "id": "def-server.PackagePolicyClient.update.$1", "type": "Object", "tags": [], "label": "soClient", @@ -5919,14 +6090,14 @@ "signature": [ "SavedObjectsClientContract" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.update.$2", + "id": "def-server.PackagePolicyClient.update.$2", "type": "Object", "tags": [], "label": "esClient", @@ -5934,14 +6105,14 @@ "signature": [ "ElasticsearchClient" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.update.$3", + "id": "def-server.PackagePolicyClient.update.$3", "type": "string", "tags": [], "label": "id", @@ -5949,14 +6120,14 @@ "signature": [ "string" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.update.$4", + "id": "def-server.PackagePolicyClient.update.$4", "type": "Object", "tags": [], "label": "packagePolicyUpdate", @@ -5970,25 +6141,25 @@ "text": "UpdatePackagePolicy" } ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.update.$5", + "id": "def-server.PackagePolicyClient.update.$5", "type": "Object", "tags": [], "label": "options", "description": [], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.update.$5.user", + "id": "def-server.PackagePolicyClient.update.$5.user", "type": "Object", "tags": [], "label": "user", @@ -6003,13 +6174,13 @@ }, " | undefined" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.update.$5.force", + "id": "def-server.PackagePolicyClient.update.$5.force", "type": "CompoundType", "tags": [], "label": "force", @@ -6017,7 +6188,7 @@ "signature": [ "boolean | undefined" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false } @@ -6025,7 +6196,7 @@ }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.update.$6", + "id": "def-server.PackagePolicyClient.update.$6", "type": "string", "tags": [], "label": "currentVersion", @@ -6033,7 +6204,7 @@ "signature": [ "string | undefined" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": false @@ -6043,7 +6214,7 @@ }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.delete", + "id": "def-server.PackagePolicyClient.delete", "type": "Function", "tags": [], "label": "delete", @@ -6071,13 +6242,13 @@ }, ">" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.delete.$1", + "id": "def-server.PackagePolicyClient.delete.$1", "type": "Object", "tags": [], "label": "soClient", @@ -6085,14 +6256,14 @@ "signature": [ "SavedObjectsClientContract" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.delete.$2", + "id": "def-server.PackagePolicyClient.delete.$2", "type": "Object", "tags": [], "label": "esClient", @@ -6100,14 +6271,14 @@ "signature": [ "ElasticsearchClient" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.delete.$3", + "id": "def-server.PackagePolicyClient.delete.$3", "type": "Array", "tags": [], "label": "ids", @@ -6115,25 +6286,25 @@ "signature": [ "string[]" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.delete.$4", + "id": "def-server.PackagePolicyClient.delete.$4", "type": "Object", "tags": [], "label": "options", "description": [], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.delete.$4.user", + "id": "def-server.PackagePolicyClient.delete.$4.user", "type": "Object", "tags": [], "label": "user", @@ -6148,13 +6319,13 @@ }, " | undefined" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.delete.$4.skipUnassignFromAgentPolicies", + "id": "def-server.PackagePolicyClient.delete.$4.skipUnassignFromAgentPolicies", "type": "CompoundType", "tags": [], "label": "skipUnassignFromAgentPolicies", @@ -6162,13 +6333,13 @@ "signature": [ "boolean | undefined" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.delete.$4.force", + "id": "def-server.PackagePolicyClient.delete.$4.force", "type": "CompoundType", "tags": [], "label": "force", @@ -6176,7 +6347,7 @@ "signature": [ "boolean | undefined" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false } @@ -6187,7 +6358,7 @@ }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.upgrade", + "id": "def-server.PackagePolicyClient.upgrade", "type": "Function", "tags": [], "label": "upgrade", @@ -6223,13 +6394,13 @@ }, ">" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.upgrade.$1", + "id": "def-server.PackagePolicyClient.upgrade.$1", "type": "Object", "tags": [], "label": "soClient", @@ -6237,14 +6408,14 @@ "signature": [ "SavedObjectsClientContract" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.upgrade.$2", + "id": "def-server.PackagePolicyClient.upgrade.$2", "type": "Object", "tags": [], "label": "esClient", @@ -6252,14 +6423,14 @@ "signature": [ "ElasticsearchClient" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.upgrade.$3", + "id": "def-server.PackagePolicyClient.upgrade.$3", "type": "Array", "tags": [], "label": "ids", @@ -6267,25 +6438,25 @@ "signature": [ "string[]" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.upgrade.$4", + "id": "def-server.PackagePolicyClient.upgrade.$4", "type": "Object", "tags": [], "label": "options", "description": [], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.upgrade.$4.user", + "id": "def-server.PackagePolicyClient.upgrade.$4.user", "type": "Object", "tags": [], "label": "user", @@ -6300,7 +6471,7 @@ }, " | undefined" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false } @@ -6308,7 +6479,7 @@ }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.upgrade.$5", + "id": "def-server.PackagePolicyClient.upgrade.$5", "type": "Object", "tags": [], "label": "packagePolicy", @@ -6323,14 +6494,14 @@ }, " | undefined" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": false }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.upgrade.$6", + "id": "def-server.PackagePolicyClient.upgrade.$6", "type": "string", "tags": [], "label": "pkgVersion", @@ -6338,7 +6509,7 @@ "signature": [ "string | undefined" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": false @@ -6348,7 +6519,7 @@ }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.getUpgradeDryRunDiff", + "id": "def-server.PackagePolicyClient.getUpgradeDryRunDiff", "type": "Function", "tags": [], "label": "getUpgradeDryRunDiff", @@ -6374,13 +6545,13 @@ }, ">" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.getUpgradeDryRunDiff.$1", + "id": "def-server.PackagePolicyClient.getUpgradeDryRunDiff.$1", "type": "Object", "tags": [], "label": "soClient", @@ -6388,14 +6559,14 @@ "signature": [ "SavedObjectsClientContract" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.getUpgradeDryRunDiff.$2", + "id": "def-server.PackagePolicyClient.getUpgradeDryRunDiff.$2", "type": "string", "tags": [], "label": "id", @@ -6403,14 +6574,14 @@ "signature": [ "string" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.getUpgradeDryRunDiff.$3", + "id": "def-server.PackagePolicyClient.getUpgradeDryRunDiff.$3", "type": "Object", "tags": [], "label": "packagePolicy", @@ -6425,14 +6596,14 @@ }, " | undefined" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": false }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.getUpgradeDryRunDiff.$4", + "id": "def-server.PackagePolicyClient.getUpgradeDryRunDiff.$4", "type": "string", "tags": [], "label": "pkgVersion", @@ -6440,7 +6611,7 @@ "signature": [ "string | undefined" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": false @@ -6450,7 +6621,7 @@ }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.enrichPolicyWithDefaultsFromPackage", + "id": "def-server.PackagePolicyClient.enrichPolicyWithDefaultsFromPackage", "type": "Function", "tags": [], "label": "enrichPolicyWithDefaultsFromPackage", @@ -6476,13 +6647,13 @@ }, ">" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.enrichPolicyWithDefaultsFromPackage.$1", + "id": "def-server.PackagePolicyClient.enrichPolicyWithDefaultsFromPackage.$1", "type": "Object", "tags": [], "label": "soClient", @@ -6490,14 +6661,14 @@ "signature": [ "SavedObjectsClientContract" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.enrichPolicyWithDefaultsFromPackage.$2", + "id": "def-server.PackagePolicyClient.enrichPolicyWithDefaultsFromPackage.$2", "type": "Object", "tags": [], "label": "newPolicy", @@ -6511,7 +6682,7 @@ "text": "NewPackagePolicy" } ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -6521,7 +6692,7 @@ }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.buildPackagePolicyFromPackage", + "id": "def-server.PackagePolicyClient.buildPackagePolicyFromPackage", "type": "Function", "tags": [], "label": "buildPackagePolicyFromPackage", @@ -6541,13 +6712,13 @@ }, " | undefined>" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.buildPackagePolicyFromPackage.$1", + "id": "def-server.PackagePolicyClient.buildPackagePolicyFromPackage.$1", "type": "Object", "tags": [], "label": "soClient", @@ -6555,14 +6726,14 @@ "signature": [ "SavedObjectsClientContract" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.buildPackagePolicyFromPackage.$2", + "id": "def-server.PackagePolicyClient.buildPackagePolicyFromPackage.$2", "type": "string", "tags": [], "label": "pkgName", @@ -6570,14 +6741,14 @@ "signature": [ "string" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.buildPackagePolicyFromPackage.$3", + "id": "def-server.PackagePolicyClient.buildPackagePolicyFromPackage.$3", "type": "Object", "tags": [], "label": "logger", @@ -6586,7 +6757,7 @@ "Logger", " | undefined" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": false @@ -6596,7 +6767,7 @@ }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.runExternalCallbacks", + "id": "def-server.PackagePolicyClient.runExternalCallbacks", "type": "Function", "tags": [], "label": "runExternalCallbacks", @@ -6654,13 +6825,13 @@ }, ">" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.runExternalCallbacks.$1", + "id": "def-server.PackagePolicyClient.runExternalCallbacks.$1", "type": "Uncategorized", "tags": [], "label": "externalCallbackType", @@ -6668,14 +6839,14 @@ "signature": [ "A" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.runExternalCallbacks.$2", + "id": "def-server.PackagePolicyClient.runExternalCallbacks.$2", "type": "Uncategorized", "tags": [], "label": "packagePolicy", @@ -6706,14 +6877,14 @@ "text": "NewPackagePolicy" } ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.runExternalCallbacks.$3", + "id": "def-server.PackagePolicyClient.runExternalCallbacks.$3", "type": "Object", "tags": [], "label": "context", @@ -6727,14 +6898,14 @@ "text": "RequestHandlerContext" } ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.runExternalCallbacks.$4", + "id": "def-server.PackagePolicyClient.runExternalCallbacks.$4", "type": "Object", "tags": [], "label": "request", @@ -6743,7 +6914,7 @@ "KibanaRequest", "" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -6753,7 +6924,7 @@ }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.runDeleteExternalCallbacks", + "id": "def-server.PackagePolicyClient.runDeleteExternalCallbacks", "type": "Function", "tags": [], "label": "runDeleteExternalCallbacks", @@ -6769,13 +6940,13 @@ }, ") => Promise" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.runDeleteExternalCallbacks.$1", + "id": "def-server.PackagePolicyClient.runDeleteExternalCallbacks.$1", "type": "Array", "tags": [], "label": "deletedPackagePolicies", @@ -6789,7 +6960,7 @@ "text": "DeletePackagePoliciesResponse" } ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -6799,7 +6970,7 @@ }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.getUpgradePackagePolicyInfo", + "id": "def-server.PackagePolicyClient.getUpgradePackagePolicyInfo", "type": "Function", "tags": [], "label": "getUpgradePackagePolicyInfo", @@ -6823,15 +6994,17 @@ "section": "def-common.PackageInfo", "text": "PackageInfo" }, - "; }>" + "; experimentalDataStreamFeatures: ", + "ExperimentalDataStreamFeature", + "[]; }>" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.getUpgradePackagePolicyInfo.$1", + "id": "def-server.PackagePolicyClient.getUpgradePackagePolicyInfo.$1", "type": "Object", "tags": [], "label": "soClient", @@ -6839,14 +7012,14 @@ "signature": [ "SavedObjectsClientContract" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "fleet", - "id": "def-server.PackagePolicyServiceInterface.getUpgradePackagePolicyInfo.$2", + "id": "def-server.PackagePolicyClient.getUpgradePackagePolicyInfo.$2", "type": "string", "tags": [], "label": "id", @@ -6854,7 +7027,7 @@ "signature": [ "string" ], - "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "path": "x-pack/plugins/fleet/server/services/package_policy_service.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -7492,8 +7665,8 @@ "pluginId": "fleet", "scope": "server", "docId": "kibFleetPluginApi", - "section": "def-server.PackagePolicyServiceInterface", - "text": "PackagePolicyServiceInterface" + "section": "def-server.PackagePolicyClient", + "text": "PackagePolicyClient" } ], "path": "x-pack/plugins/fleet/server/plugin.ts", @@ -10495,6 +10668,20 @@ "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.Installation.experimental_data_stream_features", + "type": "Array", + "tags": [], + "label": "experimental_data_stream_features", + "description": [], + "signature": [ + "{ data_stream: string; features: Record<\"synthetic_source\", boolean>; }[] | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -11501,6 +11688,21 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "fleet", + "id": "def-common.NewPackagePolicyInputStream.release", + "type": "CompoundType", + "tags": [], + "label": "release", + "description": [], + "signature": [ + "RegistryRelease", + " | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "fleet", "id": "def-common.NewPackagePolicyInputStream.vars", @@ -11901,6 +12103,21 @@ "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.PackagePolicyPackage.experimental_data_stream_features", + "type": "Array", + "tags": [], + "label": "experimental_data_stream_features", + "description": [], + "signature": [ + "ExperimentalDataStreamFeature", + "[] | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "deprecated": false, + "trackAdoption": false } ], "initialIsOpen": false @@ -12055,12 +12272,12 @@ { "parentPluginId": "fleet", "id": "def-common.PackageSpecManifest.type", - "type": "string", + "type": "CompoundType", "tags": [], "label": "type", "description": [], "signature": [ - "\"integration\" | undefined" + "\"input\" | \"integration\" | undefined" ], "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "deprecated": false, @@ -12430,10 +12647,13 @@ { "parentPluginId": "fleet", "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.release", - "type": "string", + "type": "CompoundType", "tags": [], "label": "[RegistryDataStreamKeys.release]", "description": [], + "signature": [ + "\"experimental\" | \"beta\" | \"ga\"" + ], "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false, "trackAdoption": false @@ -12813,180 +13033,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryPolicyTemplate", - "type": "Interface", - "tags": [], - "label": "RegistryPolicyTemplate", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.name", - "type": "string", - "tags": [], - "label": "[RegistryPolicyTemplateKeys.name]", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.title", - "type": "string", - "tags": [], - "label": "[RegistryPolicyTemplateKeys.title]", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.description", - "type": "string", - "tags": [], - "label": "[RegistryPolicyTemplateKeys.description]", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.icons", - "type": "Array", - "tags": [], - "label": "[RegistryPolicyTemplateKeys.icons]", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.RegistryImage", - "text": "RegistryImage" - }, - "[] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.screenshots", - "type": "Array", - "tags": [], - "label": "[RegistryPolicyTemplateKeys.screenshots]", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.RegistryImage", - "text": "RegistryImage" - }, - "[] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.categories", - "type": "Array", - "tags": [], - "label": "[RegistryPolicyTemplateKeys.categories]", - "description": [], - "signature": [ - "(", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageSpecCategory", - "text": "PackageSpecCategory" - }, - " | undefined)[] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.data_streams", - "type": "Array", - "tags": [], - "label": "[RegistryPolicyTemplateKeys.data_streams]", - "description": [], - "signature": [ - "string[] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.inputs", - "type": "Array", - "tags": [], - "label": "[RegistryPolicyTemplateKeys.inputs]", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.RegistryInput", - "text": "RegistryInput" - }, - "[] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.readme", - "type": "string", - "tags": [], - "label": "[RegistryPolicyTemplateKeys.readme]", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.multiple", - "type": "CompoundType", - "tags": [], - "label": "[RegistryPolicyTemplateKeys.multiple]", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "fleet", "id": "def-common.RegistryStream", @@ -14895,6 +14941,23 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "fleet", + "id": "def-common.RegistryPolicyTemplate", + "type": "Type", + "tags": [], + "label": "RegistryPolicyTemplate", + "description": [], + "signature": [ + "RegistryPolicyIntegrationTemplate", + " | ", + "RegistryPolicyInputOnlyTemplate" + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "fleet", "id": "def-common.RegistrySearchResult", @@ -14903,7 +14966,7 @@ "label": "RegistrySearchResult", "description": [], "signature": [ - "{ type?: \"integration\" | undefined; path: string; download: string; title: string; description: string; icons?: (", + "{ name: string; description: string; type?: \"input\" | \"integration\" | undefined; path: string; download: string; title: string; icons?: (", { "pluginId": "fleet", "scope": "common", @@ -14927,7 +14990,7 @@ "section": "def-common.PackageSpecCategory", "text": "PackageSpecCategory" }, - " | undefined)[] | undefined; name: string; version: string; internal?: boolean | undefined; release?: \"experimental\" | \"beta\" | \"ga\" | undefined; policy_templates?: ", + " | undefined)[] | undefined; version: string; internal?: boolean | undefined; release?: \"experimental\" | \"beta\" | \"ga\" | undefined; policy_templates?: ", { "pluginId": "fleet", "scope": "common", @@ -15255,6 +15318,17 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "fleet", + "id": "def-common.AGENT_API_ROUTES.ACTION_STATUS_PATTERN", + "type": "string", + "tags": [], + "label": "ACTION_STATUS_PATTERN", + "description": [], + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "fleet", "id": "def-common.AGENT_API_ROUTES.LIST_TAGS_PATTERN", @@ -15950,6 +16024,22 @@ "children": [], "returnComment": [] }, + { + "parentPluginId": "fleet", + "id": "def-common.agentRouteService.getActionStatusPath", + "type": "Function", + "tags": [], + "label": "getActionStatusPath", + "description": [], + "signature": [ + "() => string" + ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + }, { "parentPluginId": "fleet", "id": "def-common.agentRouteService.getCurrentUpgradesPath", @@ -16759,6 +16849,21 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "fleet", + "id": "def-common.INVALID_NAMESPACE_CHARACTERS", + "type": "Object", + "tags": [], + "label": "INVALID_NAMESPACE_CHARACTERS", + "description": [], + "signature": [ + "RegExp" + ], + "path": "x-pack/plugins/fleet/common/services/is_valid_namespace.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "fleet", "id": "def-common.PACKAGE_POLICY_API_ROUTES", diff --git a/api_docs/fleet.mdx b/api_docs/fleet.mdx index 212a823589def..398f9e82fd03a 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet'] --- import fleetObj from './fleet.devdocs.json'; @@ -21,7 +21,7 @@ Contact [Fleet](https://github.com/orgs/elastic/teams/fleet) for questions regar | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 970 | 3 | 873 | 10 | +| 974 | 3 | 874 | 17 | ## Client diff --git a/api_docs/global_search.devdocs.json b/api_docs/global_search.devdocs.json index da9062f69079a..6dfe6c66b672b 100644 --- a/api_docs/global_search.devdocs.json +++ b/api_docs/global_search.devdocs.json @@ -654,13 +654,7 @@ "; typeRegistry: ", "ISavedObjectTypeRegistry", "; }; uiSettings: { client: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IUiSettingsClient", - "text": "IUiSettingsClient" - }, + "IUiSettingsClient", "; }; capabilities: ", "Observable", "<", diff --git a/api_docs/global_search.mdx b/api_docs/global_search.mdx index 151db33c2bbd0..c71484128ec3b 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch'] --- import globalSearchObj from './global_search.devdocs.json'; diff --git a/api_docs/guided_onboarding.devdocs.json b/api_docs/guided_onboarding.devdocs.json new file mode 100644 index 0000000000000..27b0b8446a7d8 --- /dev/null +++ b/api_docs/guided_onboarding.devdocs.json @@ -0,0 +1,208 @@ +{ + "id": "guidedOnboarding", + "client": { + "classes": [], + "functions": [], + "interfaces": [ + { + "parentPluginId": "guidedOnboarding", + "id": "def-public.GuidedOnboardingState", + "type": "Interface", + "tags": [], + "label": "GuidedOnboardingState", + "description": [], + "path": "src/plugins/guided_onboarding/public/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "guidedOnboarding", + "id": "def-public.GuidedOnboardingState.activeGuide", + "type": "CompoundType", + "tags": [], + "label": "activeGuide", + "description": [], + "signature": [ + { + "pluginId": "guidedOnboarding", + "scope": "public", + "docId": "kibGuidedOnboardingPluginApi", + "section": "def-public.UseCase", + "text": "UseCase" + }, + " | \"unset\"" + ], + "path": "src/plugins/guided_onboarding/public/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "guidedOnboarding", + "id": "def-public.GuidedOnboardingState.activeStep", + "type": "string", + "tags": [], + "label": "activeStep", + "description": [], + "path": "src/plugins/guided_onboarding/public/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "guidedOnboarding", + "id": "def-public.UseCase", + "type": "Type", + "tags": [], + "label": "UseCase", + "description": [], + "signature": [ + "\"search\" | \"security\" | \"observability\"" + ], + "path": "src/plugins/guided_onboarding/public/types.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], + "objects": [], + "setup": { + "parentPluginId": "guidedOnboarding", + "id": "def-public.GuidedOnboardingPluginSetup", + "type": "Interface", + "tags": [], + "label": "GuidedOnboardingPluginSetup", + "description": [], + "path": "src/plugins/guided_onboarding/public/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "parentPluginId": "guidedOnboarding", + "id": "def-public.GuidedOnboardingPluginStart", + "type": "Interface", + "tags": [], + "label": "GuidedOnboardingPluginStart", + "description": [], + "path": "src/plugins/guided_onboarding/public/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "guidedOnboarding", + "id": "def-public.GuidedOnboardingPluginStart.guidedOnboardingApi", + "type": "Object", + "tags": [], + "label": "guidedOnboardingApi", + "description": [], + "signature": [ + "ApiService", + " | undefined" + ], + "path": "src/plugins/guided_onboarding/public/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "lifecycle": "start", + "initialIsOpen": true + } + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [], + "setup": { + "parentPluginId": "guidedOnboarding", + "id": "def-server.GuidedOnboardingPluginSetup", + "type": "Interface", + "tags": [], + "label": "GuidedOnboardingPluginSetup", + "description": [], + "path": "src/plugins/guided_onboarding/server/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "parentPluginId": "guidedOnboarding", + "id": "def-server.GuidedOnboardingPluginStart", + "type": "Interface", + "tags": [], + "label": "GuidedOnboardingPluginStart", + "description": [], + "path": "src/plugins/guided_onboarding/server/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "lifecycle": "start", + "initialIsOpen": true + } + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [ + { + "parentPluginId": "guidedOnboarding", + "id": "def-common.API_BASE_PATH", + "type": "string", + "tags": [], + "label": "API_BASE_PATH", + "description": [], + "signature": [ + "\"/api/guided_onboarding\"" + ], + "path": "src/plugins/guided_onboarding/common/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "guidedOnboarding", + "id": "def-common.PLUGIN_ID", + "type": "string", + "tags": [], + "label": "PLUGIN_ID", + "description": [], + "signature": [ + "\"guidedOnboarding\"" + ], + "path": "src/plugins/guided_onboarding/common/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "guidedOnboarding", + "id": "def-common.PLUGIN_NAME", + "type": "string", + "tags": [], + "label": "PLUGIN_NAME", + "description": [], + "signature": [ + "\"guidedOnboarding\"" + ], + "path": "src/plugins/guided_onboarding/common/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/guided_onboarding.mdx b/api_docs/guided_onboarding.mdx new file mode 100644 index 0000000000000..e7625a590a461 --- /dev/null +++ b/api_docs/guided_onboarding.mdx @@ -0,0 +1,52 @@ +--- +#### +#### This 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: kibGuidedOnboardingPluginApi +slug: /kibana-dev-docs/api/guidedOnboarding +title: "guidedOnboarding" +image: https://source.unsplash.com/400x175/?github +description: API docs for the guidedOnboarding plugin +date: 2022-09-20 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'guidedOnboarding'] +--- +import guidedOnboardingObj from './guided_onboarding.devdocs.json'; + +Guided onboarding framework + +Contact [Journey Onboarding](https://github.com/orgs/elastic/teams/platform-onboarding) for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 12 | 0 | 12 | 1 | + +## Client + +### Setup + + +### Start + + +### Interfaces + + +### Consts, variables and types + + +## Server + +### Setup + + +### Start + + +## Common + +### Consts, variables and types + + diff --git a/api_docs/home.devdocs.json b/api_docs/home.devdocs.json index fb0744959b803..c8e980ff0a0ab 100644 --- a/api_docs/home.devdocs.json +++ b/api_docs/home.devdocs.json @@ -1738,7 +1738,7 @@ "signature": [ "{ getSampleDatasets: () => ", "Writable", - "[]; previewImagePath: string; overviewDashboard: string; defaultIndex: string; dataIndices: Readonly<{} & { id: string; fields: Record; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ", + "[]; previewImagePath: string; overviewDashboard: string; defaultIndex: string; dataIndices: Readonly<{} & { id: string; fields: Record; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ", "SavedObject", "[]) => void; addAppLinksToSampleDataset: (id: string, appLinks: ", { @@ -1773,7 +1773,7 @@ "signature": [ "() => ", "Writable", - "[]; previewImagePath: string; overviewDashboard: string; defaultIndex: string; dataIndices: Readonly<{} & { id: string; fields: Record; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>" + "[]; previewImagePath: string; overviewDashboard: string; defaultIndex: string; dataIndices: Readonly<{} & { id: string; fields: Record; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>" ], "path": "src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts", "deprecated": false, @@ -1830,7 +1830,7 @@ "section": "def-server.TutorialContext", "text": "TutorialContext" }, - ") => Readonly<{ isBeta?: boolean | undefined; savedObjects?: any[] | undefined; euiIconType?: string | undefined; previewImagePath?: string | undefined; moduleName?: string | undefined; completionTimeMinutes?: number | undefined; elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; artifacts?: Readonly<{ application?: Readonly<{} & { path: string; label: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; savedObjectsInstallMsg?: string | undefined; customStatusCheckName?: string | undefined; integrationBrowserCategories?: string[] | undefined; eprPackageOverlap?: string | undefined; } & { id: string; name: string; category: \"other\" | \"security\" | \"metrics\" | \"logging\"; shortDescription: string; longDescription: string; onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }>" + ") => Readonly<{ isBeta?: boolean | undefined; savedObjects?: any[] | undefined; euiIconType?: string | undefined; previewImagePath?: string | undefined; moduleName?: string | undefined; completionTimeMinutes?: number | undefined; elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; artifacts?: Readonly<{ application?: Readonly<{} & { path: string; label: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; savedObjectsInstallMsg?: string | undefined; customStatusCheckName?: string | undefined; integrationBrowserCategories?: string[] | undefined; eprPackageOverlap?: string | undefined; } & { name: string; category: \"other\" | \"security\" | \"metrics\" | \"logging\"; id: string; shortDescription: string; longDescription: string; onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }>" ], "path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts", "deprecated": false, @@ -1868,7 +1868,7 @@ "label": "TutorialSchema", "description": [], "signature": [ - "{ readonly isBeta?: boolean | undefined; readonly savedObjects?: any[] | undefined; readonly euiIconType?: string | undefined; readonly previewImagePath?: string | undefined; readonly moduleName?: string | undefined; readonly completionTimeMinutes?: number | undefined; readonly elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly artifacts?: Readonly<{ application?: Readonly<{} & { path: string; label: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; readonly savedObjectsInstallMsg?: string | undefined; readonly customStatusCheckName?: string | undefined; readonly integrationBrowserCategories?: string[] | undefined; readonly eprPackageOverlap?: string | undefined; readonly id: string; readonly name: string; readonly category: \"other\" | \"security\" | \"metrics\" | \"logging\"; readonly shortDescription: string; readonly longDescription: string; readonly onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }" + "{ readonly isBeta?: boolean | undefined; readonly savedObjects?: any[] | undefined; readonly euiIconType?: string | undefined; readonly previewImagePath?: string | undefined; readonly moduleName?: string | undefined; readonly completionTimeMinutes?: number | undefined; readonly elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly artifacts?: Readonly<{ application?: Readonly<{} & { path: string; label: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; readonly savedObjectsInstallMsg?: string | undefined; readonly customStatusCheckName?: string | undefined; readonly integrationBrowserCategories?: string[] | undefined; readonly eprPackageOverlap?: string | undefined; readonly name: string; readonly category: \"other\" | \"security\" | \"metrics\" | \"logging\"; readonly id: string; readonly shortDescription: string; readonly longDescription: string; readonly onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }" ], "path": "src/plugins/home/server/services/tutorials/lib/tutorial_schema.ts", "deprecated": false, @@ -2160,7 +2160,7 @@ "signature": [ "{ getSampleDatasets: () => ", "Writable", - "[]; previewImagePath: string; overviewDashboard: string; defaultIndex: string; dataIndices: Readonly<{} & { id: string; fields: Record; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ", + "[]; previewImagePath: string; overviewDashboard: string; defaultIndex: string; dataIndices: Readonly<{} & { id: string; fields: Record; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ", "SavedObject", "[]) => void; addAppLinksToSampleDataset: (id: string, appLinks: ", { diff --git a/api_docs/home.mdx b/api_docs/home.mdx index 0633e4a824850..381a739739e54 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'home'] --- import homeObj from './home.devdocs.json'; diff --git a/api_docs/index_lifecycle_management.mdx b/api_docs/index_lifecycle_management.mdx index 7cd6a257eeca1..ed831349e52bd 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexLifecycleManagement'] --- import indexLifecycleManagementObj from './index_lifecycle_management.devdocs.json'; diff --git a/api_docs/index_management.mdx b/api_docs/index_management.mdx index b83bcf59070e4..c8af6660752e5 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement'] --- import indexManagementObj from './index_management.devdocs.json'; diff --git a/api_docs/infra.mdx b/api_docs/infra.mdx index 05616b0cfadc4..27f5c3569fa49 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'infra'] --- import infraObj from './infra.devdocs.json'; diff --git a/api_docs/inspector.mdx b/api_docs/inspector.mdx index 8454800519cb0..18fb173160a21 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: 2022-09-09 +date: 2022-09-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 100b024c58ddf..9056c00d72b84 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: 2022-09-09 +date: 2022-09-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 4606d800cf22e..9858dd71b40a0 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: 2022-09-09 +date: 2022-09-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 765ff1f91971f..d20a7b9ad37dd 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: 2022-09-09 +date: 2022-09-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.devdocs.json b/api_docs/kbn_aiops_utils.devdocs.json index 3a2e48949a52b..5fae256126a14 100644 --- a/api_docs/kbn_aiops_utils.devdocs.json +++ b/api_docs/kbn_aiops_utils.devdocs.json @@ -186,9 +186,11 @@ "\nOverload to set up a string based response stream with support\nfor gzip compression depending on provided request headers.\n" ], "signature": [ - "(headers: Headers, logger: ", + "(headers: ", + "Headers", + ", logger: ", "Logger", - ") => StreamFactoryReturnType" + ", flushFix: boolean | undefined) => StreamFactoryReturnType" ], "path": "x-pack/packages/ml/aiops_utils/src/stream_factory.ts", "deprecated": false, @@ -197,7 +199,7 @@ { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.streamFactory.$1", - "type": "Object", + "type": "CompoundType", "tags": [], "label": "headers", "description": [ @@ -225,6 +227,21 @@ "deprecated": false, "trackAdoption": false, "isRequired": true + }, + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.streamFactory.$3", + "type": "CompoundType", + "tags": [], + "label": "flushFix", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/packages/ml/aiops_utils/src/stream_factory.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": false } ], "returnComment": [ @@ -242,9 +259,11 @@ "\nSets up a response stream with support for gzip compression depending on provided\nrequest headers. Any non-string data pushed to the stream will be stream as NDJSON.\n" ], "signature": [ - "(headers: Headers, logger: ", + "(headers: ", + "Headers", + ", logger: ", "Logger", - ") => StreamFactoryReturnType" + ", flushFix: boolean) => StreamFactoryReturnType" ], "path": "x-pack/packages/ml/aiops_utils/src/stream_factory.ts", "deprecated": false, @@ -253,7 +272,7 @@ { "parentPluginId": "@kbn/aiops-utils", "id": "def-common.streamFactory.$1", - "type": "Object", + "type": "CompoundType", "tags": [], "label": "headers", "description": [ @@ -281,6 +300,21 @@ "deprecated": false, "trackAdoption": false, "isRequired": true + }, + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.streamFactory.$3", + "type": "boolean", + "tags": [], + "label": "flushFix", + "description": [], + "signature": [ + "boolean" + ], + "path": "x-pack/packages/ml/aiops_utils/src/stream_factory.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true } ], "returnComment": [ diff --git a/api_docs/kbn_aiops_utils.mdx b/api_docs/kbn_aiops_utils.mdx index 4b51bc25be890..091fed52214f6 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-utils'] --- import kbnAiopsUtilsObj from './kbn_aiops_utils.devdocs.json'; @@ -21,7 +21,7 @@ Contact Machine Learning UI for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 49 | 0 | 24 | 0 | +| 51 | 0 | 26 | 0 | ## Common diff --git a/api_docs/kbn_alerts.mdx b/api_docs/kbn_alerts.mdx index d5a04ff5eee17..adcc61574b831 100644 --- a/api_docs/kbn_alerts.mdx +++ b/api_docs/kbn_alerts.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerts title: "@kbn/alerts" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/alerts plugin -date: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts'] --- import kbnAlertsObj from './kbn_alerts.devdocs.json'; diff --git a/api_docs/kbn_analytics.mdx b/api_docs/kbn_analytics.mdx index a99efc95e8c13..d946f4c837ceb 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: 2022-09-09 +date: 2022-09-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 1fd92e71b327a..d39f68906c4e7 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: 2022-09-09 +date: 2022-09-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 4f9fac4a0b2ec..cd98524289903 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: 2022-09-09 +date: 2022-09-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 ada937d1aa30e..fe6b3d629f334 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: 2022-09-09 +date: 2022-09-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 360208b56403b..b5f8465d23abb 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: 2022-09-09 +date: 2022-09-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 995d23de7fcc7..f0bf230c94525 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: 2022-09-09 +date: 2022-09-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_apm_config_loader.mdx b/api_docs/kbn_apm_config_loader.mdx index 41246db0a6756..e05ed7932ea0b 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: 2022-09-09 +date: 2022-09-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.devdocs.json b/api_docs/kbn_apm_synthtrace.devdocs.json index 647bcc1237623..565fde2f17163 100644 --- a/api_docs/kbn_apm_synthtrace.devdocs.json +++ b/api_docs/kbn_apm_synthtrace.devdocs.json @@ -1024,7 +1024,7 @@ }, "[]; 'error.grouping_name': string; 'error.grouping_key': string; 'host.name': string; 'host.hostname': string; 'kubernetes.pod.uid': string; 'kubernetes.pod.name': string; 'metricset.name': string; observer: ", "Observer", - "; 'parent.id': string; 'processor.event': string; 'processor.name': string; 'trace.id': string; 'transaction.name': string; 'transaction.type': string; 'transaction.id': string; 'transaction.duration.us': number; 'transaction.duration.histogram': { values: number[]; counts: number[]; }; 'transaction.sampled': true; 'service.name': string; 'service.version': string; 'service.environment': string; 'service.node.name': string; 'service.runtime.name': string; 'service.runtime.version': string; 'service.framework.name': string; 'service.target.name': string; 'service.target.type': string; 'span.id': string; 'span.name': string; 'span.type': string; 'span.subtype': string; 'span.duration.us': number; 'span.destination.service.name': string; 'span.destination.service.resource': string; 'span.destination.service.type': string; 'span.destination.service.response_time.sum.us': number; 'span.destination.service.response_time.count': number; 'span.self_time.count': number; 'span.self_time.sum.us': number; 'span.links': { trace: { id: string; }; span: { id: string; }; }[]; 'cloud.provider': string; 'cloud.project.name': string; 'cloud.service.name': string; 'cloud.availability_zone': string; 'cloud.machine.type': string; 'cloud.region': string; 'host.os.platform': string; 'faas.id': string; 'faas.coldstart': boolean; 'faas.execution': string; 'faas.trigger.type': string; 'faas.trigger.request_id': string; }> & Partial<{ 'system.process.memory.size': number; 'system.memory.actual.free': number; 'system.memory.total': number; 'system.cpu.total.norm.pct': number; 'system.process.memory.rss.bytes': number; 'system.process.cpu.total.norm.pct': number; 'jvm.memory.heap.used': number; 'jvm.memory.non_heap.used': number; 'jvm.thread.count': number; }>" + "; 'parent.id': string; 'processor.event': string; 'processor.name': string; 'trace.id': string; 'transaction.name': string; 'transaction.type': string; 'transaction.id': string; 'transaction.duration.us': number; 'transaction.duration.histogram': { values: number[]; counts: number[]; }; 'transaction.sampled': true; 'service.name': string; 'service.version': string; 'service.environment': string; 'service.node.name': string; 'service.runtime.name': string; 'service.runtime.version': string; 'service.framework.name': string; 'service.target.name': string; 'service.target.type': string; 'span.id': string; 'span.name': string; 'span.type': string; 'span.subtype': string; 'span.duration.us': number; 'span.destination.service.name': string; 'span.destination.service.resource': string; 'span.destination.service.type': string; 'span.destination.service.response_time.sum.us': number; 'span.destination.service.response_time.count': number; 'span.self_time.count': number; 'span.self_time.sum.us': number; 'span.links': { trace: { id: string; }; span: { id: string; }; }[]; 'cloud.provider': string; 'cloud.project.name': string; 'cloud.service.name': string; 'cloud.availability_zone': string; 'cloud.machine.type': string; 'cloud.region': string; 'host.os.platform': string; 'faas.id': string; 'faas.name': string; 'faas.coldstart': boolean; 'faas.execution': string; 'faas.trigger.type': string; 'faas.trigger.request_id': string; }> & Partial<{ 'system.process.memory.size': number; 'system.memory.actual.free': number; 'system.memory.total': number; 'system.cpu.total.norm.pct': number; 'system.process.memory.rss.bytes': number; 'system.process.cpu.total.norm.pct': number; 'jvm.memory.heap.used': number; 'jvm.memory.non_heap.used': number; 'jvm.thread.count': number; 'faas.billed_duration': number; 'faas.timeout': number; 'faas.coldstart_duration': number; 'faas.duration': number; }>" ], "path": "packages/kbn-apm-synthtrace/src/lib/apm/apm_fields.ts", "deprecated": false, @@ -1052,7 +1052,7 @@ "label": "service", "description": [], "signature": [ - "(name: string, environment: string, agentName: string) => ", + "({ name, environment, agentName, }: { name: string; environment: string; agentName: string; }) => ", "Service" ], "path": "packages/kbn-apm-synthtrace/src/lib/apm/index.ts", @@ -1063,32 +1063,13 @@ { "parentPluginId": "@kbn/apm-synthtrace", "id": "def-server.apm.service.$1", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "path": "packages/kbn-apm-synthtrace/src/lib/apm/service.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/apm-synthtrace", - "id": "def-server.apm.service.$2", - "type": "string", - "tags": [], - "label": "environment", - "description": [], - "path": "packages/kbn-apm-synthtrace/src/lib/apm/service.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/apm-synthtrace", - "id": "def-server.apm.service.$3", - "type": "string", + "type": "Object", "tags": [], - "label": "agentName", + "label": "__0", "description": [], + "signature": [ + "{ name: string; environment: string; agentName: string; }" + ], "path": "packages/kbn-apm-synthtrace/src/lib/apm/service.ts", "deprecated": false, "trackAdoption": false @@ -1103,7 +1084,7 @@ "label": "browser", "description": [], "signature": [ - "(serviceName: string, production: string, userAgent: Partial<{ 'user_agent.original': string; 'user_agent.os.name': string; 'user_agent.name': string; 'user_agent.device.name': string; 'user_agent.version': number; }>) => ", + "({ serviceName, environment, userAgent, }: { serviceName: string; environment: string; userAgent: Partial<{ 'user_agent.original': string; 'user_agent.os.name': string; 'user_agent.name': string; 'user_agent.device.name': string; 'user_agent.version': number; }>; }) => ", "Browser" ], "path": "packages/kbn-apm-synthtrace/src/lib/apm/index.ts", @@ -1114,34 +1095,12 @@ { "parentPluginId": "@kbn/apm-synthtrace", "id": "def-server.apm.browser.$1", - "type": "string", - "tags": [], - "label": "serviceName", - "description": [], - "path": "packages/kbn-apm-synthtrace/src/lib/apm/browser.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/apm-synthtrace", - "id": "def-server.apm.browser.$2", - "type": "string", - "tags": [], - "label": "production", - "description": [], - "path": "packages/kbn-apm-synthtrace/src/lib/apm/browser.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/apm-synthtrace", - "id": "def-server.apm.browser.$3", "type": "Object", "tags": [], - "label": "userAgent", + "label": "__0", "description": [], "signature": [ - "{ 'user_agent.original'?: string | undefined; 'user_agent.os.name'?: string | undefined; 'user_agent.name'?: string | undefined; 'user_agent.device.name'?: string | undefined; 'user_agent.version'?: number | undefined; }" + "{ serviceName: string; environment: string; userAgent: Partial<{ 'user_agent.original': string; 'user_agent.os.name': string; 'user_agent.name': string; 'user_agent.device.name': string; 'user_agent.version': number; }>; }" ], "path": "packages/kbn-apm-synthtrace/src/lib/apm/browser.ts", "deprecated": false, @@ -1175,7 +1134,7 @@ }, "[] | undefined; 'error.grouping_name'?: string | undefined; 'error.grouping_key'?: string | undefined; 'host.name'?: string | undefined; 'host.hostname'?: string | undefined; 'kubernetes.pod.uid'?: string | undefined; 'kubernetes.pod.name'?: string | undefined; observer?: ", "Observer", - " | undefined; 'parent.id'?: string | undefined; 'processor.event'?: string | undefined; 'processor.name'?: string | undefined; 'trace.id'?: string | undefined; 'transaction.name'?: string | undefined; 'transaction.type'?: string | undefined; 'transaction.id'?: string | undefined; 'transaction.duration.us'?: number | undefined; 'transaction.sampled'?: true | undefined; 'service.name'?: string | undefined; 'service.version'?: string | undefined; 'service.environment'?: string | undefined; 'service.node.name'?: string | undefined; 'service.runtime.name'?: string | undefined; 'service.runtime.version'?: string | undefined; 'service.framework.name'?: string | undefined; 'service.target.name'?: string | undefined; 'service.target.type'?: string | undefined; 'span.id'?: string | undefined; 'span.name'?: string | undefined; 'span.type'?: string | undefined; 'span.subtype'?: string | undefined; 'span.duration.us'?: number | undefined; 'span.destination.service.name'?: string | undefined; 'span.destination.service.resource'?: string | undefined; 'span.destination.service.type'?: string | undefined; 'span.destination.service.response_time.sum.us'?: number | undefined; 'span.destination.service.response_time.count'?: number | undefined; 'span.self_time.count'?: number | undefined; 'span.self_time.sum.us'?: number | undefined; 'span.links'?: { trace: { id: string; }; span: { id: string; }; }[] | undefined; 'cloud.provider'?: string | undefined; 'cloud.project.name'?: string | undefined; 'cloud.service.name'?: string | undefined; 'cloud.availability_zone'?: string | undefined; 'cloud.machine.type'?: string | undefined; 'cloud.region'?: string | undefined; 'host.os.platform'?: string | undefined; 'faas.id'?: string | undefined; 'faas.coldstart'?: boolean | undefined; 'faas.execution'?: string | undefined; 'faas.trigger.type'?: string | undefined; 'faas.trigger.request_id'?: string | undefined; 'system.process.memory.size'?: number | undefined; 'system.memory.actual.free'?: number | undefined; 'system.memory.total'?: number | undefined; 'system.cpu.total.norm.pct'?: number | undefined; 'system.process.memory.rss.bytes'?: number | undefined; 'system.process.cpu.total.norm.pct'?: number | undefined; 'jvm.memory.heap.used'?: number | undefined; 'jvm.memory.non_heap.used'?: number | undefined; 'jvm.thread.count'?: number | undefined; }[]" + " | undefined; 'parent.id'?: string | undefined; 'processor.event'?: string | undefined; 'processor.name'?: string | undefined; 'trace.id'?: string | undefined; 'transaction.name'?: string | undefined; 'transaction.type'?: string | undefined; 'transaction.id'?: string | undefined; 'transaction.duration.us'?: number | undefined; 'transaction.sampled'?: true | undefined; 'service.name'?: string | undefined; 'service.version'?: string | undefined; 'service.environment'?: string | undefined; 'service.node.name'?: string | undefined; 'service.runtime.name'?: string | undefined; 'service.runtime.version'?: string | undefined; 'service.framework.name'?: string | undefined; 'service.target.name'?: string | undefined; 'service.target.type'?: string | undefined; 'span.id'?: string | undefined; 'span.name'?: string | undefined; 'span.type'?: string | undefined; 'span.subtype'?: string | undefined; 'span.duration.us'?: number | undefined; 'span.destination.service.name'?: string | undefined; 'span.destination.service.resource'?: string | undefined; 'span.destination.service.type'?: string | undefined; 'span.destination.service.response_time.sum.us'?: number | undefined; 'span.destination.service.response_time.count'?: number | undefined; 'span.self_time.count'?: number | undefined; 'span.self_time.sum.us'?: number | undefined; 'span.links'?: { trace: { id: string; }; span: { id: string; }; }[] | undefined; 'cloud.provider'?: string | undefined; 'cloud.project.name'?: string | undefined; 'cloud.service.name'?: string | undefined; 'cloud.availability_zone'?: string | undefined; 'cloud.machine.type'?: string | undefined; 'cloud.region'?: string | undefined; 'host.os.platform'?: string | undefined; 'faas.id'?: string | undefined; 'faas.name'?: string | undefined; 'faas.coldstart'?: boolean | undefined; 'faas.execution'?: string | undefined; 'faas.trigger.type'?: string | undefined; 'faas.trigger.request_id'?: string | undefined; 'system.process.memory.size'?: number | undefined; 'system.memory.actual.free'?: number | undefined; 'system.memory.total'?: number | undefined; 'system.cpu.total.norm.pct'?: number | undefined; 'system.process.memory.rss.bytes'?: number | undefined; 'system.process.cpu.total.norm.pct'?: number | undefined; 'jvm.memory.heap.used'?: number | undefined; 'jvm.memory.non_heap.used'?: number | undefined; 'jvm.thread.count'?: number | undefined; 'faas.billed_duration'?: number | undefined; 'faas.timeout'?: number | undefined; 'faas.coldstart_duration'?: number | undefined; 'faas.duration'?: number | undefined; }[]" ], "path": "packages/kbn-apm-synthtrace/src/lib/apm/index.ts", "deprecated": false, @@ -1231,7 +1190,7 @@ }, "[] | undefined; 'error.grouping_name'?: string | undefined; 'error.grouping_key'?: string | undefined; 'host.name'?: string | undefined; 'host.hostname'?: string | undefined; 'kubernetes.pod.uid'?: string | undefined; 'kubernetes.pod.name'?: string | undefined; observer?: ", "Observer", - " | undefined; 'parent.id'?: string | undefined; 'processor.event'?: string | undefined; 'processor.name'?: string | undefined; 'trace.id'?: string | undefined; 'transaction.name'?: string | undefined; 'transaction.type'?: string | undefined; 'transaction.id'?: string | undefined; 'transaction.duration.us'?: number | undefined; 'transaction.duration.histogram'?: { values: number[]; counts: number[]; } | undefined; 'transaction.sampled'?: true | undefined; 'service.name'?: string | undefined; 'service.version'?: string | undefined; 'service.environment'?: string | undefined; 'service.node.name'?: string | undefined; 'service.runtime.name'?: string | undefined; 'service.runtime.version'?: string | undefined; 'service.framework.name'?: string | undefined; 'service.target.name'?: string | undefined; 'service.target.type'?: string | undefined; 'span.id'?: string | undefined; 'span.name'?: string | undefined; 'span.type'?: string | undefined; 'span.subtype'?: string | undefined; 'span.duration.us'?: number | undefined; 'span.destination.service.name'?: string | undefined; 'span.destination.service.resource'?: string | undefined; 'span.destination.service.type'?: string | undefined; 'span.self_time.count'?: number | undefined; 'span.self_time.sum.us'?: number | undefined; 'span.links'?: { trace: { id: string; }; span: { id: string; }; }[] | undefined; 'cloud.provider'?: string | undefined; 'cloud.project.name'?: string | undefined; 'cloud.service.name'?: string | undefined; 'cloud.availability_zone'?: string | undefined; 'cloud.machine.type'?: string | undefined; 'cloud.region'?: string | undefined; 'host.os.platform'?: string | undefined; 'faas.id'?: string | undefined; 'faas.coldstart'?: boolean | undefined; 'faas.execution'?: string | undefined; 'faas.trigger.type'?: string | undefined; 'faas.trigger.request_id'?: string | undefined; 'system.process.memory.size'?: number | undefined; 'system.memory.actual.free'?: number | undefined; 'system.memory.total'?: number | undefined; 'system.cpu.total.norm.pct'?: number | undefined; 'system.process.memory.rss.bytes'?: number | undefined; 'system.process.cpu.total.norm.pct'?: number | undefined; 'jvm.memory.heap.used'?: number | undefined; 'jvm.memory.non_heap.used'?: number | undefined; 'jvm.thread.count'?: number | undefined; }[]" + " | undefined; 'parent.id'?: string | undefined; 'processor.event'?: string | undefined; 'processor.name'?: string | undefined; 'trace.id'?: string | undefined; 'transaction.name'?: string | undefined; 'transaction.type'?: string | undefined; 'transaction.id'?: string | undefined; 'transaction.duration.us'?: number | undefined; 'transaction.duration.histogram'?: { values: number[]; counts: number[]; } | undefined; 'transaction.sampled'?: true | undefined; 'service.name'?: string | undefined; 'service.version'?: string | undefined; 'service.environment'?: string | undefined; 'service.node.name'?: string | undefined; 'service.runtime.name'?: string | undefined; 'service.runtime.version'?: string | undefined; 'service.framework.name'?: string | undefined; 'service.target.name'?: string | undefined; 'service.target.type'?: string | undefined; 'span.id'?: string | undefined; 'span.name'?: string | undefined; 'span.type'?: string | undefined; 'span.subtype'?: string | undefined; 'span.duration.us'?: number | undefined; 'span.destination.service.name'?: string | undefined; 'span.destination.service.resource'?: string | undefined; 'span.destination.service.type'?: string | undefined; 'span.self_time.count'?: number | undefined; 'span.self_time.sum.us'?: number | undefined; 'span.links'?: { trace: { id: string; }; span: { id: string; }; }[] | undefined; 'cloud.provider'?: string | undefined; 'cloud.project.name'?: string | undefined; 'cloud.service.name'?: string | undefined; 'cloud.availability_zone'?: string | undefined; 'cloud.machine.type'?: string | undefined; 'cloud.region'?: string | undefined; 'host.os.platform'?: string | undefined; 'faas.id'?: string | undefined; 'faas.name'?: string | undefined; 'faas.coldstart'?: boolean | undefined; 'faas.execution'?: string | undefined; 'faas.trigger.type'?: string | undefined; 'faas.trigger.request_id'?: string | undefined; 'system.process.memory.size'?: number | undefined; 'system.memory.actual.free'?: number | undefined; 'system.memory.total'?: number | undefined; 'system.cpu.total.norm.pct'?: number | undefined; 'system.process.memory.rss.bytes'?: number | undefined; 'system.process.cpu.total.norm.pct'?: number | undefined; 'jvm.memory.heap.used'?: number | undefined; 'jvm.memory.non_heap.used'?: number | undefined; 'jvm.thread.count'?: number | undefined; 'faas.billed_duration'?: number | undefined; 'faas.timeout'?: number | undefined; 'faas.coldstart_duration'?: number | undefined; 'faas.duration'?: number | undefined; }[]" ], "path": "packages/kbn-apm-synthtrace/src/lib/apm/index.ts", "deprecated": false, @@ -1403,6 +1362,38 @@ "path": "packages/kbn-apm-synthtrace/src/lib/apm/index.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "@kbn/apm-synthtrace", + "id": "def-server.apm.serverlessFunction", + "type": "Function", + "tags": [], + "label": "serverlessFunction", + "description": [], + "signature": [ + "({ functionName, serviceName, environment, agentName, }: { functionName: string; environment: string; agentName: string; serviceName?: string | undefined; }) => ", + "ServerlessFunction" + ], + "path": "packages/kbn-apm-synthtrace/src/lib/apm/index.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/apm-synthtrace", + "id": "def-server.apm.serverlessFunction.$1", + "type": "Object", + "tags": [], + "label": "__0", + "description": [], + "signature": [ + "{ functionName: string; environment: string; agentName: string; serviceName?: string | undefined; }" + ], + "path": "packages/kbn-apm-synthtrace/src/lib/apm/serverless_function.ts", + "deprecated": false, + "trackAdoption": false + } + ] } ], "initialIsOpen": false diff --git a/api_docs/kbn_apm_synthtrace.mdx b/api_docs/kbn_apm_synthtrace.mdx index 82c57310848d5..9f1463f50f008 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-synthtrace'] --- import kbnApmSynthtraceObj from './kbn_apm_synthtrace.devdocs.json'; @@ -21,7 +21,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 76 | 0 | 76 | 12 | +| 74 | 0 | 74 | 13 | ## Server diff --git a/api_docs/kbn_apm_utils.mdx b/api_docs/kbn_apm_utils.mdx index 3b8859bf24577..350dfc4f21573 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: 2022-09-09 +date: 2022-09-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 a84beaaf76f9c..fe78eade4d5e8 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/axe-config'] --- import kbnAxeConfigObj from './kbn_axe_config.devdocs.json'; diff --git a/api_docs/kbn_chart_icons.mdx b/api_docs/kbn_chart_icons.mdx index f81ea7eb893f4..1fd328a1909af 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: 2022-09-09 +date: 2022-09-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 f136b1b4b9722..36f3f627a7079 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: 2022-09-09 +date: 2022-09-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 4fac55f5f28f2..66064bc9235db 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: 2022-09-09 +date: 2022-09-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 9a986e49442eb..50c89a112f318 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: 2022-09-09 +date: 2022-09-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 ad805a672ec6a..946811ebef1ef 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: 2022-09-09 +date: 2022-09-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_coloring.devdocs.json b/api_docs/kbn_coloring.devdocs.json index f8c78bf06c6b9..8c6054e41c806 100644 --- a/api_docs/kbn_coloring.devdocs.json +++ b/api_docs/kbn_coloring.devdocs.json @@ -1860,7 +1860,7 @@ "label": "RequiredPaletteParamTypes", "description": [], "signature": [ - "{ rangeMin: number; name: string; reverse: boolean; rangeType: \"number\" | \"percent\"; continuity: ", + "{ name: string; rangeMin: number; reverse: boolean; rangeType: \"number\" | \"percent\"; continuity: ", { "pluginId": "@kbn/coloring", "scope": "common", diff --git a/api_docs/kbn_coloring.mdx b/api_docs/kbn_coloring.mdx index d48d41a5c8649..e1e61842963b9 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: 2022-09-09 +date: 2022-09-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 1e6fbb0c52619..f4e1d6df66d36 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config'] --- import kbnConfigObj from './kbn_config.devdocs.json'; diff --git a/api_docs/kbn_config_mocks.mdx b/api_docs/kbn_config_mocks.mdx index 4ed5acbd873d2..3dfe88a5fe6f8 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: 2022-09-09 +date: 2022-09-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 1a85935c87425..770caaadc3273 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: 2022-09-09 +date: 2022-09-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_table_list.devdocs.json b/api_docs/kbn_content_management_table_list.devdocs.json new file mode 100644 index 0000000000000..967aae50206d2 --- /dev/null +++ b/api_docs/kbn_content_management_table_list.devdocs.json @@ -0,0 +1,226 @@ +{ + "id": "@kbn/content-management-table-list", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/content-management-table-list", + "id": "def-common.TableListView", + "type": "Function", + "tags": [], + "label": "TableListView", + "description": [], + "signature": [ + "({ tableListTitle, entityName, entityNamePlural, initialFilter: initialQuery, headingId, initialPageSize, listingLimit, customTableColumn, emptyPrompt, findItems, createItem, editItem, deleteItems, getDetailViewLink, onClickTitle, id, children, }: ", + "Props", + ") => JSX.Element | null" + ], + "path": "packages/content-management/table_list/src/table_list_view.tsx", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/content-management-table-list", + "id": "def-common.TableListView.$1", + "type": "Object", + "tags": [], + "label": "__0", + "description": [], + "signature": [ + "Props", + "" + ], + "path": "packages/content-management/table_list/src/table_list_view.tsx", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/content-management-table-list", + "id": "def-common.TableListViewKibanaProvider", + "type": "Function", + "tags": [], + "label": "TableListViewKibanaProvider", + "description": [ + "\nKibana-specific Provider that maps to known dependency types." + ], + "signature": [ + "({ children, ...services }: React.PropsWithChildren<", + "TableListViewKibanaDependencies", + ">) => JSX.Element" + ], + "path": "packages/content-management/table_list/src/services.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/content-management-table-list", + "id": "def-common.TableListViewKibanaProvider.$1", + "type": "CompoundType", + "tags": [], + "label": "{\n children,\n ...services\n}", + "description": [], + "signature": [ + "React.PropsWithChildren<", + "TableListViewKibanaDependencies", + ">" + ], + "path": "packages/content-management/table_list/src/services.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/content-management-table-list", + "id": "def-common.TableListViewProvider", + "type": "Function", + "tags": [], + "label": "TableListViewProvider", + "description": [ + "\nAbstract external service Provider." + ], + "signature": [ + "({ children, ...services }: React.PropsWithChildren<", + "Services", + ">) => JSX.Element" + ], + "path": "packages/content-management/table_list/src/services.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/content-management-table-list", + "id": "def-common.TableListViewProvider.$1", + "type": "CompoundType", + "tags": [], + "label": "{ children, ...services }", + "description": [], + "signature": [ + "React.PropsWithChildren<", + "Services", + ">" + ], + "path": "packages/content-management/table_list/src/services.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "@kbn/content-management-table-list", + "id": "def-common.UserContentCommonSchema", + "type": "Interface", + "tags": [], + "label": "UserContentCommonSchema", + "description": [], + "path": "packages/content-management/table_list/src/table_list_view.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/content-management-table-list", + "id": "def-common.UserContentCommonSchema.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "packages/content-management/table_list/src/table_list_view.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/content-management-table-list", + "id": "def-common.UserContentCommonSchema.updatedAt", + "type": "string", + "tags": [], + "label": "updatedAt", + "description": [], + "path": "packages/content-management/table_list/src/table_list_view.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/content-management-table-list", + "id": "def-common.UserContentCommonSchema.references", + "type": "Array", + "tags": [], + "label": "references", + "description": [], + "signature": [ + "SavedObjectsReference", + "[]" + ], + "path": "packages/content-management/table_list/src/table_list_view.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/content-management-table-list", + "id": "def-common.UserContentCommonSchema.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "packages/content-management/table_list/src/table_list_view.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/content-management-table-list", + "id": "def-common.UserContentCommonSchema.attributes", + "type": "Object", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "{ title: string; description?: string | undefined; }" + ], + "path": "packages/content-management/table_list/src/table_list_view.tsx", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_content_management_table_list.mdx b/api_docs/kbn_content_management_table_list.mdx new file mode 100644 index 0000000000000..88c8770f78e05 --- /dev/null +++ b/api_docs/kbn_content_management_table_list.mdx @@ -0,0 +1,33 @@ +--- +#### +#### This 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: kibKbnContentManagementTableListPluginApi +slug: /kibana-dev-docs/api/kbn-content-management-table-list +title: "@kbn/content-management-table-list" +image: https://source.unsplash.com/400x175/?github +description: API docs for the @kbn/content-management-table-list plugin +date: 2022-09-20 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/content-management-table-list'] +--- +import kbnContentManagementTableListObj from './kbn_content_management_table_list.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 12 | 0 | 10 | 4 | + +## Common + +### Functions + + +### Interfaces + + diff --git a/api_docs/kbn_core_analytics_browser.mdx b/api_docs/kbn_core_analytics_browser.mdx index ac39a7961593a..9985d16c3d530 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: 2022-09-09 +date: 2022-09-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 fc5cd3bfb8438..8b30598c799c5 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: 2022-09-09 +date: 2022-09-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 4c9c75e852390..7d9ba2b790cd9 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: 2022-09-09 +date: 2022-09-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 92c1424297816..367e2d1efc34b 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: 2022-09-09 +date: 2022-09-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 da3c85dc76a4e..3bc7041adc0c7 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: 2022-09-09 +date: 2022-09-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 e291353f701f6..04c9d11050656 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: 2022-09-09 +date: 2022-09-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 e1d48305d2290..d334e274ebd27 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: 2022-09-09 +date: 2022-09-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 1b208d9a63487..fb1732696cd58 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: 2022-09-09 +date: 2022-09-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.mdx b/api_docs/kbn_core_application_browser_mocks.mdx index 3ad4f503057fa..5841b62fe8421 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: 2022-09-09 +date: 2022-09-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 4779f2f4f68b5..d24d2537e5a29 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: 2022-09-09 +date: 2022-09-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.devdocs.json b/api_docs/kbn_core_apps_browser_internal.devdocs.json new file mode 100644 index 0000000000000..5cea64788f899 --- /dev/null +++ b/api_docs/kbn_core_apps_browser_internal.devdocs.json @@ -0,0 +1,355 @@ +{ + "id": "@kbn/core-apps-browser-internal", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [ + { + "parentPluginId": "@kbn/core-apps-browser-internal", + "id": "def-common.CoreAppsService", + "type": "Class", + "tags": [], + "label": "CoreAppsService", + "description": [], + "path": "packages/core/apps/core-apps-browser-internal/src/core_app.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-apps-browser-internal", + "id": "def-common.CoreAppsService.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "packages/core/apps/core-apps-browser-internal/src/core_app.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-apps-browser-internal", + "id": "def-common.CoreAppsService.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "coreContext", + "description": [], + "signature": [ + "CoreContext" + ], + "path": "packages/core/apps/core-apps-browser-internal/src/core_app.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-apps-browser-internal", + "id": "def-common.CoreAppsService.setup", + "type": "Function", + "tags": [], + "label": "setup", + "description": [], + "signature": [ + "({ application, http, injectedMetadata, notifications }: ", + { + "pluginId": "@kbn/core-apps-browser-internal", + "scope": "common", + "docId": "kibKbnCoreAppsBrowserInternalPluginApi", + "section": "def-common.CoreAppsServiceSetupDeps", + "text": "CoreAppsServiceSetupDeps" + }, + ") => void" + ], + "path": "packages/core/apps/core-apps-browser-internal/src/core_app.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-apps-browser-internal", + "id": "def-common.CoreAppsService.setup.$1", + "type": "Object", + "tags": [], + "label": "{ application, http, injectedMetadata, notifications }", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-apps-browser-internal", + "scope": "common", + "docId": "kibKbnCoreAppsBrowserInternalPluginApi", + "section": "def-common.CoreAppsServiceSetupDeps", + "text": "CoreAppsServiceSetupDeps" + } + ], + "path": "packages/core/apps/core-apps-browser-internal/src/core_app.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-apps-browser-internal", + "id": "def-common.CoreAppsService.start", + "type": "Function", + "tags": [], + "label": "start", + "description": [], + "signature": [ + "({ application, docLinks, http, notifications, uiSettings, }: ", + { + "pluginId": "@kbn/core-apps-browser-internal", + "scope": "common", + "docId": "kibKbnCoreAppsBrowserInternalPluginApi", + "section": "def-common.CoreAppsServiceStartDeps", + "text": "CoreAppsServiceStartDeps" + }, + ") => void" + ], + "path": "packages/core/apps/core-apps-browser-internal/src/core_app.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-apps-browser-internal", + "id": "def-common.CoreAppsService.start.$1", + "type": "Object", + "tags": [], + "label": "{\n application,\n docLinks,\n http,\n notifications,\n uiSettings,\n }", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-apps-browser-internal", + "scope": "common", + "docId": "kibKbnCoreAppsBrowserInternalPluginApi", + "section": "def-common.CoreAppsServiceStartDeps", + "text": "CoreAppsServiceStartDeps" + } + ], + "path": "packages/core/apps/core-apps-browser-internal/src/core_app.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-apps-browser-internal", + "id": "def-common.CoreAppsService.stop", + "type": "Function", + "tags": [], + "label": "stop", + "description": [], + "signature": [ + "() => void" + ], + "path": "packages/core/apps/core-apps-browser-internal/src/core_app.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [ + { + "parentPluginId": "@kbn/core-apps-browser-internal", + "id": "def-common.CoreAppsServiceSetupDeps", + "type": "Interface", + "tags": [], + "label": "CoreAppsServiceSetupDeps", + "description": [], + "path": "packages/core/apps/core-apps-browser-internal/src/core_app.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-apps-browser-internal", + "id": "def-common.CoreAppsServiceSetupDeps.application", + "type": "Object", + "tags": [], + "label": "application", + "description": [], + "signature": [ + "InternalApplicationSetup" + ], + "path": "packages/core/apps/core-apps-browser-internal/src/core_app.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-apps-browser-internal", + "id": "def-common.CoreAppsServiceSetupDeps.http", + "type": "Object", + "tags": [], + "label": "http", + "description": [], + "signature": [ + "HttpSetup" + ], + "path": "packages/core/apps/core-apps-browser-internal/src/core_app.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-apps-browser-internal", + "id": "def-common.CoreAppsServiceSetupDeps.injectedMetadata", + "type": "Object", + "tags": [], + "label": "injectedMetadata", + "description": [], + "signature": [ + "InternalInjectedMetadataSetup" + ], + "path": "packages/core/apps/core-apps-browser-internal/src/core_app.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-apps-browser-internal", + "id": "def-common.CoreAppsServiceSetupDeps.notifications", + "type": "Object", + "tags": [], + "label": "notifications", + "description": [], + "signature": [ + "NotificationsSetup" + ], + "path": "packages/core/apps/core-apps-browser-internal/src/core_app.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-apps-browser-internal", + "id": "def-common.CoreAppsServiceStartDeps", + "type": "Interface", + "tags": [], + "label": "CoreAppsServiceStartDeps", + "description": [], + "path": "packages/core/apps/core-apps-browser-internal/src/core_app.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-apps-browser-internal", + "id": "def-common.CoreAppsServiceStartDeps.application", + "type": "Object", + "tags": [], + "label": "application", + "description": [], + "signature": [ + "InternalApplicationStart" + ], + "path": "packages/core/apps/core-apps-browser-internal/src/core_app.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-apps-browser-internal", + "id": "def-common.CoreAppsServiceStartDeps.docLinks", + "type": "Object", + "tags": [], + "label": "docLinks", + "description": [], + "signature": [ + "DocLinksStart" + ], + "path": "packages/core/apps/core-apps-browser-internal/src/core_app.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-apps-browser-internal", + "id": "def-common.CoreAppsServiceStartDeps.http", + "type": "Object", + "tags": [], + "label": "http", + "description": [], + "signature": [ + "HttpSetup" + ], + "path": "packages/core/apps/core-apps-browser-internal/src/core_app.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-apps-browser-internal", + "id": "def-common.CoreAppsServiceStartDeps.notifications", + "type": "Object", + "tags": [], + "label": "notifications", + "description": [], + "signature": [ + "NotificationsStart" + ], + "path": "packages/core/apps/core-apps-browser-internal/src/core_app.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-apps-browser-internal", + "id": "def-common.CoreAppsServiceStartDeps.uiSettings", + "type": "Object", + "tags": [], + "label": "uiSettings", + "description": [], + "signature": [ + "IUiSettingsClient" + ], + "path": "packages/core/apps/core-apps-browser-internal/src/core_app.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/core-apps-browser-internal", + "id": "def-common.URL_MAX_LENGTH", + "type": "CompoundType", + "tags": [], + "label": "URL_MAX_LENGTH", + "description": [ + "\nThe max URL length allowed by the current browser. Should be used to display warnings to users when query parameters\ncause URL to exceed this limit." + ], + "signature": [ + "2000 | 25000" + ], + "path": "packages/core/apps/core-apps-browser-internal/src/errors/url_overflow.tsx", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_apps_browser_internal.mdx b/api_docs/kbn_core_apps_browser_internal.mdx new file mode 100644 index 0000000000000..ac8c8304cbacd --- /dev/null +++ b/api_docs/kbn_core_apps_browser_internal.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: kibKbnCoreAppsBrowserInternalPluginApi +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: 2022-09-20 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-apps-browser-internal'] +--- +import kbnCoreAppsBrowserInternalObj from './kbn_core_apps_browser_internal.devdocs.json'; + + + +Contact Kibana Core for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 20 | 0 | 19 | 0 | + +## Common + +### Classes + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/kbn_core_apps_browser_mocks.devdocs.json b/api_docs/kbn_core_apps_browser_mocks.devdocs.json new file mode 100644 index 0000000000000..7e58c029fc73b --- /dev/null +++ b/api_docs/kbn_core_apps_browser_mocks.devdocs.json @@ -0,0 +1,58 @@ +{ + "id": "@kbn/core-apps-browser-mocks", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [ + { + "parentPluginId": "@kbn/core-apps-browser-mocks", + "id": "def-common.coreAppsMock", + "type": "Object", + "tags": [], + "label": "coreAppsMock", + "description": [], + "path": "packages/core/apps/core-apps-browser-mocks/src/core_app.mock.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-apps-browser-mocks", + "id": "def-common.coreAppsMock.create", + "type": "Function", + "tags": [], + "label": "create", + "description": [], + "signature": [ + "() => jest.Mocked" + ], + "path": "packages/core/apps/core-apps-browser-mocks/src/core_app.mock.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [] + } + ], + "initialIsOpen": false + } + ] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_apps_browser_mocks.mdx b/api_docs/kbn_core_apps_browser_mocks.mdx new file mode 100644 index 0000000000000..d379d0650b330 --- /dev/null +++ b/api_docs/kbn_core_apps_browser_mocks.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: kibKbnCoreAppsBrowserMocksPluginApi +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: 2022-09-20 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-apps-browser-mocks'] +--- +import kbnCoreAppsBrowserMocksObj from './kbn_core_apps_browser_mocks.devdocs.json'; + + + +Contact Kibana Core for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 2 | 0 | 2 | 0 | + +## Common + +### Objects + + diff --git a/api_docs/kbn_core_base_browser_mocks.mdx b/api_docs/kbn_core_base_browser_mocks.mdx index 701892c07d6fb..1532b48e1caa7 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: 2022-09-09 +date: 2022-09-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.devdocs.json b/api_docs/kbn_core_base_common.devdocs.json index 5a164327bf338..e5fae7dc02d76 100644 --- a/api_docs/kbn_core_base_common.devdocs.json +++ b/api_docs/kbn_core_base_common.devdocs.json @@ -142,109 +142,6 @@ } ], "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/core-base-common", - "id": "def-server.ServiceStatus", - "type": "Interface", - "tags": [], - "label": "ServiceStatus", - "description": [ - "\nThe current status of a service at a point in time.\n" - ], - "signature": [ - { - "pluginId": "@kbn/core-base-common", - "scope": "server", - "docId": "kibKbnCoreBaseCommonPluginApi", - "section": "def-server.ServiceStatus", - "text": "ServiceStatus" - }, - "" - ], - "path": "packages/core/base/core-base-common/src/service_status.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/core-base-common", - "id": "def-server.ServiceStatus.level", - "type": "CompoundType", - "tags": [], - "label": "level", - "description": [ - "\nThe current availability level of the service." - ], - "signature": [ - "Readonly<{ toString: () => \"available\"; valueOf: () => 0; toJSON: () => \"available\"; }> | Readonly<{ toString: () => \"degraded\"; valueOf: () => 1; toJSON: () => \"degraded\"; }> | Readonly<{ toString: () => \"unavailable\"; valueOf: () => 2; toJSON: () => \"unavailable\"; }> | Readonly<{ toString: () => \"critical\"; valueOf: () => 3; toJSON: () => \"critical\"; }>" - ], - "path": "packages/core/base/core-base-common/src/service_status.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/core-base-common", - "id": "def-server.ServiceStatus.summary", - "type": "string", - "tags": [], - "label": "summary", - "description": [ - "\nA high-level summary of the service status." - ], - "path": "packages/core/base/core-base-common/src/service_status.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/core-base-common", - "id": "def-server.ServiceStatus.detail", - "type": "string", - "tags": [], - "label": "detail", - "description": [ - "\nA more detailed description of the service status." - ], - "signature": [ - "string | undefined" - ], - "path": "packages/core/base/core-base-common/src/service_status.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/core-base-common", - "id": "def-server.ServiceStatus.documentationUrl", - "type": "string", - "tags": [], - "label": "documentationUrl", - "description": [ - "\nA URL to open in a new tab about how to resolve or troubleshoot the problem." - ], - "signature": [ - "string | undefined" - ], - "path": "packages/core/base/core-base-common/src/service_status.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/core-base-common", - "id": "def-server.ServiceStatus.meta", - "type": "Uncategorized", - "tags": [], - "label": "meta", - "description": [ - "\nAny JSON-serializable data to be included in the HTTP API response. Useful for providing more fine-grained,\nmachine-readable information about the service status. May include status information for underlying features." - ], - "signature": [ - "Meta | undefined" - ], - "path": "packages/core/base/core-base-common/src/service_status.ts", - "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false } ], "enums": [ @@ -308,44 +205,9 @@ "deprecated": false, "trackAdoption": false, "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/core-base-common", - "id": "def-server.ServiceStatusLevel", - "type": "Type", - "tags": [], - "label": "ServiceStatusLevel", - "description": [ - "\nA convenience type that represents the union of each value in {@link ServiceStatusLevels}." - ], - "signature": [ - "Readonly<{ toString: () => \"available\"; valueOf: () => 0; toJSON: () => \"available\"; }> | Readonly<{ toString: () => \"degraded\"; valueOf: () => 1; toJSON: () => \"degraded\"; }> | Readonly<{ toString: () => \"unavailable\"; valueOf: () => 2; toJSON: () => \"unavailable\"; }> | Readonly<{ toString: () => \"critical\"; valueOf: () => 3; toJSON: () => \"critical\"; }>" - ], - "path": "packages/core/base/core-base-common/src/service_status.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false } ], - "objects": [ - { - "parentPluginId": "@kbn/core-base-common", - "id": "def-server.ServiceStatusLevels", - "type": "Object", - "tags": [], - "label": "ServiceStatusLevels", - "description": [ - "\nThe current \"level\" of availability of a service.\n" - ], - "signature": [ - "{ readonly available: Readonly<{ toString: () => \"available\"; valueOf: () => 0; toJSON: () => \"available\"; }>; readonly degraded: Readonly<{ toString: () => \"degraded\"; valueOf: () => 1; toJSON: () => \"degraded\"; }>; readonly unavailable: Readonly<{ toString: () => \"unavailable\"; valueOf: () => 2; toJSON: () => \"unavailable\"; }>; readonly critical: Readonly<{ toString: () => \"critical\"; valueOf: () => 3; toJSON: () => \"critical\"; }>; }" - ], - "path": "packages/core/base/core-base-common/src/service_status.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - } - ] + "objects": [] }, "common": { "classes": [], diff --git a/api_docs/kbn_core_base_common.mdx b/api_docs/kbn_core_base_common.mdx index 6f65974f3df95..7ae08ec040bc7 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-common'] --- import kbnCoreBaseCommonObj from './kbn_core_base_common.devdocs.json'; @@ -21,13 +21,10 @@ Contact Kibana Core for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 20 | 0 | 3 | 0 | +| 12 | 0 | 3 | 0 | ## Server -### Objects - - ### Interfaces diff --git a/api_docs/kbn_core_base_server_internal.mdx b/api_docs/kbn_core_base_server_internal.mdx index 3ac31dbf66d23..a46e1f96ce169 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: 2022-09-09 +date: 2022-09-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 5d9da0822c070..c4ade5b2f59e7 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: 2022-09-09 +date: 2022-09-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 0fb84b17ee969..734a7db43b735 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: 2022-09-09 +date: 2022-09-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 24dc0372c51ec..b039c307cc98d 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: 2022-09-09 +date: 2022-09-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 a52d64e5e6e20..e53c2bfaa2f7c 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: 2022-09-09 +date: 2022-09-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 5e2bfe3318f47..dba1d83d54bfa 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: 2022-09-09 +date: 2022-09-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.mdx b/api_docs/kbn_core_chrome_browser.mdx index 8e3c4efe990f0..0b8ccf9d5cc52 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-chrome-browser'] --- import kbnCoreChromeBrowserObj from './kbn_core_chrome_browser.devdocs.json'; diff --git a/api_docs/kbn_core_chrome_browser_mocks.mdx b/api_docs/kbn_core_chrome_browser_mocks.mdx index ecc9bc1bad7b3..c9b340d67fa0e 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: 2022-09-09 +date: 2022-09-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 fa73a6310dd90..00e6556403379 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: 2022-09-09 +date: 2022-09-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_deprecations_browser.mdx b/api_docs/kbn_core_deprecations_browser.mdx index e9d543f5eab88..8c6a0d2cc5326 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: 2022-09-09 +date: 2022-09-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 5e380c589df45..fcf11ae9ddef9 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: 2022-09-09 +date: 2022-09-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 86d55e1e9c44d..9c728cc39d05c 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: 2022-09-09 +date: 2022-09-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 6dd116c3c46f2..57a9e5d36f00e 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: 2022-09-09 +date: 2022-09-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 96418b9c64b68..579e0c95cedd1 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: 2022-09-09 +date: 2022-09-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 b557d4e5c473a..6f67e55a17c96 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: 2022-09-09 +date: 2022-09-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 0cacd094cfbb9..9f3766a0e2e9a 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: 2022-09-09 +date: 2022-09-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 2c72b3d00c599..f3c49ab467f46 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: 2022-09-09 +date: 2022-09-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.mdx b/api_docs/kbn_core_doc_links_browser_mocks.mdx index 1582e2b3c6a47..601595113c8bd 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: 2022-09-09 +date: 2022-09-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 7cad22cf1928b..b8dbcf387129b 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: 2022-09-09 +date: 2022-09-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 ac6c785eb5bbc..d9e077756915d 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: 2022-09-09 +date: 2022-09-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.devdocs.json b/api_docs/kbn_core_elasticsearch_client_server_internal.devdocs.json index b14c24b7a4b03..8fea22edcf2fd 100644 --- a/api_docs/kbn_core_elasticsearch_client_server_internal.devdocs.json +++ b/api_docs/kbn_core_elasticsearch_client_server_internal.devdocs.json @@ -21,9 +21,11 @@ "signature": [ "(config: ", "ElasticsearchClientConfig", - ", { logger, type, scoped, getExecutionContext, }: { logger: ", + ", { logger, type, scoped, getExecutionContext, agentManager, }: { logger: ", "Logger", - "; type: string; scoped?: boolean | undefined; getExecutionContext?: (() => string | undefined) | undefined; }) => ", + "; type: string; scoped?: boolean | undefined; getExecutionContext?: (() => string | undefined) | undefined; agentManager: ", + "AgentManager", + "; }) => ", "default" ], "path": "packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/configure_client.ts", @@ -50,7 +52,7 @@ "id": "def-server.configureClient.$2", "type": "Object", "tags": [], - "label": "{\n logger,\n type,\n scoped = false,\n getExecutionContext = noop,\n }", + "label": "{\n logger,\n type,\n scoped = false,\n getExecutionContext = noop,\n agentManager,\n }", "description": [], "path": "packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/configure_client.ts", "deprecated": false, @@ -110,6 +112,20 @@ "trackAdoption": false, "children": [], "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-elasticsearch-client-server-internal", + "id": "def-server.configureClient.$2.agentManager", + "type": "Object", + "tags": [], + "label": "agentManager", + "description": [], + "signature": [ + "AgentManager" + ], + "path": "packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/configure_client.ts", + "deprecated": false, + "trackAdoption": false } ] } diff --git a/api_docs/kbn_core_elasticsearch_client_server_internal.mdx b/api_docs/kbn_core_elasticsearch_client_server_internal.mdx index 65546108902bd..9de0e77f1d83b 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-elasticsearch-client-server-internal'] --- import kbnCoreElasticsearchClientServerInternalObj from './kbn_core_elasticsearch_client_server_internal.devdocs.json'; @@ -21,7 +21,7 @@ Contact Kibana Core for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 11 | 0 | 9 | 0 | +| 12 | 0 | 10 | 1 | ## Server 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 a9b967b7e2c98..c682403d3d63d 100644 --- a/api_docs/kbn_core_elasticsearch_client_server_mocks.devdocs.json +++ b/api_docs/kbn_core_elasticsearch_client_server_mocks.devdocs.json @@ -237,7 +237,7 @@ "label": "asInternalUser", "description": [], "signature": [ - "{ get: ", + "{ name: string | symbol; get: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", "scope": "server", @@ -341,7 +341,7 @@ }, "<", "default", - ">; name: string | symbol; index: ", + ">; index: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", "scope": "server", @@ -1348,7 +1348,7 @@ "label": "asInternalUser", "description": [], "signature": [ - "{ get: ", + "{ name: string | symbol; get: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", "scope": "server", @@ -1452,7 +1452,7 @@ }, "<", "default", - ">; name: string | symbol; index: ", + ">; index: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", "scope": "server", @@ -2413,7 +2413,7 @@ "label": "asCurrentUser", "description": [], "signature": [ - "{ get: ", + "{ name: string | symbol; get: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", "scope": "server", @@ -2517,7 +2517,7 @@ }, "<", "default", - ">; name: string | symbol; index: ", + ">; index: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", "scope": "server", @@ -3545,7 +3545,7 @@ "label": "ElasticsearchClientMock", "description": [], "signature": [ - "{ get: ", + "{ name: string | symbol; get: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", "scope": "server", @@ -3649,7 +3649,7 @@ }, "<", "default", - ">; name: string | symbol; index: ", + ">; index: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", "scope": "server", diff --git a/api_docs/kbn_core_elasticsearch_client_server_mocks.mdx b/api_docs/kbn_core_elasticsearch_client_server_mocks.mdx index b119bfb2ad808..7b77b445df55e 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: 2022-09-09 +date: 2022-09-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.devdocs.json b/api_docs/kbn_core_elasticsearch_server.devdocs.json index 7f41607270e7a..a6bbfb7a58cb9 100644 --- a/api_docs/kbn_core_elasticsearch_server.devdocs.json +++ b/api_docs/kbn_core_elasticsearch_server.devdocs.json @@ -883,7 +883,7 @@ "\nA {@link ElasticsearchClient | client} to be used to query the ES cluster on behalf of the Kibana internal user" ], "signature": [ - "{ get: { (this: That, params: ", + "{ name: string | symbol; get: { (this: That, params: ", "GetRequest", " | ", "GetRequest", @@ -1001,7 +1001,7 @@ "default", "; security: ", "default", - "; name: string | symbol; index: { (this: That, params: ", + "; index: { (this: That, params: ", "IndexRequest", " | ", "IndexRequest", @@ -2499,7 +2499,7 @@ "\nA {@link ElasticsearchClient | client} to be used to query the elasticsearch cluster\non behalf of the internal Kibana user." ], "signature": [ - "{ get: { (this: That, params: ", + "{ name: string | symbol; get: { (this: That, params: ", "GetRequest", " | ", "GetRequest", @@ -2617,7 +2617,7 @@ "default", "; security: ", "default", - "; name: string | symbol; index: { (this: That, params: ", + "; index: { (this: That, params: ", "IndexRequest", " | ", "IndexRequest", @@ -3703,7 +3703,7 @@ "\nA {@link ElasticsearchClient | client} to be used to query the elasticsearch cluster\non behalf of the user that initiated the request to the Kibana server." ], "signature": [ - "{ get: { (this: That, params: ", + "{ name: string | symbol; get: { (this: That, params: ", "GetRequest", " | ", "GetRequest", @@ -3821,7 +3821,7 @@ "default", "; security: ", "default", - "; name: string | symbol; index: { (this: That, params: ", + "; index: { (this: That, params: ", "IndexRequest", " | ", "IndexRequest", @@ -5154,7 +5154,7 @@ "\nClient used to query the elasticsearch cluster.\n" ], "signature": [ - "{ get: { (this: That, params: ", + "{ name: string | symbol; get: { (this: That, params: ", "GetRequest", " | ", "GetRequest", @@ -5272,7 +5272,7 @@ "default", "; security: ", "default", - "; name: string | symbol; index: { (this: That, params: ", + "; index: { (this: That, params: ", "IndexRequest", " | ", "IndexRequest", diff --git a/api_docs/kbn_core_elasticsearch_server.mdx b/api_docs/kbn_core_elasticsearch_server.mdx index d8d8afa63313d..226141067a8d8 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: 2022-09-09 +date: 2022-09-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.devdocs.json b/api_docs/kbn_core_elasticsearch_server_internal.devdocs.json index 9ddb76f9557d6..248c3b356fa14 100644 --- a/api_docs/kbn_core_elasticsearch_server_internal.devdocs.json +++ b/api_docs/kbn_core_elasticsearch_server_internal.devdocs.json @@ -46,7 +46,7 @@ "label": "client", "description": [], "signature": [ - "{ get: { (this: That, params: ", + "{ name: string | symbol; get: { (this: That, params: ", "GetRequest", " | ", "GetRequest", @@ -164,7 +164,7 @@ "default", "; security: ", "default", - "; name: string | symbol; index: { (this: That, params: ", + "; index: { (this: That, params: ", "IndexRequest", " | ", "IndexRequest", @@ -1629,7 +1629,7 @@ "label": "internalClient", "description": [], "signature": [ - "{ get: { (this: That, params: ", + "{ name: string | symbol; get: { (this: That, params: ", "GetRequest", " | ", "GetRequest", @@ -1747,7 +1747,7 @@ "default", "; security: ", "default", - "; name: string | symbol; index: { (this: That, params: ", + "; index: { (this: That, params: ", "IndexRequest", " | ", "IndexRequest", @@ -2884,7 +2884,7 @@ "label": "ElasticsearchConfigType", "description": [], "signature": [ - "{ readonly username?: string | undefined; readonly password?: string | undefined; readonly serviceAccountToken?: string | undefined; readonly ssl: Readonly<{ key?: string | undefined; certificateAuthorities?: string | string[] | undefined; certificate?: string | undefined; keyPassphrase?: string | undefined; } & { verificationMode: \"none\" | \"full\" | \"certificate\"; keystore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>; readonly healthCheck: Readonly<{} & { delay: moment.Duration; }>; readonly customHeaders: Record; readonly hosts: string | string[]; readonly sniffOnStart: boolean; readonly sniffInterval: false | moment.Duration; readonly sniffOnConnectionFault: boolean; readonly maxSockets: number; readonly compression: boolean; readonly requestHeadersWhitelist: string | string[]; readonly shardTimeout: moment.Duration; readonly requestTimeout: moment.Duration; readonly pingTimeout: moment.Duration; readonly logQueries: boolean; readonly apiVersion: string; readonly ignoreVersionMismatch: boolean; readonly skipStartupConnectionCheck: boolean; }" + "{ readonly username?: string | undefined; readonly password?: string | undefined; readonly serviceAccountToken?: string | undefined; readonly requestTimeout: moment.Duration; readonly compression: boolean; readonly ssl: Readonly<{ key?: string | undefined; certificateAuthorities?: string | string[] | undefined; certificate?: string | undefined; keyPassphrase?: string | undefined; } & { verificationMode: \"none\" | \"full\" | \"certificate\"; keystore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>; readonly healthCheck: Readonly<{} & { delay: moment.Duration; }>; readonly customHeaders: Record; readonly hosts: string | string[]; readonly sniffOnStart: boolean; readonly sniffInterval: false | moment.Duration; readonly sniffOnConnectionFault: boolean; readonly maxSockets: number; readonly requestHeadersWhitelist: string | string[]; readonly shardTimeout: moment.Duration; readonly pingTimeout: moment.Duration; readonly logQueries: boolean; readonly apiVersion: string; readonly ignoreVersionMismatch: boolean; readonly skipStartupConnectionCheck: boolean; }" ], "path": "packages/core/elasticsearch/core-elasticsearch-server-internal/src/elasticsearch_config.ts", "deprecated": false, diff --git a/api_docs/kbn_core_elasticsearch_server_internal.mdx b/api_docs/kbn_core_elasticsearch_server_internal.mdx index 7bb38a3c5f0bf..44deabd806282 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: 2022-09-09 +date: 2022-09-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 0a31709c05f67..9ac1cdcb19f0f 100644 --- a/api_docs/kbn_core_elasticsearch_server_mocks.devdocs.json +++ b/api_docs/kbn_core_elasticsearch_server_mocks.devdocs.json @@ -47,9 +47,9 @@ "signature": [ "jest.MockInstance<", "CustomClusterClientMock", - ", [name: string, config?: Partial<", + ", [type: string, config?: Partial<", "ElasticsearchClientConfig", - "> | undefined]> & ((name: string, config?: Partial<", + "> | undefined]> & ((type: string, config?: Partial<", "ElasticsearchClientConfig", "> | undefined) => ", "CustomClusterClientMock", @@ -65,7 +65,7 @@ "id": "def-server.MockedElasticSearchServiceStart.createClient.$1", "type": "string", "tags": [], - "label": "name", + "label": "type", "description": [], "path": "packages/core/elasticsearch/core-elasticsearch-server-mocks/src/elasticsearch_service.mock.ts", "deprecated": false, diff --git a/api_docs/kbn_core_elasticsearch_server_mocks.mdx b/api_docs/kbn_core_elasticsearch_server_mocks.mdx index da30359337d2f..4588b1e74c0fc 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: 2022-09-09 +date: 2022-09-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 115eabde42da7..14d84cfd0c01e 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: 2022-09-09 +date: 2022-09-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 edfcddc56edc1..34101622d0bb1 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: 2022-09-09 +date: 2022-09-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 6d3b3e2cf0095..8412cea09e8dc 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: 2022-09-09 +date: 2022-09-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 fcc2284968ba8..a488597af297c 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: 2022-09-09 +date: 2022-09-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 48919a14adc5d..906e6aa1e6d33 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: 2022-09-09 +date: 2022-09-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 0a87811f9fa6d..25cbf34eaceb0 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: 2022-09-09 +date: 2022-09-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 be640b0bd6c12..430afd1e0013b 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: 2022-09-09 +date: 2022-09-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 4d9363ee6d067..34072ca6dfde7 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: 2022-09-09 +date: 2022-09-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 8e1632be18c1b..4d424546b14b7 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: 2022-09-09 +date: 2022-09-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 7fee5984f817a..4ea933853df2d 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: 2022-09-09 +date: 2022-09-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 c989c3c38eff4..397f9e99b4924 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: 2022-09-09 +date: 2022-09-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 ab44b913d6d22..c781ba9fff5a3 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: 2022-09-09 +date: 2022-09-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 a23bfab235572..0be92db2558f6 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: 2022-09-09 +date: 2022-09-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.mdx b/api_docs/kbn_core_http_browser_mocks.mdx index cc4ba299fcd2f..06d2f6cda8dbb 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: 2022-09-09 +date: 2022-09-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 f3ad4235ca0bd..1bccc28f3add7 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: 2022-09-09 +date: 2022-09-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.mdx b/api_docs/kbn_core_http_context_server_mocks.mdx index 8e03645953472..889dd33ec6144 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: 2022-09-09 +date: 2022-09-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_router_server_internal.mdx b/api_docs/kbn_core_http_router_server_internal.mdx index cd7e2beebf898..d6bf834e28d3f 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: 2022-09-09 +date: 2022-09-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.mdx b/api_docs/kbn_core_http_router_server_mocks.mdx index 355ed41119b58..02de9f766f698 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: 2022-09-09 +date: 2022-09-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 6fbfbacd7757a..2fdd0ff9d2a33 100644 --- a/api_docs/kbn_core_http_server.devdocs.json +++ b/api_docs/kbn_core_http_server.devdocs.json @@ -4544,7 +4544,7 @@ "label": "options", "description": [], "signature": [ - "Method extends \"get\" | \"options\" ? Required; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; cipherSuites: string[]; supportedProtocols: string[]; clientAuthentication: \"optional\" | \"none\" | \"required\"; }>; readonly port: number; readonly compression: Readonly<{ referrerWhitelist?: string[] | undefined; } & { enabled: boolean; }>; readonly cors: Readonly<{} & { enabled: boolean; allowCredentials: boolean; allowOrigin: string[] | \"*\"[]; }>; readonly autoListen: boolean; readonly shutdownTimeout: moment.Duration; readonly securityResponseHeaders: Readonly<{} & { referrerPolicy: \"origin\" | \"no-referrer\" | \"no-referrer-when-downgrade\" | \"origin-when-cross-origin\" | \"same-origin\" | \"strict-origin\" | \"strict-origin-when-cross-origin\" | \"unsafe-url\" | null; disableEmbedding: boolean; strictTransportSecurity: string | null; xContentTypeOptions: \"nosniff\" | null; permissionsPolicy: string | null; }>; readonly customResponseHeaders: Record; readonly maxPayload: ", + "{ readonly basePath?: string | undefined; readonly uuid?: string | undefined; readonly publicBaseUrl?: string | undefined; readonly name: string; readonly host: string; readonly compression: Readonly<{ referrerWhitelist?: string[] | undefined; } & { enabled: boolean; }>; readonly ssl: Readonly<{ key?: string | undefined; certificateAuthorities?: string | string[] | undefined; certificate?: string | undefined; keyPassphrase?: string | undefined; redirectHttpFromPort?: number | undefined; } & { enabled: boolean; keystore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; cipherSuites: string[]; supportedProtocols: string[]; clientAuthentication: \"optional\" | \"none\" | \"required\"; }>; readonly port: number; readonly cors: Readonly<{} & { enabled: boolean; allowCredentials: boolean; allowOrigin: string[] | \"*\"[]; }>; readonly autoListen: boolean; readonly shutdownTimeout: moment.Duration; readonly securityResponseHeaders: Readonly<{} & { referrerPolicy: \"origin\" | \"no-referrer\" | \"no-referrer-when-downgrade\" | \"origin-when-cross-origin\" | \"same-origin\" | \"strict-origin\" | \"strict-origin-when-cross-origin\" | \"unsafe-url\" | null; disableEmbedding: boolean; strictTransportSecurity: string | null; xContentTypeOptions: \"nosniff\" | null; permissionsPolicy: string | null; }>; readonly customResponseHeaders: Record; readonly maxPayload: ", "ByteSizeValue", "; readonly rewriteBasePath: boolean; readonly keepaliveTimeout: number; readonly socketTimeout: number; readonly xsrf: Readonly<{} & { disableProtection: boolean; allowlist: string[]; }>; readonly requestId: Readonly<{} & { allowFromAnyIp: boolean; ipAllowlist: string[]; }>; }" ], diff --git a/api_docs/kbn_core_http_server_internal.mdx b/api_docs/kbn_core_http_server_internal.mdx index 8c1ce95e5da38..c7c396db97c20 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: 2022-09-09 +date: 2022-09-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.mdx b/api_docs/kbn_core_http_server_mocks.mdx index 9855a467f8ff3..ca70a925fbb56 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: 2022-09-09 +date: 2022-09-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 e10bab2bb0ef1..3660bcc446cf5 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: 2022-09-09 +date: 2022-09-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 6bbcf9a1ed58f..75e85149ca6c4 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: 2022-09-09 +date: 2022-09-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 ca0b28fad3b83..a5f96ecfd44b4 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: 2022-09-09 +date: 2022-09-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 d0b3e5f8750ae..497956f0ee8a3 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: 2022-09-09 +date: 2022-09-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 09595678ffd95..24e3538122a9d 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: 2022-09-09 +date: 2022-09-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.mdx b/api_docs/kbn_core_injected_metadata_browser.mdx index f98bc4b4caa51..58b512d1545c7 100644 --- a/api_docs/kbn_core_injected_metadata_browser.mdx +++ b/api_docs/kbn_core_injected_metadata_browser.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-injected-metadata-browser title: "@kbn/core-injected-metadata-browser" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-injected-metadata-browser plugin -date: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-injected-metadata-browser'] --- import kbnCoreInjectedMetadataBrowserObj from './kbn_core_injected_metadata_browser.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 2d6f60b30b0f4..de5f52b8471e4 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: 2022-09-09 +date: 2022-09-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 7d6d538a4a345..0637bb9d8925e 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: 2022-09-09 +date: 2022-09-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.mdx b/api_docs/kbn_core_integrations_browser_mocks.mdx index 965b44c3d7f49..3e7b806dc160a 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: 2022-09-09 +date: 2022-09-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_logging_server.devdocs.json b/api_docs/kbn_core_logging_server.devdocs.json index 0ee04816b3df4..8a5748a6993ce 100644 --- a/api_docs/kbn_core_logging_server.devdocs.json +++ b/api_docs/kbn_core_logging_server.devdocs.json @@ -215,7 +215,7 @@ "label": "level", "description": [], "signature": [ - "\"error\" | \"all\" | \"info\" | \"debug\" | \"off\" | \"trace\" | \"warn\" | \"fatal\"" + "\"error\" | \"all\" | \"info\" | \"debug\" | \"off\" | \"warn\" | \"trace\" | \"fatal\"" ], "path": "packages/core/logging/core-logging-server/src/logger.ts", "deprecated": false, diff --git a/api_docs/kbn_core_logging_server.mdx b/api_docs/kbn_core_logging_server.mdx index baf526633cb7f..55eb0c12108de 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: 2022-09-09 +date: 2022-09-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.devdocs.json b/api_docs/kbn_core_logging_server_internal.devdocs.json index d323e46daf7f2..97a1788e84dcb 100644 --- a/api_docs/kbn_core_logging_server_internal.devdocs.json +++ b/api_docs/kbn_core_logging_server_internal.devdocs.json @@ -149,7 +149,7 @@ "AppenderConfigType", ">>; loggers: ", "Type", - "[]>; }>" + "[]>; }>" ], "path": "packages/core/logging/core-logging-server-internal/src/logging_config.ts", "deprecated": false, @@ -173,7 +173,7 @@ "Type", "; level: ", "Type", - "<\"error\" | \"all\" | \"info\" | \"debug\" | \"off\" | \"trace\" | \"warn\" | \"fatal\">; }>" + "<\"error\" | \"all\" | \"info\" | \"debug\" | \"off\" | \"warn\" | \"trace\" | \"fatal\">; }>" ], "path": "packages/core/logging/core-logging-server-internal/src/logging_config.ts", "deprecated": false, diff --git a/api_docs/kbn_core_logging_server_internal.mdx b/api_docs/kbn_core_logging_server_internal.mdx index c7e3e793271dc..f50fbbca7396c 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: 2022-09-09 +date: 2022-09-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 ba256a3dc7685..a674bd9826403 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: 2022-09-09 +date: 2022-09-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 20ddad2be7f37..24e800f05030e 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: 2022-09-09 +date: 2022-09-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 6278558d4a15b..6d04faa001d5a 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: 2022-09-09 +date: 2022-09-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 774dbb4aa58f2..67c149514411e 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: 2022-09-09 +date: 2022-09-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 b68f29089b3c5..aae45e4a49448 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: 2022-09-09 +date: 2022-09-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 9da56c2b13d54..99a09376c4b9b 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: 2022-09-09 +date: 2022-09-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 fc5ad5407ea58..fb1266aaba745 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: 2022-09-09 +date: 2022-09-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 cbc248a380a6e..b3f8467f9f307 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: 2022-09-09 +date: 2022-09-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 6c389f91fb1de..d0b884478e8d8 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: 2022-09-09 +date: 2022-09-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 e8223e2b45977..4374729c68ce3 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: 2022-09-09 +date: 2022-09-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 2c27b78aff6bb..ed6b7c356b79f 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: 2022-09-09 +date: 2022-09-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 197b80b4ba630..4e05d51b17b25 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: 2022-09-09 +date: 2022-09-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 bf9b1d6b28607..0b13cdbd31306 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: 2022-09-09 +date: 2022-09-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 21561dfeb133d..8f1a0f8bbbbad 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: 2022-09-09 +date: 2022-09-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 d4790272c355d..15b9282a5911d 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: 2022-09-09 +date: 2022-09-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 1e44984b977ae..1e7f0b4206b89 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: 2022-09-09 +date: 2022-09-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_preboot_server.mdx b/api_docs/kbn_core_preboot_server.mdx index 064c1a7409c91..7e9afcaea1185 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: 2022-09-09 +date: 2022-09-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.mdx b/api_docs/kbn_core_preboot_server_mocks.mdx index 68d8ba8c77e35..0aea4d9e2256a 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: 2022-09-09 +date: 2022-09-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 33c45bca370db..87ef4b638ae7b 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: 2022-09-09 +date: 2022-09-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_saved_objects_api_browser.mdx b/api_docs/kbn_core_saved_objects_api_browser.mdx index 8fb776cf68240..fb16daa874388 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: 2022-09-09 +date: 2022-09-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 0ff68d0fc7bda..74d6732ba03ba 100644 --- a/api_docs/kbn_core_saved_objects_api_server.devdocs.json +++ b/api_docs/kbn_core_saved_objects_api_server.devdocs.json @@ -2391,7 +2391,7 @@ "tags": [], "label": "attributes", "description": [ - "{@inheritdoc SavedObjectAttributes}" + "The data for a Saved Object is stored as an object in the `attributes` property." ], "signature": [ "{ [P in keyof T]?: T[P] | undefined; }" diff --git a/api_docs/kbn_core_saved_objects_api_server.mdx b/api_docs/kbn_core_saved_objects_api_server.mdx index 37b831645698d..f308f99088f93 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: 2022-09-09 +date: 2022-09-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_internal.mdx b/api_docs/kbn_core_saved_objects_api_server_internal.mdx index b1e0f26591dea..f0a6438fc4fa6 100644 --- a/api_docs/kbn_core_saved_objects_api_server_internal.mdx +++ b/api_docs/kbn_core_saved_objects_api_server_internal.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-saved-objects-api-server-internal title: "@kbn/core-saved-objects-api-server-internal" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/core-saved-objects-api-server-internal plugin -date: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-api-server-internal'] --- import kbnCoreSavedObjectsApiServerInternalObj from './kbn_core_saved_objects_api_server_internal.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 76e6857265343..387d4624b34cb 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: 2022-09-09 +date: 2022-09-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 b0656d2d7698c..3fd8a5c5e9c37 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: 2022-09-09 +date: 2022-09-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 ecd8eb6b89e58..96ebbe50c9dbb 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: 2022-09-09 +date: 2022-09-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 3095a10b0e8a3..814bc13c8a0f0 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: 2022-09-09 +date: 2022-09-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 6e6235f54d936..321a185f26b0c 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: 2022-09-09 +date: 2022-09-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 9ba194c06f4bd..0eff5fe3a0815 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: 2022-09-09 +date: 2022-09-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 f6d379e5699ac..78a36566609fa 100644 --- a/api_docs/kbn_core_saved_objects_common.devdocs.json +++ b/api_docs/kbn_core_saved_objects_common.devdocs.json @@ -127,7 +127,7 @@ "tags": [], "label": "attributes", "description": [ - "{@inheritdoc SavedObjectAttributes}" + "The data for a Saved Object is stored as an object in the `attributes` property." ], "signature": [ "T" @@ -237,14 +237,17 @@ "parentPluginId": "@kbn/core-saved-objects-common", "id": "def-common.SavedObjectAttributes", "type": "Interface", - "tags": [], + "tags": [ + "deprecated" + ], "label": "SavedObjectAttributes", "description": [ "\nThe data for a Saved Object is stored as an object in the `attributes`\nproperty.\n" ], "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts", - "deprecated": false, + "deprecated": true, "trackAdoption": false, + "references": [], "children": [ { "parentPluginId": "@kbn/core-saved-objects-common", diff --git a/api_docs/kbn_core_saved_objects_common.mdx b/api_docs/kbn_core_saved_objects_common.mdx index 841d63be63be4..3543ac5cce759 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: 2022-09-09 +date: 2022-09-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 62ca0892a8ef0..dbb9933bd19ef 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: 2022-09-09 +date: 2022-09-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 6db912ca3d51d..ee4489e6cee50 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: 2022-09-09 +date: 2022-09-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.devdocs.json b/api_docs/kbn_core_saved_objects_migration_server_internal.devdocs.json index 0ff9be0a9591b..3e01e7bbd7649 100644 --- a/api_docs/kbn_core_saved_objects_migration_server_internal.devdocs.json +++ b/api_docs/kbn_core_saved_objects_migration_server_internal.devdocs.json @@ -1757,7 +1757,7 @@ "label": "client", "description": [], "signature": [ - "{ get: { (this: That, params: ", + "{ name: string | symbol; get: { (this: That, params: ", "GetRequest", " | ", "GetRequest", @@ -1875,7 +1875,7 @@ "default", "; security: ", "default", - "; name: string | symbol; index: { (this: That, params: ", + "; index: { (this: That, params: ", "IndexRequest", " | ", "IndexRequest", 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 124ba03f2d7cb..f3c16660d9b57 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: 2022-09-09 +date: 2022-09-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 436795ec64440..181a58b3b26d0 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: 2022-09-09 +date: 2022-09-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 3ab55e6ecc442..f21f0a648a391 100644 --- a/api_docs/kbn_core_saved_objects_server.devdocs.json +++ b/api_docs/kbn_core_saved_objects_server.devdocs.json @@ -2754,9 +2754,7 @@ "\nRegister a {@link SavedObjectsType | savedObjects type} definition.\n\nSee the {@link SavedObjectsTypeMappingDefinition | mappings format} and\n{@link SavedObjectMigrationMap | migration format} for more details about these.\n" ], "signature": [ - "(type: ", + "(type: ", { "pluginId": "@kbn/core-saved-objects-server", "scope": "server", diff --git a/api_docs/kbn_core_saved_objects_server.mdx b/api_docs/kbn_core_saved_objects_server.mdx index d39b682d0e922..9e0a46fb69b22 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: 2022-09-09 +date: 2022-09-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 097b612967b60..a4e0fa38d323b 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: 2022-09-09 +date: 2022-09-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 5cfc809e628d4..6b1a14d7b5a92 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: 2022-09-09 +date: 2022-09-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 0735565b60ba3..cc7cefe0fc9cc 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: 2022-09-09 +date: 2022-09-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.devdocs.json b/api_docs/kbn_core_status_common.devdocs.json new file mode 100644 index 0000000000000..10cab0bc06263 --- /dev/null +++ b/api_docs/kbn_core_status_common.devdocs.json @@ -0,0 +1,242 @@ +{ + "id": "@kbn/core-status-common", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [ + { + "parentPluginId": "@kbn/core-status-common", + "id": "def-common.CoreStatus", + "type": "Interface", + "tags": [], + "label": "CoreStatus", + "description": [ + "\nStatus of core services.\n" + ], + "path": "packages/core/status/core-status-common/src/core_status.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-status-common", + "id": "def-common.CoreStatus.elasticsearch", + "type": "Object", + "tags": [], + "label": "elasticsearch", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-status-common", + "scope": "common", + "docId": "kibKbnCoreStatusCommonPluginApi", + "section": "def-common.ServiceStatus", + "text": "ServiceStatus" + }, + "" + ], + "path": "packages/core/status/core-status-common/src/core_status.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-status-common", + "id": "def-common.CoreStatus.savedObjects", + "type": "Object", + "tags": [], + "label": "savedObjects", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-status-common", + "scope": "common", + "docId": "kibKbnCoreStatusCommonPluginApi", + "section": "def-common.ServiceStatus", + "text": "ServiceStatus" + }, + "" + ], + "path": "packages/core/status/core-status-common/src/core_status.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-status-common", + "id": "def-common.ServiceStatus", + "type": "Interface", + "tags": [], + "label": "ServiceStatus", + "description": [ + "\nThe current status of a service at a point in time.\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-status-common", + "scope": "common", + "docId": "kibKbnCoreStatusCommonPluginApi", + "section": "def-common.ServiceStatus", + "text": "ServiceStatus" + }, + "" + ], + "path": "packages/core/status/core-status-common/src/service_status.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-status-common", + "id": "def-common.ServiceStatus.level", + "type": "CompoundType", + "tags": [], + "label": "level", + "description": [ + "\nThe current availability level of the service." + ], + "signature": [ + "Readonly<{ toString: () => \"available\"; valueOf: () => 0; toJSON: () => \"available\"; }> | Readonly<{ toString: () => \"degraded\"; valueOf: () => 1; toJSON: () => \"degraded\"; }> | Readonly<{ toString: () => \"unavailable\"; valueOf: () => 2; toJSON: () => \"unavailable\"; }> | Readonly<{ toString: () => \"critical\"; valueOf: () => 3; toJSON: () => \"critical\"; }>" + ], + "path": "packages/core/status/core-status-common/src/service_status.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-status-common", + "id": "def-common.ServiceStatus.summary", + "type": "string", + "tags": [], + "label": "summary", + "description": [ + "\nA high-level summary of the service status." + ], + "path": "packages/core/status/core-status-common/src/service_status.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-status-common", + "id": "def-common.ServiceStatus.detail", + "type": "string", + "tags": [], + "label": "detail", + "description": [ + "\nA more detailed description of the service status." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/status/core-status-common/src/service_status.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-status-common", + "id": "def-common.ServiceStatus.documentationUrl", + "type": "string", + "tags": [], + "label": "documentationUrl", + "description": [ + "\nA URL to open in a new tab about how to resolve or troubleshoot the problem." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/status/core-status-common/src/service_status.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-status-common", + "id": "def-common.ServiceStatus.meta", + "type": "Uncategorized", + "tags": [], + "label": "meta", + "description": [ + "\nAny JSON-serializable data to be included in the HTTP API response. Useful for providing more fine-grained,\nmachine-readable information about the service status. May include status information for underlying features." + ], + "signature": [ + "Meta | undefined" + ], + "path": "packages/core/status/core-status-common/src/service_status.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/core-status-common", + "id": "def-common.ServiceStatusLevel", + "type": "Type", + "tags": [], + "label": "ServiceStatusLevel", + "description": [ + "\nA convenience type that represents the union of each value in {@link ServiceStatusLevels}." + ], + "signature": [ + "Readonly<{ toString: () => \"available\"; valueOf: () => 0; toJSON: () => \"available\"; }> | Readonly<{ toString: () => \"degraded\"; valueOf: () => 1; toJSON: () => \"degraded\"; }> | Readonly<{ toString: () => \"unavailable\"; valueOf: () => 2; toJSON: () => \"unavailable\"; }> | Readonly<{ toString: () => \"critical\"; valueOf: () => 3; toJSON: () => \"critical\"; }>" + ], + "path": "packages/core/status/core-status-common/src/service_status.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-status-common", + "id": "def-common.ServiceStatusLevelId", + "type": "Type", + "tags": [], + "label": "ServiceStatusLevelId", + "description": [ + "\nPossible values for the ID of a {@link ServiceStatusLevel}\n" + ], + "signature": [ + "\"degraded\" | \"unavailable\" | \"available\" | \"critical\"" + ], + "path": "packages/core/status/core-status-common/src/service_status.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], + "objects": [ + { + "parentPluginId": "@kbn/core-status-common", + "id": "def-common.ServiceStatusLevels", + "type": "Object", + "tags": [], + "label": "ServiceStatusLevels", + "description": [ + "\nThe current \"level\" of availability of a service.\n" + ], + "signature": [ + "{ readonly available: Readonly<{ toString: () => \"available\"; valueOf: () => 0; toJSON: () => \"available\"; }>; readonly degraded: Readonly<{ toString: () => \"degraded\"; valueOf: () => 1; toJSON: () => \"degraded\"; }>; readonly unavailable: Readonly<{ toString: () => \"unavailable\"; valueOf: () => 2; toJSON: () => \"unavailable\"; }>; readonly critical: Readonly<{ toString: () => \"critical\"; valueOf: () => 3; toJSON: () => \"critical\"; }>; }" + ], + "path": "packages/core/status/core-status-common/src/service_status.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_status_common.mdx b/api_docs/kbn_core_status_common.mdx new file mode 100644 index 0000000000000..36290f4685f52 --- /dev/null +++ b/api_docs/kbn_core_status_common.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: kibKbnCoreStatusCommonPluginApi +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: 2022-09-20 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-status-common'] +--- +import kbnCoreStatusCommonObj from './kbn_core_status_common.devdocs.json'; + + + +Contact Kibana Core for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 12 | 0 | 2 | 0 | + +## Common + +### Objects + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/kbn_core_status_common_internal.devdocs.json b/api_docs/kbn_core_status_common_internal.devdocs.json new file mode 100644 index 0000000000000..eba46bfede8b3 --- /dev/null +++ b/api_docs/kbn_core_status_common_internal.devdocs.json @@ -0,0 +1,355 @@ +{ + "id": "@kbn/core-status-common-internal", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [ + { + "parentPluginId": "@kbn/core-status-common-internal", + "id": "def-common.ServerVersion", + "type": "Interface", + "tags": [], + "label": "ServerVersion", + "description": [], + "path": "packages/core/status/core-status-common-internal/src/status.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-status-common-internal", + "id": "def-common.ServerVersion.number", + "type": "string", + "tags": [], + "label": "number", + "description": [], + "path": "packages/core/status/core-status-common-internal/src/status.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-status-common-internal", + "id": "def-common.ServerVersion.build_hash", + "type": "string", + "tags": [], + "label": "build_hash", + "description": [], + "path": "packages/core/status/core-status-common-internal/src/status.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-status-common-internal", + "id": "def-common.ServerVersion.build_number", + "type": "number", + "tags": [], + "label": "build_number", + "description": [], + "path": "packages/core/status/core-status-common-internal/src/status.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-status-common-internal", + "id": "def-common.ServerVersion.build_snapshot", + "type": "boolean", + "tags": [], + "label": "build_snapshot", + "description": [], + "path": "packages/core/status/core-status-common-internal/src/status.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-status-common-internal", + "id": "def-common.StatusInfo", + "type": "Interface", + "tags": [], + "label": "StatusInfo", + "description": [], + "path": "packages/core/status/core-status-common-internal/src/status.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-status-common-internal", + "id": "def-common.StatusInfo.overall", + "type": "Object", + "tags": [], + "label": "overall", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-status-common-internal", + "scope": "common", + "docId": "kibKbnCoreStatusCommonInternalPluginApi", + "section": "def-common.StatusInfoServiceStatus", + "text": "StatusInfoServiceStatus" + } + ], + "path": "packages/core/status/core-status-common-internal/src/status.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-status-common-internal", + "id": "def-common.StatusInfo.core", + "type": "Object", + "tags": [], + "label": "core", + "description": [], + "signature": [ + "{ elasticsearch: ", + { + "pluginId": "@kbn/core-status-common-internal", + "scope": "common", + "docId": "kibKbnCoreStatusCommonInternalPluginApi", + "section": "def-common.StatusInfoServiceStatus", + "text": "StatusInfoServiceStatus" + }, + "; savedObjects: ", + { + "pluginId": "@kbn/core-status-common-internal", + "scope": "common", + "docId": "kibKbnCoreStatusCommonInternalPluginApi", + "section": "def-common.StatusInfoServiceStatus", + "text": "StatusInfoServiceStatus" + }, + "; }" + ], + "path": "packages/core/status/core-status-common-internal/src/status.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-status-common-internal", + "id": "def-common.StatusInfo.plugins", + "type": "Object", + "tags": [], + "label": "plugins", + "description": [], + "signature": [ + "{ [x: string]: ", + { + "pluginId": "@kbn/core-status-common-internal", + "scope": "common", + "docId": "kibKbnCoreStatusCommonInternalPluginApi", + "section": "def-common.StatusInfoServiceStatus", + "text": "StatusInfoServiceStatus" + }, + "; }" + ], + "path": "packages/core/status/core-status-common-internal/src/status.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-status-common-internal", + "id": "def-common.StatusInfoServiceStatus", + "type": "Interface", + "tags": [], + "label": "StatusInfoServiceStatus", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-status-common-internal", + "scope": "common", + "docId": "kibKbnCoreStatusCommonInternalPluginApi", + "section": "def-common.StatusInfoServiceStatus", + "text": "StatusInfoServiceStatus" + }, + " extends Omit<", + "ServiceStatus", + ", \"level\">" + ], + "path": "packages/core/status/core-status-common-internal/src/status.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-status-common-internal", + "id": "def-common.StatusInfoServiceStatus.level", + "type": "CompoundType", + "tags": [], + "label": "level", + "description": [], + "signature": [ + "\"degraded\" | \"unavailable\" | \"available\" | \"critical\"" + ], + "path": "packages/core/status/core-status-common-internal/src/status.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-status-common-internal", + "id": "def-common.StatusResponse", + "type": "Interface", + "tags": [], + "label": "StatusResponse", + "description": [], + "path": "packages/core/status/core-status-common-internal/src/status.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-status-common-internal", + "id": "def-common.StatusResponse.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "path": "packages/core/status/core-status-common-internal/src/status.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-status-common-internal", + "id": "def-common.StatusResponse.uuid", + "type": "string", + "tags": [], + "label": "uuid", + "description": [], + "path": "packages/core/status/core-status-common-internal/src/status.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-status-common-internal", + "id": "def-common.StatusResponse.version", + "type": "Object", + "tags": [], + "label": "version", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-status-common-internal", + "scope": "common", + "docId": "kibKbnCoreStatusCommonInternalPluginApi", + "section": "def-common.ServerVersion", + "text": "ServerVersion" + } + ], + "path": "packages/core/status/core-status-common-internal/src/status.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-status-common-internal", + "id": "def-common.StatusResponse.status", + "type": "Object", + "tags": [], + "label": "status", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-status-common-internal", + "scope": "common", + "docId": "kibKbnCoreStatusCommonInternalPluginApi", + "section": "def-common.StatusInfo", + "text": "StatusInfo" + } + ], + "path": "packages/core/status/core-status-common-internal/src/status.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-status-common-internal", + "id": "def-common.StatusResponse.metrics", + "type": "CompoundType", + "tags": [], + "label": "metrics", + "description": [], + "signature": [ + "Omit<", + "OpsMetrics", + ", \"collected_at\"> & { last_updated: string; collection_interval_in_millis: number; requests: { status_codes: Record; }; }" + ], + "path": "packages/core/status/core-status-common-internal/src/status.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/core-status-common-internal", + "id": "def-common.ServerMetrics", + "type": "Type", + "tags": [], + "label": "ServerMetrics", + "description": [], + "signature": [ + "Omit<", + "OpsMetrics", + ", \"collected_at\"> & { last_updated: string; collection_interval_in_millis: number; requests: { status_codes: Record; }; }" + ], + "path": "packages/core/status/core-status-common-internal/src/status.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-status-common-internal", + "id": "def-common.StatusInfoCoreStatus", + "type": "Type", + "tags": [], + "label": "StatusInfoCoreStatus", + "description": [ + "\nCopy all the services listed in CoreStatus with their specific ServiceStatus declarations\nbut overwriting the `level` to its stringified version." + ], + "signature": [ + "{ elasticsearch: ", + { + "pluginId": "@kbn/core-status-common-internal", + "scope": "common", + "docId": "kibKbnCoreStatusCommonInternalPluginApi", + "section": "def-common.StatusInfoServiceStatus", + "text": "StatusInfoServiceStatus" + }, + "; savedObjects: ", + { + "pluginId": "@kbn/core-status-common-internal", + "scope": "common", + "docId": "kibKbnCoreStatusCommonInternalPluginApi", + "section": "def-common.StatusInfoServiceStatus", + "text": "StatusInfoServiceStatus" + }, + "; }" + ], + "path": "packages/core/status/core-status-common-internal/src/status.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_status_common_internal.mdx b/api_docs/kbn_core_status_common_internal.mdx new file mode 100644 index 0000000000000..764213f0fcc65 --- /dev/null +++ b/api_docs/kbn_core_status_common_internal.mdx @@ -0,0 +1,33 @@ +--- +#### +#### This 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: kibKbnCoreStatusCommonInternalPluginApi +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: 2022-09-20 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-status-common-internal'] +--- +import kbnCoreStatusCommonInternalObj from './kbn_core_status_common_internal.devdocs.json'; + + + +Contact Kibana Core for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 19 | 0 | 18 | 0 | + +## Common + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/kbn_core_status_server.devdocs.json b/api_docs/kbn_core_status_server.devdocs.json new file mode 100644 index 0000000000000..5ec5b6bbeb967 --- /dev/null +++ b/api_docs/kbn_core_status_server.devdocs.json @@ -0,0 +1,378 @@ +{ + "id": "@kbn/core-status-server", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [ + { + "parentPluginId": "@kbn/core-status-server", + "id": "def-server.CoreStatus", + "type": "Interface", + "tags": [], + "label": "CoreStatus", + "description": [ + "\nStatus of core services.\n" + ], + "signature": [ + "CoreStatus" + ], + "path": "node_modules/@types/kbn__core-status-common/index.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-status-server", + "id": "def-server.CoreStatus.elasticsearch", + "type": "Object", + "tags": [], + "label": "elasticsearch", + "description": [], + "signature": [ + "ServiceStatus", + "" + ], + "path": "node_modules/@types/kbn__core-status-common/index.d.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-status-server", + "id": "def-server.CoreStatus.savedObjects", + "type": "Object", + "tags": [], + "label": "savedObjects", + "description": [], + "signature": [ + "ServiceStatus", + "" + ], + "path": "node_modules/@types/kbn__core-status-common/index.d.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-status-server", + "id": "def-server.ServiceStatus", + "type": "Interface", + "tags": [], + "label": "ServiceStatus", + "description": [ + "\nThe current status of a service at a point in time.\n" + ], + "signature": [ + "ServiceStatus", + "" + ], + "path": "node_modules/@types/kbn__core-status-common/index.d.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-status-server", + "id": "def-server.ServiceStatus.level", + "type": "CompoundType", + "tags": [], + "label": "level", + "description": [ + "\nThe current availability level of the service." + ], + "signature": [ + "Readonly<{ toString: () => \"available\"; valueOf: () => 0; toJSON: () => \"available\"; }> | Readonly<{ toString: () => \"degraded\"; valueOf: () => 1; toJSON: () => \"degraded\"; }> | Readonly<{ toString: () => \"unavailable\"; valueOf: () => 2; toJSON: () => \"unavailable\"; }> | Readonly<{ toString: () => \"critical\"; valueOf: () => 3; toJSON: () => \"critical\"; }>" + ], + "path": "node_modules/@types/kbn__core-status-common/index.d.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-status-server", + "id": "def-server.ServiceStatus.summary", + "type": "string", + "tags": [], + "label": "summary", + "description": [ + "\nA high-level summary of the service status." + ], + "path": "node_modules/@types/kbn__core-status-common/index.d.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-status-server", + "id": "def-server.ServiceStatus.detail", + "type": "string", + "tags": [], + "label": "detail", + "description": [ + "\nA more detailed description of the service status." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-status-common/index.d.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-status-server", + "id": "def-server.ServiceStatus.documentationUrl", + "type": "string", + "tags": [], + "label": "documentationUrl", + "description": [ + "\nA URL to open in a new tab about how to resolve or troubleshoot the problem." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-status-common/index.d.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-status-server", + "id": "def-server.ServiceStatus.meta", + "type": "Uncategorized", + "tags": [], + "label": "meta", + "description": [ + "\nAny JSON-serializable data to be included in the HTTP API response. Useful for providing more fine-grained,\nmachine-readable information about the service status. May include status information for underlying features." + ], + "signature": [ + "Meta | undefined" + ], + "path": "node_modules/@types/kbn__core-status-common/index.d.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-status-server", + "id": "def-server.StatusServiceSetup", + "type": "Interface", + "tags": [], + "label": "StatusServiceSetup", + "description": [ + "\nAPI for accessing status of Core and this plugin's dependencies as well as for customizing this plugin's status.\n" + ], + "path": "packages/core/status/core-status-server/src/contracts.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-status-server", + "id": "def-server.StatusServiceSetup.core$", + "type": "Object", + "tags": [], + "label": "core$", + "description": [ + "\nCurrent status for all Core services." + ], + "signature": [ + "Observable", + "<", + "CoreStatus", + ">" + ], + "path": "packages/core/status/core-status-server/src/contracts.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-status-server", + "id": "def-server.StatusServiceSetup.overall$", + "type": "Object", + "tags": [], + "label": "overall$", + "description": [ + "\nOverall system status for all of Kibana.\n" + ], + "signature": [ + "Observable", + "<", + "ServiceStatus", + ">" + ], + "path": "packages/core/status/core-status-server/src/contracts.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-status-server", + "id": "def-server.StatusServiceSetup.set", + "type": "Function", + "tags": [], + "label": "set", + "description": [ + "\nAllows a plugin to specify a custom status dependent on its own criteria.\nCompletely overrides the default inherited status.\n" + ], + "signature": [ + "(status$: ", + "Observable", + "<", + "ServiceStatus", + ">) => void" + ], + "path": "packages/core/status/core-status-server/src/contracts.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-status-server", + "id": "def-server.StatusServiceSetup.set.$1", + "type": "Object", + "tags": [], + "label": "status$", + "description": [], + "signature": [ + "Observable", + "<", + "ServiceStatus", + ">" + ], + "path": "packages/core/status/core-status-server/src/contracts.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-status-server", + "id": "def-server.StatusServiceSetup.dependencies$", + "type": "Object", + "tags": [], + "label": "dependencies$", + "description": [ + "\nCurrent status for all plugins this plugin depends on.\nEach key of the `Record` is a plugin id." + ], + "signature": [ + "Observable", + ">>" + ], + "path": "packages/core/status/core-status-server/src/contracts.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-status-server", + "id": "def-server.StatusServiceSetup.derivedStatus$", + "type": "Object", + "tags": [], + "label": "derivedStatus$", + "description": [ + "\nThe status of this plugin as derived from its dependencies.\n" + ], + "signature": [ + "Observable", + "<", + "ServiceStatus", + ">" + ], + "path": "packages/core/status/core-status-server/src/contracts.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-status-server", + "id": "def-server.StatusServiceSetup.isStatusPageAnonymous", + "type": "Function", + "tags": [], + "label": "isStatusPageAnonymous", + "description": [ + "\nWhether or not the status HTTP APIs are available to unauthenticated users when an authentication provider is\npresent." + ], + "signature": [ + "() => boolean" + ], + "path": "packages/core/status/core-status-server/src/contracts.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/core-status-server", + "id": "def-server.ServiceStatusLevel", + "type": "Type", + "tags": [], + "label": "ServiceStatusLevel", + "description": [ + "\nA convenience type that represents the union of each value in {@link ServiceStatusLevels}." + ], + "signature": [ + "Readonly<{ toString: () => \"available\"; valueOf: () => 0; toJSON: () => \"available\"; }> | Readonly<{ toString: () => \"degraded\"; valueOf: () => 1; toJSON: () => \"degraded\"; }> | Readonly<{ toString: () => \"unavailable\"; valueOf: () => 2; toJSON: () => \"unavailable\"; }> | Readonly<{ toString: () => \"critical\"; valueOf: () => 3; toJSON: () => \"critical\"; }>" + ], + "path": "node_modules/@types/kbn__core-status-common/index.d.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-status-server", + "id": "def-server.ServiceStatusLevelId", + "type": "Type", + "tags": [], + "label": "ServiceStatusLevelId", + "description": [ + "\nPossible values for the ID of a {@link ServiceStatusLevel}\n" + ], + "signature": [ + "\"degraded\" | \"unavailable\" | \"available\" | \"critical\"" + ], + "path": "node_modules/@types/kbn__core-status-common/index.d.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], + "objects": [ + { + "parentPluginId": "@kbn/core-status-server", + "id": "def-server.ServiceStatusLevels", + "type": "Object", + "tags": [], + "label": "ServiceStatusLevels", + "description": [ + "\nThe current \"level\" of availability of a service.\n" + ], + "signature": [ + "{ readonly available: Readonly<{ toString: () => \"available\"; valueOf: () => 0; toJSON: () => \"available\"; }>; readonly degraded: Readonly<{ toString: () => \"degraded\"; valueOf: () => 1; toJSON: () => \"degraded\"; }>; readonly unavailable: Readonly<{ toString: () => \"unavailable\"; valueOf: () => 2; toJSON: () => \"unavailable\"; }>; readonly critical: Readonly<{ toString: () => \"critical\"; valueOf: () => 3; toJSON: () => \"critical\"; }>; }" + ], + "path": "node_modules/@types/kbn__core-status-common/index.d.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_status_server.mdx b/api_docs/kbn_core_status_server.mdx new file mode 100644 index 0000000000000..5fa9cf11f74df --- /dev/null +++ b/api_docs/kbn_core_status_server.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: kibKbnCoreStatusServerPluginApi +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: 2022-09-20 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-status-server'] +--- +import kbnCoreStatusServerObj from './kbn_core_status_server.devdocs.json'; + + + +Contact Kibana Core for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 20 | 0 | 1 | 0 | + +## Server + +### Objects + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/kbn_core_status_server_internal.devdocs.json b/api_docs/kbn_core_status_server_internal.devdocs.json new file mode 100644 index 0000000000000..d24cd2e143830 --- /dev/null +++ b/api_docs/kbn_core_status_server_internal.devdocs.json @@ -0,0 +1,440 @@ +{ + "id": "@kbn/core-status-server-internal", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [ + { + "parentPluginId": "@kbn/core-status-server-internal", + "id": "def-server.StatusService", + "type": "Class", + "tags": [], + "label": "StatusService", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-status-server-internal", + "scope": "server", + "docId": "kibKbnCoreStatusServerInternalPluginApi", + "section": "def-server.StatusService", + "text": "StatusService" + }, + " implements ", + "CoreService", + "<", + "InternalStatusServiceSetup", + ", void>" + ], + "path": "packages/core/status/core-status-server-internal/src/status_service.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-status-server-internal", + "id": "def-server.StatusService.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "packages/core/status/core-status-server-internal/src/status_service.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-status-server-internal", + "id": "def-server.StatusService.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "coreContext", + "description": [], + "signature": [ + "CoreContext" + ], + "path": "packages/core/status/core-status-server-internal/src/status_service.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-status-server-internal", + "id": "def-server.StatusService.setup", + "type": "Function", + "tags": [], + "label": "setup", + "description": [], + "signature": [ + "({ analytics, elasticsearch, pluginDependencies, http, metrics, savedObjects, environment, coreUsageData, }: ", + { + "pluginId": "@kbn/core-status-server-internal", + "scope": "server", + "docId": "kibKbnCoreStatusServerInternalPluginApi", + "section": "def-server.StatusServiceSetupDeps", + "text": "StatusServiceSetupDeps" + }, + ") => Promise<{ core$: ", + "Observable", + "<", + "CoreStatus", + ">; coreOverall$: ", + "Observable", + "<", + "ServiceStatus", + ">; overall$: ", + "Observable", + "<", + "ServiceStatus", + ">; plugins: { set: (plugin: string, status$: ", + "Observable", + "<", + "ServiceStatus", + ">) => void; getDependenciesStatus$: (plugin: string) => ", + "Observable", + ">>; getDerivedStatus$: (plugin: string) => ", + "Observable", + "<", + "ServiceStatus", + ">; }; isStatusPageAnonymous: () => boolean; }>" + ], + "path": "packages/core/status/core-status-server-internal/src/status_service.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-status-server-internal", + "id": "def-server.StatusService.setup.$1", + "type": "Object", + "tags": [], + "label": "{\n analytics,\n elasticsearch,\n pluginDependencies,\n http,\n metrics,\n savedObjects,\n environment,\n coreUsageData,\n }", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-status-server-internal", + "scope": "server", + "docId": "kibKbnCoreStatusServerInternalPluginApi", + "section": "def-server.StatusServiceSetupDeps", + "text": "StatusServiceSetupDeps" + } + ], + "path": "packages/core/status/core-status-server-internal/src/status_service.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-status-server-internal", + "id": "def-server.StatusService.start", + "type": "Function", + "tags": [], + "label": "start", + "description": [], + "signature": [ + "() => void" + ], + "path": "packages/core/status/core-status-server-internal/src/status_service.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-status-server-internal", + "id": "def-server.StatusService.stop", + "type": "Function", + "tags": [], + "label": "stop", + "description": [], + "signature": [ + "() => void" + ], + "path": "packages/core/status/core-status-server-internal/src/status_service.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [ + { + "parentPluginId": "@kbn/core-status-server-internal", + "id": "def-server.registerStatusRoute", + "type": "Function", + "tags": [], + "label": "registerStatusRoute", + "description": [], + "signature": [ + "({ router, config, metrics, status, incrementUsageCounter, }: Deps) => void" + ], + "path": "packages/core/status/core-status-server-internal/src/routes/status.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-status-server-internal", + "id": "def-server.registerStatusRoute.$1", + "type": "Object", + "tags": [], + "label": "{\n router,\n config,\n metrics,\n status,\n incrementUsageCounter,\n}", + "description": [], + "signature": [ + "Deps" + ], + "path": "packages/core/status/core-status-server-internal/src/routes/status.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "@kbn/core-status-server-internal", + "id": "def-server.StatusServiceSetupDeps", + "type": "Interface", + "tags": [], + "label": "StatusServiceSetupDeps", + "description": [], + "path": "packages/core/status/core-status-server-internal/src/status_service.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-status-server-internal", + "id": "def-server.StatusServiceSetupDeps.analytics", + "type": "Object", + "tags": [], + "label": "analytics", + "description": [], + "signature": [ + "{ optIn: (optInConfig: ", + "OptInConfig", + ") => void; reportEvent: (eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ", + "Observable", + "<", + "TelemetryCounter", + ">; registerEventType: (eventTypeOps: ", + "EventTypeOpts", + ") => void; registerShipper: (Shipper: ", + "ShipperClassConstructor", + ", shipperConfig: ShipperConfig, opts?: ", + "RegisterShipperOpts", + " | undefined) => void; registerContextProvider: (contextProviderOpts: ", + "ContextProviderOpts", + ") => void; removeContextProvider: (contextProviderName: string) => void; }" + ], + "path": "packages/core/status/core-status-server-internal/src/status_service.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-status-server-internal", + "id": "def-server.StatusServiceSetupDeps.elasticsearch", + "type": "Object", + "tags": [], + "label": "elasticsearch", + "description": [], + "signature": [ + "{ status$: ", + "Observable", + "<", + "ServiceStatus", + "<", + "ElasticsearchStatusMeta", + ">>; }" + ], + "path": "packages/core/status/core-status-server-internal/src/status_service.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-status-server-internal", + "id": "def-server.StatusServiceSetupDeps.environment", + "type": "Object", + "tags": [], + "label": "environment", + "description": [], + "signature": [ + "InternalEnvironmentServicePreboot" + ], + "path": "packages/core/status/core-status-server-internal/src/status_service.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-status-server-internal", + "id": "def-server.StatusServiceSetupDeps.pluginDependencies", + "type": "Object", + "tags": [], + "label": "pluginDependencies", + "description": [], + "signature": [ + "ReadonlyMap" + ], + "path": "packages/core/status/core-status-server-internal/src/status_service.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-status-server-internal", + "id": "def-server.StatusServiceSetupDeps.http", + "type": "Object", + "tags": [], + "label": "http", + "description": [], + "signature": [ + "InternalHttpServiceSetup" + ], + "path": "packages/core/status/core-status-server-internal/src/status_service.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-status-server-internal", + "id": "def-server.StatusServiceSetupDeps.metrics", + "type": "Object", + "tags": [], + "label": "metrics", + "description": [], + "signature": [ + "MetricsServiceSetup" + ], + "path": "packages/core/status/core-status-server-internal/src/status_service.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-status-server-internal", + "id": "def-server.StatusServiceSetupDeps.savedObjects", + "type": "Object", + "tags": [], + "label": "savedObjects", + "description": [], + "signature": [ + "{ status$: ", + "Observable", + "<", + "ServiceStatus", + "<", + "SavedObjectStatusMeta", + ">>; }" + ], + "path": "packages/core/status/core-status-server-internal/src/status_service.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-status-server-internal", + "id": "def-server.StatusServiceSetupDeps.coreUsageData", + "type": "Object", + "tags": [], + "label": "coreUsageData", + "description": [], + "signature": [ + "{ incrementUsageCounter: ", + "CoreIncrementUsageCounter", + "; }" + ], + "path": "packages/core/status/core-status-server-internal/src/status_service.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/core-status-server-internal", + "id": "def-server.StatusConfigType", + "type": "Type", + "tags": [], + "label": "StatusConfigType", + "description": [], + "signature": [ + "{ readonly allowAnonymous: boolean; }" + ], + "path": "packages/core/status/core-status-server-internal/src/status_config.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], + "objects": [ + { + "parentPluginId": "@kbn/core-status-server-internal", + "id": "def-server.statusConfig", + "type": "Object", + "tags": [], + "label": "statusConfig", + "description": [], + "path": "packages/core/status/core-status-server-internal/src/status_config.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-status-server-internal", + "id": "def-server.statusConfig.path", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "path": "packages/core/status/core-status-server-internal/src/status_config.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-status-server-internal", + "id": "def-server.statusConfig.schema", + "type": "Object", + "tags": [], + "label": "schema", + "description": [], + "signature": [ + "ObjectType", + "<{ allowAnonymous: ", + "Type", + "; }>" + ], + "path": "packages/core/status/core-status-server-internal/src/status_config.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + } + ] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_status_server_internal.mdx b/api_docs/kbn_core_status_server_internal.mdx new file mode 100644 index 0000000000000..cd6df67e78030 --- /dev/null +++ b/api_docs/kbn_core_status_server_internal.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: kibKbnCoreStatusServerInternalPluginApi +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: 2022-09-20 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-status-server-internal'] +--- +import kbnCoreStatusServerInternalObj from './kbn_core_status_server_internal.devdocs.json'; + + + +Contact Kibana Core for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 22 | 0 | 22 | 1 | + +## Server + +### Objects + + +### Functions + + +### Classes + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/kbn_core_status_server_mocks.devdocs.json b/api_docs/kbn_core_status_server_mocks.devdocs.json new file mode 100644 index 0000000000000..85f331d9e7e27 --- /dev/null +++ b/api_docs/kbn_core_status_server_mocks.devdocs.json @@ -0,0 +1,94 @@ +{ + "id": "@kbn/core-status-server-mocks", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [ + { + "parentPluginId": "@kbn/core-status-server-mocks", + "id": "def-server.statusServiceMock", + "type": "Object", + "tags": [], + "label": "statusServiceMock", + "description": [], + "path": "packages/core/status/core-status-server-mocks/src/status_service.mock.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-status-server-mocks", + "id": "def-server.statusServiceMock.create", + "type": "Function", + "tags": [], + "label": "create", + "description": [], + "signature": [ + "() => jest.Mocked" + ], + "path": "packages/core/status/core-status-server-mocks/src/status_service.mock.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [] + }, + { + "parentPluginId": "@kbn/core-status-server-mocks", + "id": "def-server.statusServiceMock.createSetupContract", + "type": "Function", + "tags": [], + "label": "createSetupContract", + "description": [], + "signature": [ + "() => jest.Mocked<", + "StatusServiceSetup", + ">" + ], + "path": "packages/core/status/core-status-server-mocks/src/status_service.mock.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [] + }, + { + "parentPluginId": "@kbn/core-status-server-mocks", + "id": "def-server.statusServiceMock.createInternalSetupContract", + "type": "Function", + "tags": [], + "label": "createInternalSetupContract", + "description": [], + "signature": [ + "() => jest.Mocked<", + "InternalStatusServiceSetup", + ">" + ], + "path": "packages/core/status/core-status-server-mocks/src/status_service.mock.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [] + } + ], + "initialIsOpen": false + } + ] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_status_server_mocks.mdx b/api_docs/kbn_core_status_server_mocks.mdx new file mode 100644 index 0000000000000..c2bbd12094c04 --- /dev/null +++ b/api_docs/kbn_core_status_server_mocks.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: kibKbnCoreStatusServerMocksPluginApi +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: 2022-09-20 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-status-server-mocks'] +--- +import kbnCoreStatusServerMocksObj from './kbn_core_status_server_mocks.devdocs.json'; + + + +Contact Kibana Core for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 4 | 0 | 4 | 0 | + +## Server + +### Objects + + diff --git a/api_docs/kbn_core_test_helpers_deprecations_getters.mdx b/api_docs/kbn_core_test_helpers_deprecations_getters.mdx index bcc58ce97c172..e8be3567313b0 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: 2022-09-09 +date: 2022-09-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.mdx b/api_docs/kbn_core_test_helpers_http_setup_browser.mdx index fab15b3ed6f35..6bb448c563b7b 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: 2022-09-09 +date: 2022-09-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_theme_browser.mdx b/api_docs/kbn_core_theme_browser.mdx index 017403c279a71..ef68d664af2c1 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: 2022-09-09 +date: 2022-09-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 4b18d3cb540b5..978f1833da04a 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: 2022-09-09 +date: 2022-09-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 d68eda65b7478..8abf444a86f18 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: 2022-09-09 +date: 2022-09-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 d43b64677389a..9ac7e4f27c121 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: 2022-09-09 +date: 2022-09-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 a2b638ea5c8f3..8cdfe923481d2 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: 2022-09-09 +date: 2022-09-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 6a7ad1ab8e14d..c82a3ba9a1c82 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: 2022-09-09 +date: 2022-09-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.devdocs.json b/api_docs/kbn_core_ui_settings_common.devdocs.json index 6a5e89a290d41..6967cb7263b52 100644 --- a/api_docs/kbn_core_ui_settings_common.devdocs.json +++ b/api_docs/kbn_core_ui_settings_common.devdocs.json @@ -395,7 +395,7 @@ "\nA sub-set of {@link UiSettingsParams} exposed to the client-side." ], "signature": [ - "{ options?: string[] | number[] | undefined; type?: ", + "{ name?: string | undefined; value?: unknown; description?: string | undefined; category?: string[] | undefined; options?: string[] | number[] | undefined; optionLabels?: Record | undefined; requiresPageReload?: boolean | undefined; readonly?: boolean | undefined; sensitive?: boolean | undefined; type?: ", { "pluginId": "@kbn/core-ui-settings-common", "scope": "common", @@ -403,7 +403,7 @@ "section": "def-common.UiSettingsType", "text": "UiSettingsType" }, - " | undefined; metric?: { type: string; name: string; } | undefined; value?: unknown; description?: string | undefined; name?: string | undefined; order?: number | undefined; category?: string[] | undefined; optionLabels?: Record | undefined; requiresPageReload?: boolean | undefined; readonly?: boolean | undefined; sensitive?: boolean | undefined; deprecation?: ", + " | undefined; deprecation?: ", { "pluginId": "@kbn/core-ui-settings-common", "scope": "common", @@ -411,7 +411,7 @@ "section": "def-common.DeprecationSettings", "text": "DeprecationSettings" }, - " | undefined; }" + " | undefined; order?: number | undefined; metric?: { type: string; name: string; } | undefined; }" ], "path": "packages/core/ui-settings/core-ui-settings-common/src/ui_settings.ts", "deprecated": false, diff --git a/api_docs/kbn_core_ui_settings_common.mdx b/api_docs/kbn_core_ui_settings_common.mdx index 9b16f81a2be4a..40f540a5048a6 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: 2022-09-09 +date: 2022-09-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.devdocs.json b/api_docs/kbn_core_ui_settings_server.devdocs.json new file mode 100644 index 0000000000000..f2b6ff763a4a7 --- /dev/null +++ b/api_docs/kbn_core_ui_settings_server.devdocs.json @@ -0,0 +1,500 @@ +{ + "id": "@kbn/core-ui-settings-server", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [ + { + "parentPluginId": "@kbn/core-ui-settings-server", + "id": "def-server.IUiSettingsClient", + "type": "Interface", + "tags": [], + "label": "IUiSettingsClient", + "description": [ + "\nServer-side client that provides access to the advanced settings stored in elasticsearch.\nThe settings provide control over the behavior of the Kibana application.\nFor example, a user can specify how to display numeric or date fields.\nUsers can adjust the settings via Management UI.\n" + ], + "path": "packages/core/ui-settings/core-ui-settings-server/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-ui-settings-server", + "id": "def-server.IUiSettingsClient.getRegistered", + "type": "Function", + "tags": [], + "label": "getRegistered", + "description": [ + "\nReturns registered uiSettings values {@link UiSettingsParams}" + ], + "signature": [ + "() => Readonly>" + ], + "path": "packages/core/ui-settings/core-ui-settings-server/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-ui-settings-server", + "id": "def-server.IUiSettingsClient.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [ + "\nRetrieves uiSettings values set by the user with fallbacks to default values if not specified." + ], + "signature": [ + "(key: string) => Promise" + ], + "path": "packages/core/ui-settings/core-ui-settings-server/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-ui-settings-server", + "id": "def-server.IUiSettingsClient.get.$1", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/ui-settings/core-ui-settings-server/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-ui-settings-server", + "id": "def-server.IUiSettingsClient.getAll", + "type": "Function", + "tags": [], + "label": "getAll", + "description": [ + "\nRetrieves a set of all uiSettings values set by the user with fallbacks to default values if not specified." + ], + "signature": [ + "() => Promise>" + ], + "path": "packages/core/ui-settings/core-ui-settings-server/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-ui-settings-server", + "id": "def-server.IUiSettingsClient.getUserProvided", + "type": "Function", + "tags": [], + "label": "getUserProvided", + "description": [ + "\nRetrieves a set of all uiSettings values set by the user." + ], + "signature": [ + "() => Promise>>" + ], + "path": "packages/core/ui-settings/core-ui-settings-server/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-ui-settings-server", + "id": "def-server.IUiSettingsClient.setMany", + "type": "Function", + "tags": [], + "label": "setMany", + "description": [ + "\nWrites multiple uiSettings values and marks them as set by the user." + ], + "signature": [ + "(changes: Record) => Promise" + ], + "path": "packages/core/ui-settings/core-ui-settings-server/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-ui-settings-server", + "id": "def-server.IUiSettingsClient.setMany.$1", + "type": "Object", + "tags": [], + "label": "changes", + "description": [], + "signature": [ + "Record" + ], + "path": "packages/core/ui-settings/core-ui-settings-server/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-ui-settings-server", + "id": "def-server.IUiSettingsClient.set", + "type": "Function", + "tags": [], + "label": "set", + "description": [ + "\nWrites uiSettings value and marks it as set by the user." + ], + "signature": [ + "(key: string, value: any) => Promise" + ], + "path": "packages/core/ui-settings/core-ui-settings-server/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-ui-settings-server", + "id": "def-server.IUiSettingsClient.set.$1", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/ui-settings/core-ui-settings-server/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-ui-settings-server", + "id": "def-server.IUiSettingsClient.set.$2", + "type": "Any", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "any" + ], + "path": "packages/core/ui-settings/core-ui-settings-server/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-ui-settings-server", + "id": "def-server.IUiSettingsClient.remove", + "type": "Function", + "tags": [], + "label": "remove", + "description": [ + "\nRemoves uiSettings value by key." + ], + "signature": [ + "(key: string) => Promise" + ], + "path": "packages/core/ui-settings/core-ui-settings-server/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-ui-settings-server", + "id": "def-server.IUiSettingsClient.remove.$1", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/ui-settings/core-ui-settings-server/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-ui-settings-server", + "id": "def-server.IUiSettingsClient.removeMany", + "type": "Function", + "tags": [], + "label": "removeMany", + "description": [ + "\nRemoves multiple uiSettings values by keys." + ], + "signature": [ + "(keys: string[]) => Promise" + ], + "path": "packages/core/ui-settings/core-ui-settings-server/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-ui-settings-server", + "id": "def-server.IUiSettingsClient.removeMany.$1", + "type": "Array", + "tags": [], + "label": "keys", + "description": [], + "signature": [ + "string[]" + ], + "path": "packages/core/ui-settings/core-ui-settings-server/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-ui-settings-server", + "id": "def-server.IUiSettingsClient.isOverridden", + "type": "Function", + "tags": [], + "label": "isOverridden", + "description": [ + "\nShows whether the uiSettings value set by the user." + ], + "signature": [ + "(key: string) => boolean" + ], + "path": "packages/core/ui-settings/core-ui-settings-server/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-ui-settings-server", + "id": "def-server.IUiSettingsClient.isOverridden.$1", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/ui-settings/core-ui-settings-server/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-ui-settings-server", + "id": "def-server.IUiSettingsClient.isSensitive", + "type": "Function", + "tags": [], + "label": "isSensitive", + "description": [ + "\nShows whether the uiSetting is a sensitive value. Used by telemetry to not send sensitive values." + ], + "signature": [ + "(key: string) => boolean" + ], + "path": "packages/core/ui-settings/core-ui-settings-server/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-ui-settings-server", + "id": "def-server.IUiSettingsClient.isSensitive.$1", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/ui-settings/core-ui-settings-server/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-ui-settings-server", + "id": "def-server.UiSettingsRequestHandlerContext", + "type": "Interface", + "tags": [], + "label": "UiSettingsRequestHandlerContext", + "description": [ + "\nCore's `uiSettings` request handler context." + ], + "path": "packages/core/ui-settings/core-ui-settings-server/src/request_handler_context.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-ui-settings-server", + "id": "def-server.UiSettingsRequestHandlerContext.client", + "type": "Object", + "tags": [], + "label": "client", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-ui-settings-server", + "scope": "server", + "docId": "kibKbnCoreUiSettingsServerPluginApi", + "section": "def-server.IUiSettingsClient", + "text": "IUiSettingsClient" + } + ], + "path": "packages/core/ui-settings/core-ui-settings-server/src/request_handler_context.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-ui-settings-server", + "id": "def-server.UiSettingsServiceSetup", + "type": "Interface", + "tags": [], + "label": "UiSettingsServiceSetup", + "description": [], + "path": "packages/core/ui-settings/core-ui-settings-server/src/contracts.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-ui-settings-server", + "id": "def-server.UiSettingsServiceSetup.register", + "type": "Function", + "tags": [], + "label": "register", + "description": [ + "\nSets settings with default values for the uiSettings." + ], + "signature": [ + "(settings: Record>) => void" + ], + "path": "packages/core/ui-settings/core-ui-settings-server/src/contracts.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-ui-settings-server", + "id": "def-server.UiSettingsServiceSetup.register.$1", + "type": "Object", + "tags": [], + "label": "settings", + "description": [], + "signature": [ + "Record>" + ], + "path": "packages/core/ui-settings/core-ui-settings-server/src/contracts.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-ui-settings-server", + "id": "def-server.UiSettingsServiceStart", + "type": "Interface", + "tags": [], + "label": "UiSettingsServiceStart", + "description": [], + "path": "packages/core/ui-settings/core-ui-settings-server/src/contracts.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-ui-settings-server", + "id": "def-server.UiSettingsServiceStart.asScopedToClient", + "type": "Function", + "tags": [], + "label": "asScopedToClient", + "description": [ + "\nCreates a {@link IUiSettingsClient} with provided *scoped* saved objects client.\n\nThis should only be used in the specific case where the client needs to be accessed\nfrom outside of the scope of a {@link RequestHandler}.\n" + ], + "signature": [ + "(savedObjectsClient: ", + "SavedObjectsClientContract", + ") => ", + { + "pluginId": "@kbn/core-ui-settings-server", + "scope": "server", + "docId": "kibKbnCoreUiSettingsServerPluginApi", + "section": "def-server.IUiSettingsClient", + "text": "IUiSettingsClient" + } + ], + "path": "packages/core/ui-settings/core-ui-settings-server/src/contracts.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-ui-settings-server", + "id": "def-server.UiSettingsServiceStart.asScopedToClient.$1", + "type": "Object", + "tags": [], + "label": "savedObjectsClient", + "description": [], + "signature": [ + "SavedObjectsClientContract" + ], + "path": "packages/core/ui-settings/core-ui-settings-server/src/contracts.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_ui_settings_server.mdx b/api_docs/kbn_core_ui_settings_server.mdx new file mode 100644 index 0000000000000..eaeeedee820f9 --- /dev/null +++ b/api_docs/kbn_core_ui_settings_server.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: kibKbnCoreUiSettingsServerPluginApi +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: 2022-09-20 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-ui-settings-server'] +--- +import kbnCoreUiSettingsServerObj from './kbn_core_ui_settings_server.devdocs.json'; + + + +Contact Kibana Core for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 27 | 1 | 13 | 0 | + +## Server + +### Interfaces + + diff --git a/api_docs/kbn_core_ui_settings_server_internal.devdocs.json b/api_docs/kbn_core_ui_settings_server_internal.devdocs.json new file mode 100644 index 0000000000000..2edb18eb582d6 --- /dev/null +++ b/api_docs/kbn_core_ui_settings_server_internal.devdocs.json @@ -0,0 +1,468 @@ +{ + "id": "@kbn/core-ui-settings-server-internal", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [ + { + "parentPluginId": "@kbn/core-ui-settings-server-internal", + "id": "def-server.UiSettingsClient", + "type": "Class", + "tags": [], + "label": "UiSettingsClient", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-ui-settings-server-internal", + "scope": "server", + "docId": "kibKbnCoreUiSettingsServerInternalPluginApi", + "section": "def-server.UiSettingsClient", + "text": "UiSettingsClient" + }, + " extends ", + "BaseUiSettingsClient" + ], + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-ui-settings-server-internal", + "id": "def-server.UiSettingsClient.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-ui-settings-server-internal", + "id": "def-server.UiSettingsClient.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-ui-settings-server-internal", + "scope": "server", + "docId": "kibKbnCoreUiSettingsServerInternalPluginApi", + "section": "def-server.UiSettingsServiceOptions", + "text": "UiSettingsServiceOptions" + } + ], + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-ui-settings-server-internal", + "id": "def-server.UiSettingsClient.getUserProvided", + "type": "Function", + "tags": [], + "label": "getUserProvided", + "description": [], + "signature": [ + "() => Promise>" + ], + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-ui-settings-server-internal", + "id": "def-server.UiSettingsClient.setMany", + "type": "Function", + "tags": [], + "label": "setMany", + "description": [], + "signature": [ + "(changes: Record) => Promise" + ], + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-ui-settings-server-internal", + "id": "def-server.UiSettingsClient.setMany.$1", + "type": "Object", + "tags": [], + "label": "changes", + "description": [], + "signature": [ + "Record" + ], + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-ui-settings-server-internal", + "id": "def-server.UiSettingsClient.set", + "type": "Function", + "tags": [], + "label": "set", + "description": [], + "signature": [ + "(key: string, value: any) => Promise" + ], + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-ui-settings-server-internal", + "id": "def-server.UiSettingsClient.set.$1", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-ui-settings-server-internal", + "id": "def-server.UiSettingsClient.set.$2", + "type": "Any", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "any" + ], + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-ui-settings-server-internal", + "id": "def-server.UiSettingsClient.remove", + "type": "Function", + "tags": [], + "label": "remove", + "description": [], + "signature": [ + "(key: string) => Promise" + ], + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-ui-settings-server-internal", + "id": "def-server.UiSettingsClient.remove.$1", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-ui-settings-server-internal", + "id": "def-server.UiSettingsClient.removeMany", + "type": "Function", + "tags": [], + "label": "removeMany", + "description": [], + "signature": [ + "(keys: string[]) => Promise" + ], + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-ui-settings-server-internal", + "id": "def-server.UiSettingsClient.removeMany.$1", + "type": "Array", + "tags": [], + "label": "keys", + "description": [], + "signature": [ + "string[]" + ], + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [ + { + "parentPluginId": "@kbn/core-ui-settings-server-internal", + "id": "def-server.createOrUpgradeSavedConfig", + "type": "Function", + "tags": [], + "label": "createOrUpgradeSavedConfig", + "description": [], + "signature": [ + "(options: Options) => Promise | undefined>" + ], + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/create_or_upgrade_saved_config/create_or_upgrade_saved_config.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-ui-settings-server-internal", + "id": "def-server.createOrUpgradeSavedConfig.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "Options" + ], + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/create_or_upgrade_saved_config/create_or_upgrade_saved_config.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "@kbn/core-ui-settings-server-internal", + "id": "def-server.UiSettingsServiceOptions", + "type": "Interface", + "tags": [], + "label": "UiSettingsServiceOptions", + "description": [], + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-ui-settings-server-internal", + "id": "def-server.UiSettingsServiceOptions.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-ui-settings-server-internal", + "id": "def-server.UiSettingsServiceOptions.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-ui-settings-server-internal", + "id": "def-server.UiSettingsServiceOptions.buildNum", + "type": "number", + "tags": [], + "label": "buildNum", + "description": [], + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-ui-settings-server-internal", + "id": "def-server.UiSettingsServiceOptions.savedObjectsClient", + "type": "Object", + "tags": [], + "label": "savedObjectsClient", + "description": [], + "signature": [ + "SavedObjectsClientContract" + ], + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-ui-settings-server-internal", + "id": "def-server.UiSettingsServiceOptions.overrides", + "type": "Object", + "tags": [], + "label": "overrides", + "description": [], + "signature": [ + "Record | undefined" + ], + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-ui-settings-server-internal", + "id": "def-server.UiSettingsServiceOptions.defaults", + "type": "Object", + "tags": [], + "label": "defaults", + "description": [], + "signature": [ + "Record> | undefined" + ], + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-ui-settings-server-internal", + "id": "def-server.UiSettingsServiceOptions.log", + "type": "Object", + "tags": [], + "label": "log", + "description": [], + "signature": [ + "Logger" + ], + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_client.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [ + { + "parentPluginId": "@kbn/core-ui-settings-server-internal", + "id": "def-server.uiSettingsConfig", + "type": "Object", + "tags": [], + "label": "uiSettingsConfig", + "description": [], + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_config.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-ui-settings-server-internal", + "id": "def-server.uiSettingsConfig.path", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_config.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-ui-settings-server-internal", + "id": "def-server.uiSettingsConfig.schema", + "type": "Object", + "tags": [], + "label": "schema", + "description": [], + "signature": [ + "ObjectType", + "<{ overrides: ", + "ObjectType", + "<{}>; }>" + ], + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_config.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/core-ui-settings-server-internal", + "id": "def-server.uiSettingsConfig.deprecations", + "type": "Function", + "tags": [], + "label": "deprecations", + "description": [], + "signature": [ + "(factory: ", + "ConfigDeprecationFactory", + ") => ", + "ConfigDeprecation", + "[]" + ], + "path": "packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_config.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-ui-settings-server-internal", + "id": "def-server.uiSettingsConfig.deprecations.$1", + "type": "Object", + "tags": [], + "label": "factory", + "description": [], + "signature": [ + "ConfigDeprecationFactory" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false, + "trackAdoption": false + } + ] + } + ], + "initialIsOpen": false + } + ] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_ui_settings_server_internal.mdx b/api_docs/kbn_core_ui_settings_server_internal.mdx new file mode 100644 index 0000000000000..12ade9596f6e6 --- /dev/null +++ b/api_docs/kbn_core_ui_settings_server_internal.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: kibKbnCoreUiSettingsServerInternalPluginApi +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: 2022-09-20 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-ui-settings-server-internal'] +--- +import kbnCoreUiSettingsServerInternalObj from './kbn_core_ui_settings_server_internal.devdocs.json'; + + + +Contact Kibana Core for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 28 | 1 | 27 | 1 | + +## Server + +### Objects + + +### Functions + + +### Classes + + +### Interfaces + + diff --git a/api_docs/kbn_core_ui_settings_server_mocks.devdocs.json b/api_docs/kbn_core_ui_settings_server_mocks.devdocs.json new file mode 100644 index 0000000000000..96ed28f3b1379 --- /dev/null +++ b/api_docs/kbn_core_ui_settings_server_mocks.devdocs.json @@ -0,0 +1,130 @@ +{ + "id": "@kbn/core-ui-settings-server-mocks", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [ + { + "parentPluginId": "@kbn/core-ui-settings-server-mocks", + "id": "def-server.uiSettingsServiceMock", + "type": "Object", + "tags": [], + "label": "uiSettingsServiceMock", + "description": [], + "path": "packages/core/ui-settings/core-ui-settings-server-mocks/src/ui_settings_service.mock.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/core-ui-settings-server-mocks", + "id": "def-server.uiSettingsServiceMock.createPrebootContract", + "type": "Function", + "tags": [], + "label": "createPrebootContract", + "description": [], + "signature": [ + "() => jest.Mocked<", + "InternalUiSettingsServicePreboot", + ">" + ], + "path": "packages/core/ui-settings/core-ui-settings-server-mocks/src/ui_settings_service.mock.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [] + }, + { + "parentPluginId": "@kbn/core-ui-settings-server-mocks", + "id": "def-server.uiSettingsServiceMock.createSetupContract", + "type": "Function", + "tags": [], + "label": "createSetupContract", + "description": [], + "signature": [ + "() => jest.Mocked<", + "UiSettingsServiceSetup", + ">" + ], + "path": "packages/core/ui-settings/core-ui-settings-server-mocks/src/ui_settings_service.mock.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [] + }, + { + "parentPluginId": "@kbn/core-ui-settings-server-mocks", + "id": "def-server.uiSettingsServiceMock.createStartContract", + "type": "Function", + "tags": [], + "label": "createStartContract", + "description": [], + "signature": [ + "() => jest.Mocked<", + "UiSettingsServiceStart", + ">" + ], + "path": "packages/core/ui-settings/core-ui-settings-server-mocks/src/ui_settings_service.mock.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [] + }, + { + "parentPluginId": "@kbn/core-ui-settings-server-mocks", + "id": "def-server.uiSettingsServiceMock.createClient", + "type": "Function", + "tags": [], + "label": "createClient", + "description": [], + "signature": [ + "() => jest.Mocked<", + "IUiSettingsClient", + ">" + ], + "path": "packages/core/ui-settings/core-ui-settings-server-mocks/src/ui_settings_service.mock.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [] + }, + { + "parentPluginId": "@kbn/core-ui-settings-server-mocks", + "id": "def-server.uiSettingsServiceMock.create", + "type": "Function", + "tags": [], + "label": "create", + "description": [], + "signature": [ + "() => jest.Mocked" + ], + "path": "packages/core/ui-settings/core-ui-settings-server-mocks/src/ui_settings_service.mock.ts", + "deprecated": false, + "trackAdoption": false, + "returnComment": [], + "children": [] + } + ], + "initialIsOpen": false + } + ] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_ui_settings_server_mocks.mdx b/api_docs/kbn_core_ui_settings_server_mocks.mdx new file mode 100644 index 0000000000000..931ce804b79eb --- /dev/null +++ b/api_docs/kbn_core_ui_settings_server_mocks.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: kibKbnCoreUiSettingsServerMocksPluginApi +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: 2022-09-20 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-ui-settings-server-mocks'] +--- +import kbnCoreUiSettingsServerMocksObj from './kbn_core_ui_settings_server_mocks.devdocs.json'; + + + +Contact Kibana Core for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 6 | 0 | 6 | 0 | + +## Server + +### Objects + + diff --git a/api_docs/kbn_core_usage_data_server.mdx b/api_docs/kbn_core_usage_data_server.mdx index 135387c16286c..8b6294af5a33a 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: 2022-09-09 +date: 2022-09-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 cb5b74bd34c0b..971946e462f2f 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: 2022-09-09 +date: 2022-09-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.mdx b/api_docs/kbn_core_usage_data_server_mocks.mdx index 02f152900b447..0b31e5b3a34d7 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: 2022-09-09 +date: 2022-09-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_crypto.mdx b/api_docs/kbn_crypto.mdx index 70e8d69a6b17c..5b41d00b6b4d9 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: 2022-09-09 +date: 2022-09-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 77788c27073dc..f3389cdd3d2a5 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/crypto-browser'] --- import kbnCryptoBrowserObj from './kbn_crypto_browser.devdocs.json'; diff --git a/api_docs/kbn_datemath.mdx b/api_docs/kbn_datemath.mdx index 669752ea17991..10bef6d0fe0ef 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/datemath'] --- import kbnDatemathObj from './kbn_datemath.devdocs.json'; diff --git a/api_docs/kbn_dev_cli_errors.mdx b/api_docs/kbn_dev_cli_errors.mdx index 653e1b5efe544..0341bd60eb0db 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: 2022-09-09 +date: 2022-09-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 f7edb115f49a9..9d36428f50b35 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: 2022-09-09 +date: 2022-09-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 f83c97ef5f49d..08ad6b9284437 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: 2022-09-09 +date: 2022-09-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 7278c02638113..703febe0cd967 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-utils'] --- import kbnDevUtilsObj from './kbn_dev_utils.devdocs.json'; diff --git a/api_docs/kbn_doc_links.devdocs.json b/api_docs/kbn_doc_links.devdocs.json index 4dcf21464cd01..b8d975b8f5814 100644 --- a/api_docs/kbn_doc_links.devdocs.json +++ b/api_docs/kbn_doc_links.devdocs.json @@ -546,7 +546,7 @@ "label": "securitySolution", "description": [], "signature": [ - "{ readonly trustedApps: string; readonly eventFilters: string; readonly blocklist: string; readonly policyResponseTroubleshooting: { full_disk_access: string; macos_system_ext: string; linux_deadlock: string; }; readonly threatIntelInt: string; readonly responseActions: string; }" + "{ readonly trustedApps: string; readonly eventFilters: string; readonly blocklist: string; readonly policyResponseTroubleshooting: { full_disk_access: string; macos_system_ext: string; linux_deadlock: string; }; readonly packageActionTroubleshooting: { es_connection: string; }; readonly threatIntelInt: string; readonly responseActions: string; }" ], "path": "packages/kbn-doc-links/src/types.ts", "deprecated": false, diff --git a/api_docs/kbn_doc_links.mdx b/api_docs/kbn_doc_links.mdx index 044c765674ea1..dd0d195749624 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: 2022-09-09 +date: 2022-09-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 d47c4a94ac534..2e041d294ebee 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/docs-utils'] --- import kbnDocsUtilsObj from './kbn_docs_utils.devdocs.json'; diff --git a/api_docs/kbn_ebt_tools.mdx b/api_docs/kbn_ebt_tools.mdx index 5cc4b3d097f4f..302ca68691fea 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ebt-tools'] --- import kbnEbtToolsObj from './kbn_ebt_tools.devdocs.json'; diff --git a/api_docs/kbn_es_archiver.mdx b/api_docs/kbn_es_archiver.mdx index 5cad59a4b8f74..66d013d8f0a36 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: 2022-09-09 +date: 2022-09-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 ca0ada5848034..ab88b5be725c4 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: 2022-09-09 +date: 2022-09-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 6db98adca98c5..d84edf5ed8652 100644 --- a/api_docs/kbn_es_query.devdocs.json +++ b/api_docs/kbn_es_query.devdocs.json @@ -308,7 +308,15 @@ "section": "def-common.DataViewBase", "text": "DataViewBase" }, - " | undefined, queries: AnyQuery | AnyQuery[], filters: ", + " | ", + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.DataViewBase", + "text": "DataViewBase" + }, + "[] | undefined, queries: AnyQuery | AnyQuery[], filters: ", { "pluginId": "@kbn/es-query", "scope": "common", @@ -349,7 +357,7 @@ { "parentPluginId": "@kbn/es-query", "id": "def-common.buildEsQuery.$1", - "type": "Object", + "type": "CompoundType", "tags": [], "label": "indexPattern", "description": [], @@ -361,7 +369,15 @@ "section": "def-common.DataViewBase", "text": "DataViewBase" }, - " | undefined" + " | ", + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.DataViewBase", + "text": "DataViewBase" + }, + "[] | undefined" ], "path": "packages/kbn-es-query/src/es_query/build_es_query.ts", "deprecated": false, @@ -1068,7 +1084,7 @@ "label": "buildQueryFromFilters", "description": [], "signature": [ - "(filters: ", + "(inputFilters: ", { "pluginId": "@kbn/es-query", "scope": "common", @@ -1076,7 +1092,7 @@ "section": "def-common.Filter", "text": "Filter" }, - "[] | undefined, indexPattern: ", + "[] | undefined, inputDataViews: ", { "pluginId": "@kbn/es-query", "scope": "common", @@ -1084,7 +1100,15 @@ "section": "def-common.DataViewBase", "text": "DataViewBase" }, - " | undefined, { ignoreFilterIfFieldNotInIndex, nestedIgnoreUnmapped }?: ", + " | ", + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.DataViewBase", + "text": "DataViewBase" + }, + "[] | undefined, { ignoreFilterIfFieldNotInIndex, nestedIgnoreUnmapped }?: ", { "pluginId": "@kbn/es-query", "scope": "common", @@ -1110,7 +1134,7 @@ "id": "def-common.buildQueryFromFilters.$1", "type": "Array", "tags": [], - "label": "filters", + "label": "inputFilters", "description": [], "signature": [ { @@ -1130,9 +1154,9 @@ { "parentPluginId": "@kbn/es-query", "id": "def-common.buildQueryFromFilters.$2", - "type": "Object", + "type": "CompoundType", "tags": [], - "label": "indexPattern", + "label": "inputDataViews", "description": [], "signature": [ { @@ -1142,7 +1166,15 @@ "section": "def-common.DataViewBase", "text": "DataViewBase" }, - " | undefined" + " | ", + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.DataViewBase", + "text": "DataViewBase" + }, + "[] | undefined" ], "path": "packages/kbn-es-query/src/es_query/from_filters.ts", "deprecated": false, @@ -4299,7 +4331,7 @@ "section": "def-common.IFieldSubType", "text": "IFieldSubType" }, - " | undefined; script?: string | undefined; lang?: string | undefined; scripted?: boolean | undefined; }" + " | undefined; script?: string | undefined; lang?: string | undefined; scripted?: boolean | undefined; esTypes?: string[] | undefined; }" ], "path": "packages/kbn-es-query/src/es_query/types.ts", "deprecated": false, diff --git a/api_docs/kbn_es_query.mdx b/api_docs/kbn_es_query.mdx index 792b606b4133a..00b04a4bbc45f 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-query'] --- import kbnEsQueryObj from './kbn_es_query.devdocs.json'; diff --git a/api_docs/kbn_eslint_plugin_imports.mdx b/api_docs/kbn_eslint_plugin_imports.mdx index 6e1eb7f3fcfde..c555fe8b7d5a5 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: 2022-09-09 +date: 2022-09-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_field_types.mdx b/api_docs/kbn_field_types.mdx index 3fa74decb5caa..0e498ea0e9b54 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: 2022-09-09 +date: 2022-09-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 5c3fcdaab984c..eaeb3333485b0 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: 2022-09-09 +date: 2022-09-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_generate.mdx b/api_docs/kbn_generate.mdx index ed9435a3b3b74..3bcaf385b30d3 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/generate'] --- import kbnGenerateObj from './kbn_generate.devdocs.json'; diff --git a/api_docs/kbn_get_repo_files.mdx b/api_docs/kbn_get_repo_files.mdx index 3e663271b7a7d..32da58c287d17 100644 --- a/api_docs/kbn_get_repo_files.mdx +++ b/api_docs/kbn_get_repo_files.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-get-repo-files title: "@kbn/get-repo-files" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/get-repo-files plugin -date: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/get-repo-files'] --- import kbnGetRepoFilesObj from './kbn_get_repo_files.devdocs.json'; diff --git a/api_docs/kbn_handlebars.mdx b/api_docs/kbn_handlebars.mdx index 89013d791f80d..b619dcc8fce29 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: 2022-09-09 +date: 2022-09-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 03c70dae79e77..6010e62895745 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/hapi-mocks'] --- import kbnHapiMocksObj from './kbn_hapi_mocks.devdocs.json'; diff --git a/api_docs/kbn_home_sample_data_card.devdocs.json b/api_docs/kbn_home_sample_data_card.devdocs.json index 729ea01b9dc8e..7bc80108253eb 100644 --- a/api_docs/kbn_home_sample_data_card.devdocs.json +++ b/api_docs/kbn_home_sample_data_card.devdocs.json @@ -633,7 +633,7 @@ "\nParameters drawn from the Storybook arguments collection that customize a component story." ], "signature": [ - "{ status: any; description: any; name: any; includeAppLinks: any; simulateErrors: any; }" + "{ name: any; description: any; status: any; includeAppLinks: any; simulateErrors: any; }" ], "path": "packages/home/sample_data_card/src/mocks/index.ts", "deprecated": false, diff --git a/api_docs/kbn_home_sample_data_card.mdx b/api_docs/kbn_home_sample_data_card.mdx index 4f6ed6ee570a8..63fa535614bb5 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: 2022-09-09 +date: 2022-09-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 0d51ff6ce1465..73678fded69f2 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: 2022-09-09 +date: 2022-09-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 dda867b946f49..6a2be69a99536 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/i18n'] --- import kbnI18nObj from './kbn_i18n.devdocs.json'; diff --git a/api_docs/kbn_import_resolver.mdx b/api_docs/kbn_import_resolver.mdx index 1eeda889c5cdd..55418c0839d6d 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/import-resolver'] --- import kbnImportResolverObj from './kbn_import_resolver.devdocs.json'; diff --git a/api_docs/kbn_interpreter.mdx b/api_docs/kbn_interpreter.mdx index 8c87bc7a914bd..dcd0bbfddac67 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: 2022-09-09 +date: 2022-09-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 1f89b3b7e535a..2b192f2ae841e 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: 2022-09-09 +date: 2022-09-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 6885069422ac0..dfe4988fde861 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/jest-serializers'] --- import kbnJestSerializersObj from './kbn_jest_serializers.devdocs.json'; diff --git a/api_docs/kbn_kibana_manifest_schema.devdocs.json b/api_docs/kbn_kibana_manifest_schema.devdocs.json index 21bb0a106155f..064db5081ad3a 100644 --- a/api_docs/kbn_kibana_manifest_schema.devdocs.json +++ b/api_docs/kbn_kibana_manifest_schema.devdocs.json @@ -956,11 +956,14 @@ "children": [ { "parentPluginId": "@kbn/kibana-manifest-schema", - "id": "def-server.MANIFEST_V2.properties.owner.type", - "type": "string", + "id": "def-server.MANIFEST_V2.properties.owner.oneOf", + "type": "Array", "tags": [], - "label": "type", + "label": "oneOf", "description": [], + "signature": [ + "({ type: string; pattern: string; } | { type: string; items: { type: string; pattern: string; }; })[]" + ], "path": "packages/kbn-kibana-manifest-schema/src/kibana_json_v2_schema.ts", "deprecated": false, "trackAdoption": false @@ -975,17 +978,6 @@ "path": "packages/kbn-kibana-manifest-schema/src/kibana_json_v2_schema.ts", "deprecated": false, "trackAdoption": false - }, - { - "parentPluginId": "@kbn/kibana-manifest-schema", - "id": "def-server.MANIFEST_V2.properties.owner.pattern", - "type": "string", - "tags": [], - "label": "pattern", - "description": [], - "path": "packages/kbn-kibana-manifest-schema/src/kibana_json_v2_schema.ts", - "deprecated": false, - "trackAdoption": false } ] }, diff --git a/api_docs/kbn_kibana_manifest_schema.mdx b/api_docs/kbn_kibana_manifest_schema.mdx index 771d6d1341fca..61d0fe628c129 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/kibana-manifest-schema'] --- import kbnKibanaManifestSchemaObj from './kbn_kibana_manifest_schema.devdocs.json'; @@ -21,7 +21,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 97 | 0 | 96 | 0 | +| 96 | 0 | 95 | 0 | ## Server diff --git a/api_docs/kbn_logging.devdocs.json b/api_docs/kbn_logging.devdocs.json index 70e29f10ab2af..ae5f4c09df969 100644 --- a/api_docs/kbn_logging.devdocs.json +++ b/api_docs/kbn_logging.devdocs.json @@ -658,7 +658,7 @@ "label": "EcsEventKind", "description": [], "signature": [ - "\"metric\" | \"alert\" | \"state\" | \"event\" | \"signal\" | \"pipeline_error\"" + "\"metric\" | \"alert\" | \"signal\" | \"state\" | \"event\" | \"pipeline_error\"" ], "path": "packages/kbn-logging/src/ecs/event.ts", "deprecated": false, diff --git a/api_docs/kbn_logging.mdx b/api_docs/kbn_logging.mdx index eb7eb96ae58c2..7c2d9e7844a11 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/logging'] --- import kbnLoggingObj from './kbn_logging.devdocs.json'; diff --git a/api_docs/kbn_logging_mocks.mdx b/api_docs/kbn_logging_mocks.mdx index c778ebc86da32..355064817f4d6 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: 2022-09-09 +date: 2022-09-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 f9799e1ac3947..99845433826f3 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: 2022-09-09 +date: 2022-09-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_mapbox_gl.mdx b/api_docs/kbn_mapbox_gl.mdx index fc653bed6e7e9..6780c1f696b69 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/mapbox-gl'] --- import kbnMapboxGlObj from './kbn_mapbox_gl.devdocs.json'; diff --git a/api_docs/kbn_ml_agg_utils.devdocs.json b/api_docs/kbn_ml_agg_utils.devdocs.json index 286109a9ceee4..ced4750717a78 100644 --- a/api_docs/kbn_ml_agg_utils.devdocs.json +++ b/api_docs/kbn_ml_agg_utils.devdocs.json @@ -542,6 +542,28 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "@kbn/ml-agg-utils", + "id": "def-server.ChangePoint.total_doc_count", + "type": "number", + "tags": [], + "label": "total_doc_count", + "description": [], + "path": "x-pack/packages/ml/agg_utils/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/ml-agg-utils", + "id": "def-server.ChangePoint.total_bg_count", + "type": "number", + "tags": [], + "label": "total_bg_count", + "description": [], + "path": "x-pack/packages/ml/agg_utils/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-server.ChangePoint.score", @@ -602,6 +624,47 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/ml-agg-utils", + "id": "def-server.ChangePointGroup", + "type": "Interface", + "tags": [], + "label": "ChangePointGroup", + "description": [ + "\nTree leaves" + ], + "path": "x-pack/packages/ml/agg_utils/src/types.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/ml-agg-utils", + "id": "def-server.ChangePointGroup.group", + "type": "Array", + "tags": [], + "label": "group", + "description": [], + "signature": [ + "ChangePointGroupItem[]" + ], + "path": "x-pack/packages/ml/agg_utils/src/types.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/ml-agg-utils", + "id": "def-server.ChangePointGroup.docCount", + "type": "number", + "tags": [], + "label": "docCount", + "description": [], + "path": "x-pack/packages/ml/agg_utils/src/types.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-server.ChangePointHistogram", diff --git a/api_docs/kbn_ml_agg_utils.mdx b/api_docs/kbn_ml_agg_utils.mdx index 12b0ecb60e66c..adadb5a8d1141 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-agg-utils'] --- import kbnMlAggUtilsObj from './kbn_ml_agg_utils.devdocs.json'; @@ -21,7 +21,7 @@ Contact Machine Learning UI for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 53 | 2 | 35 | 4 | +| 58 | 2 | 39 | 3 | ## Server diff --git a/api_docs/kbn_ml_is_populated_object.mdx b/api_docs/kbn_ml_is_populated_object.mdx index 67f7ef712b419..1bd52ce9c5bc8 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: 2022-09-09 +date: 2022-09-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_string_hash.mdx b/api_docs/kbn_ml_string_hash.mdx index a8aa07a6cb0ad..372c7969c3806 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: 2022-09-09 +date: 2022-09-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_monaco.mdx b/api_docs/kbn_monaco.mdx index cf5344b7847eb..902578461f024 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/monaco'] --- import kbnMonacoObj from './kbn_monaco.devdocs.json'; diff --git a/api_docs/kbn_optimizer.mdx b/api_docs/kbn_optimizer.mdx index 59384f2ce9406..cbc5ae1b1ded5 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: 2022-09-09 +date: 2022-09-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 cb5c6845f2d4f..42c37c78b5178 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: 2022-09-09 +date: 2022-09-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_performance_testing_dataset_extractor.mdx b/api_docs/kbn_performance_testing_dataset_extractor.mdx index 2445802229bf1..44d6ca0550963 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: 2022-09-09 +date: 2022-09-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 617d5fec736bf..4798bfbf8987a 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: 2022-09-09 +date: 2022-09-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 44df77707e11d..b9be224e32a5b 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-helpers'] --- import kbnPluginHelpersObj from './kbn_plugin_helpers.devdocs.json'; diff --git a/api_docs/kbn_react_field.mdx b/api_docs/kbn_react_field.mdx index 6917f3fc99b3b..40fa48fd2b023 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/react-field'] --- import kbnReactFieldObj from './kbn_react_field.devdocs.json'; diff --git a/api_docs/kbn_repo_source_classifier.mdx b/api_docs/kbn_repo_source_classifier.mdx index 9b30733e7280b..1509876385b1f 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: 2022-09-09 +date: 2022-09-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_rule_data_utils.devdocs.json b/api_docs/kbn_rule_data_utils.devdocs.json index 4323a179a30df..c30477647a1ce 100644 --- a/api_docs/kbn_rule_data_utils.devdocs.json +++ b/api_docs/kbn_rule_data_utils.devdocs.json @@ -912,7 +912,7 @@ "label": "AlertConsumers", "description": [], "signature": [ - "\"logs\" | \"apm\" | \"uptime\" | \"siem\" | \"infrastructure\" | \"observability\"" + "\"observability\" | \"logs\" | \"apm\" | \"uptime\" | \"siem\" | \"infrastructure\"" ], "path": "packages/kbn-rule-data-utils/src/alerts_as_data_rbac.ts", "deprecated": false, @@ -1107,7 +1107,7 @@ "label": "ValidFeatureId", "description": [], "signature": [ - "\"logs\" | \"apm\" | \"uptime\" | \"siem\" | \"infrastructure\" | \"observability\"" + "\"observability\" | \"logs\" | \"apm\" | \"uptime\" | \"siem\" | \"infrastructure\"" ], "path": "packages/kbn-rule-data-utils/src/alerts_as_data_rbac.ts", "deprecated": false, diff --git a/api_docs/kbn_rule_data_utils.mdx b/api_docs/kbn_rule_data_utils.mdx index d278bd47a83cc..0e8c7c73e7c84 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: 2022-09-09 +date: 2022-09-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_securitysolution_autocomplete.devdocs.json b/api_docs/kbn_securitysolution_autocomplete.devdocs.json index 91934a5908629..f73900b7cb0b0 100644 --- a/api_docs/kbn_securitysolution_autocomplete.devdocs.json +++ b/api_docs/kbn_securitysolution_autocomplete.devdocs.json @@ -60,7 +60,7 @@ "label": "AutocompleteFieldListsComponent", "description": [], "signature": [ - "{ ({ httpService, isClearable, isDisabled, isLoading, onChange, placeholder, rowLabel, selectedField, selectedValue, }: React.PropsWithChildren): JSX.Element; displayName: string | undefined; }" + "{ ({ httpService, isClearable, isDisabled, isLoading, onChange, placeholder, rowLabel, selectedField, selectedValue, allowLargeValueLists, }: React.PropsWithChildren): JSX.Element; displayName: string | undefined; }" ], "path": "packages/kbn-securitysolution-autocomplete/src/field_value_lists/index.tsx", "deprecated": false, @@ -71,7 +71,7 @@ "id": "def-common.AutocompleteFieldListsComponent.$1", "type": "CompoundType", "tags": [], - "label": "{\n httpService,\n isClearable = false,\n isDisabled = false,\n isLoading = false,\n onChange,\n placeholder,\n rowLabel,\n selectedField,\n selectedValue,\n}", + "label": "{\n httpService,\n isClearable = false,\n isDisabled = false,\n isLoading = false,\n onChange,\n placeholder,\n rowLabel,\n selectedField,\n selectedValue,\n allowLargeValueLists = false,\n}", "description": [], "signature": [ "React.PropsWithChildren" @@ -288,7 +288,9 @@ "label": "FieldComponent", "description": [], "signature": [ - "{ ({ fieldInputWidth, fieldTypeFilter, indexPattern, isClearable, isDisabled, isLoading, isRequired, onChange, placeholder, selectedField, }: React.PropsWithChildren): JSX.Element; displayName: string | undefined; }" + "{ ({ fieldInputWidth, fieldTypeFilter, indexPattern, isClearable, isDisabled, isLoading, isRequired, onChange, placeholder, selectedField, }: React.PropsWithChildren<", + "FieldProps", + ">): JSX.Element; displayName: string | undefined; }" ], "path": "packages/kbn-securitysolution-autocomplete/src/field/index.tsx", "deprecated": false, @@ -302,7 +304,9 @@ "label": "{\n fieldInputWidth,\n fieldTypeFilter = [],\n indexPattern,\n isClearable = false,\n isDisabled = false,\n isLoading = false,\n isRequired = false,\n onChange,\n placeholder,\n selectedField,\n}", "description": [], "signature": [ - "React.PropsWithChildren" + "React.PropsWithChildren<", + "FieldProps", + ">" ], "path": "packages/kbn-securitysolution-autocomplete/src/field/index.tsx", "deprecated": false, @@ -323,9 +327,24 @@ "\nGiven an array of lists and optionally a field this will return all\nthe lists that match against the field based on the types from the field\n\nNOTE: That we support one additional property from \"FieldSpec\" located here:\nsrc/plugins/data/common/index_patterns/fields/types.ts\nThis type property is esTypes. If it exists and is on there we will read off the esTypes." ], "signature": [ - "(lists: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[], field?: (", + "(lists: ", + { + "pluginId": "@kbn/securitysolution-autocomplete", + "scope": "common", + "docId": "kibKbnSecuritysolutionAutocompletePluginApi", + "section": "def-common.AutocompleteListsData", + "text": "AutocompleteListsData" + }, + ", field?: (", "DataViewFieldBase", - " & { esTypes?: string[] | undefined; }) | undefined) => { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[]" + " & { esTypes?: string[] | undefined; }) | undefined) => ", + { + "pluginId": "@kbn/securitysolution-autocomplete", + "scope": "common", + "docId": "kibKbnSecuritysolutionAutocompletePluginApi", + "section": "def-common.AutocompleteListsData", + "text": "AutocompleteListsData" + } ], "path": "packages/kbn-securitysolution-autocomplete/src/filter_field_to_list/index.ts", "deprecated": false, @@ -334,14 +353,20 @@ { "parentPluginId": "@kbn/securitysolution-autocomplete", "id": "def-common.filterFieldToList.$1", - "type": "Array", + "type": "Object", "tags": [], "label": "lists", "description": [ "The lists to match against the field" ], "signature": [ - "{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[]" + { + "pluginId": "@kbn/securitysolution-autocomplete", + "scope": "common", + "docId": "kibKbnSecuritysolutionAutocompletePluginApi", + "section": "def-common.AutocompleteListsData", + "text": "AutocompleteListsData" + } ], "path": "packages/kbn-securitysolution-autocomplete/src/filter_field_to_list/index.ts", "deprecated": false, @@ -381,7 +406,7 @@ "\nDetermines the options, selected values and option labels for EUI combo box" ], "signature": [ - "({ getLabel, options, selectedOptions, }: { getLabel: (value: T) => string; options: T[]; selectedOptions: T[]; }) => ", + "({ getLabel, options, selectedOptions, disabledOptions, }: { getLabel: (value: T) => string; options: T[]; selectedOptions: T[]; disabledOptions?: T[] | undefined; }) => ", { "pluginId": "@kbn/securitysolution-autocomplete", "scope": "common", @@ -399,7 +424,7 @@ "id": "def-common.getGenericComboBoxProps.$1", "type": "Object", "tags": [], - "label": "{\n getLabel,\n options,\n selectedOptions,\n}", + "label": "{\n getLabel,\n options,\n selectedOptions,\n disabledOptions,\n}", "description": [], "path": "packages/kbn-securitysolution-autocomplete/src/get_generic_combo_box_props/index.ts", "deprecated": false, @@ -464,6 +489,20 @@ "path": "packages/kbn-securitysolution-autocomplete/src/get_generic_combo_box_props/index.ts", "deprecated": false, "trackAdoption": false + }, + { + "parentPluginId": "@kbn/securitysolution-autocomplete", + "id": "def-common.getGenericComboBoxProps.$1.disabledOptions", + "type": "Array", + "tags": [], + "label": "disabledOptions", + "description": [], + "signature": [ + "T[] | undefined" + ], + "path": "packages/kbn-securitysolution-autocomplete/src/get_generic_combo_box_props/index.ts", + "deprecated": false, + "trackAdoption": false } ] } @@ -730,6 +769,48 @@ } ], "interfaces": [ + { + "parentPluginId": "@kbn/securitysolution-autocomplete", + "id": "def-common.AutocompleteListsData", + "type": "Interface", + "tags": [], + "label": "AutocompleteListsData", + "description": [], + "path": "packages/kbn-securitysolution-autocomplete/src/field_value_lists/index.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/securitysolution-autocomplete", + "id": "def-common.AutocompleteListsData.smallLists", + "type": "Array", + "tags": [], + "label": "smallLists", + "description": [], + "signature": [ + "{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[]" + ], + "path": "packages/kbn-securitysolution-autocomplete/src/field_value_lists/index.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/securitysolution-autocomplete", + "id": "def-common.AutocompleteListsData.largeLists", + "type": "Array", + "tags": [], + "label": "largeLists", + "description": [], + "signature": [ + "{ _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[]" + ], + "path": "packages/kbn-securitysolution-autocomplete/src/field_value_lists/index.tsx", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/securitysolution-autocomplete", "id": "def-common.GetGenericComboBoxPropsReturn", diff --git a/api_docs/kbn_securitysolution_autocomplete.mdx b/api_docs/kbn_securitysolution_autocomplete.mdx index e1c8c47ea5d19..6e19f121fd9ad 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-autocomplete'] --- import kbnSecuritysolutionAutocompleteObj from './kbn_securitysolution_autocomplete.devdocs.json'; @@ -21,7 +21,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 52 | 1 | 37 | 0 | +| 56 | 1 | 41 | 1 | ## Common diff --git a/api_docs/kbn_securitysolution_es_utils.devdocs.json b/api_docs/kbn_securitysolution_es_utils.devdocs.json index b3149b45f10dc..a96bb0f4d470e 100644 --- a/api_docs/kbn_securitysolution_es_utils.devdocs.json +++ b/api_docs/kbn_securitysolution_es_utils.devdocs.json @@ -461,7 +461,7 @@ "label": "esClient", "description": [], "signature": [ - "{ get: { (this: That, params: ", + "{ name: string | symbol; get: { (this: That, params: ", "GetRequest", " | ", "GetRequest", @@ -579,7 +579,7 @@ "default", "; security: ", "default", - "; name: string | symbol; index: { (this: That, params: ", + "; index: { (this: That, params: ", "IndexRequest", " | ", "IndexRequest", @@ -1707,7 +1707,7 @@ "label": "esClient", "description": [], "signature": [ - "{ get: { (this: That, params: ", + "{ name: string | symbol; get: { (this: That, params: ", "GetRequest", " | ", "GetRequest", @@ -1825,7 +1825,7 @@ "default", "; security: ", "default", - "; name: string | symbol; index: { (this: That, params: ", + "; index: { (this: That, params: ", "IndexRequest", " | ", "IndexRequest", diff --git a/api_docs/kbn_securitysolution_es_utils.mdx b/api_docs/kbn_securitysolution_es_utils.mdx index d2a1be19c6c17..2ffb661273b81 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: 2022-09-09 +date: 2022-09-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_hook_utils.mdx b/api_docs/kbn_securitysolution_hook_utils.mdx index e4fbf89a1405f..7e05e5af14825 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: 2022-09-09 +date: 2022-09-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 38f823267cd07..d94c62d645fd5 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: 2022-09-09 +date: 2022-09-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.devdocs.json b/api_docs/kbn_securitysolution_io_ts_list_types.devdocs.json index f75157365c883..6131ceb64878a 100644 --- a/api_docs/kbn_securitysolution_io_ts_list_types.devdocs.json +++ b/api_docs/kbn_securitysolution_io_ts_list_types.devdocs.json @@ -661,6 +661,228 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.ApiCallGetExceptionFilterFromExceptionsMemoProps", + "type": "Interface", + "tags": [], + "label": "ApiCallGetExceptionFilterFromExceptionsMemoProps", + "description": [], + "signature": [ + { + "pluginId": "@kbn/securitysolution-io-ts-list-types", + "scope": "common", + "docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi", + "section": "def-common.ApiCallGetExceptionFilterFromExceptionsMemoProps", + "text": "ApiCallGetExceptionFilterFromExceptionsMemoProps" + }, + " extends ", + { + "pluginId": "@kbn/securitysolution-io-ts-list-types", + "scope": "common", + "docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi", + "section": "def-common.GetExceptionFilterOptionalProps", + "text": "GetExceptionFilterOptionalProps" + } + ], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.ApiCallGetExceptionFilterFromExceptionsMemoProps.exceptions", + "type": "Array", + "tags": [], + "label": "exceptions", + "description": [], + "signature": [ + "(({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) | { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; })[]" + ], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.ApiCallGetExceptionFilterFromExceptionsMemoProps.onError", + "type": "Function", + "tags": [], + "label": "onError", + "description": [], + "signature": [ + "(arg: string[]) => void" + ], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.ApiCallGetExceptionFilterFromExceptionsMemoProps.onError.$1", + "type": "Array", + "tags": [], + "label": "arg", + "description": [], + "signature": [ + "string[]" + ], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.ApiCallGetExceptionFilterFromExceptionsMemoProps.onSuccess", + "type": "Function", + "tags": [], + "label": "onSuccess", + "description": [], + "signature": [ + "(arg: ", + "Filter", + ") => void" + ], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.ApiCallGetExceptionFilterFromExceptionsMemoProps.onSuccess.$1", + "type": "Object", + "tags": [], + "label": "arg", + "description": [], + "signature": [ + "Filter" + ], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.ApiCallGetExceptionFilterFromIdsMemoProps", + "type": "Interface", + "tags": [], + "label": "ApiCallGetExceptionFilterFromIdsMemoProps", + "description": [], + "signature": [ + { + "pluginId": "@kbn/securitysolution-io-ts-list-types", + "scope": "common", + "docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi", + "section": "def-common.ApiCallGetExceptionFilterFromIdsMemoProps", + "text": "ApiCallGetExceptionFilterFromIdsMemoProps" + }, + " extends ", + { + "pluginId": "@kbn/securitysolution-io-ts-list-types", + "scope": "common", + "docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi", + "section": "def-common.GetExceptionFilterOptionalProps", + "text": "GetExceptionFilterOptionalProps" + } + ], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.ApiCallGetExceptionFilterFromIdsMemoProps.exceptionListIds", + "type": "Array", + "tags": [], + "label": "exceptionListIds", + "description": [], + "signature": [ + "{ exception_list_id: string; namespace_type: \"single\" | \"agnostic\"; }[]" + ], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.ApiCallGetExceptionFilterFromIdsMemoProps.onError", + "type": "Function", + "tags": [], + "label": "onError", + "description": [], + "signature": [ + "(arg: string[]) => void" + ], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.ApiCallGetExceptionFilterFromIdsMemoProps.onError.$1", + "type": "Array", + "tags": [], + "label": "arg", + "description": [], + "signature": [ + "string[]" + ], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.ApiCallGetExceptionFilterFromIdsMemoProps.onSuccess", + "type": "Function", + "tags": [], + "label": "onSuccess", + "description": [], + "signature": [ + "(arg: ", + "Filter", + ") => void" + ], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.ApiCallGetExceptionFilterFromIdsMemoProps.onSuccess.$1", + "type": "Object", + "tags": [], + "label": "arg", + "description": [], + "signature": [ + "Filter" + ], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/securitysolution-io-ts-list-types", "id": "def-common.ApiCallMemoProps", @@ -862,6 +1084,38 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.ExceptionFilterResponse", + "type": "Interface", + "tags": [], + "label": "ExceptionFilterResponse", + "description": [], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.ExceptionFilterResponse.filter", + "type": "Object", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "{ $state?: { store: ", + "FilterStateStore", + "; } | undefined; meta: ", + "FilterMeta", + "; query?: Record | undefined; }" + ], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/securitysolution-io-ts-list-types", "id": "def-common.ExceptionList", @@ -1164,46 +1418,55 @@ }, { "parentPluginId": "@kbn/securitysolution-io-ts-list-types", - "id": "def-common.Pagination", + "id": "def-common.GetExceptionFilterFromExceptionListIdsProps", "type": "Interface", "tags": [], - "label": "Pagination", + "label": "GetExceptionFilterFromExceptionListIdsProps", "description": [], + "signature": [ + { + "pluginId": "@kbn/securitysolution-io-ts-list-types", + "scope": "common", + "docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi", + "section": "def-common.GetExceptionFilterFromExceptionListIdsProps", + "text": "GetExceptionFilterFromExceptionListIdsProps" + }, + " extends ", + { + "pluginId": "@kbn/securitysolution-io-ts-list-types", + "scope": "common", + "docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi", + "section": "def-common.GetExceptionFilterOptionalProps", + "text": "GetExceptionFilterOptionalProps" + } + ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/securitysolution-io-ts-list-types", - "id": "def-common.Pagination.page", - "type": "number", - "tags": [], - "label": "page", - "description": [], - "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/securitysolution-io-ts-list-types", - "id": "def-common.Pagination.perPage", - "type": "number", + "id": "def-common.GetExceptionFilterFromExceptionListIdsProps.http", + "type": "Object", "tags": [], - "label": "perPage", + "label": "http", "description": [], + "signature": [ + "HttpStart" + ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/securitysolution-io-ts-list-types", - "id": "def-common.Pagination.total", - "type": "number", + "id": "def-common.GetExceptionFilterFromExceptionListIdsProps.exceptionListIds", + "type": "Array", "tags": [], - "label": "total", + "label": "exceptionListIds", "description": [], "signature": [ - "number | undefined" + "{ exception_list_id: string; namespace_type: \"single\" | \"agnostic\"; }[]" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", "deprecated": false, @@ -1214,12 +1477,191 @@ }, { "parentPluginId": "@kbn/securitysolution-io-ts-list-types", - "id": "def-common.PersistHookProps", + "id": "def-common.GetExceptionFilterFromExceptionsProps", "type": "Interface", "tags": [], - "label": "PersistHookProps", + "label": "GetExceptionFilterFromExceptionsProps", "description": [], - "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", + "signature": [ + { + "pluginId": "@kbn/securitysolution-io-ts-list-types", + "scope": "common", + "docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi", + "section": "def-common.GetExceptionFilterFromExceptionsProps", + "text": "GetExceptionFilterFromExceptionsProps" + }, + " extends ", + { + "pluginId": "@kbn/securitysolution-io-ts-list-types", + "scope": "common", + "docId": "kibKbnSecuritysolutionIoTsListTypesPluginApi", + "section": "def-common.GetExceptionFilterOptionalProps", + "text": "GetExceptionFilterOptionalProps" + } + ], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.GetExceptionFilterFromExceptionsProps.http", + "type": "Object", + "tags": [], + "label": "http", + "description": [], + "signature": [ + "HttpStart" + ], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.GetExceptionFilterFromExceptionsProps.exceptions", + "type": "Array", + "tags": [], + "label": "exceptions", + "description": [], + "signature": [ + "(({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) | { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; })[]" + ], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.GetExceptionFilterOptionalProps", + "type": "Interface", + "tags": [], + "label": "GetExceptionFilterOptionalProps", + "description": [], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.GetExceptionFilterOptionalProps.signal", + "type": "Object", + "tags": [], + "label": "signal", + "description": [], + "signature": [ + "AbortSignal | undefined" + ], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.GetExceptionFilterOptionalProps.chunkSize", + "type": "number", + "tags": [], + "label": "chunkSize", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.GetExceptionFilterOptionalProps.alias", + "type": "string", + "tags": [], + "label": "alias", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.GetExceptionFilterOptionalProps.excludeExceptions", + "type": "CompoundType", + "tags": [], + "label": "excludeExceptions", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.Pagination", + "type": "Interface", + "tags": [], + "label": "Pagination", + "description": [], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.Pagination.page", + "type": "number", + "tags": [], + "label": "page", + "description": [], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.Pagination.perPage", + "type": "number", + "tags": [], + "label": "perPage", + "description": [], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.Pagination.total", + "type": "number", + "tags": [], + "label": "total", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.PersistHookProps", + "type": "Interface", + "tags": [], + "label": "PersistHookProps", + "description": [], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", "deprecated": false, "trackAdoption": false, "children": [ @@ -2168,7 +2610,7 @@ "label": "CreateListSchemaDecoded", "description": [], "signature": [ - "{ type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; id: string | undefined; description: string; name: string; meta: object | undefined; serializer: string | undefined; deserializer: string | undefined; } & { version: number; }" + "{ name: string; description: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; id: string | undefined; meta: object | undefined; serializer: string | undefined; deserializer: string | undefined; } & { version: number; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/create_list_schema/index.ts", "deprecated": false, @@ -2640,6 +3082,21 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.ExceptionListId", + "type": "Type", + "tags": [], + "label": "ExceptionListId", + "description": [], + "signature": [ + "{ exception_list_id: string; namespace_type: \"single\" | \"agnostic\"; }" + ], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/get_exception_filter_schema/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "@kbn/securitysolution-io-ts-list-types", "id": "def-common.ExceptionListItemSchema", @@ -2985,6 +3442,21 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.FoundAllListItemsSchema", + "type": "Type", + "tags": [], + "label": "FoundAllListItemsSchema", + "description": [], + "signature": [ + "{ data: { _version: string | undefined; created_at: string; created_by: string; deserializer: string | undefined; id: string; list_id: string; meta: object | undefined; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; value: string; }[]; total: number; }" + ], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/found_all_list_items_schema/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "@kbn/securitysolution-io-ts-list-types", "id": "def-common.FoundExceptionListItemSchema", @@ -3030,6 +3502,21 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.FoundListsBySizeSchema", + "type": "Type", + "tags": [], + "label": "FoundListsBySizeSchema", + "description": [], + "signature": [ + "{ largeLists: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[]; smallLists: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[]; }" + ], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/found_lists_by_size_schema/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "@kbn/securitysolution-io-ts-list-types", "id": "def-common.FoundListSchema", @@ -3045,6 +3532,21 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.GetExceptionFilterSchema", + "type": "Type", + "tags": [], + "label": "GetExceptionFilterSchema", + "description": [], + "signature": [ + "({ exception_list_ids: { exception_list_id: string; namespace_type: \"single\" | \"agnostic\"; }[]; type: \"exception_list_ids\"; } | { exceptions: (({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) | { _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; })[]; type: \"exception_items\"; }) & { alias?: string | undefined; chunk_size?: number | undefined; exclude_exceptions?: boolean | undefined; }" + ], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/get_exception_filter_schema/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "@kbn/securitysolution-io-ts-list-types", "id": "def-common.Id", @@ -6095,6 +6597,32 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.exceptionListIds", + "type": "Object", + "tags": [], + "label": "exceptionListIds", + "description": [], + "signature": [ + "TypeC", + "<{ exception_list_ids: ", + "ArrayC", + "<", + "TypeC", + "<{ exception_list_id: ", + "StringC", + "; namespace_type: ", + "KeyofC", + "<{ agnostic: null; single: null; }>; }>>; type: ", + "LiteralC", + "<\"exception_list_ids\">; }>" + ], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/get_exception_filter_schema/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "@kbn/securitysolution-io-ts-list-types", "id": "def-common.exceptionListItemSchema", @@ -6415,42 +6943,246 @@ }, { "parentPluginId": "@kbn/securitysolution-io-ts-list-types", - "id": "def-common.exportExceptionDetails", + "id": "def-common.exceptions", "type": "Object", "tags": [], - "label": "exportExceptionDetails", + "label": "exceptions", "description": [], - "path": "packages/kbn-securitysolution-io-ts-list-types/src/common/exception_export_details/index.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/securitysolution-io-ts-list-types", - "id": "def-common.exportExceptionDetails.exported_exception_list_count", - "type": "Object", - "tags": [], - "label": "exported_exception_list_count", - "description": [], - "signature": [ - "NumberC" - ], - "path": "packages/kbn-securitysolution-io-ts-list-types/src/common/exception_export_details/index.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/securitysolution-io-ts-list-types", - "id": "def-common.exportExceptionDetails.exported_exception_list_item_count", - "type": "Object", - "tags": [], - "label": "exported_exception_list_item_count", - "description": [], - "signature": [ - "NumberC" - ], - "path": "packages/kbn-securitysolution-io-ts-list-types/src/common/exception_export_details/index.ts", - "deprecated": false, - "trackAdoption": false + "signature": [ + "TypeC", + "<{ exceptions: ", + "ArrayC", + "<", + "UnionC", + "<[", + "ExactC", + "<", + "TypeC", + "<{ _version: ", + "UnionC", + "<[", + "StringC", + ", ", + "UndefinedC", + "]>; comments: ", + "ArrayC", + "<", + "IntersectionC", + "<[", + "ExactC", + "<", + "TypeC", + "<{ comment: ", + "Type", + "; created_at: ", + "StringC", + "; created_by: ", + "StringC", + "; id: ", + "Type", + "; }>>, ", + "ExactC", + "<", + "PartialC", + "<{ updated_at: ", + "StringC", + "; updated_by: ", + "StringC", + "; }>>]>>; created_at: ", + "StringC", + "; created_by: ", + "StringC", + "; description: ", + "StringC", + "; entries: ", + "ArrayC", + "<", + "UnionC", + "<[", + "ExactC", + "<", + "TypeC", + "<{ field: ", + "Type", + "; operator: ", + "KeyofC", + "<{ excluded: null; included: null; }>; type: ", + "KeyofC", + "<{ match: null; }>; value: ", + "Type", + "; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ field: ", + "Type", + "; operator: ", + "KeyofC", + "<{ excluded: null; included: null; }>; type: ", + "KeyofC", + "<{ match_any: null; }>; value: ", + "Type", + "; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ field: ", + "Type", + "; list: ", + "ExactC", + "<", + "TypeC", + "<{ id: ", + "Type", + "; type: ", + "KeyofC", + "<{ binary: null; boolean: null; byte: null; date: null; date_nanos: null; date_range: null; double: null; double_range: null; float: null; float_range: null; geo_point: null; geo_shape: null; half_float: null; integer: null; integer_range: null; ip: null; ip_range: null; keyword: null; long: null; long_range: null; shape: null; short: null; text: null; }>; }>>; operator: ", + "KeyofC", + "<{ excluded: null; included: null; }>; type: ", + "KeyofC", + "<{ list: null; }>; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ field: ", + "Type", + "; operator: ", + "KeyofC", + "<{ excluded: null; included: null; }>; type: ", + "KeyofC", + "<{ exists: null; }>; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ entries: ", + "Type", + "<({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[], ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[], unknown>; field: ", + "Type", + "; type: ", + "KeyofC", + "<{ nested: null; }>; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ field: ", + "Type", + "; operator: ", + "KeyofC", + "<{ excluded: null; included: null; }>; type: ", + "KeyofC", + "<{ wildcard: null; }>; value: ", + "Type", + "; }>>]>>; id: ", + "Type", + "; item_id: ", + "Type", + "; list_id: ", + "Type", + "; meta: ", + "UnionC", + "<[", + "ObjectC", + ", ", + "UndefinedC", + "]>; name: ", + "StringC", + "; namespace_type: ", + "Type", + "<\"single\" | \"agnostic\", \"single\" | \"agnostic\" | undefined, unknown>; os_types: ", + "Type", + "<(\"windows\" | \"linux\" | \"macos\")[], (\"windows\" | \"linux\" | \"macos\")[] | undefined, unknown>; tags: ", + "Type", + "; tie_breaker_id: ", + "StringC", + "; type: ", + "KeyofC", + "<{ simple: null; }>; updated_at: ", + "StringC", + "; updated_by: ", + "StringC", + "; }>>, ", + "IntersectionC", + "<[", + "ExactC", + "<", + "TypeC", + "<{ description: ", + "StringC", + "; entries: ", + "Type", + "<({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], unknown>; list_id: ", + "Type", + "; name: ", + "StringC", + "; type: ", + "KeyofC", + "<{ simple: null; }>; }>>, ", + "ExactC", + "<", + "PartialC", + "<{ comments: ", + "Type", + "<{ comment: string; }[], { comment: string; }[], unknown>; item_id: ", + "Type", + "; meta: ", + "ObjectC", + "; namespace_type: ", + "Type", + "<\"single\" | \"agnostic\", \"single\" | \"agnostic\" | undefined, unknown>; os_types: ", + "UnionC", + "<[", + "Type", + "<(\"windows\" | \"linux\" | \"macos\")[], (\"windows\" | \"linux\" | \"macos\")[] | undefined, unknown>, ", + "UndefinedC", + "]>; tags: ", + "Type", + "; }>>]>]>>; type: ", + "LiteralC", + "<\"exception_items\">; }>" + ], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/get_exception_filter_schema/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.exportExceptionDetails", + "type": "Object", + "tags": [], + "label": "exportExceptionDetails", + "description": [], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/common/exception_export_details/index.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.exportExceptionDetails.exported_exception_list_count", + "type": "Object", + "tags": [], + "label": "exported_exception_list_count", + "description": [], + "signature": [ + "NumberC" + ], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/common/exception_export_details/index.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.exportExceptionDetails.exported_exception_list_item_count", + "type": "Object", + "tags": [], + "label": "exported_exception_list_item_count", + "description": [], + "signature": [ + "NumberC" + ], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/common/exception_export_details/index.ts", + "deprecated": false, + "trackAdoption": false }, { "parentPluginId": "@kbn/securitysolution-io-ts-list-types", @@ -6814,20 +7546,624 @@ }, { "parentPluginId": "@kbn/securitysolution-io-ts-list-types", - "id": "def-common.foundExceptionListItemSchema", + "id": "def-common.foundAllListItemsSchema", "type": "Object", "tags": [], - "label": "foundExceptionListItemSchema", + "label": "foundAllListItemsSchema", "description": [], "signature": [ - "IntersectionC", + "ExactC", + "<", + "TypeC", + "<{ data: ", + "ArrayC", + "<", + "ExactC", + "<", + "TypeC", + "<{ _version: ", + "UnionC", + "<[", + "StringC", + ", ", + "UndefinedC", + "]>; created_at: ", + "StringC", + "; created_by: ", + "StringC", + "; deserializer: ", + "UnionC", + "<[", + "StringC", + ", ", + "UndefinedC", + "]>; id: ", + "Type", + "; list_id: ", + "Type", + "; meta: ", + "UnionC", + "<[", + "ObjectC", + ", ", + "UndefinedC", + "]>; serializer: ", + "UnionC", + "<[", + "StringC", + ", ", + "UndefinedC", + "]>; tie_breaker_id: ", + "StringC", + "; type: ", + "KeyofC", + "<{ binary: null; boolean: null; byte: null; date: null; date_nanos: null; date_range: null; double: null; double_range: null; float: null; float_range: null; geo_point: null; geo_shape: null; half_float: null; integer: null; integer_range: null; ip: null; ip_range: null; keyword: null; long: null; long_range: null; shape: null; short: null; text: null; }>; updated_at: ", + "StringC", + "; updated_by: ", + "StringC", + "; value: ", + "StringC", + "; }>>>; total: ", + "NumberC", + "; }>>" + ], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/found_all_list_items_schema/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.foundExceptionListItemSchema", + "type": "Object", + "tags": [], + "label": "foundExceptionListItemSchema", + "description": [], + "signature": [ + "IntersectionC", + "<[", + "ExactC", + "<", + "TypeC", + "<{ data: ", + "ArrayC", + "<", + "ExactC", + "<", + "TypeC", + "<{ _version: ", + "UnionC", + "<[", + "StringC", + ", ", + "UndefinedC", + "]>; comments: ", + "ArrayC", + "<", + "IntersectionC", + "<[", + "ExactC", + "<", + "TypeC", + "<{ comment: ", + "Type", + "; created_at: ", + "StringC", + "; created_by: ", + "StringC", + "; id: ", + "Type", + "; }>>, ", + "ExactC", + "<", + "PartialC", + "<{ updated_at: ", + "StringC", + "; updated_by: ", + "StringC", + "; }>>]>>; created_at: ", + "StringC", + "; created_by: ", + "StringC", + "; description: ", + "StringC", + "; entries: ", + "ArrayC", + "<", + "UnionC", + "<[", + "ExactC", + "<", + "TypeC", + "<{ field: ", + "Type", + "; operator: ", + "KeyofC", + "<{ excluded: null; included: null; }>; type: ", + "KeyofC", + "<{ match: null; }>; value: ", + "Type", + "; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ field: ", + "Type", + "; operator: ", + "KeyofC", + "<{ excluded: null; included: null; }>; type: ", + "KeyofC", + "<{ match_any: null; }>; value: ", + "Type", + "; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ field: ", + "Type", + "; list: ", + "ExactC", + "<", + "TypeC", + "<{ id: ", + "Type", + "; type: ", + "KeyofC", + "<{ binary: null; boolean: null; byte: null; date: null; date_nanos: null; date_range: null; double: null; double_range: null; float: null; float_range: null; geo_point: null; geo_shape: null; half_float: null; integer: null; integer_range: null; ip: null; ip_range: null; keyword: null; long: null; long_range: null; shape: null; short: null; text: null; }>; }>>; operator: ", + "KeyofC", + "<{ excluded: null; included: null; }>; type: ", + "KeyofC", + "<{ list: null; }>; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ field: ", + "Type", + "; operator: ", + "KeyofC", + "<{ excluded: null; included: null; }>; type: ", + "KeyofC", + "<{ exists: null; }>; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ entries: ", + "Type", + "<({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[], ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[], unknown>; field: ", + "Type", + "; type: ", + "KeyofC", + "<{ nested: null; }>; }>>, ", + "ExactC", + "<", + "TypeC", + "<{ field: ", + "Type", + "; operator: ", + "KeyofC", + "<{ excluded: null; included: null; }>; type: ", + "KeyofC", + "<{ wildcard: null; }>; value: ", + "Type", + "; }>>]>>; id: ", + "Type", + "; item_id: ", + "Type", + "; list_id: ", + "Type", + "; meta: ", + "UnionC", + "<[", + "ObjectC", + ", ", + "UndefinedC", + "]>; name: ", + "StringC", + "; namespace_type: ", + "Type", + "<\"single\" | \"agnostic\", \"single\" | \"agnostic\" | undefined, unknown>; os_types: ", + "Type", + "<(\"windows\" | \"linux\" | \"macos\")[], (\"windows\" | \"linux\" | \"macos\")[] | undefined, unknown>; tags: ", + "Type", + "; tie_breaker_id: ", + "StringC", + "; type: ", + "KeyofC", + "<{ simple: null; }>; updated_at: ", + "StringC", + "; updated_by: ", + "StringC", + "; }>>>; page: ", + "NumberC", + "; per_page: ", + "NumberC", + "; total: ", + "NumberC", + "; }>>, ", + "ExactC", + "<", + "PartialC", + "<{ pit: ", + "StringC", + "; }>>]>" + ], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/found_exception_list_item_schema/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.foundExceptionListSchema", + "type": "Object", + "tags": [], + "label": "foundExceptionListSchema", + "description": [], + "signature": [ + "IntersectionC", + "<[", + "ExactC", + "<", + "TypeC", + "<{ data: ", + "ArrayC", + "<", + "ExactC", + "<", + "TypeC", + "<{ _version: ", + "UnionC", + "<[", + "StringC", + ", ", + "UndefinedC", + "]>; created_at: ", + "StringC", + "; created_by: ", + "StringC", + "; description: ", + "StringC", + "; id: ", + "Type", + "; immutable: ", + "BooleanC", + "; list_id: ", + "Type", + "; meta: ", + "UnionC", + "<[", + "ObjectC", + ", ", + "UndefinedC", + "]>; name: ", + "StringC", + "; namespace_type: ", + "Type", + "<\"single\" | \"agnostic\", \"single\" | \"agnostic\" | undefined, unknown>; os_types: ", + "Type", + "<(\"windows\" | \"linux\" | \"macos\")[], (\"windows\" | \"linux\" | \"macos\")[] | undefined, unknown>; tags: ", + "Type", + "; tie_breaker_id: ", + "StringC", + "; type: ", + "KeyofC", + "<{ detection: null; rule_default: null; endpoint: null; endpoint_trusted_apps: null; endpoint_events: null; endpoint_host_isolation_exceptions: null; endpoint_blocklists: null; }>; updated_at: ", + "StringC", + "; updated_by: ", + "StringC", + "; version: ", + "Type", + "; }>>>; page: ", + "NumberC", + "; per_page: ", + "NumberC", + "; total: ", + "NumberC", + "; }>>, ", + "ExactC", + "<", + "PartialC", + "<{ pit: ", + "StringC", + "; }>>]>" + ], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/found_exception_list_schema/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.foundListItemSchema", + "type": "Object", + "tags": [], + "label": "foundListItemSchema", + "description": [], + "signature": [ + "ExactC", + "<", + "TypeC", + "<{ cursor: ", + "StringC", + "; data: ", + "ArrayC", + "<", + "ExactC", + "<", + "TypeC", + "<{ _version: ", + "UnionC", + "<[", + "StringC", + ", ", + "UndefinedC", + "]>; created_at: ", + "StringC", + "; created_by: ", + "StringC", + "; deserializer: ", + "UnionC", + "<[", + "StringC", + ", ", + "UndefinedC", + "]>; id: ", + "Type", + "; list_id: ", + "Type", + "; meta: ", + "UnionC", + "<[", + "ObjectC", + ", ", + "UndefinedC", + "]>; serializer: ", + "UnionC", + "<[", + "StringC", + ", ", + "UndefinedC", + "]>; tie_breaker_id: ", + "StringC", + "; type: ", + "KeyofC", + "<{ binary: null; boolean: null; byte: null; date: null; date_nanos: null; date_range: null; double: null; double_range: null; float: null; float_range: null; geo_point: null; geo_shape: null; half_float: null; integer: null; integer_range: null; ip: null; ip_range: null; keyword: null; long: null; long_range: null; shape: null; short: null; text: null; }>; updated_at: ", + "StringC", + "; updated_by: ", + "StringC", + "; value: ", + "StringC", + "; }>>>; page: ", + "NumberC", + "; per_page: ", + "NumberC", + "; total: ", + "NumberC", + "; }>>" + ], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/found_list_item_schema/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.foundListsBySizeSchema", + "type": "Object", + "tags": [], + "label": "foundListsBySizeSchema", + "description": [], + "signature": [ + "ExactC", + "<", + "TypeC", + "<{ largeLists: ", + "ArrayC", + "<", + "ExactC", + "<", + "TypeC", + "<{ _version: ", + "UnionC", + "<[", + "StringC", + ", ", + "UndefinedC", + "]>; created_at: ", + "StringC", + "; created_by: ", + "StringC", + "; description: ", + "StringC", + "; deserializer: ", + "UnionC", + "<[", + "StringC", + ", ", + "UndefinedC", + "]>; id: ", + "Type", + "; immutable: ", + "BooleanC", + "; meta: ", + "UnionC", + "<[", + "ObjectC", + ", ", + "UndefinedC", + "]>; name: ", + "StringC", + "; serializer: ", + "UnionC", + "<[", + "StringC", + ", ", + "UndefinedC", + "]>; tie_breaker_id: ", + "StringC", + "; type: ", + "KeyofC", + "<{ binary: null; boolean: null; byte: null; date: null; date_nanos: null; date_range: null; double: null; double_range: null; float: null; float_range: null; geo_point: null; geo_shape: null; half_float: null; integer: null; integer_range: null; ip: null; ip_range: null; keyword: null; long: null; long_range: null; shape: null; short: null; text: null; }>; updated_at: ", + "StringC", + "; updated_by: ", + "StringC", + "; version: ", + "Type", + "; }>>>; smallLists: ", + "ArrayC", + "<", + "ExactC", + "<", + "TypeC", + "<{ _version: ", + "UnionC", + "<[", + "StringC", + ", ", + "UndefinedC", + "]>; created_at: ", + "StringC", + "; created_by: ", + "StringC", + "; description: ", + "StringC", + "; deserializer: ", + "UnionC", + "<[", + "StringC", + ", ", + "UndefinedC", + "]>; id: ", + "Type", + "; immutable: ", + "BooleanC", + "; meta: ", + "UnionC", + "<[", + "ObjectC", + ", ", + "UndefinedC", + "]>; name: ", + "StringC", + "; serializer: ", + "UnionC", + "<[", + "StringC", + ", ", + "UndefinedC", + "]>; tie_breaker_id: ", + "StringC", + "; type: ", + "KeyofC", + "<{ binary: null; boolean: null; byte: null; date: null; date_nanos: null; date_range: null; double: null; double_range: null; float: null; float_range: null; geo_point: null; geo_shape: null; half_float: null; integer: null; integer_range: null; ip: null; ip_range: null; keyword: null; long: null; long_range: null; shape: null; short: null; text: null; }>; updated_at: ", + "StringC", + "; updated_by: ", + "StringC", + "; version: ", + "Type", + "; }>>>; }>>" + ], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/found_lists_by_size_schema/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.foundListSchema", + "type": "Object", + "tags": [], + "label": "foundListSchema", + "description": [], + "signature": [ + "ExactC", + "<", + "TypeC", + "<{ cursor: ", + "StringC", + "; data: ", + "ArrayC", + "<", + "ExactC", + "<", + "TypeC", + "<{ _version: ", + "UnionC", + "<[", + "StringC", + ", ", + "UndefinedC", + "]>; created_at: ", + "StringC", + "; created_by: ", + "StringC", + "; description: ", + "StringC", + "; deserializer: ", + "UnionC", + "<[", + "StringC", + ", ", + "UndefinedC", + "]>; id: ", + "Type", + "; immutable: ", + "BooleanC", + "; meta: ", + "UnionC", + "<[", + "ObjectC", + ", ", + "UndefinedC", + "]>; name: ", + "StringC", + "; serializer: ", + "UnionC", + "<[", + "StringC", + ", ", + "UndefinedC", + "]>; tie_breaker_id: ", + "StringC", + "; type: ", + "KeyofC", + "<{ binary: null; boolean: null; byte: null; date: null; date_nanos: null; date_range: null; double: null; double_range: null; float: null; float_range: null; geo_point: null; geo_shape: null; half_float: null; integer: null; integer_range: null; ip: null; ip_range: null; keyword: null; long: null; long_range: null; shape: null; short: null; text: null; }>; updated_at: ", + "StringC", + "; updated_by: ", + "StringC", + "; version: ", + "Type", + "; }>>>; page: ", + "NumberC", + "; per_page: ", + "NumberC", + "; total: ", + "NumberC", + "; }>>" + ], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/found_list_schema/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.getExceptionFilterSchema", + "type": "Object", + "tags": [], + "label": "getExceptionFilterSchema", + "description": [], + "signature": [ + "IntersectionC", + "<[", + "UnionC", "<[", - "ExactC", - "<", "TypeC", - "<{ data: ", + "<{ exceptions: ", "ArrayC", "<", + "UnionC", + "<[", "ExactC", "<", "TypeC", @@ -6973,253 +8309,69 @@ "StringC", "; updated_by: ", "StringC", - "; }>>>; page: ", - "NumberC", - "; per_page: ", - "NumberC", - "; total: ", - "NumberC", "; }>>, ", - "ExactC", - "<", - "PartialC", - "<{ pit: ", - "StringC", - "; }>>]>" - ], - "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/found_exception_list_item_schema/index.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/securitysolution-io-ts-list-types", - "id": "def-common.foundExceptionListSchema", - "type": "Object", - "tags": [], - "label": "foundExceptionListSchema", - "description": [], - "signature": [ "IntersectionC", "<[", "ExactC", "<", "TypeC", - "<{ data: ", - "ArrayC", - "<", - "ExactC", - "<", - "TypeC", - "<{ _version: ", - "UnionC", - "<[", - "StringC", - ", ", - "UndefinedC", - "]>; created_at: ", - "StringC", - "; created_by: ", - "StringC", - "; description: ", - "StringC", - "; id: ", - "Type", - "; immutable: ", - "BooleanC", - "; list_id: ", - "Type", - "; meta: ", - "UnionC", - "<[", - "ObjectC", - ", ", - "UndefinedC", - "]>; name: ", + "<{ description: ", "StringC", - "; namespace_type: ", - "Type", - "<\"single\" | \"agnostic\", \"single\" | \"agnostic\" | undefined, unknown>; os_types: ", + "; entries: ", "Type", - "<(\"windows\" | \"linux\" | \"macos\")[], (\"windows\" | \"linux\" | \"macos\")[] | undefined, unknown>; tags: ", + "<({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; })[]; field: string; type: \"nested\"; })[], unknown>; list_id: ", "Type", - "; tie_breaker_id: ", + "; name: ", "StringC", "; type: ", "KeyofC", - "<{ detection: null; rule_default: null; endpoint: null; endpoint_trusted_apps: null; endpoint_events: null; endpoint_host_isolation_exceptions: null; endpoint_blocklists: null; }>; updated_at: ", - "StringC", - "; updated_by: ", - "StringC", - "; version: ", - "Type", - "; }>>>; page: ", - "NumberC", - "; per_page: ", - "NumberC", - "; total: ", - "NumberC", - "; }>>, ", + "<{ simple: null; }>; }>>, ", "ExactC", "<", "PartialC", - "<{ pit: ", - "StringC", - "; }>>]>" - ], - "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/found_exception_list_schema/index.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/securitysolution-io-ts-list-types", - "id": "def-common.foundListItemSchema", - "type": "Object", - "tags": [], - "label": "foundListItemSchema", - "description": [], - "signature": [ - "ExactC", - "<", - "TypeC", - "<{ cursor: ", - "StringC", - "; data: ", - "ArrayC", - "<", - "ExactC", - "<", - "TypeC", - "<{ _version: ", - "UnionC", - "<[", - "StringC", - ", ", - "UndefinedC", - "]>; created_at: ", - "StringC", - "; created_by: ", - "StringC", - "; deserializer: ", - "UnionC", - "<[", - "StringC", - ", ", - "UndefinedC", - "]>; id: ", + "<{ comments: ", "Type", - "; list_id: ", + "<{ comment: string; }[], { comment: string; }[], unknown>; item_id: ", "Type", - "; meta: ", - "UnionC", - "<[", + "; meta: ", "ObjectC", - ", ", - "UndefinedC", - "]>; serializer: ", + "; namespace_type: ", + "Type", + "<\"single\" | \"agnostic\", \"single\" | \"agnostic\" | undefined, unknown>; os_types: ", "UnionC", "<[", - "StringC", - ", ", + "Type", + "<(\"windows\" | \"linux\" | \"macos\")[], (\"windows\" | \"linux\" | \"macos\")[] | undefined, unknown>, ", "UndefinedC", - "]>; tie_breaker_id: ", - "StringC", - "; type: ", - "KeyofC", - "<{ binary: null; boolean: null; byte: null; date: null; date_nanos: null; date_range: null; double: null; double_range: null; float: null; float_range: null; geo_point: null; geo_shape: null; half_float: null; integer: null; integer_range: null; ip: null; ip_range: null; keyword: null; long: null; long_range: null; shape: null; short: null; text: null; }>; updated_at: ", - "StringC", - "; updated_by: ", - "StringC", - "; value: ", - "StringC", - "; }>>>; page: ", - "NumberC", - "; per_page: ", - "NumberC", - "; total: ", - "NumberC", - "; }>>" - ], - "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/found_list_item_schema/index.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/securitysolution-io-ts-list-types", - "id": "def-common.foundListSchema", - "type": "Object", - "tags": [], - "label": "foundListSchema", - "description": [], - "signature": [ - "ExactC", - "<", + "]>; tags: ", + "Type", + "; }>>]>]>>; type: ", + "LiteralC", + "<\"exception_items\">; }>, ", "TypeC", - "<{ cursor: ", - "StringC", - "; data: ", + "<{ exception_list_ids: ", "ArrayC", "<", - "ExactC", - "<", "TypeC", - "<{ _version: ", - "UnionC", - "<[", - "StringC", - ", ", - "UndefinedC", - "]>; created_at: ", - "StringC", - "; created_by: ", - "StringC", - "; description: ", - "StringC", - "; deserializer: ", - "UnionC", - "<[", - "StringC", - ", ", - "UndefinedC", - "]>; id: ", - "Type", - "; immutable: ", - "BooleanC", - "; meta: ", - "UnionC", - "<[", - "ObjectC", - ", ", - "UndefinedC", - "]>; name: ", - "StringC", - "; serializer: ", - "UnionC", - "<[", - "StringC", - ", ", - "UndefinedC", - "]>; tie_breaker_id: ", + "<{ exception_list_id: ", "StringC", - "; type: ", + "; namespace_type: ", "KeyofC", - "<{ binary: null; boolean: null; byte: null; date: null; date_nanos: null; date_range: null; double: null; double_range: null; float: null; float_range: null; geo_point: null; geo_shape: null; half_float: null; integer: null; integer_range: null; ip: null; ip_range: null; keyword: null; long: null; long_range: null; shape: null; short: null; text: null; }>; updated_at: ", - "StringC", - "; updated_by: ", + "<{ agnostic: null; single: null; }>; }>>; type: ", + "LiteralC", + "<\"exception_list_ids\">; }>]>, ", + "ExactC", + "<", + "PartialC", + "<{ alias: ", "StringC", - "; version: ", - "Type", - "; }>>>; page: ", - "NumberC", - "; per_page: ", - "NumberC", - "; total: ", + "; chunk_size: ", "NumberC", - "; }>>" + "; exclude_exceptions: ", + "BooleanC", + "; }>>]>" ], - "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/found_list_schema/index.ts", + "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/get_exception_filter_schema/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false @@ -8295,6 +9447,22 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-list-types", + "id": "def-common.namespace_type", + "type": "Object", + "tags": [], + "label": "namespace_type", + "description": [], + "signature": [ + "Type", + "<\"single\" | \"agnostic\", \"single\" | \"agnostic\" | undefined, unknown>" + ], + "path": "packages/kbn-securitysolution-io-ts-list-types/src/common/namespace_type/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "@kbn/securitysolution-io-ts-list-types", "id": "def-common.namespaceType", diff --git a/api_docs/kbn_securitysolution_io_ts_list_types.mdx b/api_docs/kbn_securitysolution_io_ts_list_types.mdx index adec0fb8b5efb..63986072c7322 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-list-types'] --- import kbnSecuritysolutionIoTsListTypesObj from './kbn_securitysolution_io_ts_list_types.devdocs.json'; @@ -21,7 +21,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 470 | 1 | 457 | 0 | +| 505 | 1 | 492 | 0 | ## Common diff --git a/api_docs/kbn_securitysolution_io_ts_types.devdocs.json b/api_docs/kbn_securitysolution_io_ts_types.devdocs.json index 1ba52a1137ef1..2ec94e9e8c1c0 100644 --- a/api_docs/kbn_securitysolution_io_ts_types.devdocs.json +++ b/api_docs/kbn_securitysolution_io_ts_types.devdocs.json @@ -636,6 +636,22 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-types", + "id": "def-common.TimeDurationC", + "type": "Type", + "tags": [], + "label": "TimeDurationC", + "description": [], + "signature": [ + "Type", + "" + ], + "path": "packages/kbn-securitysolution-io-ts-types/src/time_duration/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "@kbn/securitysolution-io-ts-types", "id": "def-common.UUIDC", @@ -1026,6 +1042,24 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-types", + "id": "def-common.TimeDuration", + "type": "Object", + "tags": [], + "label": "TimeDuration", + "description": [ + "\nTypes the TimeDuration as:\n - A string that is not empty, and composed of a positive integer greater than 0 followed by a unit of time\n - in the format {safe_integer}{timeUnit}, e.g. \"30s\", \"1m\", \"2h\"" + ], + "signature": [ + "Type", + "" + ], + "path": "packages/kbn-securitysolution-io-ts-types/src/time_duration/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "@kbn/securitysolution-io-ts-types", "id": "def-common.UUID", diff --git a/api_docs/kbn_securitysolution_io_ts_types.mdx b/api_docs/kbn_securitysolution_io_ts_types.mdx index cf020e8b0a27a..7a0b917859a62 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-types'] --- import kbnSecuritysolutionIoTsTypesObj from './kbn_securitysolution_io_ts_types.devdocs.json'; @@ -21,7 +21,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 61 | 0 | 32 | 0 | +| 63 | 0 | 33 | 0 | ## Common diff --git a/api_docs/kbn_securitysolution_io_ts_utils.mdx b/api_docs/kbn_securitysolution_io_ts_utils.mdx index 598a866af57e8..6177ab6c92c8d 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: 2022-09-09 +date: 2022-09-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.devdocs.json b/api_docs/kbn_securitysolution_list_api.devdocs.json index 2f92e25cf8bef..19306715a1954 100644 --- a/api_docs/kbn_securitysolution_list_api.devdocs.json +++ b/api_docs/kbn_securitysolution_list_api.devdocs.json @@ -514,6 +514,53 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/securitysolution-list-api", + "id": "def-common.findListsBySizeWithValidation", + "type": "Function", + "tags": [], + "label": "findListsBySizeWithValidation", + "description": [], + "signature": [ + "({ cursor, http, pageIndex, pageSize, signal, }: ", + { + "pluginId": "@kbn/securitysolution-list-api", + "scope": "common", + "docId": "kibKbnSecuritysolutionListApiPluginApi", + "section": "def-common.FindListsParams", + "text": "FindListsParams" + }, + ") => Promise<{ largeLists: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[]; smallLists: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[]; }>" + ], + "path": "packages/kbn-securitysolution-list-api/src/list_api/index.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/securitysolution-list-api", + "id": "def-common.findListsBySizeWithValidation.$1", + "type": "Object", + "tags": [], + "label": "{\n cursor,\n http,\n pageIndex,\n pageSize,\n signal,\n}", + "description": [], + "signature": [ + { + "pluginId": "@kbn/securitysolution-list-api", + "scope": "common", + "docId": "kibKbnSecuritysolutionListApiPluginApi", + "section": "def-common.FindListsParams", + "text": "FindListsParams" + } + ], + "path": "packages/kbn-securitysolution-list-api/src/list_api/index.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/securitysolution-list-api", "id": "def-common.findListsWithValidation", @@ -561,6 +608,88 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/securitysolution-list-api", + "id": "def-common.getExceptionFilterFromExceptionListIds", + "type": "Function", + "tags": [ + "throws" + ], + "label": "getExceptionFilterFromExceptionListIds", + "description": [ + "\nCreate a Filter query from an exception list id\n" + ], + "signature": [ + "({ alias, chunkSize, exceptionListIds, excludeExceptions, http, signal, }: ", + "GetExceptionFilterFromExceptionListIdsProps", + ") => Promise<", + "ExceptionFilterResponse", + ">" + ], + "path": "packages/kbn-securitysolution-list-api/src/api/index.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/securitysolution-list-api", + "id": "def-common.getExceptionFilterFromExceptionListIds.$1", + "type": "Object", + "tags": [], + "label": "{\n alias,\n chunkSize,\n exceptionListIds,\n excludeExceptions,\n http,\n signal,\n}", + "description": [], + "signature": [ + "GetExceptionFilterFromExceptionListIdsProps" + ], + "path": "packages/kbn-securitysolution-list-api/src/api/index.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/securitysolution-list-api", + "id": "def-common.getExceptionFilterFromExceptions", + "type": "Function", + "tags": [ + "throws" + ], + "label": "getExceptionFilterFromExceptions", + "description": [ + "\nCreate a Filter query from a list of exceptions\n" + ], + "signature": [ + "({ exceptions, alias, excludeExceptions, http, chunkSize, signal, }: ", + "GetExceptionFilterFromExceptionsProps", + ") => Promise<", + "ExceptionFilterResponse", + ">" + ], + "path": "packages/kbn-securitysolution-list-api/src/api/index.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/securitysolution-list-api", + "id": "def-common.getExceptionFilterFromExceptions.$1", + "type": "Object", + "tags": [], + "label": "{\n exceptions,\n alias,\n excludeExceptions,\n http,\n chunkSize,\n signal,\n}", + "description": [], + "signature": [ + "GetExceptionFilterFromExceptionsProps" + ], + "path": "packages/kbn-securitysolution-list-api/src/api/index.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/securitysolution-list-api", "id": "def-common.importListWithValidation", diff --git a/api_docs/kbn_securitysolution_list_api.mdx b/api_docs/kbn_securitysolution_list_api.mdx index 7f8c8c6110751..4b880041473c4 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-api'] --- import kbnSecuritysolutionListApiObj from './kbn_securitysolution_list_api.devdocs.json'; @@ -21,7 +21,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 61 | 0 | 60 | 0 | +| 67 | 0 | 64 | 0 | ## Common diff --git a/api_docs/kbn_securitysolution_list_constants.devdocs.json b/api_docs/kbn_securitysolution_list_constants.devdocs.json index 3b2c4d2823509..0ce3f56b027df 100644 --- a/api_docs/kbn_securitysolution_list_constants.devdocs.json +++ b/api_docs/kbn_securitysolution_list_constants.devdocs.json @@ -299,6 +299,21 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "@kbn/securitysolution-list-constants", + "id": "def-common.EXCEPTION_FILTER", + "type": "string", + "tags": [], + "label": "EXCEPTION_FILTER", + "description": [], + "signature": [ + "\"/internal/lists/_create_filter\"" + ], + "path": "packages/kbn-securitysolution-list-constants/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "@kbn/securitysolution-list-constants", "id": "def-common.EXCEPTION_LIST_ITEM_URL", @@ -363,6 +378,21 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "@kbn/securitysolution-list-constants", + "id": "def-common.FIND_LISTS_BY_SIZE", + "type": "string", + "tags": [], + "label": "FIND_LISTS_BY_SIZE", + "description": [], + "signature": [ + "\"/internal/lists/_find_lists_by_size\"" + ], + "path": "packages/kbn-securitysolution-list-constants/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "@kbn/securitysolution-list-constants", "id": "def-common.INTERNAL_EXCEPTION_LIST_URL", @@ -389,6 +419,23 @@ "trackAdoption": false, "initialIsOpen": false }, + { + "parentPluginId": "@kbn/securitysolution-list-constants", + "id": "def-common.INTERNAL_LIST_URL", + "type": "string", + "tags": [], + "label": "INTERNAL_LIST_URL", + "description": [ + "\nInternal value list routes" + ], + "signature": [ + "\"/internal/lists\"" + ], + "path": "packages/kbn-securitysolution-list-constants/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, { "parentPluginId": "@kbn/securitysolution-list-constants", "id": "def-common.LIST_INDEX", @@ -456,6 +503,36 @@ "deprecated": false, "trackAdoption": false, "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/securitysolution-list-constants", + "id": "def-common.MAXIMUM_SMALL_IP_RANGE_VALUE_LIST_DASH_SIZE", + "type": "number", + "tags": [], + "label": "MAXIMUM_SMALL_IP_RANGE_VALUE_LIST_DASH_SIZE", + "description": [], + "signature": [ + "200" + ], + "path": "packages/kbn-securitysolution-list-constants/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/securitysolution-list-constants", + "id": "def-common.MAXIMUM_SMALL_VALUE_LIST_SIZE", + "type": "number", + "tags": [], + "label": "MAXIMUM_SMALL_VALUE_LIST_SIZE", + "description": [], + "signature": [ + "65536" + ], + "path": "packages/kbn-securitysolution-list-constants/index.ts", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false } ], "objects": [] diff --git a/api_docs/kbn_securitysolution_list_constants.mdx b/api_docs/kbn_securitysolution_list_constants.mdx index 3690bc8cbc2b4..28cf4efef38a8 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-constants'] --- import kbnSecuritysolutionListConstantsObj from './kbn_securitysolution_list_constants.devdocs.json'; @@ -21,7 +21,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 28 | 0 | 13 | 0 | +| 33 | 0 | 17 | 0 | ## Common diff --git a/api_docs/kbn_securitysolution_list_hooks.devdocs.json b/api_docs/kbn_securitysolution_list_hooks.devdocs.json index 05d6b763b7c16..442efdd46470e 100644 --- a/api_docs/kbn_securitysolution_list_hooks.devdocs.json +++ b/api_docs/kbn_securitysolution_list_hooks.devdocs.json @@ -431,6 +431,29 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/securitysolution-list-hooks", + "id": "def-common.useFindListsBySize", + "type": "Function", + "tags": [], + "label": "useFindListsBySize", + "description": [], + "signature": [ + "() => ", + "Task", + "<[args: ", + "OptionalSignalArgs", + "<", + "FindListsParams", + ">], { largeLists: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[]; smallLists: { _version: string | undefined; created_at: string; created_by: string; description: string; deserializer: string | undefined; id: string; immutable: boolean; meta: object | undefined; name: string; serializer: string | undefined; tie_breaker_id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; updated_at: string; updated_by: string; version: number; }[]; }>" + ], + "path": "packages/kbn-securitysolution-list-hooks/src/use_find_lists_by_size/index.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/securitysolution-list-hooks", "id": "def-common.useImportList", @@ -861,6 +884,74 @@ ], "returnComment": [] }, + { + "parentPluginId": "@kbn/securitysolution-list-hooks", + "id": "def-common.ExceptionsApi.getExceptionFilterFromIds", + "type": "Function", + "tags": [], + "label": "getExceptionFilterFromIds", + "description": [], + "signature": [ + "(arg: ", + "ApiCallGetExceptionFilterFromIdsMemoProps", + ") => Promise" + ], + "path": "packages/kbn-securitysolution-list-hooks/src/use_api/index.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/securitysolution-list-hooks", + "id": "def-common.ExceptionsApi.getExceptionFilterFromIds.$1", + "type": "Object", + "tags": [], + "label": "arg", + "description": [], + "signature": [ + "ApiCallGetExceptionFilterFromIdsMemoProps" + ], + "path": "packages/kbn-securitysolution-list-hooks/src/use_api/index.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/securitysolution-list-hooks", + "id": "def-common.ExceptionsApi.getExceptionFilterFromExceptions", + "type": "Function", + "tags": [], + "label": "getExceptionFilterFromExceptions", + "description": [], + "signature": [ + "(arg: ", + "ApiCallGetExceptionFilterFromExceptionsMemoProps", + ") => Promise" + ], + "path": "packages/kbn-securitysolution-list-hooks/src/use_api/index.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/securitysolution-list-hooks", + "id": "def-common.ExceptionsApi.getExceptionFilterFromExceptions.$1", + "type": "Object", + "tags": [], + "label": "arg", + "description": [], + "signature": [ + "ApiCallGetExceptionFilterFromExceptionsMemoProps" + ], + "path": "packages/kbn-securitysolution-list-hooks/src/use_api/index.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, { "parentPluginId": "@kbn/securitysolution-list-hooks", "id": "def-common.ExceptionsApi.exportExceptionList", diff --git a/api_docs/kbn_securitysolution_list_hooks.mdx b/api_docs/kbn_securitysolution_list_hooks.mdx index e30499cbbf39a..e2232050612c1 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-hooks'] --- import kbnSecuritysolutionListHooksObj from './kbn_securitysolution_list_hooks.devdocs.json'; @@ -21,7 +21,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 53 | 0 | 42 | 0 | +| 58 | 0 | 47 | 0 | ## Common diff --git a/api_docs/kbn_securitysolution_list_utils.devdocs.json b/api_docs/kbn_securitysolution_list_utils.devdocs.json index fd0a5457d52bc..0518a331879b0 100644 --- a/api_docs/kbn_securitysolution_list_utils.devdocs.json +++ b/api_docs/kbn_securitysolution_list_utils.devdocs.json @@ -54,704 +54,44 @@ }, { "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.buildExceptionFilter", - "type": "Function", - "tags": [], - "label": "buildExceptionFilter", - "description": [], - "signature": [ - "({ lists, excludeExceptions, chunkSize, alias, }: { lists: ({ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | ({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }))[]; excludeExceptions: boolean; chunkSize: number; alias: string | null; }) => ", - "Filter", - " | undefined" - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.buildExceptionFilter.$1", - "type": "Object", - "tags": [], - "label": "{\n lists,\n excludeExceptions,\n chunkSize,\n alias = null,\n}", - "description": [], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.buildExceptionFilter.$1.lists", - "type": "Array", - "tags": [], - "label": "lists", - "description": [], - "signature": [ - "({ _version: string | undefined; comments: ({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; })[]; created_at: string; created_by: string; description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; })[]; id: string; item_id: string; list_id: string; meta: object | undefined; name: string; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; tags: string[]; tie_breaker_id: string; type: \"simple\"; updated_at: string; updated_by: string; } | ({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"text\" | \"geo_point\" | \"geo_shape\" | \"date_nanos\" | \"long\" | \"double\" | \"date_range\" | \"ip_range\" | \"shape\" | \"short\" | \"binary\" | \"float\" | \"half_float\" | \"integer\" | \"byte\" | \"long_range\" | \"integer_range\" | \"float_range\" | \"double_range\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; list_id: string; name: string; type: \"simple\"; } & { comments?: { comment: string; }[] | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }))[]" - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.buildExceptionFilter.$1.excludeExceptions", - "type": "boolean", - "tags": [], - "label": "excludeExceptions", - "description": [], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.buildExceptionFilter.$1.chunkSize", - "type": "number", - "tags": [], - "label": "chunkSize", - "description": [], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false - }, - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.buildExceptionFilter.$1.alias", - "type": "CompoundType", - "tags": [], - "label": "alias", - "description": [], - "signature": [ - "string | null" - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false - } - ] - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.buildExceptionItemFilter", - "type": "Function", - "tags": [], - "label": "buildExceptionItemFilter", - "description": [], - "signature": [ - "(exceptionItem: ", - { - "pluginId": "@kbn/securitysolution-list-utils", - "scope": "common", - "docId": "kibKbnSecuritysolutionListUtilsPluginApi", - "section": "def-common.ExceptionItemSansLargeValueLists", - "text": "ExceptionItemSansLargeValueLists" - }, - ") => (", - { - "pluginId": "@kbn/securitysolution-list-utils", - "scope": "common", - "docId": "kibKbnSecuritysolutionListUtilsPluginApi", - "section": "def-common.BooleanFilter", - "text": "BooleanFilter" - }, - " | ", - { - "pluginId": "@kbn/securitysolution-list-utils", - "scope": "common", - "docId": "kibKbnSecuritysolutionListUtilsPluginApi", - "section": "def-common.NestedFilter", - "text": "NestedFilter" - }, - ")[]" - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.buildExceptionItemFilter.$1", - "type": "CompoundType", - "tags": [], - "label": "exceptionItem", - "description": [], - "signature": [ - { - "pluginId": "@kbn/securitysolution-list-utils", - "scope": "common", - "docId": "kibKbnSecuritysolutionListUtilsPluginApi", - "section": "def-common.ExceptionItemSansLargeValueLists", - "text": "ExceptionItemSansLargeValueLists" - } - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.buildExceptionItemFilterWithOsType", - "type": "Function", - "tags": [], - "label": "buildExceptionItemFilterWithOsType", - "description": [ - "\nThis builds an exception item filter with the os type" - ], - "signature": [ - "(osTypes: (\"windows\" | \"linux\" | \"macos\")[], entries: NonListEntry[]) => ", - { - "pluginId": "@kbn/securitysolution-list-utils", - "scope": "common", - "docId": "kibKbnSecuritysolutionListUtilsPluginApi", - "section": "def-common.BooleanFilter", - "text": "BooleanFilter" - }, - "[]" - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.buildExceptionItemFilterWithOsType.$1", - "type": "Array", - "tags": [], - "label": "osTypes", - "description": [ - "The os_type array from the REST interface that is an array such as ['windows', 'linux']" - ], - "signature": [ - "(\"windows\" | \"linux\" | \"macos\")[]" - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.buildExceptionItemFilterWithOsType.$2", - "type": "Array", - "tags": [], - "label": "entries", - "description": [ - "The entries to join the OR's with before the elastic filter change out" - ], - "signature": [ - "NonListEntry[]" - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.buildExclusionClause", - "type": "Function", - "tags": [], - "label": "buildExclusionClause", - "description": [], - "signature": [ - "(booleanFilter: ", - { - "pluginId": "@kbn/securitysolution-list-utils", - "scope": "common", - "docId": "kibKbnSecuritysolutionListUtilsPluginApi", - "section": "def-common.BooleanFilter", - "text": "BooleanFilter" - }, - ") => ", - { - "pluginId": "@kbn/securitysolution-list-utils", - "scope": "common", - "docId": "kibKbnSecuritysolutionListUtilsPluginApi", - "section": "def-common.BooleanFilter", - "text": "BooleanFilter" - } - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.buildExclusionClause.$1", - "type": "Object", - "tags": [], - "label": "booleanFilter", - "description": [], - "signature": [ - { - "pluginId": "@kbn/securitysolution-list-utils", - "scope": "common", - "docId": "kibKbnSecuritysolutionListUtilsPluginApi", - "section": "def-common.BooleanFilter", - "text": "BooleanFilter" - } - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.buildExistsClause", - "type": "Function", - "tags": [], - "label": "buildExistsClause", - "description": [], - "signature": [ - "(entry: { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; }) => ", - { - "pluginId": "@kbn/securitysolution-list-utils", - "scope": "common", - "docId": "kibKbnSecuritysolutionListUtilsPluginApi", - "section": "def-common.BooleanFilter", - "text": "BooleanFilter" - } - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.buildExistsClause.$1", - "type": "Object", - "tags": [], - "label": "entry", - "description": [], - "signature": [ - "{ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; }" - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.buildMatchAnyClause", - "type": "Function", - "tags": [], - "label": "buildMatchAnyClause", - "description": [], - "signature": [ - "(entry: { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; }) => ", - { - "pluginId": "@kbn/securitysolution-list-utils", - "scope": "common", - "docId": "kibKbnSecuritysolutionListUtilsPluginApi", - "section": "def-common.BooleanFilter", - "text": "BooleanFilter" - } - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.buildMatchAnyClause.$1", - "type": "Object", - "tags": [], - "label": "entry", - "description": [], - "signature": [ - "{ field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; }" - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.buildMatchClause", - "type": "Function", - "tags": [], - "label": "buildMatchClause", - "description": [], - "signature": [ - "(entry: { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; }) => ", - { - "pluginId": "@kbn/securitysolution-list-utils", - "scope": "common", - "docId": "kibKbnSecuritysolutionListUtilsPluginApi", - "section": "def-common.BooleanFilter", - "text": "BooleanFilter" - } - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.buildMatchClause.$1", - "type": "Object", - "tags": [], - "label": "entry", - "description": [], - "signature": [ - "{ field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; }" - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.buildMatchWildcardClause", - "type": "Function", - "tags": [], - "label": "buildMatchWildcardClause", - "description": [], - "signature": [ - "(entry: { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; }) => ", - { - "pluginId": "@kbn/securitysolution-list-utils", - "scope": "common", - "docId": "kibKbnSecuritysolutionListUtilsPluginApi", - "section": "def-common.BooleanFilter", - "text": "BooleanFilter" - } - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.buildMatchWildcardClause.$1", - "type": "Object", - "tags": [], - "label": "entry", - "description": [], - "signature": [ - "{ field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; }" - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.buildNestedClause", - "type": "Function", - "tags": [], - "label": "buildNestedClause", - "description": [], - "signature": [ - "(entry: { entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; }) => ", - { - "pluginId": "@kbn/securitysolution-list-utils", - "scope": "common", - "docId": "kibKbnSecuritysolutionListUtilsPluginApi", - "section": "def-common.NestedFilter", - "text": "NestedFilter" - } - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.buildNestedClause.$1", - "type": "Object", - "tags": [], - "label": "entry", - "description": [], - "signature": [ - "{ entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; }" - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.chunkExceptions", - "type": "Function", - "tags": [], - "label": "chunkExceptions", - "description": [], - "signature": [ - "(exceptions: ", - { - "pluginId": "@kbn/securitysolution-list-utils", - "scope": "common", - "docId": "kibKbnSecuritysolutionListUtilsPluginApi", - "section": "def-common.ExceptionItemSansLargeValueLists", - "text": "ExceptionItemSansLargeValueLists" - }, - "[], chunkSize: number) => ", - { - "pluginId": "@kbn/securitysolution-list-utils", - "scope": "common", - "docId": "kibKbnSecuritysolutionListUtilsPluginApi", - "section": "def-common.ExceptionItemSansLargeValueLists", - "text": "ExceptionItemSansLargeValueLists" - }, - "[][]" - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.chunkExceptions.$1", - "type": "Array", - "tags": [], - "label": "exceptions", - "description": [], - "signature": [ - { - "pluginId": "@kbn/securitysolution-list-utils", - "scope": "common", - "docId": "kibKbnSecuritysolutionListUtilsPluginApi", - "section": "def-common.ExceptionItemSansLargeValueLists", - "text": "ExceptionItemSansLargeValueLists" - }, - "[]" - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.chunkExceptions.$2", - "type": "number", - "tags": [], - "label": "chunkSize", - "description": [], - "signature": [ - "number" - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.containsValueListEntry", - "type": "Function", - "tags": [], - "label": "containsValueListEntry", - "description": [], - "signature": [ - "(items: ", - { - "pluginId": "@kbn/securitysolution-list-utils", - "scope": "common", - "docId": "kibKbnSecuritysolutionListUtilsPluginApi", - "section": "def-common.ExceptionsBuilderExceptionItem", - "text": "ExceptionsBuilderExceptionItem" - }, - "[]) => boolean" - ], - "path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.containsValueListEntry.$1", - "type": "Array", - "tags": [], - "label": "items", - "description": [], - "signature": [ - { - "pluginId": "@kbn/securitysolution-list-utils", - "scope": "common", - "docId": "kibKbnSecuritysolutionListUtilsPluginApi", - "section": "def-common.ExceptionsBuilderExceptionItem", - "text": "ExceptionsBuilderExceptionItem" - }, - "[]" - ], - "path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.createInnerAndClauses", - "type": "Function", - "tags": [], - "label": "createInnerAndClauses", - "description": [], - "signature": [ - "(entry: NonListEntry, parent?: string | undefined) => ", - { - "pluginId": "@kbn/securitysolution-list-utils", - "scope": "common", - "docId": "kibKbnSecuritysolutionListUtilsPluginApi", - "section": "def-common.BooleanFilter", - "text": "BooleanFilter" - }, - " | ", - { - "pluginId": "@kbn/securitysolution-list-utils", - "scope": "common", - "docId": "kibKbnSecuritysolutionListUtilsPluginApi", - "section": "def-common.NestedFilter", - "text": "NestedFilter" - } - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.createInnerAndClauses.$1", - "type": "CompoundType", - "tags": [], - "label": "entry", - "description": [], - "signature": [ - "NonListEntry" - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.createInnerAndClauses.$2", - "type": "string", - "tags": [], - "label": "parent", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": false - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.createOrClauses", + "id": "def-common.containsValueListEntry", "type": "Function", "tags": [], - "label": "createOrClauses", + "label": "containsValueListEntry", "description": [], "signature": [ - "(exceptionItems: ", - { - "pluginId": "@kbn/securitysolution-list-utils", - "scope": "common", - "docId": "kibKbnSecuritysolutionListUtilsPluginApi", - "section": "def-common.ExceptionItemSansLargeValueLists", - "text": "ExceptionItemSansLargeValueLists" - }, - "[]) => (", - { - "pluginId": "@kbn/securitysolution-list-utils", - "scope": "common", - "docId": "kibKbnSecuritysolutionListUtilsPluginApi", - "section": "def-common.BooleanFilter", - "text": "BooleanFilter" - }, - " | ", + "(items: ", { "pluginId": "@kbn/securitysolution-list-utils", "scope": "common", "docId": "kibKbnSecuritysolutionListUtilsPluginApi", - "section": "def-common.NestedFilter", - "text": "NestedFilter" + "section": "def-common.ExceptionsBuilderExceptionItem", + "text": "ExceptionsBuilderExceptionItem" }, - ")[]" + "[]) => boolean" ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", + "path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.createOrClauses.$1", + "id": "def-common.containsValueListEntry.$1", "type": "Array", "tags": [], - "label": "exceptionItems", + "label": "items", "description": [], "signature": [ { "pluginId": "@kbn/securitysolution-list-utils", "scope": "common", "docId": "kibKbnSecuritysolutionListUtilsPluginApi", - "section": "def-common.ExceptionItemSansLargeValueLists", - "text": "ExceptionItemSansLargeValueLists" + "section": "def-common.ExceptionsBuilderExceptionItem", + "text": "ExceptionsBuilderExceptionItem" }, "[]" ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", + "path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts", "deprecated": false, "trackAdoption": false, "isRequired": true @@ -808,101 +148,6 @@ "returnComment": [], "initialIsOpen": false }, - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.getBaseMatchAnyClause", - "type": "Function", - "tags": [], - "label": "getBaseMatchAnyClause", - "description": [], - "signature": [ - "(entry: { field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; }) => ", - { - "pluginId": "@kbn/securitysolution-list-utils", - "scope": "common", - "docId": "kibKbnSecuritysolutionListUtilsPluginApi", - "section": "def-common.BooleanFilter", - "text": "BooleanFilter" - } - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.getBaseMatchAnyClause.$1", - "type": "Object", - "tags": [], - "label": "entry", - "description": [], - "signature": [ - "{ field: string; operator: \"excluded\" | \"included\"; type: \"match_any\"; value: string[]; }" - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.getBaseNestedClause", - "type": "Function", - "tags": [], - "label": "getBaseNestedClause", - "description": [], - "signature": [ - "(entries: NonListEntry[], parentField: string) => ", - { - "pluginId": "@kbn/securitysolution-list-utils", - "scope": "common", - "docId": "kibKbnSecuritysolutionListUtilsPluginApi", - "section": "def-common.BooleanFilter", - "text": "BooleanFilter" - } - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.getBaseNestedClause.$1", - "type": "Array", - "tags": [], - "label": "entries", - "description": [], - "signature": [ - "NonListEntry[]" - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.getBaseNestedClause.$2", - "type": "string", - "tags": [], - "label": "parentField", - "description": [], - "signature": [ - "string" - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, { "parentPluginId": "@kbn/securitysolution-list-utils", "id": "def-common.getCorrespondingKeywordField", @@ -2763,91 +2008,9 @@ ], "returnComment": [], "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.transformOsType", - "type": "Function", - "tags": [], - "label": "transformOsType", - "description": [ - "\nTransforms the os_type into a regular filter as if the user had created it\nfrom the fields for the next state of transforms which will create the elastic filters\nfrom it.\n\nNote: We use two types of fields, the \"host.os.type\" and \"host.os.name.caseless\"\nThe endpoint/endgame agent has been using \"host.os.name.caseless\" as the same value as the ECS\nvalue of \"host.os.type\" where the auditbeat, winlogbeat, etc... (other agents) are all using\n\"host.os.type\". In order to be compatible with both, I create an \"OR\" between these two data types\nwhere if either has a match then we will exclude it as part of the match. This should also be\nforwards compatible for endpoints/endgame agents when/if they upgrade to using \"host.os.type\"\nrather than using \"host.os.name.caseless\" values.\n\nAlso we create another \"OR\" from the osType names so that if there are multiples such as ['windows', 'linux']\nthis will exclude anything with either 'windows' or with 'linux'" - ], - "signature": [ - "(osTypes: (\"windows\" | \"linux\" | \"macos\")[], entries: NonListEntry[]) => NonListEntry[][]" - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.transformOsType.$1", - "type": "Array", - "tags": [], - "label": "osTypes", - "description": [ - "The os_type array from the REST interface that is an array such as ['windows', 'linux']" - ], - "signature": [ - "(\"windows\" | \"linux\" | \"macos\")[]" - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.transformOsType.$2", - "type": "Array", - "tags": [], - "label": "entries", - "description": [ - "The entries to join the OR's with before the elastic filter change out" - ], - "signature": [ - "NonListEntry[]" - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false } ], "interfaces": [ - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.BooleanFilter", - "type": "Interface", - "tags": [], - "label": "BooleanFilter", - "description": [], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.BooleanFilter.bool", - "type": "Object", - "tags": [], - "label": "bool", - "description": [], - "signature": [ - "QueryDslBoolQuery" - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "@kbn/securitysolution-list-utils", "id": "def-common.EmptyEntry", @@ -3276,34 +2439,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.NestedFilter", - "type": "Interface", - "tags": [], - "label": "NestedFilter", - "description": [], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false, - "children": [ - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.NestedFilter.nested", - "type": "Object", - "tags": [], - "label": "nested", - "description": [], - "signature": [ - "QueryDslNestedQuery" - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "@kbn/securitysolution-list-utils", "id": "def-common.OperatorOption", @@ -3565,21 +2700,6 @@ "trackAdoption": false, "initialIsOpen": false }, - { - "parentPluginId": "@kbn/securitysolution-list-utils", - "id": "def-common.ExceptionItemSansLargeValueLists", - "type": "Type", - "tags": [], - "label": "ExceptionItemSansLargeValueLists", - "description": [], - "signature": [ - "ExceptionListItemNonLargeList | CreateExceptionListItemNonLargeList" - ], - "path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts", - "deprecated": false, - "trackAdoption": false, - "initialIsOpen": false - }, { "parentPluginId": "@kbn/securitysolution-list-utils", "id": "def-common.exceptionListAgnosticSavedObjectType", diff --git a/api_docs/kbn_securitysolution_list_utils.mdx b/api_docs/kbn_securitysolution_list_utils.mdx index 22657a04b1bb9..44b7742d2b5c7 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-utils'] --- import kbnSecuritysolutionListUtilsObj from './kbn_securitysolution_list_utils.devdocs.json'; @@ -21,7 +21,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 235 | 0 | 187 | 0 | +| 191 | 0 | 149 | 0 | ## Common diff --git a/api_docs/kbn_securitysolution_rules.mdx b/api_docs/kbn_securitysolution_rules.mdx index 19a2c081a5bd7..b979309b06fc5 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: 2022-09-09 +date: 2022-09-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 65f02eb6305e7..fd74c70883973 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: 2022-09-09 +date: 2022-09-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 f84326704b432..0acf0fc188b95 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: 2022-09-09 +date: 2022-09-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 2553be04e72c4..be7aff880057c 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: 2022-09-09 +date: 2022-09-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 e1deb3f5d47f7..bdba63997b786 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: 2022-09-09 +date: 2022-09-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_shared_svg.mdx b/api_docs/kbn_shared_svg.mdx index e28e8dfe7c35a..5cf5c679becea 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: 2022-09-09 +date: 2022-09-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_user_profile_components.devdocs.json b/api_docs/kbn_shared_ux_avatar_user_profile_components.devdocs.json new file mode 100644 index 0000000000000..3d6d19d536721 --- /dev/null +++ b/api_docs/kbn_shared_ux_avatar_user_profile_components.devdocs.json @@ -0,0 +1,857 @@ +{ + "id": "@kbn/shared-ux-avatar-user-profile-components", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserAvatar", + "type": "Function", + "tags": [], + "label": "UserAvatar", + "description": [ + "\nRenders an avatar given a user profile" + ], + "signature": [ + "({ user, avatar, ...rest }: React.PropsWithChildren<", + { + "pluginId": "@kbn/shared-ux-avatar-user-profile-components", + "scope": "common", + "docId": "kibKbnSharedUxAvatarUserProfileComponentsPluginApi", + "section": "def-common.UserAvatarProps", + "text": "UserAvatarProps" + }, + ">) => JSX.Element" + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_avatar.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserAvatar.$1", + "type": "CompoundType", + "tags": [], + "label": "{ user, avatar, ...rest }", + "description": [], + "signature": [ + "React.PropsWithChildren<", + { + "pluginId": "@kbn/shared-ux-avatar-user-profile-components", + "scope": "common", + "docId": "kibKbnSharedUxAvatarUserProfileComponentsPluginApi", + "section": "def-common.UserAvatarProps", + "text": "UserAvatarProps" + }, + ">" + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_avatar.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserProfilesPopover", + "type": "Function", + "tags": [], + "label": "UserProfilesPopover", + "description": [ + "\nRenders a selectable component inside a popover given a list of user profiles" + ], + "signature": [ + "({ title, selectableProps, ...popoverProps }: React.PropsWithChildren<", + { + "pluginId": "@kbn/shared-ux-avatar-user-profile-components", + "scope": "common", + "docId": "kibKbnSharedUxAvatarUserProfileComponentsPluginApi", + "section": "def-common.UserProfilesPopoverProps", + "text": "UserProfilesPopoverProps" + }, + ">) => JSX.Element" + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_profiles_popover.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserProfilesPopover.$1", + "type": "CompoundType", + "tags": [], + "label": "{\n title,\n selectableProps,\n ...popoverProps\n}", + "description": [], + "signature": [ + "React.PropsWithChildren<", + { + "pluginId": "@kbn/shared-ux-avatar-user-profile-components", + "scope": "common", + "docId": "kibKbnSharedUxAvatarUserProfileComponentsPluginApi", + "section": "def-common.UserProfilesPopoverProps", + "text": "UserProfilesPopoverProps" + }, + ">" + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_profiles_popover.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserProfilesSelectable", + "type": "Function", + "tags": [], + "label": "UserProfilesSelectable", + "description": [ + "\nRenders a selectable component given a list of user profiles" + ], + "signature": [ + "({ selectedOptions, defaultOptions, options, onChange, onSearchChange, isLoading, singleSelection, height, loadingMessage, noMatchesMessage, emptyMessage, errorMessage, searchPlaceholder, selectedStatusMessage, clearButtonLabel, }: React.PropsWithChildren<", + { + "pluginId": "@kbn/shared-ux-avatar-user-profile-components", + "scope": "common", + "docId": "kibKbnSharedUxAvatarUserProfileComponentsPluginApi", + "section": "def-common.UserProfilesSelectableProps", + "text": "UserProfilesSelectableProps" + }, + ">) => JSX.Element" + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_profiles_selectable.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserProfilesSelectable.$1", + "type": "CompoundType", + "tags": [], + "label": "{\n selectedOptions,\n defaultOptions,\n options,\n onChange,\n onSearchChange,\n isLoading = false,\n singleSelection = false,\n height,\n loadingMessage,\n noMatchesMessage,\n emptyMessage,\n errorMessage,\n searchPlaceholder,\n selectedStatusMessage,\n clearButtonLabel,\n}", + "description": [], + "signature": [ + "React.PropsWithChildren<", + { + "pluginId": "@kbn/shared-ux-avatar-user-profile-components", + "scope": "common", + "docId": "kibKbnSharedUxAvatarUserProfileComponentsPluginApi", + "section": "def-common.UserProfilesSelectableProps", + "text": "UserProfilesSelectableProps" + }, + ">" + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_profiles_selectable.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserAvatarProps", + "type": "Interface", + "tags": [], + "label": "UserAvatarProps", + "description": [ + "\nProps of {@link UserAvatar} component" + ], + "signature": [ + { + "pluginId": "@kbn/shared-ux-avatar-user-profile-components", + "scope": "common", + "docId": "kibKbnSharedUxAvatarUserProfileComponentsPluginApi", + "section": "def-common.UserAvatarProps", + "text": "UserAvatarProps" + }, + " extends Omit<", + "EuiAvatarProps", + ", \"name\" | \"type\" | \"color\" | \"iconColor\" | \"iconType\" | \"iconSize\" | \"initials\" | \"initialsLength\" | \"imageUrl\">" + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_avatar.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserAvatarProps.user", + "type": "Object", + "tags": [], + "label": "user", + "description": [ + "\nUser to be rendered" + ], + "signature": [ + { + "pluginId": "@kbn/shared-ux-avatar-user-profile-components", + "scope": "common", + "docId": "kibKbnSharedUxAvatarUserProfileComponentsPluginApi", + "section": "def-common.UserProfileUserInfo", + "text": "UserProfileUserInfo" + }, + " | undefined" + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_avatar.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserAvatarProps.avatar", + "type": "Object", + "tags": [], + "label": "avatar", + "description": [ + "\nAvatar data of user to be rendered" + ], + "signature": [ + { + "pluginId": "@kbn/shared-ux-avatar-user-profile-components", + "scope": "common", + "docId": "kibKbnSharedUxAvatarUserProfileComponentsPluginApi", + "section": "def-common.UserProfileAvatarData", + "text": "UserProfileAvatarData" + }, + " | undefined" + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_avatar.tsx", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserProfile", + "type": "Interface", + "tags": [], + "label": "UserProfile", + "description": [ + "\nIMPORTANT:\n\nThe types in this file have been imported from\n`x-pack/plugins/security/common/model/user_profile.ts`\n\nWhen making changes please ensure to keep both files in sync.\n\nDescribes basic properties stored in user profile." + ], + "signature": [ + { + "pluginId": "@kbn/shared-ux-avatar-user-profile-components", + "scope": "common", + "docId": "kibKbnSharedUxAvatarUserProfileComponentsPluginApi", + "section": "def-common.UserProfile", + "text": "UserProfile" + }, + "" + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_profile.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserProfile.uid", + "type": "string", + "tags": [], + "label": "uid", + "description": [ + "\nUnique ID for of the user profile." + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_profile.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserProfile.enabled", + "type": "boolean", + "tags": [], + "label": "enabled", + "description": [ + "\nIndicates whether user profile is enabled or not." + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_profile.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserProfile.user", + "type": "Object", + "tags": [], + "label": "user", + "description": [ + "\nInformation about the user that owns profile." + ], + "signature": [ + { + "pluginId": "@kbn/shared-ux-avatar-user-profile-components", + "scope": "common", + "docId": "kibKbnSharedUxAvatarUserProfileComponentsPluginApi", + "section": "def-common.UserProfileUserInfo", + "text": "UserProfileUserInfo" + } + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_profile.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserProfile.data", + "type": "Object", + "tags": [], + "label": "data", + "description": [ + "\nUser specific data associated with the profile." + ], + "signature": [ + "{ [P in keyof D]?: D[P] | undefined; }" + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_profile.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserProfileAvatarData", + "type": "Interface", + "tags": [], + "label": "UserProfileAvatarData", + "description": [ + "\nAvatar stored in user profile." + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_profile.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserProfileAvatarData.initials", + "type": "string", + "tags": [], + "label": "initials", + "description": [ + "\nOptional initials (two letters) of the user to use as avatar if avatar picture isn't specified." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_profile.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserProfileAvatarData.color", + "type": "string", + "tags": [], + "label": "color", + "description": [ + "\nBackground color of the avatar when initials are used." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_profile.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserProfileAvatarData.imageUrl", + "type": "string", + "tags": [], + "label": "imageUrl", + "description": [ + "\nBase64 data URL for the user avatar image." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_profile.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserProfilesPopoverProps", + "type": "Interface", + "tags": [], + "label": "UserProfilesPopoverProps", + "description": [ + "\nProps of {@link UserProfilesPopover} component" + ], + "signature": [ + { + "pluginId": "@kbn/shared-ux-avatar-user-profile-components", + "scope": "common", + "docId": "kibKbnSharedUxAvatarUserProfileComponentsPluginApi", + "section": "def-common.UserProfilesPopoverProps", + "text": "UserProfilesPopoverProps" + }, + " extends ", + "EuiPopoverProps" + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_profiles_popover.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserProfilesPopoverProps.title", + "type": "CompoundType", + "tags": [ + "see" + ], + "label": "title", + "description": [ + "\nTitle of the popover" + ], + "signature": [ + "boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | null | undefined" + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_profiles_popover.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserProfilesPopoverProps.selectableProps", + "type": "Object", + "tags": [ + "see" + ], + "label": "selectableProps", + "description": [ + "\nProps forwarded to selectable component" + ], + "signature": [ + { + "pluginId": "@kbn/shared-ux-avatar-user-profile-components", + "scope": "common", + "docId": "kibKbnSharedUxAvatarUserProfileComponentsPluginApi", + "section": "def-common.UserProfilesSelectableProps", + "text": "UserProfilesSelectableProps" + } + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_profiles_popover.tsx", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserProfilesSelectableProps", + "type": "Interface", + "tags": [], + "label": "UserProfilesSelectableProps", + "description": [ + "\nProps of {@link UserProfilesSelectable} component" + ], + "signature": [ + { + "pluginId": "@kbn/shared-ux-avatar-user-profile-components", + "scope": "common", + "docId": "kibKbnSharedUxAvatarUserProfileComponentsPluginApi", + "section": "def-common.UserProfilesSelectableProps", + "text": "UserProfilesSelectableProps" + }, + " extends Pick<", + "EuiSelectableProps", + "<{}>, \"height\" | \"errorMessage\" | \"singleSelection\" | \"loadingMessage\" | \"noMatchesMessage\" | \"emptyMessage\">" + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_profiles_selectable.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserProfilesSelectableProps.defaultOptions", + "type": "Array", + "tags": [], + "label": "defaultOptions", + "description": [ + "\nList of users to be rendered as suggestions." + ], + "signature": [ + { + "pluginId": "@kbn/shared-ux-avatar-user-profile-components", + "scope": "common", + "docId": "kibKbnSharedUxAvatarUserProfileComponentsPluginApi", + "section": "def-common.UserProfileWithAvatar", + "text": "UserProfileWithAvatar" + }, + "[] | undefined" + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_profiles_selectable.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserProfilesSelectableProps.selectedOptions", + "type": "Array", + "tags": [], + "label": "selectedOptions", + "description": [ + "\nList of selected users." + ], + "signature": [ + { + "pluginId": "@kbn/shared-ux-avatar-user-profile-components", + "scope": "common", + "docId": "kibKbnSharedUxAvatarUserProfileComponentsPluginApi", + "section": "def-common.UserProfileWithAvatar", + "text": "UserProfileWithAvatar" + }, + "[] | undefined" + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_profiles_selectable.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserProfilesSelectableProps.options", + "type": "Array", + "tags": [], + "label": "options", + "description": [ + "\nList of users from search results. Should be updated based on the search term provided by `onSearchChange` callback." + ], + "signature": [ + { + "pluginId": "@kbn/shared-ux-avatar-user-profile-components", + "scope": "common", + "docId": "kibKbnSharedUxAvatarUserProfileComponentsPluginApi", + "section": "def-common.UserProfileWithAvatar", + "text": "UserProfileWithAvatar" + }, + "[] | undefined" + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_profiles_selectable.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserProfilesSelectableProps.onChange", + "type": "Function", + "tags": [], + "label": "onChange", + "description": [ + "\nPasses back the list of selected users." + ], + "signature": [ + "((options: ", + { + "pluginId": "@kbn/shared-ux-avatar-user-profile-components", + "scope": "common", + "docId": "kibKbnSharedUxAvatarUserProfileComponentsPluginApi", + "section": "def-common.UserProfileWithAvatar", + "text": "UserProfileWithAvatar" + }, + "[]) => void) | undefined" + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_profiles_selectable.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserProfilesSelectableProps.onChange.$1", + "type": "Array", + "tags": [], + "label": "options", + "description": [ + "List of selected users" + ], + "signature": [ + { + "pluginId": "@kbn/shared-ux-avatar-user-profile-components", + "scope": "common", + "docId": "kibKbnSharedUxAvatarUserProfileComponentsPluginApi", + "section": "def-common.UserProfileWithAvatar", + "text": "UserProfileWithAvatar" + }, + "[]" + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_profiles_selectable.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserProfilesSelectableProps.onSearchChange", + "type": "Function", + "tags": [], + "label": "onSearchChange", + "description": [ + "\nPasses back the search term." + ], + "signature": [ + "((searchTerm: string) => void) | undefined" + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_profiles_selectable.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserProfilesSelectableProps.onSearchChange.$1", + "type": "string", + "tags": [], + "label": "searchTerm", + "description": [ + "Search term" + ], + "signature": [ + "string" + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_profiles_selectable.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserProfilesSelectableProps.isLoading", + "type": "CompoundType", + "tags": [], + "label": "isLoading", + "description": [ + "\nLoading indicator for asynchronous search operations." + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_profiles_selectable.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserProfilesSelectableProps.searchPlaceholder", + "type": "string", + "tags": [], + "label": "searchPlaceholder", + "description": [ + "\nPlaceholder text for search box." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_profiles_selectable.tsx", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserProfilesSelectableProps.selectedStatusMessage", + "type": "Function", + "tags": [], + "label": "selectedStatusMessage", + "description": [ + "\nReturns text for selected status." + ], + "signature": [ + "((selectedCount: number) => React.ReactNode) | undefined" + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_profiles_selectable.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserProfilesSelectableProps.selectedStatusMessage.$1", + "type": "number", + "tags": [], + "label": "selectedCount", + "description": [ + "Number of selected users" + ], + "signature": [ + "number" + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_profiles_selectable.tsx", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserProfilesSelectableProps.clearButtonLabel", + "type": "CompoundType", + "tags": [], + "label": "clearButtonLabel", + "description": [ + "\nText for label of clear button." + ], + "signature": [ + "boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | null | undefined" + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_profiles_selectable.tsx", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserProfileUserInfo", + "type": "Interface", + "tags": [], + "label": "UserProfileUserInfo", + "description": [ + "\nBasic user information returned in user profile." + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_profile.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserProfileUserInfo.username", + "type": "string", + "tags": [], + "label": "username", + "description": [ + "\nUsername of the user." + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_profile.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserProfileUserInfo.email", + "type": "string", + "tags": [], + "label": "email", + "description": [ + "\nOptional email of the user." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_profile.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserProfileUserInfo.fullName", + "type": "string", + "tags": [], + "label": "fullName", + "description": [ + "\nOptional full name of the user." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_profile.ts", + "deprecated": false, + "trackAdoption": false + }, + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserProfileUserInfo.displayName", + "type": "string", + "tags": [], + "label": "displayName", + "description": [ + "\nOptional display name of the user." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_profile.ts", + "deprecated": false, + "trackAdoption": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/shared-ux-avatar-user-profile-components", + "id": "def-common.UserProfileWithAvatar", + "type": "Type", + "tags": [], + "label": "UserProfileWithAvatar", + "description": [ + "\nConvenience type for a {@link UserProfile} with avatar data" + ], + "signature": [ + { + "pluginId": "@kbn/shared-ux-avatar-user-profile-components", + "scope": "common", + "docId": "kibKbnSharedUxAvatarUserProfileComponentsPluginApi", + "section": "def-common.UserProfile", + "text": "UserProfile" + }, + "<{ avatar?: ", + { + "pluginId": "@kbn/shared-ux-avatar-user-profile-components", + "scope": "common", + "docId": "kibKbnSharedUxAvatarUserProfileComponentsPluginApi", + "section": "def-common.UserProfileAvatarData", + "text": "UserProfileAvatarData" + }, + " | undefined; }>" + ], + "path": "packages/shared-ux/avatar/user_profile/impl/user_avatar.tsx", + "deprecated": false, + "trackAdoption": false, + "initialIsOpen": false + } + ], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_shared_ux_avatar_user_profile_components.mdx b/api_docs/kbn_shared_ux_avatar_user_profile_components.mdx new file mode 100644 index 0000000000000..8032ad63fef85 --- /dev/null +++ b/api_docs/kbn_shared_ux_avatar_user_profile_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: kibKbnSharedUxAvatarUserProfileComponentsPluginApi +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: 2022-09-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'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 40 | 0 | 3 | 0 | + +## Common + +### Functions + + +### Interfaces + + +### Consts, variables and types + + 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 57ee3c5eaeeac..50578bc364b66 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: 2022-09-09 +date: 2022-09-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 823e9843677a0..453fd4a07cd2c 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: 2022-09-09 +date: 2022-09-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.devdocs.json b/api_docs/kbn_shared_ux_card_no_data.devdocs.json index ce63cea38e22e..a97e211368c5c 100644 --- a/api_docs/kbn_shared_ux_card_no_data.devdocs.json +++ b/api_docs/kbn_shared_ux_card_no_data.devdocs.json @@ -148,7 +148,7 @@ "signature": [ "Partial> & { button?: React.ReactNode; onClick?: React.MouseEventHandler | undefined; description?: React.ReactNode; category?: string | undefined; canAccessFleet?: boolean | undefined; }" + ", \"description\" | \"onClick\" | \"isDisabled\" | \"button\" | \"layout\">> & { button?: React.ReactNode; onClick?: React.MouseEventHandler | undefined; description?: React.ReactNode; category?: string | undefined; canAccessFleet?: boolean | undefined; }" ], "path": "node_modules/@kbn/shared-ux-card-no-data-types/index.d.ts", "deprecated": false, @@ -184,9 +184,9 @@ "\nProps for the `NoDataCard` sevice-connected component." ], "signature": [ - "{ children?: React.ReactNode; onError?: React.ReactEventHandler | undefined; hidden?: boolean | undefined; icon?: React.ReactElement<", + "{ children?: React.ReactNode; description?: React.ReactNode; category?: string | undefined; onError?: React.ReactEventHandler | undefined; hidden?: boolean | undefined; icon?: React.ReactElement<", "EuiIconProps", - ", string | React.JSXElementConstructor> | null | undefined; id?: string | undefined; image?: string | React.ReactElement> | undefined; className?: string | undefined; title?: boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | undefined; onChange?: React.FormEventHandler | undefined; onKeyDown?: React.KeyboardEventHandler | undefined; onClick?: React.MouseEventHandler | undefined; description?: React.ReactNode; security?: string | undefined; defaultValue?: string | number | readonly string[] | undefined; lang?: string | undefined; category?: string | undefined; defaultChecked?: boolean | undefined; suppressContentEditableWarning?: boolean | undefined; suppressHydrationWarning?: boolean | undefined; accessKey?: string | undefined; contentEditable?: \"inherit\" | Booleanish | undefined; contextMenu?: string | undefined; dir?: string | undefined; draggable?: Booleanish | undefined; placeholder?: string | undefined; slot?: string | undefined; spellCheck?: Booleanish | undefined; style?: React.CSSProperties | undefined; tabIndex?: number | undefined; translate?: \"no\" | \"yes\" | undefined; radioGroup?: string | undefined; role?: React.AriaRole | undefined; about?: string | undefined; datatype?: string | undefined; inlist?: any; prefix?: string | undefined; property?: string | undefined; resource?: string | undefined; typeof?: string | undefined; vocab?: string | undefined; autoCapitalize?: string | undefined; autoCorrect?: string | undefined; autoSave?: string | undefined; itemProp?: string | undefined; itemScope?: boolean | undefined; itemType?: string | undefined; itemID?: string | undefined; itemRef?: string | undefined; results?: number | undefined; unselectable?: \"on\" | \"off\" | undefined; inputMode?: \"none\" | \"email\" | \"search\" | \"text\" | \"tel\" | \"url\" | \"numeric\" | \"decimal\" | undefined; is?: string | undefined; 'aria-activedescendant'?: string | undefined; 'aria-atomic'?: Booleanish | undefined; 'aria-autocomplete'?: \"none\" | \"list\" | \"inline\" | \"both\" | undefined; 'aria-busy'?: Booleanish | undefined; 'aria-checked'?: boolean | \"mixed\" | \"false\" | \"true\" | undefined; 'aria-colcount'?: number | undefined; 'aria-colindex'?: number | undefined; 'aria-colspan'?: number | undefined; 'aria-controls'?: string | undefined; 'aria-current'?: boolean | \"date\" | \"location\" | \"time\" | \"page\" | \"false\" | \"true\" | \"step\" | undefined; 'aria-describedby'?: string | undefined; 'aria-details'?: string | undefined; 'aria-disabled'?: Booleanish | undefined; 'aria-dropeffect'?: \"none\" | \"copy\" | \"link\" | \"execute\" | \"move\" | \"popup\" | undefined; 'aria-errormessage'?: string | undefined; 'aria-expanded'?: Booleanish | undefined; 'aria-flowto'?: string | undefined; 'aria-grabbed'?: Booleanish | undefined; 'aria-haspopup'?: boolean | \"grid\" | \"menu\" | \"false\" | \"true\" | \"dialog\" | \"listbox\" | \"tree\" | undefined; 'aria-hidden'?: Booleanish | undefined; 'aria-invalid'?: boolean | \"false\" | \"true\" | \"grammar\" | \"spelling\" | undefined; 'aria-keyshortcuts'?: string | undefined; 'aria-label'?: string | undefined; 'aria-labelledby'?: string | undefined; 'aria-level'?: number | undefined; 'aria-live'?: \"off\" | \"assertive\" | \"polite\" | undefined; 'aria-modal'?: Booleanish | undefined; 'aria-multiline'?: Booleanish | undefined; 'aria-multiselectable'?: Booleanish | undefined; 'aria-orientation'?: \"horizontal\" | \"vertical\" | undefined; 'aria-owns'?: string | undefined; 'aria-placeholder'?: string | undefined; 'aria-posinset'?: number | undefined; 'aria-pressed'?: boolean | \"mixed\" | \"false\" | \"true\" | undefined; 'aria-readonly'?: Booleanish | undefined; 'aria-relevant'?: \"all\" | \"text\" | \"additions\" | \"additions removals\" | \"additions text\" | \"removals\" | \"removals additions\" | \"removals text\" | \"text additions\" | \"text removals\" | undefined; 'aria-required'?: Booleanish | undefined; 'aria-roledescription'?: string | undefined; 'aria-rowcount'?: number | undefined; 'aria-rowindex'?: number | undefined; 'aria-rowspan'?: number | undefined; 'aria-selected'?: Booleanish | undefined; 'aria-setsize'?: number | undefined; 'aria-sort'?: \"none\" | \"other\" | \"ascending\" | \"descending\" | undefined; 'aria-valuemax'?: number | undefined; 'aria-valuemin'?: number | undefined; 'aria-valuenow'?: number | undefined; 'aria-valuetext'?: string | undefined; dangerouslySetInnerHTML?: { __html: string; } | undefined; onCopy?: React.ClipboardEventHandler | undefined; onCopyCapture?: React.ClipboardEventHandler | undefined; onCut?: React.ClipboardEventHandler | undefined; onCutCapture?: React.ClipboardEventHandler | undefined; onPaste?: React.ClipboardEventHandler | undefined; onPasteCapture?: React.ClipboardEventHandler | undefined; onCompositionEnd?: React.CompositionEventHandler | undefined; onCompositionEndCapture?: React.CompositionEventHandler | undefined; onCompositionStart?: React.CompositionEventHandler | undefined; onCompositionStartCapture?: React.CompositionEventHandler | undefined; onCompositionUpdate?: React.CompositionEventHandler | undefined; onCompositionUpdateCapture?: React.CompositionEventHandler | undefined; onFocus?: React.FocusEventHandler | undefined; onFocusCapture?: React.FocusEventHandler | undefined; onBlur?: React.FocusEventHandler | undefined; onBlurCapture?: React.FocusEventHandler | undefined; onChangeCapture?: React.FormEventHandler | undefined; onBeforeInput?: React.FormEventHandler | undefined; onBeforeInputCapture?: React.FormEventHandler | undefined; onInput?: React.FormEventHandler | undefined; onInputCapture?: React.FormEventHandler | undefined; onReset?: React.FormEventHandler | undefined; onResetCapture?: React.FormEventHandler | undefined; onSubmit?: React.FormEventHandler | undefined; onSubmitCapture?: React.FormEventHandler | undefined; onInvalid?: React.FormEventHandler | undefined; onInvalidCapture?: React.FormEventHandler | undefined; onLoad?: React.ReactEventHandler | undefined; onLoadCapture?: React.ReactEventHandler | undefined; onErrorCapture?: React.ReactEventHandler | undefined; onKeyDownCapture?: React.KeyboardEventHandler | undefined; onKeyPress?: React.KeyboardEventHandler | undefined; onKeyPressCapture?: React.KeyboardEventHandler | undefined; onKeyUp?: React.KeyboardEventHandler | undefined; onKeyUpCapture?: React.KeyboardEventHandler | undefined; onAbort?: React.ReactEventHandler | undefined; onAbortCapture?: React.ReactEventHandler | undefined; onCanPlay?: React.ReactEventHandler | undefined; onCanPlayCapture?: React.ReactEventHandler | undefined; onCanPlayThrough?: React.ReactEventHandler | undefined; onCanPlayThroughCapture?: React.ReactEventHandler | undefined; onDurationChange?: React.ReactEventHandler | undefined; onDurationChangeCapture?: React.ReactEventHandler | undefined; onEmptied?: React.ReactEventHandler | undefined; onEmptiedCapture?: React.ReactEventHandler | undefined; onEncrypted?: React.ReactEventHandler | undefined; onEncryptedCapture?: React.ReactEventHandler | undefined; onEnded?: React.ReactEventHandler | undefined; onEndedCapture?: React.ReactEventHandler | undefined; onLoadedData?: React.ReactEventHandler | undefined; onLoadedDataCapture?: React.ReactEventHandler | undefined; onLoadedMetadata?: React.ReactEventHandler | undefined; onLoadedMetadataCapture?: React.ReactEventHandler | undefined; onLoadStart?: React.ReactEventHandler | undefined; onLoadStartCapture?: React.ReactEventHandler | undefined; onPause?: React.ReactEventHandler | undefined; onPauseCapture?: React.ReactEventHandler | undefined; onPlay?: React.ReactEventHandler | undefined; onPlayCapture?: React.ReactEventHandler | undefined; onPlaying?: React.ReactEventHandler | undefined; onPlayingCapture?: React.ReactEventHandler | undefined; onProgress?: React.ReactEventHandler | undefined; onProgressCapture?: React.ReactEventHandler | undefined; onRateChange?: React.ReactEventHandler | undefined; onRateChangeCapture?: React.ReactEventHandler | undefined; onSeeked?: React.ReactEventHandler | undefined; onSeekedCapture?: React.ReactEventHandler | undefined; onSeeking?: React.ReactEventHandler | undefined; onSeekingCapture?: React.ReactEventHandler | undefined; onStalled?: React.ReactEventHandler | undefined; onStalledCapture?: React.ReactEventHandler | undefined; onSuspend?: React.ReactEventHandler | undefined; onSuspendCapture?: React.ReactEventHandler | undefined; onTimeUpdate?: React.ReactEventHandler | undefined; onTimeUpdateCapture?: React.ReactEventHandler | undefined; onVolumeChange?: React.ReactEventHandler | undefined; onVolumeChangeCapture?: React.ReactEventHandler | undefined; onWaiting?: React.ReactEventHandler | undefined; onWaitingCapture?: React.ReactEventHandler | undefined; onAuxClick?: React.MouseEventHandler | undefined; onAuxClickCapture?: React.MouseEventHandler | undefined; onClickCapture?: React.MouseEventHandler | undefined; onContextMenu?: React.MouseEventHandler | undefined; onContextMenuCapture?: React.MouseEventHandler | undefined; onDoubleClick?: React.MouseEventHandler | undefined; onDoubleClickCapture?: React.MouseEventHandler | undefined; onDrag?: React.DragEventHandler | undefined; onDragCapture?: React.DragEventHandler | undefined; onDragEnd?: React.DragEventHandler | undefined; onDragEndCapture?: React.DragEventHandler | undefined; onDragEnter?: React.DragEventHandler | undefined; onDragEnterCapture?: React.DragEventHandler | undefined; onDragExit?: React.DragEventHandler | undefined; onDragExitCapture?: React.DragEventHandler | undefined; onDragLeave?: React.DragEventHandler | undefined; onDragLeaveCapture?: React.DragEventHandler | undefined; onDragOver?: React.DragEventHandler | undefined; onDragOverCapture?: React.DragEventHandler | undefined; onDragStart?: React.DragEventHandler | undefined; onDragStartCapture?: React.DragEventHandler | undefined; onDrop?: React.DragEventHandler | undefined; onDropCapture?: React.DragEventHandler | undefined; onMouseDown?: React.MouseEventHandler | undefined; onMouseDownCapture?: React.MouseEventHandler | undefined; onMouseEnter?: React.MouseEventHandler | undefined; onMouseLeave?: React.MouseEventHandler | undefined; onMouseMove?: React.MouseEventHandler | undefined; onMouseMoveCapture?: React.MouseEventHandler | undefined; onMouseOut?: React.MouseEventHandler | undefined; onMouseOutCapture?: React.MouseEventHandler | undefined; onMouseOver?: React.MouseEventHandler | undefined; onMouseOverCapture?: React.MouseEventHandler | undefined; onMouseUp?: React.MouseEventHandler | undefined; onMouseUpCapture?: React.MouseEventHandler | undefined; onSelect?: React.ReactEventHandler | undefined; onSelectCapture?: React.ReactEventHandler | undefined; onTouchCancel?: React.TouchEventHandler | undefined; onTouchCancelCapture?: React.TouchEventHandler | undefined; onTouchEnd?: React.TouchEventHandler | undefined; onTouchEndCapture?: React.TouchEventHandler | undefined; onTouchMove?: React.TouchEventHandler | undefined; onTouchMoveCapture?: React.TouchEventHandler | undefined; onTouchStart?: React.TouchEventHandler | undefined; onTouchStartCapture?: React.TouchEventHandler | undefined; onPointerDown?: React.PointerEventHandler | undefined; onPointerDownCapture?: React.PointerEventHandler | undefined; onPointerMove?: React.PointerEventHandler | undefined; onPointerMoveCapture?: React.PointerEventHandler | undefined; onPointerUp?: React.PointerEventHandler | undefined; onPointerUpCapture?: React.PointerEventHandler | undefined; onPointerCancel?: React.PointerEventHandler | undefined; onPointerCancelCapture?: React.PointerEventHandler | undefined; onPointerEnter?: React.PointerEventHandler | undefined; onPointerEnterCapture?: React.PointerEventHandler | undefined; onPointerLeave?: React.PointerEventHandler | undefined; onPointerLeaveCapture?: React.PointerEventHandler | undefined; onPointerOver?: React.PointerEventHandler | undefined; onPointerOverCapture?: React.PointerEventHandler | undefined; onPointerOut?: React.PointerEventHandler | undefined; onPointerOutCapture?: React.PointerEventHandler | undefined; onGotPointerCapture?: React.PointerEventHandler | undefined; onGotPointerCaptureCapture?: React.PointerEventHandler | undefined; onLostPointerCapture?: React.PointerEventHandler | undefined; onLostPointerCaptureCapture?: React.PointerEventHandler | undefined; onScroll?: React.UIEventHandler | undefined; onScrollCapture?: React.UIEventHandler | undefined; onWheel?: React.WheelEventHandler | undefined; onWheelCapture?: React.WheelEventHandler | undefined; onAnimationStart?: React.AnimationEventHandler | undefined; onAnimationStartCapture?: React.AnimationEventHandler | undefined; onAnimationEnd?: React.AnimationEventHandler | undefined; onAnimationEndCapture?: React.AnimationEventHandler | undefined; onAnimationIteration?: React.AnimationEventHandler | undefined; onAnimationIterationCapture?: React.AnimationEventHandler | undefined; onTransitionEnd?: React.TransitionEventHandler | undefined; onTransitionEndCapture?: React.TransitionEventHandler | undefined; 'data-test-subj'?: string | undefined; href?: string | undefined; rel?: string | undefined; target?: string | undefined; paddingSize?: \"none\" | \"m\" | \"s\" | \"xs\" | \"l\" | \"xl\" | undefined; button?: React.ReactNode; footer?: React.ReactNode; hasBorder?: boolean | undefined; textAlign?: CardAlignment | undefined; titleElement?: \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"span\" | undefined; titleSize?: \"s\" | \"xs\" | undefined; betaBadgeProps?: Partial<(", + ", string | React.JSXElementConstructor> | null | undefined; id?: string | undefined; image?: string | React.ReactElement> | undefined; className?: string | undefined; title?: boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | undefined; onChange?: React.FormEventHandler | undefined; onKeyDown?: React.KeyboardEventHandler | undefined; onClick?: React.MouseEventHandler | undefined; security?: string | undefined; defaultValue?: string | number | readonly string[] | undefined; lang?: string | undefined; defaultChecked?: boolean | undefined; suppressContentEditableWarning?: boolean | undefined; suppressHydrationWarning?: boolean | undefined; accessKey?: string | undefined; contentEditable?: \"inherit\" | Booleanish | undefined; contextMenu?: string | undefined; dir?: string | undefined; draggable?: Booleanish | undefined; placeholder?: string | undefined; slot?: string | undefined; spellCheck?: Booleanish | undefined; style?: React.CSSProperties | undefined; tabIndex?: number | undefined; translate?: \"no\" | \"yes\" | undefined; radioGroup?: string | undefined; role?: React.AriaRole | undefined; about?: string | undefined; datatype?: string | undefined; inlist?: any; prefix?: string | undefined; property?: string | undefined; resource?: string | undefined; typeof?: string | undefined; vocab?: string | undefined; autoCapitalize?: string | undefined; autoCorrect?: string | undefined; autoSave?: string | undefined; itemProp?: string | undefined; itemScope?: boolean | undefined; itemType?: string | undefined; itemID?: string | undefined; itemRef?: string | undefined; results?: number | undefined; unselectable?: \"on\" | \"off\" | undefined; inputMode?: \"none\" | \"email\" | \"search\" | \"text\" | \"tel\" | \"url\" | \"numeric\" | \"decimal\" | undefined; is?: string | undefined; 'aria-activedescendant'?: string | undefined; 'aria-atomic'?: Booleanish | undefined; 'aria-autocomplete'?: \"none\" | \"list\" | \"inline\" | \"both\" | undefined; 'aria-busy'?: Booleanish | undefined; 'aria-checked'?: boolean | \"mixed\" | \"false\" | \"true\" | undefined; 'aria-colcount'?: number | undefined; 'aria-colindex'?: number | undefined; 'aria-colspan'?: number | undefined; 'aria-controls'?: string | undefined; 'aria-current'?: boolean | \"date\" | \"location\" | \"time\" | \"page\" | \"false\" | \"true\" | \"step\" | undefined; 'aria-describedby'?: string | undefined; 'aria-details'?: string | undefined; 'aria-disabled'?: Booleanish | undefined; 'aria-dropeffect'?: \"none\" | \"copy\" | \"link\" | \"execute\" | \"move\" | \"popup\" | undefined; 'aria-errormessage'?: string | undefined; 'aria-expanded'?: Booleanish | undefined; 'aria-flowto'?: string | undefined; 'aria-grabbed'?: Booleanish | undefined; 'aria-haspopup'?: boolean | \"grid\" | \"menu\" | \"false\" | \"true\" | \"dialog\" | \"listbox\" | \"tree\" | undefined; 'aria-hidden'?: Booleanish | undefined; 'aria-invalid'?: boolean | \"false\" | \"true\" | \"grammar\" | \"spelling\" | undefined; 'aria-keyshortcuts'?: string | undefined; 'aria-label'?: string | undefined; 'aria-labelledby'?: string | undefined; 'aria-level'?: number | undefined; 'aria-live'?: \"off\" | \"assertive\" | \"polite\" | undefined; 'aria-modal'?: Booleanish | undefined; 'aria-multiline'?: Booleanish | undefined; 'aria-multiselectable'?: Booleanish | undefined; 'aria-orientation'?: \"horizontal\" | \"vertical\" | undefined; 'aria-owns'?: string | undefined; 'aria-placeholder'?: string | undefined; 'aria-posinset'?: number | undefined; 'aria-pressed'?: boolean | \"mixed\" | \"false\" | \"true\" | undefined; 'aria-readonly'?: Booleanish | undefined; 'aria-relevant'?: \"all\" | \"text\" | \"additions\" | \"additions removals\" | \"additions text\" | \"removals\" | \"removals additions\" | \"removals text\" | \"text additions\" | \"text removals\" | undefined; 'aria-required'?: Booleanish | undefined; 'aria-roledescription'?: string | undefined; 'aria-rowcount'?: number | undefined; 'aria-rowindex'?: number | undefined; 'aria-rowspan'?: number | undefined; 'aria-selected'?: Booleanish | undefined; 'aria-setsize'?: number | undefined; 'aria-sort'?: \"none\" | \"other\" | \"ascending\" | \"descending\" | undefined; 'aria-valuemax'?: number | undefined; 'aria-valuemin'?: number | undefined; 'aria-valuenow'?: number | undefined; 'aria-valuetext'?: string | undefined; dangerouslySetInnerHTML?: { __html: string; } | undefined; onCopy?: React.ClipboardEventHandler | undefined; onCopyCapture?: React.ClipboardEventHandler | undefined; onCut?: React.ClipboardEventHandler | undefined; onCutCapture?: React.ClipboardEventHandler | undefined; onPaste?: React.ClipboardEventHandler | undefined; onPasteCapture?: React.ClipboardEventHandler | undefined; onCompositionEnd?: React.CompositionEventHandler | undefined; onCompositionEndCapture?: React.CompositionEventHandler | undefined; onCompositionStart?: React.CompositionEventHandler | undefined; onCompositionStartCapture?: React.CompositionEventHandler | undefined; onCompositionUpdate?: React.CompositionEventHandler | undefined; onCompositionUpdateCapture?: React.CompositionEventHandler | undefined; onFocus?: React.FocusEventHandler | undefined; onFocusCapture?: React.FocusEventHandler | undefined; onBlur?: React.FocusEventHandler | undefined; onBlurCapture?: React.FocusEventHandler | undefined; onChangeCapture?: React.FormEventHandler | undefined; onBeforeInput?: React.FormEventHandler | undefined; onBeforeInputCapture?: React.FormEventHandler | undefined; onInput?: React.FormEventHandler | undefined; onInputCapture?: React.FormEventHandler | undefined; onReset?: React.FormEventHandler | undefined; onResetCapture?: React.FormEventHandler | undefined; onSubmit?: React.FormEventHandler | undefined; onSubmitCapture?: React.FormEventHandler | undefined; onInvalid?: React.FormEventHandler | undefined; onInvalidCapture?: React.FormEventHandler | undefined; onLoad?: React.ReactEventHandler | undefined; onLoadCapture?: React.ReactEventHandler | undefined; onErrorCapture?: React.ReactEventHandler | undefined; onKeyDownCapture?: React.KeyboardEventHandler | undefined; onKeyPress?: React.KeyboardEventHandler | undefined; onKeyPressCapture?: React.KeyboardEventHandler | undefined; onKeyUp?: React.KeyboardEventHandler | undefined; onKeyUpCapture?: React.KeyboardEventHandler | undefined; onAbort?: React.ReactEventHandler | undefined; onAbortCapture?: React.ReactEventHandler | undefined; onCanPlay?: React.ReactEventHandler | undefined; onCanPlayCapture?: React.ReactEventHandler | undefined; onCanPlayThrough?: React.ReactEventHandler | undefined; onCanPlayThroughCapture?: React.ReactEventHandler | undefined; onDurationChange?: React.ReactEventHandler | undefined; onDurationChangeCapture?: React.ReactEventHandler | undefined; onEmptied?: React.ReactEventHandler | undefined; onEmptiedCapture?: React.ReactEventHandler | undefined; onEncrypted?: React.ReactEventHandler | undefined; onEncryptedCapture?: React.ReactEventHandler | undefined; onEnded?: React.ReactEventHandler | undefined; onEndedCapture?: React.ReactEventHandler | undefined; onLoadedData?: React.ReactEventHandler | undefined; onLoadedDataCapture?: React.ReactEventHandler | undefined; onLoadedMetadata?: React.ReactEventHandler | undefined; onLoadedMetadataCapture?: React.ReactEventHandler | undefined; onLoadStart?: React.ReactEventHandler | undefined; onLoadStartCapture?: React.ReactEventHandler | undefined; onPause?: React.ReactEventHandler | undefined; onPauseCapture?: React.ReactEventHandler | undefined; onPlay?: React.ReactEventHandler | undefined; onPlayCapture?: React.ReactEventHandler | undefined; onPlaying?: React.ReactEventHandler | undefined; onPlayingCapture?: React.ReactEventHandler | undefined; onProgress?: React.ReactEventHandler | undefined; onProgressCapture?: React.ReactEventHandler | undefined; onRateChange?: React.ReactEventHandler | undefined; onRateChangeCapture?: React.ReactEventHandler | undefined; onSeeked?: React.ReactEventHandler | undefined; onSeekedCapture?: React.ReactEventHandler | undefined; onSeeking?: React.ReactEventHandler | undefined; onSeekingCapture?: React.ReactEventHandler | undefined; onStalled?: React.ReactEventHandler | undefined; onStalledCapture?: React.ReactEventHandler | undefined; onSuspend?: React.ReactEventHandler | undefined; onSuspendCapture?: React.ReactEventHandler | undefined; onTimeUpdate?: React.ReactEventHandler | undefined; onTimeUpdateCapture?: React.ReactEventHandler | undefined; onVolumeChange?: React.ReactEventHandler | undefined; onVolumeChangeCapture?: React.ReactEventHandler | undefined; onWaiting?: React.ReactEventHandler | undefined; onWaitingCapture?: React.ReactEventHandler | undefined; onAuxClick?: React.MouseEventHandler | undefined; onAuxClickCapture?: React.MouseEventHandler | undefined; onClickCapture?: React.MouseEventHandler | undefined; onContextMenu?: React.MouseEventHandler | undefined; onContextMenuCapture?: React.MouseEventHandler | undefined; onDoubleClick?: React.MouseEventHandler | undefined; onDoubleClickCapture?: React.MouseEventHandler | undefined; onDrag?: React.DragEventHandler | undefined; onDragCapture?: React.DragEventHandler | undefined; onDragEnd?: React.DragEventHandler | undefined; onDragEndCapture?: React.DragEventHandler | undefined; onDragEnter?: React.DragEventHandler | undefined; onDragEnterCapture?: React.DragEventHandler | undefined; onDragExit?: React.DragEventHandler | undefined; onDragExitCapture?: React.DragEventHandler | undefined; onDragLeave?: React.DragEventHandler | undefined; onDragLeaveCapture?: React.DragEventHandler | undefined; onDragOver?: React.DragEventHandler | undefined; onDragOverCapture?: React.DragEventHandler | undefined; onDragStart?: React.DragEventHandler | undefined; onDragStartCapture?: React.DragEventHandler | undefined; onDrop?: React.DragEventHandler | undefined; onDropCapture?: React.DragEventHandler | undefined; onMouseDown?: React.MouseEventHandler | undefined; onMouseDownCapture?: React.MouseEventHandler | undefined; onMouseEnter?: React.MouseEventHandler | undefined; onMouseLeave?: React.MouseEventHandler | undefined; onMouseMove?: React.MouseEventHandler | undefined; onMouseMoveCapture?: React.MouseEventHandler | undefined; onMouseOut?: React.MouseEventHandler | undefined; onMouseOutCapture?: React.MouseEventHandler | undefined; onMouseOver?: React.MouseEventHandler | undefined; onMouseOverCapture?: React.MouseEventHandler | undefined; onMouseUp?: React.MouseEventHandler | undefined; onMouseUpCapture?: React.MouseEventHandler | undefined; onSelect?: React.ReactEventHandler | undefined; onSelectCapture?: React.ReactEventHandler | undefined; onTouchCancel?: React.TouchEventHandler | undefined; onTouchCancelCapture?: React.TouchEventHandler | undefined; onTouchEnd?: React.TouchEventHandler | undefined; onTouchEndCapture?: React.TouchEventHandler | undefined; onTouchMove?: React.TouchEventHandler | undefined; onTouchMoveCapture?: React.TouchEventHandler | undefined; onTouchStart?: React.TouchEventHandler | undefined; onTouchStartCapture?: React.TouchEventHandler | undefined; onPointerDown?: React.PointerEventHandler | undefined; onPointerDownCapture?: React.PointerEventHandler | undefined; onPointerMove?: React.PointerEventHandler | undefined; onPointerMoveCapture?: React.PointerEventHandler | undefined; onPointerUp?: React.PointerEventHandler | undefined; onPointerUpCapture?: React.PointerEventHandler | undefined; onPointerCancel?: React.PointerEventHandler | undefined; onPointerCancelCapture?: React.PointerEventHandler | undefined; onPointerEnter?: React.PointerEventHandler | undefined; onPointerEnterCapture?: React.PointerEventHandler | undefined; onPointerLeave?: React.PointerEventHandler | undefined; onPointerLeaveCapture?: React.PointerEventHandler | undefined; onPointerOver?: React.PointerEventHandler | undefined; onPointerOverCapture?: React.PointerEventHandler | undefined; onPointerOut?: React.PointerEventHandler | undefined; onPointerOutCapture?: React.PointerEventHandler | undefined; onGotPointerCapture?: React.PointerEventHandler | undefined; onGotPointerCaptureCapture?: React.PointerEventHandler | undefined; onLostPointerCapture?: React.PointerEventHandler | undefined; onLostPointerCaptureCapture?: React.PointerEventHandler | undefined; onScroll?: React.UIEventHandler | undefined; onScrollCapture?: React.UIEventHandler | undefined; onWheel?: React.WheelEventHandler | undefined; onWheelCapture?: React.WheelEventHandler | undefined; onAnimationStart?: React.AnimationEventHandler | undefined; onAnimationStartCapture?: React.AnimationEventHandler | undefined; onAnimationEnd?: React.AnimationEventHandler | undefined; onAnimationEndCapture?: React.AnimationEventHandler | undefined; onAnimationIteration?: React.AnimationEventHandler | undefined; onAnimationIterationCapture?: React.AnimationEventHandler | undefined; onTransitionEnd?: React.TransitionEventHandler | undefined; onTransitionEndCapture?: React.TransitionEventHandler | undefined; 'data-test-subj'?: string | undefined; href?: string | undefined; rel?: string | undefined; target?: string | undefined; paddingSize?: \"none\" | \"m\" | \"s\" | \"xs\" | \"l\" | \"xl\" | undefined; button?: React.ReactNode; footer?: React.ReactNode; hasBorder?: boolean | undefined; textAlign?: CardAlignment | undefined; titleElement?: \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"span\" | undefined; titleSize?: \"s\" | \"xs\" | undefined; betaBadgeProps?: Partial<(", "CommonProps", " & ", "DisambiguateSet", diff --git a/api_docs/kbn_shared_ux_card_no_data.mdx b/api_docs/kbn_shared_ux_card_no_data.mdx index 27455c0dcff20..8f8e2cb2d0840 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: 2022-09-09 +date: 2022-09-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.devdocs.json b/api_docs/kbn_shared_ux_card_no_data_mocks.devdocs.json index bbd3d2f518bff..c83e2d8f0e1aa 100644 --- a/api_docs/kbn_shared_ux_card_no_data_mocks.devdocs.json +++ b/api_docs/kbn_shared_ux_card_no_data_mocks.devdocs.json @@ -509,7 +509,7 @@ "\nStorybook parameters provided from the controls addon." ], "signature": [ - "{ title: any; description: any; category: any; button: any; canAccessFleet: any; }" + "{ description: any; category: any; title: any; button: any; canAccessFleet: any; }" ], "path": "packages/shared-ux/card/no_data/mocks/src/storybook.ts", "deprecated": false, 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 30e9422c7d0dc..6b5cf577d2f23 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: 2022-09-09 +date: 2022-09-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_link_redirect_app_mocks.mdx b/api_docs/kbn_shared_ux_link_redirect_app_mocks.mdx index d382db6b06181..ad46fe9c6337f 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: 2022-09-09 +date: 2022-09-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_page_analytics_no_data.mdx b/api_docs/kbn_shared_ux_page_analytics_no_data.mdx index f719f64919ffe..650f6b6de6657 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: 2022-09-09 +date: 2022-09-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 6c98183d2a7ff..c526e3b3d7f6d 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: 2022-09-09 +date: 2022-09-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 e96fd6b65b797..620084197a3fc 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: 2022-09-09 +date: 2022-09-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 f082939bf23db..53fe5c2b52348 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: 2022-09-09 +date: 2022-09-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 56d513e6b2395..1cc01f097e1f5 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: 2022-09-09 +date: 2022-09-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 f2aa470f834cc..294ae75484592 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: 2022-09-09 +date: 2022-09-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 003b096cfd0f9..e228084b30143 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: 2022-09-09 +date: 2022-09-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 8b61bc3b8fb03..02191cc87e73d 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: 2022-09-09 +date: 2022-09-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 9b0e41366e492..aa10464a8a61e 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: 2022-09-09 +date: 2022-09-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 673f7aa80d418..0ac409eb1f626 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: 2022-09-09 +date: 2022-09-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 fca609edd1eec..113d794aeac30 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: 2022-09-09 +date: 2022-09-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 d55f975104ffa..784d4bbb54fd0 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: 2022-09-09 +date: 2022-09-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 370bb3fb7b081..5097f00e1394f 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: 2022-09-09 +date: 2022-09-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_router.devdocs.json b/api_docs/kbn_shared_ux_router.devdocs.json new file mode 100644 index 0000000000000..b3381733e9f8f --- /dev/null +++ b/api_docs/kbn_shared_ux_router.devdocs.json @@ -0,0 +1,65 @@ +{ + "id": "@kbn/shared-ux-router", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/shared-ux-router", + "id": "def-common.Route", + "type": "Function", + "tags": [], + "label": "Route", + "description": [ + "\nThis is a wrapper around the react-router-dom Route component that inserts\nMatchPropagator in every application route. It helps track all route changes\nand send them to the execution context, later used to enrich APM\n'route-change' transactions." + ], + "signature": [ + "({ children, component: Component, render, ...rest }: ", + "RouteProps", + ") => JSX.Element" + ], + "path": "packages/shared-ux/router/impl/router.tsx", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-router", + "id": "def-common.Route.$1", + "type": "Object", + "tags": [], + "label": "{ children, component: Component, render, ...rest }", + "description": [], + "signature": [ + "RouteProps" + ], + "path": "packages/shared-ux/router/impl/router.tsx", + "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_shared_ux_router.mdx b/api_docs/kbn_shared_ux_router.mdx new file mode 100644 index 0000000000000..576f834d1cf4e --- /dev/null +++ b/api_docs/kbn_shared_ux_router.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: kibKbnSharedUxRouterPluginApi +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: 2022-09-20 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-router'] +--- +import kbnSharedUxRouterObj from './kbn_shared_ux_router.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 2 | 0 | 1 | 0 | + +## Common + +### Functions + + diff --git a/api_docs/kbn_shared_ux_router_mocks.devdocs.json b/api_docs/kbn_shared_ux_router_mocks.devdocs.json new file mode 100644 index 0000000000000..db66a62441697 --- /dev/null +++ b/api_docs/kbn_shared_ux_router_mocks.devdocs.json @@ -0,0 +1,45 @@ +{ + "id": "@kbn/shared-ux-router-mocks", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/shared-ux-router-mocks", + "id": "def-common.foo", + "type": "Function", + "tags": [], + "label": "foo", + "description": [], + "signature": [ + "() => string" + ], + "path": "packages/shared-ux/router/mocks/index.ts", + "deprecated": false, + "trackAdoption": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_shared_ux_router_mocks.mdx b/api_docs/kbn_shared_ux_router_mocks.mdx new file mode 100644 index 0000000000000..75a3bdd71f467 --- /dev/null +++ b/api_docs/kbn_shared_ux_router_mocks.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: kibKbnSharedUxRouterMocksPluginApi +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: 2022-09-20 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-router-mocks'] +--- +import kbnSharedUxRouterMocksObj from './kbn_shared_ux_router_mocks.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 1 | 0 | 1 | 0 | + +## Common + +### Functions + + diff --git a/api_docs/kbn_shared_ux_storybook_config.mdx b/api_docs/kbn_shared_ux_storybook_config.mdx index 9200b11a09b21..9fc0023c3105f 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: 2022-09-09 +date: 2022-09-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 d281f952bbbdf..6e659b6749e9b 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: 2022-09-09 +date: 2022-09-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 ce6cfca9bcf5c..ae651ff396bb2 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: 2022-09-09 +date: 2022-09-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_some_dev_log.mdx b/api_docs/kbn_some_dev_log.mdx index ef9f4272e5ae1..a5bf07dccef17 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: 2022-09-09 +date: 2022-09-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_sort_package_json.mdx b/api_docs/kbn_sort_package_json.mdx index 5e5cd15a35874..bec95f5dd0edf 100644 --- a/api_docs/kbn_sort_package_json.mdx +++ b/api_docs/kbn_sort_package_json.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-sort-package-json title: "@kbn/sort-package-json" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/sort-package-json plugin -date: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/sort-package-json'] --- import kbnSortPackageJsonObj from './kbn_sort_package_json.devdocs.json'; diff --git a/api_docs/kbn_std.mdx b/api_docs/kbn_std.mdx index f09537bfe88ae..15d38db3ce3f8 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: 2022-09-09 +date: 2022-09-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 9bd71879017ce..286713890035f 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: 2022-09-09 +date: 2022-09-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 9a002696753d0..6dcb31e2935ba 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: 2022-09-09 +date: 2022-09-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 5b0eba5853c13..f55b78a57dd13 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/telemetry-tools'] --- import kbnTelemetryToolsObj from './kbn_telemetry_tools.devdocs.json'; diff --git a/api_docs/kbn_test.devdocs.json b/api_docs/kbn_test.devdocs.json index 3a4cf723d0775..f36daceb7cab2 100644 --- a/api_docs/kbn_test.devdocs.json +++ b/api_docs/kbn_test.devdocs.json @@ -2669,6 +2669,20 @@ "deprecated": false, "trackAdoption": false }, + { + "parentPluginId": "@kbn/test", + "id": "def-server.CreateTestEsClusterOptions.writeLogsToPath", + "type": "string", + "tags": [], + "label": "writeLogsToPath", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/kbn-test/src/es/test_es_cluster.ts", + "deprecated": false, + "trackAdoption": false + }, { "parentPluginId": "@kbn/test", "id": "def-server.CreateTestEsClusterOptions.nodes", diff --git a/api_docs/kbn_test.mdx b/api_docs/kbn_test.mdx index 2b1cfb4d5c2fe..368a220dbf198 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/test'] --- import kbnTestObj from './kbn_test.devdocs.json'; @@ -21,7 +21,7 @@ Contact Operations for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 253 | 5 | 212 | 11 | +| 254 | 5 | 213 | 11 | ## Server diff --git a/api_docs/kbn_test_jest_helpers.devdocs.json b/api_docs/kbn_test_jest_helpers.devdocs.json index 736336420aeec..92e70ef0a7443 100644 --- a/api_docs/kbn_test_jest_helpers.devdocs.json +++ b/api_docs/kbn_test_jest_helpers.devdocs.json @@ -874,7 +874,7 @@ "section": "def-server.AsyncSetupFunc", "text": "AsyncSetupFunc" }, - "" + ">" ], "path": "packages/kbn-test-jest-helpers/src/testbed/testbed.ts", "deprecated": false, @@ -951,7 +951,7 @@ "section": "def-server.SyncSetupFunc", "text": "SyncSetupFunc" }, - "" + ">" ], "path": "packages/kbn-test-jest-helpers/src/testbed/testbed.ts", "deprecated": false, @@ -1033,7 +1033,7 @@ "section": "def-server.SetupFunc", "text": "SetupFunc" }, - "" + ">" ], "path": "packages/kbn-test-jest-helpers/src/testbed/testbed.ts", "deprecated": false, @@ -2060,7 +2060,7 @@ "label": "AsyncSetupFunc", "description": [], "signature": [ - "(props?: any) => Promise<", + "(props?: P | undefined) => Promise<", { "pluginId": "@kbn/test-jest-helpers", "scope": "server", @@ -2078,12 +2078,12 @@ { "parentPluginId": "@kbn/test-jest-helpers", "id": "def-server.AsyncSetupFunc.$1", - "type": "Any", + "type": "Uncategorized", "tags": [], "label": "props", "description": [], "signature": [ - "any" + "P | undefined" ], "path": "packages/kbn-test-jest-helpers/src/testbed/types.ts", "deprecated": false, @@ -2100,7 +2100,7 @@ "label": "SetupFunc", "description": [], "signature": [ - "(props?: any) => ", + "(props?: P | undefined) => ", { "pluginId": "@kbn/test-jest-helpers", "scope": "server", @@ -2126,12 +2126,12 @@ { "parentPluginId": "@kbn/test-jest-helpers", "id": "def-server.SetupFunc.$1", - "type": "Any", + "type": "Uncategorized", "tags": [], "label": "props", "description": [], "signature": [ - "any" + "P | undefined" ], "path": "packages/kbn-test-jest-helpers/src/testbed/types.ts", "deprecated": false, @@ -2148,7 +2148,7 @@ "label": "SyncSetupFunc", "description": [], "signature": [ - "(props?: any) => ", + "(props?: P | undefined) => ", { "pluginId": "@kbn/test-jest-helpers", "scope": "server", @@ -2166,12 +2166,12 @@ { "parentPluginId": "@kbn/test-jest-helpers", "id": "def-server.SyncSetupFunc.$1", - "type": "Any", + "type": "Uncategorized", "tags": [], "label": "props", "description": [], "signature": [ - "any" + "P | undefined" ], "path": "packages/kbn-test-jest-helpers/src/testbed/types.ts", "deprecated": false, diff --git a/api_docs/kbn_test_jest_helpers.mdx b/api_docs/kbn_test_jest_helpers.mdx index 20c4a3eb4f9ba..a9bab53131ebc 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/test-jest-helpers'] --- import kbnTestJestHelpersObj from './kbn_test_jest_helpers.devdocs.json'; @@ -21,7 +21,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 135 | 8 | 103 | 2 | +| 135 | 5 | 103 | 2 | ## Server diff --git a/api_docs/kbn_test_subj_selector.devdocs.json b/api_docs/kbn_test_subj_selector.devdocs.json new file mode 100644 index 0000000000000..78c6606408451 --- /dev/null +++ b/api_docs/kbn_test_subj_selector.devdocs.json @@ -0,0 +1,63 @@ +{ + "id": "@kbn/test-subj-selector", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/test-subj-selector", + "id": "def-server.subj", + "type": "Function", + "tags": [], + "label": "subj", + "description": [ + "\nConverts a testSubject selector into a CSS selector.\n\ntestSubject selector syntax rules:\n\n - `data-test-subj` values can include spaces\n\n - prefixing a value with `~` will allow matching a single word in a `data-test-subj` that uses several space delimited list words\n - example: `~foo`\n - css equivalent: `[data-test-subj~=\"foo\"]`\n\n - the `>` character is used between two values to indicate that the value on the right must match an element inside an element matched by the value on the left\n - example: `foo > bar`\n - css equivalent: `[data-test-subj=foo] [data-test-subj=bar]`\n\n - the `&` character is used between two values to indicate that the value on both sides must both match the element\n - example: `foo & bar`\n - css equivalent: `[data-test-subj=foo][data-test-subj=bar]`" + ], + "signature": [ + "(selector: string) => string" + ], + "path": "packages/kbn-test-subj-selector/test_subj_selector.ts", + "deprecated": false, + "trackAdoption": false, + "children": [ + { + "parentPluginId": "@kbn/test-subj-selector", + "id": "def-server.subj.$1", + "type": "string", + "tags": [], + "label": "selector", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-test-subj-selector/test_subj_selector.ts", + "deprecated": false, + "trackAdoption": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_test_subj_selector.mdx b/api_docs/kbn_test_subj_selector.mdx new file mode 100644 index 0000000000000..32bfe1cb2f68b --- /dev/null +++ b/api_docs/kbn_test_subj_selector.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: kibKbnTestSubjSelectorPluginApi +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: 2022-09-20 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/test-subj-selector'] +--- +import kbnTestSubjSelectorObj from './kbn_test_subj_selector.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 2 | 0 | 1 | 0 | + +## Server + +### Functions + + diff --git a/api_docs/kbn_tooling_log.mdx b/api_docs/kbn_tooling_log.mdx index fb392e818e687..4e928b81cc9e2 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/tooling-log'] --- import kbnToolingLogObj from './kbn_tooling_log.devdocs.json'; diff --git a/api_docs/kbn_type_summarizer.mdx b/api_docs/kbn_type_summarizer.mdx index c06226b8eba96..6885c76d34578 100644 --- a/api_docs/kbn_type_summarizer.mdx +++ b/api_docs/kbn_type_summarizer.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-type-summarizer title: "@kbn/type-summarizer" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/type-summarizer plugin -date: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/type-summarizer'] --- import kbnTypeSummarizerObj from './kbn_type_summarizer.devdocs.json'; diff --git a/api_docs/kbn_type_summarizer_core.mdx b/api_docs/kbn_type_summarizer_core.mdx index b81adb3a56d1d..02d17639ecacb 100644 --- a/api_docs/kbn_type_summarizer_core.mdx +++ b/api_docs/kbn_type_summarizer_core.mdx @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-type-summarizer-core title: "@kbn/type-summarizer-core" image: https://source.unsplash.com/400x175/?github description: API docs for the @kbn/type-summarizer-core plugin -date: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/type-summarizer-core'] --- import kbnTypeSummarizerCoreObj from './kbn_type_summarizer_core.devdocs.json'; diff --git a/api_docs/kbn_typed_react_router_config.devdocs.json b/api_docs/kbn_typed_react_router_config.devdocs.json index 016fc28862436..b6c4b0eb31605 100644 --- a/api_docs/kbn_typed_react_router_config.devdocs.json +++ b/api_docs/kbn_typed_react_router_config.devdocs.json @@ -787,12 +787,12 @@ { "parentPluginId": "@kbn/typed-react-router-config", "id": "def-common.RouteMatch.route", - "type": "Uncategorized", + "type": "CompoundType", "tags": [], "label": "route", "description": [], "signature": [ - "TRoute" + "TRoute & { path: string; }" ], "path": "packages/kbn-typed-react-router-config/src/types/index.ts", "deprecated": false, @@ -2177,8 +2177,8 @@ "pluginId": "@kbn/typed-react-router-config", "scope": "common", "docId": "kibKbnTypedReactRouterConfigPluginApi", - "section": "def-common.Route", - "text": "Route" + "section": "def-common.RouteWithPath", + "text": "RouteWithPath" }, ") => string" ], @@ -2198,8 +2198,8 @@ "pluginId": "@kbn/typed-react-router-config", "scope": "common", "docId": "kibKbnTypedReactRouterConfigPluginApi", - "section": "def-common.Route", - "text": "Route" + "section": "def-common.RouteWithPath", + "text": "RouteWithPath" } ], "path": "packages/kbn-typed-react-router-config/src/types/index.ts", diff --git a/api_docs/kbn_typed_react_router_config.mdx b/api_docs/kbn_typed_react_router_config.mdx index e75d872f2484d..eee639c93e87c 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: 2022-09-09 +date: 2022-09-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_theme.mdx b/api_docs/kbn_ui_theme.mdx index b70ee2231fefb..76f96eb38b6e5 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: 2022-09-09 +date: 2022-09-20 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ui-theme'] --- import kbnUiThemeObj from './kbn_ui_theme.devdocs.json'; diff --git a/api_docs/kbn_user_profile_components.devdocs.json b/api_docs/kbn_user_profile_components.devdocs.json index be1459464d7f5..d8cd0cfd94f9e 100644 --- a/api_docs/kbn_user_profile_components.devdocs.json +++ b/api_docs/kbn_user_profile_components.devdocs.json @@ -131,7 +131,15 @@ "\nRenders a selectable component inside a popover given a list of user profiles" ], "signature": [ - "({ title, selectableProps, ...popoverProps }: React.PropsWithChildren<", + "

+ +

+ + + + + + +
+ + + + + + + + + + + + + + ); +}; diff --git a/examples/guided_onboarding_example/public/components/main.tsx b/examples/guided_onboarding_example/public/components/main.tsx new file mode 100644 index 0000000000000..8c372bd066271 --- /dev/null +++ b/examples/guided_onboarding_example/public/components/main.tsx @@ -0,0 +1,255 @@ +/* + * 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 { useHistory } from 'react-router-dom'; +import { FormattedMessage } from '@kbn/i18n-react'; +import { i18n } from '@kbn/i18n'; +import { + EuiButton, + EuiFieldNumber, + EuiFlexGroup, + EuiFlexItem, + EuiFormRow, + EuiHorizontalRule, + EuiPageContentBody_Deprecated as EuiPageContentBody, + EuiPageContentHeader_Deprecated as EuiPageContentHeader, + EuiSelect, + EuiSpacer, + EuiText, + EuiTitle, +} from '@elastic/eui'; +import { + GuidedOnboardingPluginStart, + GuidedOnboardingState, + UseCase, +} from '@kbn/guided-onboarding-plugin/public'; +import { CoreStart } from '@kbn/core/public'; + +interface MainProps { + guidedOnboarding: GuidedOnboardingPluginStart; + notifications: CoreStart['notifications']; +} +export const Main = (props: MainProps) => { + const { + guidedOnboarding: { guidedOnboardingApi }, + notifications, + } = props; + const history = useHistory(); + const [guideState, setGuideState] = useState(undefined); + + const [selectedGuide, setSelectedGuide] = useState< + GuidedOnboardingState['activeGuide'] | undefined + >(undefined); + const [selectedStep, setSelectedStep] = useState( + undefined + ); + + useEffect(() => { + const subscription = guidedOnboardingApi?.fetchGuideState$().subscribe((newState) => { + setGuideState(newState); + }); + return () => subscription?.unsubscribe(); + }, [guidedOnboardingApi]); + + const startGuide = async (guide: UseCase) => { + const response = await guidedOnboardingApi?.updateGuideState({ + activeGuide: guide, + activeStep: 'add_data', + }); + + if (response) { + notifications.toasts.addSuccess( + i18n.translate('guidedOnboardingExample.startGuide.toastLabel', { + defaultMessage: 'Guide (re-)started', + }) + ); + } + }; + + const updateGuideState = async () => { + const response = await guidedOnboardingApi?.updateGuideState({ + activeGuide: selectedGuide!, + activeStep: selectedStep!, + }); + + if (response) { + notifications.toasts.addSuccess( + i18n.translate('guidedOnboardingExample.updateGuideState.toastLabel', { + defaultMessage: 'Guide state updated', + }) + ); + } + }; + + return ( + <> + + +

+ +

+ + + + +

+ +

+

+ +

+ {guideState ? ( +
+
+ +
+
{guideState.activeGuide ?? 'undefined'}
+ +
+ +
+
{guideState.activeStep ?? 'undefined'}
+
+ ) : undefined} + + + +

+ +

+ + + + + startGuide('search')} fill> + + + + + startGuide('observability')} fill> + + + + + startGuide('security')} fill> + + + + + + + +

+ +

+ + + + + + { + const value = e.target.value as UseCase; + const shouldResetState = value.trim().length === 0; + if (shouldResetState) { + setSelectedGuide(undefined); + setSelectedStep(undefined); + } else { + setSelectedGuide(value); + } + }} + /> + + + + + setSelectedStep(e.target.value)} + /> + + + + + Save + + + + + + +

+ +

+ + + + + history.push('stepOne')}> + + + + + history.push('stepTwo')}> + + + + + + + ); +}; diff --git a/examples/guided_onboarding_example/public/components/step_one.tsx b/examples/guided_onboarding_example/public/components/step_one.tsx new file mode 100644 index 0000000000000..65b4d8f1f4ad9 --- /dev/null +++ b/examples/guided_onboarding_example/public/components/step_one.tsx @@ -0,0 +1,94 @@ +/* + * 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 { FormattedMessage } from '@kbn/i18n-react'; +import { + EuiButton, + EuiText, + EuiTourStep, + EuiTitle, + EuiPageContentHeader_Deprecated as EuiPageContentHeader, + EuiPageContentBody_Deprecated as EuiPageContentBody, + EuiSpacer, +} from '@elastic/eui'; + +import { GuidedOnboardingPluginStart } from '@kbn/guided-onboarding-plugin/public/types'; + +interface GuidedOnboardingExampleAppDeps { + guidedOnboarding: GuidedOnboardingPluginStart; +} + +export const StepOne = ({ guidedOnboarding }: GuidedOnboardingExampleAppDeps) => { + const { guidedOnboardingApi } = guidedOnboarding; + + const [isTourStepOpen, setIsTourStepOpen] = useState(false); + useEffect(() => { + const subscription = guidedOnboardingApi?.fetchGuideState$().subscribe((newState) => { + const { activeGuide: guide, activeStep: step } = newState; + + if (guide === 'search' && step === 'add_data') { + setIsTourStepOpen(true); + } + }); + return () => subscription?.unsubscribe(); + }, [guidedOnboardingApi]); + + return ( + <> + + +

+ +

+ + + + +

+ +

+ + + +

Click this button to complete step 1.

+ + } + isStepOpen={isTourStepOpen} + minWidth={300} + onFinish={() => setIsTourStepOpen(false)} + step={1} + stepsTotal={1} + title="Step Add data" + anchorPosition="rightUp" + > + { + await guidedOnboardingApi?.updateGuideState({ + activeGuide: 'search', + activeStep: 'search_experience', + }); + }} + > + Complete step 1 + + + + + ); +}; diff --git a/examples/guided_onboarding_example/public/components/step_two.tsx b/examples/guided_onboarding_example/public/components/step_two.tsx new file mode 100644 index 0000000000000..d5962dc5e1cd9 --- /dev/null +++ b/examples/guided_onboarding_example/public/components/step_two.tsx @@ -0,0 +1,95 @@ +/* + * 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 { EuiButton, EuiSpacer, EuiText, EuiTitle, EuiTourStep } from '@elastic/eui'; + +import { GuidedOnboardingPluginStart } from '@kbn/guided-onboarding-plugin/public/types'; +import { useHistory, useLocation } from 'react-router-dom'; +import { FormattedMessage } from '@kbn/i18n-react'; +import { + EuiPageContentHeader_Deprecated as EuiPageContentHeader, + EuiPageContentBody_Deprecated as EuiPageContentBody, +} from '@elastic/eui'; + +interface StepTwoProps { + guidedOnboarding: GuidedOnboardingPluginStart; +} + +export const StepTwo = (props: StepTwoProps) => { + const { + guidedOnboarding: { guidedOnboardingApi }, + } = props; + const { search } = useLocation(); + const history = useHistory(); + + const query = React.useMemo(() => new URLSearchParams(search), [search]); + useEffect(() => { + if (query.get('showTour') === 'true') { + setIsTourStepOpen(true); + } + }, [query]); + + const [isTourStepOpen, setIsTourStepOpen] = useState(false); + + return ( + <> + + +

+ +

+ + + + +

+ +

+ + + +

Click this button to complete step 2.

+ + } + isStepOpen={isTourStepOpen} + minWidth={300} + onFinish={() => { + history.push('/stepTwo'); + query.set('showTour', 'false'); + setIsTourStepOpen(false); + }} + step={1} + stepsTotal={1} + title="Step Add data" + anchorPosition="rightUp" + > + { + await guidedOnboardingApi?.updateGuideState({ + activeGuide: 'search', + activeStep: 'optimize', + }); + }} + > + Complete step 2 + + + + + ); +}; diff --git a/examples/guided_onboarding_example/public/index.ts b/examples/guided_onboarding_example/public/index.ts new file mode 100755 index 0000000000000..2d08d5c8f1246 --- /dev/null +++ b/examples/guided_onboarding_example/public/index.ts @@ -0,0 +1,19 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { GuidedOnboardingExamplePlugin } from './plugin'; + +// This exports static code and TypeScript types, +// as well as, Kibana Platform `plugin()` initializer. +export function plugin() { + return new GuidedOnboardingExamplePlugin(); +} +export type { + GuidedOnboardingExamplePluginSetup, + GuidedOnboardingExamplePluginStart, +} from './types'; diff --git a/examples/guided_onboarding_example/public/plugin.ts b/examples/guided_onboarding_example/public/plugin.ts new file mode 100755 index 0000000000000..829bde91078cc --- /dev/null +++ b/examples/guided_onboarding_example/public/plugin.ts @@ -0,0 +1,43 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { AppMountParameters, CoreSetup, CoreStart, Plugin } from '@kbn/core/public'; +import { + GuidedOnboardingExamplePluginSetup, + GuidedOnboardingExamplePluginStart, + AppPluginStartDependencies, +} from './types'; +import { PLUGIN_NAME } from '../common'; + +export class GuidedOnboardingExamplePlugin + implements Plugin +{ + public setup(core: CoreSetup): GuidedOnboardingExamplePluginSetup { + // Register an application into the side navigation menu + core.application.register({ + id: 'guidedOnboardingExample', + title: PLUGIN_NAME, + async mount(params: AppMountParameters) { + // Load application bundle + const { renderApp } = await import('./application'); + // Get start services as specified in kibana.json + const [coreStart, depsStart] = await core.getStartServices(); + // Render the application + return renderApp(coreStart, depsStart as AppPluginStartDependencies, params); + }, + }); + + return {}; + } + + public start(core: CoreStart): GuidedOnboardingExamplePluginStart { + return {}; + } + + public stop() {} +} diff --git a/examples/guided_onboarding_example/public/types.ts b/examples/guided_onboarding_example/public/types.ts new file mode 100755 index 0000000000000..7d142de36e286 --- /dev/null +++ b/examples/guided_onboarding_example/public/types.ts @@ -0,0 +1,21 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { NavigationPublicPluginStart } from '@kbn/navigation-plugin/public'; +import { GuidedOnboardingPluginStart } from '@kbn/guided-onboarding-plugin/public/types'; + +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface GuidedOnboardingExamplePluginSetup {} + +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface GuidedOnboardingExamplePluginStart {} + +export interface AppPluginStartDependencies { + navigation: NavigationPublicPluginStart; + guidedOnboarding: GuidedOnboardingPluginStart; +} diff --git a/examples/guided_onboarding_example/tsconfig.json b/examples/guided_onboarding_example/tsconfig.json new file mode 100644 index 0000000000000..177f63fa7a449 --- /dev/null +++ b/examples/guided_onboarding_example/tsconfig.json @@ -0,0 +1,24 @@ +{ + "extends": "../../tsconfig.base.json", + "compilerOptions": { + "outDir": "./target/types", + "emitDeclarationOnly": true, + "declaration": true, + "declarationMap": true + }, + "include": [ + "__jest__/**/*", + "common/**/*", + "public/**/*", + "server/**/*", + "../../typings/**/*", + ], + "references": [ + { + "path": "../../src/core/tsconfig.json" + }, + { + "path": "../../src/plugins/guided_onboarding/tsconfig.json" + }, + ] +} diff --git a/examples/search_examples/public/search/app.tsx b/examples/search_examples/public/search/app.tsx index 94cf19436c3f5..01ebd4433af10 100644 --- a/examples/search_examples/public/search/app.tsx +++ b/examples/search_examples/public/search/app.tsx @@ -107,9 +107,9 @@ export const SearchExamplesApp = ({ const [selectedBucketField, setSelectedBucketField] = useState< DataViewField | null | undefined >(); - const [request, setRequest] = useState>({}); const [isLoading, setIsLoading] = useState(false); const [currentAbortController, setAbortController] = useState(); + const [request, setRequest] = useState>({}); const [rawResponse, setRawResponse] = useState>({}); const [warningContents, setWarningContents] = useState([]); const [selectedTab, setSelectedTab] = useState(0); @@ -202,6 +202,8 @@ export const SearchExamplesApp = ({ // Submit the search request using the `data.search` service. setRequest(req.params.body); + setRawResponse({}); + setWarningContents([]); setIsLoading(true); data.search @@ -301,6 +303,8 @@ export const SearchExamplesApp = ({ searchSource.setField('aggs', ac); } setRequest(searchSource.getSearchRequestBody()); + setRawResponse({}); + setWarningContents([]); const abortController = new AbortController(); const inspector: Required = { diff --git a/examples/user_profile_examples/public/popover_demo.tsx b/examples/user_profile_examples/public/popover_demo.tsx index 243441ee12aa1..b1cd036653d5c 100644 --- a/examples/user_profile_examples/public/popover_demo.tsx +++ b/examples/user_profile_examples/public/popover_demo.tsx @@ -6,7 +6,7 @@ * Side Public License, v 1. */ import React, { FunctionComponent, useState } from 'react'; -import { EuiButtonEmpty } from '@elastic/eui'; +import { EuiButtonEmpty, EuiFilterGroup, EuiFilterButton, EuiSpacer, EuiTitle } from '@elastic/eui'; import { UserProfilesPopover, UserProfileWithAvatar } from '@kbn/user-profile-components'; import { PanelWithCodeBlock } from './panel_with_code_block'; @@ -57,6 +57,44 @@ export const PopoverDemo: FunctionComponent = () => { }, ]; + const [isOpen2, setIsOpen2] = useState(false); + const [selectedOptions2, setSelectedOptions2] = useState>([ + null, + ]); + const options2: Array = [ + null, + { + uid: 'u_J41Oh6L9ki-Vo2tOogS8WRTENzhHurGtRc87NgEAlkc_0', + enabled: true, + data: {}, + user: { + username: 'damaged_raccoon', + email: 'damaged_raccoon@elastic.co', + full_name: 'Damaged Raccoon', + }, + }, + { + uid: 'u_A_tM4n0wPkdiQ9smmd8o0Hr_h61XQfu8aRPh9GMoRoc_0', + enabled: true, + data: {}, + user: { + username: 'physical_dinosaur', + email: 'physical_dinosaur@elastic.co', + full_name: 'Physical Dinosaur', + }, + }, + { + uid: 'u_9xDEQqUqoYCnFnPPLq5mIRHKL8gBTo_NiKgOnd5gGk0_0', + enabled: true, + data: {}, + user: { + username: 'wet_dingo', + email: 'wet_dingo@elastic.co', + full_name: 'Wet Dingo', + }, + }, + ]; + return ( { width: 32 * 16, }} /> + + +

Unassigned option

+ + + + 0} + numActiveFilters={selectedOptions2.length} + onClick={() => setIsOpen2((value) => !value)} + > + Assignees + + } + isOpen={isOpen2} + closePopover={() => setIsOpen2(false)} + selectableProps={{ + selectedOptions: selectedOptions2, + options: options2, + onChange: setSelectedOptions2, + height: 32 * 8, + nullOptionLabel: 'Unassigned', + }} + panelStyle={{ + width: 32 * 16, + }} + /> + ); }; diff --git a/kbn_pm/src/cli.mjs b/kbn_pm/src/cli.mjs index 99d8262f92aa9..2c9d1019b588f 100644 --- a/kbn_pm/src/cli.mjs +++ b/kbn_pm/src/cli.mjs @@ -18,7 +18,7 @@ import { Args } from './lib/args.mjs'; import { getHelp } from './lib/help.mjs'; import { createFlagError, isCliError } from './lib/cli_error.mjs'; -import { COMMANDS } from './commands/index.mjs'; +import { getCmd } from './commands/index.mjs'; import { Log } from './lib/log.mjs'; const start = Date.now(); @@ -39,7 +39,7 @@ async function tryToGetCiStatsReporter(log) { } try { - const cmd = cmdName ? COMMANDS.find((c) => c.name === cmdName) : undefined; + const cmd = getCmd(cmdName); if (cmdName && !cmd) { throw createFlagError(`Invalid command name [${cmdName}]`); diff --git a/kbn_pm/src/commands/bootstrap/bootstrap_command.mjs b/kbn_pm/src/commands/bootstrap/bootstrap_command.mjs index 328971313039a..5a2575c645415 100644 --- a/kbn_pm/src/commands/bootstrap/bootstrap_command.mjs +++ b/kbn_pm/src/commands/bootstrap/bootstrap_command.mjs @@ -76,7 +76,7 @@ export const command = { // That is only intended during the migration process while non Bazel projects are not removed at all. if (forceInstall) { await time('force install dependencies', async () => { - removeYarnIntegrityFileIfExists(); + await removeYarnIntegrityFileIfExists(); await Bazel.expungeCache(log, { quiet }); await Bazel.installYarnDeps(log, { offline, quiet }); }); @@ -89,19 +89,17 @@ export const command = { // generate the synthetic package map which powers several other features, needed // as an input to the package build await time('regenerate synthetic package map', async () => { - regenerateSyntheticPackageMap(plugins); + await regenerateSyntheticPackageMap(plugins); }); - // build packages await time('build packages', async () => { await Bazel.buildPackages(log, { offline, quiet }); }); - await time('sort package json', async () => { await sortPackageJson(); }); await time('regenerate tsconfig.base.json', async () => { - regenerateBaseTsconfig(plugins); + await regenerateBaseTsconfig(plugins); }); if (validate) { diff --git a/kbn_pm/src/commands/bootstrap/regenerate_base_tsconfig.mjs b/kbn_pm/src/commands/bootstrap/regenerate_base_tsconfig.mjs index 69b288f7981bb..3cf71531614a5 100644 --- a/kbn_pm/src/commands/bootstrap/regenerate_base_tsconfig.mjs +++ b/kbn_pm/src/commands/bootstrap/regenerate_base_tsconfig.mjs @@ -7,7 +7,7 @@ */ import Path from 'path'; -import Fs from 'fs'; +import Fsp from 'fs/promises'; import { REPO_ROOT } from '../../lib/paths.mjs'; import { convertPluginIdToPackageId } from './plugins.mjs'; @@ -16,9 +16,9 @@ import { normalizePath } from './normalize_path.mjs'; /** * @param {import('@kbn/plugin-discovery').KibanaPlatformPlugin[]} plugins */ -export function regenerateBaseTsconfig(plugins) { +export async function regenerateBaseTsconfig(plugins) { const tsconfigPath = Path.resolve(REPO_ROOT, 'tsconfig.base.json'); - const lines = Fs.readFileSync(tsconfigPath, 'utf-8').split('\n'); + const lines = (await Fsp.readFile(tsconfigPath, 'utf-8')).split('\n'); const packageMap = plugins .slice() @@ -32,7 +32,7 @@ export function regenerateBaseTsconfig(plugins) { const start = lines.findIndex((l) => l.trim() === '// START AUTOMATED PACKAGE LISTING'); const end = lines.findIndex((l) => l.trim() === '// END AUTOMATED PACKAGE LISTING'); - Fs.writeFileSync( + await Fsp.writeFile( tsconfigPath, [...lines.slice(0, start + 1), ...packageMap, ...lines.slice(end)].join('\n') ); diff --git a/kbn_pm/src/commands/bootstrap/regenerate_synthetic_package_map.mjs b/kbn_pm/src/commands/bootstrap/regenerate_synthetic_package_map.mjs index 22898daa92b21..ea1f53727997d 100644 --- a/kbn_pm/src/commands/bootstrap/regenerate_synthetic_package_map.mjs +++ b/kbn_pm/src/commands/bootstrap/regenerate_synthetic_package_map.mjs @@ -7,7 +7,7 @@ */ import Path from 'path'; -import Fs from 'fs'; +import Fsp from 'fs/promises'; import { normalizePath } from './normalize_path.mjs'; import { REPO_ROOT } from '../../lib/paths.mjs'; @@ -16,7 +16,7 @@ import { convertPluginIdToPackageId } from './plugins.mjs'; /** * @param {import('@kbn/plugin-discovery').KibanaPlatformPlugin[]} plugins */ -export function regenerateSyntheticPackageMap(plugins) { +export async function regenerateSyntheticPackageMap(plugins) { /** @type {Array<[string, string]>} */ const entries = [['@kbn/core', 'src/core']]; @@ -27,7 +27,7 @@ export function regenerateSyntheticPackageMap(plugins) { ]); } - Fs.writeFileSync( + await Fsp.writeFile( Path.resolve(REPO_ROOT, 'packages/kbn-synthetic-package-map/synthetic-packages.json'), JSON.stringify(entries, null, 2) ); diff --git a/kbn_pm/src/commands/bootstrap/yarn.mjs b/kbn_pm/src/commands/bootstrap/yarn.mjs index db11c3b12930e..652c5cdb38b6e 100644 --- a/kbn_pm/src/commands/bootstrap/yarn.mjs +++ b/kbn_pm/src/commands/bootstrap/yarn.mjs @@ -7,20 +7,20 @@ */ import Path from 'path'; -import Fs from 'fs'; +import Fsp from 'fs/promises'; import { REPO_ROOT } from '../../lib/paths.mjs'; import { maybeRealpath, isFile, isDirectory } from '../../lib/fs.mjs'; // yarn integrity file checker -export function removeYarnIntegrityFileIfExists() { +export async function removeYarnIntegrityFileIfExists() { try { const nodeModulesRealPath = maybeRealpath(Path.resolve(REPO_ROOT, 'node_modules')); const yarnIntegrityFilePath = Path.resolve(nodeModulesRealPath, '.yarn-integrity'); // check if the file exists and delete it in that case if (isFile(yarnIntegrityFilePath)) { - Fs.unlinkSync(yarnIntegrityFilePath); + await Fsp.unlink(yarnIntegrityFilePath); } } catch { // no-op diff --git a/kbn_pm/src/commands/index.mjs b/kbn_pm/src/commands/index.mjs index 8d4638310d329..f8b63d7afe5fc 100644 --- a/kbn_pm/src/commands/index.mjs +++ b/kbn_pm/src/commands/index.mjs @@ -12,4 +12,12 @@ export const COMMANDS = [ (await import('./run_in_packages_command.mjs')).command, (await import('./clean_command.mjs')).command, (await import('./reset_command.mjs')).command, + (await import('./test_command.mjs')).command, ]; + +/** + * @param {string | undefined} name + */ +export function getCmd(name) { + return COMMANDS.find((c) => (c.name.startsWith('_') ? c.name.slice(1) : c.name) === name); +} diff --git a/kbn_pm/src/commands/test_command.mjs b/kbn_pm/src/commands/test_command.mjs new file mode 100644 index 0000000000000..e425c5b94698d --- /dev/null +++ b/kbn_pm/src/commands/test_command.mjs @@ -0,0 +1,15 @@ +/* + * 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. + */ + +/** @type {import('../lib/command').Command} */ +export const command = { + name: '_test', + async run({ log }) { + log.success('empty'); + }, +}; diff --git a/kbn_pm/src/lib/find_clean_paths.mjs b/kbn_pm/src/lib/find_clean_paths.mjs index e98a949971487..a15118031038b 100644 --- a/kbn_pm/src/lib/find_clean_paths.mjs +++ b/kbn_pm/src/lib/find_clean_paths.mjs @@ -30,7 +30,7 @@ async function tryToGetSyntheticPackageMap(log) { } /** - * @param {*} packageDir + * @param {string} packageDir * @returns {string[]} */ export function readCleanPatterns(packageDir) { diff --git a/kbn_pm/src/lib/help.mjs b/kbn_pm/src/lib/help.mjs index bce93df47e941..28f61bb65c56f 100644 --- a/kbn_pm/src/lib/help.mjs +++ b/kbn_pm/src/lib/help.mjs @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { COMMANDS } from '../commands/index.mjs'; +import { COMMANDS, getCmd } from '../commands/index.mjs'; import { dedent, indent } from './indent.mjs'; import { title } from './colors.mjs'; @@ -15,7 +15,7 @@ import { title } from './colors.mjs'; * @returns {Promise} */ export async function getHelp(cmdName = undefined) { - const cmd = cmdName && COMMANDS.find((c) => c.name === cmdName); + const cmd = getCmd(cmdName); /** * @param {number} depth @@ -49,6 +49,6 @@ export async function getHelp(cmdName = undefined) { ' yarn kbn [...flags]', '', 'Commands:', - ...COMMANDS.map((cmd) => cmdLines(2, cmd)).flat(), + ...COMMANDS.flatMap((cmd) => (cmd.name.startsWith('_') ? [] : cmdLines(2, cmd))), ].join('\n'); } diff --git a/package.json b/package.json index ae40de1b204f4..d895c8d00e819 100644 --- a/package.json +++ b/package.json @@ -99,7 +99,7 @@ }, "dependencies": { "@appland/sql-parser": "^1.5.1", - "@babel/runtime": "^7.18.9", + "@babel/runtime": "^7.19.0", "@dnd-kit/core": "^3.1.1", "@dnd-kit/sortable": "^4.0.0", "@dnd-kit/utilities": "^2.0.0", @@ -109,7 +109,7 @@ "@elastic/datemath": "5.0.3", "@elastic/elasticsearch": "npm:@elastic/elasticsearch-canary@8.3.0-canary.1", "@elastic/ems-client": "8.3.3", - "@elastic/eui": "63.0.6", + "@elastic/eui": "64.0.4", "@elastic/filesaver": "1.1.2", "@elastic/node-crypto": "1.2.1", "@elastic/numeral": "^2.5.1", @@ -146,6 +146,7 @@ "@kbn/config": "link:bazel-bin/packages/kbn-config", "@kbn/config-mocks": "link:bazel-bin/packages/kbn-config-mocks", "@kbn/config-schema": "link:bazel-bin/packages/kbn-config-schema", + "@kbn/content-management-table-list": "link:bazel-bin/packages/content-management/table_list", "@kbn/core-analytics-browser": "link:bazel-bin/packages/core/analytics/core-analytics-browser", "@kbn/core-analytics-browser-internal": "link:bazel-bin/packages/core/analytics/core-analytics-browser-internal", "@kbn/core-analytics-browser-mocks": "link:bazel-bin/packages/core/analytics/core-analytics-browser-mocks", @@ -156,6 +157,8 @@ "@kbn/core-application-browser-internal": "link:bazel-bin/packages/core/application/core-application-browser-internal", "@kbn/core-application-browser-mocks": "link:bazel-bin/packages/core/application/core-application-browser-mocks", "@kbn/core-application-common": "link:bazel-bin/packages/core/application/core-application-common", + "@kbn/core-apps-browser-internal": "link:bazel-bin/packages/core/apps/core-apps-browser-internal", + "@kbn/core-apps-browser-mocks": "link:bazel-bin/packages/core/apps/core-apps-browser-mocks", "@kbn/core-base-browser-internal": "link:bazel-bin/packages/core/base/core-base-browser-internal", "@kbn/core-base-browser-mocks": "link:bazel-bin/packages/core/base/core-base-browser-mocks", "@kbn/core-base-common": "link:bazel-bin/packages/core/base/core-base-common", @@ -283,6 +286,9 @@ "@kbn/core-ui-settings-browser-internal": "link:bazel-bin/packages/core/ui-settings/core-ui-settings-browser-internal", "@kbn/core-ui-settings-browser-mocks": "link:bazel-bin/packages/core/ui-settings/core-ui-settings-browser-mocks", "@kbn/core-ui-settings-common": "link:bazel-bin/packages/core/ui-settings/core-ui-settings-common", + "@kbn/core-ui-settings-server": "link:bazel-bin/packages/core/ui-settings/core-ui-settings-server", + "@kbn/core-ui-settings-server-internal": "link:bazel-bin/packages/core/ui-settings/core-ui-settings-server-internal", + "@kbn/core-ui-settings-server-mocks": "link:bazel-bin/packages/core/ui-settings/core-ui-settings-server-mocks", "@kbn/core-usage-data-base-server-internal": "link:bazel-bin/packages/core/usage-data/core-usage-data-base-server-internal", "@kbn/core-usage-data-server": "link:bazel-bin/packages/core/usage-data/core-usage-data-server", "@kbn/core-usage-data-server-internal": "link:bazel-bin/packages/core/usage-data/core-usage-data-server-internal", @@ -294,6 +300,7 @@ "@kbn/ebt-tools": "link:bazel-bin/packages/kbn-ebt-tools", "@kbn/es-errors": "link:bazel-bin/packages/kbn-es-errors", "@kbn/es-query": "link:bazel-bin/packages/kbn-es-query", + "@kbn/es-types": "link:bazel-bin/packages/kbn-es-types", "@kbn/field-types": "link:bazel-bin/packages/kbn-field-types", "@kbn/flot-charts": "link:bazel-bin/packages/kbn-flot-charts", "@kbn/handlebars": "link:bazel-bin/packages/kbn-handlebars", @@ -334,6 +341,7 @@ "@kbn/server-route-repository": "link:bazel-bin/packages/kbn-server-route-repository", "@kbn/shared-svg": "link:bazel-bin/packages/kbn-shared-svg", "@kbn/shared-ux-avatar-solution": "link:bazel-bin/packages/shared-ux/avatar/solution", + "@kbn/shared-ux-avatar-user-profile-components": "link:bazel-bin/packages/shared-ux/avatar/user_profile/impl", "@kbn/shared-ux-button-exit-full-screen": "link:bazel-bin/packages/shared-ux/button/exit_full_screen/impl", "@kbn/shared-ux-button-exit-full-screen-mocks": "link:bazel-bin/packages/shared-ux/button/exit_full_screen/mocks", "@kbn/shared-ux-button-exit-full-screen-types": "link:bazel-bin/packages/shared-ux/button/exit_full_screen/types", @@ -363,7 +371,9 @@ "@kbn/shared-ux-prompt-no-data-views": "link:bazel-bin/packages/shared-ux/prompt/no_data_views/impl", "@kbn/shared-ux-prompt-no-data-views-mocks": "link:bazel-bin/packages/shared-ux/prompt/no_data_views/mocks", "@kbn/shared-ux-prompt-no-data-views-types": "link:bazel-bin/packages/shared-ux/prompt/no_data_views/types", - "@kbn/shared-ux-storybook-config": "link:bazel-bin/packages/shared-ux/storybook/config", + "@kbn/shared-ux-router-mocks": "link:bazel-bin/packages/shared-ux/router/mocks", + "@kbn/shared-ux-services": "link:bazel-bin/packages/kbn-shared-ux-services", + "@kbn/shared-ux-storybook": "link:bazel-bin/packages/kbn-shared-ux-storybook", "@kbn/shared-ux-storybook-mock": "link:bazel-bin/packages/shared-ux/storybook/mock", "@kbn/shared-ux-utility": "link:bazel-bin/packages/kbn-shared-ux-utility", "@kbn/std": "link:bazel-bin/packages/kbn-std", @@ -426,20 +436,20 @@ "constate": "^3.3.2", "content-disposition": "^0.5.4", "copy-to-clipboard": "^3.0.8", - "core-js": "^3.25.0", + "core-js": "^3.25.1", "cronstrue": "^1.51.0", "cuid": "^2.1.8", "cytoscape": "^3.10.0", "cytoscape-dagre": "^2.2.2", "d3": "3.5.17", - "d3-array": "1.2.4", + "d3-array": "2.12.1", "d3-brush": "^3.0.0", "d3-cloud": "1.2.5", "d3-interpolate": "^3.0.1", - "d3-scale": "^2.2.2", + "d3-scale": "^3.3.0", "d3-selection": "^3.0.0", - "d3-shape": "^1.1.0", - "d3-time": "^1.1.0", + "d3-shape": "^2.1.0", + "d3-time": "^2.1.1", "d3-transition": "^3.0.1", "dedent": "^0.7.0", "deep-freeze-strict": "^1.1.1", @@ -454,6 +464,7 @@ "fast-deep-equal": "^3.1.1", "fflate": "^0.6.9", "file-saver": "^1.3.8", + "fnv-plus": "^1.3.1", "font-awesome": "4.7.0", "formik": "^2.2.9", "fp-ts": "^2.3.1", @@ -492,6 +503,8 @@ "jsonwebtoken": "^8.3.0", "jsts": "^1.6.2", "kea": "^2.4.2", + "launchdarkly-js-client-sdk": "^2.22.1", + "launchdarkly-node-server-sdk": "^6.4.2", "load-json-file": "^6.2.0", "lodash": "^4.17.21", "lru-cache": "^4.1.5", @@ -527,6 +540,7 @@ "pbf": "3.2.1", "pdfjs-dist": "^2.13.216", "pdfmake": "^0.2.5", + "peggy": "^1.2.0", "pluralize": "3.1.0", "polished": "^3.7.2", "pretty-ms": "6.0.0", @@ -547,7 +561,7 @@ "react-fast-compare": "^2.0.4", "react-focus-on": "^3.6.0", "react-grid-layout": "^1.3.4", - "react-hook-form": "^7.34.2", + "react-hook-form": "^7.35.0", "react-intl": "^2.8.0", "react-is": "^17.0.2", "react-markdown": "^6.0.3", @@ -579,6 +593,7 @@ "redux-saga": "^1.1.3", "redux-thunk": "^2.4.1", "redux-thunks": "^1.0.0", + "remark-gfm": "1.0.0", "remark-parse": "^8.0.3", "remark-stringify": "^8.0.3", "require-in-the-middle": "^5.2.0", @@ -627,12 +642,12 @@ "devDependencies": { "@apidevtools/swagger-parser": "^10.0.3", "@babel/cli": "^7.18.10", - "@babel/core": "^7.18.13", + "@babel/core": "^7.19.0", "@babel/eslint-parser": "^7.18.9", "@babel/eslint-plugin": "^7.18.10", - "@babel/generator": "^7.18.13", - "@babel/helper-plugin-utils": "^7.18.9", - "@babel/parser": "^7.18.13", + "@babel/generator": "^7.19.0", + "@babel/helper-plugin-utils": "^7.19.0", + "@babel/parser": "^7.19.0", "@babel/plugin-proposal-class-properties": "^7.18.6", "@babel/plugin-proposal-export-namespace-from": "^7.18.9", "@babel/plugin-proposal-nullish-coalescing-operator": "^7.18.6", @@ -640,17 +655,17 @@ "@babel/plugin-proposal-optional-chaining": "^7.18.9", "@babel/plugin-proposal-private-methods": "^7.18.6", "@babel/plugin-transform-runtime": "^7.18.10", - "@babel/preset-env": "^7.18.10", + "@babel/preset-env": "^7.19.0", "@babel/preset-react": "^7.18.6", "@babel/preset-typescript": "^7.18.6", "@babel/register": "^7.18.9", - "@babel/traverse": "^7.18.13", - "@babel/types": "^7.18.13", + "@babel/traverse": "^7.19.0", + "@babel/types": "^7.19.0", "@bazel/ibazel": "^0.16.2", "@bazel/typescript": "4.6.2", - "@cypress/code-coverage": "^3.9.12", + "@cypress/code-coverage": "^3.10.0", "@cypress/snapshot": "^2.1.7", - "@cypress/webpack-preprocessor": "^5.6.0", + "@cypress/webpack-preprocessor": "^5.12.2", "@elastic/eslint-plugin-eui": "0.0.2", "@elastic/github-checks-reporter": "0.0.20b3", "@elastic/makelogs": "^6.0.0", @@ -720,7 +735,6 @@ "@mapbox/vector-tile": "1.3.1", "@octokit/rest": "^16.35.0", "@openpgp/web-stream-tools": "^0.0.10", - "@percy/agent": "^0.28.6", "@storybook/addon-a11y": "^6.4.22", "@storybook/addon-actions": "^6.4.22", "@storybook/addon-controls": "^6.4.22", @@ -759,15 +773,15 @@ "@types/compression-webpack-plugin": "^2.0.2", "@types/cytoscape": "^3.14.0", "@types/d3": "^3.5.43", - "@types/d3-array": "^1.2.7", + "@types/d3-array": "^2.12.1", "@types/d3-brush": "^3.0.0", - "@types/d3-interpolate": "^2.0.0", - "@types/d3-scale": "^2.2.6", + "@types/d3-interpolate": "^3.0.1", + "@types/d3-scale": "^3.3.0", "@types/d3-selection": "^3.0.0", - "@types/d3-shape": "^1.3.1", - "@types/d3-time": "^1.0.10", - "@types/d3-time-format": "^2.1.1", + "@types/d3-shape": "^2.1.0", + "@types/d3-time": "^2.1.1", "@types/d3-transition": "^3.0.1", + "@types/dagre": "^0.7.47", "@types/dedent": "^0.7.0", "@types/deep-freeze-strict": "^1.1.0", "@types/delete-empty": "^2.0.0", @@ -780,6 +794,7 @@ "@types/fetch-mock": "^7.3.1", "@types/file-saver": "^2.0.0", "@types/flot": "^0.0.31", + "@types/fnv-plus": "^1.3.0", "@types/geojson": "7946.0.7", "@types/getos": "^3.0.0", "@types/gulp": "^4.0.6", @@ -833,6 +848,7 @@ "@types/kbn__config": "link:bazel-bin/packages/kbn-config/npm_module_types", "@types/kbn__config-mocks": "link:bazel-bin/packages/kbn-config-mocks/npm_module_types", "@types/kbn__config-schema": "link:bazel-bin/packages/kbn-config-schema/npm_module_types", + "@types/kbn__content-management-table-list": "link:bazel-bin/packages/content-management/table_list/npm_module_types", "@types/kbn__core-analytics-browser": "link:bazel-bin/packages/core/analytics/core-analytics-browser/npm_module_types", "@types/kbn__core-analytics-browser-internal": "link:bazel-bin/packages/core/analytics/core-analytics-browser-internal/npm_module_types", "@types/kbn__core-analytics-browser-mocks": "link:bazel-bin/packages/core/analytics/core-analytics-browser-mocks/npm_module_types", @@ -843,6 +859,8 @@ "@types/kbn__core-application-browser-internal": "link:bazel-bin/packages/core/application/core-application-browser-internal/npm_module_types", "@types/kbn__core-application-browser-mocks": "link:bazel-bin/packages/core/application/core-application-browser-mocks/npm_module_types", "@types/kbn__core-application-common": "link:bazel-bin/packages/core/application/core-application-common/npm_module_types", + "@types/kbn__core-apps-browser-internal": "link:bazel-bin/packages/core/apps/core-apps-browser-internal/npm_module_types", + "@types/kbn__core-apps-browser-mocks": "link:bazel-bin/packages/core/apps/core-apps-browser-mocks/npm_module_types", "@types/kbn__core-base-browser": "link:bazel-bin/packages/core/base/core-base-browser/npm_module_types", "@types/kbn__core-base-browser-internal": "link:bazel-bin/packages/core/base/core-base-browser-internal/npm_module_types", "@types/kbn__core-base-browser-mocks": "link:bazel-bin/packages/core/base/core-base-browser-mocks/npm_module_types", @@ -975,6 +993,9 @@ "@types/kbn__core-ui-settings-browser-internal": "link:bazel-bin/packages/core/ui-settings/core-ui-settings-browser-internal/npm_module_types", "@types/kbn__core-ui-settings-browser-mocks": "link:bazel-bin/packages/core/ui-settings/core-ui-settings-browser-mocks/npm_module_types", "@types/kbn__core-ui-settings-common": "link:bazel-bin/packages/core/ui-settings/core-ui-settings-common/npm_module_types", + "@types/kbn__core-ui-settings-server": "link:bazel-bin/packages/core/ui-settings/core-ui-settings-server/npm_module_types", + "@types/kbn__core-ui-settings-server-internal": "link:bazel-bin/packages/core/ui-settings/core-ui-settings-server-internal/npm_module_types", + "@types/kbn__core-ui-settings-server-mocks": "link:bazel-bin/packages/core/ui-settings/core-ui-settings-server-mocks/npm_module_types", "@types/kbn__core-usage-data-base-server-internal": "link:bazel-bin/packages/core/usage-data/core-usage-data-base-server-internal/npm_module_types", "@types/kbn__core-usage-data-server": "link:bazel-bin/packages/core/usage-data/core-usage-data-server/npm_module_types", "@types/kbn__core-usage-data-server-internal": "link:bazel-bin/packages/core/usage-data/core-usage-data-server-internal/npm_module_types", @@ -992,6 +1013,7 @@ "@types/kbn__es-archiver": "link:bazel-bin/packages/kbn-es-archiver/npm_module_types", "@types/kbn__es-errors": "link:bazel-bin/packages/kbn-es-errors/npm_module_types", "@types/kbn__es-query": "link:bazel-bin/packages/kbn-es-query/npm_module_types", + "@types/kbn__es-types": "link:bazel-bin/packages/kbn-es-types/npm_module_types", "@types/kbn__eslint-plugin-disable": "link:bazel-bin/packages/kbn-eslint-plugin-disable/npm_module_types", "@types/kbn__eslint-plugin-imports": "link:bazel-bin/packages/kbn-eslint-plugin-imports/npm_module_types", "@types/kbn__field-types": "link:bazel-bin/packages/kbn-field-types/npm_module_types", @@ -1048,6 +1070,7 @@ "@types/kbn__server-route-repository": "link:bazel-bin/packages/kbn-server-route-repository/npm_module_types", "@types/kbn__shared-svg": "link:bazel-bin/packages/kbn-shared-svg/npm_module_types", "@types/kbn__shared-ux-avatar-solution": "link:bazel-bin/packages/shared-ux/avatar/solution/npm_module_types", + "@types/kbn__shared-ux-avatar-user-profile-components": "link:bazel-bin/packages/shared-ux/avatar/user_profile/impl/npm_module_types", "@types/kbn__shared-ux-button-exit-full-screen": "link:bazel-bin/packages/shared-ux/button/exit_full_screen/impl/npm_module_types", "@types/kbn__shared-ux-button-exit-full-screen-mocks": "link:bazel-bin/packages/shared-ux/button/exit_full_screen/mocks/npm_module_types", "@types/kbn__shared-ux-button-exit-full-screen-types": "link:bazel-bin/packages/shared-ux/button/exit_full_screen/types/npm_module_types", @@ -1077,7 +1100,9 @@ "@types/kbn__shared-ux-prompt-no-data-views": "link:bazel-bin/packages/shared-ux/prompt/no_data_views/impl/npm_module_types", "@types/kbn__shared-ux-prompt-no-data-views-mocks": "link:bazel-bin/packages/shared-ux/prompt/no_data_views/mocks/npm_module_types", "@types/kbn__shared-ux-prompt-no-data-views-types": "link:bazel-bin/packages/shared-ux/prompt/no_data_views/types/npm_module_types", - "@types/kbn__shared-ux-storybook-config": "link:bazel-bin/packages/shared-ux/storybook/config/npm_module_types", + "@types/kbn__shared-ux-router-mocks": "link:bazel-bin/packages/shared-ux/router/mocks/npm_module_types", + "@types/kbn__shared-ux-services": "link:bazel-bin/packages/kbn-shared-ux-services/npm_module_types", + "@types/kbn__shared-ux-storybook": "link:bazel-bin/packages/kbn-shared-ux-storybook/npm_module_types", "@types/kbn__shared-ux-storybook-mock": "link:bazel-bin/packages/shared-ux/storybook/mock/npm_module_types", "@types/kbn__shared-ux-utility": "link:bazel-bin/packages/kbn-shared-ux-utility/npm_module_types", "@types/kbn__some-dev-log": "link:bazel-bin/packages/kbn-some-dev-log/npm_module_types", @@ -1088,6 +1113,7 @@ "@types/kbn__telemetry-tools": "link:bazel-bin/packages/kbn-telemetry-tools/npm_module_types", "@types/kbn__test": "link:bazel-bin/packages/kbn-test/npm_module_types", "@types/kbn__test-jest-helpers": "link:bazel-bin/packages/kbn-test-jest-helpers/npm_module_types", + "@types/kbn__test-subj-selector": "link:bazel-bin/packages/kbn-test-subj-selector/npm_module_types", "@types/kbn__tooling-log": "link:bazel-bin/packages/kbn-tooling-log/npm_module_types", "@types/kbn__type-summarizer": "link:bazel-bin/packages/kbn-type-summarizer/npm_module_types", "@types/kbn__type-summarizer-cli": "link:bazel-bin/packages/kbn-type-summarizer-cli/npm_module_types", @@ -1159,7 +1185,7 @@ "@types/resolve": "^1.20.1", "@types/rrule": "^2.2.9", "@types/seedrandom": ">=2.0.0 <4.0.0", - "@types/selenium-webdriver": "^4.1.2", + "@types/selenium-webdriver": "^4.1.5", "@types/semver": "^7", "@types/set-value": "^2.0.0", "@types/sharp": "^0.30.4", @@ -1216,7 +1242,7 @@ "callsites": "^3.1.0", "chance": "1.0.18", "chokidar": "^3.5.3", - "chromedriver": "^104.0.0", + "chromedriver": "^105.0.1", "clean-webpack-plugin": "^3.0.0", "compression-webpack-plugin": "^4.0.0", "copy-webpack-plugin": "^6.0.2", @@ -1225,14 +1251,14 @@ "cssnano": "^5.1.12", "cssnano-preset-default": "^5.2.12", "csstype": "^3.0.2", - "cypress": "^9.6.1", - "cypress-axe": "^0.14.0", + "cypress": "^10.7.0", + "cypress-axe": "^1.0.0", "cypress-file-upload": "^5.0.8", - "cypress-multi-reporters": "^1.6.0", + "cypress-multi-reporters": "^1.6.1", "cypress-pipe": "^2.0.0", - "cypress-react-selector": "^2.3.17", - "cypress-real-events": "^1.7.0", - "cypress-recurse": "^1.20.0", + "cypress-react-selector": "^3.0.0", + "cypress-real-events": "^1.7.1", + "cypress-recurse": "^1.23.0", "debug": "^2.6.9", "delete-empty": "^2.0.0", "dependency-check": "^4.1.0", @@ -1313,7 +1339,7 @@ "ms-chromium-edge-driver": "^0.5.1", "mutation-observer": "^1.0.3", "nock": "12.0.3", - "node-sass": "7.0.1", + "node-sass": "^7.0.3", "null-loader": "^3.0.0", "nyc": "^15.1.0", "oboe": "^2.1.4", diff --git a/packages/BUILD.bazel b/packages/BUILD.bazel index b898faee5fb07..051d0ac9bf27f 100644 --- a/packages/BUILD.bazel +++ b/packages/BUILD.bazel @@ -14,6 +14,7 @@ filegroup( "//packages/analytics/shippers/elastic_v3/common:build", "//packages/analytics/shippers/elastic_v3/server:build", "//packages/analytics/shippers/fullstory:build", + "//packages/content-management/table_list:build", "//packages/core/analytics/core-analytics-browser:build", "//packages/core/analytics/core-analytics-browser-internal:build", "//packages/core/analytics/core-analytics-browser-mocks:build", @@ -24,6 +25,8 @@ filegroup( "//packages/core/application/core-application-browser-internal:build", "//packages/core/application/core-application-browser-mocks:build", "//packages/core/application/core-application-common:build", + "//packages/core/apps/core-apps-browser-internal:build", + "//packages/core/apps/core-apps-browser-mocks:build", "//packages/core/base/core-base-browser-internal:build", "//packages/core/base/core-base-browser-mocks:build", "//packages/core/base/core-base-common:build", @@ -149,6 +152,9 @@ filegroup( "//packages/core/ui-settings/core-ui-settings-browser-internal:build", "//packages/core/ui-settings/core-ui-settings-browser-mocks:build", "//packages/core/ui-settings/core-ui-settings-common:build", + "//packages/core/ui-settings/core-ui-settings-server:build", + "//packages/core/ui-settings/core-ui-settings-server-internal:build", + "//packages/core/ui-settings/core-ui-settings-server-mocks:build", "//packages/core/usage-data/core-usage-data-base-server-internal:build", "//packages/core/usage-data/core-usage-data-server:build", "//packages/core/usage-data/core-usage-data-server-internal:build", @@ -192,6 +198,7 @@ filegroup( "//packages/kbn-es-archiver:build", "//packages/kbn-es-errors:build", "//packages/kbn-es-query:build", + "//packages/kbn-es-types:build", "//packages/kbn-eslint-config:build", "//packages/kbn-eslint-plugin-disable:build", "//packages/kbn-eslint-plugin-eslint:build", @@ -322,6 +329,7 @@ filegroup( "//packages/analytics/shippers/elastic_v3/common:build_types", "//packages/analytics/shippers/elastic_v3/server:build_types", "//packages/analytics/shippers/fullstory:build_types", + "//packages/content-management/table_list:build_types", "//packages/core/analytics/core-analytics-browser:build_types", "//packages/core/analytics/core-analytics-browser-internal:build_types", "//packages/core/analytics/core-analytics-browser-mocks:build_types", @@ -332,6 +340,8 @@ filegroup( "//packages/core/application/core-application-browser-internal:build_types", "//packages/core/application/core-application-browser-mocks:build_types", "//packages/core/application/core-application-common:build_types", + "//packages/core/apps/core-apps-browser-internal:build_types", + "//packages/core/apps/core-apps-browser-mocks:build_types", "//packages/core/base/core-base-browser-internal:build_types", "//packages/core/base/core-base-browser-mocks:build_types", "//packages/core/base/core-base-common:build_types", @@ -457,6 +467,9 @@ filegroup( "//packages/core/ui-settings/core-ui-settings-browser-internal:build_types", "//packages/core/ui-settings/core-ui-settings-browser-mocks:build_types", "//packages/core/ui-settings/core-ui-settings-common:build_types", + "//packages/core/ui-settings/core-ui-settings-server:build_types", + "//packages/core/ui-settings/core-ui-settings-server-internal:build_types", + "//packages/core/ui-settings/core-ui-settings-server-mocks:build_types", "//packages/core/usage-data/core-usage-data-base-server-internal:build_types", "//packages/core/usage-data/core-usage-data-server:build_types", "//packages/core/usage-data/core-usage-data-server-internal:build_types", @@ -494,6 +507,7 @@ filegroup( "//packages/kbn-es-archiver:build_types", "//packages/kbn-es-errors:build_types", "//packages/kbn-es-query:build_types", + "//packages/kbn-es-types:build_types", "//packages/kbn-eslint-plugin-disable:build_types", "//packages/kbn-eslint-plugin-imports:build_types", "//packages/kbn-field-types:build_types", @@ -552,6 +566,7 @@ filegroup( "//packages/kbn-telemetry-tools:build_types", "//packages/kbn-test:build_types", "//packages/kbn-test-jest-helpers:build_types", + "//packages/kbn-test-subj-selector:build_types", "//packages/kbn-tooling-log:build_types", "//packages/kbn-type-summarizer:build_types", "//packages/kbn-type-summarizer-cli:build_types", diff --git a/packages/content-management/.storybook/main.js b/packages/content-management/.storybook/main.js new file mode 100644 index 0000000000000..0aaf1046299de --- /dev/null +++ b/packages/content-management/.storybook/main.js @@ -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. + */ + +const defaultConfig = require('@kbn/storybook').defaultConfig; + +module.exports = { + ...defaultConfig, + stories: ['../**/*.stories.tsx'], + reactOptions: { + strictMode: true, + }, +}; diff --git a/packages/content-management/.storybook/manager.js b/packages/content-management/.storybook/manager.js new file mode 100644 index 0000000000000..bc576ed60a8aa --- /dev/null +++ b/packages/content-management/.storybook/manager.js @@ -0,0 +1,19 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ +const { addons } = require('@storybook/addons'); +const { create } = require('@storybook/theming'); +const { PANEL_ID } = require('@storybook/addon-actions'); + +addons.setConfig({ + theme: create({ + base: 'light', + brandTitle: 'Content Management Storybook', + }), + showPanel: () => true, + selectedPanel: PANEL_ID, +}); diff --git a/packages/content-management/table_list/BUILD.bazel b/packages/content-management/table_list/BUILD.bazel new file mode 100644 index 0000000000000..36d84a426a017 --- /dev/null +++ b/packages/content-management/table_list/BUILD.bazel @@ -0,0 +1,160 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "table_list" +PKG_REQUIRE_NAME = "@kbn/content-management-table-list" + +SOURCE_FILES = glob( + [ + "**/*.ts", + "**/*.tsx", + ], + exclude = [ + "**/*.config.js", + "**/*.mock.*", + "**/*.test.*", + "**/*.stories.*", + "**/__snapshots__", + "**/integration_tests", + "**/mocks", + "**/scripts", + "**/storybook", + "**/test_fixtures", + "**/test_helpers", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +# In this array place runtime dependencies, including other packages and NPM packages +# which must be available for this code to run. +# +# To reference other packages use: +# "//repo/relative/path/to/package" +# eg. "//packages/kbn-utils" +# +# To reference a NPM package use: +# "@npm//name-of-package" +# eg. "@npm//lodash" +RUNTIME_DEPS = [ + "//packages/kbn-i18n-react", + "//packages/kbn-i18n", + "//packages/core/http/core-http-browser", + "//packages/core/theme/core-theme-browser", + "//packages/kbn-safer-lodash-set", + "//packages/shared-ux/page/kibana_template/impl", + "@npm//@elastic/eui", + "@npm//@emotion/react", + "@npm//@emotion/css", + "@npm//lodash", + "@npm//moment", + "@npm//react-use", + "@npm//react", + "@npm//rxjs", +] + +# In this array place dependencies necessary to build the types, which will include the +# :npm_module_types target of other packages and packages from NPM, including @types/* +# packages. +# +# To reference the types for another package use: +# "//repo/relative/path/to/package:npm_module_types" +# eg. "//packages/kbn-utils:npm_module_types" +# +# References to NPM packages work the same as RUNTIME_DEPS +TYPES_DEPS = [ + "//packages/kbn-i18n:npm_module_types", + "//packages/kbn-i18n-react:npm_module_types", + "//packages/core/http/core-http-browser:npm_module_types", + "//packages/core/theme/core-theme-browser:npm_module_types", + "//packages/kbn-ambient-storybook-types", + "//packages/kbn-ambient-ui-types", + "//packages/kbn-safer-lodash-set:npm_module_types", + "//packages/shared-ux/page/kibana_template/impl:npm_module_types", + "//packages/shared-ux/page/kibana_template/types", + "@npm//@types/node", + "@npm//@types/jest", + "@npm//@types/lodash", + "@npm//@types/react", + "@npm//@elastic/eui", + "@npm//react-use", + "@npm//rxjs", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +jsts_transpiler( + name = "target_web", + srcs = SRCS, + build_pkg_name = package_name(), + web = True, +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + declaration_map = True, + emit_declaration_only = True, + out_dir = "target_types", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node", ":target_web"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/content-management/table_list/README.mdx b/packages/content-management/table_list/README.mdx new file mode 100644 index 0000000000000..1847207c3bdcd --- /dev/null +++ b/packages/content-management/table_list/README.mdx @@ -0,0 +1,20 @@ +--- +id: sharedUX/contentManagement/TableList +slug: /shared-ux/content-management/table-list +title: Table list view +summary: A table to render user generated saved objects. +tags: ['shared-ux', 'content-management'] +date: 2022-08-09 +--- + +The `` render a eui page to display a list of user content saved object. + +**Uncomplete documentation**. Will be updated. + +## API + +TODO + +## EUI Promotion Status + +This component is not currently considered for promotion to EUI. diff --git a/packages/content-management/table_list/index.ts b/packages/content-management/table_list/index.ts new file mode 100644 index 0000000000000..c6550a12da30a --- /dev/null +++ b/packages/content-management/table_list/index.ts @@ -0,0 +1,11 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export { TableListView, TableListViewProvider, TableListViewKibanaProvider } from './src'; + +export type { UserContentCommonSchema } from './src'; diff --git a/packages/content-management/table_list/jest.config.js b/packages/content-management/table_list/jest.config.js new file mode 100644 index 0000000000000..546d16dd86cf0 --- /dev/null +++ b/packages/content-management/table_list/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/content-management/table_list'], +}; diff --git a/packages/content-management/table_list/kibana.jsonc b/packages/content-management/table_list/kibana.jsonc new file mode 100644 index 0000000000000..7f22b8c8f56c4 --- /dev/null +++ b/packages/content-management/table_list/kibana.jsonc @@ -0,0 +1,7 @@ +{ + "type": "shared-common", + "id": "@kbn/content-management-table-list", + "owner": "@elastic/shared-ux", + "runtimeDeps": [], + "typeDeps": [] +} diff --git a/packages/content-management/table_list/package.json b/packages/content-management/table_list/package.json new file mode 100644 index 0000000000000..f4cc8ba690d20 --- /dev/null +++ b/packages/content-management/table_list/package.json @@ -0,0 +1,8 @@ +{ + "name": "@kbn/content-management-table-list", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "browser": "./target_web/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/packages/content-management/table_list/src/__jest__/index.ts b/packages/content-management/table_list/src/__jest__/index.ts new file mode 100644 index 0000000000000..2f3d8863ff1d6 --- /dev/null +++ b/packages/content-management/table_list/src/__jest__/index.ts @@ -0,0 +1,9 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export { WithServices } from './tests.helpers'; diff --git a/packages/content-management/table_list/src/__jest__/tests.helpers.tsx b/packages/content-management/table_list/src/__jest__/tests.helpers.tsx new file mode 100644 index 0000000000000..381e4974b4e36 --- /dev/null +++ b/packages/content-management/table_list/src/__jest__/tests.helpers.tsx @@ -0,0 +1,36 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ +import React from 'react'; +import type { ComponentType } from 'react'; +import { from } from 'rxjs'; + +import { TableListViewProvider, Services } from '../services'; + +export const getMockServices = (overrides?: Partial) => { + const services: Services = { + canEditAdvancedSettings: true, + getListingLimitSettingsUrl: () => 'http://elastic.co', + notifyError: () => undefined, + currentAppId$: from('mockedApp'), + navigateToUrl: () => undefined, + ...overrides, + }; + + return services; +}; + +export function WithServices

(Comp: ComponentType

, overrides: Partial = {}) { + return (props: P) => { + const services = getMockServices(overrides); + return ( + + + + ); + }; +} diff --git a/packages/content-management/table_list/src/actions.ts b/packages/content-management/table_list/src/actions.ts new file mode 100644 index 0000000000000..ad82aa7379812 --- /dev/null +++ b/packages/content-management/table_list/src/actions.ts @@ -0,0 +1,74 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 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 { IHttpFetchError } from '@kbn/core-http-browser'; +import type { CriteriaWithPagination } from '@elastic/eui'; + +/** Action to trigger a fetch of the table items */ +export interface OnFetchItemsAction { + type: 'onFetchItems'; +} + +/** Action to return the fetched table items */ +export interface OnFetchItemsSuccessAction { + type: 'onFetchItemsSuccess'; + data: { + response: { + total: number; + hits: T[]; + }; + }; +} + +/** Action to return any error while fetching the table items */ +export interface OnFetchItemsErrorAction { + type: 'onFetchItemsError'; + data: IHttpFetchError; +} + +/** + * Actions to update the state of items deletions + * - onDeleteItems: emit before deleting item(s) + * - onItemsDeleted: emit after deleting item(s) + * - onCancelDeleteItems: emit to cancel deleting items (and close the modal) + */ +export interface DeleteItemsActions { + type: 'onCancelDeleteItems' | 'onDeleteItems' | 'onItemsDeleted'; +} + +/** Action to update the selection of items in the table (for batch operations) */ +export interface OnSelectionChangeAction { + type: 'onSelectionChange'; + data: T[]; +} + +/** Action to update the state of the table whenever the sort or page size changes */ +export interface OnTableChangeAction { + type: 'onTableChange'; + data: CriteriaWithPagination; +} + +/** Action to display the delete confirmation modal */ +export interface ShowConfirmDeleteItemsModalAction { + type: 'showConfirmDeleteItemsModal'; +} + +/** Action to update the search bar query text */ +export interface OnSearchQueryChangeAction { + type: 'onSearchQueryChange'; + data: string; +} + +export type Action = + | OnFetchItemsAction + | OnFetchItemsSuccessAction + | OnFetchItemsErrorAction + | DeleteItemsActions + | OnSelectionChangeAction + | OnTableChangeAction + | ShowConfirmDeleteItemsModalAction + | OnSearchQueryChangeAction; diff --git a/packages/content-management/table_list/src/components/confirm_delete_modal.tsx b/packages/content-management/table_list/src/components/confirm_delete_modal.tsx new file mode 100644 index 0000000000000..af2585788701a --- /dev/null +++ b/packages/content-management/table_list/src/components/confirm_delete_modal.tsx @@ -0,0 +1,94 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import React from 'react'; +import { EuiConfirmModal } from '@elastic/eui'; +import { i18n } from '@kbn/i18n'; + +function getI18nTexts(items: unknown[], entityName: string, entityNamePlural: string) { + return { + deleteBtnLabel: i18n.translate( + 'contentManagement.tableList.listing.deleteSelectedItemsConfirmModal.confirmButtonLabel', + { + defaultMessage: 'Delete', + } + ), + deletingBtnLabel: i18n.translate( + 'contentManagement.tableList.listing.deleteSelectedItemsConfirmModal.confirmButtonLabelDeleting', + { + defaultMessage: 'Deleting', + } + ), + title: i18n.translate('contentManagement.tableList.listing.deleteSelectedConfirmModal.title', { + defaultMessage: 'Delete {itemCount} {entityName}?', + values: { + itemCount: items.length, + entityName: items.length === 1 ? entityName : entityNamePlural, + }, + }), + description: i18n.translate( + 'contentManagement.tableList.listing.deleteConfirmModalDescription', + { + defaultMessage: `You can't recover deleted {entityNamePlural}.`, + values: { + entityNamePlural, + }, + } + ), + cancelBtnLabel: i18n.translate( + 'contentManagement.tableList.listing.deleteSelectedItemsConfirmModal.cancelButtonLabel', + { + defaultMessage: 'Cancel', + } + ), + }; +} + +interface Props { + /** Flag to indicate if the items are being deleted */ + isDeletingItems: boolean; + /** Array of items to delete */ + items: T[]; + /** The name of the entity to delete (singular) */ + entityName: string; + /** The name of the entity to delete (plural) */ + entityNamePlural: string; + /** Handler to be called when clicking the "Cancel" button */ + onCancel: () => void; + /** Handler to be called when clicking the "Confirm" button */ + onConfirm: () => void; +} + +export function ConfirmDeleteModal({ + isDeletingItems, + items, + entityName, + entityNamePlural, + onCancel, + onConfirm, +}: Props) { + const { deleteBtnLabel, deletingBtnLabel, title, description, cancelBtnLabel } = getI18nTexts( + items, + entityName, + entityNamePlural + ); + + return ( + +

{description}

+ + ); +} diff --git a/packages/content-management/table_list/src/components/index.ts b/packages/content-management/table_list/src/components/index.ts new file mode 100644 index 0000000000000..b9226155ba44d --- /dev/null +++ b/packages/content-management/table_list/src/components/index.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 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 { Table } from './table'; +export { UpdatedAtField } from './updated_at_field'; +export { ConfirmDeleteModal } from './confirm_delete_modal'; +export { ListingLimitWarning } from './listing_limit_warning'; diff --git a/packages/content-management/table_list/src/components/listing_limit_warning.tsx b/packages/content-management/table_list/src/components/listing_limit_warning.tsx new file mode 100644 index 0000000000000..f5317a9598baa --- /dev/null +++ b/packages/content-management/table_list/src/components/listing_limit_warning.tsx @@ -0,0 +1,78 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import React from 'react'; +import { EuiCallOut, EuiLink, EuiSpacer } from '@elastic/eui'; +import { FormattedMessage } from '@kbn/i18n-react'; + +interface Props { + entityNamePlural: string; + canEditAdvancedSettings: boolean; + advancedSettingsLink: string; + totalItems: number; + listingLimit: number; +} + +export function ListingLimitWarning({ + entityNamePlural, + totalItems, + listingLimit, + canEditAdvancedSettings, + advancedSettingsLink, +}: Props) { + return ( + <> + + } + color="warning" + iconType="help" + > +

+ listingLimit, + }} + />{' '} + {canEditAdvancedSettings ? ( + + + + ), + }} + /> + ) : ( + + )} +

+ + + + ); +} diff --git a/packages/content-management/table_list/src/components/table.tsx b/packages/content-management/table_list/src/components/table.tsx new file mode 100644 index 0000000000000..feb83dbc30a40 --- /dev/null +++ b/packages/content-management/table_list/src/components/table.tsx @@ -0,0 +1,131 @@ +/* + * 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, { Dispatch, useCallback } from 'react'; +import { FormattedMessage } from '@kbn/i18n-react'; +import { + EuiBasicTableColumn, + EuiButton, + EuiInMemoryTable, + CriteriaWithPagination, + PropertySort, +} from '@elastic/eui'; + +import { useServices } from '../services'; +import type { Action } from '../actions'; +import type { + State as TableListViewState, + Props as TableListViewProps, + UserContentCommonSchema, +} from '../table_list_view'; + +type State = Pick< + TableListViewState, + 'items' | 'selectedIds' | 'searchQuery' | 'tableSort' | 'pagination' +>; + +interface Props extends State { + dispatch: Dispatch>; + entityName: string; + entityNamePlural: string; + isFetchingItems: boolean; + tableCaption: string; + tableColumns: Array>; + deleteItems: TableListViewProps['deleteItems']; +} + +export function Table({ + dispatch, + items, + isFetchingItems, + searchQuery, + selectedIds, + pagination, + tableColumns, + tableSort, + entityName, + entityNamePlural, + deleteItems, + tableCaption, +}: Props) { + const { getSearchBarFilters } = useServices(); + + const renderToolsLeft = useCallback(() => { + if (!deleteItems || selectedIds.length === 0) { + return; + } + + return ( + dispatch({ type: 'showConfirmDeleteItemsModal' })} + data-test-subj="deleteSelectedItems" + > + + + ); + }, [deleteItems, dispatch, entityName, entityNamePlural, selectedIds.length]); + + const selection = deleteItems + ? { + onSelectionChange: (obj: T[]) => { + dispatch({ type: 'onSelectionChange', data: obj }); + }, + } + : undefined; + + const searchFilters = getSearchBarFilters ? getSearchBarFilters() : []; + + const search = { + onChange: ({ queryText }: { queryText: string }) => + dispatch({ type: 'onSearchQueryChange', data: queryText }), + toolsLeft: renderToolsLeft(), + defaultQuery: searchQuery, + box: { + incremental: true, + 'data-test-subj': 'tableListSearchBox', + }, + filters: searchFilters, + }; + + const noItemsMessage = ( + + ); + + return ( + + itemId="id" + items={items} + columns={tableColumns} + pagination={pagination} + loading={isFetchingItems} + message={noItemsMessage} + selection={selection} + search={search} + sorting={tableSort ? { sort: tableSort as PropertySort } : undefined} + onChange={(criteria: CriteriaWithPagination) => + dispatch({ type: 'onTableChange', data: criteria }) + } + data-test-subj="itemsInMemTable" + rowHeader="attributes.title" + tableCaption={tableCaption} + /> + ); +} diff --git a/packages/content-management/table_list/src/components/updated_at_field.tsx b/packages/content-management/table_list/src/components/updated_at_field.tsx new file mode 100644 index 0000000000000..76055c63f00e4 --- /dev/null +++ b/packages/content-management/table_list/src/components/updated_at_field.tsx @@ -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. + */ + +import React, { FC } from 'react'; +import { i18n } from '@kbn/i18n'; +import { EuiToolTip } from '@elastic/eui'; +import moment from 'moment'; + +import { DateFormatter } from '../services'; + +const DefaultDateFormatter: DateFormatter = ({ value, children }) => + children(new Date(value).toDateString()); + +export const UpdatedAtField: FC<{ dateTime?: string; DateFormatterComp?: DateFormatter }> = ({ + dateTime, + DateFormatterComp = DefaultDateFormatter, +}) => { + if (!dateTime) { + return ( + + - + + ); + } + const updatedAt = moment(dateTime); + + if (updatedAt.diff(moment(), 'days') > -7) { + return ( + + {(formattedDate: string) => ( + + {formattedDate} + + )} + + ); + } + return ( + + {updatedAt.format('LL')} + + ); +}; diff --git a/packages/content-management/table_list/src/index.ts b/packages/content-management/table_list/src/index.ts new file mode 100644 index 0000000000000..df0d1e22bc106 --- /dev/null +++ b/packages/content-management/table_list/src/index.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. + */ + +export { TableListView } from './table_list_view'; + +export type { + Props as TableListViewProps, + State as TableListViewState, + UserContentCommonSchema, +} from './table_list_view'; + +export { TableListViewProvider, TableListViewKibanaProvider } from './services'; diff --git a/packages/content-management/table_list/src/mocks.ts b/packages/content-management/table_list/src/mocks.ts new file mode 100644 index 0000000000000..3c6bb3c68cad1 --- /dev/null +++ b/packages/content-management/table_list/src/mocks.ts @@ -0,0 +1,99 @@ +/* + * 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 { from } from 'rxjs'; + +import { Services } from './services'; + +/** + * Parameters drawn from the Storybook arguments collection that customize a component story. + */ +export type Params = Record, any>; +type ActionFn = (name: string) => any; + +/** + * Returns Storybook-compatible service abstractions for the `NoDataCard` Provider. + */ +export const getStoryServices = (params: Params, action: ActionFn = () => {}) => { + const services: Services = { + canEditAdvancedSettings: true, + getListingLimitSettingsUrl: () => 'http://elastic.co', + notifyError: (title, text) => { + action('notifyError')({ title, text }); + }, + currentAppId$: from('mockedApp'), + navigateToUrl: () => undefined, + ...params, + }; + + return services; +}; + +/** + * Returns the Storybook arguments for `NoDataCard`, for its stories and for + * consuming component stories. + */ +export const getStoryArgTypes = () => ({ + tableListTitle: { + control: { + type: 'text', + }, + defaultValue: 'My dashboards', + }, + entityName: { + control: { + type: 'text', + }, + defaultValue: 'Dashboard', + }, + entityNamePlural: { + control: { + type: 'text', + }, + defaultValue: 'Dashboards', + }, + canCreateItem: { + control: 'boolean', + defaultValue: true, + }, + canEditItem: { + control: 'boolean', + defaultValue: true, + }, + canDeleteItem: { + control: 'boolean', + defaultValue: true, + }, + showCustomColumn: { + control: 'boolean', + defaultValue: false, + }, + numberOfItemsToRender: { + control: { + type: 'number', + }, + defaultValue: 15, + }, + initialFilter: { + control: { + type: 'text', + }, + defaultValue: '', + }, + initialPageSize: { + control: { + type: 'number', + }, + defaultValue: 10, + }, + listingLimit: { + control: { + type: 'number', + }, + defaultValue: 20, + }, +}); diff --git a/packages/content-management/table_list/src/reducer.tsx b/packages/content-management/table_list/src/reducer.tsx new file mode 100644 index 0000000000000..605e3872c077d --- /dev/null +++ b/packages/content-management/table_list/src/reducer.tsx @@ -0,0 +1,152 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ +import React from 'react'; +import { sortBy } from 'lodash'; +import { i18n } from '@kbn/i18n'; + +import { UpdatedAtField } from './components'; +import type { State, UserContentCommonSchema } from './table_list_view'; +import type { Action } from './actions'; +import type { Services } from './services'; + +interface Dependencies { + DateFormatterComp: Services['DateFormatterComp']; +} + +function onInitialItemsFetch( + items: T[], + { DateFormatterComp }: Dependencies +) { + // We check if the saved object have the "updatedAt" metadata + // to render or not that column in the table + const hasUpdatedAtMetadata = Boolean(items.find((item) => Boolean(item.updatedAt))); + + if (hasUpdatedAtMetadata) { + // Add "Last update" column and sort by that column initially + return { + tableSort: { + field: 'updatedAt' as keyof T, + direction: 'desc' as const, + }, + tableColumns: [ + { + field: 'updatedAt', + name: i18n.translate('contentManagement.tableList.lastUpdatedColumnTitle', { + defaultMessage: 'Last updated', + }), + render: (field: string, record: { updatedAt?: string }) => ( + + ), + sortable: true, + width: '150px', + }, + ], + }; + } + + return {}; +} + +export function getReducer({ DateFormatterComp }: Dependencies) { + return (state: State, action: Action): State => { + switch (action.type) { + case 'onFetchItems': { + return { + ...state, + isFetchingItems: true, + }; + } + case 'onFetchItemsSuccess': { + const items = action.data.response.hits; + // We only get the state on the initial fetch of items + // After that we don't want to reset the columns or change the sort after fetching + const { tableColumns, tableSort } = state.hasInitialFetchReturned + ? { tableColumns: undefined, tableSort: undefined } + : onInitialItemsFetch(items, { DateFormatterComp }); + + return { + ...state, + hasInitialFetchReturned: true, + isFetchingItems: false, + items: !state.searchQuery ? sortBy(items, 'title') : items, + totalItems: action.data.response.total, + tableColumns: tableColumns + ? [...state.tableColumns, ...tableColumns] + : state.tableColumns, + tableSort: tableSort ?? state.tableSort, + pagination: { + ...state.pagination, + totalItemCount: items.length, + }, + }; + } + case 'onFetchItemsError': { + return { + ...state, + isFetchingItems: false, + items: [], + totalItems: 0, + fetchError: action.data, + }; + } + case 'onSearchQueryChange': { + return { + ...state, + searchQuery: action.data, + isFetchingItems: true, + }; + } + case 'onTableChange': { + const tableSort = action.data.sort ?? state.tableSort; + return { + ...state, + pagination: { + ...state.pagination, + pageIndex: action.data.page.index, + pageSize: action.data.page.size, + }, + tableSort, + }; + } + case 'showConfirmDeleteItemsModal': { + return { + ...state, + showDeleteModal: true, + }; + } + case 'onDeleteItems': { + return { + ...state, + isDeletingItems: true, + }; + } + case 'onCancelDeleteItems': { + return { + ...state, + showDeleteModal: false, + }; + } + case 'onItemsDeleted': { + return { + ...state, + isDeletingItems: false, + selectedIds: [], + showDeleteModal: false, + }; + } + case 'onSelectionChange': { + return { + ...state, + selectedIds: action.data + .map((item) => item?.id) + .filter((id): id is string => Boolean(id)), + }; + } + } + }; +} diff --git a/packages/content-management/table_list/src/services.tsx b/packages/content-management/table_list/src/services.tsx new file mode 100644 index 0000000000000..ca376c2f83058 --- /dev/null +++ b/packages/content-management/table_list/src/services.tsx @@ -0,0 +1,191 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import React, { FC, useContext, useMemo } from 'react'; +import type { EuiTableFieldDataColumnType, SearchFilterConfig } from '@elastic/eui'; +import type { Observable } from 'rxjs'; +import type { FormattedRelative } from '@kbn/i18n-react'; +import { RedirectAppLinksKibanaProvider } from '@kbn/shared-ux-link-redirect-app'; + +import { UserContentCommonSchema } from './table_list_view'; + +type UnmountCallback = () => void; +type MountPoint = (element: HTMLElement) => UnmountCallback; +type NotifyFn = (title: JSX.Element, text?: string) => void; + +export interface SavedObjectsReference { + id: string; + name: string; + type: string; +} + +export type SavedObjectsFindOptionsReference = Omit; + +export type DateFormatter = (props: { + value: number; + children: (formattedDate: string) => JSX.Element; +}) => JSX.Element; + +/** + * Abstract external services for this component. + */ +export interface Services { + canEditAdvancedSettings: boolean; + getListingLimitSettingsUrl: () => string; + notifyError: NotifyFn; + currentAppId$: Observable; + navigateToUrl: (url: string) => Promise | void; + searchQueryParser?: (searchQuery: string) => { + searchQuery: string; + references?: SavedObjectsFindOptionsReference[]; + }; + getTagsColumnDefinition?: () => EuiTableFieldDataColumnType | undefined; + getSearchBarFilters?: () => SearchFilterConfig[]; + DateFormatterComp?: DateFormatter; +} + +const TableListViewContext = React.createContext(null); + +/** + * Abstract external service Provider. + */ +export const TableListViewProvider: FC = ({ children, ...services }) => { + return {children}; +}; + +/** + * Kibana-specific service types. + */ +export interface TableListViewKibanaDependencies { + /** CoreStart contract */ + core: { + application: { + capabilities: { + advancedSettings?: { + save: boolean; + }; + }; + getUrlForApp: (app: string, options: { path: string }) => string; + currentAppId$: Observable; + navigateToUrl: (url: string) => Promise | void; + }; + notifications: { + toasts: { + addDanger: (notifyArgs: { title: MountPoint; text?: string }) => void; + }; + }; + }; + /** + * Handler from the '@kbn/kibana-react-plugin/public' Plugin + * + * ``` + * import { toMountPoint } from '@kbn/kibana-react-plugin/public'; + * ``` + */ + toMountPoint: ( + node: React.ReactNode, + options?: { theme$: Observable<{ readonly darkMode: boolean }> } + ) => MountPoint; + /** + * The public API from the savedObjectsTaggingOss plugin. + * It is returned by calling `getTaggingApi()` from the SavedObjectTaggingOssPluginStart + * + * ```js + * const savedObjectsTagging = savedObjectsTaggingOss?.getTaggingApi() + * ``` + */ + savedObjectsTagging?: { + ui: { + getTableColumnDefinition: () => EuiTableFieldDataColumnType; + parseSearchQuery: ( + query: string, + options?: { + useName?: boolean; + tagField?: string; + } + ) => { + searchTerm: string; + tagReferences: SavedObjectsFindOptionsReference[]; + valid: boolean; + }; + getSearchBarFilter: (options?: { + useName?: boolean; + tagField?: string; + }) => SearchFilterConfig; + }; + }; + /** The component from the @kbn/i18n-react package */ + FormattedRelative: typeof FormattedRelative; +} + +/** + * Kibana-specific Provider that maps to known dependency types. + */ +export const TableListViewKibanaProvider: FC = ({ + children, + ...services +}) => { + const { core, toMountPoint, savedObjectsTagging, FormattedRelative } = services; + + const getSearchBarFilters = useMemo(() => { + if (savedObjectsTagging) { + return () => [savedObjectsTagging.ui.getSearchBarFilter({ useName: true })]; + } + }, [savedObjectsTagging]); + + const searchQueryParser = useMemo(() => { + if (savedObjectsTagging) { + return (searchQuery: string) => { + const res = savedObjectsTagging.ui.parseSearchQuery(searchQuery, { useName: true }); + return { + searchQuery: res.searchTerm, + references: res.tagReferences, + }; + }; + } + }, [savedObjectsTagging]); + + return ( + + + core.application.getUrlForApp('management', { + path: `/kibana/settings?query=savedObjects:listingLimit`, + }) + } + notifyError={(title, text) => { + core.notifications.toasts.addDanger({ title: toMountPoint(title), text }); + }} + getTagsColumnDefinition={savedObjectsTagging?.ui.getTableColumnDefinition} + getSearchBarFilters={getSearchBarFilters} + searchQueryParser={searchQueryParser} + DateFormatterComp={(props) => } + currentAppId$={core.application.currentAppId$} + navigateToUrl={core.application.navigateToUrl} + > + {children} + + + ); +}; + +/** + * React hook for accessing pre-wired services. + */ +export function useServices() { + const context = useContext(TableListViewContext); + + if (!context) { + throw new Error( + 'TableListViewContext is missing. Ensure your component or React root is wrapped with or .' + ); + } + + return context; +} diff --git a/packages/content-management/table_list/src/table_list_view.stories.tsx b/packages/content-management/table_list/src/table_list_view.stories.tsx new file mode 100644 index 0000000000000..7b197c0fa1b5b --- /dev/null +++ b/packages/content-management/table_list/src/table_list_view.stories.tsx @@ -0,0 +1,108 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import React from 'react'; +import Chance from 'chance'; +import moment from 'moment'; +import { action } from '@storybook/addon-actions'; + +import { Params, getStoryArgTypes, getStoryServices } from './mocks'; + +import { TableListView as Component, UserContentCommonSchema } from './table_list_view'; +import { TableListViewProvider } from './services'; + +import mdx from '../README.mdx'; + +const chance = new Chance(); + +export default { + title: 'Table list view', + description: 'A table list to display user content saved objects', + parameters: { + docs: { + page: mdx, + }, + }, +}; + +const createMockItems = (total: number): UserContentCommonSchema[] => { + return [...Array(total)].map((_, i) => { + const type = itemTypes[Math.floor(Math.random() * 4)]; + + return { + id: i.toString(), + type, + references: [], + updatedAt: moment().subtract(i, 'day').format('YYYY-MM-DDTHH:mm:ss'), + attributes: { + title: chance.sentence({ words: 5 }), + description: `Description of item ${i}`, + }, + }; + }); +}; + +const argTypes = getStoryArgTypes(); +const itemTypes = ['foo', 'bar', 'baz', 'elastic']; +const mockItems: UserContentCommonSchema[] = createMockItems(500); + +export const ConnectedComponent = (params: Params) => { + return ( + + { + const hits = mockItems + .filter((_, i) => i < params.numberOfItemsToRender) + .filter((item) => item.attributes.title.includes(searchQuery)); + + return Promise.resolve({ + total: hits.length, + hits, + }); + }} + getDetailViewLink={() => 'http://elastic.co'} + createItem={ + params.canCreateItem + ? () => { + action('Create item')(); + } + : undefined + } + editItem={ + params.canEditItem + ? ({ attributes: { title } }) => { + action('Edit item')(title); + } + : undefined + } + deleteItems={ + params.canDeleteItem + ? async (items) => { + action('Delete item(s)')( + items.map(({ attributes: { title } }) => title).join(', ') + ); + } + : undefined + } + customTableColumn={ + params.showCustomColumn + ? { + field: 'attributes.type', + name: 'Type', + } + : undefined + } + {...params} + /> + + ); +}; + +ConnectedComponent.argTypes = argTypes; diff --git a/packages/content-management/table_list/src/table_list_view.test.tsx b/packages/content-management/table_list/src/table_list_view.test.tsx new file mode 100644 index 0000000000000..d5c0fda746bfe --- /dev/null +++ b/packages/content-management/table_list/src/table_list_view.test.tsx @@ -0,0 +1,309 @@ +/* + * 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 { EuiEmptyPrompt } from '@elastic/eui'; +import { registerTestBed, TestBed } from '@kbn/test-jest-helpers'; +import React, { useEffect } from 'react'; +import moment, { Moment } from 'moment'; +import { act } from 'react-dom/test-utils'; + +import { WithServices } from './__jest__'; +import { TableListView, Props as TableListViewProps } from './table_list_view'; + +const mockUseEffect = useEffect; + +jest.mock('lodash', () => { + const original = jest.requireActual('lodash'); + + return { + ...original, + debounce: (handler: () => void) => handler, + }; +}); + +jest.mock('react-use/lib/useDebounce', () => { + return (cb: () => void, ms: number, deps: any[]) => { + mockUseEffect(() => { + cb(); + }, deps); + }; +}); + +const requiredProps: TableListViewProps = { + entityName: 'test', + entityNamePlural: 'tests', + listingLimit: 500, + initialFilter: '', + initialPageSize: 20, + tableListTitle: 'test title', + findItems: jest.fn().mockResolvedValue({ total: 0, hits: [] }), + getDetailViewLink: () => 'http://elastic.co', +}; + +describe('TableListView', () => { + beforeAll(() => { + jest.useFakeTimers(); + }); + + afterAll(() => { + jest.useRealTimers(); + }); + + const setup = registerTestBed( + WithServices(TableListView), + { + defaultProps: { ...requiredProps }, + memoryRouter: { wrapComponent: false }, + } + ); + + test('render default empty prompt', async () => { + let testBed: TestBed; + + await act(async () => { + testBed = await setup(); + }); + + const { component, exists } = testBed!; + component.update(); + + expect(component.find(EuiEmptyPrompt).length).toBe(1); + expect(exists('newItemButton')).toBe(false); + }); + + // 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; + + await act(async () => { + testBed = await setup({ createItem: () => undefined }); + }); + + const { component, exists } = testBed!; + component.update(); + + expect(component.find(EuiEmptyPrompt).length).toBe(1); + expect(exists('newItemButton')).toBe(true); + }); + + test('render custom empty prompt', async () => { + let testBed: TestBed; + + const CustomEmptyPrompt = () => { + return Table empty} />; + }; + + await act(async () => { + testBed = await setup({ emptyPrompt: }); + }); + + const { component, exists } = testBed!; + component.update(); + + expect(exists('custom-empty-prompt')).toBe(true); + }); + + describe('default columns', () => { + const twoDaysAgo = new Date(new Date().setDate(new Date().getDate() - 2)); + 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 hits = [ + { + id: '123', + updatedAt: twoDaysAgo, + attributes: { + title: 'Item 1', + description: 'Item 1 description', + }, + }, + { + id: '456', + // This is the latest updated and should come first in the table + updatedAt: yesterday, + attributes: { + title: 'Item 2', + description: 'Item 2 description', + }, + }, + ]; + + test('should add a "Last updated" column if "updatedAt" is provided', async () => { + let testBed: TestBed; + + await act(async () => { + testBed = await setup({ + findItems: jest.fn().mockResolvedValue({ total: hits.length, hits }), + }); + }); + + const { component, table } = testBed!; + component.update(); + + const { tableCellsValues } = table.getMetaData('itemsInMemTable'); + + expect(tableCellsValues).toEqual([ + ['Item 2', 'Item 2 description', yesterdayToString], // Comes first as it is the latest updated + ['Item 1', 'Item 1 description', twoDaysAgoToString], + ]); + }); + + test('should not display relative time for items updated more than 7 days ago', async () => { + let testBed: TestBed; + + const updatedAtValues: Moment[] = []; + + const updatedHits = hits.map(({ id, attributes }, i) => { + const updatedAt = new Date(new Date().setDate(new Date().getDate() - (7 + i))); + updatedAtValues.push(moment(updatedAt)); + + return { + id, + updatedAt, + attributes, + }; + }); + + await act(async () => { + testBed = await setup({ + findItems: jest.fn().mockResolvedValue({ + total: updatedHits.length, + hits: updatedHits, + }), + }); + }); + + const { component, table } = testBed!; + component.update(); + + const { tableCellsValues } = table.getMetaData('itemsInMemTable'); + + expect(tableCellsValues).toEqual([ + // Renders the datetime with this format: "July 28, 2022" + ['Item 1', 'Item 1 description', updatedAtValues[0].format('LL')], + ['Item 2', 'Item 2 description', updatedAtValues[1].format('LL')], + ]); + }); + + test('should not add a "Last updated" column if no "updatedAt" is provided', async () => { + let testBed: TestBed; + + await act(async () => { + testBed = await setup({ + findItems: jest.fn().mockResolvedValue({ + total: hits.length, + // Not including the "updatedAt" metadata + hits: hits.map(({ attributes }) => ({ attributes })), + }), + }); + }); + + const { component, table } = testBed!; + component.update(); + + const { tableCellsValues } = table.getMetaData('itemsInMemTable'); + + expect(tableCellsValues).toEqual([ + ['Item 1', 'Item 1 description'], // Sorted by title + ['Item 2', 'Item 2 description'], + ]); + }); + + test('should not display anything if there is no updatedAt metadata for an item', async () => { + let testBed: TestBed; + + await act(async () => { + testBed = await setup({ + findItems: jest.fn().mockResolvedValue({ + total: hits.length + 1, + hits: [ + ...hits, + { id: '789', attributes: { title: 'Item 3', description: 'Item 3 description' } }, + ], + }), + }); + }); + + const { component, table } = testBed!; + component.update(); + + const { tableCellsValues } = table.getMetaData('itemsInMemTable'); + + expect(tableCellsValues).toEqual([ + ['Item 2', 'Item 2 description', yesterdayToString], + ['Item 1', 'Item 1 description', twoDaysAgoToString], + ['Item 3', 'Item 3 description', '-'], // Empty column as no updatedAt provided + ]); + }); + }); + + describe('pagination', () => { + const initialPageSize = 20; + const totalItems = 30; + + const hits = [...Array(totalItems)].map((_, i) => ({ + attributes: { + title: `Item ${i < 10 ? `0${i}` : i}`, // prefix with "0" for correct A-Z sorting + }, + })); + + const props = { + initialPageSize, + findItems: jest.fn().mockResolvedValue({ total: hits.length, hits }), + }; + + test('should limit the number of row to the `initialPageSize` provided', async () => { + let testBed: TestBed; + + await act(async () => { + testBed = await setup(props); + }); + + const { component, table } = testBed!; + component.update(); + + const { tableCellsValues } = table.getMetaData('itemsInMemTable'); + expect(tableCellsValues.length).toBe(requiredProps.initialPageSize); + + const [[firstRowTitle]] = tableCellsValues; + const [lastRowTitle] = tableCellsValues[tableCellsValues.length - 1]; + + expect(firstRowTitle).toBe('Item 00'); + expect(lastRowTitle).toBe('Item 19'); + }); + + test('should navigate to page 2', async () => { + let testBed: TestBed; + + await act(async () => { + testBed = await setup(props); + }); + + const { component, table } = testBed!; + component.update(); + + const pageLinks = component.find('.euiPagination__list .euiPagination__item'); + expect(pageLinks.length).toBe(Math.ceil(totalItems / initialPageSize)); + + act(() => { + // Click on page 2 + pageLinks.at(1).find('a').simulate('click'); + }); + component.update(); + + const { tableCellsValues } = table.getMetaData('itemsInMemTable'); + expect(tableCellsValues.length).toBe(totalItems - initialPageSize); + + const [[firstRowTitle]] = tableCellsValues; + const [lastRowTitle] = tableCellsValues[tableCellsValues.length - 1]; + + expect(firstRowTitle).toBe('Item 20'); + expect(lastRowTitle).toBe('Item 29'); + }); + }); +}); diff --git a/packages/content-management/table_list/src/table_list_view.tsx b/packages/content-management/table_list/src/table_list_view.tsx new file mode 100644 index 0000000000000..afa41885052e1 --- /dev/null +++ b/packages/content-management/table_list/src/table_list_view.tsx @@ -0,0 +1,526 @@ +/* + * 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, { + useReducer, + useCallback, + useEffect, + useRef, + useMemo, + ReactNode, + MouseEvent, +} from 'react'; +import useDebounce from 'react-use/lib/useDebounce'; +import { + EuiBasicTableColumn, + EuiButton, + EuiCallOut, + EuiEmptyPrompt, + Pagination, + Direction, + EuiSpacer, + EuiTableActionsColumnType, + EuiLink, +} from '@elastic/eui'; +import { keyBy, uniq, get } from 'lodash'; +import { i18n } from '@kbn/i18n'; +import { FormattedMessage } from '@kbn/i18n-react'; +import type { IHttpFetchError } from '@kbn/core-http-browser'; +import { KibanaPageTemplate } from '@kbn/shared-ux-page-kibana-template'; +import { RedirectAppLinks } from '@kbn/shared-ux-link-redirect-app'; + +import { Table, ConfirmDeleteModal, ListingLimitWarning } from './components'; +import { useServices } from './services'; +import type { SavedObjectsReference, SavedObjectsFindOptionsReference } from './services'; +import type { Action } from './actions'; +import { getReducer } from './reducer'; + +export interface Props { + entityName: string; + entityNamePlural: string; + tableListTitle: string; + listingLimit: number; + initialFilter: string; + initialPageSize: number; + emptyPrompt?: JSX.Element; + /** Add an additional custom column */ + customTableColumn?: EuiBasicTableColumn; + /** + * Id of the heading element describing the table. This id will be used as `aria-labelledby` of the wrapper element. + * If the table is not empty, this component renders its own h1 element using the same id. + */ + headingId?: string; + /** An optional id for the listing. Used to generate unique data-test-subj. Default: "userContent" */ + id?: string; + children?: ReactNode | undefined; + findItems( + searchQuery: string, + references?: SavedObjectsFindOptionsReference[] + ): Promise<{ total: number; hits: T[] }>; + /** Handler to set the item title "href" value. If it returns undefined there won't be a link for this item. */ + getDetailViewLink?: (entity: T) => string | undefined; + /** Handler to execute when clicking the item title */ + onClickTitle?: (item: T) => void; + createItem?(): void; + deleteItems?(items: T[]): Promise; + editItem?(item: T): void; +} + +export interface State { + items: T[]; + hasInitialFetchReturned: boolean; + isFetchingItems: boolean; + isDeletingItems: boolean; + showDeleteModal: boolean; + fetchError?: IHttpFetchError; + searchQuery: string; + selectedIds: string[]; + totalItems: number; + tableColumns: Array>; + pagination: Pagination; + tableSort?: { + field: keyof T; + direction: Direction; + }; +} + +export interface UserContentCommonSchema { + id: string; + updatedAt: string; + references: SavedObjectsReference[]; + type: string; + attributes: { + title: string; + description?: string; + }; +} + +function TableListViewComp({ + tableListTitle, + entityName, + entityNamePlural, + initialFilter: initialQuery, + headingId, + initialPageSize, + listingLimit, + customTableColumn, + emptyPrompt, + findItems, + createItem, + editItem, + deleteItems, + getDetailViewLink, + onClickTitle, + id = 'userContent', + children, +}: Props) { + if (!getDetailViewLink && !onClickTitle) { + throw new Error( + `[TableListView] One o["getDetailViewLink" or "onClickTitle"] prop must be provided.` + ); + } + + if (getDetailViewLink && onClickTitle) { + throw new Error( + `[TableListView] Either "getDetailViewLink" or "onClickTitle" can be provided. Not both.` + ); + } + + const isMounted = useRef(false); + const fetchIdx = useRef(0); + + const { + canEditAdvancedSettings, + getListingLimitSettingsUrl, + getTagsColumnDefinition, + searchQueryParser, + notifyError, + DateFormatterComp, + navigateToUrl, + currentAppId$, + } = useServices(); + + const reducer = useMemo(() => { + return getReducer({ DateFormatterComp }); + }, [DateFormatterComp]); + + const redirectAppLinksCoreStart = useMemo( + () => ({ + application: { + navigateToUrl, + currentAppId$, + }, + }), + [navigateToUrl, currentAppId$] + ); + + const [state, dispatch] = useReducer<(state: State, action: Action) => State>(reducer, { + items: [], + totalItems: 0, + hasInitialFetchReturned: false, + isFetchingItems: false, + isDeletingItems: false, + showDeleteModal: false, + selectedIds: [], + tableColumns: [ + { + field: 'attributes.title', + name: i18n.translate('contentManagement.tableList.titleColumnName', { + defaultMessage: 'Title', + }), + sortable: true, + render: (field: keyof T, record: T) => { + // The validation is handled at the top of the component + const href = getDetailViewLink ? getDetailViewLink(record) : undefined; + + if (!href && !onClickTitle) { + // This item is not clickable + return {record.attributes.title}; + } + + return ( + + {/* eslint-disable-next-line @elastic/eui/href-or-on-click */} + { + e.preventDefault(); + onClickTitle(record); + } + : undefined + } + data-test-subj={`${id}ListingTitleLink-${record.attributes.title + .split(' ') + .join('-')}`} + > + {record.attributes.title} + + + ); + }, + }, + { + field: 'attributes.description', + name: i18n.translate('contentManagement.tableList.descriptionColumnName', { + defaultMessage: 'Description', + }), + }, + ], + searchQuery: initialQuery, + pagination: { + pageIndex: 0, + totalItemCount: 0, + pageSize: initialPageSize, + pageSizeOptions: uniq([10, 20, 50, initialPageSize]).sort(), + }, + }); + + const { + searchQuery, + hasInitialFetchReturned, + isFetchingItems, + items, + fetchError, + showDeleteModal, + isDeletingItems, + selectedIds, + totalItems, + tableColumns: stateTableColumns, + pagination, + tableSort, + } = state; + const hasNoItems = !isFetchingItems && items.length === 0 && !searchQuery; + const pageDataTestSubject = `${entityName}LandingPage`; + const showFetchError = Boolean(fetchError); + const showLimitError = !showFetchError && totalItems > listingLimit; + + const tableColumns = useMemo(() => { + const columns = stateTableColumns.slice(); + + if (customTableColumn) { + columns.push(customTableColumn); + } + + const tagsColumnDef = getTagsColumnDefinition ? getTagsColumnDefinition() : undefined; + if (tagsColumnDef) { + columns.push(tagsColumnDef); + } + + // Add "Actions" column + if (editItem) { + const actions: EuiTableActionsColumnType['actions'] = [ + { + name: (item) => { + return i18n.translate('contentManagement.tableList.listing.table.editActionName', { + defaultMessage: 'Edit {itemDescription}', + values: { + itemDescription: get(item, 'attributes.title'), + }, + }); + }, + description: i18n.translate( + 'contentManagement.tableList.listing.table.editActionDescription', + { + defaultMessage: 'Edit', + } + ), + icon: 'pencil', + type: 'icon', + enabled: (v) => !(v as unknown as { error: string })?.error, + onClick: editItem, + }, + ]; + + columns.push({ + name: i18n.translate('contentManagement.tableList.listing.table.actionTitle', { + defaultMessage: 'Actions', + }), + width: '100px', + actions, + }); + } + + return columns; + }, [stateTableColumns, customTableColumn, getTagsColumnDefinition, editItem]); + + const itemsById = useMemo(() => { + return keyBy(items, 'id'); + }, [items]); + + const selectedItems = useMemo(() => { + return selectedIds.map((selectedId) => itemsById[selectedId]); + }, [selectedIds, itemsById]); + + // ------------ + // Callbacks + // ------------ + const fetchItems = useCallback(async () => { + dispatch({ type: 'onFetchItems' }); + + try { + const idx = ++fetchIdx.current; + + const { searchQuery: searchQueryParsed, references } = searchQueryParser + ? searchQueryParser(searchQuery) + : { searchQuery, references: undefined }; + + const response = await findItems(searchQueryParsed, references); + + if (!isMounted.current) { + return; + } + + if (idx === fetchIdx.current) { + dispatch({ + type: 'onFetchItemsSuccess', + data: { + response, + }, + }); + } + } catch (err) { + dispatch({ + type: 'onFetchItemsError', + data: err, + }); + } + }, [searchQueryParser, searchQuery, findItems]); + + const deleteSelectedItems = useCallback(async () => { + if (isDeletingItems) { + return; + } + + dispatch({ type: 'onDeleteItems' }); + + try { + await deleteItems!(selectedItems); + } catch (error) { + notifyError( + , + error + ); + } + + fetchItems(); + + dispatch({ type: 'onItemsDeleted' }); + }, [deleteItems, entityName, fetchItems, isDeletingItems, notifyError, selectedItems]); + + const renderCreateButton = useCallback(() => { + if (createItem) { + return ( + + + + ); + } + }, [createItem, entityName]); + + const renderNoItemsMessage = useCallback(() => { + if (emptyPrompt) { + return emptyPrompt; + } else { + return ( + + { + + } + + } + actions={renderCreateButton()} + /> + ); + } + }, [emptyPrompt, entityNamePlural, renderCreateButton]); + + const renderFetchError = useCallback(() => { + return ( + + + } + color="danger" + iconType="alert" + > +

+ +

+ + + + ); + }, [entityName, fetchError]); + + // ------------ + // Effects + // ------------ + useDebounce(fetchItems, 300, [fetchItems]); + + useEffect(() => { + isMounted.current = true; + + return () => { + isMounted.current = false; + }; + }, []); + + // ------------ + // Render + // ------------ + if (!hasInitialFetchReturned) { + return null; + } + + if (!fetchError && hasNoItems) { + return ( + + + {renderNoItemsMessage()} + + + ); + } + + return ( + + {tableListTitle}} + rightSideItems={[renderCreateButton() ?? ]} + data-test-subj="top-nav" + /> + + {/* Any children passed to the component */} + {children} + + {/* Too many items error */} + {showLimitError && ( + + )} + + {/* Error while fetching items */} + {showFetchError && renderFetchError()} + + {/* Table of items */} + + dispatch={dispatch} + items={items} + isFetchingItems={isFetchingItems} + searchQuery={searchQuery} + tableColumns={tableColumns} + tableSort={tableSort} + pagination={pagination} + selectedIds={selectedIds} + entityName={entityName} + entityNamePlural={entityNamePlural} + deleteItems={deleteItems} + tableCaption={tableListTitle} + /> + + {/* Delete modal */} + {showDeleteModal && ( + + isDeletingItems={isDeletingItems} + entityName={entityName} + entityNamePlural={entityNamePlural} + items={selectedItems} + onConfirm={deleteSelectedItems} + onCancel={() => dispatch({ type: 'onCancelDeleteItems' })} + /> + )} + + + ); +} + +const TableListView = React.memo(TableListViewComp) as typeof TableListViewComp; + +export { TableListView }; + +// eslint-disable-next-line import/no-default-export +export default TableListView; diff --git a/packages/content-management/table_list/tsconfig.json b/packages/content-management/table_list/tsconfig.json new file mode 100644 index 0000000000000..f9da39a3d7eb9 --- /dev/null +++ b/packages/content-management/table_list/tsconfig.json @@ -0,0 +1,21 @@ +{ + "extends": "../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "declarationMap": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "stripInternal": false, + "types": [ + "jest", + "node", + "react", + "@kbn/ambient-ui-types", + "@kbn/ambient-storybook-types" + ] + }, + "include": [ + "**/*.ts", + "**/*.tsx", + ] +} diff --git a/packages/core/apps/core-apps-browser-internal/BUILD.bazel b/packages/core/apps/core-apps-browser-internal/BUILD.bazel new file mode 100644 index 0000000000000..4ca5c1a1cf2af --- /dev/null +++ b/packages/core/apps/core-apps-browser-internal/BUILD.bazel @@ -0,0 +1,137 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "core-apps-browser-internal" +PKG_REQUIRE_NAME = "@kbn/core-apps-browser-internal" + +SOURCE_FILES = glob( + [ + "**/*.ts", + "**/*.tsx", + ], + exclude = [ + "**/*.config.js", + "**/*.mock.*", + "**/*.test.*", + "**/*.stories.*", + "**/__snapshots__/**", + "**/integration_tests/**", + "**/mocks/**", + "**/scripts/**", + "**/storybook/**", + "**/test_fixtures/**", + "**/test_helpers/**", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +RUNTIME_DEPS = [ + "@npm//react", + "@npm//react-dom", + "@npm//history", + "@npm//@elastic/eui", + "//packages/kbn-i18n", + "//packages/kbn-i18n-react", + "//packages/core/mount-utils/core-mount-utils-browser-internal", +] + +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", + "@npm//@types/react", + "@npm//@types/react-dom", + "@npm//@types/history", + "@npm//@elastic/eui", + "//packages/kbn-i18n:npm_module_types", + "//packages/kbn-i18n-react:npm_module_types", + "//packages/core/base/core-base-browser-internal:npm_module_types", + "//packages/core/injected-metadata/core-injected-metadata-browser-internal:npm_module_types", + "//packages/core/doc-links/core-doc-links-browser:npm_module_types", + "//packages/core/http/core-http-browser:npm_module_types", + "//packages/core/ui-settings/core-ui-settings-browser:npm_module_types", + "//packages/core/notifications/core-notifications-browser:npm_module_types", + "//packages/core/application/core-application-browser:npm_module_types", + "//packages/core/application/core-application-browser-internal:npm_module_types", + "//packages/core/theme/core-theme-browser-internal:npm_module_types", + "//packages/core/mount-utils/core-mount-utils-browser-internal:npm_module_types", + "//packages/core/status/core-status-common-internal:npm_module_types", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +jsts_transpiler( + name = "target_web", + srcs = SRCS, + build_pkg_name = package_name(), + web = True, +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + declaration_map = True, + emit_declaration_only = True, + out_dir = "target_types", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node", ":target_web"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/core/apps/core-apps-browser-internal/README.md b/packages/core/apps/core-apps-browser-internal/README.md new file mode 100644 index 0000000000000..8412844a911df --- /dev/null +++ b/packages/core/apps/core-apps-browser-internal/README.md @@ -0,0 +1,3 @@ +# @kbn/core-apps-browser-internal + +This package contains the internal types and implementation of Core's `coreApps` service. diff --git a/packages/core/apps/core-apps-browser-internal/index.ts b/packages/core/apps/core-apps-browser-internal/index.ts new file mode 100644 index 0000000000000..35678cd2a19fd --- /dev/null +++ b/packages/core/apps/core-apps-browser-internal/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 { CoreAppsService, URL_MAX_LENGTH } from './src'; +export type { CoreAppsServiceSetupDeps, CoreAppsServiceStartDeps } from './src'; diff --git a/packages/core/apps/core-apps-browser-internal/jest.config.js b/packages/core/apps/core-apps-browser-internal/jest.config.js new file mode 100644 index 0000000000000..80df7f644eab5 --- /dev/null +++ b/packages/core/apps/core-apps-browser-internal/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test', + rootDir: '../../../..', + roots: ['/packages/core/apps/core-apps-browser-internal'], +}; diff --git a/packages/core/apps/core-apps-browser-internal/kibana.jsonc b/packages/core/apps/core-apps-browser-internal/kibana.jsonc new file mode 100644 index 0000000000000..552de143ce1de --- /dev/null +++ b/packages/core/apps/core-apps-browser-internal/kibana.jsonc @@ -0,0 +1,7 @@ +{ + "type": "shared-common", + "id": "@kbn/core-apps-browser-internal", + "owner": "@elastic/kibana-core", + "runtimeDeps": [], + "typeDeps": [] +} diff --git a/packages/core/apps/core-apps-browser-internal/package.json b/packages/core/apps/core-apps-browser-internal/package.json new file mode 100644 index 0000000000000..58262f9a7aaeb --- /dev/null +++ b/packages/core/apps/core-apps-browser-internal/package.json @@ -0,0 +1,9 @@ +{ + "name": "@kbn/core-apps-browser-internal", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "browser": "./target_web/index.js", + "author": "Kibana Core", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/src/core/public/core_app/core_app.ts b/packages/core/apps/core-apps-browser-internal/src/core_app.ts similarity index 91% rename from src/core/public/core_app/core_app.ts rename to packages/core/apps/core-apps-browser-internal/src/core_app.ts index 7b4fd29011b9b..e8a61de40bea2 100644 --- a/src/core/public/core_app/core_app.ts +++ b/packages/core/apps/core-apps-browser-internal/src/core_app.ts @@ -25,14 +25,14 @@ import { } from './errors'; import { renderApp as renderStatusApp } from './status'; -export interface SetupDeps { +export interface CoreAppsServiceSetupDeps { application: InternalApplicationSetup; http: HttpSetup; injectedMetadata: InternalInjectedMetadataSetup; notifications: NotificationsSetup; } -export interface StartDeps { +export interface CoreAppsServiceStartDeps { application: InternalApplicationStart; docLinks: DocLinksStart; http: HttpStart; @@ -40,12 +40,12 @@ export interface StartDeps { uiSettings: IUiSettingsClient; } -export class CoreApp { +export class CoreAppsService { private stopHistoryListening?: UnregisterCallback; constructor(private readonly coreContext: CoreContext) {} - public setup({ application, http, injectedMetadata, notifications }: SetupDeps) { + public setup({ application, http, injectedMetadata, notifications }: CoreAppsServiceSetupDeps) { application.register(this.coreContext.coreId, { id: 'error', title: 'App Error', @@ -73,7 +73,13 @@ export class CoreApp { }); } - public start({ application, docLinks, http, notifications, uiSettings }: StartDeps) { + public start({ + application, + docLinks, + http, + notifications, + uiSettings, + }: CoreAppsServiceStartDeps) { if (!application.history) { return; } diff --git a/src/core/public/core_app/errors/error_application.test.ts b/packages/core/apps/core-apps-browser-internal/src/errors/error_application.test.ts similarity index 100% rename from src/core/public/core_app/errors/error_application.test.ts rename to packages/core/apps/core-apps-browser-internal/src/errors/error_application.test.ts diff --git a/src/core/public/core_app/errors/error_application.tsx b/packages/core/apps/core-apps-browser-internal/src/errors/error_application.tsx similarity index 100% rename from src/core/public/core_app/errors/error_application.tsx rename to packages/core/apps/core-apps-browser-internal/src/errors/error_application.tsx diff --git a/src/core/public/core_app/errors/index.ts b/packages/core/apps/core-apps-browser-internal/src/errors/index.ts similarity index 100% rename from src/core/public/core_app/errors/index.ts rename to packages/core/apps/core-apps-browser-internal/src/errors/index.ts diff --git a/src/core/public/core_app/errors/public_base_url.test.tsx b/packages/core/apps/core-apps-browser-internal/src/errors/public_base_url.test.tsx similarity index 100% rename from src/core/public/core_app/errors/public_base_url.test.tsx rename to packages/core/apps/core-apps-browser-internal/src/errors/public_base_url.test.tsx diff --git a/src/core/public/core_app/errors/public_base_url.tsx b/packages/core/apps/core-apps-browser-internal/src/errors/public_base_url.tsx similarity index 95% rename from src/core/public/core_app/errors/public_base_url.tsx rename to packages/core/apps/core-apps-browser-internal/src/errors/public_base_url.tsx index f86903f3c185f..ec5f45930ce22 100644 --- a/src/core/public/core_app/errors/public_base_url.tsx +++ b/packages/core/apps/core-apps-browser-internal/src/errors/public_base_url.tsx @@ -12,8 +12,9 @@ import { i18n } from '@kbn/i18n'; import { FormattedMessage } from '@kbn/i18n-react'; import type { DocLinksStart } from '@kbn/core-doc-links-browser'; +import type { HttpStart } from '@kbn/core-http-browser'; +import type { NotificationsStart } from '@kbn/core-notifications-browser'; import { mountReactNode } from '@kbn/core-mount-utils-browser-internal'; -import type { HttpStart, NotificationsStart } from '../..'; /** Only exported for tests */ export const MISSING_CONFIG_STORAGE_KEY = `core.warnings.publicBaseUrlMissingDismissed`; diff --git a/src/core/public/core_app/errors/url_overflow.test.ts b/packages/core/apps/core-apps-browser-internal/src/errors/url_overflow.test.ts similarity index 100% rename from src/core/public/core_app/errors/url_overflow.test.ts rename to packages/core/apps/core-apps-browser-internal/src/errors/url_overflow.test.ts diff --git a/src/core/public/core_app/errors/url_overflow.tsx b/packages/core/apps/core-apps-browser-internal/src/errors/url_overflow.tsx similarity index 100% rename from src/core/public/core_app/errors/url_overflow.tsx rename to packages/core/apps/core-apps-browser-internal/src/errors/url_overflow.tsx diff --git a/src/core/public/core_app/errors/url_overflow_ui.tsx b/packages/core/apps/core-apps-browser-internal/src/errors/url_overflow_ui.tsx similarity index 100% rename from src/core/public/core_app/errors/url_overflow_ui.tsx rename to packages/core/apps/core-apps-browser-internal/src/errors/url_overflow_ui.tsx diff --git a/packages/core/apps/core-apps-browser-internal/src/index.ts b/packages/core/apps/core-apps-browser-internal/src/index.ts new file mode 100644 index 0000000000000..d0bb30144b7db --- /dev/null +++ b/packages/core/apps/core-apps-browser-internal/src/index.ts @@ -0,0 +1,11 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export { CoreAppsService } from './core_app'; +export { URL_MAX_LENGTH } from './errors'; +export type { CoreAppsServiceSetupDeps, CoreAppsServiceStartDeps } from './core_app'; diff --git a/src/core/public/core_app/status/components/__snapshots__/metric_tiles.test.tsx.snap b/packages/core/apps/core-apps-browser-internal/src/status/components/__snapshots__/metric_tiles.test.tsx.snap similarity index 100% rename from src/core/public/core_app/status/components/__snapshots__/metric_tiles.test.tsx.snap rename to packages/core/apps/core-apps-browser-internal/src/status/components/__snapshots__/metric_tiles.test.tsx.snap diff --git a/src/core/public/core_app/status/components/__snapshots__/server_status.test.tsx.snap b/packages/core/apps/core-apps-browser-internal/src/status/components/__snapshots__/server_status.test.tsx.snap similarity index 100% rename from src/core/public/core_app/status/components/__snapshots__/server_status.test.tsx.snap rename to packages/core/apps/core-apps-browser-internal/src/status/components/__snapshots__/server_status.test.tsx.snap diff --git a/src/core/public/core_app/status/components/__snapshots__/status_table.test.tsx.snap b/packages/core/apps/core-apps-browser-internal/src/status/components/__snapshots__/status_table.test.tsx.snap similarity index 100% rename from src/core/public/core_app/status/components/__snapshots__/status_table.test.tsx.snap rename to packages/core/apps/core-apps-browser-internal/src/status/components/__snapshots__/status_table.test.tsx.snap diff --git a/src/core/public/core_app/status/components/index.ts b/packages/core/apps/core-apps-browser-internal/src/status/components/index.ts similarity index 100% rename from src/core/public/core_app/status/components/index.ts rename to packages/core/apps/core-apps-browser-internal/src/status/components/index.ts diff --git a/src/core/public/core_app/status/components/metric_tiles.test.tsx b/packages/core/apps/core-apps-browser-internal/src/status/components/metric_tiles.test.tsx similarity index 100% rename from src/core/public/core_app/status/components/metric_tiles.test.tsx rename to packages/core/apps/core-apps-browser-internal/src/status/components/metric_tiles.test.tsx diff --git a/src/core/public/core_app/status/components/metric_tiles.tsx b/packages/core/apps/core-apps-browser-internal/src/status/components/metric_tiles.tsx similarity index 100% rename from src/core/public/core_app/status/components/metric_tiles.tsx rename to packages/core/apps/core-apps-browser-internal/src/status/components/metric_tiles.tsx diff --git a/src/core/public/core_app/status/components/server_status.test.tsx b/packages/core/apps/core-apps-browser-internal/src/status/components/server_status.test.tsx similarity index 100% rename from src/core/public/core_app/status/components/server_status.test.tsx rename to packages/core/apps/core-apps-browser-internal/src/status/components/server_status.test.tsx diff --git a/src/core/public/core_app/status/components/server_status.tsx b/packages/core/apps/core-apps-browser-internal/src/status/components/server_status.tsx similarity index 100% rename from src/core/public/core_app/status/components/server_status.tsx rename to packages/core/apps/core-apps-browser-internal/src/status/components/server_status.tsx diff --git a/src/core/public/core_app/status/components/status_badge.test.tsx b/packages/core/apps/core-apps-browser-internal/src/status/components/status_badge.test.tsx similarity index 100% rename from src/core/public/core_app/status/components/status_badge.test.tsx rename to packages/core/apps/core-apps-browser-internal/src/status/components/status_badge.test.tsx diff --git a/src/core/public/core_app/status/components/status_badge.tsx b/packages/core/apps/core-apps-browser-internal/src/status/components/status_badge.tsx similarity index 100% rename from src/core/public/core_app/status/components/status_badge.tsx rename to packages/core/apps/core-apps-browser-internal/src/status/components/status_badge.tsx diff --git a/src/core/public/core_app/status/components/status_expanded_row.tsx b/packages/core/apps/core-apps-browser-internal/src/status/components/status_expanded_row.tsx similarity index 100% rename from src/core/public/core_app/status/components/status_expanded_row.tsx rename to packages/core/apps/core-apps-browser-internal/src/status/components/status_expanded_row.tsx diff --git a/src/core/public/core_app/status/components/status_section.tsx b/packages/core/apps/core-apps-browser-internal/src/status/components/status_section.tsx similarity index 100% rename from src/core/public/core_app/status/components/status_section.tsx rename to packages/core/apps/core-apps-browser-internal/src/status/components/status_section.tsx diff --git a/src/core/public/core_app/status/components/status_table.test.tsx b/packages/core/apps/core-apps-browser-internal/src/status/components/status_table.test.tsx similarity index 100% rename from src/core/public/core_app/status/components/status_table.test.tsx rename to packages/core/apps/core-apps-browser-internal/src/status/components/status_table.test.tsx diff --git a/src/core/public/core_app/status/components/status_table.tsx b/packages/core/apps/core-apps-browser-internal/src/status/components/status_table.tsx similarity index 100% rename from src/core/public/core_app/status/components/status_table.tsx rename to packages/core/apps/core-apps-browser-internal/src/status/components/status_table.tsx diff --git a/src/core/public/core_app/status/components/version_header.test.tsx b/packages/core/apps/core-apps-browser-internal/src/status/components/version_header.test.tsx similarity index 100% rename from src/core/public/core_app/status/components/version_header.test.tsx rename to packages/core/apps/core-apps-browser-internal/src/status/components/version_header.test.tsx diff --git a/src/core/public/core_app/status/components/version_header.tsx b/packages/core/apps/core-apps-browser-internal/src/status/components/version_header.tsx similarity index 100% rename from src/core/public/core_app/status/components/version_header.tsx rename to packages/core/apps/core-apps-browser-internal/src/status/components/version_header.tsx diff --git a/src/core/public/core_app/status/index.ts b/packages/core/apps/core-apps-browser-internal/src/status/index.ts similarity index 100% rename from src/core/public/core_app/status/index.ts rename to packages/core/apps/core-apps-browser-internal/src/status/index.ts diff --git a/src/core/public/core_app/status/lib/format_number.test.ts b/packages/core/apps/core-apps-browser-internal/src/status/lib/format_number.test.ts similarity index 100% rename from src/core/public/core_app/status/lib/format_number.test.ts rename to packages/core/apps/core-apps-browser-internal/src/status/lib/format_number.test.ts diff --git a/src/core/public/core_app/status/lib/format_number.ts b/packages/core/apps/core-apps-browser-internal/src/status/lib/format_number.ts similarity index 100% rename from src/core/public/core_app/status/lib/format_number.ts rename to packages/core/apps/core-apps-browser-internal/src/status/lib/format_number.ts diff --git a/src/core/public/core_app/status/lib/index.ts b/packages/core/apps/core-apps-browser-internal/src/status/lib/index.ts similarity index 100% rename from src/core/public/core_app/status/lib/index.ts rename to packages/core/apps/core-apps-browser-internal/src/status/lib/index.ts diff --git a/src/core/public/core_app/status/lib/load_status.test.ts b/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.test.ts similarity index 100% rename from src/core/public/core_app/status/lib/load_status.test.ts rename to packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.test.ts diff --git a/src/core/public/core_app/status/lib/load_status.ts b/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts similarity index 99% rename from src/core/public/core_app/status/lib/load_status.ts rename to packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts index 5a4b2b5907ea2..c3ebd9923e2a8 100644 --- a/src/core/public/core_app/status/lib/load_status.ts +++ b/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts @@ -14,7 +14,7 @@ import type { StatusResponse, StatusInfoServiceStatus as ServiceStatus, } from '@kbn/core-status-common-internal'; -import type { DataType } from '.'; +import type { DataType } from './format_number'; interface MetricMeta { title: string; diff --git a/src/core/public/core_app/status/lib/status_level.test.ts b/packages/core/apps/core-apps-browser-internal/src/status/lib/status_level.test.ts similarity index 100% rename from src/core/public/core_app/status/lib/status_level.test.ts rename to packages/core/apps/core-apps-browser-internal/src/status/lib/status_level.test.ts diff --git a/src/core/public/core_app/status/lib/status_level.ts b/packages/core/apps/core-apps-browser-internal/src/status/lib/status_level.ts similarity index 100% rename from src/core/public/core_app/status/lib/status_level.ts rename to packages/core/apps/core-apps-browser-internal/src/status/lib/status_level.ts diff --git a/src/core/public/core_app/status/render_app.tsx b/packages/core/apps/core-apps-browser-internal/src/status/render_app.tsx similarity index 100% rename from src/core/public/core_app/status/render_app.tsx rename to packages/core/apps/core-apps-browser-internal/src/status/render_app.tsx diff --git a/src/core/public/core_app/status/status_app.tsx b/packages/core/apps/core-apps-browser-internal/src/status/status_app.tsx similarity index 100% rename from src/core/public/core_app/status/status_app.tsx rename to packages/core/apps/core-apps-browser-internal/src/status/status_app.tsx diff --git a/packages/core/apps/core-apps-browser-internal/tsconfig.json b/packages/core/apps/core-apps-browser-internal/tsconfig.json new file mode 100644 index 0000000000000..2249e2ee93761 --- /dev/null +++ b/packages/core/apps/core-apps-browser-internal/tsconfig.json @@ -0,0 +1,19 @@ +{ + "extends": "../../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "declarationMap": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "stripInternal": false, + "types": [ + "jest", + "node", + "react" + ] + }, + "include": [ + "**/*.ts", + "**/*.tsx", + ] +} diff --git a/packages/core/apps/core-apps-browser-mocks/BUILD.bazel b/packages/core/apps/core-apps-browser-mocks/BUILD.bazel new file mode 100644 index 0000000000000..42c29b72766b9 --- /dev/null +++ b/packages/core/apps/core-apps-browser-mocks/BUILD.bazel @@ -0,0 +1,115 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "core-apps-browser-mocks" +PKG_REQUIRE_NAME = "@kbn/core-apps-browser-mocks" + +SOURCE_FILES = glob( + [ + "**/*.ts", + "**/*.tsx", + ], + exclude = [ + "**/*.config.js", + "**/*.test.*", + "**/*.stories.*", + "**/__snapshots__/**", + "**/integration_tests/**", + "**/mocks/**", + "**/scripts/**", + "**/storybook/**", + "**/test_fixtures/**", + "**/test_helpers/**", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +RUNTIME_DEPS = [ + "@npm//react" +] + +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", + "//packages/kbn-utility-types:npm_module_types", + "//packages/core/apps/core-apps-browser-internal:npm_module_types", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +jsts_transpiler( + name = "target_web", + srcs = SRCS, + build_pkg_name = package_name(), + web = True, +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + declaration_map = True, + emit_declaration_only = True, + out_dir = "target_types", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node", ":target_web"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/core/apps/core-apps-browser-mocks/README.md b/packages/core/apps/core-apps-browser-mocks/README.md new file mode 100644 index 0000000000000..5ae368e814c43 --- /dev/null +++ b/packages/core/apps/core-apps-browser-mocks/README.md @@ -0,0 +1,4 @@ +# @kbn/core-apps-browser-mocks + +This package contains mocks for Core's browser-side `coreApps` service. +- `coreAppsMock` diff --git a/packages/core/apps/core-apps-browser-mocks/index.ts b/packages/core/apps/core-apps-browser-mocks/index.ts new file mode 100644 index 0000000000000..68289764ac3e8 --- /dev/null +++ b/packages/core/apps/core-apps-browser-mocks/index.ts @@ -0,0 +1,9 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export { coreAppsMock } from './src'; diff --git a/packages/core/apps/core-apps-browser-mocks/jest.config.js b/packages/core/apps/core-apps-browser-mocks/jest.config.js new file mode 100644 index 0000000000000..f797f04d42061 --- /dev/null +++ b/packages/core/apps/core-apps-browser-mocks/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test', + rootDir: '../../../..', + roots: ['/packages/core/apps/core-apps-browser-mocks'], +}; diff --git a/packages/core/apps/core-apps-browser-mocks/kibana.jsonc b/packages/core/apps/core-apps-browser-mocks/kibana.jsonc new file mode 100644 index 0000000000000..074993f2bd62b --- /dev/null +++ b/packages/core/apps/core-apps-browser-mocks/kibana.jsonc @@ -0,0 +1,7 @@ +{ + "type": "shared-common", + "id": "@kbn/core-apps-browser-mocks", + "owner": "@elastic/kibana-core", + "runtimeDeps": [], + "typeDeps": [] +} diff --git a/packages/core/apps/core-apps-browser-mocks/package.json b/packages/core/apps/core-apps-browser-mocks/package.json new file mode 100644 index 0000000000000..486f6445a8b24 --- /dev/null +++ b/packages/core/apps/core-apps-browser-mocks/package.json @@ -0,0 +1,9 @@ +{ + "name": "@kbn/core-apps-browser-mocks", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "browser": "./target_web/index.js", + "author": "Kibana Core", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/src/core/public/core_app/core_app.mock.ts b/packages/core/apps/core-apps-browser-mocks/src/core_app.mock.ts similarity index 77% rename from src/core/public/core_app/core_app.mock.ts rename to packages/core/apps/core-apps-browser-mocks/src/core_app.mock.ts index 04a4eefa0d25f..fb5a3b54ad591 100644 --- a/src/core/public/core_app/core_app.mock.ts +++ b/packages/core/apps/core-apps-browser-mocks/src/core_app.mock.ts @@ -7,15 +7,16 @@ */ import type { PublicMethodsOf } from '@kbn/utility-types'; -import { CoreApp } from './core_app'; +import type { CoreAppsService } from '@kbn/core-apps-browser-internal'; + +type CoreAppContract = PublicMethodsOf; -type CoreAppContract = PublicMethodsOf; const createMock = (): jest.Mocked => ({ setup: jest.fn(), start: jest.fn(), stop: jest.fn(), }); -export const coreAppMock = { +export const coreAppsMock = { create: createMock, }; diff --git a/packages/core/apps/core-apps-browser-mocks/src/index.ts b/packages/core/apps/core-apps-browser-mocks/src/index.ts new file mode 100644 index 0000000000000..7afedc3d90fcf --- /dev/null +++ b/packages/core/apps/core-apps-browser-mocks/src/index.ts @@ -0,0 +1,9 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export { coreAppsMock } from './core_app.mock'; diff --git a/packages/core/apps/core-apps-browser-mocks/tsconfig.json b/packages/core/apps/core-apps-browser-mocks/tsconfig.json new file mode 100644 index 0000000000000..26b4c7aca3a67 --- /dev/null +++ b/packages/core/apps/core-apps-browser-mocks/tsconfig.json @@ -0,0 +1,18 @@ +{ + "extends": "../../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "declarationMap": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "**/*.ts", + "**/*.tsx", + ] +} diff --git a/packages/core/elasticsearch/core-elasticsearch-client-server-internal/index.ts b/packages/core/elasticsearch/core-elasticsearch-client-server-internal/index.ts index 819f2b0381550..158af330fcb73 100644 --- a/packages/core/elasticsearch/core-elasticsearch-client-server-internal/index.ts +++ b/packages/core/elasticsearch/core-elasticsearch-client-server-internal/index.ts @@ -9,6 +9,7 @@ export { ScopedClusterClient } from './src/scoped_cluster_client'; export { ClusterClient } from './src/cluster_client'; export { configureClient } from './src/configure_client'; +export { AgentManager } from './src/agent_manager'; export { getRequestDebugMeta, getErrorMessage } from './src/log_query_and_deprecation'; export { PRODUCT_RESPONSE_HEADER, diff --git a/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/agent_manager.test.ts b/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/agent_manager.test.ts new file mode 100644 index 0000000000000..b8b218db3d8fd --- /dev/null +++ b/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/agent_manager.test.ts @@ -0,0 +1,125 @@ +/* + * 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 { AgentManager } from './agent_manager'; +import { Agent as HttpAgent } from 'http'; +import { Agent as HttpsAgent } from 'https'; + +jest.mock('http'); +jest.mock('https'); + +const HttpAgentMock = HttpAgent as jest.Mock; +const HttpsAgentMock = HttpsAgent as jest.Mock; + +describe('AgentManager', () => { + afterEach(() => { + HttpAgentMock.mockClear(); + HttpsAgentMock.mockClear(); + }); + + describe('#getAgentFactory()', () => { + it('provides factories which are different at each call', () => { + const agentManager = new AgentManager(); + const agentFactory1 = agentManager.getAgentFactory(); + const agentFactory2 = agentManager.getAgentFactory(); + expect(agentFactory1).not.toEqual(agentFactory2); + }); + + describe('one agent factory', () => { + it('provides instances of the http and https Agent classes', () => { + const mockedHttpAgent = new HttpAgent(); + HttpAgentMock.mockImplementationOnce(() => mockedHttpAgent); + const mockedHttpsAgent = new HttpsAgent(); + HttpsAgentMock.mockImplementationOnce(() => mockedHttpsAgent); + const agentManager = new AgentManager(); + const agentFactory = agentManager.getAgentFactory(); + const httpAgent = agentFactory({ url: new URL('http://elastic-node-1:9200') }); + const httpsAgent = agentFactory({ url: new URL('https://elastic-node-1:9200') }); + expect(httpAgent).toEqual(mockedHttpAgent); + expect(httpsAgent).toEqual(mockedHttpsAgent); + }); + + it('provides Agents with a valid default configuration', () => { + const agentManager = new AgentManager(); + const agentFactory = agentManager.getAgentFactory(); + agentFactory({ url: new URL('http://elastic-node-1:9200') }); + expect(HttpAgent).toBeCalledTimes(1); + expect(HttpAgent).toBeCalledWith({ + keepAlive: true, + keepAliveMsecs: 50000, + maxFreeSockets: 256, + maxSockets: 256, + scheduling: 'lifo', + }); + }); + + it('takes into account the provided configurations', () => { + const agentManager = new AgentManager({ maxFreeSockets: 32, maxSockets: 2048 }); + const agentFactory = agentManager.getAgentFactory({ + maxSockets: 1024, + scheduling: 'fifo', + }); + agentFactory({ url: new URL('http://elastic-node-1:9200') }); + expect(HttpAgent).toBeCalledTimes(1); + expect(HttpAgent).toBeCalledWith({ + keepAlive: true, + keepAliveMsecs: 50000, + maxFreeSockets: 32, + maxSockets: 1024, + scheduling: 'fifo', + }); + }); + + it('provides Agents that match the URLs protocol', () => { + const agentManager = new AgentManager(); + const agentFactory = agentManager.getAgentFactory(); + agentFactory({ url: new URL('http://elastic-node-1:9200') }); + expect(HttpAgent).toHaveBeenCalledTimes(1); + expect(HttpsAgent).toHaveBeenCalledTimes(0); + agentFactory({ url: new URL('https://elastic-node-3:9200') }); + expect(HttpAgent).toHaveBeenCalledTimes(1); + expect(HttpsAgent).toHaveBeenCalledTimes(1); + }); + + it('provides the same Agent iif URLs use the same protocol', () => { + const agentManager = new AgentManager(); + const agentFactory = agentManager.getAgentFactory(); + const agent1 = agentFactory({ url: new URL('http://elastic-node-1:9200') }); + const agent2 = agentFactory({ url: new URL('http://elastic-node-2:9200') }); + const agent3 = agentFactory({ url: new URL('https://elastic-node-3:9200') }); + const agent4 = agentFactory({ url: new URL('https://elastic-node-4:9200') }); + + expect(agent1).toEqual(agent2); + expect(agent1).not.toEqual(agent3); + expect(agent3).toEqual(agent4); + }); + + it('dereferences an agent instance when the agent is closed', () => { + const agentManager = new AgentManager(); + const agentFactory = agentManager.getAgentFactory(); + const agent = agentFactory({ url: new URL('http://elastic-node-1:9200') }); + // eslint-disable-next-line dot-notation + expect(agentManager['httpStore'].has(agent)).toEqual(true); + agent.destroy(); + // eslint-disable-next-line dot-notation + expect(agentManager['httpStore'].has(agent)).toEqual(false); + }); + }); + + describe('two agent factories', () => { + it('never provide the same Agent instance even if they use the same type', () => { + const agentManager = new AgentManager(); + const agentFactory1 = agentManager.getAgentFactory(); + const agentFactory2 = agentManager.getAgentFactory(); + const agent1 = agentFactory1({ url: new URL('http://elastic-node-1:9200') }); + const agent2 = agentFactory2({ url: new URL('http://elastic-node-1:9200') }); + expect(agent1).not.toEqual(agent2); + }); + }); + }); +}); diff --git a/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/agent_manager.ts b/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/agent_manager.ts new file mode 100644 index 0000000000000..237f6964d975b --- /dev/null +++ b/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/agent_manager.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 { Agent as HttpAgent } from 'http'; +import { Agent as HttpsAgent } from 'https'; +import { ConnectionOptions, HttpAgentOptions } from '@elastic/elasticsearch'; + +const HTTPS = 'https:'; +const DEFAULT_CONFIG: HttpAgentOptions = { + keepAlive: true, + keepAliveMsecs: 50000, + maxSockets: 256, + maxFreeSockets: 256, + scheduling: 'lifo', +}; + +export type NetworkAgent = HttpAgent | HttpsAgent; +export type AgentFactory = (connectionOpts: ConnectionOptions) => NetworkAgent; + +/** + * Allows obtaining Agent factories, which can then be fed into elasticsearch-js's Client class. + * Ideally, we should obtain one Agent factory for each ES Client class. + * This allows using the same Agent across all the Pools and Connections of the Client (one per ES node). + * + * Agent instances are stored internally to allow collecting metrics (nbr of active/idle connections to ES). + * + * Using the same Agent factory across multiple ES Client instances is strongly discouraged, cause ES Client + * exposes methods that can modify the underlying pools, effectively impacting the connections of other Clients. + * @internal + **/ +export class AgentManager { + // Stores Https Agent instances + private httpsStore: Set; + // Stores Http Agent instances + private httpStore: Set; + + constructor(private agentOptions: HttpAgentOptions = DEFAULT_CONFIG) { + this.httpsStore = new Set(); + this.httpStore = new Set(); + } + + public getAgentFactory(agentOptions?: HttpAgentOptions): AgentFactory { + // a given agent factory always provides the same Agent instances (for the same protocol) + // we keep references to the instances at factory level, to be able to reuse them + let httpAgent: HttpAgent; + let httpsAgent: HttpsAgent; + + return (connectionOpts: ConnectionOptions): NetworkAgent => { + if (connectionOpts.url.protocol === HTTPS) { + if (!httpsAgent) { + const config = Object.assign( + {}, + DEFAULT_CONFIG, + this.agentOptions, + agentOptions, + connectionOpts.tls + ); + httpsAgent = new HttpsAgent(config); + this.httpsStore.add(httpsAgent); + dereferenceOnDestroy(this.httpsStore, httpsAgent); + } + + return httpsAgent; + } + + if (!httpAgent) { + const config = Object.assign({}, DEFAULT_CONFIG, this.agentOptions, agentOptions); + httpAgent = new HttpAgent(config); + this.httpStore.add(httpAgent); + dereferenceOnDestroy(this.httpStore, httpAgent); + } + + return httpAgent; + }; + } +} + +const dereferenceOnDestroy = (protocolStore: Set, agent: NetworkAgent) => { + const doDestroy = agent.destroy.bind(agent); + agent.destroy = () => { + protocolStore.delete(agent); + doDestroy(); + }; +}; diff --git a/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/client_config.ts b/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/client_config.ts index 9d380fcbaa455..f72a43abfd310 100644 --- a/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/client_config.ts +++ b/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/client_config.ts @@ -9,10 +9,12 @@ import { ConnectionOptions as TlsConnectionOptions } from 'tls'; import { URL } from 'url'; import { Duration } from 'moment'; -import type { ClientOptions } from '@elastic/elasticsearch/lib/client'; +import type { ClientOptions, HttpAgentOptions } from '@elastic/elasticsearch'; import type { ElasticsearchClientConfig } from '@kbn/core-elasticsearch-server'; import { DEFAULT_HEADERS } from './headers'; +export type ParsedClientOptions = Omit & { agent: HttpAgentOptions }; + /** * Parse the client options from given client config and `scoped` flag. * @@ -23,8 +25,8 @@ import { DEFAULT_HEADERS } from './headers'; export function parseClientOptions( config: ElasticsearchClientConfig, scoped: boolean -): ClientOptions { - const clientOptions: ClientOptions = { +): ParsedClientOptions { + const clientOptions: ParsedClientOptions = { sniffOnStart: config.sniffOnStart, sniffOnConnectionFault: config.sniffOnConnectionFault, headers: { diff --git a/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/cluster_client.test.ts b/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/cluster_client.test.ts index 3b2e6f82fe40d..895266126ebcb 100644 --- a/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/cluster_client.test.ts +++ b/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/cluster_client.test.ts @@ -17,6 +17,7 @@ import { httpServerMock, httpServiceMock } from '@kbn/core-http-server-mocks'; import type { ElasticsearchClientConfig } from '@kbn/core-elasticsearch-server'; import { ClusterClient } from './cluster_client'; import { DEFAULT_HEADERS } from './headers'; +import { AgentManager } from './agent_manager'; const createConfig = ( parts: Partial = {} @@ -42,6 +43,7 @@ describe('ClusterClient', () => { let authHeaders: ReturnType; let internalClient: jest.Mocked; let scopedClient: jest.Mocked; + let agentManager: AgentManager; const mockTransport = { mockTransport: true }; @@ -49,6 +51,7 @@ describe('ClusterClient', () => { logger = loggingSystemMock.createLogger(); internalClient = createClient(); scopedClient = createClient(); + agentManager = new AgentManager(); authHeaders = httpServiceMock.createAuthHeaderStorage(); authHeaders.get.mockImplementation(() => ({ @@ -78,16 +81,19 @@ describe('ClusterClient', () => { authHeaders, type: 'custom-type', getExecutionContext: getExecutionContextMock, + agentManager, }); expect(configureClientMock).toHaveBeenCalledTimes(2); expect(configureClientMock).toHaveBeenCalledWith(config, { logger, + agentManager, type: 'custom-type', getExecutionContext: getExecutionContextMock, }); expect(configureClientMock).toHaveBeenCalledWith(config, { logger, + agentManager, type: 'custom-type', getExecutionContext: getExecutionContextMock, scoped: true, @@ -101,6 +107,7 @@ describe('ClusterClient', () => { logger, type: 'custom-type', authHeaders, + agentManager, }); expect(clusterClient.asInternalUser).toBe(internalClient); @@ -114,6 +121,7 @@ describe('ClusterClient', () => { logger, type: 'custom-type', authHeaders, + agentManager, }); const request = httpServerMock.createKibanaRequest(); @@ -139,6 +147,7 @@ describe('ClusterClient', () => { authHeaders, getExecutionContext, getUnauthorizedErrorHandler, + agentManager, }); const request = httpServerMock.createKibanaRequest(); @@ -161,6 +170,7 @@ describe('ClusterClient', () => { authHeaders, getExecutionContext, getUnauthorizedErrorHandler, + agentManager, }); const request = httpServerMock.createKibanaRequest(); @@ -192,6 +202,7 @@ describe('ClusterClient', () => { logger, type: 'custom-type', authHeaders, + agentManager, }); const request = httpServerMock.createKibanaRequest(); @@ -210,7 +221,13 @@ describe('ClusterClient', () => { }); authHeaders.get.mockReturnValue({}); - const clusterClient = new ClusterClient({ config, logger, type: 'custom-type', authHeaders }); + const clusterClient = new ClusterClient({ + config, + logger, + type: 'custom-type', + authHeaders, + agentManager, + }); const request = httpServerMock.createKibanaRequest({ headers: { foo: 'bar', @@ -237,7 +254,13 @@ describe('ClusterClient', () => { other: 'yep', }); - const clusterClient = new ClusterClient({ config, logger, type: 'custom-type', authHeaders }); + const clusterClient = new ClusterClient({ + config, + logger, + type: 'custom-type', + authHeaders, + agentManager, + }); const request = httpServerMock.createKibanaRequest({}); clusterClient.asScoped(request); @@ -264,7 +287,13 @@ describe('ClusterClient', () => { other: 'yep', }); - const clusterClient = new ClusterClient({ config, logger, type: 'custom-type', authHeaders }); + const clusterClient = new ClusterClient({ + config, + logger, + type: 'custom-type', + authHeaders, + agentManager, + }); const request = httpServerMock.createKibanaRequest({ headers: { authorization: 'override', @@ -296,7 +325,13 @@ describe('ClusterClient', () => { }); authHeaders.get.mockReturnValue({}); - const clusterClient = new ClusterClient({ config, logger, type: 'custom-type', authHeaders }); + const clusterClient = new ClusterClient({ + config, + logger, + type: 'custom-type', + authHeaders, + agentManager, + }); const request = httpServerMock.createKibanaRequest({}); clusterClient.asScoped(request); @@ -318,7 +353,13 @@ describe('ClusterClient', () => { const config = createConfig(); authHeaders.get.mockReturnValue({}); - const clusterClient = new ClusterClient({ config, logger, type: 'custom-type', authHeaders }); + const clusterClient = new ClusterClient({ + config, + logger, + type: 'custom-type', + authHeaders, + agentManager, + }); const request = httpServerMock.createKibanaRequest({ kibanaRequestState: { requestId: 'my-fake-id', requestUuid: 'ignore-this-id' }, }); @@ -348,7 +389,13 @@ describe('ClusterClient', () => { foo: 'auth', }); - const clusterClient = new ClusterClient({ config, logger, type: 'custom-type', authHeaders }); + const clusterClient = new ClusterClient({ + config, + logger, + type: 'custom-type', + authHeaders, + agentManager, + }); const request = httpServerMock.createKibanaRequest({}); clusterClient.asScoped(request); @@ -376,7 +423,13 @@ describe('ClusterClient', () => { }); authHeaders.get.mockReturnValue({}); - const clusterClient = new ClusterClient({ config, logger, type: 'custom-type', authHeaders }); + const clusterClient = new ClusterClient({ + config, + logger, + type: 'custom-type', + authHeaders, + agentManager, + }); const request = httpServerMock.createKibanaRequest({ headers: { foo: 'request' }, }); @@ -405,7 +458,13 @@ describe('ClusterClient', () => { }); authHeaders.get.mockReturnValue({}); - const clusterClient = new ClusterClient({ config, logger, type: 'custom-type', authHeaders }); + const clusterClient = new ClusterClient({ + config, + logger, + type: 'custom-type', + authHeaders, + agentManager, + }); const request = httpServerMock.createKibanaRequest(); clusterClient.asScoped(request); @@ -428,7 +487,13 @@ describe('ClusterClient', () => { }); authHeaders.get.mockReturnValue({}); - const clusterClient = new ClusterClient({ config, logger, type: 'custom-type', authHeaders }); + const clusterClient = new ClusterClient({ + config, + logger, + type: 'custom-type', + authHeaders, + agentManager, + }); const request = httpServerMock.createKibanaRequest({ headers: { [headerKey]: 'foo' }, }); @@ -454,7 +519,13 @@ describe('ClusterClient', () => { }); authHeaders.get.mockReturnValue({}); - const clusterClient = new ClusterClient({ config, logger, type: 'custom-type', authHeaders }); + const clusterClient = new ClusterClient({ + config, + logger, + type: 'custom-type', + authHeaders, + agentManager, + }); const request = httpServerMock.createKibanaRequest({ headers: { foo: 'request' }, kibanaRequestState: { requestId: 'from request', requestUuid: 'ignore-this-id' }, @@ -479,7 +550,13 @@ describe('ClusterClient', () => { }); authHeaders.get.mockReturnValue({}); - const clusterClient = new ClusterClient({ config, logger, type: 'custom-type', authHeaders }); + const clusterClient = new ClusterClient({ + config, + logger, + type: 'custom-type', + authHeaders, + agentManager, + }); const request = { headers: { authorization: 'auth', @@ -505,7 +582,13 @@ describe('ClusterClient', () => { authorization: 'auth', }); - const clusterClient = new ClusterClient({ config, logger, type: 'custom-type', authHeaders }); + const clusterClient = new ClusterClient({ + config, + logger, + type: 'custom-type', + authHeaders, + agentManager, + }); const request = { headers: { foo: 'bar', @@ -531,6 +614,7 @@ describe('ClusterClient', () => { logger, type: 'custom-type', authHeaders, + agentManager, }); await clusterClient.close(); @@ -547,6 +631,7 @@ describe('ClusterClient', () => { logger, type: 'custom-type', authHeaders, + agentManager, }); let internalClientClosed = false; @@ -590,6 +675,7 @@ describe('ClusterClient', () => { logger, type: 'custom-type', authHeaders, + agentManager, }); internalClient.close.mockRejectedValue(new Error('error closing client')); @@ -605,6 +691,7 @@ describe('ClusterClient', () => { logger, type: 'custom-type', authHeaders, + agentManager, }); await clusterClient.close(); diff --git a/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/cluster_client.ts b/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/cluster_client.ts index 088a99c7642f0..4c7f56458baa7 100644 --- a/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/cluster_client.ts +++ b/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/cluster_client.ts @@ -26,6 +26,7 @@ import { ScopedClusterClient } from './scoped_cluster_client'; import { DEFAULT_HEADERS } from './headers'; import { createInternalErrorHandler, InternalUnauthorizedErrorHandler } from './retry_unauthorized'; import { createTransport } from './create_transport'; +import { AgentManager } from './agent_manager'; const noop = () => undefined; @@ -47,6 +48,7 @@ export class ClusterClient implements ICustomClusterClient { authHeaders, getExecutionContext = noop, getUnauthorizedErrorHandler = noop, + agentManager, }: { config: ElasticsearchClientConfig; logger: Logger; @@ -54,18 +56,25 @@ export class ClusterClient implements ICustomClusterClient { authHeaders?: IAuthHeadersStorage; getExecutionContext?: () => string | undefined; getUnauthorizedErrorHandler?: () => UnauthorizedErrorHandler | undefined; + agentManager: AgentManager; }) { this.config = config; this.authHeaders = authHeaders; this.getExecutionContext = getExecutionContext; this.getUnauthorizedErrorHandler = getUnauthorizedErrorHandler; - this.asInternalUser = configureClient(config, { logger, type, getExecutionContext }); + this.asInternalUser = configureClient(config, { + logger, + type, + getExecutionContext, + agentManager, + }); this.rootScopedClient = configureClient(config, { logger, type, getExecutionContext, scoped: true, + agentManager, }); } diff --git a/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/configure_client.test.ts b/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/configure_client.test.ts index e4fb582972b1b..e37f30b272212 100644 --- a/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/configure_client.test.ts +++ b/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/configure_client.test.ts @@ -10,17 +10,23 @@ jest.mock('./log_query_and_deprecation', () => ({ __esModule: true, instrumentEsQueryAndDeprecationLogger: jest.fn(), })); +jest.mock('./agent_manager'); +import { Agent } from 'http'; import { parseClientOptionsMock, createTransportMock, ClientMock, } from './configure_client.test.mocks'; +import { MockedLogger } from '@kbn/logging-mocks'; import { loggingSystemMock } from '@kbn/core-logging-server-mocks'; import { ClusterConnectionPool } from '@elastic/elasticsearch'; import type { ElasticsearchClientConfig } from '@kbn/core-elasticsearch-server'; import { configureClient } from './configure_client'; import { instrumentEsQueryAndDeprecationLogger } from './log_query_and_deprecation'; +import { AgentManager } from './agent_manager'; + +const AgentManagerMock = AgentManager as jest.Mock; const createFakeConfig = ( parts: Partial = {} @@ -39,15 +45,31 @@ const createFakeClient = () => { return client; }; +const createFakeAgentFactory = (logger: MockedLogger) => { + const agentFactory = () => new Agent(); + + AgentManagerMock.mockImplementationOnce(() => { + const agentManager = new AgentManager(); + agentManager.getAgentFactory = () => agentFactory; + return agentManager; + }); + + const agentManager = new AgentManager(); + + return { agentManager, agentFactory }; +}; + describe('configureClient', () => { - let logger: ReturnType; + let logger: MockedLogger; let config: ElasticsearchClientConfig; + let agentManager: AgentManager; beforeEach(() => { logger = loggingSystemMock.createLogger(); config = createFakeConfig(); parseClientOptionsMock.mockReturnValue({}); ClientMock.mockImplementation(() => createFakeClient()); + agentManager = new AgentManager(); }); afterEach(() => { @@ -57,14 +79,14 @@ describe('configureClient', () => { }); it('calls `parseClientOptions` with the correct parameters', () => { - configureClient(config, { logger, type: 'test', scoped: false }); + configureClient(config, { logger, type: 'test', scoped: false, agentManager }); expect(parseClientOptionsMock).toHaveBeenCalledTimes(1); expect(parseClientOptionsMock).toHaveBeenCalledWith(config, false); parseClientOptionsMock.mockClear(); - configureClient(config, { logger, type: 'test', scoped: true }); + configureClient(config, { logger, type: 'test', scoped: true, agentManager }); expect(parseClientOptionsMock).toHaveBeenCalledTimes(1); expect(parseClientOptionsMock).toHaveBeenCalledWith(config, true); @@ -76,23 +98,49 @@ describe('configureClient', () => { }; parseClientOptionsMock.mockReturnValue(parsedOptions); - const client = configureClient(config, { logger, type: 'test', scoped: false }); + const client = configureClient(config, { logger, type: 'test', scoped: false, agentManager }); expect(ClientMock).toHaveBeenCalledTimes(1); expect(ClientMock).toHaveBeenCalledWith(expect.objectContaining(parsedOptions)); expect(client).toBe(ClientMock.mock.results[0].value); }); + it('constructs a client using the provided `agentManager`', () => { + const { agentManager: customAgentManager, agentFactory } = createFakeAgentFactory(logger); + const client = configureClient(config, { + logger, + type: 'test', + scoped: false, + agentManager: customAgentManager, + }); + + expect(ClientMock).toHaveBeenCalledTimes(1); + expect(ClientMock).toHaveBeenCalledWith(expect.objectContaining({ agent: agentFactory })); + expect(client).toBe(ClientMock.mock.results[0].value); + }); + it('calls `createTransport` with the correct parameters', () => { const getExecutionContext = jest.fn(); - configureClient(config, { logger, type: 'test', scoped: false, getExecutionContext }); + configureClient(config, { + logger, + type: 'test', + scoped: false, + getExecutionContext, + agentManager, + }); expect(createTransportMock).toHaveBeenCalledTimes(1); expect(createTransportMock).toHaveBeenCalledWith({ getExecutionContext }); createTransportMock.mockClear(); - configureClient(config, { logger, type: 'test', scoped: true, getExecutionContext }); + configureClient(config, { + logger, + type: 'test', + scoped: true, + getExecutionContext, + agentManager, + }); expect(createTransportMock).toHaveBeenCalledTimes(1); expect(createTransportMock).toHaveBeenCalledWith({ getExecutionContext }); @@ -102,7 +150,7 @@ describe('configureClient', () => { const mockedTransport = { mockTransport: true }; createTransportMock.mockReturnValue(mockedTransport); - const client = configureClient(config, { logger, type: 'test', scoped: false }); + const client = configureClient(config, { logger, type: 'test', scoped: false, agentManager }); expect(ClientMock).toHaveBeenCalledTimes(1); expect(ClientMock).toHaveBeenCalledWith( @@ -117,7 +165,7 @@ describe('configureClient', () => { const mockedTransport = { mockTransport: true }; createTransportMock.mockReturnValue(mockedTransport); - const client = configureClient(config, { logger, type: 'test', scoped: false }); + const client = configureClient(config, { logger, type: 'test', scoped: false, agentManager }); expect(ClientMock).toHaveBeenCalledTimes(1); expect(ClientMock).toHaveBeenCalledWith( @@ -129,7 +177,7 @@ describe('configureClient', () => { }); it('calls instrumentEsQueryAndDeprecationLogger', () => { - const client = configureClient(config, { logger, type: 'test', scoped: false }); + const client = configureClient(config, { logger, type: 'test', scoped: false, agentManager }); expect(instrumentEsQueryAndDeprecationLogger).toHaveBeenCalledTimes(1); expect(instrumentEsQueryAndDeprecationLogger).toHaveBeenCalledWith({ diff --git a/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/configure_client.ts b/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/configure_client.ts index 4901349e6b487..9980a54356fee 100644 --- a/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/configure_client.ts +++ b/packages/core/elasticsearch/core-elasticsearch-client-server-internal/src/configure_client.ts @@ -12,6 +12,7 @@ import type { ElasticsearchClientConfig } from '@kbn/core-elasticsearch-server'; import { parseClientOptions } from './client_config'; import { instrumentEsQueryAndDeprecationLogger } from './log_query_and_deprecation'; import { createTransport } from './create_transport'; +import { AgentManager } from './agent_manager'; const noop = () => undefined; @@ -22,18 +23,20 @@ export const configureClient = ( type, scoped = false, getExecutionContext = noop, + agentManager, }: { logger: Logger; type: string; scoped?: boolean; getExecutionContext?: () => string | undefined; + agentManager: AgentManager; } ): Client => { const clientOptions = parseClientOptions(config, scoped); const KibanaTransport = createTransport({ getExecutionContext }); - const client = new Client({ ...clientOptions, + agent: agentManager.getAgentFactory(clientOptions.agent), Transport: KibanaTransport, Connection: HttpConnection, // using ClusterConnectionPool until https://github.com/elastic/elasticsearch-js/issues/1714 is addressed diff --git a/packages/core/elasticsearch/core-elasticsearch-server-internal/src/elasticsearch_service.test.mocks.ts b/packages/core/elasticsearch/core-elasticsearch-server-internal/src/elasticsearch_service.test.mocks.ts index 29b9a2cda3dfd..cd6d36f0cb111 100644 --- a/packages/core/elasticsearch/core-elasticsearch-server-internal/src/elasticsearch_service.test.mocks.ts +++ b/packages/core/elasticsearch/core-elasticsearch-server-internal/src/elasticsearch_service.test.mocks.ts @@ -7,8 +7,10 @@ */ export const MockClusterClient = jest.fn(); +export const MockAgentManager = jest.fn(); jest.mock('@kbn/core-elasticsearch-client-server-internal', () => ({ ClusterClient: MockClusterClient, + AgentManager: MockAgentManager, })); export const isScriptingEnabledMock = jest.fn(); diff --git a/packages/core/elasticsearch/core-elasticsearch-server-internal/src/elasticsearch_service.test.ts b/packages/core/elasticsearch/core-elasticsearch-server-internal/src/elasticsearch_service.test.ts index aaf7344fdc3b6..5b54a2c35683e 100644 --- a/packages/core/elasticsearch/core-elasticsearch-server-internal/src/elasticsearch_service.test.ts +++ b/packages/core/elasticsearch/core-elasticsearch-server-internal/src/elasticsearch_service.test.ts @@ -135,6 +135,20 @@ describe('#preboot', () => { ); }); + it('creates a ClusterClient using the internal AgentManager', async () => { + const prebootContract = await elasticsearchService.preboot(); + const customConfig = { keepAlive: true }; + const clusterClient = prebootContract.createClient('custom-type', customConfig); + + expect(clusterClient).toBe(mockClusterClientInstance); + + expect(MockClusterClient).toHaveBeenCalledTimes(1); + expect(MockClusterClient.mock.calls[0][0]).toEqual( + // eslint-disable-next-line dot-notation + expect.objectContaining({ agentManager: elasticsearchService['agentManager'] }) + ); + }); + it('creates a new client on each call', async () => { const prebootContract = await elasticsearchService.preboot(); diff --git a/packages/core/elasticsearch/core-elasticsearch-server-internal/src/elasticsearch_service.ts b/packages/core/elasticsearch/core-elasticsearch-server-internal/src/elasticsearch_service.ts index 8e7ab46b0edd4..1dc50c7561192 100644 --- a/packages/core/elasticsearch/core-elasticsearch-server-internal/src/elasticsearch_service.ts +++ b/packages/core/elasticsearch/core-elasticsearch-server-internal/src/elasticsearch_service.ts @@ -22,7 +22,7 @@ import type { UnauthorizedErrorHandler, ElasticsearchClientConfig, } from '@kbn/core-elasticsearch-server'; -import { ClusterClient } from '@kbn/core-elasticsearch-client-server-internal'; +import { ClusterClient, AgentManager } from '@kbn/core-elasticsearch-client-server-internal'; import { registerAnalyticsContextProvider } from './register_analytics_context_provider'; import { ElasticsearchConfig, ElasticsearchConfigType } from './elasticsearch_config'; @@ -58,6 +58,7 @@ export class ElasticsearchService private esNodesCompatibility$?: Observable; private client?: ClusterClient; private unauthorizedErrorHandler?: UnauthorizedErrorHandler; + private agentManager: AgentManager; constructor(private readonly coreContext: CoreContext) { this.kibanaVersion = coreContext.env.packageInfo.version; @@ -65,6 +66,7 @@ export class ElasticsearchService this.config$ = coreContext.configService .atPath('elasticsearch') .pipe(map((rawConfig) => new ElasticsearchConfig(rawConfig))); + this.agentManager = new AgentManager(); } public async preboot(): Promise { @@ -172,6 +174,7 @@ export class ElasticsearchService clientConfig: Partial = {} ) { const config = mergeConfig(baseConfig, clientConfig); + return new ClusterClient({ config, logger: this.coreContext.logger.get('elasticsearch'), @@ -179,6 +182,7 @@ export class ElasticsearchService authHeaders: this.authHeaders, getExecutionContext: () => this.executionContextClient?.getAsHeader(), getUnauthorizedErrorHandler: () => this.unauthorizedErrorHandler, + agentManager: this.agentManager, }); } } diff --git a/packages/core/elasticsearch/core-elasticsearch-server-mocks/src/elasticsearch_service.mock.ts b/packages/core/elasticsearch/core-elasticsearch-server-mocks/src/elasticsearch_service.mock.ts index fcaca91264d4f..a1323be0ea71b 100644 --- a/packages/core/elasticsearch/core-elasticsearch-server-mocks/src/elasticsearch_service.mock.ts +++ b/packages/core/elasticsearch/core-elasticsearch-server-mocks/src/elasticsearch_service.mock.ts @@ -42,18 +42,15 @@ export type MockedElasticSearchServiceSetup = jest.Mocked< export interface MockedElasticSearchServiceStart { client: ClusterClientMock; createClient: jest.MockedFunction< - (name: string, config?: Partial) => CustomClusterClientMock + (type: string, config?: Partial) => CustomClusterClientMock >; } const createPrebootContractMock = () => { const prebootContract: MockedElasticSearchServicePreboot = { config: { hosts: [], credentialsSpecified: false }, - createClient: jest.fn(), + createClient: jest.fn((type: string) => elasticsearchClientMock.createCustomClusterClient()), }; - prebootContract.createClient.mockImplementation(() => - elasticsearchClientMock.createCustomClusterClient() - ); return prebootContract; }; @@ -70,12 +67,8 @@ const createSetupContractMock = () => { const createStartContractMock = () => { const startContract: MockedElasticSearchServiceStart = { client: elasticsearchClientMock.createClusterClient(), - createClient: jest.fn(), + createClient: jest.fn((type: string) => elasticsearchClientMock.createCustomClusterClient()), }; - - startContract.createClient.mockImplementation(() => - elasticsearchClientMock.createCustomClusterClient() - ); return startContract; }; diff --git a/packages/core/fatal-errors/core-fatal-errors-browser-internal/src/fatal_errors_screen.test.tsx b/packages/core/fatal-errors/core-fatal-errors-browser-internal/src/fatal_errors_screen.test.tsx index 1849517c8cf3f..5fea6d6a66342 100644 --- a/packages/core/fatal-errors/core-fatal-errors-browser-internal/src/fatal_errors_screen.test.tsx +++ b/packages/core/fatal-errors/core-fatal-errors-browser-internal/src/fatal_errors_screen.test.tsx @@ -7,7 +7,7 @@ */ import { EuiCallOut } from '@elastic/eui'; -import testSubjSelector from '@kbn/test-subj-selector'; +import { subj as testSubjSelector } from '@kbn/test-subj-selector'; import React from 'react'; import { of, ReplaySubject } from 'rxjs'; import { mountWithIntl, shallowWithIntl } from '@kbn/test-jest-helpers'; diff --git a/packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_update.ts b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_update.ts index 102e46809b55e..858504853dd75 100644 --- a/packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_update.ts +++ b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_update.ts @@ -19,7 +19,7 @@ export interface SavedObjectsBulkUpdateObject id: string; /** The type of this Saved Object. Each plugin can define it's own custom Saved Object types. */ type: string; - /** {@inheritdoc SavedObjectAttributes} */ + /** The data for a Saved Object is stored as an object in the `attributes` property. **/ attributes: Partial; /** * Optional namespace string to use when searching for this object. If this is defined, it will supersede the namespace ID that is in diff --git a/packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts b/packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts index 2b8f6d66e67ac..b9bdbafc213c9 100644 --- a/packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts +++ b/packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts @@ -31,6 +31,7 @@ export type SavedObjectAttribute = SavedObjectAttributeSingle | SavedObjectAttri * property. * * @public + * @deprecated This type reduces the type safety of your code. Create an interface for your specific saved object type or use `unknown` instead. */ export interface SavedObjectAttributes { [key: string]: SavedObjectAttribute; @@ -76,7 +77,7 @@ export interface SavedObject { /** Timestamp of the last time this document had been updated. */ updated_at?: string; error?: SavedObjectError; - /** {@inheritdoc SavedObjectAttributes} */ + /** The data for a Saved Object is stored as an object in the `attributes` property. **/ attributes: T; /** {@inheritdoc SavedObjectReference} */ references: SavedObjectReference[]; diff --git a/packages/core/saved-objects/core-saved-objects-server/src/contracts.ts b/packages/core/saved-objects/core-saved-objects-server/src/contracts.ts index bb790aec293c8..20821cef46e7a 100644 --- a/packages/core/saved-objects/core-saved-objects-server/src/contracts.ts +++ b/packages/core/saved-objects/core-saved-objects-server/src/contracts.ts @@ -7,7 +7,6 @@ */ import type { KibanaRequest } from '@kbn/core-http-server'; -import type { SavedObjectAttributes } from '@kbn/core-saved-objects-common'; import type { SavedObjectsClientContract, ISavedObjectsRepository, @@ -124,9 +123,7 @@ export interface SavedObjectsServiceSetup { * } * ``` */ - registerType: ( - type: SavedObjectsType - ) => void; + registerType: (type: SavedObjectsType) => void; /** * Returns the default index used for saved objects. diff --git a/packages/core/ui-settings/core-ui-settings-server-internal/BUILD.bazel b/packages/core/ui-settings/core-ui-settings-server-internal/BUILD.bazel new file mode 100644 index 0000000000000..ae77747b313e3 --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server-internal/BUILD.bazel @@ -0,0 +1,129 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "core-ui-settings-server-internal" +PKG_REQUIRE_NAME = "@kbn/core-ui-settings-server-internal" + +SOURCE_FILES = glob( + [ + "**/*.ts", + ], + exclude = [ + "**/*.config.js", + "**/*.mock.*", + "**/*.test.*", + "**/*.stories.*", + "**/__snapshots__/**", + "**/integration_tests/**", + "**/mocks/**", + "**/scripts/**", + "**/storybook/**", + "**/test_fixtures/**", + "**/test_helpers/**", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +RUNTIME_DEPS = [ + "@npm//lodash", + "@npm//semver", + "@npm//moment-timezone", + "//packages/kbn-std", + "//packages/kbn-i18n", + "//packages/kbn-config-schema", + "//packages/core/saved-objects/core-saved-objects-utils-server", +] + +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", + "@npm//@types/semver", + "@npm//@types/moment-timezone", + "@npm//lodash", + "//packages/kbn-ui-shared-deps-npm:npm_module_types", + "//packages/kbn-logging:npm_module_types", + "//packages/kbn-std:npm_module_types", + "//packages/kbn-i18n:npm_module_types", + "//packages/kbn-config-schema:npm_module_types", + "//packages/core/base/core-base-server-internal:npm_module_types", + "//packages/core/http/core-http-server:npm_module_types", + "//packages/core/http/core-http-server-internal:npm_module_types", + "//packages/core/saved-objects/core-saved-objects-api-server:npm_module_types", + "//packages/core/saved-objects/core-saved-objects-server:npm_module_types", + "//packages/core/saved-objects/core-saved-objects-server-internal:npm_module_types", + "//packages/core/saved-objects/core-saved-objects-utils-server:npm_module_types", + "//packages/core/ui-settings/core-ui-settings-common:npm_module_types", + "//packages/core/ui-settings/core-ui-settings-server:npm_module_types", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + declaration_map = True, + emit_declaration_only = True, + out_dir = "target_types", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/core/ui-settings/core-ui-settings-server-internal/README.md b/packages/core/ui-settings/core-ui-settings-server-internal/README.md new file mode 100644 index 0000000000000..00e9d6e29465c --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server-internal/README.md @@ -0,0 +1,3 @@ +# @kbn/core-ui-settings-server-internal + +This package contains the internal types and implementation for Core's server-side uiSettings service. diff --git a/packages/core/ui-settings/core-ui-settings-server-internal/index.ts b/packages/core/ui-settings/core-ui-settings-server-internal/index.ts new file mode 100644 index 0000000000000..9fd6540587ab2 --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server-internal/index.ts @@ -0,0 +1,23 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export { + uiSettingsConfig, + UiSettingsClient, + UiSettingsService, + CoreUiSettingsRouteHandlerContext, +} from './src'; +export type { + InternalUiSettingsServicePreboot, + InternalUiSettingsServiceSetup, + InternalUiSettingsServiceStart, + UiSettingsServiceOptions, +} from './src'; + +// only exported for integration tests +export { createOrUpgradeSavedConfig } from './src/create_or_upgrade_saved_config'; diff --git a/packages/core/ui-settings/core-ui-settings-server-internal/jest.config.js b/packages/core/ui-settings/core-ui-settings-server-internal/jest.config.js new file mode 100644 index 0000000000000..441fe174f93ae --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server-internal/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test/jest_node', + rootDir: '../../../..', + roots: ['/packages/core/ui-settings/core-ui-settings-server-internal'], +}; diff --git a/packages/core/ui-settings/core-ui-settings-server-internal/kibana.jsonc b/packages/core/ui-settings/core-ui-settings-server-internal/kibana.jsonc new file mode 100644 index 0000000000000..b6c943e1e6677 --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server-internal/kibana.jsonc @@ -0,0 +1,7 @@ +{ + "type": "shared-common", + "id": "@kbn/core-ui-settings-server-internal", + "owner": "@elastic/kibana-core", + "runtimeDeps": [], + "typeDeps": [], +} diff --git a/packages/core/ui-settings/core-ui-settings-server-internal/package.json b/packages/core/ui-settings/core-ui-settings-server-internal/package.json new file mode 100644 index 0000000000000..519392b438efb --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server-internal/package.json @@ -0,0 +1,8 @@ +{ + "name": "@kbn/core-ui-settings-server-internal", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "author": "Kibana Core", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/src/core/server/ui_settings/base_ui_settings_client.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/base_ui_settings_client.ts similarity index 91% rename from src/core/server/ui_settings/base_ui_settings_client.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/base_ui_settings_client.ts index be50c923bea0e..27c7bccefb835 100644 --- a/src/core/server/ui_settings/base_ui_settings_client.ts +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/base_ui_settings_client.ts @@ -7,14 +7,13 @@ */ import { omit } from 'lodash'; - import type { Logger } from '@kbn/logging'; -import { - IUiSettingsClient, +import type { UiSettingsParams, PublicUiSettingsParams, UserProvidedValues, -} from './types'; +} from '@kbn/core-ui-settings-common'; +import type { IUiSettingsClient } from '@kbn/core-ui-settings-server'; export interface BaseUiSettingsDefaultsClientOptions { overrides?: Record; @@ -26,9 +25,9 @@ export interface BaseUiSettingsDefaultsClientOptions { * Base implementation of the {@link IUiSettingsClient}. */ export abstract class BaseUiSettingsClient implements IUiSettingsClient { - private readonly defaults: NonNullable; + private readonly defaults: Record; private readonly defaultValues: Record; - protected readonly overrides: NonNullable; + protected readonly overrides: Record; protected readonly log: Logger; protected constructor(options: BaseUiSettingsDefaultsClientOptions) { @@ -86,8 +85,12 @@ export abstract class BaseUiSettingsClient implements IUiSettingsClient { } abstract getUserProvided(): Promise>>; + abstract setMany(changes: Record): Promise; + abstract set(key: string, value: any): Promise; + abstract remove(key: string): Promise; + abstract removeMany(keys: string[]): Promise; } diff --git a/src/core/server/ui_settings/cache.test.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/cache.test.ts similarity index 100% rename from src/core/server/ui_settings/cache.test.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/cache.test.ts diff --git a/src/core/server/ui_settings/cache.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/cache.ts similarity index 99% rename from src/core/server/ui_settings/cache.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/cache.ts index ea628193c0d65..3dcde3d97844f 100644 --- a/src/core/server/ui_settings/cache.ts +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/cache.ts @@ -8,6 +8,7 @@ const oneSec = 1000; const defMaxAge = 5 * oneSec; + /** * @internal */ diff --git a/src/core/server/ui_settings/create_or_upgrade_saved_config/create_or_upgrade_saved_config.test.mock.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/create_or_upgrade_saved_config/create_or_upgrade_saved_config.test.mock.ts similarity index 100% rename from src/core/server/ui_settings/create_or_upgrade_saved_config/create_or_upgrade_saved_config.test.mock.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/create_or_upgrade_saved_config/create_or_upgrade_saved_config.test.mock.ts diff --git a/src/core/server/ui_settings/create_or_upgrade_saved_config/create_or_upgrade_saved_config.test.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/create_or_upgrade_saved_config/create_or_upgrade_saved_config.test.ts similarity index 100% rename from src/core/server/ui_settings/create_or_upgrade_saved_config/create_or_upgrade_saved_config.test.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/create_or_upgrade_saved_config/create_or_upgrade_saved_config.test.ts diff --git a/src/core/server/ui_settings/create_or_upgrade_saved_config/create_or_upgrade_saved_config.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/create_or_upgrade_saved_config/create_or_upgrade_saved_config.ts similarity index 100% rename from src/core/server/ui_settings/create_or_upgrade_saved_config/create_or_upgrade_saved_config.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/create_or_upgrade_saved_config/create_or_upgrade_saved_config.ts diff --git a/src/core/server/ui_settings/create_or_upgrade_saved_config/get_upgradeable_config.test.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/create_or_upgrade_saved_config/get_upgradeable_config.test.ts similarity index 100% rename from src/core/server/ui_settings/create_or_upgrade_saved_config/get_upgradeable_config.test.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/create_or_upgrade_saved_config/get_upgradeable_config.test.ts diff --git a/src/core/server/ui_settings/create_or_upgrade_saved_config/get_upgradeable_config.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/create_or_upgrade_saved_config/get_upgradeable_config.ts similarity index 100% rename from src/core/server/ui_settings/create_or_upgrade_saved_config/get_upgradeable_config.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/create_or_upgrade_saved_config/get_upgradeable_config.ts diff --git a/src/core/server/ui_settings/create_or_upgrade_saved_config/index.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/create_or_upgrade_saved_config/index.ts similarity index 100% rename from src/core/server/ui_settings/create_or_upgrade_saved_config/index.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/create_or_upgrade_saved_config/index.ts diff --git a/src/core/server/ui_settings/create_or_upgrade_saved_config/is_config_version_upgradeable.test.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/create_or_upgrade_saved_config/is_config_version_upgradeable.test.ts similarity index 100% rename from src/core/server/ui_settings/create_or_upgrade_saved_config/is_config_version_upgradeable.test.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/create_or_upgrade_saved_config/is_config_version_upgradeable.test.ts diff --git a/src/core/server/ui_settings/create_or_upgrade_saved_config/is_config_version_upgradeable.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/create_or_upgrade_saved_config/is_config_version_upgradeable.ts similarity index 100% rename from src/core/server/ui_settings/create_or_upgrade_saved_config/is_config_version_upgradeable.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/create_or_upgrade_saved_config/is_config_version_upgradeable.ts diff --git a/packages/core/ui-settings/core-ui-settings-server-internal/src/index.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/index.ts new file mode 100644 index 0000000000000..654816e921226 --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/index.ts @@ -0,0 +1,18 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export { uiSettingsConfig } from './ui_settings_config'; +export { UiSettingsService } from './ui_settings_service'; +export { CoreUiSettingsRouteHandlerContext } from './ui_settings_route_handler_context'; +export { UiSettingsClient } from './ui_settings_client'; +export type { UiSettingsServiceOptions } from './ui_settings_client'; +export type { + InternalUiSettingsServicePreboot, + InternalUiSettingsServiceSetup, + InternalUiSettingsServiceStart, +} from './types'; diff --git a/src/core/server/ui_settings/internal_types.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/internal_types.ts similarity index 90% rename from src/core/server/ui_settings/internal_types.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/internal_types.ts index 441a5dbb389e0..2da5446360029 100644 --- a/src/core/server/ui_settings/internal_types.ts +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/internal_types.ts @@ -7,7 +7,7 @@ */ import type { IRouter, RequestHandlerContextBase } from '@kbn/core-http-server'; -import type { UiSettingsRequestHandlerContext } from './ui_settings_route_handler_context'; +import type { UiSettingsRequestHandlerContext } from '@kbn/core-ui-settings-server'; /** * Request handler context used by core's uiSetting routes. diff --git a/src/core/server/ui_settings/routes/delete.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/routes/delete.ts similarity index 100% rename from src/core/server/ui_settings/routes/delete.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/routes/delete.ts diff --git a/src/core/server/ui_settings/routes/get.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/routes/get.ts similarity index 100% rename from src/core/server/ui_settings/routes/get.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/routes/get.ts diff --git a/src/core/server/ui_settings/routes/index.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/routes/index.ts similarity index 100% rename from src/core/server/ui_settings/routes/index.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/routes/index.ts diff --git a/src/core/server/ui_settings/routes/set.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/routes/set.ts similarity index 100% rename from src/core/server/ui_settings/routes/set.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/routes/set.ts diff --git a/src/core/server/ui_settings/routes/set_many.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/routes/set_many.ts similarity index 100% rename from src/core/server/ui_settings/routes/set_many.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/routes/set_many.ts diff --git a/src/core/server/ui_settings/saved_objects/index.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/saved_objects/index.ts similarity index 100% rename from src/core/server/ui_settings/saved_objects/index.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/saved_objects/index.ts diff --git a/src/core/server/ui_settings/saved_objects/migrations.test.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/saved_objects/migrations.test.ts similarity index 99% rename from src/core/server/ui_settings/saved_objects/migrations.test.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/saved_objects/migrations.test.ts index c08f75ad9d184..4c6114ea93a8d 100644 --- a/src/core/server/ui_settings/saved_objects/migrations.test.ts +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/saved_objects/migrations.test.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { SavedObjectUnsanitizedDoc } from '../..'; +import type { SavedObjectUnsanitizedDoc } from '@kbn/core-saved-objects-server'; import { migrations } from './migrations'; describe('ui_settings 7.9.0 migrations', () => { diff --git a/src/core/server/ui_settings/saved_objects/migrations.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/saved_objects/migrations.ts similarity index 97% rename from src/core/server/ui_settings/saved_objects/migrations.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/saved_objects/migrations.ts index 73b51254d1869..2c14f022379f7 100644 --- a/src/core/server/ui_settings/saved_objects/migrations.ts +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/saved_objects/migrations.ts @@ -6,7 +6,10 @@ * Side Public License, v 1. */ -import { SavedObjectUnsanitizedDoc, SavedObjectSanitizedDoc } from '../..'; +import type { + SavedObjectUnsanitizedDoc, + SavedObjectSanitizedDoc, +} from '@kbn/core-saved-objects-server'; export const migrations = { '7.9.0': (doc: SavedObjectUnsanitizedDoc): SavedObjectSanitizedDoc => ({ diff --git a/packages/core/ui-settings/core-ui-settings-server-internal/src/saved_objects/transforms.test.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/saved_objects/transforms.test.ts new file mode 100644 index 0000000000000..8f3382d4dadd2 --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/saved_objects/transforms.test.ts @@ -0,0 +1,115 @@ +/* + * 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 { savedObjectsClientMock } from '@kbn/core-saved-objects-api-server-mocks'; +import { SavedObjectsErrorHelpers } from '@kbn/core-saved-objects-utils-server'; +import type { SavedObject } from '@kbn/core-saved-objects-common'; +import type { UpgradeableConfigAttributes } from '../create_or_upgrade_saved_config'; +import { transformDefaultIndex } from './transforms'; + +/** + * Test each transform function individually, not the entire exported `transforms` array. + */ +describe('#transformDefaultIndex', () => { + const savedObjectsClient = savedObjectsClientMock.create(); + + beforeEach(() => { + jest.resetAllMocks(); + }); + + it('should return early if the config object has already been transformed', async () => { + const result = await transformDefaultIndex({ + savedObjectsClient, + configAttributes: { isDefaultIndexMigrated: true } as UpgradeableConfigAttributes, // We don't care about the other attributes + }); + + expect(savedObjectsClient.resolve).not.toHaveBeenCalled(); + expect(result).toEqual(null); // This is the only time we expect a null result + }); + + it('should return early if configAttributes is undefined', async () => { + const result = await transformDefaultIndex({ savedObjectsClient, configAttributes: undefined }); + + expect(savedObjectsClient.resolve).not.toHaveBeenCalled(); + expect(result).toEqual({ isDefaultIndexMigrated: true }); + }); + + it('should return early if the defaultIndex attribute is undefined', async () => { + const result = await transformDefaultIndex({ + savedObjectsClient, + configAttributes: { defaultIndex: undefined } as UpgradeableConfigAttributes, // We don't care about the other attributes + }); + + expect(savedObjectsClient.resolve).not.toHaveBeenCalled(); + expect(result).toEqual({ isDefaultIndexMigrated: true }); + }); + + describe('should resolve the data view for the defaultIndex and return the result according to the outcome', () => { + it('outcome: exactMatch', async () => { + savedObjectsClient.resolve.mockResolvedValue({ + outcome: 'exactMatch', + alias_target_id: 'another-index', // This wouldn't realistically be set if the outcome is exactMatch, but we're including it in this test to assert that the returned defaultIndex will be 'some-index' + saved_object: {} as SavedObject, // Doesn't matter + }); + const result = await transformDefaultIndex({ + savedObjectsClient, + configAttributes: { defaultIndex: 'some-index' } as UpgradeableConfigAttributes, // We don't care about the other attributes + }); + + expect(savedObjectsClient.resolve).toHaveBeenCalledTimes(1); + expect(savedObjectsClient.resolve).toHaveBeenCalledWith('index-pattern', 'some-index'); + expect(result).toEqual({ isDefaultIndexMigrated: true, defaultIndex: 'some-index' }); + }); + + for (const outcome of ['aliasMatch' as const, 'conflict' as const]) { + it(`outcome: ${outcome}`, async () => { + savedObjectsClient.resolve.mockResolvedValue({ + outcome, + alias_target_id: 'another-index', + saved_object: {} as SavedObject, // Doesn't matter + }); + const result = await transformDefaultIndex({ + savedObjectsClient, + configAttributes: { defaultIndex: 'some-index' } as UpgradeableConfigAttributes, // We don't care about the other attributes + }); + + expect(savedObjectsClient.resolve).toHaveBeenCalledTimes(1); + expect(savedObjectsClient.resolve).toHaveBeenCalledWith('index-pattern', 'some-index'); + expect(result).toEqual({ isDefaultIndexMigrated: true, defaultIndex: 'another-index' }); + }); + } + + it('returns the expected result if resolve fails with a Not Found error', async () => { + savedObjectsClient.resolve.mockRejectedValue( + SavedObjectsErrorHelpers.createGenericNotFoundError('Oh no!') + ); + const result = await transformDefaultIndex({ + savedObjectsClient, + configAttributes: { defaultIndex: 'some-index' } as UpgradeableConfigAttributes, // We don't care about the other attributes + }); + + expect(savedObjectsClient.resolve).toHaveBeenCalledTimes(1); + expect(savedObjectsClient.resolve).toHaveBeenCalledWith('index-pattern', 'some-index'); + expect(result).toEqual({ isDefaultIndexMigrated: true, defaultIndex: 'some-index' }); + }); + + it('returns the expected result if resolve fails with another error', async () => { + savedObjectsClient.resolve.mockRejectedValue( + SavedObjectsErrorHelpers.createIndexAliasNotFoundError('Oh no!') + ); + const result = await transformDefaultIndex({ + savedObjectsClient, + configAttributes: { defaultIndex: 'some-index' } as UpgradeableConfigAttributes, // We don't care about the other attributes + }); + + expect(savedObjectsClient.resolve).toHaveBeenCalledTimes(1); + expect(savedObjectsClient.resolve).toHaveBeenCalledWith('index-pattern', 'some-index'); + expect(result).toEqual({ isDefaultIndexMigrated: false, defaultIndex: 'some-index' }); + }); + }); +}); diff --git a/packages/core/ui-settings/core-ui-settings-server-internal/src/saved_objects/transforms.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/saved_objects/transforms.ts new file mode 100644 index 0000000000000..05bfbbf9d3a12 --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/saved_objects/transforms.ts @@ -0,0 +1,96 @@ +/* + * 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-utils-server'; +import type { SavedObjectsClientContract } from '@kbn/core-saved-objects-api-server'; +import type { UpgradeableConfigAttributes } from '../create_or_upgrade_saved_config'; + +/** + * The params needed to execute each transform function. + */ +interface TransformParams { + savedObjectsClient: SavedObjectsClientContract; + configAttributes: UpgradeableConfigAttributes | undefined; +} + +/** + * The resulting attributes that should be used when upgrading the config object. + * This should be a union of all transform function return types (A | B | C | ...). + */ +type TransformReturnType = TransformDefaultIndexReturnType; + +/** + * The return type for `transformDefaultIndex`. + * If this config object has already been upgraded, it returns `null` because it doesn't need to set different default attributes. + * Otherwise, it always sets a default for the `isDefaultIndexMigrated` attribute, and it optionally sets the `defaultIndex` attribute + * depending on the outcome. + */ +type TransformDefaultIndexReturnType = { + isDefaultIndexMigrated: boolean; + defaultIndex?: string; +} | null; + +export type TransformConfigFn = (params: TransformParams) => Promise; + +/** + * Any transforms that should be applied during `createOrUpgradeSavedConfig` need to be included in this array. + */ +export const transforms: TransformConfigFn[] = [transformDefaultIndex]; + +/** + * This optionally transforms the `defaultIndex` attribute of a config saved object. The `defaultIndex` attribute points to a data view ID, + * but those saved object IDs were regenerated in the 8.0 upgrade. That resulted in a bug where the `defaultIndex` would be broken in custom + * spaces. + * + * We are fixing this bug after the fact in 8.3, and we can't retroactively change a saved object that's already been migrated, so we use + * this transformation instead to ensure that the `defaultIndex` attribute is not broken. + * + * Note that what used to be called "index patterns" prior to 8.0 have been renamed to "data views", but the object type cannot be changed, + * so that type remains `index-pattern`. + * + * Note also that this function is only exported for unit testing. It is also included in the `transforms` export above, which is how it is + * applied during `createOrUpgradeSavedConfig`. + */ +export async function transformDefaultIndex( + params: TransformParams +): Promise { + const { savedObjectsClient, configAttributes } = params; + if (configAttributes?.isDefaultIndexMigrated) { + // This config object has already been migrated, return null because we don't need to set different defaults for the new config object. + return null; + } + if (!configAttributes?.defaultIndex) { + // If configAttributes is undefined (there's no config object being upgraded), OR if configAttributes is defined but the defaultIndex + // attribute is not set, set isDefaultIndexMigrated to true and return. This means there was no defaultIndex to upgrade, so we will just + // avoid attempting to transform this again in the future. + return { isDefaultIndexMigrated: true }; + } + + let defaultIndex = configAttributes.defaultIndex; // Retain the existing defaultIndex attribute in case we run into a resolve error + let isDefaultIndexMigrated: boolean; + try { + // The defaultIndex for this config object was created prior to 8.3, and it might refer to a data view ID that is no longer valid. + // We should try to resolve the data view and change the defaultIndex to the new ID, if necessary. + const resolvedDataView = await savedObjectsClient.resolve('index-pattern', defaultIndex); + if (resolvedDataView.outcome === 'aliasMatch' || resolvedDataView.outcome === 'conflict') { + // This resolved to an aliasMatch or conflict outcome; that means we should change the defaultIndex to the data view's new ID. + // Note, the alias_target_id field is guaranteed to exist iff the resolve outcome is aliasMatch or conflict. + defaultIndex = resolvedDataView.alias_target_id!; + } + isDefaultIndexMigrated = true; // Regardless of the resolve outcome, we now consider this defaultIndex attribute to be migrated + } catch (err) { + // If the defaultIndex is not found at all, it will throw a Not Found error and we should mark the defaultIndex attribute as upgraded. + if (SavedObjectsErrorHelpers.isNotFoundError(err)) { + isDefaultIndexMigrated = true; + } else { + // For any other error, explicitly set isDefaultIndexMigrated to false so we can try this upgrade again in the future. + isDefaultIndexMigrated = false; + } + } + return { isDefaultIndexMigrated, defaultIndex }; +} diff --git a/src/core/server/ui_settings/saved_objects/ui_settings.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/saved_objects/ui_settings.ts similarity index 100% rename from src/core/server/ui_settings/saved_objects/ui_settings.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/saved_objects/ui_settings.ts diff --git a/src/core/server/ui_settings/settings/accessibility.test.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/accessibility.test.ts similarity index 94% rename from src/core/server/ui_settings/settings/accessibility.test.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/settings/accessibility.test.ts index 9e7dbbfe28455..0441e87dfa5b1 100644 --- a/src/core/server/ui_settings/settings/accessibility.test.ts +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/accessibility.test.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { UiSettingsParams } from '../../../types'; +import type { UiSettingsParams } from '@kbn/core-ui-settings-common'; import { getAccessibilitySettings } from './accessibility'; describe('accessibility settings', () => { diff --git a/src/core/server/ui_settings/settings/accessibility.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/accessibility.ts similarity index 93% rename from src/core/server/ui_settings/settings/accessibility.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/settings/accessibility.ts index 36e756c3fc984..bd84cbc89f045 100644 --- a/src/core/server/ui_settings/settings/accessibility.ts +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/accessibility.ts @@ -8,7 +8,7 @@ import { schema } from '@kbn/config-schema'; import { i18n } from '@kbn/i18n'; -import { UiSettingsParams } from '../../../types'; +import type { UiSettingsParams } from '@kbn/core-ui-settings-common'; export const getAccessibilitySettings = (): Record => { return { diff --git a/src/core/server/ui_settings/settings/announcements.test.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/announcements.test.ts similarity index 94% rename from src/core/server/ui_settings/settings/announcements.test.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/settings/announcements.test.ts index ef32e85ef192a..0317402b28f10 100644 --- a/src/core/server/ui_settings/settings/announcements.test.ts +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/announcements.test.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { UiSettingsParams } from '../../../types'; +import type { UiSettingsParams } from '@kbn/core-ui-settings-common'; import { getAnnouncementsSettings } from './announcements'; describe('announcements settings', () => { diff --git a/src/core/server/ui_settings/settings/announcements.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/announcements.ts similarity index 93% rename from src/core/server/ui_settings/settings/announcements.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/settings/announcements.ts index 1f049feb462e8..12cfa29c4c37d 100644 --- a/src/core/server/ui_settings/settings/announcements.ts +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/announcements.ts @@ -8,7 +8,7 @@ import { schema } from '@kbn/config-schema'; import { i18n } from '@kbn/i18n'; -import { UiSettingsParams } from '../../../types'; +import type { UiSettingsParams } from '@kbn/core-ui-settings-common'; export const getAnnouncementsSettings = (): Record => { return { diff --git a/src/core/server/ui_settings/settings/date_formats.test.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/date_formats.test.ts similarity index 97% rename from src/core/server/ui_settings/settings/date_formats.test.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/settings/date_formats.test.ts index 57edd6f0b1a01..d34dc9cf7d934 100644 --- a/src/core/server/ui_settings/settings/date_formats.test.ts +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/date_formats.test.ts @@ -7,7 +7,7 @@ */ import moment from 'moment-timezone'; -import { UiSettingsParams } from '../../../types'; +import type { UiSettingsParams } from '@kbn/core-ui-settings-common'; import { getDateFormatSettings } from './date_formats'; describe('accessibility settings', () => { diff --git a/src/core/server/ui_settings/settings/date_formats.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/date_formats.ts similarity index 98% rename from src/core/server/ui_settings/settings/date_formats.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/settings/date_formats.ts index 039ead326a236..c13eae4965a54 100644 --- a/src/core/server/ui_settings/settings/date_formats.ts +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/date_formats.ts @@ -9,7 +9,7 @@ import moment from 'moment-timezone'; import { schema } from '@kbn/config-schema'; import { i18n } from '@kbn/i18n'; -import { UiSettingsParams } from '../../../types'; +import type { UiSettingsParams } from '@kbn/core-ui-settings-common'; export const getDateFormatSettings = (): Record => { const weekdays = moment.weekdays().slice(); diff --git a/src/core/server/ui_settings/settings/index.test.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/index.test.ts similarity index 100% rename from src/core/server/ui_settings/settings/index.test.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/settings/index.test.ts diff --git a/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/index.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/index.ts new file mode 100644 index 0000000000000..baf10af09acb6 --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/index.ts @@ -0,0 +1,36 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 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 { UiSettingsParams } from '@kbn/core-ui-settings-common'; +import { getAccessibilitySettings } from './accessibility'; +import { getDateFormatSettings } from './date_formats'; +import { getMiscUiSettings } from './misc'; +import { getNavigationSettings } from './navigation'; +import { getNotificationsSettings } from './notifications'; +import { getThemeSettings } from './theme'; +import { getStateSettings } from './state'; +import { getAnnouncementsSettings } from './announcements'; + +interface GetCoreSettingsOptions { + isDist?: boolean; +} + +export const getCoreSettings = ( + options?: GetCoreSettingsOptions +): Record => { + return { + ...getAccessibilitySettings(), + ...getAnnouncementsSettings(), + ...getDateFormatSettings(), + ...getMiscUiSettings(), + ...getNavigationSettings(), + ...getNotificationsSettings(), + ...getThemeSettings(options), + ...getStateSettings(), + }; +}; diff --git a/src/core/server/ui_settings/settings/misc.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/misc.ts similarity index 89% rename from src/core/server/ui_settings/settings/misc.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/settings/misc.ts index ad7411dfd12af..cdda2d7f7dc8b 100644 --- a/src/core/server/ui_settings/settings/misc.ts +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/misc.ts @@ -7,7 +7,7 @@ */ import { schema } from '@kbn/config-schema'; -import { UiSettingsParams } from '../types'; +import type { UiSettingsParams } from '@kbn/core-ui-settings-common'; export const getMiscUiSettings = (): Record => { return { diff --git a/src/core/server/ui_settings/settings/navigation.test.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/navigation.test.ts similarity index 94% rename from src/core/server/ui_settings/settings/navigation.test.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/settings/navigation.test.ts index 37f5e81f737e8..11c89c7662122 100644 --- a/src/core/server/ui_settings/settings/navigation.test.ts +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/navigation.test.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { UiSettingsParams } from '../../../types'; +import type { UiSettingsParams } from '@kbn/core-ui-settings-common'; import { getNavigationSettings } from './navigation'; describe('navigation settings', () => { diff --git a/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/navigation.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/navigation.ts new file mode 100644 index 0000000000000..c69889b84fc36 --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/navigation.ts @@ -0,0 +1,41 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { schema } from '@kbn/config-schema'; +import { i18n } from '@kbn/i18n'; +import { isRelativeUrl } from '@kbn/std'; +import type { UiSettingsParams } from '@kbn/core-ui-settings-common'; + +export const getNavigationSettings = (): Record => { + return { + defaultRoute: { + name: i18n.translate('core.ui_settings.params.defaultRoute.defaultRouteTitle', { + defaultMessage: 'Default route', + }), + value: '/app/home', + schema: schema.string({ + validate(value) { + if (!value.startsWith('/') || !isRelativeUrl(value)) { + return i18n.translate( + 'core.ui_settings.params.defaultRoute.defaultRouteIsRelativeValidationMessage', + { + defaultMessage: 'Must be a relative URL.', + } + ); + } + }, + }), + description: i18n.translate('core.ui_settings.params.defaultRoute.defaultRouteText', { + defaultMessage: + 'This setting specifies the default route when opening Kibana. ' + + 'You can use this setting to modify the landing page when opening Kibana. ' + + 'The route must be a relative URL.', + }), + }, + }; +}; diff --git a/src/core/server/ui_settings/settings/notifications.test.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/notifications.test.ts similarity index 98% rename from src/core/server/ui_settings/settings/notifications.test.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/settings/notifications.test.ts index 01e2905b0cc2c..59c3403080450 100644 --- a/src/core/server/ui_settings/settings/notifications.test.ts +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/notifications.test.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { UiSettingsParams } from '../../../types'; +import type { UiSettingsParams } from '@kbn/core-ui-settings-common'; import { getNotificationsSettings } from './notifications'; describe('notifications settings', () => { diff --git a/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/notifications.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/notifications.ts new file mode 100644 index 0000000000000..13101c22c94c7 --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/notifications.ts @@ -0,0 +1,94 @@ +/* + * 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 { i18n } from '@kbn/i18n'; +import type { UiSettingsParams } from '@kbn/core-ui-settings-common'; + +export const getNotificationsSettings = (): Record => { + return { + 'notifications:banner': { + name: i18n.translate('core.ui_settings.params.notifications.bannerTitle', { + defaultMessage: 'Custom banner notification', + }), + value: '', + type: 'markdown', + description: i18n.translate('core.ui_settings.params.notifications.bannerText', { + defaultMessage: + 'A custom banner intended for temporary notices to all users. {markdownLink}.', + description: + 'Part of composite text: core.ui_settings.params.notifications.bannerText + ' + + 'core.ui_settings.params.notifications.banner.markdownLinkText', + values: { + markdownLink: + `` + + i18n.translate('core.ui_settings.params.notifications.banner.markdownLinkText', { + defaultMessage: 'Markdown supported', + }) + + '', + }, + }), + category: ['notifications'], + sensitive: true, + schema: schema.string(), + }, + 'notifications:lifetime:banner': { + name: i18n.translate('core.ui_settings.params.notifications.bannerLifetimeTitle', { + defaultMessage: 'Banner notification lifetime', + }), + value: 3000000, + description: i18n.translate('core.ui_settings.params.notifications.bannerLifetimeText', { + defaultMessage: + 'The time in milliseconds which a banner notification will be displayed on-screen for. ', + }), + type: 'number', + category: ['notifications'], + schema: schema.oneOf([schema.number({ min: 0 }), schema.literal('Infinity')]), // Setting to 'Infinity' will disable the countdown. + }, + 'notifications:lifetime:error': { + name: i18n.translate('core.ui_settings.params.notifications.errorLifetimeTitle', { + defaultMessage: 'Error notification lifetime', + }), + value: 300000, + description: i18n.translate('core.ui_settings.params.notifications.errorLifetimeText', { + defaultMessage: + 'The time in milliseconds which an error notification will be displayed on-screen for. ', + }), + type: 'number', + category: ['notifications'], + schema: schema.oneOf([schema.number({ min: 0 }), schema.literal('Infinity')]), // Setting to 'Infinity' will disable + }, + 'notifications:lifetime:warning': { + name: i18n.translate('core.ui_settings.params.notifications.warningLifetimeTitle', { + defaultMessage: 'Warning notification lifetime', + }), + value: 10000, + description: i18n.translate('core.ui_settings.params.notifications.warningLifetimeText', { + defaultMessage: + 'The time in milliseconds which a warning notification will be displayed on-screen for. ', + }), + type: 'number', + category: ['notifications'], + schema: schema.oneOf([schema.number({ min: 0 }), schema.literal('Infinity')]), // Setting to 'Infinity' will disable + }, + 'notifications:lifetime:info': { + name: i18n.translate('core.ui_settings.params.notifications.infoLifetimeTitle', { + defaultMessage: 'Info notification lifetime', + }), + value: 5000, + description: i18n.translate('core.ui_settings.params.notifications.infoLifetimeText', { + defaultMessage: + 'The time in milliseconds which an information notification will be displayed on-screen for. ', + }), + type: 'number', + category: ['notifications'], + schema: schema.oneOf([schema.number({ min: 0 }), schema.literal('Infinity')]), // Setting to 'Infinity' will disable + }, + }; +}; diff --git a/src/core/server/ui_settings/settings/state.test.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/state.test.ts similarity index 94% rename from src/core/server/ui_settings/settings/state.test.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/settings/state.test.ts index 4304b29a9d989..ee7aed84415c1 100644 --- a/src/core/server/ui_settings/settings/state.test.ts +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/state.test.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { UiSettingsParams } from '../../../types'; +import type { UiSettingsParams } from '@kbn/core-ui-settings-common'; import { getStateSettings } from './state'; describe('state settings', () => { diff --git a/src/core/server/ui_settings/settings/state.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/state.ts similarity index 94% rename from src/core/server/ui_settings/settings/state.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/settings/state.ts index fa630b0a2b788..20441d46179a8 100644 --- a/src/core/server/ui_settings/settings/state.ts +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/state.ts @@ -8,7 +8,7 @@ import { schema } from '@kbn/config-schema'; import { i18n } from '@kbn/i18n'; -import { UiSettingsParams } from '../../../types'; +import type { UiSettingsParams } from '@kbn/core-ui-settings-common'; export const getStateSettings = (): Record => { return { diff --git a/src/core/server/ui_settings/settings/theme.test.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/theme.test.ts similarity index 96% rename from src/core/server/ui_settings/settings/theme.test.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/settings/theme.test.ts index 839ece4eaf8d0..78770b3ae62c7 100644 --- a/src/core/server/ui_settings/settings/theme.test.ts +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/theme.test.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { UiSettingsParams } from '../../../types'; +import type { UiSettingsParams } from '@kbn/core-ui-settings-common'; import { getThemeSettings } from './theme'; describe('theme settings', () => { diff --git a/src/core/server/ui_settings/settings/theme.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/theme.ts similarity index 96% rename from src/core/server/ui_settings/settings/theme.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/settings/theme.ts index 1c34314839916..1cece7db0bfed 100644 --- a/src/core/server/ui_settings/settings/theme.ts +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/settings/theme.ts @@ -9,7 +9,7 @@ import { schema } from '@kbn/config-schema'; import { i18n } from '@kbn/i18n'; import type { ThemeVersion } from '@kbn/ui-shared-deps-npm'; -import { UiSettingsParams } from '../../../types'; +import type { UiSettingsParams } from '@kbn/core-ui-settings-common'; function parseThemeTags() { if (!process.env.KBN_OPTIMIZER_THEMES || process.env.KBN_OPTIMIZER_THEMES === '*') { diff --git a/packages/core/ui-settings/core-ui-settings-server-internal/src/types.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/types.ts new file mode 100644 index 0000000000000..16af4b0d01d67 --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/types.ts @@ -0,0 +1,27 @@ +/* + * 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 { + IUiSettingsClient, + UiSettingsServiceSetup, + UiSettingsServiceStart, +} from '@kbn/core-ui-settings-server'; + +/** @internal */ +export interface InternalUiSettingsServicePreboot { + /** + * Creates a {@link IUiSettingsClient} that returns default values for the Core uiSettings. + */ + createDefaultsClient(): IUiSettingsClient; +} + +/** @internal */ +export type InternalUiSettingsServiceSetup = UiSettingsServiceSetup; + +/** @internal */ +export type InternalUiSettingsServiceStart = UiSettingsServiceStart; diff --git a/src/core/server/ui_settings/ui_settings_client.test.mock.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_client.test.mock.ts similarity index 100% rename from src/core/server/ui_settings/ui_settings_client.test.mock.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_client.test.mock.ts diff --git a/src/core/server/ui_settings/ui_settings_client.test.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_client.test.ts similarity index 100% rename from src/core/server/ui_settings/ui_settings_client.test.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_client.test.ts diff --git a/packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_client.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_client.ts new file mode 100644 index 0000000000000..908607463c4cd --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_client.ts @@ -0,0 +1,198 @@ +/* + * 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 { Logger } from '@kbn/logging'; +import type { SavedObjectsClientContract } from '@kbn/core-saved-objects-api-server'; +import { SavedObjectsErrorHelpers } from '@kbn/core-saved-objects-utils-server'; +import type { UiSettingsParams } from '@kbn/core-ui-settings-common'; +import { createOrUpgradeSavedConfig } from './create_or_upgrade_saved_config'; +import { CannotOverrideError } from './ui_settings_errors'; +import { Cache } from './cache'; +import { BaseUiSettingsClient } from './base_ui_settings_client'; + +export interface UiSettingsServiceOptions { + type: string; + id: string; + buildNum: number; + savedObjectsClient: SavedObjectsClientContract; + overrides?: Record; + defaults?: Record; + log: Logger; +} + +interface ReadOptions { + autoCreateOrUpgradeIfMissing?: boolean; +} + +interface UserProvidedValue { + userValue?: T; + isOverridden?: boolean; +} + +type UserProvided = Record>; + +export class UiSettingsClient extends BaseUiSettingsClient { + private readonly type: UiSettingsServiceOptions['type']; + private readonly id: UiSettingsServiceOptions['id']; + private readonly buildNum: UiSettingsServiceOptions['buildNum']; + private readonly savedObjectsClient: UiSettingsServiceOptions['savedObjectsClient']; + private readonly cache: Cache; + + constructor(options: UiSettingsServiceOptions) { + const { type, id, buildNum, savedObjectsClient, log, defaults = {}, overrides = {} } = options; + super({ overrides, defaults, log }); + + this.type = type; + this.id = id; + this.buildNum = buildNum; + this.savedObjectsClient = savedObjectsClient; + this.cache = new Cache(); + } + + async getUserProvided(): Promise> { + const cachedValue = this.cache.get(); + if (cachedValue) { + return cachedValue; + } + + const userProvided: UserProvided = this.onReadHook(await this.read()); + + // write all overridden keys, dropping the userValue is override is null and + // adding keys for overrides that are not in saved object + for (const [key, value] of Object.entries(this.overrides)) { + userProvided[key] = + value === null ? { isOverridden: true } : { isOverridden: true, userValue: value }; + } + + this.cache.set(userProvided); + + return userProvided; + } + + async setMany(changes: Record) { + this.cache.del(); + this.onWriteHook(changes); + await this.write({ changes }); + } + + async set(key: string, value: any) { + await this.setMany({ [key]: value }); + } + + async remove(key: string) { + await this.set(key, null); + } + + async removeMany(keys: string[]) { + const changes: Record = {}; + keys.forEach((key) => { + changes[key] = null; + }); + await this.setMany(changes); + } + + private assertUpdateAllowed(key: string) { + if (this.isOverridden(key)) { + throw new CannotOverrideError(`Unable to update "${key}" because it is overridden`); + } + } + + private onWriteHook(changes: Record) { + for (const key of Object.keys(changes)) { + this.assertUpdateAllowed(key); + } + + for (const [key, value] of Object.entries(changes)) { + this.validateKey(key, value); + } + } + + private onReadHook(values: Record) { + // write the userValue for each key stored in the saved object that is not overridden + // validate value read from saved objects as it can be changed via SO API + const filteredValues: UserProvided = {}; + for (const [key, userValue] of Object.entries(values)) { + if (userValue === null || this.isOverridden(key)) continue; + try { + this.validateKey(key, userValue); + filteredValues[key] = { + userValue: userValue as T, + }; + } catch (error) { + this.log.warn(`Ignore invalid UiSettings value. ${error}.`); + } + } + + return filteredValues; + } + + private async write({ + changes, + autoCreateOrUpgradeIfMissing = true, + }: { + changes: Record; + autoCreateOrUpgradeIfMissing?: boolean; + }) { + try { + await this.savedObjectsClient.update(this.type, this.id, changes); + } catch (error) { + if (!SavedObjectsErrorHelpers.isNotFoundError(error) || !autoCreateOrUpgradeIfMissing) { + throw error; + } + + await createOrUpgradeSavedConfig({ + savedObjectsClient: this.savedObjectsClient, + version: this.id, + buildNum: this.buildNum, + log: this.log, + handleWriteErrors: false, + }); + + await this.write({ + changes, + autoCreateOrUpgradeIfMissing: false, + }); + } + } + + private async read({ autoCreateOrUpgradeIfMissing = true }: ReadOptions = {}): Promise< + Record + > { + try { + const resp = await this.savedObjectsClient.get>(this.type, this.id); + return resp.attributes; + } catch (error) { + if (SavedObjectsErrorHelpers.isNotFoundError(error) && autoCreateOrUpgradeIfMissing) { + const failedUpgradeAttributes = await createOrUpgradeSavedConfig({ + savedObjectsClient: this.savedObjectsClient, + version: this.id, + buildNum: this.buildNum, + log: this.log, + handleWriteErrors: true, + }); + + if (!failedUpgradeAttributes) { + return await this.read({ autoCreateOrUpgradeIfMissing: false }); + } + + return failedUpgradeAttributes; + } + + if (this.isIgnorableError(error)) { + return {}; + } + + throw error; + } + } + + private isIgnorableError(error: Error) { + const { isForbiddenError, isEsUnavailableError } = SavedObjectsErrorHelpers; + return isForbiddenError(error) || isEsUnavailableError(error); + } +} diff --git a/src/core/server/ui_settings/ui_settings_config.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_config.ts similarity index 92% rename from src/core/server/ui_settings/ui_settings_config.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_config.ts index 20d2c5f30e396..5e5d5a05345ba 100644 --- a/src/core/server/ui_settings/ui_settings_config.ts +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_config.ts @@ -21,7 +21,7 @@ const configSchema = schema.object({ export type UiSettingsConfigType = TypeOf; -export const config: ServiceConfigDescriptor = { +export const uiSettingsConfig: ServiceConfigDescriptor = { path: 'uiSettings', schema: configSchema, deprecations, diff --git a/src/core/server/ui_settings/ui_settings_defaults_client.test.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_defaults_client.test.ts similarity index 100% rename from src/core/server/ui_settings/ui_settings_defaults_client.test.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_defaults_client.test.ts diff --git a/src/core/server/ui_settings/ui_settings_defaults_client.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_defaults_client.ts similarity index 95% rename from src/core/server/ui_settings/ui_settings_defaults_client.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_defaults_client.ts index 1865065adcea5..08e7b76dbf7ac 100644 --- a/src/core/server/ui_settings/ui_settings_defaults_client.ts +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_defaults_client.ts @@ -7,7 +7,7 @@ */ import type { Logger } from '@kbn/logging'; -import { UiSettingsParams, UserProvidedValues } from './types'; +import type { UiSettingsParams, UserProvidedValues } from '@kbn/core-ui-settings-common'; import { BaseUiSettingsClient } from './base_ui_settings_client'; export interface UiSettingsDefaultsClientOptions { diff --git a/src/core/server/ui_settings/ui_settings_errors.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_errors.ts similarity index 100% rename from src/core/server/ui_settings/ui_settings_errors.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_errors.ts diff --git a/src/core/server/ui_settings/ui_settings_route_handler_context.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_route_handler_context.ts similarity index 82% rename from src/core/server/ui_settings/ui_settings_route_handler_context.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_route_handler_context.ts index 09a6aa4c43d64..ca7f680c0e628 100644 --- a/src/core/server/ui_settings/ui_settings_route_handler_context.ts +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_route_handler_context.ts @@ -7,15 +7,11 @@ */ import type { CoreSavedObjectsRouteHandlerContext } from '@kbn/core-saved-objects-server-internal'; -import type { IUiSettingsClient, InternalUiSettingsServiceStart } from './types'; - -/** - * Core's `uiSettings` request handler context. - * @public - */ -export interface UiSettingsRequestHandlerContext { - client: IUiSettingsClient; -} +import type { + UiSettingsRequestHandlerContext, + IUiSettingsClient, +} from '@kbn/core-ui-settings-server'; +import type { InternalUiSettingsServiceStart } from './types'; /** * The {@link UiSettingsRequestHandlerContext} implementation. diff --git a/src/core/server/ui_settings/ui_settings_service.test.mock.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_service.test.mock.ts similarity index 100% rename from src/core/server/ui_settings/ui_settings_service.test.mock.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_service.test.mock.ts diff --git a/src/core/server/ui_settings/ui_settings_service.test.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_service.test.ts similarity index 100% rename from src/core/server/ui_settings/ui_settings_service.test.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_service.test.ts diff --git a/src/core/server/ui_settings/ui_settings_service.ts b/packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_service.ts similarity index 94% rename from src/core/server/ui_settings/ui_settings_service.ts rename to packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_service.ts index 04f22e51828c1..173547c8bda2e 100644 --- a/src/core/server/ui_settings/ui_settings_service.ts +++ b/packages/core/ui-settings/core-ui-settings-server-internal/src/ui_settings_service.ts @@ -13,20 +13,20 @@ import type { Logger } from '@kbn/logging'; import type { CoreContext, CoreService } from '@kbn/core-base-server-internal'; import type { InternalHttpServiceSetup } from '@kbn/core-http-server-internal'; import type { SavedObjectsClientContract } from '@kbn/core-saved-objects-api-server'; -import { InternalSavedObjectsServiceSetup } from '@kbn/core-saved-objects-server-internal'; -import { UiSettingsConfigType, config as uiConfigDefinition } from './ui_settings_config'; +import type { InternalSavedObjectsServiceSetup } from '@kbn/core-saved-objects-server-internal'; +import type { UiSettingsParams } from '@kbn/core-ui-settings-common'; +import { UiSettingsConfigType, uiSettingsConfig as uiConfigDefinition } from './ui_settings_config'; import { UiSettingsClient } from './ui_settings_client'; -import { +import type { InternalUiSettingsServicePreboot, InternalUiSettingsServiceSetup, InternalUiSettingsServiceStart, - UiSettingsParams, } from './types'; +import type { InternalUiSettingsRequestHandlerContext } from './internal_types'; import { uiSettingsType } from './saved_objects'; import { registerRoutes } from './routes'; import { getCoreSettings } from './settings'; import { UiSettingsDefaultsClient } from './ui_settings_defaults_client'; -import type { InternalUiSettingsRequestHandlerContext } from './internal_types'; export interface SetupDeps { http: InternalHttpServiceSetup; diff --git a/packages/core/ui-settings/core-ui-settings-server-internal/tsconfig.json b/packages/core/ui-settings/core-ui-settings-server-internal/tsconfig.json new file mode 100644 index 0000000000000..71bb40fe57f3f --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server-internal/tsconfig.json @@ -0,0 +1,17 @@ +{ + "extends": "../../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "declarationMap": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "**/*.ts", + ] +} diff --git a/packages/core/ui-settings/core-ui-settings-server-mocks/BUILD.bazel b/packages/core/ui-settings/core-ui-settings-server-mocks/BUILD.bazel new file mode 100644 index 0000000000000..332b7e19f9cf3 --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server-mocks/BUILD.bazel @@ -0,0 +1,107 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "core-ui-settings-server-mocks" +PKG_REQUIRE_NAME = "@kbn/core-ui-settings-server-mocks" + +SOURCE_FILES = glob( + [ + "**/*.ts", + ], + exclude = [ + "**/*.config.js", + "**/*.test.*", + "**/*.stories.*", + "**/__snapshots__/**", + "**/integration_tests/**", + "**/mocks/**", + "**/scripts/**", + "**/storybook/**", + "**/test_fixtures/**", + "**/test_helpers/**", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +RUNTIME_DEPS = [ +] + +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", + "//packages/kbn-utility-types:npm_module_types", + "//packages/core/ui-settings/core-ui-settings-server:npm_module_types", + "//packages/core/ui-settings/core-ui-settings-server-internal:npm_module_types", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + declaration_map = True, + emit_declaration_only = True, + out_dir = "target_types", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/core/ui-settings/core-ui-settings-server-mocks/README.md b/packages/core/ui-settings/core-ui-settings-server-mocks/README.md new file mode 100644 index 0000000000000..8ce5bc6201c16 --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server-mocks/README.md @@ -0,0 +1,4 @@ +# @kbn/core-ui-settings-server-mocks + +This package contains the mocks for the server-side uiSettings service: +- `uiSettingsServiceMock` diff --git a/packages/core/ui-settings/core-ui-settings-server-mocks/index.ts b/packages/core/ui-settings/core-ui-settings-server-mocks/index.ts new file mode 100644 index 0000000000000..3a0ca94d059dd --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server-mocks/index.ts @@ -0,0 +1,9 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export { uiSettingsServiceMock } from './src'; diff --git a/packages/core/ui-settings/core-ui-settings-server-mocks/jest.config.js b/packages/core/ui-settings/core-ui-settings-server-mocks/jest.config.js new file mode 100644 index 0000000000000..2e4e9bb23e8b9 --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server-mocks/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test/jest_node', + rootDir: '../../../..', + roots: ['/packages/core/ui-settings/core-ui-settings-server-mocks'], +}; diff --git a/packages/core/ui-settings/core-ui-settings-server-mocks/kibana.jsonc b/packages/core/ui-settings/core-ui-settings-server-mocks/kibana.jsonc new file mode 100644 index 0000000000000..5426961c3a663 --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server-mocks/kibana.jsonc @@ -0,0 +1,7 @@ +{ + "type": "shared-common", + "id": "@kbn/core-ui-settings-server-mocks", + "owner": "@elastic/kibana-core", + "runtimeDeps": [], + "typeDeps": [], +} diff --git a/packages/core/ui-settings/core-ui-settings-server-mocks/package.json b/packages/core/ui-settings/core-ui-settings-server-mocks/package.json new file mode 100644 index 0000000000000..1984eb8ec5d61 --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server-mocks/package.json @@ -0,0 +1,8 @@ +{ + "name": "@kbn/core-ui-settings-server-mocks", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "author": "Kibana Core", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/packages/core/ui-settings/core-ui-settings-server-mocks/src/index.ts b/packages/core/ui-settings/core-ui-settings-server-mocks/src/index.ts new file mode 100644 index 0000000000000..1eaa0bff3a4c7 --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server-mocks/src/index.ts @@ -0,0 +1,9 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export { uiSettingsServiceMock } from './ui_settings_service.mock'; diff --git a/src/core/server/ui_settings/ui_settings_service.mock.ts b/packages/core/ui-settings/core-ui-settings-server-mocks/src/ui_settings_service.mock.ts similarity index 93% rename from src/core/server/ui_settings/ui_settings_service.mock.ts rename to packages/core/ui-settings/core-ui-settings-server-mocks/src/ui_settings_service.mock.ts index d505074ee824a..8a8c3fddd1765 100644 --- a/src/core/server/ui_settings/ui_settings_service.mock.ts +++ b/packages/core/ui-settings/core-ui-settings-server-mocks/src/ui_settings_service.mock.ts @@ -7,13 +7,13 @@ */ import type { PublicMethodsOf } from '@kbn/utility-types'; -import { - IUiSettingsClient, +import type { IUiSettingsClient } from '@kbn/core-ui-settings-server'; +import type { InternalUiSettingsServiceSetup, InternalUiSettingsServiceStart, InternalUiSettingsServicePreboot, -} from './types'; -import type { UiSettingsService } from './ui_settings_service'; + UiSettingsService, +} from '@kbn/core-ui-settings-server-internal'; const createClientMock = () => { const mocked: jest.Mocked = { diff --git a/packages/core/ui-settings/core-ui-settings-server-mocks/tsconfig.json b/packages/core/ui-settings/core-ui-settings-server-mocks/tsconfig.json new file mode 100644 index 0000000000000..71bb40fe57f3f --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server-mocks/tsconfig.json @@ -0,0 +1,17 @@ +{ + "extends": "../../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "declarationMap": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "**/*.ts", + ] +} diff --git a/packages/core/ui-settings/core-ui-settings-server/BUILD.bazel b/packages/core/ui-settings/core-ui-settings-server/BUILD.bazel new file mode 100644 index 0000000000000..c28f92633e949 --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server/BUILD.bazel @@ -0,0 +1,107 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "core-ui-settings-server" +PKG_REQUIRE_NAME = "@kbn/core-ui-settings-server" + +SOURCE_FILES = glob( + [ + "**/*.ts", + ], + exclude = [ + "**/*.config.js", + "**/*.mock.*", + "**/*.test.*", + "**/*.stories.*", + "**/__snapshots__/**", + "**/integration_tests/**", + "**/mocks/**", + "**/scripts/**", + "**/storybook/**", + "**/test_fixtures/**", + "**/test_helpers/**", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +RUNTIME_DEPS = [ +] + +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", + "//packages/core/saved-objects/core-saved-objects-api-server:npm_module_types", + "//packages/core/ui-settings/core-ui-settings-common:npm_module_types", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + declaration_map = True, + emit_declaration_only = True, + out_dir = "target_types", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/core/ui-settings/core-ui-settings-server/README.md b/packages/core/ui-settings/core-ui-settings-server/README.md new file mode 100644 index 0000000000000..5150e7b6f7d22 --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server/README.md @@ -0,0 +1,3 @@ +# @kbn/core-ui-settings-server + +This package contains the public types for the server-side ui-settings service. diff --git a/packages/core/ui-settings/core-ui-settings-server/index.ts b/packages/core/ui-settings/core-ui-settings-server/index.ts new file mode 100644 index 0000000000000..d2759b6f6d21c --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server/index.ts @@ -0,0 +1,14 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export type { + IUiSettingsClient, + UiSettingsServiceSetup, + UiSettingsServiceStart, + UiSettingsRequestHandlerContext, +} from './src'; diff --git a/packages/core/ui-settings/core-ui-settings-server/jest.config.js b/packages/core/ui-settings/core-ui-settings-server/jest.config.js new file mode 100644 index 0000000000000..9ed815b3f223c --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test/jest_node', + rootDir: '../../../..', + roots: ['/packages/core/ui-settings/core-ui-settings-server'], +}; diff --git a/packages/core/ui-settings/core-ui-settings-server/kibana.jsonc b/packages/core/ui-settings/core-ui-settings-server/kibana.jsonc new file mode 100644 index 0000000000000..5ac08792e518e --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server/kibana.jsonc @@ -0,0 +1,7 @@ +{ + "type": "shared-common", + "id": "@kbn/core-ui-settings-server", + "owner": "@elastic/kibana-core", + "runtimeDeps": [], + "typeDeps": [], +} diff --git a/packages/core/ui-settings/core-ui-settings-server/package.json b/packages/core/ui-settings/core-ui-settings-server/package.json new file mode 100644 index 0000000000000..930339f0db50a --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server/package.json @@ -0,0 +1,8 @@ +{ + "name": "@kbn/core-ui-settings-server", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "author": "Kibana Core", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/packages/core/ui-settings/core-ui-settings-server/src/contracts.ts b/packages/core/ui-settings/core-ui-settings-server/src/contracts.ts new file mode 100644 index 0000000000000..b078da6a4ec46 --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server/src/contracts.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. + */ + +import type { UiSettingsParams } from '@kbn/core-ui-settings-common'; +import type { SavedObjectsClientContract } from '@kbn/core-saved-objects-api-server'; +import type { IUiSettingsClient } from './ui_settings_client'; + +/** @public */ +export interface UiSettingsServiceSetup { + /** + * Sets settings with default values for the uiSettings. + * @param settings + * + * @example + * ```ts + * setup(core: CoreSetup){ + * core.uiSettings.register([{ + * foo: { + * name: i18n.translate('my foo settings'), + * value: true, + * description: 'add some awesomeness', + * }, + * }]); + * } + * ``` + */ + register(settings: Record): void; +} + +/** @public */ +export interface UiSettingsServiceStart { + /** + * Creates a {@link IUiSettingsClient} with provided *scoped* saved objects client. + * + * This should only be used in the specific case where the client needs to be accessed + * from outside of the scope of a {@link RequestHandler}. + * + * @example + * ```ts + * start(core: CoreStart) { + * const soClient = core.savedObjects.getScopedClient(arbitraryRequest); + * const uiSettingsClient = core.uiSettings.asScopedToClient(soClient); + * } + * ``` + */ + asScopedToClient(savedObjectsClient: SavedObjectsClientContract): IUiSettingsClient; +} diff --git a/packages/core/ui-settings/core-ui-settings-server/src/index.ts b/packages/core/ui-settings/core-ui-settings-server/src/index.ts new file mode 100644 index 0000000000000..d409cb2e6757e --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server/src/index.ts @@ -0,0 +1,11 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export type { IUiSettingsClient } from './ui_settings_client'; +export type { UiSettingsServiceSetup, UiSettingsServiceStart } from './contracts'; +export type { UiSettingsRequestHandlerContext } from './request_handler_context'; diff --git a/packages/core/ui-settings/core-ui-settings-server/src/request_handler_context.ts b/packages/core/ui-settings/core-ui-settings-server/src/request_handler_context.ts new file mode 100644 index 0000000000000..32c59539abf94 --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server/src/request_handler_context.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 type { IUiSettingsClient } from './ui_settings_client'; + +/** + * Core's `uiSettings` request handler context. + * @public + */ +export interface UiSettingsRequestHandlerContext { + client: IUiSettingsClient; +} diff --git a/packages/core/ui-settings/core-ui-settings-server/src/ui_settings_client.ts b/packages/core/ui-settings/core-ui-settings-server/src/ui_settings_client.ts new file mode 100644 index 0000000000000..fa8022be605c5 --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server/src/ui_settings_client.ts @@ -0,0 +1,60 @@ +/* + * 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 { UserProvidedValues, PublicUiSettingsParams } from '@kbn/core-ui-settings-common'; + +/** + * Server-side client that provides access to the advanced settings stored in elasticsearch. + * The settings provide control over the behavior of the Kibana application. + * For example, a user can specify how to display numeric or date fields. + * Users can adjust the settings via Management UI. + * + * @public + */ +export interface IUiSettingsClient { + /** + * Returns registered uiSettings values {@link UiSettingsParams} + */ + getRegistered: () => Readonly>; + /** + * Retrieves uiSettings values set by the user with fallbacks to default values if not specified. + */ + get: (key: string) => Promise; + /** + * Retrieves a set of all uiSettings values set by the user with fallbacks to default values if not specified. + */ + getAll: () => Promise>; + /** + * Retrieves a set of all uiSettings values set by the user. + */ + getUserProvided: () => Promise>>; + /** + * Writes multiple uiSettings values and marks them as set by the user. + */ + setMany: (changes: Record) => Promise; + /** + * Writes uiSettings value and marks it as set by the user. + */ + set: (key: string, value: any) => Promise; + /** + * Removes uiSettings value by key. + */ + remove: (key: string) => Promise; + /** + * Removes multiple uiSettings values by keys. + */ + removeMany: (keys: string[]) => Promise; + /** + * Shows whether the uiSettings value set by the user. + */ + isOverridden: (key: string) => boolean; + /** + * Shows whether the uiSetting is a sensitive value. Used by telemetry to not send sensitive values. + */ + isSensitive: (key: string) => boolean; +} diff --git a/packages/core/ui-settings/core-ui-settings-server/tsconfig.json b/packages/core/ui-settings/core-ui-settings-server/tsconfig.json new file mode 100644 index 0000000000000..71bb40fe57f3f --- /dev/null +++ b/packages/core/ui-settings/core-ui-settings-server/tsconfig.json @@ -0,0 +1,17 @@ +{ + "extends": "../../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "declarationMap": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "**/*.ts", + ] +} diff --git a/packages/kbn-apm-config-loader/kibana.jsonc b/packages/kbn-apm-config-loader/kibana.jsonc index d817476c0b6db..904a7eda0177a 100644 --- a/packages/kbn-apm-config-loader/kibana.jsonc +++ b/packages/kbn-apm-config-loader/kibana.jsonc @@ -1,7 +1,7 @@ { "type": "shared-common", "id": "@kbn/apm-config-loader", - "owner": "@elastic/kibana-core", + "owner": ["@elastic/kibana-core", "@vigneshshanmugam"], "runtimeDeps": [], "typeDeps": [] } diff --git a/packages/kbn-apm-synthtrace/README.md b/packages/kbn-apm-synthtrace/README.md index dcd50215c6a85..4aaaeee5b672c 100644 --- a/packages/kbn-apm-synthtrace/README.md +++ b/packages/kbn-apm-synthtrace/README.md @@ -27,7 +27,7 @@ This library can currently be used in two ways: ```ts import { service, timerange, toElasticsearchOutput } from '@kbn/apm-synthtrace'; -const instance = service('synth-go', 'production', 'go').instance('instance-a'); +const instance = service({name: 'synth-go', environment: 'production', agentName: 'go'}).instance('instance-a'); const from = new Date('2021-01-01T12:00:00.000Z').getTime(); const to = new Date('2021-01-01T12:00:00.000Z').getTime(); @@ -37,7 +37,7 @@ const traceEvents = timerange(from, to) .rate(10) .flatMap((timestamp) => instance - .transaction('GET /api/product/list') + .transaction({transactionName: 'GET /api/product/list'}) .timestamp(timestamp) .duration(1000) .success() diff --git a/packages/kbn-apm-synthtrace/src/lib/apm/apm_fields.ts b/packages/kbn-apm-synthtrace/src/lib/apm/apm_fields.ts index 690e6c3563f27..7736aa8e8879b 100644 --- a/packages/kbn-apm-synthtrace/src/lib/apm/apm_fields.ts +++ b/packages/kbn-apm-synthtrace/src/lib/apm/apm_fields.ts @@ -18,6 +18,10 @@ export type ApmApplicationMetricFields = Partial<{ 'jvm.memory.heap.used': number; 'jvm.memory.non_heap.used': number; 'jvm.thread.count': number; + 'faas.billed_duration': number; + 'faas.timeout': number; + 'faas.coldstart_duration': number; + 'faas.duration': number; }>; export type ApmUserAgentFields = Partial<{ @@ -104,6 +108,7 @@ export type ApmFields = Fields & 'cloud.region': string; 'host.os.platform': string; 'faas.id': string; + 'faas.name': string; 'faas.coldstart': boolean; 'faas.execution': string; 'faas.trigger.type': string; diff --git a/packages/kbn-apm-synthtrace/src/lib/apm/browser.ts b/packages/kbn-apm-synthtrace/src/lib/apm/browser.ts index ebba6a0e89a69..89a1ac5d34a1d 100644 --- a/packages/kbn-apm-synthtrace/src/lib/apm/browser.ts +++ b/packages/kbn-apm-synthtrace/src/lib/apm/browser.ts @@ -12,7 +12,13 @@ import { RumSpan } from './rum_span'; import { RumTransaction } from './rum_transaction'; export class Browser extends Entity { - transaction(transactionName: string, transactionType: string = 'page-load') { + transaction({ + transactionName, + transactionType = 'page-load', + }: { + transactionName: string; + transactionType?: string; + }) { return new RumTransaction({ ...this.fields, 'transaction.name': transactionName, @@ -20,7 +26,15 @@ export class Browser extends Entity { }); } - span(spanName: string, spanType: string, spanSubtype: string) { + span({ + spanName, + spanType, + spanSubtype, + }: { + spanName: string; + spanType: string; + spanSubtype: string; + }) { return new RumSpan({ ...this.fields, 'span.name': spanName, @@ -30,11 +44,19 @@ export class Browser extends Entity { } } -export function browser(serviceName: string, production: string, userAgent: ApmUserAgentFields) { +export function browser({ + serviceName, + environment, + userAgent, +}: { + serviceName: string; + environment: string; + userAgent: ApmUserAgentFields; +}) { return new Browser({ 'agent.name': 'rum-js', 'service.name': serviceName, - 'service.environment': production, + 'service.environment': environment, ...userAgent, }); } diff --git a/packages/kbn-apm-synthtrace/src/lib/apm/index.ts b/packages/kbn-apm-synthtrace/src/lib/apm/index.ts index a136daabee8f2..84e6bfc9e8126 100644 --- a/packages/kbn-apm-synthtrace/src/lib/apm/index.ts +++ b/packages/kbn-apm-synthtrace/src/lib/apm/index.ts @@ -7,6 +7,7 @@ */ import { service } from './service'; import { browser } from './browser'; +import { serverlessFunction } from './serverless_function'; import { getTransactionMetrics } from './processors/get_transaction_metrics'; import { getSpanDestinationMetrics } from './processors/get_span_destination_metrics'; import { getChromeUserAgentDefaults } from './defaults/get_chrome_user_agent_defaults'; @@ -27,6 +28,7 @@ export const apm = { getApmWriteTargets, ApmSynthtraceEsClient, ApmSynthtraceKibanaClient, + serverlessFunction, }; export type { ApmSynthtraceEsClient, ApmException }; diff --git a/packages/kbn-apm-synthtrace/src/lib/apm/instance.ts b/packages/kbn-apm-synthtrace/src/lib/apm/instance.ts index d212c1f2cead0..32a81de9f307a 100644 --- a/packages/kbn-apm-synthtrace/src/lib/apm/instance.ts +++ b/packages/kbn-apm-synthtrace/src/lib/apm/instance.ts @@ -14,7 +14,13 @@ import { Transaction } from './transaction'; import { ApmApplicationMetricFields, ApmFields } from './apm_fields'; export class Instance extends Entity { - transaction(transactionName: string, transactionType = 'request') { + transaction({ + transactionName, + transactionType = 'request', + }: { + transactionName: string; + transactionType?: string; + }) { return new Transaction({ ...this.fields, 'transaction.name': transactionName, @@ -22,7 +28,16 @@ export class Instance extends Entity { }); } - span(spanName: string, spanType: string, spanSubtype?: string, apmFields?: ApmFields) { + span({ + spanName, + spanType, + spanSubtype, + ...apmFields + }: { + spanName: string; + spanType: string; + spanSubtype?: string; + } & ApmFields) { return new Span({ ...this.fields, ...apmFields, @@ -32,7 +47,15 @@ export class Instance extends Entity { }); } - error(message: string, type?: string, groupingName?: string) { + error({ + message, + type, + groupingName, + }: { + message: string; + type?: string; + groupingName?: string; + }) { return new ApmError({ ...this.fields, 'error.exception': [{ message, ...(type ? { type } : {}) }], diff --git a/packages/kbn-apm-synthtrace/src/lib/apm/serverless.ts b/packages/kbn-apm-synthtrace/src/lib/apm/serverless.ts new file mode 100644 index 0000000000000..b67586c18a074 --- /dev/null +++ b/packages/kbn-apm-synthtrace/src/lib/apm/serverless.ts @@ -0,0 +1,88 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { generateLongId, generateShortId } from '../utils/generate_id'; +import { ApmFields } from './apm_fields'; +import { BaseSpan } from './base_span'; +import { Metricset } from './metricset'; + +export type FaasTriggerType = 'http' | 'pubsub' | 'datasource' | 'timer' | 'other'; + +export class Serverless extends BaseSpan { + private readonly metric: Metricset; + + constructor(fields: ApmFields) { + const faasExection = generateLongId(); + const triggerType = 'other'; + super({ + ...fields, + 'processor.event': 'transaction', + 'transaction.id': generateShortId(), + 'transaction.sampled': true, + 'faas.execution': faasExection, + 'faas.trigger.type': triggerType, + 'transaction.name': fields['transaction.name'] || fields['faas.name'], + 'transaction.type': 'request', + }); + this.metric = new Metricset({ + ...fields, + 'metricset.name': 'app', + 'faas.execution': faasExection, + 'faas.id': fields['service.name'], + }); + } + + duration(duration: number) { + this.fields['transaction.duration.us'] = duration * 1000; + return this; + } + + coldStart(coldstart: boolean) { + this.fields['faas.coldstart'] = coldstart; + this.metric.fields['faas.coldstart'] = coldstart; + return this; + } + + billedDuration(billedDuration: number) { + this.metric.fields['faas.billed_duration'] = billedDuration; + return this; + } + + faasTimeout(faasTimeout: number) { + this.metric.fields['faas.timeout'] = faasTimeout; + return this; + } + + memory({ total, free }: { total: number; free: number }) { + this.metric.fields['system.memory.total'] = total; + this.metric.fields['system.memory.actual.free'] = free; + return this; + } + + coldStartDuration(coldStartDuration: number) { + this.metric.fields['faas.coldstart_duration'] = coldStartDuration; + return this; + } + + faasDuration(faasDuration: number) { + this.metric.fields['faas.duration'] = faasDuration; + return this; + } + + timestamp(time: number): this { + super.timestamp(time); + this.metric.fields['@timestamp'] = time; + return this; + } + + serialize(): ApmFields[] { + const transaction = super.serialize(); + const metric = this.metric.serialize(); + return [...transaction, ...metric]; + } +} diff --git a/packages/kbn-apm-synthtrace/src/lib/apm/serverless_function.ts b/packages/kbn-apm-synthtrace/src/lib/apm/serverless_function.ts new file mode 100644 index 0000000000000..e10bb23b1f933 --- /dev/null +++ b/packages/kbn-apm-synthtrace/src/lib/apm/serverless_function.ts @@ -0,0 +1,45 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { Entity } from '../entity'; +import { generateShortId } from '../utils/generate_id'; +import { ApmFields } from './apm_fields'; +import { ServerlessInstance } from './serverless_instance'; + +export class ServerlessFunction extends Entity { + instance({ instanceName, ...apmFields }: { instanceName: string } & ApmFields) { + return new ServerlessInstance({ + ...this.fields, + ['service.node.name']: instanceName, + 'host.name': instanceName, + ...apmFields, + }); + } +} + +export function serverlessFunction({ + functionName, + serviceName, + environment, + agentName, +}: { + functionName: string; + environment: string; + agentName: string; + serviceName?: string; +}) { + const faasId = `arn:aws:lambda:us-west-2:${generateShortId()}:function:${functionName}`; + return new ServerlessFunction({ + 'service.name': serviceName || faasId, + 'faas.id': faasId, + 'faas.name': functionName, + 'service.environment': environment, + 'agent.name': agentName, + 'service.runtime.name': 'AWS_lambda', + }); +} diff --git a/packages/kbn-apm-synthtrace/src/lib/apm/serverless_instance.ts b/packages/kbn-apm-synthtrace/src/lib/apm/serverless_instance.ts new file mode 100644 index 0000000000000..2d1626add7719 --- /dev/null +++ b/packages/kbn-apm-synthtrace/src/lib/apm/serverless_instance.ts @@ -0,0 +1,22 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { Entity } from '../entity'; +import { ApmFields } from './apm_fields'; +import { FaasTriggerType, Serverless } from './serverless'; + +export class ServerlessInstance extends Entity { + invocation(params: { transactionName?: string; faasTriggerType?: FaasTriggerType } = {}) { + const { transactionName, faasTriggerType = 'other' } = params; + return new Serverless({ + ...this.fields, + 'transaction.name': transactionName, + 'faas.trigger.type': faasTriggerType, + }); + } +} diff --git a/packages/kbn-apm-synthtrace/src/lib/apm/service.ts b/packages/kbn-apm-synthtrace/src/lib/apm/service.ts index ded149f0b6236..0939535a87135 100644 --- a/packages/kbn-apm-synthtrace/src/lib/apm/service.ts +++ b/packages/kbn-apm-synthtrace/src/lib/apm/service.ts @@ -20,7 +20,15 @@ export class Service extends Entity { } } -export function service(name: string, environment: string, agentName: string) { +export function service({ + name, + environment, + agentName, +}: { + name: string; + environment: string; + agentName: string; +}) { return new Service({ 'service.name': name, 'service.environment': environment, diff --git a/packages/kbn-apm-synthtrace/src/lib/apm/span.ts b/packages/kbn-apm-synthtrace/src/lib/apm/span.ts index 388e65385e7dd..a5795ae321478 100644 --- a/packages/kbn-apm-synthtrace/src/lib/apm/span.ts +++ b/packages/kbn-apm-synthtrace/src/lib/apm/span.ts @@ -47,7 +47,7 @@ export function httpExitSpan({ }: { spanName: string; destinationUrl: string; -}): [string, string, string, ApmFields] { +}) { // origin: 'http://opbeans-go:3000', // host: 'opbeans-go:3000', // hostname: 'opbeans-go', @@ -57,39 +57,29 @@ export function httpExitSpan({ const spanType = 'external'; const spanSubType = 'http'; - return [ + return { spanName, spanType, spanSubType, - { - 'destination.address': destination.hostname, - 'destination.port': parseInt(destination.port, 10), - 'service.target.name': destination.host, - 'span.destination.service.name': destination.origin, - 'span.destination.service.resource': destination.host, - 'span.destination.service.type': 'external', - }, - ]; + 'destination.address': destination.hostname, + 'destination.port': parseInt(destination.port, 10), + 'service.target.name': destination.host, + 'span.destination.service.name': destination.origin, + 'span.destination.service.resource': destination.host, + 'span.destination.service.type': 'external', + }; } -export function dbExitSpan({ - spanName, - spanSubType, -}: { - spanName: string; - spanSubType?: string; -}): [string, string, string | undefined, ApmFields] { +export function dbExitSpan({ spanName, spanSubType }: { spanName: string; spanSubType?: string }) { const spanType = 'db'; - return [ + return { spanName, spanType, spanSubType, - { - 'service.target.type': spanSubType, - 'span.destination.service.name': spanSubType, - 'span.destination.service.resource': spanSubType, - 'span.destination.service.type': spanType, - }, - ]; + 'service.target.type': spanSubType, + 'span.destination.service.name': spanSubType, + 'span.destination.service.resource': spanSubType, + 'span.destination.service.type': spanType, + }; } diff --git a/packages/kbn-apm-synthtrace/src/scenarios/aws_lambda.ts b/packages/kbn-apm-synthtrace/src/scenarios/aws_lambda.ts index fa04d6e4f6465..b89b0b5ea5f16 100644 --- a/packages/kbn-apm-synthtrace/src/scenarios/aws_lambda.ts +++ b/packages/kbn-apm-synthtrace/src/scenarios/aws_lambda.ts @@ -7,53 +7,90 @@ */ import { apm, timerange } from '../..'; -import { ApmFields } from '../lib/apm/apm_fields'; import { Scenario } from '../cli/scenario'; -import { getLogger } from '../cli/utils/get_common_services'; import { RunOptions } from '../cli/utils/parse_run_cli_flags'; +import { ApmFields } from '../lib/apm/apm_fields'; import { getSynthtraceEnvironment } from '../lib/utils/get_synthtrace_environment'; const ENVIRONMENT = getSynthtraceEnvironment(__filename); const scenario: Scenario = async (runOptions: RunOptions) => { - const logger = getLogger(runOptions); - return { generate: ({ from, to }) => { const range = timerange(from, to); const timestamps = range.ratePerMinute(180); - const instance = apm.service('lambda-python', ENVIRONMENT, 'python').instance('instance'); - - const traceEventsSetups = [ - { functionName: 'lambda-python-1', coldStart: true }, - { functionName: 'lambda-python-2', coldStart: false }, - ]; - - const traceEvents = ({ functionName, coldStart }: typeof traceEventsSetups[0]) => { - return timestamps.generator((timestamp) => - instance - .transaction('GET /order/{id}') - .defaults({ - 'service.runtime.name': 'AWS_Lambda_python3.8', - 'cloud.provider': 'aws', - 'cloud.service.name': 'lambda', - 'cloud.region': 'us-east-1', - 'faas.id': `arn:aws:lambda:us-west-2:123456789012:function:${functionName}`, - 'faas.coldstart': coldStart, - 'faas.trigger.type': 'other', - }) + const cloudFields: ApmFields = { + 'cloud.provider': 'aws', + 'cloud.service.name': 'lambda', + 'cloud.region': 'us-west-2', + }; + + const instanceALambdaPython = apm + .serverlessFunction({ + serviceName: 'aws-lambdas', + environment: ENVIRONMENT, + agentName: 'python', + functionName: 'fn-python-1', + }) + .instance({ instanceName: 'instance_A', ...cloudFields }); + + const instanceALambdaNode = apm + .serverlessFunction({ + serviceName: 'aws-lambdas', + environment: ENVIRONMENT, + agentName: 'nodejs', + functionName: 'fn-node-1', + }) + .instance({ instanceName: 'instance_A', ...cloudFields }); + + const instanceALambdaNode2 = apm + .serverlessFunction({ + environment: ENVIRONMENT, + agentName: 'nodejs', + functionName: 'fn-node-2', + }) + .instance({ instanceName: 'instance_A', ...cloudFields }); + + const memory = { + total: 536870912, // 0.5gb + free: 94371840, // ~0.08 gb + }; + + const awsLambdaEvents = timestamps.generator((timestamp) => { + return [ + instanceALambdaPython + .invocation() + .duration(1000) .timestamp(timestamp) + .coldStart(true) + .billedDuration(4000) + .faasTimeout(10000) + .memory(memory) + .coldStartDuration(4000) + .faasDuration(4000), + instanceALambdaNode + .invocation() .duration(1000) - .success() - ); - }; + .timestamp(timestamp) + .coldStart(false) + .billedDuration(4000) + .faasTimeout(10000) + .memory(memory) + .faasDuration(4000), + instanceALambdaNode2 + .invocation() + .duration(1000) + .timestamp(timestamp) + .coldStart(false) + .billedDuration(4000) + .faasTimeout(10000) + .memory(memory) + .faasDuration(4000), + ]; + }); - return traceEventsSetups - .map((traceEventsSetup) => - logger.perf('generating_apm_events', () => traceEvents(traceEventsSetup)) - ) - .reduce((p, c) => p.merge(c)); + return awsLambdaEvents; }, }; }; diff --git a/packages/kbn-apm-synthtrace/src/scenarios/distributed_trace.ts b/packages/kbn-apm-synthtrace/src/scenarios/distributed_trace.ts index a87cbfe5ab4d3..7834011afa69a 100644 --- a/packages/kbn-apm-synthtrace/src/scenarios/distributed_trace.ts +++ b/packages/kbn-apm-synthtrace/src/scenarios/distributed_trace.ts @@ -23,23 +23,27 @@ const scenario: Scenario = async (runOptions: RunOptions) => { const transactionName = '240rpm/75% 1000ms'; const successfulTimestamps = range.interval('1s').rate(3); - const opbeansRum = apm.service('opbeans-rum', ENVIRONMENT, 'rum-js').instance('my-instance'); + const opbeansRum = apm + .service({ name: 'opbeans-rum', environment: ENVIRONMENT, agentName: 'rum-js' }) + .instance('my-instance'); const opbeansNode = apm - .service('opbeans-node', ENVIRONMENT, 'nodejs') + .service({ name: 'opbeans-node', environment: ENVIRONMENT, agentName: 'nodejs' }) + .instance('my-instance'); + const opbeansGo = apm + .service({ name: 'opbeans-go', environment: ENVIRONMENT, agentName: 'go' }) .instance('my-instance'); - const opbeansGo = apm.service('opbeans-go', ENVIRONMENT, 'go').instance('my-instance'); const traces = successfulTimestamps.generator((timestamp) => { // opbeans-rum return opbeansRum - .transaction(transactionName) + .transaction({ transactionName }) .duration(400) .timestamp(timestamp) .children( // opbeans-rum -> opbeans-node opbeansRum .span( - ...httpExitSpan({ + httpExitSpan({ spanName: 'GET /api/products/top', destinationUrl: 'http://opbeans-node:3000', }) @@ -50,14 +54,14 @@ const scenario: Scenario = async (runOptions: RunOptions) => { .children( // opbeans-node opbeansNode - .transaction('Initial transaction in opbeans-node') + .transaction({ transactionName: 'Initial transaction in opbeans-node' }) .duration(300) .timestamp(timestamp) .children( opbeansNode // opbeans-node -> opbeans-go .span( - ...httpExitSpan({ + httpExitSpan({ spanName: 'GET opbeans-go:3000', destinationUrl: 'http://opbeans-go:3000', }) @@ -69,12 +73,12 @@ const scenario: Scenario = async (runOptions: RunOptions) => { // opbeans-go opbeansGo - .transaction('Initial transaction in opbeans-go') + .transaction({ transactionName: 'Initial transaction in opbeans-go' }) .timestamp(timestamp) .duration(200) .children( opbeansGo - .span('custom_operation', 'custom') + .span({ spanName: 'custom_operation', spanType: 'custom' }) .timestamp(timestamp) .duration(100) .success() diff --git a/packages/kbn-apm-synthtrace/src/scenarios/high_throughput.ts b/packages/kbn-apm-synthtrace/src/scenarios/high_throughput.ts index 41b21df2e83e1..1b2ec3d64b087 100644 --- a/packages/kbn-apm-synthtrace/src/scenarios/high_throughput.ts +++ b/packages/kbn-apm-synthtrace/src/scenarios/high_throughput.ts @@ -28,11 +28,11 @@ const scenario: Scenario = async (runOptions: RunOptions) => { const instances = services.map((service, index) => apm - .service( - `${service}-${languages[index % languages.length]}`, - 'production', - languages[index % languages.length] - ) + .service({ + name: `${service}-${languages[index % languages.length]}`, + environment: 'production', + agentName: languages[index % languages.length], + }) .instance(`instance-${index}`) ); const entities = [ @@ -68,18 +68,22 @@ const scenario: Scenario = async (runOptions: RunOptions) => { const generateError = index % random(mod, 9) === 0; const generateChildError = index % random(mod, 9) === 0; const span = instance - .transaction(url) + .transaction({ transactionName: url }) .timestamp(timestamp) .duration(duration) .children( instance - .span('GET apm-*/_search', 'db', 'elasticsearch') + .span({ + spanName: 'GET apm-*/_search', + spanType: 'db', + spanSubtype: 'elasticsearch', + }) .duration(childDuration) .destination('elasticsearch') .timestamp(timestamp) .outcome(generateError && generateChildError ? 'failure' : 'success'), instance - .span('custom_operation', 'custom') + .span({ spanName: 'custom_operation', spanType: 'custom' }) .duration(remainderDuration) .success() .timestamp(timestamp + childDuration) @@ -88,7 +92,9 @@ const scenario: Scenario = async (runOptions: RunOptions) => { ? span.success() : span .failure() - .errors(instance.error(`No handler for ${url}`).timestamp(timestamp + 50)); + .errors( + instance.error({ message: `No handler for ${url}` }).timestamp(timestamp + 50) + ); }); return successfulTraceEvents; diff --git a/packages/kbn-apm-synthtrace/src/scenarios/low_throughput.ts b/packages/kbn-apm-synthtrace/src/scenarios/low_throughput.ts index d842a0650b423..006a5074f7c1b 100644 --- a/packages/kbn-apm-synthtrace/src/scenarios/low_throughput.ts +++ b/packages/kbn-apm-synthtrace/src/scenarios/low_throughput.ts @@ -32,11 +32,13 @@ const scenario: Scenario = async (runOptions: RunOptions) => { const instances = services.map((service, index) => apm - .service( - `${services[index % services.length]}-${languages[index % languages.length]}-${index}`, - ENVIRONMENT, - languages[index % languages.length] - ) + .service({ + name: `${services[index % services.length]}-${ + languages[index % languages.length] + }-${index}`, + environment: ENVIRONMENT, + agentName: languages[index % languages.length], + }) .instance(`instance-${index}`) ); @@ -53,18 +55,22 @@ const scenario: Scenario = async (runOptions: RunOptions) => { const generateError = index % random(mod, 9) === 0; const generateChildError = index % random(mod, 9) === 0; const span = instance - .transaction(url) + .transaction({ transactionName: url }) .timestamp(timestamp) .duration(duration) .children( instance - .span('GET apm-*/_search', 'db', 'elasticsearch') + .span({ + spanName: 'GET apm-*/_search', + spanType: 'db', + spanSubtype: 'elasticsearch', + }) .duration(childDuration) .destination('elasticsearch') .timestamp(timestamp) .outcome(generateError && generateChildError ? 'failure' : 'success'), instance - .span('custom_operation', 'custom') + .span({ spanName: 'custom_operation', spanType: 'custom' }) .duration(remainderDuration) .success() .timestamp(timestamp + childDuration) @@ -73,7 +79,9 @@ const scenario: Scenario = async (runOptions: RunOptions) => { ? span.success() : span .failure() - .errors(instance.error(`No handler for ${url}`).timestamp(timestamp + 50)); + .errors( + instance.error({ message: `No handler for ${url}` }).timestamp(timestamp + 50) + ); }); return successfulTraceEvents; diff --git a/packages/kbn-apm-synthtrace/src/scenarios/many_services.ts b/packages/kbn-apm-synthtrace/src/scenarios/many_services.ts index 501d0e678f0f4..1829d46e17232 100644 --- a/packages/kbn-apm-synthtrace/src/scenarios/many_services.ts +++ b/packages/kbn-apm-synthtrace/src/scenarios/many_services.ts @@ -33,11 +33,13 @@ const scenario: Scenario = async (runOptions: RunOptions) => { const instances = [...Array(numServices).keys()].map((index) => apm - .service( - `${services[index % services.length]}-${languages[index % languages.length]}-${index}`, - ENVIRONMENT, - languages[index % languages.length] - ) + .service({ + name: `${services[index % services.length]}-${ + languages[index % languages.length] + }-${index}`, + environment: ENVIRONMENT, + agentName: languages[index % languages.length], + }) .instance(`instance-${index}`) ); @@ -53,18 +55,22 @@ const scenario: Scenario = async (runOptions: RunOptions) => { const generateError = random(1, 4) % 3 === 0; const generateChildError = random(0, 5) % 2 === 0; const span = instance - .transaction(url) + .transaction({ transactionName: url }) .timestamp(timestamp) .duration(duration) .children( instance - .span('GET apm-*/_search', 'db', 'elasticsearch') + .span({ + spanName: 'GET apm-*/_search', + spanType: 'db', + spanSubtype: 'elasticsearch', + }) .duration(childDuration) .destination('elasticsearch') .timestamp(timestamp) .outcome(generateError && generateChildError ? 'failure' : 'success'), instance - .span('custom_operation', 'custom') + .span({ spanName: 'custom_operation', spanType: 'custom' }) .duration(remainderDuration) .success() .timestamp(timestamp + childDuration) @@ -73,7 +79,9 @@ const scenario: Scenario = async (runOptions: RunOptions) => { ? span.success() : span .failure() - .errors(instance.error(`No handler for ${url}`).timestamp(timestamp + 50)); + .errors( + instance.error({ message: `No handler for ${url}` }).timestamp(timestamp + 50) + ); }); return successfulTraceEvents; diff --git a/packages/kbn-apm-synthtrace/src/scenarios/simple_trace.ts b/packages/kbn-apm-synthtrace/src/scenarios/simple_trace.ts index f8444ab6e5879..8f3c84564787c 100644 --- a/packages/kbn-apm-synthtrace/src/scenarios/simple_trace.ts +++ b/packages/kbn-apm-synthtrace/src/scenarios/simple_trace.ts @@ -31,24 +31,30 @@ const scenario: Scenario = async (runOptions: RunOptions) => { const failedTimestamps = range.ratePerMinute(180); const instances = [...Array(numServices).keys()].map((index) => - apm.service(`opbeans-go-${index}`, ENVIRONMENT, 'go').instance('instance') + apm + .service({ name: `opbeans-go-${index}`, environment: ENVIRONMENT, agentName: 'go' }) + .instance('instance') ); const instanceSpans = (instance: Instance) => { const successfulTraceEvents = successfulTimestamps.generator((timestamp) => instance - .transaction(transactionName) + .transaction({ transactionName }) .timestamp(timestamp) .duration(1000) .success() .children( instance - .span('GET apm-*/_search', 'db', 'elasticsearch') + .span({ + spanName: 'GET apm-*/_search', + spanType: 'db', + spanSubtype: 'elasticsearch', + }) .duration(1000) .success() .destination('elasticsearch') .timestamp(timestamp), instance - .span('custom_operation', 'custom') + .span({ spanName: 'custom_operation', spanType: 'custom' }) .duration(100) .success() .timestamp(timestamp) @@ -57,12 +63,14 @@ const scenario: Scenario = async (runOptions: RunOptions) => { const failedTraceEvents = failedTimestamps.generator((timestamp) => instance - .transaction(transactionName) + .transaction({ transactionName }) .timestamp(timestamp) .duration(1000) .failure() .errors( - instance.error('[ResponseError] index_not_found_exception').timestamp(timestamp + 50) + instance + .error({ message: '[ResponseError] index_not_found_exception' }) + .timestamp(timestamp + 50) ) ); diff --git a/packages/kbn-apm-synthtrace/src/scenarios/span_links.ts b/packages/kbn-apm-synthtrace/src/scenarios/span_links.ts index 0c9250dcd16f7..4267b6465b179 100644 --- a/packages/kbn-apm-synthtrace/src/scenarios/span_links.ts +++ b/packages/kbn-apm-synthtrace/src/scenarios/span_links.ts @@ -35,7 +35,7 @@ const scenario: Scenario = async () => { generate: ({ from, to }) => { const producerInternalOnlyInstance = apm - .service('producer-internal-only', ENVIRONMENT, 'go') + .service({ name: 'producer-internal-only', environment: ENVIRONMENT, agentName: 'go' }) .instance('instance-a'); const producerInternalOnlyEvents = timerange( new Date('2022-04-25T19:00:00.000Z'), @@ -45,13 +45,13 @@ const scenario: Scenario = async () => { .rate(1) .generator((timestamp) => { return producerInternalOnlyInstance - .transaction('Transaction A') + .transaction({ transactionName: 'Transaction A' }) .timestamp(timestamp) .duration(1000) .success() .children( producerInternalOnlyInstance - .span('Span A', 'custom') + .span({ spanName: 'Span A', spanType: 'custom' }) .timestamp(timestamp + 50) .duration(100) .success() @@ -62,20 +62,20 @@ const scenario: Scenario = async () => { const spanASpanLink = getSpanLinksFromEvents(producerInternalOnlyApmFields); const producerConsumerInstance = apm - .service('producer-consumer', ENVIRONMENT, 'java') + .service({ name: 'producer-consumer', environment: ENVIRONMENT, agentName: 'java' }) .instance('instance-b'); const producerConsumerEvents = timerange(from, to) .interval('1m') .rate(1) .generator((timestamp) => { return producerConsumerInstance - .transaction('Transaction B') + .transaction({ transactionName: 'Transaction B' }) .timestamp(timestamp) .duration(1000) .success() .children( producerConsumerInstance - .span('Span B', 'external') + .span({ spanName: 'Span B', spanType: 'external' }) .defaults({ 'span.links': shuffle([...generateExternalSpanLinks(), ...spanASpanLink]), }) @@ -88,19 +88,21 @@ const scenario: Scenario = async () => { const producerConsumerApmFields = producerConsumerEvents.toArray(); const spanBSpanLink = getSpanLinksFromEvents(producerConsumerApmFields); - const consumerInstance = apm.service('consumer', ENVIRONMENT, 'ruby').instance('instance-c'); + const consumerInstance = apm + .service({ name: 'consumer', environment: ENVIRONMENT, agentName: 'ruby' }) + .instance('instance-c'); const consumerEvents = timerange(from, to) .interval('1m') .rate(1) .generator((timestamp) => { return consumerInstance - .transaction('Transaction C') + .transaction({ transactionName: 'Transaction C' }) .timestamp(timestamp) .duration(1000) .success() .children( consumerInstance - .span('Span C', 'external') + .span({ spanName: 'Span C', spanType: 'external' }) .defaults({ 'span.links': spanBSpanLink }) .timestamp(timestamp + 50) .duration(900) diff --git a/packages/kbn-apm-synthtrace/src/test/event_dsl_behavior.test.ts b/packages/kbn-apm-synthtrace/src/test/event_dsl_behavior.test.ts index 31a5ed02429d5..3cf1d8500e12d 100644 --- a/packages/kbn-apm-synthtrace/src/test/event_dsl_behavior.test.ts +++ b/packages/kbn-apm-synthtrace/src/test/event_dsl_behavior.test.ts @@ -19,7 +19,11 @@ describe('DSL invocations', () => { new Date('2021-01-01T00:00:00.000Z'), new Date('2021-01-01T00:15:00.000Z') ); - const javaService = apm.service('opbeans-java', 'production', 'java'); + const javaService = apm.service({ + name: 'opbeans-java', + environment: 'production', + agentName: 'java', + }); const javaInstance = javaService.instance('instance-1'); let globalSeq = 0; @@ -28,13 +32,13 @@ describe('DSL invocations', () => { .rate(1) .generator((timestamp, index) => javaInstance - .transaction(`GET /api/product/${index}/${globalSeq++}`) + .transaction({ transactionName: `GET /api/product/${index}/${globalSeq++}` }) .duration(1000) .success() .timestamp(timestamp) .children( javaInstance - .span('GET apm-*/_search', 'db', 'elasticsearch') + .span({ spanName: 'GET apm-*/_search', spanType: 'db', spanSubtype: 'elasticsearch' }) .success() .duration(900) .timestamp(timestamp + 50) diff --git a/packages/kbn-apm-synthtrace/src/test/rate_per_minute.test.ts b/packages/kbn-apm-synthtrace/src/test/rate_per_minute.test.ts index e40848ab9f47b..5a100aa8a404d 100644 --- a/packages/kbn-apm-synthtrace/src/test/rate_per_minute.test.ts +++ b/packages/kbn-apm-synthtrace/src/test/rate_per_minute.test.ts @@ -19,7 +19,11 @@ describe('rate per minute calculations', () => { let events: Array>; beforeEach(() => { - const javaService = apm.service('opbeans-java', 'production', 'java'); + const javaService = apm.service({ + name: 'opbeans-java', + environment: 'production', + agentName: 'java', + }); const javaInstance = javaService.instance('instance-1'); iterable = range @@ -27,13 +31,13 @@ describe('rate per minute calculations', () => { .rate(1) .generator((timestamp) => javaInstance - .transaction('GET /api/product/list') + .transaction({ transactionName: 'GET /api/product/list' }) .duration(1000) .success() .timestamp(timestamp) .children( javaInstance - .span('GET apm-*/_search', 'db', 'elasticsearch') + .span({ spanName: 'GET apm-*/_search', spanType: 'db', spanSubtype: 'elasticsearch' }) .success() .duration(900) .timestamp(timestamp + 50) diff --git a/packages/kbn-apm-synthtrace/src/test/scenarios/01_simple_trace.test.ts b/packages/kbn-apm-synthtrace/src/test/scenarios/01_simple_trace.test.ts index 8f405700fa2c1..a278997ecdf73 100644 --- a/packages/kbn-apm-synthtrace/src/test/scenarios/01_simple_trace.test.ts +++ b/packages/kbn-apm-synthtrace/src/test/scenarios/01_simple_trace.test.ts @@ -16,7 +16,11 @@ describe('simple trace', () => { let events: Array>; beforeEach(() => { - const javaService = apm.service('opbeans-java', 'production', 'java'); + const javaService = apm.service({ + name: 'opbeans-java', + environment: 'production', + agentName: 'java', + }); const javaInstance = javaService.instance('instance-1').containerId('instance-1'); const range = timerange( @@ -29,13 +33,13 @@ describe('simple trace', () => { .rate(1) .generator((timestamp) => javaInstance - .transaction('GET /api/product/list') + .transaction({ transactionName: 'GET /api/product/list' }) .duration(1000) .success() .timestamp(timestamp) .children( javaInstance - .span('GET apm-*/_search', 'db', 'elasticsearch') + .span({ spanName: 'GET apm-*/_search', spanType: 'db', spanSubtype: 'elasticsearch' }) .success() .duration(900) .timestamp(timestamp + 50) diff --git a/packages/kbn-apm-synthtrace/src/test/scenarios/02_transaction_metrics.test.ts b/packages/kbn-apm-synthtrace/src/test/scenarios/02_transaction_metrics.test.ts index d7f60b2396cd0..99715ab6998d6 100644 --- a/packages/kbn-apm-synthtrace/src/test/scenarios/02_transaction_metrics.test.ts +++ b/packages/kbn-apm-synthtrace/src/test/scenarios/02_transaction_metrics.test.ts @@ -16,7 +16,11 @@ describe('transaction metrics', () => { let events: Array>; beforeEach(() => { - const javaService = apm.service('opbeans-java', 'production', 'java'); + const javaService = apm.service({ + name: 'opbeans-java', + environment: 'production', + agentName: 'java', + }); const javaInstance = javaService.instance('instance-1'); const range = timerange( @@ -25,7 +29,10 @@ describe('transaction metrics', () => { ); const span = (timestamp: number) => - javaInstance.transaction('GET /api/product/list').duration(1000).timestamp(timestamp); + javaInstance + .transaction({ transactionName: 'GET /api/product/list' }) + .duration(1000) + .timestamp(timestamp); const processor = new StreamProcessor({ processors: [getTransactionMetrics], diff --git a/packages/kbn-apm-synthtrace/src/test/scenarios/03_span_destination_metrics.test.ts b/packages/kbn-apm-synthtrace/src/test/scenarios/03_span_destination_metrics.test.ts index 39c33e6486f69..f5c721221c328 100644 --- a/packages/kbn-apm-synthtrace/src/test/scenarios/03_span_destination_metrics.test.ts +++ b/packages/kbn-apm-synthtrace/src/test/scenarios/03_span_destination_metrics.test.ts @@ -16,7 +16,11 @@ describe('span destination metrics', () => { let events: Array>; beforeEach(() => { - const javaService = apm.service('opbeans-java', 'production', 'java'); + const javaService = apm.service({ + name: 'opbeans-java', + environment: 'production', + agentName: 'java', + }); const javaInstance = javaService.instance('instance-1'); const range = timerange( @@ -31,13 +35,17 @@ describe('span destination metrics', () => { .rate(25) .generator((timestamp) => javaInstance - .transaction('GET /api/product/list') + .transaction({ transactionName: 'GET /api/product/list' }) .duration(1000) .success() .timestamp(timestamp) .children( javaInstance - .span('GET apm-*/_search', 'db', 'elasticsearch') + .span({ + spanName: 'GET apm-*/_search', + spanType: 'db', + spanSubtype: 'elasticsearch', + }) .timestamp(timestamp) .duration(1000) .destination('elasticsearch') @@ -49,19 +57,23 @@ describe('span destination metrics', () => { .rate(50) .generator((timestamp) => javaInstance - .transaction('GET /api/product/list') + .transaction({ transactionName: 'GET /api/product/list' }) .duration(1000) .failure() .timestamp(timestamp) .children( javaInstance - .span('GET apm-*/_search', 'db', 'elasticsearch') + .span({ + spanName: 'GET apm-*/_search', + spanType: 'db', + spanSubtype: 'elasticsearch', + }) .timestamp(timestamp) .duration(1000) .destination('elasticsearch') .failure(), javaInstance - .span('custom_operation', 'app') + .span({ spanName: 'custom_operation', spanType: 'app' }) .timestamp(timestamp) .duration(500) .success() diff --git a/packages/kbn-apm-synthtrace/src/test/scenarios/04_breakdown_metrics.test.ts b/packages/kbn-apm-synthtrace/src/test/scenarios/04_breakdown_metrics.test.ts index 831ca790e57a6..731dea453058d 100644 --- a/packages/kbn-apm-synthtrace/src/test/scenarios/04_breakdown_metrics.test.ts +++ b/packages/kbn-apm-synthtrace/src/test/scenarios/04_breakdown_metrics.test.ts @@ -22,7 +22,11 @@ describe('breakdown metrics', () => { const INTERVALS = 6; beforeEach(() => { - const javaService = apm.service('opbeans-java', 'production', 'java'); + const javaService = apm.service({ + name: 'opbeans-java', + environment: 'production', + agentName: 'java', + }); const javaInstance = javaService.instance('instance-1'); const start = new Date('2021-01-01T00:00:00.000Z'); @@ -34,15 +38,18 @@ describe('breakdown metrics', () => { .rate(LIST_RATE) .generator((timestamp) => javaInstance - .transaction('GET /api/product/list') + .transaction({ transactionName: 'GET /api/product/list' }) .timestamp(timestamp) .duration(1000) .children( javaInstance - .span('GET apm-*/_search', 'db', 'elasticsearch') + .span({ spanName: 'GET apm-*/_search', spanType: 'db', spanSubtype: 'elasticsearch' }) .timestamp(timestamp + 150) .duration(500), - javaInstance.span('GET foo', 'db', 'redis').timestamp(timestamp).duration(100) + javaInstance + .span({ spanName: 'GET foo', spanType: 'db', spanSubtype: 'redis' }) + .timestamp(timestamp) + .duration(100) ) ); @@ -51,17 +58,17 @@ describe('breakdown metrics', () => { .rate(ID_RATE) .generator((timestamp) => javaInstance - .transaction('GET /api/product/:id') + .transaction({ transactionName: 'GET /api/product/:id' }) .timestamp(timestamp) .duration(1000) .children( javaInstance - .span('GET apm-*/_search', 'db', 'elasticsearch') + .span({ spanName: 'GET apm-*/_search', spanType: 'db', spanSubtype: 'elasticsearch' }) .duration(500) .timestamp(timestamp + 100) .children( javaInstance - .span('bar', 'external', 'http') + .span({ spanName: 'bar', spanType: 'external', spanSubtype: 'http' }) .timestamp(timestamp + 200) .duration(100) ) diff --git a/packages/kbn-apm-synthtrace/src/test/scenarios/05_transactions_with_errors.test.ts b/packages/kbn-apm-synthtrace/src/test/scenarios/05_transactions_with_errors.test.ts index b9b12aeab0754..305c3ed2d88a4 100644 --- a/packages/kbn-apm-synthtrace/src/test/scenarios/05_transactions_with_errors.test.ts +++ b/packages/kbn-apm-synthtrace/src/test/scenarios/05_transactions_with_errors.test.ts @@ -14,13 +14,15 @@ describe('transactions with errors', () => { const timestamp = new Date('2021-01-01T00:00:00.000Z').getTime(); beforeEach(() => { - instance = apm.service('opbeans-java', 'production', 'java').instance('instance'); + instance = apm + .service({ name: 'opbeans-java', environment: 'production', agentName: 'java' }) + .instance('instance'); }); it('generates error events', () => { const events = instance - .transaction('GET /api') + .transaction({ transactionName: 'GET /api' }) .timestamp(timestamp) - .errors(instance.error('test error').timestamp(timestamp)) + .errors(instance.error({ message: 'test error' }).timestamp(timestamp)) .serialize(); const errorEvents = events.filter((event) => event['processor.event'] === 'error'); @@ -39,9 +41,9 @@ describe('transactions with errors', () => { it('sets the transaction and trace id', () => { const [transaction, error] = instance - .transaction('GET /api') + .transaction({ transactionName: 'GET /api' }) .timestamp(timestamp) - .errors(instance.error('test error').timestamp(timestamp)) + .errors(instance.error({ message: 'test error' }).timestamp(timestamp)) .serialize(); const keys = ['transaction.id', 'trace.id', 'transaction.type']; @@ -55,9 +57,9 @@ describe('transactions with errors', () => { it('sets the error grouping key', () => { const [, error] = instance - .transaction('GET /api') + .transaction({ transactionName: 'GET /api' }) .timestamp(timestamp) - .errors(instance.error('test error').timestamp(timestamp)) + .errors(instance.error({ message: 'test error' }).timestamp(timestamp)) .serialize(); expect(error['error.grouping_name']).toEqual('test error'); diff --git a/packages/kbn-apm-synthtrace/src/test/scenarios/06_application_metrics.test.ts b/packages/kbn-apm-synthtrace/src/test/scenarios/06_application_metrics.test.ts index 7bae1e51f1ab3..c9f33c2f23711 100644 --- a/packages/kbn-apm-synthtrace/src/test/scenarios/06_application_metrics.test.ts +++ b/packages/kbn-apm-synthtrace/src/test/scenarios/06_application_metrics.test.ts @@ -14,7 +14,9 @@ describe('application metrics', () => { const timestamp = new Date('2021-01-01T00:00:00.000Z').getTime(); beforeEach(() => { - instance = apm.service('opbeans-java', 'production', 'java').instance('instance'); + instance = apm + .service({ name: 'opbeans-java', environment: 'production', agentName: 'java' }) + .instance('instance'); }); it('generates application metricsets', () => { const events = instance diff --git a/packages/kbn-babel-preset/node_preset.js b/packages/kbn-babel-preset/node_preset.js index 5b50e91354988..caf5f7dce419e 100644 --- a/packages/kbn-babel-preset/node_preset.js +++ b/packages/kbn-babel-preset/node_preset.js @@ -31,7 +31,7 @@ module.exports = (_, options = {}) => { // Because of that we should use for that value the same version we install // in the package.json in order to have the same polyfills between the environment // and the tests - corejs: '3.25.0', + corejs: '3.25.1', bugfixes: true, ...(options['@babel/preset-env'] || {}), diff --git a/packages/kbn-babel-preset/webpack_preset.js b/packages/kbn-babel-preset/webpack_preset.js index e3b52cc1e5e11..5d2fa5a627fb6 100644 --- a/packages/kbn-babel-preset/webpack_preset.js +++ b/packages/kbn-babel-preset/webpack_preset.js @@ -18,7 +18,7 @@ module.exports = (_, options = {}) => { modules: false, // Please read the explanation for this // in node_preset.js - corejs: '3.25.0', + corejs: '3.25.1', bugfixes: true, }, ], diff --git a/packages/kbn-bazel-packages/src/bazel_package.test.ts b/packages/kbn-bazel-packages/src/bazel_package.test.ts index 16a06dab7e08e..202d4d96204e7 100644 --- a/packages/kbn-bazel-packages/src/bazel_package.test.ts +++ b/packages/kbn-bazel-packages/src/bazel_package.test.ts @@ -20,7 +20,7 @@ const pkgJson: ParsedPackageJson = { const manifest: KibanaPackageManifest = { type: 'shared-common', id: '@kbn/foo', - owner: '@elastic/kibana-operations', + owner: ['@elastic/kibana-operations'], runtimeDeps: [], typeDeps: [], }; diff --git a/packages/kbn-bazel-packages/src/bazel_package_dirs.js b/packages/kbn-bazel-packages/src/bazel_package_dirs.js index 7e3f728a21ca7..dbb8826bcd733 100644 --- a/packages/kbn-bazel-packages/src/bazel_package_dirs.js +++ b/packages/kbn-bazel-packages/src/bazel_package_dirs.js @@ -26,6 +26,7 @@ const BAZEL_PACKAGE_DIRS = [ 'packages/analytics/shippers/elastic_v3', 'packages/core/*', 'packages/home', + 'packages/content-management', 'x-pack/packages/ml', ]; diff --git a/packages/kbn-bazel-packages/src/parse_package_manifest.js b/packages/kbn-bazel-packages/src/parse_package_manifest.js index 42acbf3e60366..97a209bb47383 100644 --- a/packages/kbn-bazel-packages/src/parse_package_manifest.js +++ b/packages/kbn-bazel-packages/src/parse_package_manifest.js @@ -30,6 +30,12 @@ const err = (key, value, msg) => { return new Error(`invalid package "${key}" [${dbg}], ${msg}`); }; +/** + * @param {unknown} v + * @returns {v is string} + */ +const isValidOwner = (v) => typeof v === 'string' && v.startsWith('@'); + /** * @param {unknown} plugin * @returns {import('./types').PluginPackageManifest['plugin']} @@ -132,8 +138,15 @@ function validatePackageManifest(parsed) { throw err(`id`, id, `must be a string that starts with @kbn/`); } - if (typeof owner !== 'string' || !owner.startsWith('@')) { - throw err(`owner`, owner, `must be a valid Github team handle starting with @`); + if ( + !(Array.isArray(owner) && owner.every(isValidOwner)) && + !(typeof owner === 'string' && isValidOwner(owner)) + ) { + throw err( + `owner`, + owner, + `must be a valid Github team handle starting with @, or an array of such handles` + ); } if (!isArrOfStrings(typeDeps)) { @@ -150,7 +163,7 @@ function validatePackageManifest(parsed) { const base = { id, - owner, + owner: Array.isArray(owner) ? owner : [owner], typeDeps, runtimeDeps, devOnly, diff --git a/packages/kbn-bazel-packages/src/types.ts b/packages/kbn-bazel-packages/src/types.ts index c4b445adfd851..106d0bce3fe52 100644 --- a/packages/kbn-bazel-packages/src/types.ts +++ b/packages/kbn-bazel-packages/src/types.ts @@ -54,12 +54,10 @@ interface PackageManifestBaseFields { */ id: string; /** - * Github handle for the person or team who is responsible for this package. - * This owner will be used in the codeowners files for this package. - * - * For additional codeowners, you add manually add entries to the codeowners file. + * Github handles for the people or teams responsible for this package. + * These values will be used in the codeowners files for this package. */ - owner: string; + owner: string[]; /** * Packages which are required for the source code in the package to be type- * checked. This list is updated automatically by the package linter diff --git a/packages/kbn-dev-proc-runner/src/proc.ts b/packages/kbn-dev-proc-runner/src/proc.ts index ffe7cb6464123..d30a893ae4c75 100644 --- a/packages/kbn-dev-proc-runner/src/proc.ts +++ b/packages/kbn-dev-proc-runner/src/proc.ts @@ -6,8 +6,10 @@ * Side Public License, v 1. */ -import { statSync } from 'fs'; +import Fs from 'fs'; +import Path from 'path'; import { promisify } from 'util'; +import stripAnsi from 'strip-ansi'; import execa from 'execa'; import * as Rx from 'rxjs'; @@ -29,6 +31,7 @@ export interface ProcOptions { cwd: string; env?: Record; stdin?: string; + writeLogsToPath?: string; } async function withTimeout( @@ -44,13 +47,21 @@ export type Proc = ReturnType; export function startProc(name: string, options: ProcOptions, log: ToolingLog) { const { cmd, args, cwd, env, stdin } = options; - log.info('[%s] > %s', name, cmd === process.execPath ? 'node' : cmd, args.join(' ')); + let stdioTarget: undefined | NodeJS.WritableStream; + if (!options.writeLogsToPath) { + log.info('starting [%s] > %s', name, cmd === process.execPath ? 'node' : cmd, args.join(' ')); + } else { + stdioTarget = Fs.createWriteStream(options.writeLogsToPath, 'utf8'); + const exec = cmd === process.execPath ? 'node' : cmd; + const relOut = Path.relative(process.cwd(), options.writeLogsToPath); + log.info(`starting [${name}] and writing output to ${relOut} > ${exec} ${args.join(' ')}`); + } // spawn fails with ENOENT when either the // cmd or cwd don't exist, so we check for the cwd // ahead of time so that the error is less ambiguous try { - if (!statSync(cwd).isDirectory()) { + if (!Fs.statSync(cwd).isDirectory()) { throw new Error(`cwd "${cwd}" exists but is not a directory`); } } catch (err) { @@ -104,7 +115,20 @@ export function startProc(name: string, options: ProcOptions, log: ToolingLog) { observeLines(childProcess.stdout!), // TypeScript note: As long as the proc stdio[1] is 'pipe', then stdout will not be null observeLines(childProcess.stderr!) // TypeScript note: As long as the proc stdio[1] is 'pipe', then stderr will not be null ).pipe( - tap((line) => log.write(` ${chalk.gray('proc')} [${chalk.gray(name)}] ${line}`)), + tap({ + next(line) { + if (stdioTarget) { + stdioTarget.write(stripAnsi(line) + '\n'); + } else { + log.write(` ${chalk.gray('proc')} [${chalk.gray(name)}] ${line}`); + } + }, + complete() { + if (stdioTarget) { + stdioTarget.end(); + } + }, + }), share() ); diff --git a/packages/kbn-dev-proc-runner/src/proc_runner.ts b/packages/kbn-dev-proc-runner/src/proc_runner.ts index 56a6ee48c3150..1226cbeb3eef1 100644 --- a/packages/kbn-dev-proc-runner/src/proc_runner.ts +++ b/packages/kbn-dev-proc-runner/src/proc_runner.ts @@ -36,12 +36,12 @@ export class ProcRunner { private procs: Proc[] = []; private signalUnsubscribe: () => void; - constructor(private log: ToolingLog) { + constructor(private readonly log: ToolingLog) { this.log = log.withType('ProcRunner'); this.signalUnsubscribe = exitHook(() => { this.teardown().catch((error) => { - log.error(`ProcRunner teardown error: ${error.stack}`); + this.log.error(`ProcRunner teardown error: ${error.stack}`); }); }); } @@ -58,6 +58,7 @@ export class ProcRunner { waitTimeout = 15 * MINUTE, env = process.env, onEarlyExit, + writeLogsToPath, } = options; const cmd = options.cmd === 'node' ? process.execPath : options.cmd; @@ -79,6 +80,7 @@ export class ProcRunner { cwd, env, stdin, + writeLogsToPath, }); if (onEarlyExit) { diff --git a/packages/kbn-doc-links/src/get_doc_links.ts b/packages/kbn-doc-links/src/get_doc_links.ts index 7b7c57ff4f7f2..413e8905bea93 100644 --- a/packages/kbn-doc-links/src/get_doc_links.ts +++ b/packages/kbn-doc-links/src/get_doc_links.ts @@ -360,6 +360,10 @@ export const getDocLinks = ({ kibanaBranch }: GetDocLinkOptions): DocLinks => { macos_system_ext: `${SECURITY_SOLUTION_DOCS}deploy-elastic-endpoint.html#system-extension-endpoint`, linux_deadlock: `${SECURITY_SOLUTION_DOCS}ts-management.html#linux-deadlock`, }, + packageActionTroubleshooting: { + // TODO: Pending to be updated when docs are ready + es_connection: '', + }, responseActions: `${SECURITY_SOLUTION_DOCS}response-actions.html`, }, query: { diff --git a/packages/kbn-doc-links/src/types.ts b/packages/kbn-doc-links/src/types.ts index fb934f4aa4f2a..1ee0d5414b275 100644 --- a/packages/kbn-doc-links/src/types.ts +++ b/packages/kbn-doc-links/src/types.ts @@ -264,6 +264,9 @@ export interface DocLinks { macos_system_ext: string; linux_deadlock: string; }; + readonly packageActionTroubleshooting: { + es_connection: string; + }; readonly threatIntelInt: string; readonly responseActions: string; }; diff --git a/packages/kbn-es-query/src/es_query/build_es_query.ts b/packages/kbn-es-query/src/es_query/build_es_query.ts index 1a0ac9cef15ee..497d38a0530cf 100644 --- a/packages/kbn-es-query/src/es_query/build_es_query.ts +++ b/packages/kbn-es-query/src/es_query/build_es_query.ts @@ -45,7 +45,7 @@ function removeMatchAll(filters: T[]) { * @public */ export function buildEsQuery( - indexPattern: DataViewBase | undefined, + indexPattern: DataViewBase | DataViewBase[] | undefined, queries: AnyQuery | AnyQuery[], filters: Filter | Filter[], config: EsQueryConfig = { @@ -60,7 +60,7 @@ export function buildEsQuery( const validQueries = queries.filter(isOfQueryType).filter((query) => has(query, 'query')); const queriesByLanguage = groupBy(validQueries, 'language'); const kueryQuery = buildQueryFromKuery( - indexPattern, + Array.isArray(indexPattern) ? indexPattern[0] : indexPattern, queriesByLanguage.kuery, { allowLeadingWildcards: config.allowLeadingWildcards }, { diff --git a/packages/kbn-es-query/src/es_query/from_filters.test.ts b/packages/kbn-es-query/src/es_query/from_filters.test.ts index 78b719ccc0e62..d17b0de3768b1 100644 --- a/packages/kbn-es-query/src/es_query/from_filters.test.ts +++ b/packages/kbn-es-query/src/es_query/from_filters.test.ts @@ -15,6 +15,7 @@ describe('build query', () => { const indexPattern: DataViewBase = { fields, title: 'dataView', + id: '1', }; describe('buildQueryFromFilters', () => { @@ -201,5 +202,43 @@ describe('build query', () => { const result = buildQueryFromFilters(filters, indexPattern, { nestedIgnoreUnmapped: true }); expect(result.filter).toEqual(expectedESQueries); }); + + test('should work with multiple data views', () => { + const indexPattern2: DataViewBase = { + fields, + title: 'dataView', + id: '2', + }; + + const filters = [ + { + query: { query_string: { query: 'foo' } }, + meta: { index: '1' }, + }, + { + query: { query_string: { query: 'bar' } }, + meta: { index: '2' }, + }, + ] as Filter[]; + + const result = buildQueryFromFilters(filters, [indexPattern, indexPattern2], { + ignoreFilterIfFieldNotInIndex: false, + }); + + expect(result.filter).toMatchInlineSnapshot(` + Array [ + Object { + "query_string": Object { + "query": "foo", + }, + }, + Object { + "query_string": Object { + "query": "bar", + }, + }, + ] + `); + }); }); }); diff --git a/packages/kbn-es-query/src/es_query/from_filters.ts b/packages/kbn-es-query/src/es_query/from_filters.ts index 871ff77026b54..2200648a52c4f 100644 --- a/packages/kbn-es-query/src/es_query/from_filters.ts +++ b/packages/kbn-es-query/src/es_query/from_filters.ts @@ -64,27 +64,34 @@ export interface EsQueryFiltersConfig { * @public */ export const buildQueryFromFilters = ( - filters: Filter[] = [], - indexPattern: DataViewBase | undefined, + inputFilters: Filter[] = [], + inputDataViews: DataViewBase | DataViewBase[] | undefined, { ignoreFilterIfFieldNotInIndex = false, nestedIgnoreUnmapped }: EsQueryFiltersConfig = { ignoreFilterIfFieldNotInIndex: false, } ): BoolQuery => { - filters = filters.filter((filter) => filter && !isFilterDisabled(filter)); + const filters = inputFilters.filter((filter) => filter && !isFilterDisabled(filter)); + const indexPatterns = Array.isArray(inputDataViews) ? inputDataViews : [inputDataViews]; + + const findIndexPattern = (id: string | undefined) => { + return indexPatterns.find((index) => index?.id === id) || indexPatterns[0]; + }; const filtersToESQueries = (negate: boolean) => { return filters .filter((f) => !!f) .filter(filterNegate(negate)) - .filter( - (filter) => !ignoreFilterIfFieldNotInIndex || filterMatchesIndex(filter, indexPattern) - ) + .filter((filter) => { + const indexPattern = findIndexPattern(filter.meta?.index); + return !ignoreFilterIfFieldNotInIndex || filterMatchesIndex(filter, indexPattern); + }) .map((filter) => { - return migrateFilter(filter, indexPattern); + const indexPattern = findIndexPattern(filter.meta?.index); + const migratedFilter = migrateFilter(filter, indexPattern); + return handleNestedFilter(migratedFilter, indexPattern, { + ignoreUnmapped: nestedIgnoreUnmapped, + }); }) - .map((filter) => - handleNestedFilter(filter, indexPattern, { ignoreUnmapped: nestedIgnoreUnmapped }) - ) .map(cleanFilter) .map(translateToQuery); }; diff --git a/packages/kbn-es-query/src/es_query/types.ts b/packages/kbn-es-query/src/es_query/types.ts index 14e091ed5b7f2..89c22521a6409 100644 --- a/packages/kbn-es-query/src/es_query/types.ts +++ b/packages/kbn-es-query/src/es_query/types.ts @@ -54,6 +54,10 @@ export type DataViewFieldBase = { */ lang?: estypes.ScriptLanguage; scripted?: boolean; + /** + * ES field types as strings array. + */ + esTypes?: string[]; }; /** diff --git a/packages/kbn-es-query/src/filters/build_filters/get_filter_field.ts b/packages/kbn-es-query/src/filters/build_filters/get_filter_field.ts index 9ae820cfea4e7..d8ef7e1106c0b 100644 --- a/packages/kbn-es-query/src/filters/build_filters/get_filter_field.ts +++ b/packages/kbn-es-query/src/filters/build_filters/get_filter_field.ts @@ -8,8 +8,8 @@ import { getExistsFilterField, isExistsFilter } from './exists_filter'; import { getPhrasesFilterField, isPhrasesFilter } from './phrases_filter'; -import { getPhraseFilterField, isPhraseFilter } from './phrase_filter'; -import { getRangeFilterField, isRangeFilter } from './range_filter'; +import { getPhraseFilterField, isPhraseFilter, isScriptedPhraseFilter } from './phrase_filter'; +import { getRangeFilterField, isRangeFilter, isScriptedRangeFilter } from './range_filter'; import type { Filter } from './types'; /** @internal */ @@ -17,13 +17,13 @@ export const getFilterField = (filter: Filter) => { if (isExistsFilter(filter)) { return getExistsFilterField(filter); } - if (isPhraseFilter(filter)) { + if (isPhraseFilter(filter) || isScriptedPhraseFilter(filter)) { return getPhraseFilterField(filter); } if (isPhrasesFilter(filter)) { return getPhrasesFilterField(filter); } - if (isRangeFilter(filter)) { + if (isRangeFilter(filter) || isScriptedRangeFilter(filter)) { return getRangeFilterField(filter); } diff --git a/packages/kbn-es-query/src/filters/build_filters/phrase_filter.test.ts b/packages/kbn-es-query/src/filters/build_filters/phrase_filter.test.ts index 7c7f7dd28f6ca..1088ba196840c 100644 --- a/packages/kbn-es-query/src/filters/build_filters/phrase_filter.test.ts +++ b/packages/kbn-es-query/src/filters/build_filters/phrase_filter.test.ts @@ -186,4 +186,14 @@ describe('isScriptedPhraseFilter', () => { expect(isScriptedPhraseFilter(filter)).toBe(true); expect(isPhraseFilter(unknownFilter)).toBe(false); }); + + it('should return false if the filter is a range filter', () => { + const filter: Filter = set({ meta: {} }, 'query.script.script.params', { + gt: 0, + lt: 100, + value: 100, + }) as Filter; + + expect(isScriptedPhraseFilter(filter)).toBe(false); + }); }); diff --git a/packages/kbn-es-query/src/filters/build_filters/phrase_filter.ts b/packages/kbn-es-query/src/filters/build_filters/phrase_filter.ts index 752dc8b338661..3bbf94cd0722a 100644 --- a/packages/kbn-es-query/src/filters/build_filters/phrase_filter.ts +++ b/packages/kbn-es-query/src/filters/build_filters/phrase_filter.ts @@ -10,6 +10,7 @@ import { get, has, isPlainObject } from 'lodash'; import type { Filter, FilterMeta } from './types'; import type { DataViewFieldBase, DataViewBase } from '../../es_query'; import { getConvertedValueForField } from './get_converted_value_for_field'; +import { hasRangeKeys } from './range_filter'; export type PhraseFilterValue = string | number | boolean; @@ -60,10 +61,12 @@ export const isPhraseFilter = (filter: Filter): filter is PhraseFilter => { * @public */ export const isScriptedPhraseFilter = (filter: Filter): filter is ScriptedPhraseFilter => - has(filter, 'query.script.script.params.value'); + has(filter, 'query.script.script.params.value') && + !hasRangeKeys(filter.query?.script?.script?.params); /** @internal */ -export const getPhraseFilterField = (filter: PhraseFilter) => { +export const getPhraseFilterField = (filter: PhraseFilter | ScriptedPhraseFilter) => { + if (filter.meta?.field) return filter.meta.field; const queryConfig = filter.query.match_phrase ?? filter.query.match ?? {}; return Object.keys(queryConfig)[0]; }; diff --git a/packages/kbn-es-query/src/filters/build_filters/range_filter.ts b/packages/kbn-es-query/src/filters/build_filters/range_filter.ts index 2ff43a854da23..e9bafade964b7 100644 --- a/packages/kbn-es-query/src/filters/build_filters/range_filter.ts +++ b/packages/kbn-es-query/src/filters/build_filters/range_filter.ts @@ -47,7 +47,7 @@ export interface RangeFilterParams { format?: string; } -const hasRangeKeys = (params: RangeFilterParams) => +export const hasRangeKeys = (params: RangeFilterParams) => Boolean( keys(params).find((key: string) => ['gte', 'gt', 'lte', 'lt', 'from', 'to'].includes(key)) ); @@ -108,8 +108,8 @@ export const isScriptedRangeFilter = (filter: Filter): filter is ScriptedRangeFi /** * @internal */ -export const getRangeFilterField = (filter: RangeFilter) => { - return filter.query.range && Object.keys(filter.query.range)[0]; +export const getRangeFilterField = (filter: RangeFilter | ScriptedRangeFilter) => { + return filter.meta?.field ?? (filter.query.range && Object.keys(filter.query.range)[0]); }; const formatValue = (params: any[]) => diff --git a/packages/kbn-es-query/src/filters/stubs/fields.mocks.ts b/packages/kbn-es-query/src/filters/stubs/fields.mocks.ts index 2d9b7269f85a4..390d322ffb9ed 100644 --- a/packages/kbn-es-query/src/filters/stubs/fields.mocks.ts +++ b/packages/kbn-es-query/src/filters/stubs/fields.mocks.ts @@ -42,6 +42,12 @@ export const fields: DataViewFieldBase[] = [ type: 'string', scripted: false, }, + { + name: 'machine.os.keyword', + type: 'string', + esTypes: ['keyword'], + scripted: false, + }, { name: 'script number', type: 'number', 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 f0143db87809b..f36ea0d17dc8c 100644 --- a/packages/kbn-es-query/src/kuery/functions/is.test.ts +++ b/packages/kbn-es-query/src/kuery/functions/is.test.ts @@ -206,6 +206,25 @@ describe('kuery functions', () => { expect(result).toEqual(expected); }); + test('should create a wildcard query for keyword fields', () => { + const expected = { + bool: { + should: [ + { + wildcard: { + 'machine.os.keyword': 'win*', + }, + }, + ], + minimum_should_match: 1, + }, + }; + const node = nodeTypes.function.buildNode('is', 'machine.os.keyword', 'win*'); + const result = is.toElasticsearchQuery(node, indexPattern); + + expect(result).toEqual(expected); + }); + test('should support scripted fields', () => { const node = nodeTypes.function.buildNode('is', 'script string', 'foo'); const result = is.toElasticsearchQuery(node, indexPattern); diff --git a/packages/kbn-es-query/src/kuery/functions/is.ts b/packages/kbn-es-query/src/kuery/functions/is.ts index 12ada3326604d..f2db74857b02e 100644 --- a/packages/kbn-es-query/src/kuery/functions/is.ts +++ b/packages/kbn-es-query/src/kuery/functions/is.ts @@ -142,15 +142,20 @@ export function toElasticsearchQuery( }), ]; } else if (wildcard.isNode(valueArg)) { - return [ - ...accumulator, - wrapWithNestedQuery({ - query_string: { - fields: [field.name], - query: wildcard.toQueryStringQuery(valueArg), - }, - }), - ]; + const query = field.esTypes?.includes('keyword') + ? { + wildcard: { + [field.name]: value, + }, + } + : { + query_string: { + fields: [field.name], + query: wildcard.toQueryStringQuery(valueArg), + }, + }; + + return [...accumulator, wrapWithNestedQuery(query)]; } else if (field.type === 'date') { /* If we detect that it's a date field and the user wants an exact date, we need to convert the query to both >= and <= the value provided to force a range query. This is because match and match_phrase queries do not accept a timezone parameter. diff --git a/packages/kbn-es-query/src/kuery/functions/utils/get_fields.test.ts b/packages/kbn-es-query/src/kuery/functions/utils/get_fields.test.ts index f3d49c426d079..e0e69c222604e 100644 --- a/packages/kbn-es-query/src/kuery/functions/utils/get_fields.test.ts +++ b/packages/kbn-es-query/src/kuery/functions/utils/get_fields.test.ts @@ -74,10 +74,13 @@ describe('getFields', () => { const fieldNameNode = nodeTypes.wildcard.buildNode('machine*'); const results = getFields(fieldNameNode, indexPattern); - expect(Array.isArray(results)).toBeTruthy(); - expect(results).toHaveLength(2); - expect(results!.find((field) => field.name === 'machine.os')).toBeDefined(); - expect(results!.find((field) => field.name === 'machine.os.raw')).toBeDefined(); + expect(results).toEqual(expect.any(Array)); + expect(results).toHaveLength(3); + expect(results).toEqual([ + expect.objectContaining({ name: 'machine.os' }), + expect.objectContaining({ name: 'machine.os.raw' }), + expect.objectContaining({ name: 'machine.os.keyword' }), + ]); }); }); }); diff --git a/packages/kbn-es-types/BUILD.bazel b/packages/kbn-es-types/BUILD.bazel new file mode 100644 index 0000000000000..99ebf0cc1e688 --- /dev/null +++ b/packages/kbn-es-types/BUILD.bazel @@ -0,0 +1,107 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "kbn-es-types" +PKG_REQUIRE_NAME = "@kbn/es-types" + +SOURCE_FILES = glob( + [ + "**/*.ts", + ], + exclude = [ + "**/*.config.js", + "**/*.mock.*", + "**/*.test.*", + "**/*.stories.*", + "**/__snapshots__/**", + "**/integration_tests/**", + "**/mocks/**", + "**/scripts/**", + "**/storybook/**", + "**/test_fixtures/**", + "**/test_helpers/**", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +RUNTIME_DEPS = [ +] + +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", + "@npm//utility-types", + "@npm//@elastic/elasticsearch", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + declaration_map = True, + emit_declaration_only = True, + out_dir = "target_types", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/kbn-es-types/README.md b/packages/kbn-es-types/README.md new file mode 100644 index 0000000000000..4017d4dfd9f3a --- /dev/null +++ b/packages/kbn-es-types/README.md @@ -0,0 +1,3 @@ +# @kbn/es-types + +This package contains 'missing' types for the `@elastic/elasticsearch` client. diff --git a/packages/kbn-es-types/index.ts b/packages/kbn-es-types/index.ts new file mode 100644 index 0000000000000..a3243ea755b09 --- /dev/null +++ b/packages/kbn-es-types/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. + */ + +export type { + AggregationOptionsByType, + ESSearchOptions, + SearchHit, + ESSearchResponse, + ESSearchRequest, + ESSourceOptions, + InferSearchResponseOf, + AggregationResultOf, + ESFilter, + MaybeReadonlyArray, +} from './src'; diff --git a/packages/kbn-es-types/jest.config.js b/packages/kbn-es-types/jest.config.js new file mode 100644 index 0000000000000..0d18f7298f14c --- /dev/null +++ b/packages/kbn-es-types/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test/jest_node', + rootDir: '../..', + roots: ['/packages/kbn-es-types'], +}; diff --git a/packages/kbn-es-types/kibana.jsonc b/packages/kbn-es-types/kibana.jsonc new file mode 100644 index 0000000000000..18af5562c4eeb --- /dev/null +++ b/packages/kbn-es-types/kibana.jsonc @@ -0,0 +1,7 @@ +{ + "type": "shared-common", + "id": "@kbn/es-types", + "owner": ["@elastic/kibana-core", "@elastic/apm-ui"], + "runtimeDeps": [], + "typeDeps": [], +} diff --git a/packages/kbn-es-types/package.json b/packages/kbn-es-types/package.json new file mode 100644 index 0000000000000..b0119ee1d53b2 --- /dev/null +++ b/packages/kbn-es-types/package.json @@ -0,0 +1,8 @@ +{ + "name": "@kbn/es-types", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "author": "Kibana Core", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/src/core/types/elasticsearch/index.ts b/packages/kbn-es-types/src/index.ts similarity index 100% rename from src/core/types/elasticsearch/index.ts rename to packages/kbn-es-types/src/index.ts diff --git a/packages/kbn-es-types/src/search.ts b/packages/kbn-es-types/src/search.ts new file mode 100644 index 0000000000000..b506aa0236c61 --- /dev/null +++ b/packages/kbn-es-types/src/search.ts @@ -0,0 +1,631 @@ +/* + * 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 { ValuesType, UnionToIntersection } from 'utility-types'; +import * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; + +interface AggregationsAggregationContainer extends Record { + aggs?: any; + aggregations?: any; +} + +type InvalidAggregationRequest = unknown; + +// ensures aggregations work with requests where aggregation options are a union type, +// e.g. { transaction_groups: { composite: any } | { terms: any } }. +// Union keys are not included in keyof, but extends iterates over the types in a union. +type ValidAggregationKeysOf> = T extends T ? keyof T : never; + +type KeyOfSource = Record< + keyof T, + (T extends Record ? null : never) | string | number +>; + +type KeysOfSources = T extends [any] + ? KeyOfSource + : T extends [any, any] + ? KeyOfSource & KeyOfSource + : T extends [any, any, any] + ? KeyOfSource & KeyOfSource & KeyOfSource + : T extends [any, any, any, any] + ? KeyOfSource & KeyOfSource & KeyOfSource & KeyOfSource + : Record; + +type CompositeKeysOf = + TAggregationContainer extends { + composite: { sources: [...infer TSource] }; + } + ? KeysOfSources + : unknown; + +type Source = estypes.SearchSourceFilter | boolean | estypes.Fields; + +type TopMetricKeysOf = + TAggregationContainer extends { top_metrics: { metrics: { field: infer TField } } } + ? TField + : TAggregationContainer extends { top_metrics: { metrics: Array<{ field: infer TField }> } } + ? TField + : string; + +type ValueTypeOfField = T extends Record + ? ValuesType + : T extends Array + ? ValueTypeOfField + : T extends { field: estypes.Field } + ? T['field'] + : T extends string | number + ? T + : never; + +type MaybeArray = T | T[]; + +type Fields = Required['body']>['fields']; +type DocValueFields = MaybeArray; + +export type SearchHit< + TSource extends any = unknown, + TFields extends Fields | undefined = undefined, + TDocValueFields extends DocValueFields | undefined = undefined +> = Omit & + (TSource extends false ? {} : { _source: TSource }) & + (TFields extends Fields + ? { + fields: Partial, unknown[]>>; + } + : {}) & + (TDocValueFields extends DocValueFields + ? { + fields: Partial, unknown[]>>; + } + : {}); + +type HitsOf< + TOptions extends + | { _source?: Source; fields?: Fields; docvalue_fields?: DocValueFields } + | undefined, + TDocument extends unknown +> = Array< + SearchHit< + TOptions extends { _source: false } ? undefined : TDocument, + TOptions extends { fields: Fields } ? TOptions['fields'] : undefined, + TOptions extends { docvalue_fields: DocValueFields } ? TOptions['docvalue_fields'] : undefined + > +>; + +type AggregationMap = Partial>; + +type TopLevelAggregationRequest = Pick; + +type MaybeKeyed< + TAggregationContainer, + TBucket, + TKeys extends string = string +> = TAggregationContainer extends Record + ? Record + : { buckets: TBucket[] }; + +export type AggregateOf< + TAggregationContainer extends AggregationsAggregationContainer, + TDocument +> = ValuesType< + Pick< + Record & { + adjacency_matrix: { + buckets: Array< + { + key: string; + doc_count: number; + } & SubAggregateOf + >; + }; + auto_date_histogram: { + interval: string; + buckets: Array< + { + key: number; + key_as_string: string; + doc_count: number; + } & SubAggregateOf + >; + }; + avg: { + value: number | null; + value_as_string?: string; + }; + avg_bucket: { + value: number | null; + }; + boxplot: { + min: number | null; + max: number | null; + q1: number | null; + q2: number | null; + q3: number | null; + }; + bucket_correlation: { + value: number | null; + }; + bucket_count_ks_test: { + less: number; + greater: number; + two_sided: number; + }; + bucket_script: { + value: unknown; + }; + cardinality: { + value: number; + }; + children: { + doc_count: number; + } & SubAggregateOf; + composite: { + after_key: CompositeKeysOf; + buckets: Array< + { + doc_count: number; + key: CompositeKeysOf; + } & SubAggregateOf + >; + }; + cumulative_cardinality: { + value: number; + }; + cumulative_sum: { + value: number; + }; + date_histogram: MaybeKeyed< + TAggregationContainer, + { + key: number; + key_as_string: string; + doc_count: number; + } & SubAggregateOf + >; + date_range: MaybeKeyed< + TAggregationContainer, + Partial<{ from: string | number; from_as_string: string }> & + Partial<{ to: string | number; to_as_string: string }> & { + doc_count: number; + key: string; + } + >; + derivative: + | { + value: number | null; + } + | undefined; + extended_stats: { + count: number; + min: number | null; + max: number | null; + avg: number | null; + sum: number; + sum_of_squares: number | null; + variance: number | null; + variance_population: number | null; + variance_sampling: number | null; + std_deviation: number | null; + std_deviation_population: number | null; + std_deviation_sampling: number | null; + std_deviation_bounds: { + upper: number | null; + lower: number | null; + upper_population: number | null; + lower_population: number | null; + upper_sampling: number | null; + lower_sampling: number | null; + }; + } & ( + | { + min_as_string: string; + max_as_string: string; + avg_as_string: string; + sum_of_squares_as_string: string; + variance_population_as_string: string; + variance_sampling_as_string: string; + std_deviation_as_string: string; + std_deviation_population_as_string: string; + std_deviation_sampling_as_string: string; + std_deviation_bounds_as_string: { + upper: string; + lower: string; + upper_population: string; + lower_population: string; + upper_sampling: string; + lower_sampling: string; + }; + } + | {} + ); + extended_stats_bucket: { + count: number; + min: number | null; + max: number | null; + avg: number | null; + sum: number | null; + sum_of_squares: number | null; + variance: number | null; + variance_population: number | null; + variance_sampling: number | null; + std_deviation: number | null; + std_deviation_population: number | null; + std_deviation_sampling: number | null; + std_deviation_bounds: { + upper: number | null; + lower: number | null; + upper_population: number | null; + lower_population: number | null; + upper_sampling: number | null; + lower_sampling: number | null; + }; + }; + filter: { + doc_count: number; + } & SubAggregateOf; + filters: { + buckets: TAggregationContainer extends { filters: { filters: any[] } } + ? Array< + { + doc_count: number; + } & SubAggregateOf + > + : TAggregationContainer extends { filters: { filters: Record } } + ? { + [key in keyof TAggregationContainer['filters']['filters']]: { + doc_count: number; + } & SubAggregateOf; + } & (TAggregationContainer extends { + filters: { other_bucket_key: infer TOtherBucketKey }; + } + ? Record< + TOtherBucketKey & string, + { doc_count: number } & SubAggregateOf + > + : unknown) & + (TAggregationContainer extends { filters: { other_bucket: true } } + ? { + _other: { doc_count: number } & SubAggregateOf< + TAggregationContainer, + TDocument + >; + } + : unknown) + : unknown; + }; + geo_bounds: { + top_left: { + lat: number | null; + lon: number | null; + }; + bottom_right: { + lat: number | null; + lon: number | null; + }; + }; + geo_centroid: { + count: number; + location: { + lat: number; + lon: number; + }; + }; + geo_distance: MaybeKeyed< + TAggregationContainer, + { + from: number; + to?: number; + doc_count: number; + } & SubAggregateOf + >; + geo_hash: { + buckets: Array< + { + doc_count: number; + key: string; + } & SubAggregateOf + >; + }; + geotile_grid: { + buckets: Array< + { + doc_count: number; + key: string; + } & SubAggregateOf + >; + }; + global: { + doc_count: number; + } & SubAggregateOf; + histogram: MaybeKeyed< + TAggregationContainer, + { + key: number; + doc_count: number; + } & SubAggregateOf + >; + ip_range: MaybeKeyed< + TAggregationContainer, + { + key: string; + from?: string; + to?: string; + doc_count: number; + }, + TAggregationContainer extends { ip_range: { ranges: Array } } + ? TRangeType extends { key: infer TKeys } + ? TKeys + : string + : string + >; + inference: { + value: number; + prediction_probability: number; + prediction_score: number; + }; + max: { + value: number | null; + value_as_string?: string; + }; + max_bucket: { + value: number | null; + }; + min: { + value: number | null; + value_as_string?: string; + }; + min_bucket: { + value: number | null; + }; + median_absolute_deviation: { + value: number | null; + }; + moving_avg: + | { + value: number | null; + } + | undefined; + moving_fn: { + value: number | null; + }; + moving_percentiles: TAggregationContainer extends Record + ? Array<{ key: number; value: number | null }> + : Record | undefined; + missing: { + doc_count: number; + } & SubAggregateOf; + multi_terms: { + doc_count_error_upper_bound: number; + sum_other_doc_count: number; + buckets: Array< + { + doc_count: number; + key: string[]; + } & SubAggregateOf + >; + }; + nested: { + doc_count: number; + } & SubAggregateOf; + normalize: { + value: number | null; + // TODO: should be perhaps based on input? ie when `format` is specified + value_as_string?: string; + }; + parent: { + doc_count: number; + } & SubAggregateOf; + percentiles: { + values: TAggregationContainer extends Record + ? Array<{ key: number; value: number | null }> + : Record; + }; + percentile_ranks: { + values: TAggregationContainer extends Record + ? Array<{ key: number; value: number | null }> + : Record; + }; + percentiles_bucket: { + values: TAggregationContainer extends Record + ? Array<{ key: number; value: number | null }> + : Record; + }; + range: MaybeKeyed< + TAggregationContainer, + { + key: string; + from?: number; + from_as_string?: string; + to?: number; + to_as_string?: string; + doc_count: number; + }, + TAggregationContainer extends { range: { ranges: Array } } + ? TRangeType extends { key: infer TKeys } + ? TKeys + : string + : string + >; + rare_terms: Array< + { + key: string | number; + doc_count: number; + } & SubAggregateOf + >; + rate: { + value: number | null; + }; + reverse_nested: { + doc_count: number; + } & SubAggregateOf; + random_sampler: { + seed: number; + probability: number; + doc_count: number; + } & SubAggregateOf; + sampler: { + doc_count: number; + } & SubAggregateOf; + scripted_metric: { + value: unknown; + }; + serial_diff: { + value: number | null; + // TODO: should be perhaps based on input? ie when `format` is specified + value_as_string?: string; + }; + significant_terms: { + doc_count: number; + bg_count: number; + buckets: Array< + { + key: string | number; + score: number; + doc_count: number; + bg_count: number; + } & SubAggregateOf + >; + }; + significant_text: { + doc_count: number; + buckets: Array<{ + key: string; + doc_count: number; + score: number; + bg_count: number; + }>; + }; + stats: { + count: number; + min: number | null; + max: number | null; + avg: number | null; + sum: number; + } & ( + | { + min_as_string: string; + max_as_string: string; + avg_as_string: string; + sum_as_string: string; + } + | {} + ); + stats_bucket: { + count: number; + min: number | null; + max: number | null; + avg: number | null; + sum: number; + }; + string_stats: { + count: number; + min_length: number | null; + max_length: number | null; + avg_length: number | null; + entropy: number | null; + distribution: Record; + }; + sum: { + value: number | null; + value_as_string?: string; + }; + sum_bucket: { + value: number | null; + }; + terms: { + doc_count_error_upper_bound: number; + sum_other_doc_count: number; + buckets: Array< + { + doc_count: number; + key: string | number; + key_as_string?: string; + } & SubAggregateOf + >; + }; + top_hits: { + hits: { + total: { + value: number; + relation: 'eq' | 'gte'; + }; + max_score: number | null; + hits: TAggregationContainer extends { top_hits: estypes.AggregationsTopHitsAggregation } + ? HitsOf + : estypes.SearchHitsMetadata; + }; + }; + top_metrics: { + top: Array<{ + sort: number[] | string[]; + metrics: Record, string | number | null>; + }>; + }; + weighted_avg: { value: number | null }; + value_count: { + value: number; + }; + // t_test: {} not defined + }, + Exclude, 'aggs' | 'aggregations'> & string + > +>; + +type AggregateOfMap = { + [TAggregationName in keyof TAggregationMap]: Required[TAggregationName] extends AggregationsAggregationContainer + ? AggregateOf + : never; // using never means we effectively ignore optional keys, using {} creates a union type of { ... } | {} +}; + +type SubAggregateOf = TAggregationRequest extends { + aggs?: AggregationMap; +} + ? AggregateOfMap + : TAggregationRequest extends { aggregations?: AggregationMap } + ? AggregateOfMap + : {}; + +type SearchResponseOf< + TAggregationRequest extends TopLevelAggregationRequest, + TDocument +> = SubAggregateOf; + +// if aggregation response cannot be inferred, fall back to unknown +type WrapAggregationResponse = keyof UnionToIntersection extends never + ? { aggregations?: unknown } + : { aggregations?: T }; + +export type InferSearchResponseOf< + TDocument = unknown, + TSearchRequest extends estypes.SearchRequest = estypes.SearchRequest, + TOptions extends { restTotalHitsAsInt?: boolean } = {} +> = Omit, 'aggregations' | 'hits'> & + (TSearchRequest['body'] extends TopLevelAggregationRequest + ? WrapAggregationResponse> + : TSearchRequest extends TopLevelAggregationRequest + ? WrapAggregationResponse> + : { aggregations?: InvalidAggregationRequest }) & { + hits: Omit['hits'], 'total' | 'hits'> & + (TOptions['restTotalHitsAsInt'] extends true + ? { + total: number; + } + : { + total: { + value: number; + relation: 'eq' | 'gte'; + }; + }) & { + hits: HitsOf< + TSearchRequest['body'] extends estypes.SearchRequest['body'] + ? TSearchRequest['body'] + : TSearchRequest, + TDocument + >; + }; + }; diff --git a/packages/kbn-es-types/tsconfig.json b/packages/kbn-es-types/tsconfig.json new file mode 100644 index 0000000000000..81935b1385550 --- /dev/null +++ b/packages/kbn-es-types/tsconfig.json @@ -0,0 +1,17 @@ +{ + "extends": "../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "declarationMap": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "**/*.ts", + ] +} diff --git a/packages/kbn-es/src/cluster.js b/packages/kbn-es/src/cluster.js index 5c410523d70ca..a027db201b002 100644 --- a/packages/kbn-es/src/cluster.js +++ b/packages/kbn-es/src/cluster.js @@ -6,10 +6,12 @@ * Side Public License, v 1. */ +const fs = require('fs'); const fsp = require('fs/promises'); const execa = require('execa'); const chalk = require('chalk'); const path = require('path'); +const Rx = require('rxjs'); const { Client } = require('@elastic/elasticsearch'); const { downloadSnapshot, installSnapshot, installSource, installArchive } = require('./install'); const { ES_BIN, ES_PLUGIN_BIN, ES_KEYSTORE_BIN } = require('./paths'); @@ -315,6 +317,7 @@ exports.Cluster = class Cluster { startTime, skipReadyCheck, readyTimeout, + writeLogsToPath, ...options } = opts; @@ -322,7 +325,19 @@ exports.Cluster = class Cluster { throw new Error('ES has already been started'); } - this._log.info(chalk.bold('Starting')); + /** @type {NodeJS.WritableStream | undefined} */ + let stdioTarget; + + if (writeLogsToPath) { + stdioTarget = fs.createWriteStream(writeLogsToPath, 'utf8'); + this._log.info( + chalk.bold('Starting'), + `and writing logs to ${path.relative(process.cwd(), writeLogsToPath)}` + ); + } else { + this._log.info(chalk.bold('Starting')); + } + this._log.indent(4); const esArgs = new Map([ @@ -428,7 +443,8 @@ exports.Cluster = class Cluster { let reportSent = false; // parse and forward es stdout to the log this._process.stdout.on('data', (data) => { - const lines = parseEsLog(data.toString()); + const chunk = data.toString(); + const lines = parseEsLog(chunk); lines.forEach((line) => { if (!reportSent && line.message.includes('publish_address')) { reportSent = true; @@ -436,12 +452,36 @@ exports.Cluster = class Cluster { success: true, }); } - this._log.info(line.formattedMessage); + + if (stdioTarget) { + stdioTarget.write(chunk); + } else { + this._log.info(line.formattedMessage); + } }); }); // forward es stderr to the log - this._process.stderr.on('data', (data) => this._log.error(chalk.red(data.toString()))); + this._process.stderr.on('data', (data) => { + const chunk = data.toString(); + if (stdioTarget) { + stdioTarget.write(chunk); + } else { + this._log.error(chalk.red()); + } + }); + + // close the stdio target if we have one defined + if (stdioTarget) { + Rx.combineLatest([ + Rx.fromEvent(this._process.stderr, 'end'), + Rx.fromEvent(this._process.stdout, 'end'), + ]) + .pipe(Rx.first()) + .subscribe(() => { + stdioTarget.end(); + }); + } // observe the exit code of the process and reflect in _outcome promies const exitCode = new Promise((resolve) => this._process.once('exit', resolve)); diff --git a/packages/kbn-generate/src/commands/codeowners_command.ts b/packages/kbn-generate/src/commands/codeowners_command.ts index 7478f342c0d9a..f1c42dc54173f 100644 --- a/packages/kbn-generate/src/commands/codeowners_command.ts +++ b/packages/kbn-generate/src/commands/codeowners_command.ts @@ -42,7 +42,7 @@ export const CodeownersCommand: GenerateCommand = { } const newCodeowners = `${codeowners.slice(0, genStart)}${GENERATED_START}${pkgs - .map((pkg) => `${pkg.normalizedRepoRelativeDir} ${pkg.manifest.owner}`) + .map((pkg) => `${pkg.normalizedRepoRelativeDir} ${pkg.manifest.owner.join(' ')}`) .join('\n')}\n`; if (codeowners === newCodeowners) { diff --git a/packages/kbn-kibana-manifest-schema/src/kibana_json_v2_schema.ts b/packages/kbn-kibana-manifest-schema/src/kibana_json_v2_schema.ts index b665808837121..21b3b3b717380 100644 --- a/packages/kbn-kibana-manifest-schema/src/kibana_json_v2_schema.ts +++ b/packages/kbn-kibana-manifest-schema/src/kibana_json_v2_schema.ts @@ -27,14 +27,25 @@ export const MANIFEST_V2: JSONSchema = { `, }, owner: { - type: 'string', + oneOf: [ + { + type: 'string', + pattern: '^@', + }, + { + type: 'array', + items: { + type: 'string', + pattern: '^@', + }, + }, + ], description: desc` Github handle for the person or team who is responsible for this package. This owner will be used in the codeowners files for this package. - For additional codeowners, you add manually add entries to the codeowners file. + For additional codeowners, the value can be an array of user/team names. `, - pattern: '^@', }, typeDeps: { type: 'array', diff --git a/packages/kbn-optimizer/limits.yml b/packages/kbn-optimizer/limits.yml index 511d230ec968d..0c6b68f79cebd 100644 --- a/packages/kbn-optimizer/limits.yml +++ b/packages/kbn-optimizer/limits.yml @@ -10,6 +10,7 @@ pageLoadAssetSize: cases: 144442 charts: 55000 cloud: 21076 + cloudExperiments: 59358 cloudSecurityPosture: 19109 console: 46091 controls: 40000 @@ -31,7 +32,7 @@ pageLoadAssetSize: embeddableEnhanced: 22107 enterpriseSearch: 35741 esUiShared: 326654 - eventAnnotation: 19334 + eventAnnotation: 19500 expressionError: 22127 expressionGauge: 25000 expressionHeatmap: 27505 @@ -56,6 +57,7 @@ pageLoadAssetSize: globalSearchProviders: 25554 graph: 31504 grokdebugger: 26779 + guidedOnboarding: 26875 home: 30182 indexLifecycleManagement: 107090 indexManagement: 140608 @@ -85,6 +87,7 @@ pageLoadAssetSize: osquery: 107090 painlessLab: 179748 presentationUtil: 58834 + profiling: 18628 remoteClusters: 51327 reporting: 57003 rollup: 97204 @@ -108,7 +111,7 @@ pageLoadAssetSize: synthetics: 40958 telemetry: 51957 telemetryManagementSection: 38586 - threatIntelligence: 29195 + threatIntelligence: 44299 timelines: 327300 transform: 41007 triggersActionsUi: 119000 diff --git a/packages/kbn-optimizer/src/__fixtures__/mock_repo/src/core/public/core_app/styles/_globals_v7dark.scss b/packages/kbn-optimizer/src/__fixtures__/mock_repo/src/core/public/styles/core_app/_globals_v7dark.scss similarity index 100% rename from packages/kbn-optimizer/src/__fixtures__/mock_repo/src/core/public/core_app/styles/_globals_v7dark.scss rename to packages/kbn-optimizer/src/__fixtures__/mock_repo/src/core/public/styles/core_app/_globals_v7dark.scss diff --git a/packages/kbn-optimizer/src/__fixtures__/mock_repo/src/core/public/core_app/styles/_globals_v7light.scss b/packages/kbn-optimizer/src/__fixtures__/mock_repo/src/core/public/styles/core_app/_globals_v7light.scss similarity index 100% rename from packages/kbn-optimizer/src/__fixtures__/mock_repo/src/core/public/core_app/styles/_globals_v7light.scss rename to packages/kbn-optimizer/src/__fixtures__/mock_repo/src/core/public/styles/core_app/_globals_v7light.scss diff --git a/packages/kbn-optimizer/src/__fixtures__/mock_repo/src/core/public/core_app/styles/_globals_v8dark.scss b/packages/kbn-optimizer/src/__fixtures__/mock_repo/src/core/public/styles/core_app/_globals_v8dark.scss similarity index 100% rename from packages/kbn-optimizer/src/__fixtures__/mock_repo/src/core/public/core_app/styles/_globals_v8dark.scss rename to packages/kbn-optimizer/src/__fixtures__/mock_repo/src/core/public/styles/core_app/_globals_v8dark.scss diff --git a/packages/kbn-optimizer/src/__fixtures__/mock_repo/src/core/public/core_app/styles/_globals_v8light.scss b/packages/kbn-optimizer/src/__fixtures__/mock_repo/src/core/public/styles/core_app/_globals_v8light.scss similarity index 100% rename from packages/kbn-optimizer/src/__fixtures__/mock_repo/src/core/public/core_app/styles/_globals_v8light.scss rename to packages/kbn-optimizer/src/__fixtures__/mock_repo/src/core/public/styles/core_app/_globals_v8light.scss diff --git a/packages/kbn-optimizer/src/integration_tests/basic_optimization.test.ts b/packages/kbn-optimizer/src/integration_tests/basic_optimization.test.ts index e7f9e7d3c3b81..fdd36c76f6e4d 100644 --- a/packages/kbn-optimizer/src/integration_tests/basic_optimization.test.ts +++ b/packages/kbn-optimizer/src/integration_tests/basic_optimization.test.ts @@ -164,8 +164,8 @@ it('builds expected bundles, saves bundle counts to metadata', async () => { /packages/kbn-optimizer/src/__fixtures__/__tmp__/mock_repo/plugins/bar/public/legacy/_other_styles.scss, /packages/kbn-optimizer/src/__fixtures__/__tmp__/mock_repo/plugins/bar/public/legacy/styles.scss, /packages/kbn-optimizer/src/__fixtures__/__tmp__/mock_repo/plugins/bar/public/lib.ts, - /packages/kbn-optimizer/src/__fixtures__/__tmp__/mock_repo/src/core/public/core_app/styles/_globals_v8dark.scss, - /packages/kbn-optimizer/src/__fixtures__/__tmp__/mock_repo/src/core/public/core_app/styles/_globals_v8light.scss, + /packages/kbn-optimizer/src/__fixtures__/__tmp__/mock_repo/src/core/public/styles/core_app/_globals_v8dark.scss, + /packages/kbn-optimizer/src/__fixtures__/__tmp__/mock_repo/src/core/public/styles/core_app/_globals_v8light.scss, /packages/kbn-optimizer/src/worker/entry_point_creator.ts, ] `); diff --git a/packages/kbn-optimizer/src/worker/webpack.config.ts b/packages/kbn-optimizer/src/worker/webpack.config.ts index 1b87498496b24..04074fb2b10b4 100644 --- a/packages/kbn-optimizer/src/worker/webpack.config.ts +++ b/packages/kbn-optimizer/src/worker/webpack.config.ts @@ -188,7 +188,7 @@ export function getWebpackConfig(bundle: Bundle, bundleRefs: BundleRefs, worker: loaderContext, Path.resolve( worker.repoRoot, - `src/core/public/core_app/styles/_globals_${theme}.scss` + `src/core/public/styles/core_app/_globals_${theme}.scss` ) )};\n${content}`; }, @@ -246,7 +246,10 @@ export function getWebpackConfig(bundle: Bundle, bundleRefs: BundleRefs, worker: extensions: ['.js', '.ts', '.tsx', '.json'], mainFields: ['browser', 'main'], alias: { - core_app_image_assets: Path.resolve(worker.repoRoot, 'src/core/public/core_app/images'), + core_app_image_assets: Path.resolve( + worker.repoRoot, + 'src/core/public/styles/core_app/images' + ), vega: Path.resolve(worker.repoRoot, 'node_modules/vega/build-es5/vega.js'), }, symlinks: false, diff --git a/packages/kbn-securitysolution-autocomplete/src/field/__tests__/__snapshots__/index.test.tsx.snap b/packages/kbn-securitysolution-autocomplete/src/field/__tests__/__snapshots__/index.test.tsx.snap new file mode 100644 index 0000000000000..daaf9c66c453f --- /dev/null +++ b/packages/kbn-securitysolution-autocomplete/src/field/__tests__/__snapshots__/index.test.tsx.snap @@ -0,0 +1,765 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`FieldComponent should allow user to clear values if isClearable is true 1`] = ` +Object { + "asFragment": [Function], + "baseElement": +
+
+
+
+
+ + machine.os.raw + +
+ +
+
+
+
+ + +
+
+
+
+
+ , + "container":
+
+
+
+
+ + machine.os.raw + +
+ +
+
+
+
+ + +
+
+
+
+
, + "debug": [Function], + "findAllByAltText": [Function], + "findAllByDisplayValue": [Function], + "findAllByLabelText": [Function], + "findAllByPlaceholderText": [Function], + "findAllByRole": [Function], + "findAllByTestId": [Function], + "findAllByText": [Function], + "findAllByTitle": [Function], + "findByAltText": [Function], + "findByDisplayValue": [Function], + "findByLabelText": [Function], + "findByPlaceholderText": [Function], + "findByRole": [Function], + "findByTestId": [Function], + "findByText": [Function], + "findByTitle": [Function], + "getAllByAltText": [Function], + "getAllByDisplayValue": [Function], + "getAllByLabelText": [Function], + "getAllByPlaceholderText": [Function], + "getAllByRole": [Function], + "getAllByTestId": [Function], + "getAllByText": [Function], + "getAllByTitle": [Function], + "getByAltText": [Function], + "getByDisplayValue": [Function], + "getByLabelText": [Function], + "getByPlaceholderText": [Function], + "getByRole": [Function], + "getByTestId": [Function], + "getByText": [Function], + "getByTitle": [Function], + "queryAllByAltText": [Function], + "queryAllByDisplayValue": [Function], + "queryAllByLabelText": [Function], + "queryAllByPlaceholderText": [Function], + "queryAllByRole": [Function], + "queryAllByTestId": [Function], + "queryAllByText": [Function], + "queryAllByTitle": [Function], + "queryByAltText": [Function], + "queryByDisplayValue": [Function], + "queryByLabelText": [Function], + "queryByPlaceholderText": [Function], + "queryByRole": [Function], + "queryByTestId": [Function], + "queryByText": [Function], + "queryByTitle": [Function], + "rerender": [Function], + "unmount": [Function], +} +`; + +exports[`FieldComponent should render the component disabled if isDisabled is true 1`] = ` +Object { + "asFragment": [Function], + "baseElement": +
+
+
+
+
+ + machine.os.raw + +
+ +
+
+
+
+ +
+
+
+
+
+ , + "container":
+
+
+
+
+ + machine.os.raw + +
+ +
+
+
+
+ +
+
+
+
+
, + "debug": [Function], + "findAllByAltText": [Function], + "findAllByDisplayValue": [Function], + "findAllByLabelText": [Function], + "findAllByPlaceholderText": [Function], + "findAllByRole": [Function], + "findAllByTestId": [Function], + "findAllByText": [Function], + "findAllByTitle": [Function], + "findByAltText": [Function], + "findByDisplayValue": [Function], + "findByLabelText": [Function], + "findByPlaceholderText": [Function], + "findByRole": [Function], + "findByTestId": [Function], + "findByText": [Function], + "findByTitle": [Function], + "getAllByAltText": [Function], + "getAllByDisplayValue": [Function], + "getAllByLabelText": [Function], + "getAllByPlaceholderText": [Function], + "getAllByRole": [Function], + "getAllByTestId": [Function], + "getAllByText": [Function], + "getAllByTitle": [Function], + "getByAltText": [Function], + "getByDisplayValue": [Function], + "getByLabelText": [Function], + "getByPlaceholderText": [Function], + "getByRole": [Function], + "getByTestId": [Function], + "getByText": [Function], + "getByTitle": [Function], + "queryAllByAltText": [Function], + "queryAllByDisplayValue": [Function], + "queryAllByLabelText": [Function], + "queryAllByPlaceholderText": [Function], + "queryAllByRole": [Function], + "queryAllByTestId": [Function], + "queryAllByText": [Function], + "queryAllByTitle": [Function], + "queryByAltText": [Function], + "queryByDisplayValue": [Function], + "queryByLabelText": [Function], + "queryByPlaceholderText": [Function], + "queryByRole": [Function], + "queryByTestId": [Function], + "queryByText": [Function], + "queryByTitle": [Function], + "rerender": [Function], + "unmount": [Function], +} +`; + +exports[`FieldComponent should render the component enabled and displays the selected field correctly 1`] = ` +Object { + "asFragment": [Function], + "baseElement": +
+
+
+
+
+ + machine.os.raw + +
+ +
+
+
+
+ +
+
+
+
+
+ , + "container":
+
+
+
+
+ + machine.os.raw + +
+ +
+
+
+
+ +
+
+
+
+
, + "debug": [Function], + "findAllByAltText": [Function], + "findAllByDisplayValue": [Function], + "findAllByLabelText": [Function], + "findAllByPlaceholderText": [Function], + "findAllByRole": [Function], + "findAllByTestId": [Function], + "findAllByText": [Function], + "findAllByTitle": [Function], + "findByAltText": [Function], + "findByDisplayValue": [Function], + "findByLabelText": [Function], + "findByPlaceholderText": [Function], + "findByRole": [Function], + "findByTestId": [Function], + "findByText": [Function], + "findByTitle": [Function], + "getAllByAltText": [Function], + "getAllByDisplayValue": [Function], + "getAllByLabelText": [Function], + "getAllByPlaceholderText": [Function], + "getAllByRole": [Function], + "getAllByTestId": [Function], + "getAllByText": [Function], + "getAllByTitle": [Function], + "getByAltText": [Function], + "getByDisplayValue": [Function], + "getByLabelText": [Function], + "getByPlaceholderText": [Function], + "getByRole": [Function], + "getByTestId": [Function], + "getByText": [Function], + "getByTitle": [Function], + "queryAllByAltText": [Function], + "queryAllByDisplayValue": [Function], + "queryAllByLabelText": [Function], + "queryAllByPlaceholderText": [Function], + "queryAllByRole": [Function], + "queryAllByTestId": [Function], + "queryAllByText": [Function], + "queryAllByTitle": [Function], + "queryByAltText": [Function], + "queryByDisplayValue": [Function], + "queryByLabelText": [Function], + "queryByPlaceholderText": [Function], + "queryByRole": [Function], + "queryByTestId": [Function], + "queryByText": [Function], + "queryByTitle": [Function], + "rerender": [Function], + "unmount": [Function], +} +`; + +exports[`FieldComponent should render the loading spinner if isLoading is true when clicked 1`] = ` +Object { + "asFragment": [Function], + "baseElement": +
+
+
+
+
+ + machine.os.raw + +
+ +
+
+
+
+ + +
+
+
+
+
+ , + "container":
+
+
+
+
+ + machine.os.raw + +
+ +
+
+
+
+ + +
+
+
+
+
, + "debug": [Function], + "findAllByAltText": [Function], + "findAllByDisplayValue": [Function], + "findAllByLabelText": [Function], + "findAllByPlaceholderText": [Function], + "findAllByRole": [Function], + "findAllByTestId": [Function], + "findAllByText": [Function], + "findAllByTitle": [Function], + "findByAltText": [Function], + "findByDisplayValue": [Function], + "findByLabelText": [Function], + "findByPlaceholderText": [Function], + "findByRole": [Function], + "findByTestId": [Function], + "findByText": [Function], + "findByTitle": [Function], + "getAllByAltText": [Function], + "getAllByDisplayValue": [Function], + "getAllByLabelText": [Function], + "getAllByPlaceholderText": [Function], + "getAllByRole": [Function], + "getAllByTestId": [Function], + "getAllByText": [Function], + "getAllByTitle": [Function], + "getByAltText": [Function], + "getByDisplayValue": [Function], + "getByLabelText": [Function], + "getByPlaceholderText": [Function], + "getByRole": [Function], + "getByTestId": [Function], + "getByText": [Function], + "getByTitle": [Function], + "queryAllByAltText": [Function], + "queryAllByDisplayValue": [Function], + "queryAllByLabelText": [Function], + "queryAllByPlaceholderText": [Function], + "queryAllByRole": [Function], + "queryAllByTestId": [Function], + "queryAllByText": [Function], + "queryAllByTitle": [Function], + "queryByAltText": [Function], + "queryByDisplayValue": [Function], + "queryByLabelText": [Function], + "queryByPlaceholderText": [Function], + "queryByRole": [Function], + "queryByTestId": [Function], + "queryByText": [Function], + "queryByTitle": [Function], + "rerender": [Function], + "unmount": [Function], +} +`; diff --git a/packages/kbn-securitysolution-autocomplete/src/field/__tests__/disabled_types_with_tooltip_text.test.ts b/packages/kbn-securitysolution-autocomplete/src/field/__tests__/disabled_types_with_tooltip_text.test.ts new file mode 100644 index 0000000000000..819b91942b953 --- /dev/null +++ b/packages/kbn-securitysolution-autocomplete/src/field/__tests__/disabled_types_with_tooltip_text.test.ts @@ -0,0 +1,19 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { disabledTypesWithTooltipText } from '../disabled_types_with_tooltip_text'; + +jest.mock('../../translations', () => ({ + BINARY_TYPE_NOT_SUPPORTED: 'Binary fields are currently unsupported', +})); +describe('disabledTypesWithTooltipText', () => { + it('should return Binary fields are currently unsupported for binary type', () => { + const type = 'binary'; + expect(disabledTypesWithTooltipText[type]).toEqual('Binary fields are currently unsupported'); + }); +}); diff --git a/packages/kbn-securitysolution-autocomplete/src/field/__tests__/index.test.tsx b/packages/kbn-securitysolution-autocomplete/src/field/__tests__/index.test.tsx new file mode 100644 index 0000000000000..dcdba80c268d7 --- /dev/null +++ b/packages/kbn-securitysolution-autocomplete/src/field/__tests__/index.test.tsx @@ -0,0 +1,117 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import React from 'react'; +import { fireEvent, render, waitFor } from '@testing-library/react'; +import '@testing-library/jest-dom'; + +import { FieldComponent } from '..'; +import { fields, getField } from '../../fields/index.mock'; + +describe('FieldComponent', () => { + it('should render the component enabled and displays the selected field correctly', () => { + const wrapper = render( + + ); + expect(wrapper).toMatchSnapshot(); + expect(wrapper.getByTestId('fieldAutocompleteComboBox')).toHaveTextContent('machine.os.raw'); + }); + it('should render the component disabled if isDisabled is true', () => { + const wrapper = render( + + ); + expect(wrapper).toMatchSnapshot(); + expect(wrapper.getByTestId('fieldAutocompleteComboBox').querySelector('input')).toBeDisabled(); + }); + it('should render the loading spinner if isLoading is true when clicked', () => { + const wrapper = render( + + ); + const fieldAutocompleteComboBox = wrapper.getByTestId('fieldAutocompleteComboBox'); + expect(wrapper).toMatchSnapshot(); + fireEvent.click(fieldAutocompleteComboBox); + expect(wrapper.getByRole('progressbar')).toBeInTheDocument(); + }); + it('should allow user to clear values if isClearable is true', () => { + const wrapper = render( + + ); + expect(wrapper).toMatchSnapshot(); + expect(wrapper.getByTestId('comboBoxClearButton')).toBeInTheDocument(); + }); + it('should change the selected value', async () => { + const wrapper = render( + + ); + const fieldAutocompleteComboBox = wrapper.getByTestId('comboBoxSearchInput'); + fireEvent.change(fieldAutocompleteComboBox, { target: { value: '_source' } }); + await waitFor(() => + expect(wrapper.getByTestId('fieldAutocompleteComboBox')).toHaveTextContent('_source') + ); + }); +}); diff --git a/packages/kbn-securitysolution-autocomplete/src/field/__tests__/use_field.test.ts b/packages/kbn-securitysolution-autocomplete/src/field/__tests__/use_field.test.ts new file mode 100644 index 0000000000000..68748bf82a20f --- /dev/null +++ b/packages/kbn-securitysolution-autocomplete/src/field/__tests__/use_field.test.ts @@ -0,0 +1,396 @@ +/* + * 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 { DataViewFieldBase } from '@kbn/es-query'; +import { ReactElement } from 'react'; +import { act } from '@testing-library/react'; + +import { renderHook } from '@testing-library/react-hooks'; +import TestRenderer from 'react-test-renderer'; +const { act: actTestRenderer } = TestRenderer; + +import { fields } from '../../fields/index.mock'; +import { useField } from '../use_field'; + +jest.mock('../../translations', () => ({ + BINARY_TYPE_NOT_SUPPORTED: 'Binary fields are currently unsupported', +})); + +const indexPattern = { fields, title: 'title' }; +const onChangeMock = jest.fn(); +const selectedField = { name: '@timestamp', type: 'date' }; +describe('useField', () => { + beforeEach(() => { + jest.resetAllMocks(); + jest.resetModules(); + }); + + describe('comboOptions and selectedComboOptions', () => { + it('should return default values', () => { + const { result } = renderHook(() => useField({ indexPattern, onChange: onChangeMock })); + const { isInvalid, comboOptions, selectedComboOptions, fieldWidth } = result.current; + expect(isInvalid).toBeFalsy(); + expect(comboOptions.length).toEqual(30); + expect(selectedComboOptions.length).toEqual(0); + expect(fieldWidth).toEqual({}); + }); + it('should map fields to comboOptions correctly and return empty selectedComboOptions', () => { + const newIndexPattern = { + ...indexPattern, + fields: [ + { + name: 'bytes', + type: 'number', + esTypes: ['long'], + count: 10, + scripted: false, + searchable: true, + aggregatable: true, + readFromDocValues: true, + }, + { + name: 'ssl', + type: 'boolean', + esTypes: ['boolean'], + count: 20, + scripted: false, + searchable: true, + aggregatable: true, + readFromDocValues: true, + }, + { + name: '@timestamp', + type: 'date', + esTypes: ['date'], + count: 30, + scripted: false, + searchable: true, + aggregatable: true, + readFromDocValues: true, + }, + ] as unknown as DataViewFieldBase[], + title: 'title1', + }; + + const { result } = renderHook(() => + useField({ indexPattern: newIndexPattern, onChange: onChangeMock }) + ); + const { comboOptions, selectedComboOptions } = result.current; + expect(comboOptions).toEqual([{ label: 'bytes' }, { label: 'ssl' }, { label: '@timestamp' }]); + expect(selectedComboOptions).toEqual([]); + }); + it('should map fields to comboOptions correctly and return selectedComboOptions', () => { + const newIndexPattern = { + ...indexPattern, + fields: [ + { + name: 'bytes', + type: 'number', + esTypes: ['long'], + count: 10, + scripted: false, + searchable: true, + aggregatable: true, + readFromDocValues: true, + }, + { + name: 'ssl', + type: 'boolean', + esTypes: ['boolean'], + count: 20, + scripted: false, + searchable: true, + aggregatable: true, + readFromDocValues: true, + }, + { + name: '@timestamp', + type: 'date', + esTypes: ['date'], + count: 30, + scripted: false, + searchable: true, + aggregatable: true, + readFromDocValues: true, + }, + ] as unknown as DataViewFieldBase[], + title: 'title1', + }; + + const { result } = renderHook(() => + useField({ indexPattern: newIndexPattern, onChange: onChangeMock, selectedField }) + ); + const { comboOptions, selectedComboOptions } = result.current; + expect(comboOptions).toEqual([{ label: 'bytes' }, { label: 'ssl' }, { label: '@timestamp' }]); + expect(selectedComboOptions).toEqual([{ label: '@timestamp' }]); + }); + }); + + describe('getDisabledLabelTooltipTexts and renderFields', () => { + it('should return label as component and disable the binary field type if field.esType has one the disabled types', () => { + indexPattern.fields = [ + { + name: 'blob', + type: 'unknown', + esTypes: ['binary'], + scripted: false, + searchable: true, + aggregatable: true, + readFromDocValues: true, + }, + { + name: 'bytes', + type: 'number', + esTypes: ['long'], + count: 10, + scripted: false, + searchable: true, + aggregatable: true, + readFromDocValues: true, + }, + { + name: 'ssl', + type: 'boolean', + esTypes: ['boolean'], + count: 20, + scripted: false, + searchable: true, + aggregatable: true, + readFromDocValues: true, + }, + { + name: '@timestamp', + type: 'date', + esTypes: ['date'], + count: 30, + scripted: false, + searchable: true, + aggregatable: true, + readFromDocValues: true, + }, + ] as unknown as DataViewFieldBase[]; + const { result } = renderHook(() => useField({ indexPattern, onChange: onChangeMock })); + const { comboOptions, renderFields } = result.current; + expect(comboOptions).toEqual([ + { label: 'blob' }, + { label: 'bytes' }, + { label: 'ssl' }, + { label: '@timestamp' }, + ]); + act(() => { + const label = renderFields({ label: 'blob' }, '', '') as ReactElement; + expect(label?.props.content).toEqual('Binary fields are currently unsupported'); + }); + }); + it('should return label as component and disable the binary field type if field.type is one of the disabled types', () => { + indexPattern.fields = [ + { + name: 'blob', + type: 'binary', + esTypes: [], + scripted: false, + searchable: true, + aggregatable: true, + readFromDocValues: true, + }, + { + name: 'bytes', + type: 'number', + esTypes: ['long'], + count: 10, + scripted: false, + searchable: true, + aggregatable: true, + readFromDocValues: true, + }, + { + name: 'ssl', + type: 'boolean', + esTypes: ['boolean'], + count: 20, + scripted: false, + searchable: true, + aggregatable: true, + readFromDocValues: true, + }, + { + name: '@timestamp', + type: 'date', + esTypes: ['date'], + count: 30, + scripted: false, + searchable: true, + aggregatable: true, + readFromDocValues: true, + }, + ] as unknown as DataViewFieldBase[]; + const { result } = renderHook(() => useField({ indexPattern, onChange: onChangeMock })); + const { comboOptions, renderFields } = result.current; + expect(comboOptions).toEqual([ + { label: 'blob' }, + { label: 'bytes' }, + { label: 'ssl' }, + { label: '@timestamp' }, + ]); + act(() => { + const label = renderFields({ label: 'blob' }, '', '') as ReactElement; + expect(label?.props.content).toEqual('Binary fields are currently unsupported'); + }); + }); + it('should return label as string', () => { + indexPattern.fields = [ + { + name: 'bytes', + type: 'number', + esTypes: ['long'], + count: 10, + scripted: false, + searchable: true, + aggregatable: true, + readFromDocValues: true, + }, + { + name: 'ssl', + type: 'boolean', + esTypes: ['boolean'], + count: 20, + scripted: false, + searchable: true, + aggregatable: true, + readFromDocValues: true, + }, + { + name: '@timestamp', + type: 'date', + esTypes: ['date'], + count: 30, + scripted: false, + searchable: true, + aggregatable: true, + readFromDocValues: true, + }, + ] as unknown as DataViewFieldBase[]; + const { result } = renderHook(() => useField({ indexPattern, onChange: onChangeMock })); + const { comboOptions, renderFields } = result.current; + expect(comboOptions).toEqual([{ label: 'bytes' }, { label: 'ssl' }, { label: '@timestamp' }]); + act(() => { + const label = renderFields({ label: '@timestamp' }, '', '') as ReactElement; + expect(label).toEqual('@timestamp'); + }); + }); + }); + describe('handleValuesChange', () => { + beforeEach(() => { + jest.resetAllMocks(); + jest.resetModules(); + }); + it('should invoke onChange with one value if one option is sent', () => { + const { result } = renderHook(() => useField({ indexPattern, onChange: onChangeMock })); + act(() => { + result.current.handleValuesChange([ + { + label: '@timestamp', + }, + ]); + expect(onChangeMock).toHaveBeenCalledWith([ + { + aggregatable: true, + count: 30, + esTypes: ['date'], + name: '@timestamp', + readFromDocValues: true, + scripted: false, + searchable: true, + type: 'date', + }, + ]); + }); + }); + it('should invoke onChange with array value if more than an option', () => { + const { result } = renderHook(() => useField({ indexPattern, onChange: onChangeMock })); + act(() => { + result.current.handleValuesChange([ + { + label: '@timestamp', + }, + { + label: 'ssl', + }, + ]); + expect(onChangeMock).toHaveBeenCalledWith([ + { + aggregatable: true, + count: 30, + esTypes: ['date'], + name: '@timestamp', + readFromDocValues: true, + scripted: false, + searchable: true, + type: 'date', + }, + { + name: 'ssl', + type: 'boolean', + esTypes: ['boolean'], + count: 20, + scripted: false, + searchable: true, + aggregatable: true, + readFromDocValues: true, + }, + ]); + }); + }); + }); + + describe('fieldWidth', () => { + it('should return object has width prop', () => { + const { result } = renderHook(() => + useField({ indexPattern, onChange: onChangeMock, fieldInputWidth: 100 }) + ); + expect(result.current.fieldWidth).toEqual({ width: '100px' }); + }); + it('should return empty object', () => { + const { result } = renderHook(() => + useField({ indexPattern, onChange: onChangeMock, fieldInputWidth: 0 }) + ); + expect(result.current.fieldWidth).toEqual({}); + }); + }); + + describe('isInvalid with handleTouch', () => { + it('should return isInvalid equals true when calling with no selectedField and isRequired is true', () => { + const { result } = renderHook(() => + useField({ indexPattern, onChange: onChangeMock, isRequired: true }) + ); + + actTestRenderer(() => { + result.current.handleTouch(); + }); + expect(result.current.isInvalid).toBeTruthy(); + }); + it('should return isInvalid equals false with selectedField and isRequired is true', () => { + const { result } = renderHook(() => + useField({ indexPattern, onChange: onChangeMock, isRequired: true, selectedField }) + ); + + actTestRenderer(() => { + result.current.handleTouch(); + }); + expect(result.current.isInvalid).toBeFalsy(); + }); + it('should return isInvalid equals false when isRequired is false', () => { + const { result } = renderHook(() => useField({ indexPattern, onChange: onChangeMock })); + + actTestRenderer(() => { + result.current.handleTouch(); + }); + expect(result.current.isInvalid).toBeFalsy(); + }); + }); +}); diff --git a/packages/kbn-securitysolution-autocomplete/src/field/disabled_types_with_tooltip_text.ts b/packages/kbn-securitysolution-autocomplete/src/field/disabled_types_with_tooltip_text.ts new file mode 100644 index 0000000000000..eec4151644507 --- /dev/null +++ b/packages/kbn-securitysolution-autocomplete/src/field/disabled_types_with_tooltip_text.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 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. + */ + +interface DisabledTypesTextType { + [typeName: string]: string; +} +import * as i18n from '../translations'; + +export const disabledTypesWithTooltipText: DisabledTypesTextType = { + binary: i18n.BINARY_TYPE_NOT_SUPPORTED, +}; diff --git a/packages/kbn-securitysolution-autocomplete/src/field/index.test.tsx b/packages/kbn-securitysolution-autocomplete/src/field/index.test.tsx deleted file mode 100644 index 626c791315c3e..0000000000000 --- a/packages/kbn-securitysolution-autocomplete/src/field/index.test.tsx +++ /dev/null @@ -1,145 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import React from 'react'; -import { mount } from 'enzyme'; -import { EuiComboBox, EuiComboBoxOptionOption } from '@elastic/eui'; -import { FieldComponent } from '.'; -import { fields, getField } from '../fields/index.mock'; - -describe('field', () => { - test('it renders disabled if "isDisabled" is true', () => { - const wrapper = mount( - - ); - - expect( - wrapper.find(`[data-test-subj="fieldAutocompleteComboBox"] input`).prop('disabled') - ).toBeTruthy(); - }); - - test('it renders loading if "isLoading" is true', () => { - const wrapper = mount( - - ); - wrapper.find(`[data-test-subj="fieldAutocompleteComboBox"] button`).at(0).simulate('click'); - expect( - wrapper - .find(`EuiComboBoxOptionsList[data-test-subj="fieldAutocompleteComboBox-optionsList"]`) - .prop('isLoading') - ).toBeTruthy(); - }); - - test('it allows user to clear values if "isClearable" is true', () => { - const wrapper = mount( - - ); - - expect( - wrapper - .find(`[data-test-subj="comboBoxInput"]`) - .hasClass('euiComboBox__inputWrap-isClearable') - ).toBeTruthy(); - }); - - test('it correctly displays selected field', () => { - const wrapper = mount( - - ); - - expect( - wrapper.find(`[data-test-subj="fieldAutocompleteComboBox"] EuiComboBoxPill`).at(0).text() - ).toEqual('machine.os.raw'); - }); - - test('it invokes "onChange" when option selected', () => { - const mockOnChange = jest.fn(); - const wrapper = mount( - - ); - - ( - wrapper.find(EuiComboBox).props() as unknown as { - onChange: (a: EuiComboBoxOptionOption[]) => void; - } - ).onChange([{ label: 'machine.os' }]); - - expect(mockOnChange).toHaveBeenCalledWith([ - { - aggregatable: true, - count: 0, - esTypes: ['text'], - name: 'machine.os', - readFromDocValues: false, - scripted: false, - searchable: true, - type: 'string', - }, - ]); - }); -}); diff --git a/packages/kbn-securitysolution-autocomplete/src/field/index.tsx b/packages/kbn-securitysolution-autocomplete/src/field/index.tsx index a89e0a096b673..dad13434779e7 100644 --- a/packages/kbn-securitysolution-autocomplete/src/field/index.tsx +++ b/packages/kbn-securitysolution-autocomplete/src/field/index.tsx @@ -6,31 +6,15 @@ * Side Public License, v 1. */ -import React, { useCallback, useMemo, useState } from 'react'; -import { EuiComboBox, EuiComboBoxOptionOption } from '@elastic/eui'; -import { DataViewBase, DataViewFieldBase } from '@kbn/es-query'; +import React from 'react'; +import { EuiComboBox } from '@elastic/eui'; -import { - getGenericComboBoxProps, - GetGenericComboBoxPropsReturn, -} from '../get_generic_combo_box_props'; +import { FieldProps } from './types'; +import { useField } from './use_field'; const AS_PLAIN_TEXT = { asPlainText: true }; -interface OperatorProps { - fieldInputWidth?: number; - fieldTypeFilter?: string[]; - indexPattern: DataViewBase | undefined; - isClearable: boolean; - isDisabled: boolean; - isLoading: boolean; - isRequired?: boolean; - onChange: (a: DataViewFieldBase[]) => void; - placeholder: string; - selectedField: DataViewFieldBase | undefined; -} - -export const FieldComponent: React.FC = ({ +export const FieldComponent: React.FC = ({ fieldInputWidth, fieldTypeFilter = [], indexPattern, @@ -42,36 +26,23 @@ export const FieldComponent: React.FC = ({ placeholder, selectedField, }): JSX.Element => { - const [touched, setIsTouched] = useState(false); - - const { availableFields, selectedFields } = useMemo( - () => getComboBoxFields(indexPattern, selectedField, fieldTypeFilter), - [indexPattern, selectedField, fieldTypeFilter] - ); - - const { comboOptions, labels, selectedComboOptions } = useMemo( - () => getComboBoxProps({ availableFields, selectedFields }), - [availableFields, selectedFields] - ); - - const handleValuesChange = useCallback( - (newOptions: EuiComboBoxOptionOption[]): void => { - const newValues: DataViewFieldBase[] = newOptions.map( - ({ label }) => availableFields[labels.indexOf(label)] - ); - onChange(newValues); - }, - [availableFields, labels, onChange] - ); - - const handleTouch = useCallback((): void => { - setIsTouched(true); - }, [setIsTouched]); - - const fieldWidth = useMemo(() => { - return fieldInputWidth ? { width: `${fieldInputWidth}px` } : {}; - }, [fieldInputWidth]); - + const { + isInvalid, + comboOptions, + selectedComboOptions, + fieldWidth, + + renderFields, + handleTouch, + handleValuesChange, + } = useField({ + indexPattern, + fieldTypeFilter, + isRequired, + selectedField, + fieldInputWidth, + onChange, + }); return ( = ({ isLoading={isLoading} isDisabled={isDisabled} isClearable={isClearable} - isInvalid={isRequired ? touched && selectedField == null : false} + isInvalid={isInvalid} onFocus={handleTouch} singleSelection={AS_PLAIN_TEXT} data-test-subj="fieldAutocompleteComboBox" style={fieldWidth} fullWidth + renderOption={renderFields} /> ); }; FieldComponent.displayName = 'Field'; - -interface ComboBoxFields { - availableFields: DataViewFieldBase[]; - selectedFields: DataViewFieldBase[]; -} - -const getComboBoxFields = ( - indexPattern: DataViewBase | undefined, - selectedField: DataViewFieldBase | undefined, - fieldTypeFilter: string[] -): ComboBoxFields => { - const existingFields = getExistingFields(indexPattern); - const selectedFields = getSelectedFields(selectedField); - const availableFields = getAvailableFields(existingFields, selectedFields, fieldTypeFilter); - - return { availableFields, selectedFields }; -}; - -const getComboBoxProps = (fields: ComboBoxFields): GetGenericComboBoxPropsReturn => { - const { availableFields, selectedFields } = fields; - - return getGenericComboBoxProps({ - getLabel: (field) => field.name, - options: availableFields, - selectedOptions: selectedFields, - }); -}; - -const getExistingFields = (indexPattern: DataViewBase | undefined): DataViewFieldBase[] => { - return indexPattern != null ? indexPattern.fields : []; -}; - -const getSelectedFields = (selectedField: DataViewFieldBase | undefined): DataViewFieldBase[] => { - return selectedField ? [selectedField] : []; -}; - -const getAvailableFields = ( - existingFields: DataViewFieldBase[], - selectedFields: DataViewFieldBase[], - fieldTypeFilter: string[] -): DataViewFieldBase[] => { - const fieldsByName = new Map(); - - existingFields.forEach((f) => fieldsByName.set(f.name, f)); - selectedFields.forEach((f) => fieldsByName.set(f.name, f)); - - const uniqueFields = Array.from(fieldsByName.values()); - - if (fieldTypeFilter.length > 0) { - return uniqueFields.filter(({ type }) => fieldTypeFilter.includes(type)); - } - - return uniqueFields; -}; diff --git a/packages/kbn-securitysolution-autocomplete/src/field/types.ts b/packages/kbn-securitysolution-autocomplete/src/field/types.ts new file mode 100644 index 0000000000000..ee0b98e4b795c --- /dev/null +++ b/packages/kbn-securitysolution-autocomplete/src/field/types.ts @@ -0,0 +1,38 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 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 { DataViewBase, DataViewFieldBase } from '@kbn/es-query'; +import { GetGenericComboBoxPropsReturn } from '../get_generic_combo_box_props'; + +export interface FieldProps extends FieldBaseProps { + isClearable: boolean; + isDisabled: boolean; + isLoading: boolean; + placeholder: string; +} +export interface FieldBaseProps { + indexPattern: DataViewBase | undefined; + fieldTypeFilter?: string[]; + isRequired?: boolean; + selectedField?: DataViewFieldBase | undefined; + fieldInputWidth?: number; + onChange: (a: DataViewFieldBase[]) => void; +} + +export interface ComboBoxFields { + availableFields: DataViewField[]; + selectedFields: DataViewField[]; +} + +export interface GetFieldComboBoxPropsReturn extends GetGenericComboBoxPropsReturn { + disabledLabelTooltipTexts: { [label: string]: string }; +} + +export interface DataViewField extends DataViewFieldBase { + esTypes?: string[]; +} diff --git a/packages/kbn-securitysolution-autocomplete/src/field/use_field.tsx b/packages/kbn-securitysolution-autocomplete/src/field/use_field.tsx new file mode 100644 index 0000000000000..feb575575a423 --- /dev/null +++ b/packages/kbn-securitysolution-autocomplete/src/field/use_field.tsx @@ -0,0 +1,165 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ +import React from 'react'; +import { useCallback, useMemo, useState } from 'react'; +import { EuiComboBoxOptionOption, EuiToolTip } from '@elastic/eui'; +import { DataViewBase, DataViewFieldBase } from '@kbn/es-query'; + +import { getGenericComboBoxProps } from '../get_generic_combo_box_props'; +import { + ComboBoxFields, + DataViewField, + FieldBaseProps, + GetFieldComboBoxPropsReturn, +} from './types'; +import { disabledTypesWithTooltipText } from './disabled_types_with_tooltip_text'; + +const getExistingFields = (indexPattern: DataViewBase | undefined): DataViewFieldBase[] => { + return indexPattern != null ? indexPattern.fields : []; +}; + +const getSelectedFields = (selectedField: DataViewField | undefined): DataViewFieldBase[] => { + return selectedField ? [selectedField] : []; +}; + +const getAvailableFields = ( + existingFields: DataViewField[], + selectedFields: DataViewField[], + fieldTypeFilter: string[] | undefined +): DataViewField[] => { + const fieldsByName = new Map(); + + existingFields.forEach((f) => fieldsByName.set(f.name, f)); + selectedFields.forEach((f) => fieldsByName.set(f.name, f)); + + const uniqueFields = Array.from(fieldsByName.values()); + + if (fieldTypeFilter && fieldTypeFilter?.length > 0) { + return uniqueFields.filter(({ type }) => fieldTypeFilter.includes(type)); + } + + return uniqueFields; +}; + +const getComboBoxFields = ( + indexPattern: DataViewBase | undefined, + selectedField: DataViewField | undefined, + fieldTypeFilter: string[] | undefined +): ComboBoxFields => { + const existingFields = getExistingFields(indexPattern); + const selectedFields = getSelectedFields(selectedField); + const availableFields = getAvailableFields(existingFields, selectedFields, fieldTypeFilter); + + return { availableFields, selectedFields }; +}; + +const getDisabledLabelTooltipTexts = (fields: ComboBoxFields) => { + const disabledLabelTooltipTexts = fields.availableFields.reduce( + (acc: { [label: string]: string }, field: DataViewField) => { + const esTypeKey = field.esTypes?.find((type) => disabledTypesWithTooltipText[type]); + const tooltipText = + (esTypeKey && disabledTypesWithTooltipText[esTypeKey]) || + disabledTypesWithTooltipText[field.type]; + if (tooltipText) acc[field.name] = tooltipText; + return acc; + }, + {} + ); + return disabledLabelTooltipTexts; +}; +const getComboBoxProps = (fields: ComboBoxFields): GetFieldComboBoxPropsReturn => { + const { availableFields, selectedFields } = fields; + + const genericProps = getGenericComboBoxProps({ + getLabel: (field) => field.name, + options: availableFields, + selectedOptions: selectedFields, + }); + const disabledLabelTooltipTexts = getDisabledLabelTooltipTexts(fields); + return { + ...genericProps, + disabledLabelTooltipTexts, + }; +}; + +export const useField = ({ + indexPattern, + fieldTypeFilter, + isRequired, + selectedField, + fieldInputWidth, + onChange, +}: FieldBaseProps) => { + const [touched, setIsTouched] = useState(false); + + const { availableFields, selectedFields } = useMemo( + () => getComboBoxFields(indexPattern, selectedField, fieldTypeFilter), + [indexPattern, fieldTypeFilter, selectedField] + ); + + const { comboOptions, labels, selectedComboOptions, disabledLabelTooltipTexts } = useMemo( + () => getComboBoxProps({ availableFields, selectedFields }), + [availableFields, selectedFields] + ); + + const handleValuesChange = useCallback( + (newOptions: EuiComboBoxOptionOption[]): void => { + const newValues: DataViewFieldBase[] = newOptions.map( + ({ label }) => availableFields[labels.indexOf(label)] + ); + onChange(newValues); + }, + [availableFields, labels, onChange] + ); + + const handleTouch = useCallback((): void => { + setIsTouched(true); + }, [setIsTouched]); + + const fieldWidth = useMemo(() => { + return fieldInputWidth ? { width: `${fieldInputWidth}px` } : {}; + }, [fieldInputWidth]); + + const isInvalid = useMemo( + () => (isRequired ? touched && selectedField == null : false), + [isRequired, selectedField, touched] + ); + + const renderFields = ( + option: EuiComboBoxOptionOption, + searchValue: string, + contentClassName: string + ) => { + const { label } = option; + + const labelTooltipText = disabledLabelTooltipTexts[label]; + if (labelTooltipText) { + option.disabled = true; + return ( + + <>{label} + + ); + } + return label; + }; + return { + isInvalid, + comboOptions, + selectedComboOptions, + fieldWidth, + + renderFields, + handleTouch, + handleValuesChange, + }; +}; diff --git a/packages/kbn-securitysolution-autocomplete/src/field_value_lists/index.test.tsx b/packages/kbn-securitysolution-autocomplete/src/field_value_lists/index.test.tsx index 941eaf5322000..6cd92fe1a1b35 100644 --- a/packages/kbn-securitysolution-autocomplete/src/field_value_lists/index.test.tsx +++ b/packages/kbn-securitysolution-autocomplete/src/field_value_lists/index.test.tsx @@ -16,7 +16,7 @@ import { getField } from '../fields/index.mock'; import { AutocompleteFieldListsComponent } from '.'; import { getListResponseMock, - getFoundListSchemaMock, + getFoundListsBySizeSchemaMock, DATE_NOW, IMMUTABLE, VERSION, @@ -34,14 +34,15 @@ const mockKeywordList: ListSchema = { name: 'keyword list', type: 'keyword', }; -const mockResult = { ...getFoundListSchemaMock() }; -mockResult.data = [...mockResult.data, mockKeywordList]; +const mockResult = { ...getFoundListsBySizeSchemaMock() }; +mockResult.smallLists = [...mockResult.smallLists, mockKeywordList]; +mockResult.largeLists = []; jest.mock('@kbn/securitysolution-list-hooks', () => { const originalModule = jest.requireActual('@kbn/securitysolution-list-hooks'); return { ...originalModule, - useFindLists: () => ({ + useFindListsBySize: () => ({ error: undefined, loading: false, result: mockResult, @@ -116,7 +117,7 @@ describe('AutocompleteFieldListsComponent', () => { wrapper .find('EuiComboBox[data-test-subj="valuesAutocompleteComboBox listsComboxBox"]') .prop('options') - ).toEqual([{ label: 'some name' }]); + ).toEqual([{ label: 'some name', disabled: false }]); }); test('it correctly displays lists that match the selected "keyword" field esType', () => { @@ -139,7 +140,7 @@ describe('AutocompleteFieldListsComponent', () => { wrapper .find('EuiComboBox[data-test-subj="valuesAutocompleteComboBox listsComboxBox"]') .prop('options') - ).toEqual([{ label: 'keyword list' }]); + ).toEqual([{ label: 'keyword list', disabled: false }]); }); test('it correctly displays lists that match the selected "ip" field esType', () => { @@ -162,7 +163,7 @@ describe('AutocompleteFieldListsComponent', () => { wrapper .find('EuiComboBox[data-test-subj="valuesAutocompleteComboBox listsComboxBox"]') .prop('options') - ).toEqual([{ label: 'some name' }]); + ).toEqual([{ label: 'some name', disabled: false }]); }); test('it correctly displays selected list', async () => { @@ -206,7 +207,7 @@ describe('AutocompleteFieldListsComponent', () => { wrapper.find(EuiComboBox).props() as unknown as { onChange: (a: EuiComboBoxOptionOption[]) => void; } - ).onChange([{ label: 'some name' }]); + ).onChange([{ label: 'some name', disabled: false }]); await waitFor(() => { expect(mockOnChange).toHaveBeenCalledWith({ diff --git a/packages/kbn-securitysolution-autocomplete/src/field_value_lists/index.tsx b/packages/kbn-securitysolution-autocomplete/src/field_value_lists/index.tsx index 2d87c3523a839..79f707feaa70d 100644 --- a/packages/kbn-securitysolution-autocomplete/src/field_value_lists/index.tsx +++ b/packages/kbn-securitysolution-autocomplete/src/field_value_lists/index.tsx @@ -7,9 +7,9 @@ */ import React, { useCallback, useEffect, useMemo, useState } from 'react'; -import { EuiComboBox, EuiComboBoxOptionOption, EuiFormRow } from '@elastic/eui'; +import { EuiComboBox, EuiComboBoxOptionOption, EuiFormRow, EuiLink, EuiText } from '@elastic/eui'; import type { ListSchema } from '@kbn/securitysolution-io-ts-list-types'; -import { useFindLists } from '@kbn/securitysolution-list-hooks'; +import { useFindListsBySize } from '@kbn/securitysolution-list-hooks'; import { DataViewFieldBase } from '@kbn/es-query'; import { filterFieldToList } from '../filter_field_to_list'; @@ -33,6 +33,12 @@ interface AutocompleteFieldListsProps { rowLabel?: string; selectedField: DataViewFieldBase | undefined; selectedValue: string | undefined; + allowLargeValueLists?: boolean; +} + +export interface AutocompleteListsData { + smallLists: ListSchema[]; + largeLists: ListSchema[]; } export const AutocompleteFieldListsComponent: React.FC = ({ @@ -45,37 +51,44 @@ export const AutocompleteFieldListsComponent: React.FC { const [error, setError] = useState(undefined); - const [lists, setLists] = useState([]); - const { loading, result, start } = useFindLists(); + const [listData, setListData] = useState({ + smallLists: [], + largeLists: [], + }); + const { loading, result, start } = useFindListsBySize(); const getLabel = useCallback(({ name }) => name, []); const optionsMemo = useMemo( - () => filterFieldToList(lists, selectedField), - [lists, selectedField] + () => filterFieldToList(listData, selectedField), + [listData, selectedField] ); const selectedOptionsMemo = useMemo(() => { if (selectedValue != null) { - const list = lists.filter(({ id }) => id === selectedValue); + const combinedLists = [...listData.smallLists, ...listData.largeLists]; + const list = combinedLists.filter(({ id }) => id === selectedValue); return list ?? []; } else { return []; } - }, [selectedValue, lists]); + }, [selectedValue, listData]); const { comboOptions, labels, selectedComboOptions } = useMemo( () => getGenericComboBoxProps({ getLabel, - options: optionsMemo, + options: [...optionsMemo.smallLists, ...optionsMemo.largeLists], selectedOptions: selectedOptionsMemo, + disabledOptions: allowLargeValueLists ? undefined : optionsMemo.largeLists, // Disable large lists if the rule type doesn't allow it }), - [optionsMemo, selectedOptionsMemo, getLabel] + [optionsMemo, selectedOptionsMemo, getLabel, allowLargeValueLists] ); const handleValuesChange = useCallback( (newOptions: EuiComboBoxOptionOption[]) => { - const [newValue] = newOptions.map(({ label }) => optionsMemo[labels.indexOf(label)]); + const combinedLists = [...optionsMemo.smallLists, ...optionsMemo.largeLists]; + const [newValue] = newOptions.map(({ label }) => combinedLists[labels.indexOf(label)]); onChange(newValue ?? ''); }, [labels, optionsMemo, onChange] @@ -87,7 +100,7 @@ export const AutocompleteFieldListsComponent: React.FC { if (result != null) { - setLists(result.data); + setListData(result); } }, [result]); @@ -103,8 +116,27 @@ export const AutocompleteFieldListsComponent: React.FC isLoading || loading, [isLoading, loading]); + const helpText = useMemo(() => { + return ( + !allowLargeValueLists && ( + + {i18n.LISTS_TOOLTIP_INFO}{' '} + + {i18n.SEE_DOCUMENTATION} + + + ) + ); + }, [allowLargeValueLists]); + return ( - + { - test('it returns empty array if given a undefined for field', () => { - const filter = filterFieldToList([], undefined); - expect(filter).toEqual([]); + test('it returns empty list data object if given a undefined for field', () => { + const filter = filterFieldToList(emptyListData, undefined); + expect(filter).toEqual(emptyListData); }); - test('it returns empty array if filed does not contain esTypes', () => { + test('it returns empty list data object if filed does not contain esTypes', () => { const field: DataViewFieldBase = { name: 'some-name', type: 'some-type', }; - const filter = filterFieldToList([], field); - expect(filter).toEqual([]); + const filter = filterFieldToList(emptyListData, field); + expect(filter).toEqual(emptyListData); }); - test('it returns single filtered list of ip_range -> ip', () => { + test('it returns filtered lists of ip_range -> ip', () => { const field: DataViewFieldBase & { esTypes: string[] } = { esTypes: ['ip'], name: 'some-name', type: 'ip', }; - const listItem: ListSchema = { ...getListResponseMock(), type: 'ip_range' }; - const filter = filterFieldToList([listItem], field); - const expected: ListSchema[] = [listItem]; + const listData: AutocompleteListsData = { + smallLists: [{ ...getListResponseMock(), type: 'ip_range' }], + largeLists: [], + }; + const filter = filterFieldToList(listData, field); + const expected = listData; expect(filter).toEqual(expected); }); - test('it returns single filtered list of ip -> ip', () => { + test('it returns filtered lists of ip -> ip', () => { const field: DataViewFieldBase & { esTypes: string[] } = { esTypes: ['ip'], name: 'some-name', type: 'ip', }; - const listItem: ListSchema = { ...getListResponseMock(), type: 'ip' }; - const filter = filterFieldToList([listItem], field); - const expected: ListSchema[] = [listItem]; + const listData: AutocompleteListsData = { + smallLists: [{ ...getListResponseMock(), type: 'ip' }], + largeLists: [], + }; + const filter = filterFieldToList(listData, field); + const expected = listData; expect(filter).toEqual(expected); }); - test('it returns single filtered list of keyword -> keyword', () => { + test('it returns filtered lists of keyword -> keyword', () => { const field: DataViewFieldBase & { esTypes: string[] } = { esTypes: ['keyword'], name: 'some-name', type: 'keyword', }; - const listItem: ListSchema = { ...getListResponseMock(), type: 'keyword' }; - const filter = filterFieldToList([listItem], field); - const expected: ListSchema[] = [listItem]; + const listData: AutocompleteListsData = { + smallLists: [{ ...getListResponseMock(), type: 'keyword' }], + largeLists: [], + }; + const filter = filterFieldToList(listData, field); + const expected = listData; expect(filter).toEqual(expected); }); - test('it returns single filtered list of text -> text', () => { + test('it returns filtered lists of text -> text', () => { const field: DataViewFieldBase & { esTypes: string[] } = { esTypes: ['text'], name: 'some-name', type: 'text', }; - const listItem: ListSchema = { ...getListResponseMock(), type: 'text' }; - const filter = filterFieldToList([listItem], field); - const expected: ListSchema[] = [listItem]; + const listData: AutocompleteListsData = { + smallLists: [{ ...getListResponseMock(), type: 'text' }], + largeLists: [], + }; + const filter = filterFieldToList(listData, field); + const expected = listData; expect(filter).toEqual(expected); }); - test('it returns 2 filtered lists of ip_range -> ip', () => { + test('it returns small and large filtered lists of ip_range -> ip', () => { const field: DataViewFieldBase & { esTypes: string[] } = { esTypes: ['ip'], name: 'some-name', type: 'ip', }; - const listItem1: ListSchema = { ...getListResponseMock(), type: 'ip_range' }; - const listItem2: ListSchema = { ...getListResponseMock(), type: 'ip_range' }; - const filter = filterFieldToList([listItem1, listItem2], field); - const expected: ListSchema[] = [listItem1, listItem2]; + const listData: AutocompleteListsData = { + smallLists: [{ ...getListResponseMock(), type: 'ip_range' }], + largeLists: [{ ...getListResponseMock(), type: 'ip_range' }], + }; + const filter = filterFieldToList(listData, field); + const expected = listData; expect(filter).toEqual(expected); }); @@ -94,10 +110,15 @@ describe('#filterFieldToList', () => { name: 'some-name', type: 'ip', }; - const listItem1: ListSchema = { ...getListResponseMock(), type: 'ip_range' }; - const listItem2: ListSchema = { ...getListResponseMock(), type: 'text' }; - const filter = filterFieldToList([listItem1, listItem2], field); - const expected: ListSchema[] = [listItem1]; + const listData: AutocompleteListsData = { + smallLists: [{ ...getListResponseMock(), type: 'ip_range' }], + largeLists: [{ ...getListResponseMock(), type: 'text' }], + }; + const filter = filterFieldToList(listData, field); + const expected: AutocompleteListsData = { + smallLists: [{ ...getListResponseMock(), type: 'ip_range' }], + largeLists: [], + }; expect(filter).toEqual(expected); }); }); diff --git a/packages/kbn-securitysolution-autocomplete/src/filter_field_to_list/index.ts b/packages/kbn-securitysolution-autocomplete/src/filter_field_to_list/index.ts index 32cd55522b3fd..344e97878ca4e 100644 --- a/packages/kbn-securitysolution-autocomplete/src/filter_field_to_list/index.ts +++ b/packages/kbn-securitysolution-autocomplete/src/filter_field_to_list/index.ts @@ -6,9 +6,9 @@ * Side Public License, v 1. */ -import { ListSchema } from '@kbn/securitysolution-io-ts-list-types'; import { DataViewFieldBase } from '@kbn/es-query'; import { typeMatch } from '../type_match'; +import { AutocompleteListsData } from '../field_value_lists'; /** * Given an array of lists and optionally a field this will return all @@ -21,13 +21,20 @@ import { typeMatch } from '../type_match'; * @param field The field to check against the list to see if they are compatible */ export const filterFieldToList = ( - lists: ListSchema[], + lists: AutocompleteListsData, field?: DataViewFieldBase & { esTypes?: string[] } -): ListSchema[] => { +): AutocompleteListsData => { if (field != null) { const { esTypes = [] } = field; - return lists.filter(({ type }) => esTypes.some((esType: string) => typeMatch(type, esType))); + return { + smallLists: lists.smallLists.filter(({ type }) => + esTypes.some((esType: string) => typeMatch(type, esType)) + ), + largeLists: lists.largeLists.filter(({ type }) => + esTypes.some((esType: string) => typeMatch(type, esType)) + ), + }; } else { - return []; + return { smallLists: [], largeLists: [] }; } }; diff --git a/packages/kbn-securitysolution-autocomplete/src/get_generic_combo_box_props/index.test.tsx b/packages/kbn-securitysolution-autocomplete/src/get_generic_combo_box_props/index.test.tsx index 63a94be1271a7..c53eb82018437 100644 --- a/packages/kbn-securitysolution-autocomplete/src/get_generic_combo_box_props/index.test.tsx +++ b/packages/kbn-securitysolution-autocomplete/src/get_generic_combo_box_props/index.test.tsx @@ -67,7 +67,7 @@ describe('get_generic_combo_box_props', () => { }); }); - test('it return "selectedOptions" items that do appear in "options"', () => { + test('it returns "selectedOptions" items that do appear in "options"', () => { const result = getGenericComboBoxProps({ options: ['option1', 'option2', 'option3'], selectedOptions: ['option2'], @@ -94,4 +94,32 @@ describe('get_generic_combo_box_props', () => { ], }); }); + + test('it returns "disabledOptions" items that do appear in "options" as disabled', () => { + const result = getGenericComboBoxProps({ + options: ['option1', 'option2', 'option3'], + selectedOptions: [], + disabledOptions: ['option2'], + getLabel: (t: string) => t, + }); + + expect(result).toEqual({ + comboOptions: [ + { + label: 'option1', + disabled: false, + }, + { + label: 'option2', + disabled: true, + }, + { + label: 'option3', + disabled: false, + }, + ], + labels: ['option1', 'option2', 'option3'], + selectedComboOptions: [], + }); + }); }); diff --git a/packages/kbn-securitysolution-autocomplete/src/get_generic_combo_box_props/index.ts b/packages/kbn-securitysolution-autocomplete/src/get_generic_combo_box_props/index.ts index 0fba3c39344b8..c25311f42b4ce 100644 --- a/packages/kbn-securitysolution-autocomplete/src/get_generic_combo_box_props/index.ts +++ b/packages/kbn-securitysolution-autocomplete/src/get_generic_combo_box_props/index.ts @@ -24,13 +24,19 @@ export const getGenericComboBoxProps = ({ getLabel, options, selectedOptions, + disabledOptions, }: { getLabel: (value: T) => string; options: T[]; selectedOptions: T[]; + disabledOptions?: T[]; }): GetGenericComboBoxPropsReturn => { const newLabels = options.map(getLabel); - const newComboOptions: EuiComboBoxOptionOption[] = newLabels.map((label) => ({ label })); + const disabledLabels = disabledOptions?.map(getLabel); + const newComboOptions: EuiComboBoxOptionOption[] = newLabels.map((label) => ({ + label, + disabled: disabledLabels && disabledLabels.length !== 0 && disabledLabels.includes(label), + })); const newSelectedComboOptions = selectedOptions .map(getLabel) .filter((option) => { diff --git a/packages/kbn-securitysolution-autocomplete/src/list_schema/index.mock.ts b/packages/kbn-securitysolution-autocomplete/src/list_schema/index.mock.ts index fb629ad2f946e..9dca48e2d8b38 100644 --- a/packages/kbn-securitysolution-autocomplete/src/list_schema/index.mock.ts +++ b/packages/kbn-securitysolution-autocomplete/src/list_schema/index.mock.ts @@ -6,7 +6,11 @@ * Side Public License, v 1. */ -import { FoundListSchema, ListSchema } from '@kbn/securitysolution-io-ts-list-types'; +import { + FoundListSchema, + ListSchema, + FoundListsBySizeSchema, +} from '@kbn/securitysolution-io-ts-list-types'; // TODO: Once this mock is available within packages, use it instead, https://github.com/elastic/kibana/issues/100715 // import { getFoundListSchemaMock } from '../../../../../lists/common/schemas/response/found_list_schema.mock'; @@ -18,6 +22,11 @@ export const getFoundListSchemaMock = (): FoundListSchema => ({ total: 1, }); +export const getFoundListsBySizeSchemaMock = (): FoundListsBySizeSchema => ({ + smallLists: [getListResponseMock()], + largeLists: [getListResponseMock()], +}); + // TODO: Once these mocks are available from packages use it instead, https://github.com/elastic/kibana/issues/100715 export const DATE_NOW = '2020-04-20T15:25:31.830Z'; export const USER = 'some user'; diff --git a/packages/kbn-securitysolution-autocomplete/src/translations/index.ts b/packages/kbn-securitysolution-autocomplete/src/translations/index.ts index 6c6bf715cf083..df54ada4fb205 100644 --- a/packages/kbn-securitysolution-autocomplete/src/translations/index.ts +++ b/packages/kbn-securitysolution-autocomplete/src/translations/index.ts @@ -28,10 +28,21 @@ export const DATE_ERR = i18n.translate('autocomplete.invalidDateError', { defaultMessage: 'Not a valid date', }); +export const BINARY_TYPE_NOT_SUPPORTED = i18n.translate('autocomplete.invalidBinaryType', { + defaultMessage: 'Binary fields are currently unsupported', +}); export const FIELD_SPACE_WARNING = i18n.translate('autocomplete.fieldSpaceWarning', { defaultMessage: "Warning: Spaces at the start or end of this value aren't being displayed.", }); +export const LISTS_TOOLTIP_INFO = i18n.translate('autocomplete.listsTooltipWarning', { + defaultMessage: "Lists that aren't able to be processed by this rule type will be disabled.", +}); + +export const SEE_DOCUMENTATION = i18n.translate('autocomplete.seeDocumentation', { + defaultMessage: 'See Documentation', +}); + // eslint-disable-next-line import/no-default-export export default { LOADING, @@ -40,4 +51,5 @@ export default { NUMBER_ERR, DATE_ERR, FIELD_SPACE_WARNING, + BINARY_TYPE_NOT_SUPPORTED, }; diff --git a/packages/kbn-securitysolution-io-ts-list-types/BUILD.bazel b/packages/kbn-securitysolution-io-ts-list-types/BUILD.bazel index 54f95e00d1bd2..7a4388b65053e 100644 --- a/packages/kbn-securitysolution-io-ts-list-types/BUILD.bazel +++ b/packages/kbn-securitysolution-io-ts-list-types/BUILD.bazel @@ -48,6 +48,7 @@ TYPES_DEPS = [ "//packages/kbn-securitysolution-io-ts-types:npm_module_types", "//packages/kbn-securitysolution-io-ts-utils:npm_module_types", "//packages/kbn-securitysolution-list-constants:npm_module_types", + "//packages/kbn-es-query:npm_module_types", "@npm//fp-ts", "@npm//io-ts", "@npm//tslib", diff --git a/packages/kbn-securitysolution-io-ts-list-types/src/common/index.ts b/packages/kbn-securitysolution-io-ts-list-types/src/common/index.ts index f7e533aa7d4cd..7f92649fd07d8 100644 --- a/packages/kbn-securitysolution-io-ts-list-types/src/common/index.ts +++ b/packages/kbn-securitysolution-io-ts-list-types/src/common/index.ts @@ -41,6 +41,7 @@ export * from './lists_default_array'; export * from './max_size'; export * from './meta'; export * from './name'; +export * from './namespace_type'; export * from './non_empty_entries_array'; export * from './non_empty_nested_entries_array'; export * from './os_type'; diff --git a/packages/kbn-securitysolution-io-ts-list-types/src/request/get_exception_filter_schema/index.ts b/packages/kbn-securitysolution-io-ts-list-types/src/request/get_exception_filter_schema/index.ts new file mode 100644 index 0000000000000..d7ef12efdcc11 --- /dev/null +++ b/packages/kbn-securitysolution-io-ts-list-types/src/request/get_exception_filter_schema/index.ts @@ -0,0 +1,39 @@ +/* + * 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 * as t from 'io-ts'; +import { namespaceType } from '../../common/default_namespace'; +import { exceptionListItemSchema } from '../../response'; +import { createExceptionListItemSchema } from '../create_exception_list_item_schema'; + +const exceptionListId = t.type({ + exception_list_id: t.string, + namespace_type: namespaceType, +}); + +export const exceptionListIds = t.type({ + exception_list_ids: t.array(exceptionListId), + type: t.literal('exception_list_ids'), +}); + +export const exceptions = t.type({ + exceptions: t.array(t.union([exceptionListItemSchema, createExceptionListItemSchema])), + type: t.literal('exception_items'), +}); + +const optionalExceptionParams = t.exact( + t.partial({ alias: t.string, chunk_size: t.number, exclude_exceptions: t.boolean }) +); + +export const getExceptionFilterSchema = t.intersection([ + t.union([exceptions, exceptionListIds]), + optionalExceptionParams, +]); + +export type GetExceptionFilterSchema = t.TypeOf; +export type ExceptionListId = t.TypeOf; diff --git a/packages/kbn-securitysolution-io-ts-list-types/src/request/index.ts b/packages/kbn-securitysolution-io-ts-list-types/src/request/index.ts index bb604d3e7a800..07e8551845ec5 100644 --- a/packages/kbn-securitysolution-io-ts-list-types/src/request/index.ts +++ b/packages/kbn-securitysolution-io-ts-list-types/src/request/index.ts @@ -23,6 +23,7 @@ export * from './find_exception_list_schema'; export * from './find_exception_list_item_schema'; export * from './find_list_item_schema'; export * from './find_list_schema'; +export * from './get_exception_filter_schema'; export * from './import_list_item_query_schema'; export * from './import_exception_list_schema'; export * from './import_exception_item_schema'; diff --git a/packages/kbn-securitysolution-io-ts-list-types/src/response/found_all_list_items_schema/index.mock.ts b/packages/kbn-securitysolution-io-ts-list-types/src/response/found_all_list_items_schema/index.mock.ts new file mode 100644 index 0000000000000..61a8436bca26f --- /dev/null +++ b/packages/kbn-securitysolution-io-ts-list-types/src/response/found_all_list_items_schema/index.mock.ts @@ -0,0 +1,15 @@ +/* + * 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 { FoundAllListItemsSchema } from '.'; +import { getListItemResponseMock } from '../list_item_schema/index.mock'; + +export const getFoundAllListItemsSchemaMock = (): FoundAllListItemsSchema => ({ + data: [getListItemResponseMock()], + total: 1, +}); diff --git a/packages/kbn-securitysolution-io-ts-list-types/src/response/found_all_list_items_schema/index.ts b/packages/kbn-securitysolution-io-ts-list-types/src/response/found_all_list_items_schema/index.ts new file mode 100644 index 0000000000000..49ba985b8ffdb --- /dev/null +++ b/packages/kbn-securitysolution-io-ts-list-types/src/response/found_all_list_items_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 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 * as t from 'io-ts'; + +import { listItemSchema } from '../list_item_schema'; +import { total } from '../../common/total'; + +export const foundAllListItemsSchema = t.exact( + t.type({ + data: t.array(listItemSchema), + total, + }) +); + +export type FoundAllListItemsSchema = t.TypeOf; diff --git a/packages/kbn-securitysolution-io-ts-list-types/src/response/found_lists_by_size_schema/index.mock.ts b/packages/kbn-securitysolution-io-ts-list-types/src/response/found_lists_by_size_schema/index.mock.ts new file mode 100644 index 0000000000000..0ce73783fb088 --- /dev/null +++ b/packages/kbn-securitysolution-io-ts-list-types/src/response/found_lists_by_size_schema/index.mock.ts @@ -0,0 +1,15 @@ +/* + * 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 { FoundListsBySizeSchema } from '.'; +import { getListResponseMock } from '../list_schema/index.mock'; + +export const getFoundListsBySizeSchemaMock = (): FoundListsBySizeSchema => ({ + smallLists: [getListResponseMock()], + largeLists: [getListResponseMock()], +}); diff --git a/packages/kbn-securitysolution-io-ts-list-types/src/response/found_lists_by_size_schema/index.ts b/packages/kbn-securitysolution-io-ts-list-types/src/response/found_lists_by_size_schema/index.ts new file mode 100644 index 0000000000000..a9769efc5ead2 --- /dev/null +++ b/packages/kbn-securitysolution-io-ts-list-types/src/response/found_lists_by_size_schema/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 * as t from 'io-ts'; + +import { listSchema } from '../list_schema'; + +export const foundListsBySizeSchema = t.exact( + t.type({ + largeLists: t.array(listSchema), + smallLists: t.array(listSchema), + }) +); + +export type FoundListsBySizeSchema = t.TypeOf; diff --git a/packages/kbn-securitysolution-io-ts-list-types/src/response/index.ts b/packages/kbn-securitysolution-io-ts-list-types/src/response/index.ts index c37b092eb3477..363dc0039b84a 100644 --- a/packages/kbn-securitysolution-io-ts-list-types/src/response/index.ts +++ b/packages/kbn-securitysolution-io-ts-list-types/src/response/index.ts @@ -12,6 +12,8 @@ export * from './exception_list_schema'; export * from './exception_list_item_schema'; export * from './found_exception_list_item_schema'; export * from './found_exception_list_schema'; +export * from './found_all_list_items_schema'; +export * from './found_lists_by_size_schema'; export * from './found_list_item_schema'; export * from './found_list_schema'; export * from './import_exceptions_schema'; diff --git a/packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts b/packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts index b8f03629135a2..14118d9eb1d45 100644 --- a/packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts +++ b/packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts @@ -6,6 +6,7 @@ * Side Public License, v 1. */ +import type { Filter } from '@kbn/es-query'; import { NamespaceType } from '../common/default_namespace'; import { ExceptionListType } from '../common/exception_list'; import { Page } from '../common/page'; @@ -13,6 +14,7 @@ import { PerPage } from '../common/per_page'; import { TotalOrUndefined } from '../common/total'; import { CreateExceptionListItemSchema } from '../request/create_exception_list_item_schema'; import { CreateExceptionListSchema } from '../request/create_exception_list_schema'; +import { ExceptionListId } from '../request/get_exception_filter_schema'; import { UpdateExceptionListItemSchema } from '../request/update_exception_list_item_schema'; import { UpdateExceptionListSchema } from '../request/update_exception_list_schema'; import { ExceptionListItemSchema } from '../response/exception_list_item_schema'; @@ -107,6 +109,19 @@ export interface ApiCallFindListsItemsMemoProps { onSuccess: (arg: UseExceptionListItemsSuccess) => void; } +export interface ApiCallGetExceptionFilterFromIdsMemoProps extends GetExceptionFilterOptionalProps { + exceptionListIds: ExceptionListId[]; + onError: (arg: string[]) => void; + onSuccess: (arg: Filter) => void; +} + +export interface ApiCallGetExceptionFilterFromExceptionsMemoProps + extends GetExceptionFilterOptionalProps { + exceptions: Array; + onError: (arg: string[]) => void; + onSuccess: (arg: Filter) => void; +} + export interface ExportExceptionListProps { http: HttpStart; id: string; @@ -184,3 +199,25 @@ export interface PersistHookProps { export interface ExceptionList extends ExceptionListSchema { totalItems: number; } + +export interface GetExceptionFilterOptionalProps { + signal?: AbortSignal; + chunkSize?: number; + alias?: string; + excludeExceptions?: boolean; +} + +export interface GetExceptionFilterFromExceptionListIdsProps + extends GetExceptionFilterOptionalProps { + http: HttpStart; + exceptionListIds: ExceptionListId[]; +} + +export interface GetExceptionFilterFromExceptionsProps extends GetExceptionFilterOptionalProps { + http: HttpStart; + exceptions: Array; +} + +export interface ExceptionFilterResponse { + filter: Filter; +} diff --git a/packages/kbn-securitysolution-io-ts-types/index.ts b/packages/kbn-securitysolution-io-ts-types/index.ts index 998e25a141583..1eb62ebf494a3 100644 --- a/packages/kbn-securitysolution-io-ts-types/index.ts +++ b/packages/kbn-securitysolution-io-ts-types/index.ts @@ -30,5 +30,6 @@ export * from './src/operator'; export * from './src/positive_integer_greater_than_zero'; export * from './src/positive_integer'; export * from './src/string_to_positive_number'; +export * from './src/time_duration'; export * from './src/uuid'; export * from './src/version'; diff --git a/packages/kbn-securitysolution-io-ts-types/src/time_duration/index.test.ts b/packages/kbn-securitysolution-io-ts-types/src/time_duration/index.test.ts new file mode 100644 index 0000000000000..8af5f04bf16e6 --- /dev/null +++ b/packages/kbn-securitysolution-io-ts-types/src/time_duration/index.test.ts @@ -0,0 +1,105 @@ +/* + * 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 { pipe } from 'fp-ts/lib/pipeable'; +import { left } from 'fp-ts/lib/Either'; +import { TimeDuration } from '.'; +import { foldLeftRight, getPaths } from '@kbn/securitysolution-io-ts-utils'; + +describe('time_unit', () => { + test('it should validate a correctly formed TimeDuration with time unit of seconds', () => { + const payload = '1s'; + const decoded = TimeDuration.decode(payload); + const message = pipe(decoded, foldLeftRight); + + expect(getPaths(left(message.errors))).toEqual([]); + expect(message.schema).toEqual(payload); + }); + + test('it should validate a correctly formed TimeDuration with time unit of minutes', () => { + const payload = '100m'; + const decoded = TimeDuration.decode(payload); + const message = pipe(decoded, foldLeftRight); + + expect(getPaths(left(message.errors))).toEqual([]); + expect(message.schema).toEqual(payload); + }); + + test('it should validate a correctly formed TimeDuration with time unit of hours', () => { + const payload = '10000000h'; + const decoded = TimeDuration.decode(payload); + const message = pipe(decoded, foldLeftRight); + + expect(getPaths(left(message.errors))).toEqual([]); + expect(message.schema).toEqual(payload); + }); + + test('it should NOT validate a negative TimeDuration', () => { + const payload = '-10s'; + const decoded = TimeDuration.decode(payload); + const message = pipe(decoded, foldLeftRight); + + expect(getPaths(left(message.errors))).toEqual([ + 'Invalid value "-10s" supplied to "TimeDuration"', + ]); + expect(message.schema).toEqual({}); + }); + + test('it should NOT validate a TimeDuration with some other time unit', () => { + const payload = '10000000w'; + const decoded = TimeDuration.decode(payload); + const message = pipe(decoded, foldLeftRight); + + expect(getPaths(left(message.errors))).toEqual([ + 'Invalid value "10000000w" supplied to "TimeDuration"', + ]); + expect(message.schema).toEqual({}); + }); + + test('it should NOT validate a TimeDuration with a time interval with incorrect format', () => { + const payload = '100ff0000w'; + const decoded = TimeDuration.decode(payload); + const message = pipe(decoded, foldLeftRight); + + expect(getPaths(left(message.errors))).toEqual([ + 'Invalid value "100ff0000w" supplied to "TimeDuration"', + ]); + expect(message.schema).toEqual({}); + }); + + test('it should NOT validate an empty string', () => { + const payload = ''; + const decoded = TimeDuration.decode(payload); + const message = pipe(decoded, foldLeftRight); + + expect(getPaths(left(message.errors))).toEqual(['Invalid value "" supplied to "TimeDuration"']); + expect(message.schema).toEqual({}); + }); + + test('it should NOT validate an number', () => { + const payload = 100; + const decoded = TimeDuration.decode(payload); + const message = pipe(decoded, foldLeftRight); + + expect(getPaths(left(message.errors))).toEqual([ + 'Invalid value "100" supplied to "TimeDuration"', + ]); + expect(message.schema).toEqual({}); + }); + + test('it should NOT validate an TimeDuration with a valid time unit but unsafe integer', () => { + const payload = `${Math.pow(2, 53)}h`; + const decoded = TimeDuration.decode(payload); + const message = pipe(decoded, foldLeftRight); + + expect(getPaths(left(message.errors))).toEqual([ + `Invalid value "${Math.pow(2, 53)}h" supplied to "TimeDuration"`, + ]); + expect(message.schema).toEqual({}); + }); +}); diff --git a/packages/kbn-securitysolution-io-ts-types/src/time_duration/index.ts b/packages/kbn-securitysolution-io-ts-types/src/time_duration/index.ts new file mode 100644 index 0000000000000..c486e1d171689 --- /dev/null +++ b/packages/kbn-securitysolution-io-ts-types/src/time_duration/index.ts @@ -0,0 +1,45 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import * as t from 'io-ts'; +import { Either } from 'fp-ts/lib/Either'; + +/** + * Types the TimeDuration as: + * - A string that is not empty, and composed of a positive integer greater than 0 followed by a unit of time + * - in the format {safe_integer}{timeUnit}, e.g. "30s", "1m", "2h" + */ +export const TimeDuration = new t.Type( + 'TimeDuration', + t.string.is, + (input, context): Either => { + if (typeof input === 'string' && input.trim() !== '') { + try { + const inputLength = input.length; + const time = parseInt(input.trim().substring(0, inputLength - 1), 10); + const unit = input.trim().at(-1); + if ( + time >= 1 && + Number.isSafeInteger(time) && + (unit === 's' || unit === 'm' || unit === 'h') + ) { + return t.success(input); + } else { + return t.failure(input, context); + } + } catch (error) { + return t.failure(input, context); + } + } else { + return t.failure(input, context); + } + }, + t.identity +); + +export type TimeDurationC = typeof TimeDuration; diff --git a/packages/kbn-securitysolution-list-api/src/api/index.ts b/packages/kbn-securitysolution-list-api/src/api/index.ts index 871987ff7d367..8d23db33601a4 100644 --- a/packages/kbn-securitysolution-list-api/src/api/index.ts +++ b/packages/kbn-securitysolution-list-api/src/api/index.ts @@ -29,10 +29,14 @@ import { ExportExceptionListProps, UpdateExceptionListItemProps, UpdateExceptionListProps, + GetExceptionFilterFromExceptionListIdsProps, + GetExceptionFilterFromExceptionsProps, + ExceptionFilterResponse, } from '@kbn/securitysolution-io-ts-list-types'; import { ENDPOINT_LIST_URL, + EXCEPTION_FILTER, EXCEPTION_LIST_ITEM_URL, EXCEPTION_LIST_URL, } from '@kbn/securitysolution-list-constants'; @@ -547,3 +551,59 @@ export const exportExceptionList = async ({ query: { id, list_id: listId, namespace_type: namespaceType }, signal, }); + +/** + * Create a Filter query from an exception list id + * + * @param exceptionListId The id of the exception list from which create a Filter query + * @param signal AbortSignal for cancelling request + * + * @throws An error if response is not OK + */ +export const getExceptionFilterFromExceptionListIds = async ({ + alias, + chunkSize, + exceptionListIds, + excludeExceptions, + http, + signal, +}: GetExceptionFilterFromExceptionListIdsProps): Promise => + http.fetch(EXCEPTION_FILTER, { + method: 'POST', + body: JSON.stringify({ + exception_list_ids: exceptionListIds, + type: 'exception_list_ids', + alias, + exclude_exceptions: excludeExceptions, + chunk_size: chunkSize, + }), + signal, + }); + +/** + * Create a Filter query from a list of exceptions + * + * @param exceptions Exception items to be made into a `Filter` query + * @param signal AbortSignal for cancelling request + * + * @throws An error if response is not OK + */ +export const getExceptionFilterFromExceptions = async ({ + exceptions, + alias, + excludeExceptions, + http, + chunkSize, + signal, +}: GetExceptionFilterFromExceptionsProps): Promise => + http.fetch(EXCEPTION_FILTER, { + method: 'POST', + body: JSON.stringify({ + exceptions, + type: 'exception_items', + alias, + exclude_exceptions: excludeExceptions, + chunk_size: chunkSize, + }), + signal, + }); diff --git a/packages/kbn-securitysolution-list-api/src/list_api/index.ts b/packages/kbn-securitysolution-list-api/src/list_api/index.ts index 7e56191a7bb80..a7ca546ea2eef 100644 --- a/packages/kbn-securitysolution-list-api/src/list_api/index.ts +++ b/packages/kbn-securitysolution-list-api/src/list_api/index.ts @@ -29,12 +29,15 @@ import { importListItemSchema, listItemIndexExistSchema, listSchema, + foundListsBySizeSchema, + FoundListsBySizeSchema, } from '@kbn/securitysolution-io-ts-list-types'; import { LIST_INDEX, LIST_ITEM_URL, LIST_PRIVILEGES_URL, LIST_URL, + FIND_LISTS_BY_SIZE, } from '@kbn/securitysolution-list-constants'; import { toError, toPromise } from '../fp_utils'; @@ -104,6 +107,46 @@ const findListsWithValidation = async ({ export { findListsWithValidation as findLists }; +const findListsBySize = async ({ + http, + cursor, + page, + // eslint-disable-next-line @typescript-eslint/naming-convention + per_page, + signal, +}: ApiParams & FindListSchemaEncoded): Promise => { + return http.fetch(`${FIND_LISTS_BY_SIZE}`, { + method: 'GET', + query: { + cursor, + page, + per_page, + }, + signal, + }); +}; + +const findListsBySizeWithValidation = async ({ + cursor, + http, + pageIndex, + pageSize, + signal, +}: FindListsParams): Promise => + pipe( + { + cursor: cursor != null ? cursor.toString() : undefined, + page: pageIndex != null ? pageIndex.toString() : undefined, + per_page: pageSize != null ? pageSize.toString() : undefined, + }, + (payload) => fromEither(validateEither(findListSchema, payload)), + chain((payload) => tryCatch(() => findListsBySize({ http, signal, ...payload }), toError)), + chain((response) => fromEither(validateEither(foundListsBySizeSchema, response))), + flow(toPromise) + ); + +export { findListsBySizeWithValidation as findListsBySize }; + const importList = async ({ file, http, diff --git a/packages/kbn-securitysolution-list-constants/index.ts b/packages/kbn-securitysolution-list-constants/index.ts index 6bdae56d74b7b..6a1241564cf30 100644 --- a/packages/kbn-securitysolution-list-constants/index.ts +++ b/packages/kbn-securitysolution-list-constants/index.ts @@ -14,6 +14,13 @@ export const LIST_INDEX = `${LIST_URL}/index`; export const LIST_ITEM_URL = `${LIST_URL}/items`; export const LIST_PRIVILEGES_URL = `${LIST_URL}/privileges`; +/** + * Internal value list routes + */ +export const INTERNAL_LIST_URL = '/internal/lists'; +export const FIND_LISTS_BY_SIZE = `${INTERNAL_LIST_URL}/_find_lists_by_size` as const; +export const EXCEPTION_FILTER = `${INTERNAL_LIST_URL}/_create_filter` as const; + /** * Exception list routes */ @@ -59,6 +66,10 @@ export const ENDPOINT_LIST_DESCRIPTION = 'Endpoint Security Exception List'; export const MAX_EXCEPTION_LIST_SIZE = 10000; +export const MAXIMUM_SMALL_VALUE_LIST_SIZE = 65536; + +export const MAXIMUM_SMALL_IP_RANGE_VALUE_LIST_DASH_SIZE = 200; + /** ID of trusted apps agnostic list */ export const ENDPOINT_TRUSTED_APPS_LIST_ID = 'endpoint_trusted_apps'; diff --git a/packages/kbn-securitysolution-list-hooks/index.ts b/packages/kbn-securitysolution-list-hooks/index.ts index c2469bc4c4948..2422d2767349a 100644 --- a/packages/kbn-securitysolution-list-hooks/index.ts +++ b/packages/kbn-securitysolution-list-hooks/index.ts @@ -13,6 +13,7 @@ export * from './src/use_delete_list'; export * from './src/use_exception_lists'; export * from './src/use_export_list'; export * from './src/use_find_lists'; +export * from './src/use_find_lists_by_size'; export * from './src/use_import_list'; export * from './src/use_persist_exception_item'; export * from './src/use_persist_exception_list'; diff --git a/packages/kbn-securitysolution-list-hooks/src/use_api/index.ts b/packages/kbn-securitysolution-list-hooks/src/use_api/index.ts index ec76d169390cc..30664df147252 100644 --- a/packages/kbn-securitysolution-list-hooks/src/use_api/index.ts +++ b/packages/kbn-securitysolution-list-hooks/src/use_api/index.ts @@ -15,6 +15,8 @@ import type { ApiCallFindListsItemsMemoProps, ApiCallMemoProps, ApiListExportProps, + ApiCallGetExceptionFilterFromIdsMemoProps, + ApiCallGetExceptionFilterFromExceptionsMemoProps, } from '@kbn/securitysolution-io-ts-list-types'; import * as Api from '@kbn/securitysolution-list-api'; @@ -44,6 +46,10 @@ export interface ExceptionsApi { arg: ApiCallMemoProps & { onSuccess: (arg: ExceptionListSchema) => void } ) => Promise; getExceptionListsItems: (arg: ApiCallFindListsItemsMemoProps) => Promise; + getExceptionFilterFromIds: (arg: ApiCallGetExceptionFilterFromIdsMemoProps) => Promise; + getExceptionFilterFromExceptions: ( + arg: ApiCallGetExceptionFilterFromExceptionsMemoProps + ) => Promise; exportExceptionList: (arg: ApiListExportProps) => Promise; } @@ -224,6 +230,52 @@ export const useApi = (http: HttpStart): ExceptionsApi => { onError(error); } }, + async getExceptionFilterFromIds({ + exceptionListIds, + chunkSize, + alias, + excludeExceptions, + onSuccess, + onError, + }: ApiCallGetExceptionFilterFromIdsMemoProps): Promise { + const abortCtrl = new AbortController(); + try { + const { filter } = await Api.getExceptionFilterFromExceptionListIds({ + http, + exceptionListIds, + signal: abortCtrl.signal, + chunkSize, + alias, + excludeExceptions, + }); + onSuccess(filter); + } catch (error) { + onError(error); + } + }, + async getExceptionFilterFromExceptions({ + exceptions, + chunkSize, + alias, + excludeExceptions, + onSuccess, + onError, + }: ApiCallGetExceptionFilterFromExceptionsMemoProps): Promise { + const abortCtrl = new AbortController(); + try { + const { filter } = await Api.getExceptionFilterFromExceptions({ + http, + exceptions, + signal: abortCtrl.signal, + chunkSize, + alias, + excludeExceptions, + }); + onSuccess(filter); + } catch (error) { + onError(error); + } + }, async updateExceptionListItem({ listItem, }: { diff --git a/packages/kbn-securitysolution-list-hooks/src/use_find_lists_by_size/index.ts b/packages/kbn-securitysolution-list-hooks/src/use_find_lists_by_size/index.ts new file mode 100644 index 0000000000000..505242b3dd179 --- /dev/null +++ b/packages/kbn-securitysolution-list-hooks/src/use_find_lists_by_size/index.ts @@ -0,0 +1,14 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 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 { findListsBySize } from '@kbn/securitysolution-list-api'; +import { useAsync, withOptionalSignal } from '@kbn/securitysolution-hook-utils'; + +const findListsBySizeWithOptionalSignal = withOptionalSignal(findListsBySize); + +export const useFindListsBySize = () => useAsync(findListsBySizeWithOptionalSignal); diff --git a/packages/kbn-securitysolution-list-utils/index.ts b/packages/kbn-securitysolution-list-utils/index.ts index 3dce6bd9812c7..a66f52c1509c8 100644 --- a/packages/kbn-securitysolution-list-utils/index.ts +++ b/packages/kbn-securitysolution-list-utils/index.ts @@ -6,7 +6,6 @@ * Side Public License, v 1. */ export * from './src/autocomplete_operators'; -export * from './src/build_exception_filter'; export * from './src/get_exception_list_type'; export * from './src/get_filters'; export * from './src/get_general_filters'; diff --git a/packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.test.ts b/packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.test.ts deleted file mode 100644 index 78277845fc7e3..0000000000000 --- a/packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.test.ts +++ /dev/null @@ -1,14 +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. - */ - -describe('build_exceptions_filter', () => { - test('Tests should be ported', () => { - // TODO: Port all the tests from: x-pack/plugins/lists/common/exceptions/build_exceptions_filter.test.ts here once mocks are figured out and kbn package mocks are figured out - expect(true).toBe(true); - }); -}); diff --git a/packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts b/packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts deleted file mode 100644 index e8a9d8e74a486..0000000000000 --- a/packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts +++ /dev/null @@ -1,390 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import { chunk } from 'lodash/fp'; - -import { - CreateExceptionListItemSchema, - EntryExists, - EntryMatch, - EntryMatchAny, - EntryNested, - ExceptionListItemSchema, - entriesExists, - entriesMatch, - entriesMatchAny, - entriesNested, - OsTypeArray, - entriesMatchWildcard, - EntryMatchWildcard, -} from '@kbn/securitysolution-io-ts-list-types'; -import { Filter } from '@kbn/es-query'; - -import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; -import { hasLargeValueList } from '../has_large_value_list'; - -type NonListEntry = EntryMatch | EntryMatchAny | EntryNested | EntryExists | EntryMatchWildcard; -interface ExceptionListItemNonLargeList extends ExceptionListItemSchema { - entries: NonListEntry[]; -} - -interface CreateExceptionListItemNonLargeList extends CreateExceptionListItemSchema { - entries: NonListEntry[]; -} - -export type ExceptionItemSansLargeValueLists = - | ExceptionListItemNonLargeList - | CreateExceptionListItemNonLargeList; - -export interface BooleanFilter { - bool: estypes.QueryDslBoolQuery; -} - -export interface NestedFilter { - nested: estypes.QueryDslNestedQuery; -} - -export const chunkExceptions = ( - exceptions: ExceptionItemSansLargeValueLists[], - chunkSize: number -): ExceptionItemSansLargeValueLists[][] => { - return chunk(chunkSize, exceptions); -}; - -/** - * Transforms the os_type into a regular filter as if the user had created it - * from the fields for the next state of transforms which will create the elastic filters - * from it. - * - * Note: We use two types of fields, the "host.os.type" and "host.os.name.caseless" - * The endpoint/endgame agent has been using "host.os.name.caseless" as the same value as the ECS - * value of "host.os.type" where the auditbeat, winlogbeat, etc... (other agents) are all using - * "host.os.type". In order to be compatible with both, I create an "OR" between these two data types - * where if either has a match then we will exclude it as part of the match. This should also be - * forwards compatible for endpoints/endgame agents when/if they upgrade to using "host.os.type" - * rather than using "host.os.name.caseless" values. - * - * Also we create another "OR" from the osType names so that if there are multiples such as ['windows', 'linux'] - * this will exclude anything with either 'windows' or with 'linux' - * @param osTypes The os_type array from the REST interface that is an array such as ['windows', 'linux'] - * @param entries The entries to join the OR's with before the elastic filter change out - */ -export const transformOsType = ( - osTypes: OsTypeArray, - entries: NonListEntry[] -): NonListEntry[][] => { - const hostTypeTransformed = osTypes.map((osType) => { - return [ - { field: 'host.os.type', operator: 'included', type: 'match', value: osType }, - ...entries, - ]; - }); - const caseLessTransformed = osTypes.map((osType) => { - return [ - { field: 'host.os.name.caseless', operator: 'included', type: 'match', value: osType }, - ...entries, - ]; - }); - return [...hostTypeTransformed, ...caseLessTransformed]; -}; - -/** - * This builds an exception item filter with the os type - * @param osTypes The os_type array from the REST interface that is an array such as ['windows', 'linux'] - * @param entries The entries to join the OR's with before the elastic filter change out - */ -export const buildExceptionItemFilterWithOsType = ( - osTypes: OsTypeArray, - entries: NonListEntry[] -): BooleanFilter[] => { - const entriesWithOsTypes = transformOsType(osTypes, entries); - return entriesWithOsTypes.map((entryWithOsType) => { - return { - bool: { - filter: entryWithOsType.map((entry) => createInnerAndClauses(entry)), - }, - }; - }); -}; - -export const buildExceptionItemFilter = ( - exceptionItem: ExceptionItemSansLargeValueLists -): Array => { - const { entries, os_types: osTypes } = exceptionItem; - if (osTypes != null && osTypes.length > 0) { - return buildExceptionItemFilterWithOsType(osTypes, entries); - } else { - if (entries.length === 1) { - return [createInnerAndClauses(entries[0])]; - } else { - return [ - { - bool: { - filter: entries.map((entry) => createInnerAndClauses(entry)), - }, - }, - ]; - } - } -}; - -export const createOrClauses = ( - exceptionItems: ExceptionItemSansLargeValueLists[] -): Array => { - return exceptionItems.flatMap((exceptionItem) => buildExceptionItemFilter(exceptionItem)); -}; - -export const buildExceptionFilter = ({ - lists, - excludeExceptions, - chunkSize, - alias = null, -}: { - lists: Array; - excludeExceptions: boolean; - chunkSize: number; - alias: string | null; -}): Filter | undefined => { - // Remove exception items with large value lists. These are evaluated - // elsewhere for the moment being. - const exceptionsWithoutLargeValueLists = lists.filter( - (item): item is ExceptionItemSansLargeValueLists => !hasLargeValueList(item.entries) - ); - - const exceptionFilter: Filter = { - meta: { - alias, - disabled: false, - negate: excludeExceptions, - }, - query: { - bool: { - should: undefined, - }, - }, - }; - - if (exceptionsWithoutLargeValueLists.length === 0) { - return undefined; - } else if (exceptionsWithoutLargeValueLists.length <= chunkSize) { - const clause = createOrClauses(exceptionsWithoutLargeValueLists); - exceptionFilter.query!.bool!.should = clause; - return exceptionFilter; - } else { - const chunks = chunkExceptions(exceptionsWithoutLargeValueLists, chunkSize); - - const filters = chunks.map((exceptionsChunk) => { - const orClauses = createOrClauses(exceptionsChunk); - - return { - meta: { - alias: null, - disabled: false, - negate: false, - }, - query: { - bool: { - should: orClauses, - }, - }, - }; - }); - - const clauses = filters.map(({ query }) => query); - - return { - meta: { - alias, - disabled: false, - negate: excludeExceptions, - }, - query: { - bool: { - should: clauses, - }, - }, - }; - } -}; - -export const buildExclusionClause = (booleanFilter: BooleanFilter): BooleanFilter => { - return { - bool: { - must_not: booleanFilter, - }, - }; -}; - -export const buildMatchClause = (entry: EntryMatch): BooleanFilter => { - const { field, operator, value } = entry; - const matchClause = { - bool: { - minimum_should_match: 1, - should: [ - { - match_phrase: { - [field]: value, - }, - }, - ], - }, - }; - - if (operator === 'excluded') { - return buildExclusionClause(matchClause); - } else { - return matchClause; - } -}; - -export const getBaseMatchAnyClause = (entry: EntryMatchAny): BooleanFilter => { - const { field, value } = entry; - - if (value.length === 1) { - return { - bool: { - minimum_should_match: 1, - should: [ - { - match_phrase: { - [field]: value[0], - }, - }, - ], - }, - }; - } - - return { - bool: { - minimum_should_match: 1, - should: value.map((val) => { - return { - bool: { - minimum_should_match: 1, - should: [ - { - match_phrase: { - [field]: val, - }, - }, - ], - }, - }; - }), - }, - }; -}; - -export const buildMatchAnyClause = (entry: EntryMatchAny): BooleanFilter => { - const { operator } = entry; - const matchAnyClause = getBaseMatchAnyClause(entry); - - if (operator === 'excluded') { - return buildExclusionClause(matchAnyClause); - } else { - return matchAnyClause; - } -}; - -export const buildMatchWildcardClause = (entry: EntryMatchWildcard): BooleanFilter => { - const { field, operator, value } = entry; - const wildcardClause = { - bool: { - filter: { - wildcard: { - [field]: value, - }, - }, - }, - }; - - if (operator === 'excluded') { - return buildExclusionClause(wildcardClause); - } else { - return wildcardClause; - } -}; - -export const buildExistsClause = (entry: EntryExists): BooleanFilter => { - const { field, operator } = entry; - const existsClause = { - bool: { - minimum_should_match: 1, - should: [ - { - exists: { - field, - }, - }, - ], - }, - }; - - if (operator === 'excluded') { - return buildExclusionClause(existsClause); - } else { - return existsClause; - } -}; - -const isBooleanFilter = (clause: object): clause is BooleanFilter => { - const keys = Object.keys(clause); - return keys.includes('bool') != null; -}; - -export const getBaseNestedClause = ( - entries: NonListEntry[], - parentField: string -): BooleanFilter => { - if (entries.length === 1) { - const [singleNestedEntry] = entries; - const innerClause = createInnerAndClauses(singleNestedEntry, parentField); - return isBooleanFilter(innerClause) ? innerClause : { bool: {} }; - } - - return { - bool: { - filter: entries.map((nestedEntry) => createInnerAndClauses(nestedEntry, parentField)), - }, - }; -}; - -export const buildNestedClause = (entry: EntryNested): NestedFilter => { - const { field, entries } = entry; - - const baseNestedClause = getBaseNestedClause(entries, field); - - return { - nested: { - path: field, - query: baseNestedClause, - score_mode: 'none', - }, - }; -}; - -export const createInnerAndClauses = ( - entry: NonListEntry, - parent?: string -): BooleanFilter | NestedFilter => { - const field = parent != null ? `${parent}.${entry.field}` : entry.field; - if (entriesExists.is(entry)) { - return buildExistsClause({ ...entry, field }); - } else if (entriesMatch.is(entry)) { - return buildMatchClause({ ...entry, field }); - } else if (entriesMatchAny.is(entry)) { - return buildMatchAnyClause({ ...entry, field }); - } else if (entriesMatchWildcard.is(entry)) { - return buildMatchWildcardClause({ ...entry, field }); - } else if (entriesNested.is(entry)) { - return buildNestedClause(entry); - } else { - throw new TypeError(`Unexpected exception entry: ${entry}`); - } -}; diff --git a/packages/kbn-storybook/src/webpack.config.ts b/packages/kbn-storybook/src/webpack.config.ts index 880afe83528a8..3d00fb88a089a 100644 --- a/packages/kbn-storybook/src/webpack.config.ts +++ b/packages/kbn-storybook/src/webpack.config.ts @@ -102,7 +102,7 @@ export default ({ config: storybookConfig }: { config: Configuration }) => { additionalData(content: string, loaderContext: any) { return `@import ${stringifyRequest( loaderContext, - resolve(REPO_ROOT, 'src/core/public/core_app/styles/_globals_v8light.scss') + resolve(REPO_ROOT, 'src/core/public/styles/core_app/_globals_v8light.scss') )};\n${content}`; }, implementation: require('node-sass'), @@ -120,7 +120,7 @@ export default ({ config: storybookConfig }: { config: Configuration }) => { extensions: ['.js', '.ts', '.tsx', '.json', '.mdx'], mainFields: ['browser', 'main'], alias: { - core_app_image_assets: resolve(REPO_ROOT, 'src/core/public/core_app/images'), + core_app_image_assets: resolve(REPO_ROOT, 'src/core/public/styles/core_app/images'), core_styles: resolve(REPO_ROOT, 'src/core/public/index.scss'), }, symlinks: false, diff --git a/packages/kbn-telemetry-tools/src/tools/tasks/write_to_file_task.ts b/packages/kbn-telemetry-tools/src/tools/tasks/write_to_file_task.ts index e640d9e3bfec8..f6adffa38f068 100644 --- a/packages/kbn-telemetry-tools/src/tools/tasks/write_to_file_task.ts +++ b/packages/kbn-telemetry-tools/src/tools/tasks/write_to_file_task.ts @@ -15,6 +15,12 @@ export function writeToFileTask({ roots }: TaskContext) { task: async () => { const fullPath = path.resolve(process.cwd(), root.config.output); if (root.mapping && Object.keys(root.mapping.properties).length > 0) { + // Sort first-level properties alphabetically + root.mapping.properties = Object.fromEntries( + Object.entries(root.mapping.properties).sort(([a], [b]) => { + return a > b ? 1 : -1; + }) + ); const serializedMapping = JSON.stringify(root.mapping, null, 2).concat('\n'); await writeFileAsync(fullPath, serializedMapping); } diff --git a/packages/kbn-test-jest-helpers/src/testbed/testbed.ts b/packages/kbn-test-jest-helpers/src/testbed/testbed.ts index ddd574ace64b8..a05133b35f581 100644 --- a/packages/kbn-test-jest-helpers/src/testbed/testbed.ts +++ b/packages/kbn-test-jest-helpers/src/testbed/testbed.ts @@ -55,18 +55,18 @@ const defaultConfig: TestBedConfig = { }); ``` */ -export function registerTestBed( +export function registerTestBed( Component: ComponentType, config: AsyncTestBedConfig -): AsyncSetupFunc; -export function registerTestBed( +): AsyncSetupFunc>; +export function registerTestBed( Component: ComponentType, config?: TestBedConfig -): SyncSetupFunc; -export function registerTestBed( +): SyncSetupFunc>; +export function registerTestBed( Component: ComponentType, config?: AsyncTestBedConfig | TestBedConfig -): SetupFunc { +): SetupFunc> { const { defaultProps = defaultConfig.defaultProps, memoryRouter = defaultConfig.memoryRouter!, @@ -263,7 +263,7 @@ export function registerTestBed( .slice(1) // we remove the first row as it is the table header .map((row) => ({ reactWrapper: row, - columns: row.find('td').map((col) => ({ + columns: row.find('.euiTableCellContent').map((col) => ({ reactWrapper: col, // We can't access the td value with col.text() because // eui adds an extra div in td on mobile => (.euiTableRowCell__mobileHeader) diff --git a/packages/kbn-test-jest-helpers/src/testbed/types.ts b/packages/kbn-test-jest-helpers/src/testbed/types.ts index 15996646ec80a..6390be14be00e 100644 --- a/packages/kbn-test-jest-helpers/src/testbed/types.ts +++ b/packages/kbn-test-jest-helpers/src/testbed/types.ts @@ -10,9 +10,9 @@ import { Store } from 'redux'; import { ReactWrapper as GenericReactWrapper } from 'enzyme'; import { LocationDescriptor } from 'history'; -export type AsyncSetupFunc = (props?: any) => Promise>; -export type SyncSetupFunc = (props?: any) => TestBed; -export type SetupFunc = (props?: any) => TestBed | Promise>; +export type AsyncSetupFunc = (props?: P) => Promise>; +export type SyncSetupFunc = (props?: P) => TestBed; +export type SetupFunc = (props?: P) => TestBed | Promise>; export type ReactWrapper = GenericReactWrapper; export interface EuiTableMetaData { diff --git a/packages/kbn-test-subj-selector/BUILD.bazel b/packages/kbn-test-subj-selector/BUILD.bazel index cc3334650a5d9..a92554c948230 100644 --- a/packages/kbn-test-subj-selector/BUILD.bazel +++ b/packages/kbn-test-subj-selector/BUILD.bazel @@ -1,13 +1,28 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") load("@build_bazel_rules_nodejs//:index.bzl", "js_library") -load("//src/dev/bazel:index.bzl", "pkg_npm") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") -PKG_BASE_NAME = "kbn-test-subj-selector" +PKG_DIRNAME = "kbn-test-subj-selector" PKG_REQUIRE_NAME = "@kbn/test-subj-selector" -SOURCE_FILES = glob([ - "index.d.ts", - "index.js" -]) +SOURCE_FILES = glob( + [ + "**/*.ts", + ], + exclude = [ + "**/*.config.js", + "**/*.mock.*", + "**/*.test.*", + "**/*.stories.*", + "**/__snapshots__/**", + "**/integration_tests/**", + "**/mocks/**", + "**/scripts/**", + "**/storybook/**", + "**/test_fixtures/**", + "**/test_helpers/**", + ], +) SRCS = SOURCE_FILES @@ -20,29 +35,90 @@ NPM_MODULE_EXTRA_FILES = [ "package.json", ] -RUNTIME_DEPS = [] +# In this array place runtime dependencies, including other packages and NPM packages +# which must be available for this code to run. +# +# To reference other packages use: +# "//repo/relative/path/to/package" +# eg. "//packages/kbn-utils" +# +# To reference a NPM package use: +# "@npm//name-of-package" +# eg. "@npm//lodash" +RUNTIME_DEPS = [ +] -js_library( - name = PKG_BASE_NAME, - srcs = NPM_MODULE_EXTRA_FILES + [ - ":srcs", +# In this array place dependencies necessary to build the types, which will include the +# :npm_module_types target of other packages and packages from NPM, including @types/* +# packages. +# +# To reference the types for another package use: +# "//repo/relative/path/to/package:npm_module_types" +# eg. "//packages/kbn-utils:npm_module_types" +# +# References to NPM packages work the same as RUNTIME_DEPS +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", ], - deps = RUNTIME_DEPS, +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + declaration_map = True, + emit_declaration_only = True, + out_dir = "target_types", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node"], package_name = PKG_REQUIRE_NAME, visibility = ["//visibility:public"], ) pkg_npm( name = "npm_module", - deps = [ - ":%s" % PKG_BASE_NAME, - ] + deps = [":" + PKG_DIRNAME], ) filegroup( name = "build", - srcs = [ - ":npm_module", - ], + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], visibility = ["//visibility:public"], ) diff --git a/packages/kbn-test-subj-selector/README.mdx b/packages/kbn-test-subj-selector/README.mdx index c924d15937129..9f36c3c63670c 100755 --- a/packages/kbn-test-subj-selector/README.mdx +++ b/packages/kbn-test-subj-selector/README.mdx @@ -7,4 +7,20 @@ date: 2022-05-19 tags: ['kibana', 'dev', 'contributor', 'operations', 'test', 'subj', 'selector'] --- -Converts a string from a test subject syntax into a css selectors composed by `data-test-subj`. +Converts a testSubject selector into a CSS selector. + +testSubject selector syntax rules: + + - `data-test-subj` values can include spaces + + - prefixing a value with `~` will allow matching a single word in a `data-test-subj` that uses several space delimited list words + - example: `~foo` + - css equivalent: `[data-test-subj~="foo"]` + + - the `>` character is used between two values to indicate that the value on the right must match an element inside an element matched by the value on the left + - example: `foo > bar` + - css equivalent: `[data-test-subj=foo] [data-test-subj=bar]` + + - the `&` character is used between two values to indicate that the value on both sides must both match the element + - example: `foo & bar` + - css equivalent: `[data-test-subj=foo][data-test-subj=bar]` \ No newline at end of file diff --git a/packages/kbn-test-subj-selector/index.d.ts b/packages/kbn-test-subj-selector/index.d.ts deleted file mode 100644 index 41765c094dc74..0000000000000 --- a/packages/kbn-test-subj-selector/index.d.ts +++ /dev/null @@ -1,10 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -// eslint-disable-next-line import/no-default-export -export default function kbnTestSubjSelector(selector: string): string; diff --git a/packages/kbn-test-subj-selector/index.js b/packages/kbn-test-subj-selector/index.js deleted file mode 100755 index 0163983d87eea..0000000000000 --- a/packages/kbn-test-subj-selector/index.js +++ /dev/null @@ -1,38 +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. - */ - -function selectorToTerms(selector) { - return selector - .replace(/\s*~\s*/g, '~') // css locator with '~' operator cannot contain spaces - .replace(/\s*>\s*/g, '>') // remove all whitespace around joins > - .replace(/\s*&\s*/g, '&') // remove all whitespace around joins & - .split(/>+/); -} - -function termToCssSelector(term) { - if (term) { - return term.startsWith('~') - ? '[data-test-subj~="' + term.substring(1).replace(/\s/g, '') + '"]' - : '[data-test-subj="' + term + '"]'; - } else { - return ''; - } -} - -module.exports = function testSubjSelector(selector) { - const cssSelectors = []; - const terms = selectorToTerms(selector); - - while (terms.length) { - const term = terms.shift(); - // split each term by joins/& and map to css selectors - cssSelectors.push(term.split('&').map(termToCssSelector).join('')); - } - - return cssSelectors.join(' '); -}; diff --git a/packages/kbn-test-subj-selector/index.test.js b/packages/kbn-test-subj-selector/index.test.js deleted file mode 100755 index aa23c8d1bd70b..0000000000000 --- a/packages/kbn-test-subj-selector/index.test.js +++ /dev/null @@ -1,24 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -const testSubjSelector = require('.'); - -describe('testSubjSelector()', function () { - it('converts subjectSelectors to cssSelectors', function () { - expect(testSubjSelector('foo bar')).toEqual('[data-test-subj="foo bar"]'); - expect(testSubjSelector('foo > bar')).toEqual('[data-test-subj="foo"] [data-test-subj="bar"]'); - expect(testSubjSelector('foo > bar baz')).toEqual( - '[data-test-subj="foo"] [data-test-subj="bar baz"]' - ); - expect(testSubjSelector('foo> ~bar')).toEqual('[data-test-subj="foo"] [data-test-subj~="bar"]'); - expect(testSubjSelector('~ foo')).toEqual('[data-test-subj~="foo"]'); - expect(testSubjSelector('~foo & ~ bar')).toEqual( - '[data-test-subj~="foo"][data-test-subj~="bar"]' - ); - }); -}); diff --git a/packages/kbn-test-subj-selector/index.ts b/packages/kbn-test-subj-selector/index.ts new file mode 100644 index 0000000000000..d815909b39b7b --- /dev/null +++ b/packages/kbn-test-subj-selector/index.ts @@ -0,0 +1,9 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export { subj } from './test_subj_selector'; diff --git a/packages/kbn-test-subj-selector/jest.config.js b/packages/kbn-test-subj-selector/jest.config.js index 8395fe2837911..26b71c41970d1 100644 --- a/packages/kbn-test-subj-selector/jest.config.js +++ b/packages/kbn-test-subj-selector/jest.config.js @@ -7,7 +7,7 @@ */ module.exports = { - preset: '@kbn/test', + preset: '@kbn/test/jest_node', rootDir: '../..', roots: ['/packages/kbn-test-subj-selector'], }; diff --git a/packages/kbn-test-subj-selector/kibana.jsonc b/packages/kbn-test-subj-selector/kibana.jsonc index 697ce5593ea71..708e1fd44ac39 100644 --- a/packages/kbn-test-subj-selector/kibana.jsonc +++ b/packages/kbn-test-subj-selector/kibana.jsonc @@ -1,8 +1,8 @@ { "type": "shared-common", "id": "@kbn/test-subj-selector", - "devOnly": true, "owner": "@elastic/kibana-operations", + "devOnly": true, "runtimeDeps": [], - "typeDeps": [] + "typeDeps": [], } diff --git a/packages/kbn-test-subj-selector/package.json b/packages/kbn-test-subj-selector/package.json old mode 100755 new mode 100644 index 8ced36990a6e3..6c8d040735d50 --- a/packages/kbn-test-subj-selector/package.json +++ b/packages/kbn-test-subj-selector/package.json @@ -1,10 +1,7 @@ { "name": "@kbn/test-subj-selector", - "version": "0.2.1", - "description": "", - "main": "index.js", - "keywords": [], - "author": "Spencer Alger ", - "license": "SSPL-1.0 OR Elastic License 2.0", - "private": "true" + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0" } diff --git a/packages/kbn-test-subj-selector/test_subj_selector.test.ts b/packages/kbn-test-subj-selector/test_subj_selector.test.ts new file mode 100644 index 0000000000000..d8ad1e6ddfd56 --- /dev/null +++ b/packages/kbn-test-subj-selector/test_subj_selector.test.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 { subj } from './test_subj_selector'; + +describe('testSubjSelector()', function () { + it('converts subjectSelectors to cssSelectors', function () { + expect(subj('foo bar')).toEqual('[data-test-subj="foo bar"]'); + expect(subj('foo > bar')).toEqual('[data-test-subj="foo"] [data-test-subj="bar"]'); + expect(subj('foo > bar baz')).toEqual('[data-test-subj="foo"] [data-test-subj="bar baz"]'); + expect(subj('foo> ~bar')).toEqual('[data-test-subj="foo"] [data-test-subj~="bar"]'); + expect(subj('~ foo')).toEqual('[data-test-subj~="foo"]'); + expect(subj('~foo & ~ bar')).toEqual('[data-test-subj~="foo"][data-test-subj~="bar"]'); + }); +}); diff --git a/packages/kbn-test-subj-selector/test_subj_selector.ts b/packages/kbn-test-subj-selector/test_subj_selector.ts new file mode 100644 index 0000000000000..e6db49755a89b --- /dev/null +++ b/packages/kbn-test-subj-selector/test_subj_selector.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. + */ + +function selectorToTerms(selector: string) { + return selector + .replace(/\s*~\s*/g, '~') // css locator with '~' operator cannot contain spaces + .replace(/\s*>\s*/g, '>') // remove all whitespace around joins > + .replace(/\s*&\s*/g, '&') // remove all whitespace around joins & + .split(/>+/); +} + +function termToCssSelector(term: string) { + if (term) { + return term.startsWith('~') + ? '[data-test-subj~="' + term.substring(1).replace(/\s/g, '') + '"]' + : '[data-test-subj="' + term + '"]'; + } else { + return ''; + } +} + +/** + * Converts a testSubject selector into a CSS selector. + * + * testSubject selector syntax rules: + * + * - `data-test-subj` values can include spaces + * + * - prefixing a value with `~` will allow matching a single word in a `data-test-subj` that uses several space delimited list words + * - example: `~foo` + * - css equivalent: `[data-test-subj~="foo"]` + * + * - the `>` character is used between two values to indicate that the value on the right must match an element inside an element matched by the value on the left + * - example: `foo > bar` + * - css equivalent: `[data-test-subj=foo] [data-test-subj=bar]` + * + * - the `&` character is used between two values to indicate that the value on both sides must both match the element + * - example: `foo & bar` + * - css equivalent: `[data-test-subj=foo][data-test-subj=bar]` + */ +export function subj(selector: string) { + return selectorToTerms(selector) + .map((term) => + // split each term by joins/& and map to css selectors + term.split('&').map(termToCssSelector).join('') + ) + .join(' '); +} diff --git a/packages/kbn-test-subj-selector/tsconfig.json b/packages/kbn-test-subj-selector/tsconfig.json index a590073946162..81935b1385550 100644 --- a/packages/kbn-test-subj-selector/tsconfig.json +++ b/packages/kbn-test-subj-selector/tsconfig.json @@ -1,9 +1,17 @@ { "extends": "../../tsconfig.bazel.json", "compilerOptions": { - "outDir": "target/types" + "declaration": true, + "declarationMap": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "stripInternal": false, + "types": [ + "jest", + "node" + ] }, "include": [ - "index.d.ts" + "**/*.ts", ] } diff --git a/packages/kbn-test/src/es/test_es_cluster.ts b/packages/kbn-test/src/es/test_es_cluster.ts index 8c650ec9b6051..70fa5f2e8d375 100644 --- a/packages/kbn-test/src/es/test_es_cluster.ts +++ b/packages/kbn-test/src/es/test_es_cluster.ts @@ -95,6 +95,7 @@ export interface CreateTestEsClusterOptions { */ license?: 'basic' | 'gold' | 'trial'; // | 'oss' log: ToolingLog; + writeLogsToPath?: string; /** * Node-specific configuration if you wish to run a multi-node * cluster. One node will be added for each item in the array. @@ -168,6 +169,7 @@ export function createTestEsCluster< password = 'changeme', license = 'basic', log, + writeLogsToPath, basePath = Path.resolve(REPO_ROOT, '.es'), esFrom = esTestConfig.getBuildFrom(), dataArchive, @@ -272,6 +274,7 @@ export function createTestEsCluster< skipNativeRealmSetup: this.nodes.length > 1 && i < this.nodes.length - 1, skipReadyCheck: this.nodes.length > 1 && i < this.nodes.length - 1, onEarlyExit, + writeLogsToPath, }); }); } diff --git a/packages/kbn-test/src/failed_tests_reporter/__fixtures__/cypress_report.xml b/packages/kbn-test/src/failed_tests_reporter/__fixtures__/cypress_report.xml index ed0e154552caa..c0c66e81db26d 100644 --- a/packages/kbn-test/src/failed_tests_reporter/__fixtures__/cypress_report.xml +++ b/packages/kbn-test/src/failed_tests_reporter/__fixtures__/cypress_report.xml @@ -1,6 +1,6 @@ - + diff --git a/packages/kbn-test/src/failed_tests_reporter/add_messages_to_report.test.ts b/packages/kbn-test/src/failed_tests_reporter/add_messages_to_report.test.ts index 220a336915bf1..3b71823ee6bde 100644 --- a/packages/kbn-test/src/failed_tests_reporter/add_messages_to_report.test.ts +++ b/packages/kbn-test/src/failed_tests_reporter/add_messages_to_report.test.ts @@ -282,9 +282,9 @@ it('rewrites cypress reports with minimal changes', async () => { -‹?xml version="1.0" encoding="UTF-8"?› +‹?xml version="1.0" encoding="utf-8"?› ‹testsuites name="Mocha Tests" time="16.198" tests="2" failures="1"› - - ‹testsuite name="Root Suite" timestamp="2020-07-22T15:06:26" tests="0" file="cypress/integration/timeline_flyout_button.spec.ts" failures="0" time="0"› + - ‹testsuite name="Root Suite" timestamp="2020-07-22T15:06:26" tests="0" file="cypress/e2e/timeline_flyout_button.spec.ts" failures="0" time="0"› - ‹/testsuite› - + ‹testsuite name="Root Suite" timestamp="2020-07-22T15:06:26" tests="0" file="cypress/integration/timeline_flyout_button.spec.ts" failures="0" time="0"/› + + ‹testsuite name="Root Suite" timestamp="2020-07-22T15:06:26" tests="0" file="cypress/e2e/timeline_flyout_button.spec.ts" failures="0" time="0"/› ‹testsuite name="timeline flyout button" timestamp="2020-07-22T15:06:26" tests="2" failures="1" time="16.198"› - ‹testcase name="timeline flyout button toggles open the timeline" time="8.099" classname="toggles open the timeline"› - ‹/testcase› diff --git a/packages/kbn-test/src/functional_tests/cli/run_tests/__snapshots__/args.test.js.snap b/packages/kbn-test/src/functional_tests/cli/run_tests/__snapshots__/args.test.js.snap index cff0b46afcad1..ff8961e263f17 100644 --- a/packages/kbn-test/src/functional_tests/cli/run_tests/__snapshots__/args.test.js.snap +++ b/packages/kbn-test/src/functional_tests/cli/run_tests/__snapshots__/args.test.js.snap @@ -23,6 +23,7 @@ Options: --include-tag Tags that suites must include to be run, can be included multiple times. --exclude-tag Tags that suites must NOT include to be run, can be included multiple times. --assert-none-excluded Exit with 1/0 based on if any test is excluded with the current set of tags. + --logToFile Write the log output from Kibana/Elasticsearch to files instead of to stdout --verbose Log everything. --debug Run in debug mode. --quiet Only log errors. @@ -40,6 +41,7 @@ Object { "esFrom": "snapshot", "esVersion": "999.999.999", "extraKbnOpts": undefined, + "logsDir": undefined, "suiteFiles": Object { "exclude": Array [], "include": Array [], @@ -62,6 +64,7 @@ Object { "esFrom": "snapshot", "esVersion": "999.999.999", "extraKbnOpts": undefined, + "logsDir": undefined, "suiteFiles": Object { "exclude": Array [], "include": Array [], @@ -85,6 +88,7 @@ Object { "esFrom": "snapshot", "esVersion": "999.999.999", "extraKbnOpts": undefined, + "logsDir": undefined, "suiteFiles": Object { "exclude": Array [], "include": Array [], @@ -107,6 +111,7 @@ Object { "esFrom": "snapshot", "esVersion": "999.999.999", "extraKbnOpts": undefined, + "logsDir": undefined, "suiteFiles": Object { "exclude": Array [], "include": Array [], @@ -133,6 +138,7 @@ Object { "extraKbnOpts": Object { "server.foo": "bar", }, + "logsDir": undefined, "suiteFiles": Object { "exclude": Array [], "include": Array [], @@ -154,6 +160,7 @@ Object { "esFrom": "snapshot", "esVersion": "999.999.999", "extraKbnOpts": undefined, + "logsDir": undefined, "quiet": true, "suiteFiles": Object { "exclude": Array [], @@ -176,6 +183,7 @@ Object { "esFrom": "snapshot", "esVersion": "999.999.999", "extraKbnOpts": undefined, + "logsDir": undefined, "silent": true, "suiteFiles": Object { "exclude": Array [], @@ -198,6 +206,7 @@ Object { "esFrom": "source", "esVersion": "999.999.999", "extraKbnOpts": undefined, + "logsDir": undefined, "suiteFiles": Object { "exclude": Array [], "include": Array [], @@ -219,6 +228,7 @@ Object { "esFrom": "source", "esVersion": "999.999.999", "extraKbnOpts": undefined, + "logsDir": undefined, "suiteFiles": Object { "exclude": Array [], "include": Array [], @@ -241,6 +251,7 @@ Object { "esVersion": "999.999.999", "extraKbnOpts": undefined, "installDir": "foo", + "logsDir": undefined, "suiteFiles": Object { "exclude": Array [], "include": Array [], @@ -263,6 +274,7 @@ Object { "esVersion": "999.999.999", "extraKbnOpts": undefined, "grep": "management", + "logsDir": undefined, "suiteFiles": Object { "exclude": Array [], "include": Array [], @@ -284,6 +296,7 @@ Object { "esFrom": "snapshot", "esVersion": "999.999.999", "extraKbnOpts": undefined, + "logsDir": undefined, "suiteFiles": Object { "exclude": Array [], "include": Array [], @@ -306,6 +319,7 @@ Object { "esFrom": "snapshot", "esVersion": "999.999.999", "extraKbnOpts": undefined, + "logsDir": undefined, "suiteFiles": Object { "exclude": Array [], "include": Array [], diff --git a/packages/kbn-test/src/functional_tests/cli/run_tests/__snapshots__/cli.test.js.snap b/packages/kbn-test/src/functional_tests/cli/run_tests/__snapshots__/cli.test.js.snap deleted file mode 100644 index 6b81c2e499cf4..0000000000000 --- a/packages/kbn-test/src/functional_tests/cli/run_tests/__snapshots__/cli.test.js.snap +++ /dev/null @@ -1,74 +0,0 @@ -// Jest Snapshot v1, https://goo.gl/fbAQLP - -exports[`run tests CLI options accepts help option even if invalid options passed 1`] = ` -"Run Functional Tests - -Usage: - node scripts/functional_tests --help - node scripts/functional_tests [--config [--config ...]] - node scripts/functional_tests [options] [-- --] - -Options: - --help Display this menu and exit. - --config Pass in a config. Can pass in multiple configs. - --esFrom Build Elasticsearch from source or run from snapshot. Default: $TEST_ES_FROM or snapshot - --kibana-install-dir Run Kibana from existing install directory instead of from source. - --bail Stop the test run at the first failure. - --grep Pattern to select which tests to run. - --updateBaselines Replace baseline screenshots with whatever is generated from the test. - --updateSnapshots Replace inline and file snapshots with whatever is generated from the test. - --u Replace both baseline screenshots and snapshots - --include Files that must included to be run, can be included multiple times. - --exclude Files that must NOT be included to be run, can be included multiple times. - --include-tag Tags that suites must include to be run, can be included multiple times. - --exclude-tag Tags that suites must NOT include to be run, can be included multiple times. - --assert-none-excluded Exit with 1/0 based on if any test is excluded with the current set of tags. - --verbose Log everything. - --debug Run in debug mode. - --quiet Only log errors. - --silent Log nothing. - --dry-run Report tests without executing them. -" -`; - -exports[`run tests CLI options rejects boolean config value 1`] = ` -" -functional_tests: invalid argument [true] to option [config] - ...stack trace... -" -`; - -exports[`run tests CLI options rejects boolean value for kibana-install-dir 1`] = ` -" -functional_tests: invalid argument [true] to option [kibana-install-dir] - ...stack trace... -" -`; - -exports[`run tests CLI options rejects empty config value if no default passed 1`] = ` -" -functional_tests: config is required - ...stack trace... -" -`; - -exports[`run tests CLI options rejects invalid options even if valid options exist 1`] = ` -" -functional_tests: invalid option [aintnothang] - ...stack trace... -" -`; - -exports[`run tests CLI options rejects non-boolean value for bail 1`] = ` -" -functional_tests: invalid argument [peanut] to option [bail] - ...stack trace... -" -`; - -exports[`run tests CLI options rejects non-enum value for esFrom 1`] = ` -" -functional_tests: invalid argument [butter] to option [esFrom] - ...stack trace... -" -`; diff --git a/packages/kbn-test/src/functional_tests/cli/run_tests/args.js b/packages/kbn-test/src/functional_tests/cli/run_tests/args.js index d94adcfe615a5..8b1bf471f4e98 100644 --- a/packages/kbn-test/src/functional_tests/cli/run_tests/args.js +++ b/packages/kbn-test/src/functional_tests/cli/run_tests/args.js @@ -6,9 +6,11 @@ * Side Public License, v 1. */ -import { resolve } from 'path'; +import Path from 'path'; +import { v4 as uuid } from 'uuid'; import dedent from 'dedent'; +import { REPO_ROOT } from '@kbn/utils'; import { ToolingLog, pickLevelFromFlags } from '@kbn/tooling-log'; import { EsVersion } from '../../../functional_test_runner'; @@ -61,6 +63,9 @@ const options = { 'assert-none-excluded': { desc: 'Exit with 1/0 based on if any test is excluded with the current set of tags.', }, + logToFile: { + desc: 'Write the log output from Kibana/Elasticsearch to files instead of to stdout', + }, verbose: { desc: 'Log everything.' }, debug: { desc: 'Run in debug mode.' }, quiet: { desc: 'Only log errors.' }, @@ -142,19 +147,24 @@ export function processOptions(userOptions, defaultConfigPaths) { delete userOptions['dry-run']; } + const log = new ToolingLog({ + level: pickLevelFromFlags(userOptions), + writeTo: process.stdout, + }); function createLogger() { - return new ToolingLog({ - level: pickLevelFromFlags(userOptions), - writeTo: process.stdout, - }); + return log; } + const logToFile = !!userOptions.logToFile; + const logsDir = logToFile ? Path.resolve(REPO_ROOT, 'data/ftr_servers_logs', uuid()) : undefined; + return { ...userOptions, - configs: configs.map((c) => resolve(c)), + configs: configs.map((c) => Path.resolve(c)), createLogger, extraKbnOpts: userOptions._, esVersion: EsVersion.getDefault(), + logsDir, }; } diff --git a/packages/kbn-test/src/functional_tests/cli/run_tests/cli.js b/packages/kbn-test/src/functional_tests/cli/run_tests/cli.js index e920e43f375b4..3958c1503cd30 100644 --- a/packages/kbn-test/src/functional_tests/cli/run_tests/cli.js +++ b/packages/kbn-test/src/functional_tests/cli/run_tests/cli.js @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { runTests } from '../../tasks'; +import { runTests, initLogsDir } from '../../tasks'; import { runCli } from '../../lib'; import { processOptions, displayHelp } from './args'; @@ -21,6 +21,7 @@ import { processOptions, displayHelp } from './args'; export async function runTestsCli(defaultConfigPaths) { await runCli(displayHelp, async (userOptions) => { const options = processOptions(userOptions, defaultConfigPaths); + initLogsDir(options); await runTests(options); }); } diff --git a/packages/kbn-test/src/functional_tests/cli/run_tests/cli.test.js b/packages/kbn-test/src/functional_tests/cli/run_tests/cli.test.js deleted file mode 100644 index 1b679f285d133..0000000000000 --- a/packages/kbn-test/src/functional_tests/cli/run_tests/cli.test.js +++ /dev/null @@ -1,232 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import { Writable } from 'stream'; - -import { runTestsCli } from './cli'; -import { checkMockConsoleLogSnapshot } from '../../test_helpers'; - -// Note: Stub the runTests function to keep testing only around the cli -// method and arguments. -jest.mock('../../tasks', () => ({ - runTests: jest.fn(), -})); - -describe('run tests CLI', () => { - describe('options', () => { - const originalObjects = { process, console }; - const exitMock = jest.fn(); - const logMock = jest.fn(); // mock logging so we don't send output to the test results - const argvMock = ['foo', 'foo']; - - const processMock = { - exit: exitMock, - argv: argvMock, - stdout: new Writable(), - cwd: jest.fn(), - env: { - ...originalObjects.process.env, - TEST_ES_FROM: 'snapshot', - }, - }; - - beforeAll(() => { - global.process = processMock; - global.console = { log: logMock }; - }); - - afterAll(() => { - global.process = originalObjects.process; - global.console = originalObjects.console; - }); - - beforeEach(() => { - global.process.argv = [...argvMock]; - global.process.env = { - ...originalObjects.process.env, - TEST_ES_FROM: 'snapshot', - }; - jest.resetAllMocks(); - }); - - it('rejects boolean config value', async () => { - global.process.argv.push('--config'); - - await runTestsCli(); - - expect(exitMock).toHaveBeenCalledWith(1); - checkMockConsoleLogSnapshot(logMock); - }); - - it('rejects empty config value if no default passed', async () => { - global.process.argv.push('--config', ''); - - await runTestsCli(); - - expect(exitMock).toHaveBeenCalledWith(1); - checkMockConsoleLogSnapshot(logMock); - }); - - it('accepts empty config value if default passed', async () => { - global.process.argv.push('--config', ''); - - await runTestsCli(['foo']); - - expect(exitMock).not.toHaveBeenCalled(); - }); - - it('rejects non-boolean value for bail', async () => { - global.process.argv.push('--bail', 'peanut'); - - await runTestsCli(['foo']); - - expect(exitMock).toHaveBeenCalledWith(1); - checkMockConsoleLogSnapshot(logMock); - }); - - it('accepts string value for kibana-install-dir', async () => { - global.process.argv.push('--kibana-install-dir', 'foo'); - - await runTestsCli(['foo']); - - expect(exitMock).not.toHaveBeenCalled(); - }); - - it('rejects boolean value for kibana-install-dir', async () => { - global.process.argv.push('--kibana-install-dir'); - - await runTestsCli(['foo']); - - expect(exitMock).toHaveBeenCalledWith(1); - checkMockConsoleLogSnapshot(logMock); - }); - - it('accepts boolean value for updateBaselines', async () => { - global.process.argv.push('--updateBaselines'); - - await runTestsCli(['foo']); - - expect(exitMock).not.toHaveBeenCalledWith(); - }); - - it('accepts boolean value for updateSnapshots', async () => { - global.process.argv.push('--updateSnapshots'); - - await runTestsCli(['foo']); - - expect(exitMock).not.toHaveBeenCalledWith(); - }); - - it('accepts boolean value for -u', async () => { - global.process.argv.push('-u'); - - await runTestsCli(['foo']); - - expect(exitMock).not.toHaveBeenCalledWith(); - }); - - it('accepts source value for esFrom', async () => { - global.process.argv.push('--esFrom', 'source'); - - await runTestsCli(['foo']); - - expect(exitMock).not.toHaveBeenCalled(); - }); - - it('rejects non-enum value for esFrom', async () => { - global.process.argv.push('--esFrom', 'butter'); - - await runTestsCli(['foo']); - - expect(exitMock).toHaveBeenCalledWith(1); - checkMockConsoleLogSnapshot(logMock); - }); - - it('accepts value for grep', async () => { - global.process.argv.push('--grep', 'management'); - - await runTestsCli(['foo']); - - expect(exitMock).not.toHaveBeenCalled(); - }); - - it('accepts debug option', async () => { - global.process.argv.push('--debug'); - - await runTestsCli(['foo']); - - expect(exitMock).not.toHaveBeenCalled(); - }); - - it('accepts silent option', async () => { - global.process.argv.push('--silent'); - - await runTestsCli(['foo']); - - expect(exitMock).not.toHaveBeenCalled(); - }); - - it('accepts quiet option', async () => { - global.process.argv.push('--quiet'); - - await runTestsCli(['foo']); - - expect(exitMock).not.toHaveBeenCalled(); - }); - - it('accepts verbose option', async () => { - global.process.argv.push('--verbose'); - - await runTestsCli(['foo']); - - expect(exitMock).not.toHaveBeenCalled(); - }); - - it('accepts network throttle option', async () => { - global.process.argv.push('--throttle'); - - await runTestsCli(['foo']); - - expect(exitMock).toHaveBeenCalledWith(1); - }); - - it('accepts headless option', async () => { - global.process.argv.push('--headless'); - - await runTestsCli(['foo']); - - expect(exitMock).toHaveBeenCalledWith(1); - }); - - it('accepts extra server options', async () => { - global.process.argv.push('--', '--server.foo=bar'); - - await runTestsCli(['foo']); - - expect(exitMock).not.toHaveBeenCalled(); - }); - - it('accepts help option even if invalid options passed', async () => { - global.process.argv.push('--debug', '--aintnothang', '--help'); - - await runTestsCli(['foo']); - - expect(exitMock).not.toHaveBeenCalledWith(1); - checkMockConsoleLogSnapshot(logMock); - }); - - it('rejects invalid options even if valid options exist', async () => { - global.process.argv.push('--debug', '--aintnothang', '--bail'); - - await runTestsCli(['foo']); - - expect(exitMock).toHaveBeenCalledWith(1); - checkMockConsoleLogSnapshot(logMock); - }); - }); -}); diff --git a/packages/kbn-test/src/functional_tests/cli/start_servers/__snapshots__/args.test.js.snap b/packages/kbn-test/src/functional_tests/cli/start_servers/__snapshots__/args.test.js.snap index cd3174d13c3e6..1f572578119f7 100644 --- a/packages/kbn-test/src/functional_tests/cli/start_servers/__snapshots__/args.test.js.snap +++ b/packages/kbn-test/src/functional_tests/cli/start_servers/__snapshots__/args.test.js.snap @@ -13,6 +13,7 @@ Options: --config Pass in a config --esFrom Build Elasticsearch from source, snapshot or path to existing install dir. Default: $TEST_ES_FROM or snapshot --kibana-install-dir Run Kibana from existing install directory instead of from source. + --logToFile Write the log output from Kibana/Elasticsearch to files instead of to stdout --verbose Log everything. --debug Run in debug mode. --quiet Only log errors. @@ -26,6 +27,7 @@ Object { "debug": true, "esFrom": "snapshot", "extraKbnOpts": undefined, + "logsDir": undefined, "useDefaultConfig": true, } `; @@ -36,6 +38,7 @@ Object { "createLogger": [Function], "esFrom": "snapshot", "extraKbnOpts": undefined, + "logsDir": undefined, "useDefaultConfig": true, } `; @@ -51,6 +54,7 @@ Object { "extraKbnOpts": Object { "server.foo": "bar", }, + "logsDir": undefined, "useDefaultConfig": true, } `; @@ -61,6 +65,7 @@ Object { "createLogger": [Function], "esFrom": "snapshot", "extraKbnOpts": undefined, + "logsDir": undefined, "quiet": true, "useDefaultConfig": true, } @@ -72,6 +77,7 @@ Object { "createLogger": [Function], "esFrom": "snapshot", "extraKbnOpts": undefined, + "logsDir": undefined, "silent": true, "useDefaultConfig": true, } @@ -83,6 +89,7 @@ Object { "createLogger": [Function], "esFrom": "source", "extraKbnOpts": undefined, + "logsDir": undefined, "useDefaultConfig": true, } `; @@ -93,6 +100,7 @@ Object { "createLogger": [Function], "esFrom": "source", "extraKbnOpts": undefined, + "logsDir": undefined, "useDefaultConfig": true, } `; @@ -104,6 +112,7 @@ Object { "esFrom": "snapshot", "extraKbnOpts": undefined, "installDir": "foo", + "logsDir": undefined, "useDefaultConfig": true, } `; @@ -114,6 +123,7 @@ Object { "createLogger": [Function], "esFrom": "snapshot", "extraKbnOpts": undefined, + "logsDir": undefined, "useDefaultConfig": true, "verbose": true, } @@ -125,6 +135,7 @@ Object { "createLogger": [Function], "esFrom": "snapshot", "extraKbnOpts": undefined, + "logsDir": undefined, "useDefaultConfig": true, } `; diff --git a/packages/kbn-test/src/functional_tests/cli/start_servers/__snapshots__/cli.test.js.snap b/packages/kbn-test/src/functional_tests/cli/start_servers/__snapshots__/cli.test.js.snap deleted file mode 100644 index ba085b0868216..0000000000000 --- a/packages/kbn-test/src/functional_tests/cli/start_servers/__snapshots__/cli.test.js.snap +++ /dev/null @@ -1,50 +0,0 @@ -// Jest Snapshot v1, https://goo.gl/fbAQLP - -exports[`start servers CLI options accepts boolean value for updateBaselines 1`] = ` -" -functional_tests_server: invalid option [updateBaselines] - ...stack trace... -" -`; - -exports[`start servers CLI options accepts boolean value for updateSnapshots 1`] = ` -" -functional_tests_server: invalid option [updateSnapshots] - ...stack trace... -" -`; - -exports[`start servers CLI options rejects bail 1`] = ` -" -functional_tests_server: invalid option [bail] - ...stack trace... -" -`; - -exports[`start servers CLI options rejects boolean config value 1`] = ` -" -functional_tests_server: invalid argument [true] to option [config] - ...stack trace... -" -`; - -exports[`start servers CLI options rejects boolean value for kibana-install-dir 1`] = ` -" -functional_tests_server: invalid argument [true] to option [kibana-install-dir] - ...stack trace... -" -`; - -exports[`start servers CLI options rejects empty config value if no default passed 1`] = ` -" -functional_tests_server: config is required - ...stack trace... -" -`; - -exports[`start servers CLI options rejects invalid options even if valid options exist 1`] = ` -" -functional_tests_server: invalid option [grep] - ...stack trace... -" -`; diff --git a/packages/kbn-test/src/functional_tests/cli/start_servers/args.js b/packages/kbn-test/src/functional_tests/cli/start_servers/args.js index 527e3ce64613d..e025bdc339331 100644 --- a/packages/kbn-test/src/functional_tests/cli/start_servers/args.js +++ b/packages/kbn-test/src/functional_tests/cli/start_servers/args.js @@ -6,9 +6,11 @@ * Side Public License, v 1. */ -import { resolve } from 'path'; +import Path from 'path'; +import { v4 as uuid } from 'uuid'; import dedent from 'dedent'; +import { REPO_ROOT } from '@kbn/utils'; import { ToolingLog, pickLevelFromFlags } from '@kbn/tooling-log'; const options = { @@ -26,6 +28,9 @@ const options = { arg: '', desc: 'Run Kibana from existing install directory instead of from source.', }, + logToFile: { + desc: 'Write the log output from Kibana/Elasticsearch to files instead of to stdout', + }, verbose: { desc: 'Log everything.' }, debug: { desc: 'Run in debug mode.' }, quiet: { desc: 'Only log errors.' }, @@ -80,16 +85,22 @@ export function processOptions(userOptions, defaultConfigPath) { delete userOptions['kibana-install-dir']; } + const log = new ToolingLog({ + level: pickLevelFromFlags(userOptions), + writeTo: process.stdout, + }); + function createLogger() { - return new ToolingLog({ - level: pickLevelFromFlags(userOptions), - writeTo: process.stdout, - }); + return log; } + const logToFile = !!userOptions.logToFile; + const logsDir = logToFile ? Path.resolve(REPO_ROOT, 'data/ftr_servers_logs', uuid()) : undefined; + return { ...userOptions, - config: resolve(config), + logsDir, + config: Path.resolve(config), useDefaultConfig, createLogger, extraKbnOpts: userOptions._, diff --git a/packages/kbn-test/src/functional_tests/cli/start_servers/cli.js b/packages/kbn-test/src/functional_tests/cli/start_servers/cli.js index df7f8750b2ae3..d57d5c4761f6e 100644 --- a/packages/kbn-test/src/functional_tests/cli/start_servers/cli.js +++ b/packages/kbn-test/src/functional_tests/cli/start_servers/cli.js @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { startServers } from '../../tasks'; +import { startServers, initLogsDir } from '../../tasks'; import { runCli } from '../../lib'; import { processOptions, displayHelp } from './args'; @@ -18,6 +18,7 @@ import { processOptions, displayHelp } from './args'; export async function startServersCli(defaultConfigPath) { await runCli(displayHelp, async (userOptions) => { const options = processOptions(userOptions, defaultConfigPath); + initLogsDir(options); await startServers({ ...options, }); diff --git a/packages/kbn-test/src/functional_tests/cli/start_servers/cli.test.js b/packages/kbn-test/src/functional_tests/cli/start_servers/cli.test.js deleted file mode 100644 index a88e4dbd01169..0000000000000 --- a/packages/kbn-test/src/functional_tests/cli/start_servers/cli.test.js +++ /dev/null @@ -1,192 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import { Writable } from 'stream'; - -import { startServersCli } from './cli'; -import { checkMockConsoleLogSnapshot } from '../../test_helpers'; - -// Note: Stub the startServers function to keep testing only around the cli -// method and arguments. -jest.mock('../../tasks', () => ({ - startServers: jest.fn(), -})); - -describe('start servers CLI', () => { - describe('options', () => { - const originalObjects = { process, console }; - const exitMock = jest.fn(); - const logMock = jest.fn(); // mock logging so we don't send output to the test results - const argvMock = ['foo', 'foo']; - - const processMock = { - exit: exitMock, - argv: argvMock, - stdout: new Writable(), - cwd: jest.fn(), - env: { - ...originalObjects.process.env, - TEST_ES_FROM: 'snapshot', - }, - }; - - beforeAll(() => { - global.process = processMock; - global.console = { log: logMock }; - }); - - afterAll(() => { - global.process = originalObjects.process; - global.console = originalObjects.console; - }); - - beforeEach(() => { - global.process.argv = [...argvMock]; - global.process.env = { - ...originalObjects.process.env, - TEST_ES_FROM: 'snapshot', - }; - jest.resetAllMocks(); - }); - - it('rejects boolean config value', async () => { - global.process.argv.push('--config'); - - await startServersCli(); - - expect(exitMock).toHaveBeenCalledWith(1); - checkMockConsoleLogSnapshot(logMock); - }); - - it('rejects empty config value if no default passed', async () => { - global.process.argv.push('--config', ''); - - await startServersCli(); - - expect(exitMock).toHaveBeenCalledWith(1); - checkMockConsoleLogSnapshot(logMock); - }); - - it('accepts empty config value if default passed', async () => { - global.process.argv.push('--config', ''); - - await startServersCli('foo'); - - expect(exitMock).not.toHaveBeenCalled(); - }); - - it('rejects bail', async () => { - global.process.argv.push('--bail', true); - - await startServersCli('foo'); - - expect(exitMock).toHaveBeenCalledWith(1); - checkMockConsoleLogSnapshot(logMock); - }); - - it('accepts string value for kibana-install-dir', async () => { - global.process.argv.push('--kibana-install-dir', 'foo'); - - await startServersCli('foo'); - - expect(exitMock).not.toHaveBeenCalled(); - }); - - it('rejects boolean value for kibana-install-dir', async () => { - global.process.argv.push('--kibana-install-dir'); - - await startServersCli('foo'); - - expect(exitMock).toHaveBeenCalledWith(1); - checkMockConsoleLogSnapshot(logMock); - }); - - it('accepts boolean value for updateBaselines', async () => { - global.process.argv.push('--updateBaselines'); - - await startServersCli('foo'); - - expect(exitMock).toHaveBeenCalledWith(1); - checkMockConsoleLogSnapshot(logMock); - }); - - it('accepts boolean value for updateSnapshots', async () => { - global.process.argv.push('--updateSnapshots'); - - await startServersCli('foo'); - - expect(exitMock).toHaveBeenCalledWith(1); - checkMockConsoleLogSnapshot(logMock); - }); - - it('accepts source value for esFrom', async () => { - global.process.argv.push('--esFrom', 'source'); - - await startServersCli('foo'); - - expect(exitMock).not.toHaveBeenCalled(); - }); - - it('accepts debug option', async () => { - global.process.argv.push('--debug'); - - await startServersCli('foo'); - - expect(exitMock).not.toHaveBeenCalled(); - }); - - it('accepts silent option', async () => { - global.process.argv.push('--silent'); - - await startServersCli('foo'); - - expect(exitMock).not.toHaveBeenCalled(); - }); - - it('accepts quiet option', async () => { - global.process.argv.push('--quiet'); - - await startServersCli('foo'); - - expect(exitMock).not.toHaveBeenCalled(); - }); - - it('accepts verbose option', async () => { - global.process.argv.push('--verbose'); - - await startServersCli('foo'); - - expect(exitMock).not.toHaveBeenCalled(); - }); - - it('accepts extra server options', async () => { - global.process.argv.push('--', '--server.foo=bar'); - - await startServersCli('foo'); - - expect(exitMock).not.toHaveBeenCalled(); - }); - - it('accepts help option even if invalid options passed', async () => { - global.process.argv.push('--debug', '--grep', '--help'); - - await startServersCli('foo'); - - expect(exitMock).not.toHaveBeenCalledWith(1); - }); - - it('rejects invalid options even if valid options exist', async () => { - global.process.argv.push('--debug', '--grep', '--bail'); - - await startServersCli('foo'); - - expect(exitMock).toHaveBeenCalledWith(1); - checkMockConsoleLogSnapshot(logMock); - }); - }); -}); diff --git a/packages/kbn-test/src/functional_tests/lib/run_elasticsearch.ts b/packages/kbn-test/src/functional_tests/lib/run_elasticsearch.ts index 5dcee56e765e0..b367af4daf492 100644 --- a/packages/kbn-test/src/functional_tests/lib/run_elasticsearch.ts +++ b/packages/kbn-test/src/functional_tests/lib/run_elasticsearch.ts @@ -18,6 +18,7 @@ interface RunElasticsearchOptions { esFrom?: string; config: Config; onEarlyExit?: (msg: string) => void; + logsDir?: string; } interface CcsConfig { @@ -62,26 +63,41 @@ function getEsConfig({ export async function runElasticsearch( options: RunElasticsearchOptions ): Promise<() => Promise> { - const { log } = options; + const { log, logsDir } = options; const config = getEsConfig(options); if (!config.ccsConfig) { - const node = await startEsNode(log, 'ftr', config); + const node = await startEsNode({ + log, + name: 'ftr', + logsDir, + config, + }); return async () => { await node.cleanup(); }; } const remotePort = await getPort(); - const remoteNode = await startEsNode(log, 'ftr-remote', { - ...config, - port: parseInt(new URL(config.ccsConfig.remoteClusterUrl).port, 10), - transportPort: remotePort, + const remoteNode = await startEsNode({ + log, + name: 'ftr-remote', + logsDir, + config: { + ...config, + port: parseInt(new URL(config.ccsConfig.remoteClusterUrl).port, 10), + transportPort: remotePort, + }, }); - const localNode = await startEsNode(log, 'ftr-local', { - ...config, - esArgs: [...config.esArgs, `cluster.remote.ftr-remote.seeds=localhost:${remotePort}`], + const localNode = await startEsNode({ + log, + name: 'ftr-local', + logsDir, + config: { + ...config, + esArgs: [...config.esArgs, `cluster.remote.ftr-remote.seeds=localhost:${remotePort}`], + }, }); return async () => { @@ -90,12 +106,19 @@ export async function runElasticsearch( }; } -async function startEsNode( - log: ToolingLog, - name: string, - config: EsConfig & { transportPort?: number }, - onEarlyExit?: (msg: string) => void -) { +async function startEsNode({ + log, + name, + config, + onEarlyExit, + logsDir, +}: { + log: ToolingLog; + name: string; + config: EsConfig & { transportPort?: number }; + onEarlyExit?: (msg: string) => void; + logsDir?: string; +}) { const cluster = createTestEsCluster({ clusterName: `cluster-${name}`, esArgs: config.esArgs, @@ -106,6 +129,7 @@ async function startEsNode( port: config.port, ssl: config.ssl, log, + writeLogsToPath: logsDir ? resolve(logsDir, `es-cluster-${name}.log`) : undefined, basePath: resolve(REPO_ROOT, '.es'), nodes: [ { diff --git a/packages/kbn-test/src/functional_tests/lib/run_kibana_server.ts b/packages/kbn-test/src/functional_tests/lib/run_kibana_server.ts index 58b77151a9fde..2ae15ca5f83f8 100644 --- a/packages/kbn-test/src/functional_tests/lib/run_kibana_server.ts +++ b/packages/kbn-test/src/functional_tests/lib/run_kibana_server.ts @@ -42,7 +42,11 @@ export async function runKibanaServer({ }: { procs: ProcRunner; config: Config; - options: { installDir?: string; extraKbnOpts?: string[] }; + options: { + installDir?: string; + extraKbnOpts?: string[]; + logsDir?: string; + }; onEarlyExit?: (msg: string) => void; }) { const runOptions = config.get('kbnTestServer.runOptions'); @@ -84,10 +88,14 @@ export async function runKibanaServer({ ...(options.extraKbnOpts ?? []), ]); + const mainName = useTaskRunner ? 'kbn-ui' : 'kibana'; const promises = [ // main process - procs.run(useTaskRunner ? 'kbn-ui' : 'kibana', { + procs.run(mainName, { ...procRunnerOpts, + writeLogsToPath: options.logsDir + ? Path.resolve(options.logsDir, `${mainName}.log`) + : undefined, args: [ ...prefixArgs, ...parseRawFlags([ @@ -110,6 +118,9 @@ export async function runKibanaServer({ promises.push( procs.run('kbn-tasks', { ...procRunnerOpts, + writeLogsToPath: options.logsDir + ? Path.resolve(options.logsDir, 'kbn-tasks.log') + : undefined, args: [ ...prefixArgs, ...parseRawFlags([ diff --git a/packages/kbn-test/src/functional_tests/tasks.ts b/packages/kbn-test/src/functional_tests/tasks.ts index 9b5fb5424f3fe..26504b07544b0 100644 --- a/packages/kbn-test/src/functional_tests/tasks.ts +++ b/packages/kbn-test/src/functional_tests/tasks.ts @@ -6,6 +6,7 @@ * Side Public License, v 1. */ +import Fs from 'fs'; import Path from 'path'; import { setTimeout } from 'timers/promises'; @@ -51,6 +52,16 @@ const makeSuccessMessage = (options: StartServerOptions) => { ); }; +export async function initLogsDir(options: { logsDir?: string; createLogger(): ToolingLog }) { + if (options.logsDir) { + options + .createLogger() + .info(`Kibana/ES logs will be written to ${Path.relative(process.cwd(), options.logsDir)}/`); + + Fs.mkdirSync(options.logsDir, { recursive: true }); + } +} + /** * Run servers and tests for each config */ diff --git a/packages/kbn-typed-react-router-config/src/create_router.test.tsx b/packages/kbn-typed-react-router-config/src/create_router.test.tsx index e0582de320a96..fe4ada218b0b4 100644 --- a/packages/kbn-typed-react-router-config/src/create_router.test.tsx +++ b/packages/kbn-typed-react-router-config/src/create_router.test.tsx @@ -10,6 +10,7 @@ import * as t from 'io-ts'; import { toNumberRt } from '@kbn/io-ts-utils'; import { createRouter } from './create_router'; import { createMemoryHistory } from 'history'; +import { last } from 'lodash'; describe('createRouter', () => { const routes = { @@ -382,4 +383,12 @@ describe('createRouter', () => { ); }); }); + + describe('getRoutePath', () => { + it('returns the correct route path', () => { + expect( + router.getRoutePath(last(router.getRoutesToMatch('/services/opbeans-java/errors'))!) + ).toBe('/services/{serviceName}/errors'); + }); + }); }); diff --git a/packages/kbn-typed-react-router-config/src/create_router.ts b/packages/kbn-typed-react-router-config/src/create_router.ts index f545fa8ed63e3..4430c852b19ed 100644 --- a/packages/kbn-typed-react-router-config/src/create_router.ts +++ b/packages/kbn-typed-react-router-config/src/create_router.ts @@ -208,7 +208,7 @@ export function createRouter(routes: TRoutes): Router< return matchRoutes(...args) as any; }, getRoutePath: (route) => { - return reactRouterConfigsByRoute.get(route)!.path as string; + return route.path; }, getRoutesToMatch: (path: string) => { return getRoutesToMatch(path) as unknown as FlattenRoutesOf; diff --git a/packages/kbn-typed-react-router-config/src/types/index.ts b/packages/kbn-typed-react-router-config/src/types/index.ts index a5121ba0d72c9..f4655c7022db9 100644 --- a/packages/kbn-typed-react-router-config/src/types/index.ts +++ b/packages/kbn-typed-react-router-config/src/types/index.ts @@ -36,7 +36,7 @@ export interface RouteWithPath extends Route { } export interface RouteMatch { - route: TRoute; + route: TRoute & { path: string }; match: { isExact: boolean; path: string; @@ -146,7 +146,7 @@ export interface Router { path: TPath, ...args: TypeAsArgs> ): string; - getRoutePath(route: Route): string; + getRoutePath(route: RouteWithPath): string; getRoutesToMatch(path: string): FlattenRoutesOf; } diff --git a/packages/kbn-user-profile-components/src/user_profiles_popover.test.tsx b/packages/kbn-user-profile-components/src/user_profiles_popover.test.tsx index 6f838631591ce..a68f09cba6a54 100644 --- a/packages/kbn-user-profile-components/src/user_profiles_popover.test.tsx +++ b/packages/kbn-user-profile-components/src/user_profiles_popover.test.tsx @@ -8,10 +8,11 @@ import { shallow } from 'enzyme'; import React from 'react'; +import { UserProfile } from './user_profile'; import { UserProfilesPopover } from './user_profiles_popover'; -const userProfiles = [ +const userProfiles: UserProfile[] = [ { uid: 'u_BOulL4QMPSyV9jg5lQI2JmCkUnokHTazBnet3xVHNv0_0', enabled: true, diff --git a/packages/kbn-user-profile-components/src/user_profiles_popover.tsx b/packages/kbn-user-profile-components/src/user_profiles_popover.tsx index db6964f3fdca2..69558a058a368 100644 --- a/packages/kbn-user-profile-components/src/user_profiles_popover.tsx +++ b/packages/kbn-user-profile-components/src/user_profiles_popover.tsx @@ -7,16 +7,17 @@ */ import type { EuiPopoverProps, EuiContextMenuPanelProps } from '@elastic/eui'; -import type { FunctionComponent } from 'react'; import React from 'react'; import { EuiPopover, EuiContextMenuPanel, useGeneratedHtmlId } from '@elastic/eui'; import { UserProfilesSelectable, UserProfilesSelectableProps } from './user_profiles_selectable'; +import type { UserProfileWithAvatar } from './user_avatar'; /** * Props of {@link UserProfilesPopover} component */ -export interface UserProfilesPopoverProps extends EuiPopoverProps { +export interface UserProfilesPopoverProps