diff --git a/.buildkite/scripts/common/setup_bazel.sh b/.buildkite/scripts/common/setup_bazel.sh index 96cd04fa612fd..e3791dfa393c7 100755 --- a/.buildkite/scripts/common/setup_bazel.sh +++ b/.buildkite/scripts/common/setup_bazel.sh @@ -11,8 +11,29 @@ cat < $KIBANA_DIR/.bazelrc build --build_metadata=ROLE=CI EOF -if [[ "${BAZEL_CACHE_MODE:-none}" == read* ]]; then - echo "[bazel] enabling caching" +BAZEL_CACHE_MODE=${BAZEL_CACHE_MODE:-gcs} + +if [[ "$BAZEL_CACHE_MODE" == "gcs" ]]; then + echo "[bazel] enabling caching with GCS buckets" + + BAZEL_REGION="us-central1" + if [[ "$(curl -is metadata.google.internal || true)" ]]; then + # projects/1003139005402/zones/us-central1-a -> us-central1-a -> us-central1 + BAZEL_REGION=$(curl -sH Metadata-Flavor:Google http://metadata.google.internal/computeMetadata/v1/instance/zone | rev | cut -d'/' -f1 | cut -c3- | rev) + fi + + BAZEL_BUCKET="kibana-ci-bazel_$BAZEL_REGION" + + echo "[bazel] using GCS bucket: $BAZEL_BUCKET" + +cat <> $KIBANA_DIR/.bazelrc + build --remote_cache=https://storage.googleapis.com/$BAZEL_BUCKET + build --google_default_credentials +EOF +fi + +if [[ "$BAZEL_CACHE_MODE" == "buildbuddy" ]]; then + echo "[bazel] enabling caching with Buildbuddy" cat <> $KIBANA_DIR/.bazelrc build --bes_results_url=https://app.buildbuddy.io/invocation/ build --bes_backend=grpcs://remote.buildbuddy.io @@ -22,14 +43,7 @@ cat <> $KIBANA_DIR/.bazelrc EOF fi -if [[ "${BAZEL_CACHE_MODE:-none}" == "read" ]]; then - echo "[bazel] cache set to read-only" -cat <> $KIBANA_DIR/.bazelrc - build --noremote_upload_local_results -EOF -fi - -if [[ "${BAZEL_CACHE_MODE:-none}" != @(read|read-write|none|) ]]; then - echo "invalid value for BAZEL_CACHE_MODE received ($BAZEL_CACHE_MODE), expected one of [read,read-write,none]" +if [[ "$BAZEL_CACHE_MODE" != @(gcs|buildbuddy|none|) ]]; then + echo "invalid value for BAZEL_CACHE_MODE received ($BAZEL_CACHE_MODE), expected one of [gcs,buildbuddy,none]" exit 1 fi diff --git a/.buildkite/scripts/pipelines/pull_request/pipeline.js b/.buildkite/scripts/pipelines/pull_request/pipeline.js index 0f8e46842fd39..35ea19c78cd93 100644 --- a/.buildkite/scripts/pipelines/pull_request/pipeline.js +++ b/.buildkite/scripts/pipelines/pull_request/pipeline.js @@ -20,6 +20,7 @@ const SKIPPABLE_PATHS = [ /^\.github\//, /\.md$/, /^\.backportrc\.json$/, + /^nav-kibana-dev\.docnav\.json$/, ]; const REQUIRED_PATHS = [ diff --git a/.buildkite/scripts/steps/bazel_cache/bootstrap_mac.sh b/.buildkite/scripts/steps/bazel_cache/bootstrap_mac.sh index 1417137f0b6f0..62aabf496fd8a 100755 --- a/.buildkite/scripts/steps/bazel_cache/bootstrap_mac.sh +++ b/.buildkite/scripts/steps/bazel_cache/bootstrap_mac.sh @@ -2,7 +2,7 @@ set -euo pipefail -export BAZEL_CACHE_MODE=read-write +export BAZEL_CACHE_MODE=buildbuddy export DISABLE_BOOTSTRAP_VALIDATION=true # Since our Mac agents are currently static, diff --git a/.buildkite/scripts/steps/on_merge_ts_refs_api_docs.sh b/.buildkite/scripts/steps/on_merge_ts_refs_api_docs.sh index 6d08fbb2c6835..5659db50e1404 100755 --- a/.buildkite/scripts/steps/on_merge_ts_refs_api_docs.sh +++ b/.buildkite/scripts/steps/on_merge_ts_refs_api_docs.sh @@ -2,7 +2,7 @@ set -euo pipefail -export BAZEL_CACHE_MODE=read-write # Populate bazel remote cache for linux +export BAZEL_CACHE_MODE=buildbuddy # Populate Buildbuddy bazel remote cache for linux export BUILD_TS_REFS_CACHE_ENABLE=true export BUILD_TS_REFS_CACHE_CAPTURE=true export DISABLE_BOOTSTRAP_VALIDATION=true diff --git a/.buildkite/scripts/steps/storybooks/build_and_upload.js b/.buildkite/scripts/steps/storybooks/build_and_upload.js index 482640b8d9cc0..becb8f1bd871f 100644 --- a/.buildkite/scripts/steps/storybooks/build_and_upload.js +++ b/.buildkite/scripts/steps/storybooks/build_and_upload.js @@ -20,7 +20,7 @@ const STORYBOOKS = [ 'custom_integrations', 'dashboard_enhanced', 'dashboard', - 'data_enhanced', + 'data', 'embeddable', 'expression_error', 'expression_image', diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 215514d58f601..7f7c048717f02 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -79,7 +79,6 @@ /src/plugins/inspector/ @elastic/kibana-app-services /src/plugins/unified_search/ @elastic/kibana-app-services /x-pack/examples/ui_actions_enhanced_examples/ @elastic/kibana-app-services -/x-pack/plugins/data_enhanced/ @elastic/kibana-app-services /x-pack/plugins/embeddable_enhanced/ @elastic/kibana-app-services /x-pack/plugins/ui_actions_enhanced/ @elastic/kibana-app-services /x-pack/plugins/runtime_fields @elastic/kibana-app-services diff --git a/api_docs/actions.devdocs.json b/api_docs/actions.devdocs.json index 227bba7d93599..b5fd8147b8a2e 100644 --- a/api_docs/actions.devdocs.json +++ b/api_docs/actions.devdocs.json @@ -1,12 +1,209 @@ { "id": "actions", "client": { - "classes": [], + "classes": [ + { + "parentPluginId": "actions", + "id": "def-public.Plugin", + "type": "Class", + "tags": [], + "label": "Plugin", + "description": [], + "signature": [ + { + "pluginId": "actions", + "scope": "public", + "docId": "kibActionsPluginApi", + "section": "def-public.Plugin", + "text": "Plugin" + }, + " implements ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.Plugin", + "text": "Plugin" + }, + "<", + { + "pluginId": "actions", + "scope": "public", + "docId": "kibActionsPluginApi", + "section": "def-public.ActionsPublicPluginSetup", + "text": "ActionsPublicPluginSetup" + }, + ", void, object, object>" + ], + "path": "x-pack/plugins/actions/public/plugin.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-public.Plugin.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "x-pack/plugins/actions/public/plugin.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-public.Plugin.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "ctx", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.PluginInitializerContext", + "text": "PluginInitializerContext" + }, + "<", + "Config", + ">" + ], + "path": "x-pack/plugins/actions/public/plugin.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "actions", + "id": "def-public.Plugin.setup", + "type": "Function", + "tags": [], + "label": "setup", + "description": [], + "signature": [ + "() => ", + { + "pluginId": "actions", + "scope": "public", + "docId": "kibActionsPluginApi", + "section": "def-public.ActionsPublicPluginSetup", + "text": "ActionsPublicPluginSetup" + } + ], + "path": "x-pack/plugins/actions/public/plugin.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "actions", + "id": "def-public.Plugin.start", + "type": "Function", + "tags": [], + "label": "start", + "description": [], + "signature": [ + "() => void" + ], + "path": "x-pack/plugins/actions/public/plugin.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], "functions": [], "interfaces": [], "enums": [], "misc": [], - "objects": [] + "objects": [], + "setup": { + "parentPluginId": "actions", + "id": "def-public.ActionsPublicPluginSetup", + "type": "Interface", + "tags": [], + "label": "ActionsPublicPluginSetup", + "description": [], + "path": "x-pack/plugins/actions/public/plugin.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-public.ActionsPublicPluginSetup.validateEmailAddresses", + "type": "Function", + "tags": [], + "label": "validateEmailAddresses", + "description": [], + "signature": [ + "(emails: string[], options?: ", + { + "pluginId": "actions", + "scope": "common", + "docId": "kibActionsPluginApi", + "section": "def-common.ValidateEmailAddressesOptions", + "text": "ValidateEmailAddressesOptions" + }, + " | undefined) => ", + { + "pluginId": "actions", + "scope": "common", + "docId": "kibActionsPluginApi", + "section": "def-common.ValidatedEmail", + "text": "ValidatedEmail" + }, + "[]" + ], + "path": "x-pack/plugins/actions/public/plugin.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-public.ActionsPublicPluginSetup.validateEmailAddresses.$1", + "type": "Array", + "tags": [], + "label": "emails", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/actions/public/plugin.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "actions", + "id": "def-public.ActionsPublicPluginSetup.validateEmailAddresses.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "actions", + "scope": "common", + "docId": "kibActionsPluginApi", + "section": "def-common.ValidateEmailAddressesOptions", + "text": "ValidateEmailAddressesOptions" + }, + " | undefined" + ], + "path": "x-pack/plugins/actions/public/plugin.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + } + ], + "lifecycle": "setup", + "initialIsOpen": true + } }, "server": { "classes": [], @@ -181,6 +378,16 @@ "description": [], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false + }, + { + "parentPluginId": "actions", + "id": "def-server.ActionResult.isDeprecated", + "type": "boolean", + "tags": [], + "label": "isDeprecated", + "description": [], + "path": "x-pack/plugins/actions/server/types.ts", + "deprecated": false } ], "initialIsOpen": false @@ -738,7 +945,7 @@ "label": "ActionParamsType", "description": [], "signature": [ - "{ readonly source?: string | undefined; readonly summary?: string | undefined; readonly group?: string | undefined; readonly timestamp?: string | undefined; readonly eventAction?: \"resolve\" | \"trigger\" | \"acknowledge\" | undefined; readonly dedupKey?: string | undefined; readonly severity?: \"error\" | \"info\" | \"warning\" | \"critical\" | undefined; readonly component?: string | undefined; readonly class?: string | undefined; }" + "{ readonly source?: string | undefined; readonly summary?: string | undefined; readonly group?: string | undefined; readonly timestamp?: string | undefined; readonly eventAction?: \"resolve\" | \"trigger\" | \"acknowledge\" | undefined; readonly dedupKey?: string | undefined; readonly severity?: \"error\" | \"warning\" | \"info\" | \"critical\" | undefined; readonly component?: string | undefined; readonly class?: string | undefined; }" ], "path": "x-pack/plugins/actions/server/builtin_action_types/pagerduty.ts", "deprecated": false, @@ -1586,6 +1793,85 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "actions", + "id": "def-common.hasMustacheTemplate", + "type": "Function", + "tags": [], + "label": "hasMustacheTemplate", + "description": [ + "does the string contain `{{.*}}`?" + ], + "signature": [ + "(string: string) => boolean" + ], + "path": "x-pack/plugins/actions/common/mustache_template.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-common.hasMustacheTemplate.$1", + "type": "string", + "tags": [], + "label": "string", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/actions/common/mustache_template.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "actions", + "id": "def-common.invalidEmailsAsMessage", + "type": "Function", + "tags": [], + "label": "invalidEmailsAsMessage", + "description": [], + "signature": [ + "(validatedEmails: ", + { + "pluginId": "actions", + "scope": "common", + "docId": "kibActionsPluginApi", + "section": "def-common.ValidatedEmail", + "text": "ValidatedEmail" + }, + "[]) => string | undefined" + ], + "path": "x-pack/plugins/actions/common/validate_email_addresses.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-common.invalidEmailsAsMessage.$1", + "type": "Array", + "tags": [], + "label": "validatedEmails", + "description": [], + "signature": [ + { + "pluginId": "actions", + "scope": "common", + "docId": "kibActionsPluginApi", + "section": "def-common.ValidatedEmail", + "text": "ValidatedEmail" + }, + "[]" + ], + "path": "x-pack/plugins/actions/common/validate_email_addresses.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "actions", "id": "def-common.isActionTypeExecutorResult", @@ -1616,70 +1902,249 @@ ], "returnComment": [], "initialIsOpen": false - } - ], - "interfaces": [ + }, { "parentPluginId": "actions", - "id": "def-common.ActionResult", - "type": "Interface", + "id": "def-common.validateEmailAddresses", + "type": "Function", "tags": [], - "label": "ActionResult", + "label": "validateEmailAddresses", "description": [], - "path": "x-pack/plugins/actions/common/types.ts", - "deprecated": false, - "children": [ + "signature": [ + "(allowedDomains: string[] | null, addresses: string[], options: ", { - "parentPluginId": "actions", - "id": "def-common.ActionResult.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "path": "x-pack/plugins/actions/common/types.ts", - "deprecated": false + "pluginId": "actions", + "scope": "common", + "docId": "kibActionsPluginApi", + "section": "def-common.ValidateEmailAddressesOptions", + "text": "ValidateEmailAddressesOptions" }, + ") => ", { - "parentPluginId": "actions", - "id": "def-common.ActionResult.actionTypeId", - "type": "string", - "tags": [], - "label": "actionTypeId", - "description": [], - "path": "x-pack/plugins/actions/common/types.ts", - "deprecated": false + "pluginId": "actions", + "scope": "common", + "docId": "kibActionsPluginApi", + "section": "def-common.ValidatedEmail", + "text": "ValidatedEmail" }, + "[]" + ], + "path": "x-pack/plugins/actions/common/validate_email_addresses.ts", + "deprecated": false, + "children": [ { "parentPluginId": "actions", - "id": "def-common.ActionResult.name", - "type": "string", + "id": "def-common.validateEmailAddresses.$1", + "type": "CompoundType", "tags": [], - "label": "name", + "label": "allowedDomains", "description": [], - "path": "x-pack/plugins/actions/common/types.ts", - "deprecated": false + "signature": [ + "string[] | null" + ], + "path": "x-pack/plugins/actions/common/validate_email_addresses.ts", + "deprecated": false, + "isRequired": false }, { "parentPluginId": "actions", - "id": "def-common.ActionResult.config", - "type": "Object", + "id": "def-common.validateEmailAddresses.$2", + "type": "Array", "tags": [], - "label": "config", + "label": "addresses", "description": [], "signature": [ - "{ [x: string]: any; }" + "string[]" ], - "path": "x-pack/plugins/actions/common/types.ts", - "deprecated": false + "path": "x-pack/plugins/actions/common/validate_email_addresses.ts", + "deprecated": false, + "isRequired": true }, { "parentPluginId": "actions", - "id": "def-common.ActionResult.isPreconfigured", - "type": "boolean", + "id": "def-common.validateEmailAddresses.$3", + "type": "Object", "tags": [], - "label": "isPreconfigured", + "label": "options", "description": [], - "path": "x-pack/plugins/actions/common/types.ts", + "signature": [ + { + "pluginId": "actions", + "scope": "common", + "docId": "kibActionsPluginApi", + "section": "def-common.ValidateEmailAddressesOptions", + "text": "ValidateEmailAddressesOptions" + } + ], + "path": "x-pack/plugins/actions/common/validate_email_addresses.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "actions", + "id": "def-common.validateEmailAddressesAsAlwaysValid", + "type": "Function", + "tags": [], + "label": "validateEmailAddressesAsAlwaysValid", + "description": [], + "signature": [ + "(addresses: string[]) => ", + { + "pluginId": "actions", + "scope": "common", + "docId": "kibActionsPluginApi", + "section": "def-common.ValidatedEmail", + "text": "ValidatedEmail" + }, + "[]" + ], + "path": "x-pack/plugins/actions/common/validate_email_addresses.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-common.validateEmailAddressesAsAlwaysValid.$1", + "type": "Array", + "tags": [], + "label": "addresses", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/actions/common/validate_email_addresses.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "actions", + "id": "def-common.withoutMustacheTemplate", + "type": "Function", + "tags": [], + "label": "withoutMustacheTemplate", + "description": [ + "filter strings that do not contain `{{.*}}`" + ], + "signature": [ + "(strings: string[]) => string[]" + ], + "path": "x-pack/plugins/actions/common/mustache_template.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-common.withoutMustacheTemplate.$1", + "type": "Array", + "tags": [], + "label": "strings", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/actions/common/mustache_template.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "actions", + "id": "def-common.ActionResult", + "type": "Interface", + "tags": [], + "label": "ActionResult", + "description": [], + "path": "x-pack/plugins/actions/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-common.ActionResult.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "x-pack/plugins/actions/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "actions", + "id": "def-common.ActionResult.actionTypeId", + "type": "string", + "tags": [], + "label": "actionTypeId", + "description": [], + "path": "x-pack/plugins/actions/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "actions", + "id": "def-common.ActionResult.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "path": "x-pack/plugins/actions/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "actions", + "id": "def-common.ActionResult.config", + "type": "Object", + "tags": [], + "label": "config", + "description": [], + "signature": [ + "{ [x: string]: any; }" + ], + "path": "x-pack/plugins/actions/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "actions", + "id": "def-common.ActionResult.isPreconfigured", + "type": "boolean", + "tags": [], + "label": "isPreconfigured", + "description": [], + "path": "x-pack/plugins/actions/common/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "actions", + "id": "def-common.ActionsPublicConfigType", + "type": "Interface", + "tags": [], + "label": "ActionsPublicConfigType", + "description": [], + "path": "x-pack/plugins/actions/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-common.ActionsPublicConfigType.allowedEmailDomains", + "type": "Array", + "tags": [], + "label": "allowedEmailDomains", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false } ], @@ -1858,6 +2323,165 @@ } ], "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, + "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 + }, + { + "parentPluginId": "actions", + "id": "def-common.SNProductsConfigValue.appScope", + "type": "string", + "tags": [], + "label": "appScope", + "description": [], + "path": "x-pack/plugins/actions/common/servicenow_config.ts", + "deprecated": 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 + }, + { + "parentPluginId": "actions", + "id": "def-common.SNProductsConfigValue.importSetTable", + "type": "string", + "tags": [], + "label": "importSetTable", + "description": [], + "path": "x-pack/plugins/actions/common/servicenow_config.ts", + "deprecated": 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 + }, + { + "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 + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "actions", + "id": "def-common.ValidatedEmail", + "type": "Interface", + "tags": [], + "label": "ValidatedEmail", + "description": [], + "path": "x-pack/plugins/actions/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-common.ValidatedEmail.address", + "type": "string", + "tags": [], + "label": "address", + "description": [], + "path": "x-pack/plugins/actions/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "actions", + "id": "def-common.ValidatedEmail.valid", + "type": "boolean", + "tags": [], + "label": "valid", + "description": [], + "path": "x-pack/plugins/actions/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "actions", + "id": "def-common.ValidatedEmail.reason", + "type": "CompoundType", + "tags": [], + "label": "reason", + "description": [], + "signature": [ + { + "pluginId": "actions", + "scope": "common", + "docId": "kibActionsPluginApi", + "section": "def-common.InvalidEmailReason", + "text": "InvalidEmailReason" + }, + " | undefined" + ], + "path": "x-pack/plugins/actions/common/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "actions", + "id": "def-common.ValidateEmailAddressesOptions", + "type": "Interface", + "tags": [], + "label": "ValidateEmailAddressesOptions", + "description": [ + "Options that can be used when validating email addresses" + ], + "path": "x-pack/plugins/actions/common/validate_email_addresses.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-common.ValidateEmailAddressesOptions.treatMustacheTemplatesAsValid", + "type": "CompoundType", + "tags": [], + "label": "treatMustacheTemplatesAsValid", + "description": [ + "treat any address which contains a mustache template as valid" + ], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/actions/common/validate_email_addresses.ts", + "deprecated": false + } + ], + "initialIsOpen": false } ], "enums": [ @@ -1871,6 +2495,17 @@ "path": "x-pack/plugins/actions/common/index.ts", "deprecated": false, "initialIsOpen": false + }, + { + "parentPluginId": "actions", + "id": "def-common.InvalidEmailReason", + "type": "Enum", + "tags": [], + "label": "InvalidEmailReason", + "description": [], + "path": "x-pack/plugins/actions/common/types.ts", + "deprecated": false, + "initialIsOpen": false } ], "misc": [ @@ -1969,6 +2604,34 @@ "deprecated": 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, + "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, + "initialIsOpen": false + }, { "parentPluginId": "actions", "id": "def-common.INTERNAL_BASE_ACTION_API_PATH", @@ -2066,8 +2729,343 @@ } ], "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, + "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, + "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, + "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, + "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, + "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, + "initialIsOpen": false } ], - "objects": [] + "objects": [ + { + "parentPluginId": "actions", + "id": "def-common.MustacheInEmailRegExp", + "type": "Object", + "tags": [], + "label": "MustacheInEmailRegExp", + "description": [], + "signature": [ + "RegExp" + ], + "path": "x-pack/plugins/actions/common/mustache_template.ts", + "deprecated": false, + "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, + "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, + "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 + }, + { + "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 + }, + { + "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 + }, + { + "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 + }, + { + "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 + }, + { + "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 + } + ] + }, + { + "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, + "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 + }, + { + "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 + }, + { + "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 + }, + { + "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 + }, + { + "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 + }, + { + "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 + } + ] + }, + { + "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, + "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 + }, + { + "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 + }, + { + "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 + }, + { + "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 + }, + { + "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 + } + ] + } + ], + "initialIsOpen": false + } + ] } } \ No newline at end of file diff --git a/api_docs/actions.mdx b/api_docs/actions.mdx index 72bb9168e149d..267f24e44374c 100644 --- a/api_docs/actions.mdx +++ b/api_docs/actions.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/actions title: "actions" image: https://source.unsplash.com/400x175/?github summary: API docs for the actions plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,15 @@ Contact [Response Ops](https://github.com/orgs/elastic/teams/response-ops) for q | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 127 | 0 | 127 | 10 | +| 195 | 0 | 191 | 11 | + +## Client + +### Setup + + +### Classes + ## Server @@ -39,6 +47,9 @@ Contact [Response Ops](https://github.com/orgs/elastic/teams/response-ops) for q ## Common +### Objects + + ### Functions diff --git a/api_docs/advanced_settings.mdx b/api_docs/advanced_settings.mdx index ae965957eacb7..4403e9604c11a 100644 --- a/api_docs/advanced_settings.mdx +++ b/api_docs/advanced_settings.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/advancedSettings title: "advancedSettings" image: https://source.unsplash.com/400x175/?github summary: API docs for the advancedSettings plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/alerting.devdocs.json b/api_docs/alerting.devdocs.json index dcaed350c4882..a7c437fda9dbf 100644 --- a/api_docs/alerting.devdocs.json +++ b/api_docs/alerting.devdocs.json @@ -2456,20 +2456,6 @@ ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false - }, - { - "parentPluginId": "alerting", - "id": "def-server.RuleType.config", - "type": "Object", - "tags": [], - "label": "config", - "description": [], - "signature": [ - "RuleTypeConfig", - " | undefined" - ], - "path": "x-pack/plugins/alerting/server/types.ts", - "deprecated": false } ], "initialIsOpen": false @@ -3889,10 +3875,10 @@ }, { "parentPluginId": "alerting", - "id": "def-common.IExecutionLog.num_scheduled_actions", + "id": "def-common.IExecutionLog.num_generated_actions", "type": "number", "tags": [], - "label": "num_scheduled_actions", + "label": "num_generated_actions", "description": [], "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false @@ -4547,72 +4533,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "alerting", - "id": "def-common.RuleExecutionRunResult", - "type": "Interface", - "tags": [], - "label": "RuleExecutionRunResult", - "description": [], - "path": "x-pack/plugins/alerting/common/rule_task_instance.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "alerting", - "id": "def-common.RuleExecutionRunResult.state", - "type": "CompoundType", - "tags": [], - "label": "state", - "description": [], - "signature": [ - "{ alertTypeState?: { [x: string]: unknown; } | undefined; alertInstances?: { [x: string]: { state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; } | undefined; }; } | undefined; previousStartedAt?: Date | null | undefined; } & { metrics: { numSearches?: number | undefined; totalSearchDurationMs?: number | undefined; esSearchDurationMs?: number | undefined; }; alertExecutionStore: { numberOfTriggeredActions?: number | undefined; numberOfScheduledActions?: number | undefined; triggeredActionsStatus?: string | undefined; }; }" - ], - "path": "x-pack/plugins/alerting/common/rule_task_instance.ts", - "deprecated": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.RuleExecutionRunResult.monitoring", - "type": "Object", - "tags": [], - "label": "monitoring", - "description": [], - "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.RuleMonitoring", - "text": "RuleMonitoring" - }, - " | undefined" - ], - "path": "x-pack/plugins/alerting/common/rule_task_instance.ts", - "deprecated": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.RuleExecutionRunResult.schedule", - "type": "Object", - "tags": [], - "label": "schedule", - "description": [], - "signature": [ - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.IntervalSchedule", - "text": "IntervalSchedule" - }, - " | undefined" - ], - "path": "x-pack/plugins/alerting/common/rule_task_instance.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "alerting", "id": "def-common.RuleExecutionStatus", @@ -4631,46 +4551,7 @@ "label": "status", "description": [], "signature": [ - "\"error\" | \"unknown\" | \"warning\" | \"pending\" | \"ok\" | \"active\"" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.RuleExecutionStatus.numberOfTriggeredActions", - "type": "number", - "tags": [], - "label": "numberOfTriggeredActions", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.RuleExecutionStatus.numberOfScheduledActions", - "type": "number", - "tags": [], - "label": "numberOfScheduledActions", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "x-pack/plugins/alerting/common/rule.ts", - "deprecated": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.RuleExecutionStatus.metrics", - "type": "Object", - "tags": [], - "label": "metrics", - "description": [], - "signature": [ - "{ numSearches?: number | undefined; totalSearchDurationMs?: number | undefined; esSearchDurationMs?: number | undefined; } | undefined" + "\"error\" | \"warning\" | \"unknown\" | \"pending\" | \"ok\" | \"active\"" ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false @@ -5103,6 +4984,17 @@ } ], "enums": [ + { + "parentPluginId": "alerting", + "id": "def-common.ActionsCompletion", + "type": "Enum", + "tags": [], + "label": "ActionsCompletion", + "description": [], + "path": "x-pack/plugins/alerting/common/rule_task_instance.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "alerting", "id": "def-common.HealthStatus", @@ -5263,7 +5155,7 @@ "label": "ExecutionLogSortFields", "description": [], "signature": [ - "\"timestamp\" | \"execution_duration\" | \"total_search_duration\" | \"es_search_duration\" | \"schedule_delay\" | \"num_triggered_actions\" | \"num_scheduled_actions\"" + "\"timestamp\" | \"execution_duration\" | \"total_search_duration\" | \"es_search_duration\" | \"schedule_delay\" | \"num_triggered_actions\" | \"num_generated_actions\"" ], "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, @@ -5463,34 +5355,6 @@ "deprecated": false, "initialIsOpen": false }, - { - "parentPluginId": "alerting", - "id": "def-common.RuleExecutionMetrics", - "type": "Type", - "tags": [], - "label": "RuleExecutionMetrics", - "description": [], - "signature": [ - "{ numSearches?: number | undefined; totalSearchDurationMs?: number | undefined; esSearchDurationMs?: number | undefined; }" - ], - "path": "x-pack/plugins/alerting/common/rule_task_instance.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "alerting", - "id": "def-common.RuleExecutionState", - "type": "Type", - "tags": [], - "label": "RuleExecutionState", - "description": [], - "signature": [ - "{ alertTypeState?: { [x: string]: unknown; } | undefined; alertInstances?: { [x: string]: { state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; } | undefined; }; } | undefined; previousStartedAt?: Date | null | undefined; } & { metrics: { numSearches?: number | undefined; totalSearchDurationMs?: number | undefined; esSearchDurationMs?: number | undefined; }; alertExecutionStore: { numberOfTriggeredActions?: number | undefined; numberOfScheduledActions?: number | undefined; triggeredActionsStatus?: string | undefined; }; }" - ], - "path": "x-pack/plugins/alerting/common/rule_task_instance.ts", - "deprecated": false, - "initialIsOpen": false - }, { "parentPluginId": "alerting", "id": "def-common.RuleExecutionStatuses", @@ -5499,7 +5363,7 @@ "label": "RuleExecutionStatuses", "description": [], "signature": [ - "\"error\" | \"unknown\" | \"warning\" | \"pending\" | \"ok\" | \"active\"" + "\"error\" | \"warning\" | \"unknown\" | \"pending\" | \"ok\" | \"active\"" ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, @@ -5750,7 +5614,7 @@ "label": "executionLogSortableColumns", "description": [], "signature": [ - "readonly [\"timestamp\", \"execution_duration\", \"total_search_duration\", \"es_search_duration\", \"schedule_delay\", \"num_triggered_actions\", \"num_scheduled_actions\"]" + "readonly [\"timestamp\", \"execution_duration\", \"total_search_duration\", \"es_search_duration\", \"schedule_delay\", \"num_triggered_actions\", \"num_generated_actions\"]" ], "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, diff --git a/api_docs/alerting.mdx b/api_docs/alerting.mdx index 8ed04bc845f1a..cc9c60a87987e 100644 --- a/api_docs/alerting.mdx +++ b/api_docs/alerting.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/alerting title: "alerting" image: https://source.unsplash.com/400x175/?github summary: API docs for the alerting plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Response Ops](https://github.com/orgs/elastic/teams/response-ops) for q | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 334 | 0 | 325 | 20 | +| 325 | 0 | 316 | 19 | ## Client diff --git a/api_docs/apm.devdocs.json b/api_docs/apm.devdocs.json index bd88217f34fc3..302f8c93bdea9 100644 --- a/api_docs/apm.devdocs.json +++ b/api_docs/apm.devdocs.json @@ -345,12 +345,43 @@ { "parentPluginId": "apm", "id": "def-server.APMRouteHandlerResources.context", - "type": "Object", + "type": "CompoundType", "tags": [], "label": "context", "description": [], "signature": [ - "ApmPluginRequestHandlerContext" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.RequestHandlerContext", + "text": "RequestHandlerContext" + }, + " & { licensing: Promise<", + { + "pluginId": "licensing", + "scope": "server", + "docId": "kibLicensingPluginApi", + "section": "def-server.LicensingApiRequestHandlerContext", + "text": "LicensingApiRequestHandlerContext" + }, + ">; alerting: Promise<", + { + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.AlertingApiRequestHandlerContext", + "text": "AlertingApiRequestHandlerContext" + }, + ">; rac: Promise<", + { + "pluginId": "ruleRegistry", + "scope": "server", + "docId": "kibRuleRegistryPluginApi", + "section": "def-server.RacApiRequestHandlerContext", + "text": "RacApiRequestHandlerContext" + }, + ">; }" ], "path": "x-pack/plugins/apm/server/routes/typings.ts", "deprecated": false @@ -491,7 +522,7 @@ "section": "def-server.RequestHandlerContext", "text": "RequestHandlerContext" }, - " & { licensing: ", + " & { licensing: Promise<", { "pluginId": "licensing", "scope": "server", @@ -499,7 +530,7 @@ "section": "def-server.LicensingApiRequestHandlerContext", "text": "LicensingApiRequestHandlerContext" }, - "; }, request: ", + ">; }, request: ", { "pluginId": "core", "scope": "server", @@ -2979,7 +3010,11 @@ "Type", "; end: ", "Type", - "; }>]>; }>, ", + "; }>, ", + "TypeC", + "<{ probability: ", + "Type", + "; }>]>; }>, ", { "pluginId": "apm", "scope": "server", @@ -4010,6 +4045,8 @@ "<{ query: ", "IntersectionC", "<[", + "IntersectionC", + "<[", "TypeC", "<{ environment: ", "UnionC", @@ -4039,6 +4076,10 @@ "StringC", "; }>, ", "TypeC", + "<{ probability: ", + "Type", + "; }>]>, ", + "TypeC", "<{ serviceNames: ", "Type", "; }>]>; }>, ", @@ -4085,7 +4126,11 @@ "PartialC", "<{ serviceGroup: ", "StringC", - "; }>]>; }>, ", + "; }>, ", + "TypeC", + "<{ probability: ", + "Type", + "; }>]>; }>, ", { "pluginId": "apm", "scope": "server", @@ -5219,12 +5264,43 @@ { "parentPluginId": "apm", "id": "def-server.APMPluginSetup.createApmEventClient.$1.context", - "type": "Object", + "type": "CompoundType", "tags": [], "label": "context", "description": [], "signature": [ - "ApmPluginRequestHandlerContext" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.RequestHandlerContext", + "text": "RequestHandlerContext" + }, + " & { licensing: Promise<", + { + "pluginId": "licensing", + "scope": "server", + "docId": "kibLicensingPluginApi", + "section": "def-server.LicensingApiRequestHandlerContext", + "text": "LicensingApiRequestHandlerContext" + }, + ">; alerting: Promise<", + { + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.AlertingApiRequestHandlerContext", + "text": "AlertingApiRequestHandlerContext" + }, + ">; rac: Promise<", + { + "pluginId": "ruleRegistry", + "scope": "server", + "docId": "kibRuleRegistryPluginApi", + "section": "def-server.RacApiRequestHandlerContext", + "text": "RacApiRequestHandlerContext" + }, + ">; }" ], "path": "x-pack/plugins/apm/server/types.ts", "deprecated": false diff --git a/api_docs/apm.mdx b/api_docs/apm.mdx index 2337384644551..9dd3c0c89fdf4 100644 --- a/api_docs/apm.mdx +++ b/api_docs/apm.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/apm title: "apm" image: https://source.unsplash.com/400x175/?github summary: API docs for the apm plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/banners.devdocs.json b/api_docs/banners.devdocs.json index eae41491a43d2..d370967767d93 100644 --- a/api_docs/banners.devdocs.json +++ b/api_docs/banners.devdocs.json @@ -38,7 +38,7 @@ "label": "placement", "description": [], "signature": [ - "\"top\" | \"disabled\"" + "\"disabled\" | \"top\"" ], "path": "x-pack/plugins/banners/common/types.ts", "deprecated": false @@ -129,7 +129,7 @@ "label": "BannerPlacement", "description": [], "signature": [ - "\"top\" | \"disabled\"" + "\"disabled\" | \"top\"" ], "path": "x-pack/plugins/banners/common/types.ts", "deprecated": false, diff --git a/api_docs/banners.mdx b/api_docs/banners.mdx index 732a3f841f0c3..e22924610e9ae 100644 --- a/api_docs/banners.mdx +++ b/api_docs/banners.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/banners title: "banners" image: https://source.unsplash.com/400x175/?github summary: API docs for the banners plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/bfetch.mdx b/api_docs/bfetch.mdx index c19e0fecea759..2b2f9e84817e5 100644 --- a/api_docs/bfetch.mdx +++ b/api_docs/bfetch.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/bfetch title: "bfetch" image: https://source.unsplash.com/400x175/?github summary: API docs for the bfetch plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/canvas.mdx b/api_docs/canvas.mdx index 623e6529ac3f4..cc1fdd45c597c 100644 --- a/api_docs/canvas.mdx +++ b/api_docs/canvas.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/canvas title: "canvas" image: https://source.unsplash.com/400x175/?github summary: API docs for the canvas plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/cases.devdocs.json b/api_docs/cases.devdocs.json index 76d0d7ae642cc..a78b058751b23 100644 --- a/api_docs/cases.devdocs.json +++ b/api_docs/cases.devdocs.json @@ -1348,7 +1348,9 @@ "type": "string", "tags": [], "label": "SECURITY_SOLUTION_OWNER", - "description": [], + "description": [ + "\nOwner" + ], "signature": [ "\"securitySolution\"" ], diff --git a/api_docs/cases.mdx b/api_docs/cases.mdx index 9ec7594d975cd..3b1c2a5e78c50 100644 --- a/api_docs/cases.mdx +++ b/api_docs/cases.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/cases title: "cases" image: https://source.unsplash.com/400x175/?github summary: API docs for the cases plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [ResponseOps](https://github.com/orgs/elastic/teams/response-ops) for qu | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 71 | 0 | 58 | 19 | +| 71 | 0 | 57 | 19 | ## Client diff --git a/api_docs/charts.devdocs.json b/api_docs/charts.devdocs.json index d65c1a3de92dc..584443f5b46dc 100644 --- a/api_docs/charts.devdocs.json +++ b/api_docs/charts.devdocs.json @@ -9,29 +9,68 @@ "type": "Function", "tags": [], "label": "ColorPicker", - "description": [], + "description": [ + "\nA `ColorPicker` component that is wrapped by the `withSuspense` HOC. This component can\nbe used directly by consumers and will load the `ColorPickerLazy` component lazily with\na predefined fallback and error boundary." + ], "signature": [ - "({ onChange, color: selectedColor, label, useLegacyColors, colorIsOverwritten, onKeyDown, maxDepth, layerIndex, }: ColorPickerProps) => JSX.Element" + "React.ForwardRefExoticComponent<", + "ColorPickerProps", + " & React.RefAttributes<{}>>" ], - "path": "src/plugins/charts/public/static/components/color_picker.tsx", + "path": "src/plugins/charts/public/static/components/index.ts", "deprecated": false, + "returnComment": [], "children": [ { "parentPluginId": "charts", "id": "def-public.ColorPicker.$1", - "type": "Object", + "type": "Uncategorized", "tags": [], - "label": "{\n onChange,\n color: selectedColor,\n label,\n useLegacyColors = true,\n colorIsOverwritten = true,\n onKeyDown,\n maxDepth,\n layerIndex,\n}", + "label": "props", "description": [], "signature": [ - "ColorPickerProps" + "P" ], - "path": "src/plugins/charts/public/static/components/color_picker.tsx", - "deprecated": false, - "isRequired": true + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false } ], + "initialIsOpen": false + }, + { + "parentPluginId": "charts", + "id": "def-public.ColorPickerLazy", + "type": "Function", + "tags": [], + "label": "ColorPickerLazy", + "description": [ + "\nThe Lazily-loaded `ColorPicker` component. Consumers should use `React.Suspense` or\nthe withSuspense` HOC to load this component." + ], + "signature": [ + "React.ExoticComponent<", + "ColorPickerProps", + "> & { readonly _result: ({ onChange, color: selectedColor, label, useLegacyColors, colorIsOverwritten, onKeyDown, maxDepth, layerIndex, }: ", + "ColorPickerProps", + ") => JSX.Element; }" + ], + "path": "src/plugins/charts/public/static/components/index.ts", + "deprecated": false, "returnComment": [], + "children": [ + { + "parentPluginId": "charts", + "id": "def-public.ColorPickerLazy.$1", + "type": "Uncategorized", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -108,9 +147,9 @@ "label": "EmptyPlaceholder", "description": [], "signature": [ - "({ icon, iconColor, message, dataTestSubj, className, }: { icon: ", - "IconType", - "; iconColor?: string | undefined; message?: JSX.Element | undefined; dataTestSubj?: string | undefined; className?: string | undefined; }) => JSX.Element" + "({ icon, iconColor, message, dataTestSubj, className, }: ", + "EmptyPlaceholderProps", + ") => JSX.Element" ], "path": "src/plugins/charts/public/static/components/empty_placeholder.tsx", "deprecated": false, @@ -122,75 +161,12 @@ "tags": [], "label": "{\n icon,\n iconColor = 'subdued',\n message = ,\n dataTestSubj = 'emptyPlaceholder',\n className,\n}", "description": [], + "signature": [ + "EmptyPlaceholderProps" + ], "path": "src/plugins/charts/public/static/components/empty_placeholder.tsx", "deprecated": false, - "children": [ - { - "parentPluginId": "charts", - "id": "def-public.EmptyPlaceholder.$1.icon", - "type": "CompoundType", - "tags": [], - "label": "icon", - "description": [], - "signature": [ - "string | React.ComponentType<{}>" - ], - "path": "src/plugins/charts/public/static/components/empty_placeholder.tsx", - "deprecated": false - }, - { - "parentPluginId": "charts", - "id": "def-public.EmptyPlaceholder.$1.iconColor", - "type": "string", - "tags": [], - "label": "iconColor", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/charts/public/static/components/empty_placeholder.tsx", - "deprecated": false - }, - { - "parentPluginId": "charts", - "id": "def-public.EmptyPlaceholder.$1.message", - "type": "Object", - "tags": [], - "label": "message", - "description": [], - "signature": [ - "JSX.Element | undefined" - ], - "path": "src/plugins/charts/public/static/components/empty_placeholder.tsx", - "deprecated": false - }, - { - "parentPluginId": "charts", - "id": "def-public.EmptyPlaceholder.$1.dataTestSubj", - "type": "string", - "tags": [], - "label": "dataTestSubj", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/charts/public/static/components/empty_placeholder.tsx", - "deprecated": false - }, - { - "parentPluginId": "charts", - "id": "def-public.EmptyPlaceholder.$1.className", - "type": "string", - "tags": [], - "label": "className", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/charts/public/static/components/empty_placeholder.tsx", - "deprecated": false - } - ] + "isRequired": true } ], "returnComment": [], @@ -628,11 +604,15 @@ "type": "Function", "tags": [], "label": "LegendToggle", - "description": [], + "description": [ + "\nA `LegendToggle` component that is wrapped by the `withSuspense` HOC. This component can\nbe used directly by consumers and will load the `LegendToggleLazy` component lazily with\na predefined fallback and error boundary." + ], "signature": [ - "React.NamedExoticComponent & { readonly type: ({ onClick, showLegend, legendPosition }: LegendToggleProps) => JSX.Element; }" + "React.ForwardRefExoticComponent<", + "LegendToggleProps", + " & React.RefAttributes<{}>>" ], - "path": "src/plugins/charts/public/static/components/legend_toggle.tsx", + "path": "src/plugins/charts/public/static/components/index.ts", "deprecated": false, "returnComment": [], "children": [ @@ -652,6 +632,42 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "charts", + "id": "def-public.LegendToggleLazy", + "type": "Function", + "tags": [], + "label": "LegendToggleLazy", + "description": [ + "\nThe Lazily-loaded `LegendToggle` component. Consumers should use `React.Suspense` or\nthe withSuspense` HOC to load this component." + ], + "signature": [ + "React.ExoticComponent<", + "LegendToggleProps", + "> & { readonly _result: React.MemoExoticComponent<({ onClick, showLegend, legendPosition }: ", + "LegendToggleProps", + ") => JSX.Element>; }" + ], + "path": "src/plugins/charts/public/static/components/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "charts", + "id": "def-public.LegendToggleLazy.$1", + "type": "Uncategorized", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "charts", "id": "def-public.lightenColor", @@ -866,6 +882,26 @@ ], "returnComment": [], "initialIsOpen": false + }, + { + "parentPluginId": "charts", + "id": "def-public.useCommonChartStyles", + "type": "Function", + "tags": [], + "label": "useCommonChartStyles", + "description": [], + "signature": [ + "() => { chartIcon: { subdued: ", + "SerializedStyles", + "; accent: ", + "SerializedStyles", + "; }; }" + ], + "path": "src/plugins/charts/public/static/components/common_chart_styles.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false } ], "interfaces": [ @@ -916,81 +952,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "charts", - "id": "def-public.ChartColorConfiguration", - "type": "Interface", - "tags": [], - "label": "ChartColorConfiguration", - "description": [ - "\nInformation about the structure of a chart to determine the color of a series within it." - ], - "path": "src/plugins/charts/public/services/palettes/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "charts", - "id": "def-public.ChartColorConfiguration.totalSeries", - "type": "number", - "tags": [], - "label": "totalSeries", - "description": [ - "\nOverall number of series in the current chart" - ], - "signature": [ - "number | undefined" - ], - "path": "src/plugins/charts/public/services/palettes/types.ts", - "deprecated": false - }, - { - "parentPluginId": "charts", - "id": "def-public.ChartColorConfiguration.maxDepth", - "type": "number", - "tags": [], - "label": "maxDepth", - "description": [ - "\nMax nesting depth of the series tree" - ], - "signature": [ - "number | undefined" - ], - "path": "src/plugins/charts/public/services/palettes/types.ts", - "deprecated": false - }, - { - "parentPluginId": "charts", - "id": "def-public.ChartColorConfiguration.behindText", - "type": "CompoundType", - "tags": [], - "label": "behindText", - "description": [ - "\nFlag whether the color will be used behind text. The palette can use this information to\nadjust colors for better a11y. Might be ignored depending on the palette." - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/charts/public/services/palettes/types.ts", - "deprecated": false - }, - { - "parentPluginId": "charts", - "id": "def-public.ChartColorConfiguration.syncColors", - "type": "CompoundType", - "tags": [], - "label": "syncColors", - "description": [ - "\nFlag whether a color assignment to a given key should be remembered and re-used the next time the key shows up.\nThis setting might be ignored based on the palette." - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/charts/public/services/palettes/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "charts", "id": "def-public.ClickTriggerEvent", @@ -1162,7 +1123,7 @@ "tags": [], "label": "CustomPaletteArguments", "description": [], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false, "children": [ { @@ -1175,7 +1136,7 @@ "signature": [ "string[] | undefined" ], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -1185,7 +1146,7 @@ "tags": [], "label": "gradient", "description": [], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -1198,7 +1159,7 @@ "signature": [ "boolean | undefined" ], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -1211,7 +1172,7 @@ "signature": [ "number[] | undefined" ], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -1224,7 +1185,7 @@ "signature": [ "\"number\" | \"percent\" | undefined" ], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -1237,7 +1198,7 @@ "signature": [ "number | undefined" ], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -1250,7 +1211,7 @@ "signature": [ "number | undefined" ], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -1261,16 +1222,10 @@ "label": "continuity", "description": [], "signature": [ - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteContinuity", - "text": "PaletteContinuity" - }, + "PaletteContinuity", " | undefined" ], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false } ], @@ -1283,7 +1238,7 @@ "tags": [], "label": "CustomPaletteState", "description": [], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false, "children": [ { @@ -1296,7 +1251,7 @@ "signature": [ "string[]" ], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -1306,7 +1261,7 @@ "tags": [], "label": "gradient", "description": [], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -1319,7 +1274,7 @@ "signature": [ "number[]" ], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -1332,7 +1287,7 @@ "signature": [ "\"number\" | \"percent\"" ], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -1342,7 +1297,7 @@ "tags": [], "label": "rangeMin", "description": [], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -1352,7 +1307,7 @@ "tags": [], "label": "rangeMax", "description": [], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -1363,16 +1318,10 @@ "label": "continuity", "description": [], "signature": [ - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteContinuity", - "text": "PaletteContinuity" - }, + "PaletteContinuity", " | undefined" ], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false } ], @@ -1471,576 +1420,54 @@ }, { "parentPluginId": "charts", - "id": "def-public.PaletteDefinition", + "id": "def-public.RawColorSchema", "type": "Interface", "tags": [], - "label": "PaletteDefinition", - "description": [ - "\nDefinition of a global palette.\n\nA palette controls the appearance of Lens charts on an editor level.\nThe palette wont get reset when switching charts.\n\nA palette can hold internal state (e.g. for customizations) and also includes\nan editor component to edit the internal state." - ], - "signature": [ - { - "pluginId": "charts", - "scope": "public", - "docId": "kibChartsPluginApi", - "section": "def-public.PaletteDefinition", - "text": "PaletteDefinition" - }, - "" - ], - "path": "src/plugins/charts/public/services/palettes/types.ts", + "label": "RawColorSchema", + "description": [], + "path": "src/plugins/charts/common/static/color_maps/color_maps.ts", "deprecated": false, "children": [ { "parentPluginId": "charts", - "id": "def-public.PaletteDefinition.id", - "type": "string", + "id": "def-public.RawColorSchema.id", + "type": "Enum", "tags": [], "label": "id", - "description": [ - "\nUnique id of the palette (this will be persisted along with the visualization state)" - ], - "path": "src/plugins/charts/public/services/palettes/types.ts", - "deprecated": false - }, - { - "parentPluginId": "charts", - "id": "def-public.PaletteDefinition.title", - "type": "string", - "tags": [], - "label": "title", - "description": [ - "\nUser facing title (should be i18n-ized)" - ], - "path": "src/plugins/charts/public/services/palettes/types.ts", - "deprecated": false - }, - { - "parentPluginId": "charts", - "id": "def-public.PaletteDefinition.internal", - "type": "CompoundType", - "tags": [], - "label": "internal", - "description": [ - "\nFlag indicating whether users should be able to pick this palette manually." - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/charts/public/services/palettes/types.ts", - "deprecated": false - }, - { - "parentPluginId": "charts", - "id": "def-public.PaletteDefinition.toExpression", - "type": "Function", - "tags": [], - "label": "toExpression", - "description": [ - "\nSerialize the internal state of the palette into an expression function.\nThis function should be used to pass the palette to the expression function applying color and other styles" - ], + "description": [], "signature": [ - "(state?: T | undefined) => ", { - "pluginId": "expressions", + "pluginId": "charts", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" - } - ], - "path": "src/plugins/charts/public/services/palettes/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "charts", - "id": "def-public.PaletteDefinition.toExpression.$1", - "type": "Uncategorized", - "tags": [], - "label": "state", - "description": [ - "The internal state of the palette" - ], - "signature": [ - "T | undefined" - ], - "path": "src/plugins/charts/public/services/palettes/types.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] - }, - { - "parentPluginId": "charts", - "id": "def-public.PaletteDefinition.getCategoricalColor", - "type": "Function", - "tags": [], - "label": "getCategoricalColor", - "description": [ - "\nColor a series according to the internal rules of the palette." - ], - "signature": [ - "(series: ", - { - "pluginId": "charts", - "scope": "public", - "docId": "kibChartsPluginApi", - "section": "def-public.SeriesLayer", - "text": "SeriesLayer" - }, - "[], chartConfiguration?: ", - { - "pluginId": "charts", - "scope": "public", - "docId": "kibChartsPluginApi", - "section": "def-public.ChartColorConfiguration", - "text": "ChartColorConfiguration" - }, - " | undefined, state?: T | undefined) => string | null" - ], - "path": "src/plugins/charts/public/services/palettes/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "charts", - "id": "def-public.PaletteDefinition.getCategoricalColor.$1", - "type": "Array", - "tags": [], - "label": "series", - "description": [ - "The current series along with its ancestors." - ], - "signature": [ - { - "pluginId": "charts", - "scope": "public", - "docId": "kibChartsPluginApi", - "section": "def-public.SeriesLayer", - "text": "SeriesLayer" - }, - "[]" - ], - "path": "src/plugins/charts/public/services/palettes/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "charts", - "id": "def-public.PaletteDefinition.getCategoricalColor.$2", - "type": "Object", - "tags": [], - "label": "chartConfiguration", - "description": [], - "signature": [ - { - "pluginId": "charts", - "scope": "public", - "docId": "kibChartsPluginApi", - "section": "def-public.ChartColorConfiguration", - "text": "ChartColorConfiguration" - }, - " | undefined" - ], - "path": "src/plugins/charts/public/services/palettes/types.ts", - "deprecated": false, - "isRequired": false - }, - { - "parentPluginId": "charts", - "id": "def-public.PaletteDefinition.getCategoricalColor.$3", - "type": "Uncategorized", - "tags": [], - "label": "state", - "description": [ - "The internal state of the palette" - ], - "signature": [ - "T | undefined" - ], - "path": "src/plugins/charts/public/services/palettes/types.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] - }, - { - "parentPluginId": "charts", - "id": "def-public.PaletteDefinition.getCategoricalColors", - "type": "Function", - "tags": [], - "label": "getCategoricalColors", - "description": [ - "\nGet a spectrum of colors of the current palette.\nThis can be used if the chart wants to control color assignment locally." - ], - "signature": [ - "(size: number, state?: T | undefined) => string[]" - ], - "path": "src/plugins/charts/public/services/palettes/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "charts", - "id": "def-public.PaletteDefinition.getCategoricalColors.$1", - "type": "number", - "tags": [], - "label": "size", - "description": [], - "signature": [ - "number" - ], - "path": "src/plugins/charts/public/services/palettes/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "charts", - "id": "def-public.PaletteDefinition.getCategoricalColors.$2", - "type": "Uncategorized", - "tags": [], - "label": "state", - "description": [], - "signature": [ - "T | undefined" - ], - "path": "src/plugins/charts/public/services/palettes/types.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] - }, - { - "parentPluginId": "charts", - "id": "def-public.PaletteDefinition.canDynamicColoring", - "type": "CompoundType", - "tags": [], - "label": "canDynamicColoring", - "description": [ - "\nDefine whether a palette supports dynamic coloring (i.e. gradient colors mapped to number values)" - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/charts/public/services/palettes/types.ts", - "deprecated": false - }, - { - "parentPluginId": "charts", - "id": "def-public.PaletteDefinition.getColorForValue", - "type": "Function", - "tags": [], - "label": "getColorForValue", - "description": [ - "\nGet the assigned color for the given value based on its data domain and state settings.\nThis can be used for dynamic coloring based on uniform color distribution or custom stops." - ], - "signature": [ - "((value: number | undefined, state: T, { min, max }: { min: number; max: number; }) => string | undefined) | undefined" - ], - "path": "src/plugins/charts/public/services/palettes/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "charts", - "id": "def-public.PaletteDefinition.getColorForValue.$1", - "type": "number", - "tags": [], - "label": "value", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "src/plugins/charts/public/services/palettes/types.ts", - "deprecated": false, - "isRequired": false - }, - { - "parentPluginId": "charts", - "id": "def-public.PaletteDefinition.getColorForValue.$2", - "type": "Uncategorized", - "tags": [], - "label": "state", - "description": [], - "signature": [ - "T" - ], - "path": "src/plugins/charts/public/services/palettes/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "charts", - "id": "def-public.PaletteDefinition.getColorForValue.$3", - "type": "Object", - "tags": [], - "label": "{ min, max }", - "description": [], - "path": "src/plugins/charts/public/services/palettes/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "charts", - "id": "def-public.PaletteDefinition.getColorForValue.$3.min", - "type": "number", - "tags": [], - "label": "min", - "description": [], - "path": "src/plugins/charts/public/services/palettes/types.ts", - "deprecated": false - }, - { - "parentPluginId": "charts", - "id": "def-public.PaletteDefinition.getColorForValue.$3.max", - "type": "number", - "tags": [], - "label": "max", - "description": [], - "path": "src/plugins/charts/public/services/palettes/types.ts", - "deprecated": false - } - ] - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "charts", - "id": "def-public.PaletteOutput", - "type": "Interface", - "tags": [], - "label": "PaletteOutput", - "description": [], - "signature": [ - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteOutput", - "text": "PaletteOutput" - }, - "" - ], - "path": "src/plugins/charts/common/palette.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "charts", - "id": "def-public.PaletteOutput.type", - "type": "CompoundType", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"palette\" | \"system_palette\"" - ], - "path": "src/plugins/charts/common/palette.ts", - "deprecated": false - }, - { - "parentPluginId": "charts", - "id": "def-public.PaletteOutput.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "path": "src/plugins/charts/common/palette.ts", - "deprecated": false - }, - { - "parentPluginId": "charts", - "id": "def-public.PaletteOutput.params", - "type": "Uncategorized", - "tags": [], - "label": "params", - "description": [], - "signature": [ - "T | undefined" - ], - "path": "src/plugins/charts/common/palette.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "charts", - "id": "def-public.PaletteRegistry", - "type": "Interface", - "tags": [], - "label": "PaletteRegistry", - "description": [], - "path": "src/plugins/charts/public/services/palettes/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "charts", - "id": "def-public.PaletteRegistry.get", - "type": "Function", - "tags": [], - "label": "get", - "description": [], - "signature": [ - "(name: string) => ", - { - "pluginId": "charts", - "scope": "public", - "docId": "kibChartsPluginApi", - "section": "def-public.PaletteDefinition", - "text": "PaletteDefinition" - }, - "" - ], - "path": "src/plugins/charts/public/services/palettes/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "charts", - "id": "def-public.PaletteRegistry.get.$1", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/charts/public/services/palettes/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "charts", - "id": "def-public.PaletteRegistry.getAll", - "type": "Function", - "tags": [], - "label": "getAll", - "description": [], - "signature": [ - "() => ", - { - "pluginId": "charts", - "scope": "public", "docId": "kibChartsPluginApi", - "section": "def-public.PaletteDefinition", - "text": "PaletteDefinition" - }, - "[]" - ], - "path": "src/plugins/charts/public/services/palettes/types.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "charts", - "id": "def-public.RawColorSchema", - "type": "Interface", - "tags": [], - "label": "RawColorSchema", - "description": [], - "path": "src/plugins/charts/common/static/color_maps/color_maps.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "charts", - "id": "def-public.RawColorSchema.id", - "type": "Enum", - "tags": [], - "label": "id", - "description": [], - "signature": [ - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.ColorSchemas", - "text": "ColorSchemas" - } - ], - "path": "src/plugins/charts/common/static/color_maps/color_maps.ts", - "deprecated": false - }, - { - "parentPluginId": "charts", - "id": "def-public.RawColorSchema.label", - "type": "string", - "tags": [], - "label": "label", - "description": [], - "path": "src/plugins/charts/common/static/color_maps/color_maps.ts", - "deprecated": false - }, - { - "parentPluginId": "charts", - "id": "def-public.RawColorSchema.value", - "type": "Array", - "tags": [], - "label": "value", - "description": [], - "signature": [ - "[number, number[]][]" - ], - "path": "src/plugins/charts/common/static/color_maps/color_maps.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "charts", - "id": "def-public.SeriesLayer", - "type": "Interface", - "tags": [], - "label": "SeriesLayer", - "description": [ - "\nInformation about a series in a chart used to determine its color.\nSeries layers can be nested, this means each series layer can have an ancestor." - ], - "path": "src/plugins/charts/public/services/palettes/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "charts", - "id": "def-public.SeriesLayer.name", - "type": "string", - "tags": [], - "label": "name", - "description": [ - "\nName of the series (can be used for lookup-based coloring)" + "section": "def-common.ColorSchemas", + "text": "ColorSchemas" + } ], - "path": "src/plugins/charts/public/services/palettes/types.ts", + "path": "src/plugins/charts/common/static/color_maps/color_maps.ts", "deprecated": false }, { "parentPluginId": "charts", - "id": "def-public.SeriesLayer.rankAtDepth", - "type": "number", + "id": "def-public.RawColorSchema.label", + "type": "string", "tags": [], - "label": "rankAtDepth", - "description": [ - "\nRank of the series compared to siblings with the same ancestor" - ], - "path": "src/plugins/charts/public/services/palettes/types.ts", + "label": "label", + "description": [], + "path": "src/plugins/charts/common/static/color_maps/color_maps.ts", "deprecated": false }, { "parentPluginId": "charts", - "id": "def-public.SeriesLayer.totalSeriesAtDepth", - "type": "number", + "id": "def-public.RawColorSchema.value", + "type": "Array", "tags": [], - "label": "totalSeriesAtDepth", - "description": [ - "\nTotal number of series with the same ancestor" + "label": "value", + "description": [], + "signature": [ + "[number, number[]][]" ], - "path": "src/plugins/charts/public/services/palettes/types.ts", + "path": "src/plugins/charts/common/static/color_maps/color_maps.ts", "deprecated": false } ], @@ -2116,7 +1543,7 @@ "tags": [], "label": "SystemPaletteArguments", "description": [], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/system_palette.ts", "deprecated": false, "children": [ { @@ -2126,7 +1553,7 @@ "tags": [], "label": "name", "description": [], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/system_palette.ts", "deprecated": false } ], @@ -2858,13 +2285,7 @@ "description": [], "signature": [ "{ getPalettes: () => Promise<", - { - "pluginId": "charts", - "scope": "public", - "docId": "kibChartsPluginApi", - "section": "def-public.PaletteRegistry", - "text": "PaletteRegistry" - }, + "PaletteRegistry", ">; }" ], "path": "src/plugins/charts/public/plugin.ts", @@ -2910,7 +2331,7 @@ "tags": [], "label": "CustomPaletteArguments", "description": [], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false, "children": [ { @@ -2923,7 +2344,7 @@ "signature": [ "string[] | undefined" ], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -2933,7 +2354,7 @@ "tags": [], "label": "gradient", "description": [], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -2946,7 +2367,7 @@ "signature": [ "boolean | undefined" ], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -2959,7 +2380,7 @@ "signature": [ "number[] | undefined" ], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -2972,7 +2393,7 @@ "signature": [ "\"number\" | \"percent\" | undefined" ], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -2985,7 +2406,7 @@ "signature": [ "number | undefined" ], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -2998,7 +2419,7 @@ "signature": [ "number | undefined" ], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -3009,16 +2430,10 @@ "label": "continuity", "description": [], "signature": [ - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteContinuity", - "text": "PaletteContinuity" - }, + "PaletteContinuity", " | undefined" ], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false } ], @@ -3031,7 +2446,7 @@ "tags": [], "label": "CustomPaletteState", "description": [], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false, "children": [ { @@ -3044,7 +2459,7 @@ "signature": [ "string[]" ], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -3054,7 +2469,7 @@ "tags": [], "label": "gradient", "description": [], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -3067,7 +2482,7 @@ "signature": [ "number[]" ], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -3080,7 +2495,7 @@ "signature": [ "\"number\" | \"percent\"" ], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -3090,7 +2505,7 @@ "tags": [], "label": "rangeMin", "description": [], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -3100,7 +2515,7 @@ "tags": [], "label": "rangeMax", "description": [], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -3111,75 +2526,10 @@ "label": "continuity", "description": [], "signature": [ - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteContinuity", - "text": "PaletteContinuity" - }, + "PaletteContinuity", " | undefined" ], - "path": "src/plugins/charts/common/palette.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "charts", - "id": "def-server.PaletteOutput", - "type": "Interface", - "tags": [], - "label": "PaletteOutput", - "description": [], - "signature": [ - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteOutput", - "text": "PaletteOutput" - }, - "" - ], - "path": "src/plugins/charts/common/palette.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "charts", - "id": "def-server.PaletteOutput.type", - "type": "CompoundType", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"palette\" | \"system_palette\"" - ], - "path": "src/plugins/charts/common/palette.ts", - "deprecated": false - }, - { - "parentPluginId": "charts", - "id": "def-server.PaletteOutput.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "path": "src/plugins/charts/common/palette.ts", - "deprecated": false - }, - { - "parentPluginId": "charts", - "id": "def-server.PaletteOutput.params", - "type": "Uncategorized", - "tags": [], - "label": "params", - "description": [], - "signature": [ - "T | undefined" - ], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false } ], @@ -3192,7 +2542,7 @@ "tags": [], "label": "SystemPaletteArguments", "description": [], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/system_palette.ts", "deprecated": false, "children": [ { @@ -3202,7 +2552,7 @@ "tags": [], "label": "name", "description": [], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/system_palette.ts", "deprecated": false } ], @@ -3231,98 +2581,6 @@ "common": { "classes": [], "functions": [ - { - "parentPluginId": "charts", - "id": "def-common.checkIsMaxContinuity", - "type": "Function", - "tags": [], - "label": "checkIsMaxContinuity", - "description": [], - "signature": [ - "(continuity: ", - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteContinuity", - "text": "PaletteContinuity" - }, - " | undefined) => boolean" - ], - "path": "src/plugins/charts/common/static/palette/index.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "charts", - "id": "def-common.checkIsMaxContinuity.$1", - "type": "CompoundType", - "tags": [], - "label": "continuity", - "description": [], - "signature": [ - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteContinuity", - "text": "PaletteContinuity" - }, - " | undefined" - ], - "path": "src/plugins/charts/common/static/palette/index.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "charts", - "id": "def-common.checkIsMinContinuity", - "type": "Function", - "tags": [], - "label": "checkIsMinContinuity", - "description": [], - "signature": [ - "(continuity: ", - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteContinuity", - "text": "PaletteContinuity" - }, - " | undefined) => boolean" - ], - "path": "src/plugins/charts/common/static/palette/index.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "charts", - "id": "def-common.checkIsMinContinuity.$1", - "type": "CompoundType", - "tags": [], - "label": "continuity", - "description": [], - "signature": [ - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteContinuity", - "text": "PaletteContinuity" - }, - " | undefined" - ], - "path": "src/plugins/charts/common/static/palette/index.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [], - "initialIsOpen": false - }, { "parentPluginId": "charts", "id": "def-common.getHeatmapColors", @@ -3377,58 +2635,9 @@ "description": [], "signature": [ "() => ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"palette\", null, ", - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.CustomPaletteArguments", - "text": "CustomPaletteArguments" - }, - ", ", - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteOutput", - "text": "PaletteOutput" - }, - "<", - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.CustomPaletteState", - "text": "CustomPaletteState" - }, - ">, ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContext", - "text": "ExecutionContext" - }, - "<", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" - }, - ", ", - "SerializableRecord", - ">>" + "PaletteExpressionFunctionDefinition" ], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/palette.ts", "deprecated": false, "children": [], "returnComment": [], @@ -3459,13 +2668,7 @@ "text": "SystemPaletteArguments" }, ", ", - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteOutput", - "text": "PaletteOutput" - }, + "PaletteOutput", "<{ [key: string]: unknown; }>, ", { "pluginId": "expressions", @@ -3486,7 +2689,7 @@ "SerializableRecord", ">>" ], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/system_palette.ts", "deprecated": false, "children": [], "returnComment": [], @@ -3618,7 +2821,7 @@ "tags": [], "label": "CustomPaletteArguments", "description": [], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false, "children": [ { @@ -3631,7 +2834,7 @@ "signature": [ "string[] | undefined" ], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -3641,7 +2844,7 @@ "tags": [], "label": "gradient", "description": [], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -3654,7 +2857,7 @@ "signature": [ "boolean | undefined" ], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -3667,7 +2870,7 @@ "signature": [ "number[] | undefined" ], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -3680,7 +2883,7 @@ "signature": [ "\"number\" | \"percent\" | undefined" ], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -3693,7 +2896,7 @@ "signature": [ "number | undefined" ], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -3706,7 +2909,7 @@ "signature": [ "number | undefined" ], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -3717,16 +2920,10 @@ "label": "continuity", "description": [], "signature": [ - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteContinuity", - "text": "PaletteContinuity" - }, + "PaletteContinuity", " | undefined" ], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false } ], @@ -3739,7 +2936,7 @@ "tags": [], "label": "CustomPaletteState", "description": [], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false, "children": [ { @@ -3752,7 +2949,7 @@ "signature": [ "string[]" ], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -3762,7 +2959,7 @@ "tags": [], "label": "gradient", "description": [], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -3775,7 +2972,7 @@ "signature": [ "number[]" ], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -3788,7 +2985,7 @@ "signature": [ "\"number\" | \"percent\"" ], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -3798,7 +2995,7 @@ "tags": [], "label": "rangeMin", "description": [], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -3808,7 +3005,7 @@ "tags": [], "label": "rangeMax", "description": [], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false }, { @@ -3819,16 +3016,10 @@ "label": "continuity", "description": [], "signature": [ - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteContinuity", - "text": "PaletteContinuity" - }, + "PaletteContinuity", " | undefined" ], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/types.ts", "deprecated": false } ], @@ -3925,65 +3116,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "charts", - "id": "def-common.PaletteOutput", - "type": "Interface", - "tags": [], - "label": "PaletteOutput", - "description": [], - "signature": [ - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteOutput", - "text": "PaletteOutput" - }, - "" - ], - "path": "src/plugins/charts/common/palette.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "charts", - "id": "def-common.PaletteOutput.type", - "type": "CompoundType", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"palette\" | \"system_palette\"" - ], - "path": "src/plugins/charts/common/palette.ts", - "deprecated": false - }, - { - "parentPluginId": "charts", - "id": "def-common.PaletteOutput.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "path": "src/plugins/charts/common/palette.ts", - "deprecated": false - }, - { - "parentPluginId": "charts", - "id": "def-common.PaletteOutput.params", - "type": "Uncategorized", - "tags": [], - "label": "params", - "description": [], - "signature": [ - "T | undefined" - ], - "path": "src/plugins/charts/common/palette.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "charts", "id": "def-common.RawColorSchema", @@ -4109,7 +3241,7 @@ "tags": [], "label": "SystemPaletteArguments", "description": [], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/system_palette.ts", "deprecated": false, "children": [ { @@ -4119,7 +3251,7 @@ "tags": [], "label": "name", "description": [], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/expressions/palette/system_palette.ts", "deprecated": false } ], @@ -4210,7 +3342,7 @@ "signature": [ "string[]" ], - "path": "src/plugins/charts/common/palette.ts", + "path": "src/plugins/charts/common/constants.ts", "deprecated": false, "initialIsOpen": false }, @@ -4242,20 +3374,6 @@ "deprecated": false, "initialIsOpen": false }, - { - "parentPluginId": "charts", - "id": "def-common.PaletteContinuity", - "type": "Type", - "tags": [], - "label": "PaletteContinuity", - "description": [], - "signature": [ - "\"above\" | \"below\" | \"none\" | \"all\"" - ], - "path": "src/plugins/charts/common/types.ts", - "deprecated": false, - "initialIsOpen": false - }, { "parentPluginId": "charts", "id": "def-common.paletteIds", diff --git a/api_docs/charts.mdx b/api_docs/charts.mdx index dc22287d352d0..0fe3642f18398 100644 --- a/api_docs/charts.mdx +++ b/api_docs/charts.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/charts title: "charts" image: https://source.unsplash.com/400x175/?github summary: API docs for the charts plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 322 | 2 | 289 | 4 | +| 272 | 2 | 253 | 9 | ## Client diff --git a/api_docs/cloud.mdx b/api_docs/cloud.mdx index 378879307a9d0..ccf2076033b67 100644 --- a/api_docs/cloud.mdx +++ b/api_docs/cloud.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/cloud title: "cloud" image: https://source.unsplash.com/400x175/?github summary: API docs for the cloud plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/cloud_security_posture.mdx b/api_docs/cloud_security_posture.mdx index d9a6b1d20909c..d487aab1a4754 100644 --- a/api_docs/cloud_security_posture.mdx +++ b/api_docs/cloud_security_posture.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/cloudSecurityPosture title: "cloudSecurityPosture" image: https://source.unsplash.com/400x175/?github summary: API docs for the cloudSecurityPosture plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/console.mdx b/api_docs/console.mdx index 343ada2ae4109..4d91e53febaf7 100644 --- a/api_docs/console.mdx +++ b/api_docs/console.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/console title: "console" image: https://source.unsplash.com/400x175/?github summary: API docs for the console plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/controls.devdocs.json b/api_docs/controls.devdocs.json index 7cd89434ad64f..fe22caa955878 100644 --- a/api_docs/controls.devdocs.json +++ b/api_docs/controls.devdocs.json @@ -3154,31 +3154,11 @@ "text": "OptionsListEmbeddableInput" }, " extends ", - "ControlInput" + "DataControlInput" ], "path": "src/plugins/controls/common/control_types/options_list/types.ts", "deprecated": false, "children": [ - { - "parentPluginId": "controls", - "id": "def-public.OptionsListEmbeddableInput.fieldName", - "type": "string", - "tags": [], - "label": "fieldName", - "description": [], - "path": "src/plugins/controls/common/control_types/options_list/types.ts", - "deprecated": false - }, - { - "parentPluginId": "controls", - "id": "def-public.OptionsListEmbeddableInput.dataViewId", - "type": "string", - "tags": [], - "label": "dataViewId", - "description": [], - "path": "src/plugins/controls/common/control_types/options_list/types.ts", - "deprecated": false - }, { "parentPluginId": "controls", "id": "def-public.OptionsListEmbeddableInput.selectedOptions", @@ -3302,31 +3282,11 @@ "text": "RangeSliderEmbeddableInput" }, " extends ", - "ControlInput" + "DataControlInput" ], "path": "src/plugins/controls/common/control_types/range_slider/types.ts", "deprecated": false, "children": [ - { - "parentPluginId": "controls", - "id": "def-public.RangeSliderEmbeddableInput.fieldName", - "type": "string", - "tags": [], - "label": "fieldName", - "description": [], - "path": "src/plugins/controls/common/control_types/range_slider/types.ts", - "deprecated": false - }, - { - "parentPluginId": "controls", - "id": "def-public.RangeSliderEmbeddableInput.dataViewId", - "type": "string", - "tags": [], - "label": "dataViewId", - "description": [], - "path": "src/plugins/controls/common/control_types/range_slider/types.ts", - "deprecated": false - }, { "parentPluginId": "controls", "id": "def-public.RangeSliderEmbeddableInput.value", @@ -3600,7 +3560,46 @@ }, "server": { "classes": [], - "functions": [], + "functions": [ + { + "parentPluginId": "controls", + "id": "def-server.initializeControlGroupTelemetry", + "type": "Function", + "tags": [], + "label": "initializeControlGroupTelemetry", + "description": [], + "signature": [ + "(statsSoFar: Record) => ", + { + "pluginId": "controls", + "scope": "common", + "docId": "kibControlsPluginApi", + "section": "def-common.ControlGroupTelemetry", + "text": "ControlGroupTelemetry" + } + ], + "path": "src/plugins/controls/server/control_group/control_group_telemetry.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "controls", + "id": "def-server.initializeControlGroupTelemetry.$1", + "type": "Object", + "tags": [], + "label": "statsSoFar", + "description": [], + "signature": [ + "Record" + ], + "path": "src/plugins/controls/server/control_group/control_group_telemetry.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], "interfaces": [], "enums": [], "misc": [], @@ -3609,6 +3608,60 @@ "common": { "classes": [], "functions": [ + { + "parentPluginId": "controls", + "id": "def-common.controlGroupInputToRawControlGroupAttributes", + "type": "Function", + "tags": [], + "label": "controlGroupInputToRawControlGroupAttributes", + "description": [], + "signature": [ + "(controlGroupInput: Omit<", + { + "pluginId": "controls", + "scope": "common", + "docId": "kibControlsPluginApi", + "section": "def-common.ControlGroupInput", + "text": "ControlGroupInput" + }, + ", \"id\">) => ", + { + "pluginId": "controls", + "scope": "common", + "docId": "kibControlsPluginApi", + "section": "def-common.RawControlGroupAttributes", + "text": "RawControlGroupAttributes" + } + ], + "path": "src/plugins/controls/common/control_group/control_group_persistence.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "controls", + "id": "def-common.controlGroupInputToRawControlGroupAttributes.$1", + "type": "Object", + "tags": [], + "label": "controlGroupInput", + "description": [], + "signature": [ + "Omit<", + { + "pluginId": "controls", + "scope": "common", + "docId": "kibControlsPluginApi", + "section": "def-common.ControlGroupInput", + "text": "ControlGroupInput" + }, + ", \"id\">" + ], + "path": "src/plugins/controls/common/control_group/control_group_persistence.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "controls", "id": "def-common.getDefaultControlGroupInput", @@ -3627,11 +3680,228 @@ }, ", \"id\">" ], - "path": "src/plugins/controls/common/control_group/control_group_constants.ts", + "path": "src/plugins/controls/common/control_group/control_group_persistence.ts", "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false + }, + { + "parentPluginId": "controls", + "id": "def-common.persistableControlGroupInputIsEqual", + "type": "Function", + "tags": [], + "label": "persistableControlGroupInputIsEqual", + "description": [], + "signature": [ + "(a: ", + { + "pluginId": "controls", + "scope": "common", + "docId": "kibControlsPluginApi", + "section": "def-common.PersistableControlGroupInput", + "text": "PersistableControlGroupInput" + }, + " | undefined, b: ", + { + "pluginId": "controls", + "scope": "common", + "docId": "kibControlsPluginApi", + "section": "def-common.PersistableControlGroupInput", + "text": "PersistableControlGroupInput" + }, + " | undefined) => boolean" + ], + "path": "src/plugins/controls/common/control_group/control_group_persistence.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "controls", + "id": "def-common.persistableControlGroupInputIsEqual.$1", + "type": "Object", + "tags": [], + "label": "a", + "description": [], + "signature": [ + { + "pluginId": "controls", + "scope": "common", + "docId": "kibControlsPluginApi", + "section": "def-common.PersistableControlGroupInput", + "text": "PersistableControlGroupInput" + }, + " | undefined" + ], + "path": "src/plugins/controls/common/control_group/control_group_persistence.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "controls", + "id": "def-common.persistableControlGroupInputIsEqual.$2", + "type": "Object", + "tags": [], + "label": "b", + "description": [], + "signature": [ + { + "pluginId": "controls", + "scope": "common", + "docId": "kibControlsPluginApi", + "section": "def-common.PersistableControlGroupInput", + "text": "PersistableControlGroupInput" + }, + " | undefined" + ], + "path": "src/plugins/controls/common/control_group/control_group_persistence.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "controls", + "id": "def-common.rawControlGroupAttributesToControlGroupInput", + "type": "Function", + "tags": [], + "label": "rawControlGroupAttributesToControlGroupInput", + "description": [], + "signature": [ + "(rawControlGroupAttributes: ", + { + "pluginId": "controls", + "scope": "common", + "docId": "kibControlsPluginApi", + "section": "def-common.RawControlGroupAttributes", + "text": "RawControlGroupAttributes" + }, + ") => Omit<", + { + "pluginId": "controls", + "scope": "common", + "docId": "kibControlsPluginApi", + "section": "def-common.ControlGroupInput", + "text": "ControlGroupInput" + }, + ", \"id\"> | undefined" + ], + "path": "src/plugins/controls/common/control_group/control_group_persistence.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "controls", + "id": "def-common.rawControlGroupAttributesToControlGroupInput.$1", + "type": "CompoundType", + "tags": [], + "label": "rawControlGroupAttributes", + "description": [], + "signature": [ + { + "pluginId": "controls", + "scope": "common", + "docId": "kibControlsPluginApi", + "section": "def-common.RawControlGroupAttributes", + "text": "RawControlGroupAttributes" + } + ], + "path": "src/plugins/controls/common/control_group/control_group_persistence.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "controls", + "id": "def-common.rawControlGroupAttributesToSerializable", + "type": "Function", + "tags": [], + "label": "rawControlGroupAttributesToSerializable", + "description": [], + "signature": [ + "(rawControlGroupAttributes: Omit<", + { + "pluginId": "controls", + "scope": "common", + "docId": "kibControlsPluginApi", + "section": "def-common.RawControlGroupAttributes", + "text": "RawControlGroupAttributes" + }, + ", \"id\">) => ", + "SerializableRecord" + ], + "path": "src/plugins/controls/common/control_group/control_group_persistence.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "controls", + "id": "def-common.rawControlGroupAttributesToSerializable.$1", + "type": "Object", + "tags": [], + "label": "rawControlGroupAttributes", + "description": [], + "signature": [ + "Omit<", + { + "pluginId": "controls", + "scope": "common", + "docId": "kibControlsPluginApi", + "section": "def-common.RawControlGroupAttributes", + "text": "RawControlGroupAttributes" + }, + ", \"id\">" + ], + "path": "src/plugins/controls/common/control_group/control_group_persistence.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "controls", + "id": "def-common.serializableToRawControlGroupAttributes", + "type": "Function", + "tags": [], + "label": "serializableToRawControlGroupAttributes", + "description": [], + "signature": [ + "(serializable: ", + "SerializableRecord", + ") => Omit<", + { + "pluginId": "controls", + "scope": "common", + "docId": "kibControlsPluginApi", + "section": "def-common.RawControlGroupAttributes", + "text": "RawControlGroupAttributes" + }, + ", \"id\" | \"type\">" + ], + "path": "src/plugins/controls/common/control_group/control_group_persistence.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "controls", + "id": "def-common.serializableToRawControlGroupAttributes.$1", + "type": "Object", + "tags": [], + "label": "serializable", + "description": [], + "signature": [ + "SerializableRecord" + ], + "path": "src/plugins/controls/common/control_group/control_group_persistence.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false } ], "interfaces": [ @@ -3732,6 +4002,81 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "controls", + "id": "def-common.ControlGroupTelemetry", + "type": "Interface", + "tags": [], + "label": "ControlGroupTelemetry", + "description": [], + "path": "src/plugins/controls/common/control_group/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "controls", + "id": "def-common.ControlGroupTelemetry.total", + "type": "number", + "tags": [], + "label": "total", + "description": [], + "path": "src/plugins/controls/common/control_group/types.ts", + "deprecated": false + }, + { + "parentPluginId": "controls", + "id": "def-common.ControlGroupTelemetry.chaining_system", + "type": "Object", + "tags": [], + "label": "chaining_system", + "description": [], + "signature": [ + "{ [key: string]: number; }" + ], + "path": "src/plugins/controls/common/control_group/types.ts", + "deprecated": false + }, + { + "parentPluginId": "controls", + "id": "def-common.ControlGroupTelemetry.label_position", + "type": "Object", + "tags": [], + "label": "label_position", + "description": [], + "signature": [ + "{ [key: string]: number; }" + ], + "path": "src/plugins/controls/common/control_group/types.ts", + "deprecated": false + }, + { + "parentPluginId": "controls", + "id": "def-common.ControlGroupTelemetry.ignore_settings", + "type": "Object", + "tags": [], + "label": "ignore_settings", + "description": [], + "signature": [ + "{ [key: string]: number; }" + ], + "path": "src/plugins/controls/common/control_group/types.ts", + "deprecated": false + }, + { + "parentPluginId": "controls", + "id": "def-common.ControlGroupTelemetry.by_type", + "type": "Object", + "tags": [], + "label": "by_type", + "description": [], + "signature": [ + "{ [key: string]: { total: number; details: { [key: string]: number; }; }; }" + ], + "path": "src/plugins/controls/common/control_group/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "controls", "id": "def-common.ControlPanelState", @@ -3838,31 +4183,11 @@ "text": "OptionsListEmbeddableInput" }, " extends ", - "ControlInput" + "DataControlInput" ], "path": "src/plugins/controls/common/control_types/options_list/types.ts", "deprecated": false, "children": [ - { - "parentPluginId": "controls", - "id": "def-common.OptionsListEmbeddableInput.fieldName", - "type": "string", - "tags": [], - "label": "fieldName", - "description": [], - "path": "src/plugins/controls/common/control_types/options_list/types.ts", - "deprecated": false - }, - { - "parentPluginId": "controls", - "id": "def-common.OptionsListEmbeddableInput.dataViewId", - "type": "string", - "tags": [], - "label": "dataViewId", - "description": [], - "path": "src/plugins/controls/common/control_types/options_list/types.ts", - "deprecated": false - }, { "parentPluginId": "controls", "id": "def-common.OptionsListEmbeddableInput.selectedOptions", @@ -3921,31 +4246,11 @@ "text": "RangeSliderEmbeddableInput" }, " extends ", - "ControlInput" + "DataControlInput" ], "path": "src/plugins/controls/common/control_types/range_slider/types.ts", "deprecated": false, "children": [ - { - "parentPluginId": "controls", - "id": "def-common.RangeSliderEmbeddableInput.fieldName", - "type": "string", - "tags": [], - "label": "fieldName", - "description": [], - "path": "src/plugins/controls/common/control_types/range_slider/types.ts", - "deprecated": false - }, - { - "parentPluginId": "controls", - "id": "def-common.RangeSliderEmbeddableInput.dataViewId", - "type": "string", - "tags": [], - "label": "dataViewId", - "description": [], - "path": "src/plugins/controls/common/control_types/range_slider/types.ts", - "deprecated": false - }, { "parentPluginId": "controls", "id": "def-common.RangeSliderEmbeddableInput.value", @@ -3993,6 +4298,34 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "controls", + "id": "def-common.DEFAULT_CONTROL_STYLE", + "type": "CompoundType", + "tags": [], + "label": "DEFAULT_CONTROL_STYLE", + "description": [], + "signature": [ + "\"twoLine\" | \"oneLine\"" + ], + "path": "src/plugins/controls/common/control_group/control_group_constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "controls", + "id": "def-common.DEFAULT_CONTROL_WIDTH", + "type": "CompoundType", + "tags": [], + "label": "DEFAULT_CONTROL_WIDTH", + "description": [], + "signature": [ + "\"auto\" | \"small\" | \"medium\" | \"large\"" + ], + "path": "src/plugins/controls/common/control_group/control_group_constants.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "controls", "id": "def-common.OPTIONS_LIST_CONTROL", @@ -4007,6 +4340,34 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "controls", + "id": "def-common.PersistableControlGroupInput", + "type": "Type", + "tags": [], + "label": "PersistableControlGroupInput", + "description": [], + "signature": [ + "{ controlStyle: ", + "ControlStyle", + "; ignoreParentSettings?: ", + "ParentIgnoreSettings", + " | undefined; chainingSystem: ", + "ControlGroupChainingSystem", + "; panels: ", + { + "pluginId": "controls", + "scope": "common", + "docId": "kibControlsPluginApi", + "section": "def-common.ControlsPanels", + "text": "ControlsPanels" + }, + "; }" + ], + "path": "src/plugins/controls/common/control_group/types.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "controls", "id": "def-common.RANGE_SLIDER_CONTROL", @@ -4021,6 +4382,28 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "controls", + "id": "def-common.RawControlGroupAttributes", + "type": "Type", + "tags": [], + "label": "RawControlGroupAttributes", + "description": [], + "signature": [ + "Omit<", + { + "pluginId": "controls", + "scope": "common", + "docId": "kibControlsPluginApi", + "section": "def-common.PersistableControlGroupInput", + "text": "PersistableControlGroupInput" + }, + ", \"ignoreParentSettings\" | \"panels\"> & { ignoreParentSettingsJSON: string; panelsJSON: string; }" + ], + "path": "src/plugins/controls/common/control_group/types.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "controls", "id": "def-common.TIME_SLIDER_CONTROL", diff --git a/api_docs/controls.mdx b/api_docs/controls.mdx index 7a59f3a0a5120..870bc6876f2c6 100644 --- a/api_docs/controls.mdx +++ b/api_docs/controls.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/controls title: "controls" image: https://source.unsplash.com/400x175/?github summary: API docs for the controls plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-prese | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 188 | 0 | 182 | 4 | +| 203 | 0 | 197 | 6 | ## Client @@ -34,6 +34,11 @@ Contact [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-prese ### Consts, variables and types +## Server + +### Functions + + ## Common ### Functions diff --git a/api_docs/core.devdocs.json b/api_docs/core.devdocs.json index 7568da42bdc95..ae6443972aefb 100644 --- a/api_docs/core.devdocs.json +++ b/api_docs/core.devdocs.json @@ -651,7 +651,7 @@ "description": [ "\r\nAnalytics client's public APIs" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { @@ -666,7 +666,7 @@ "signature": [ ">(eventType: string, eventData: EventTypeData) => void" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { @@ -681,7 +681,7 @@ "signature": [ "string" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true }, @@ -697,7 +697,7 @@ "signature": [ "EventTypeData" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true } @@ -718,7 +718,7 @@ "EventTypeOpts", ") => void" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { @@ -732,7 +732,7 @@ "EventTypeOpts", "" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true } @@ -757,7 +757,7 @@ "RegisterShipperOpts", " | undefined) => void" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { @@ -773,7 +773,7 @@ "ShipperClassConstructor", "" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true }, @@ -789,7 +789,7 @@ "signature": [ "ShipperConfig" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true }, @@ -806,7 +806,7 @@ "RegisterShipperOpts", " | undefined" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": false } @@ -827,7 +827,7 @@ "OptInConfig", ") => void" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { @@ -842,7 +842,7 @@ "signature": [ "OptInConfig" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true } @@ -863,7 +863,7 @@ "ContextProviderOpts", ") => void" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { @@ -879,7 +879,7 @@ "ContextProviderOpts", "" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true } @@ -898,7 +898,7 @@ "signature": [ "(contextProviderName: string) => void" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { @@ -913,7 +913,7 @@ "signature": [ "string" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true } @@ -935,7 +935,7 @@ "TelemetryCounter", ">" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false } ], @@ -1113,7 +1113,7 @@ "ContextProviderOpts", "" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { @@ -1125,7 +1125,7 @@ "description": [ "\r\nThe name of the provider." ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { @@ -1141,7 +1141,7 @@ "Observable", "" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { @@ -1158,7 +1158,7 @@ "SchemaValue", "; }" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false } ], @@ -2075,7 +2075,7 @@ "signature": [ "Event" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { @@ -2087,7 +2087,7 @@ "description": [ "\r\nThe time the event was generated in ISO format." ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { @@ -2099,7 +2099,7 @@ "description": [ "\r\nThe event type." ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { @@ -2114,7 +2114,7 @@ "signature": [ "{ [x: string]: unknown; }" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { @@ -2129,7 +2129,7 @@ "signature": [ "EventContext" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false } ], @@ -2141,10 +2141,102 @@ "type": "Interface", "tags": [], "label": "EventContext", - "description": [], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "description": [ + "\r\nDefinition of the context that can be appended to the events through the {@link IAnalyticsClient.registerContextProvider}." + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ + { + "parentPluginId": "core", + "id": "def-public.EventContext.userId", + "type": "string", + "tags": [], + "label": "userId", + "description": [ + "\r\nThe unique user ID." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.EventContext.cloudId", + "type": "string", + "tags": [], + "label": "cloudId", + "description": [ + "\r\nThe Cloud ID." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.EventContext.version", + "type": "string", + "tags": [], + "label": "version", + "description": [ + "\r\nThe product's version." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.EventContext.pageName", + "type": "string", + "tags": [], + "label": "pageName", + "description": [ + "\r\nThe name of the current page." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.EventContext.applicationId", + "type": "string", + "tags": [], + "label": "applicationId", + "description": [ + "\r\nThe current application ID." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.EventContext.entityId", + "type": "string", + "tags": [], + "label": "entityId", + "description": [ + "\r\nThe current entity ID (dashboard ID, visualization ID, etc.)." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, { "parentPluginId": "core", "id": "def-public.EventContext.Unnamed", @@ -2155,7 +2247,7 @@ "signature": [ "[key: string]: unknown" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false } ], @@ -2174,7 +2266,7 @@ "EventTypeOpts", "" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { @@ -2186,7 +2278,7 @@ "description": [ "\r\nThe event type's unique name." ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { @@ -2203,7 +2295,7 @@ "SchemaValue", "; }" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false } ], @@ -2619,7 +2711,7 @@ "description": [ "\r\nBasic structure of a Shipper" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { @@ -2636,7 +2728,7 @@ "Event", "[]) => void" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { @@ -2652,7 +2744,7 @@ "Event", "[]" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true } @@ -2671,7 +2763,7 @@ "signature": [ "(isOptedIn: boolean) => void" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { @@ -2686,7 +2778,7 @@ "signature": [ "boolean" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true } @@ -2707,7 +2799,7 @@ "EventContext", ") => void) | undefined" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { @@ -2720,7 +2812,7 @@ "signature": [ "EventContext" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true } @@ -2742,7 +2834,7 @@ "TelemetryCounter", "> | undefined" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false } ], @@ -3479,7 +3571,7 @@ "description": [ "\r\n" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { @@ -3494,7 +3586,7 @@ "signature": [ "OptInConfigPerType" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { @@ -3511,7 +3603,7 @@ "OptInConfigPerType", " | undefined> | undefined" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false } ], @@ -5391,6 +5483,21 @@ "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", "deprecated": false }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectReferenceWithContext.originId", + "type": "string", + "tags": [], + "label": "originId", + "description": [ + "The origin ID of the referenced object (if it has one)" + ], + "signature": [ + "string | undefined" + ], + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "deprecated": false + }, { "parentPluginId": "core", "id": "def-public.SavedObjectReferenceWithContext.spaces", @@ -5450,6 +5557,21 @@ ], "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectReferenceWithContext.spacesWithMatchingOrigins", + "type": "Array", + "tags": [], + "label": "spacesWithMatchingOrigins", + "description": [ + "The space(s) that objects matching this origin exist in (including this one)" + ], + "signature": [ + "string[] | undefined" + ], + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "deprecated": false } ], "initialIsOpen": false @@ -6793,7 +6915,7 @@ "ShipperClassConstructor", "" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { @@ -6805,7 +6927,7 @@ "description": [ "\r\nThe shipper's unique name" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { @@ -6820,7 +6942,7 @@ "signature": [ "any" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false } ], @@ -6835,7 +6957,7 @@ "description": [ "\r\nShape of the events emitted by the telemetryCounter$ observable" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { @@ -6850,7 +6972,7 @@ "signature": [ "TelemetryCounterType" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { @@ -6862,7 +6984,7 @@ "description": [ "\r\nWho emitted the event? It can be \"client\" or the name of the shipper." ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { @@ -6874,7 +6996,7 @@ "description": [ "\r\nThe event type the success/failure/drop event refers to." ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { @@ -6886,7 +7008,7 @@ "description": [ "\r\nCode to provide additional information about the success or failure. Examples are 200/400/504/ValidationError/UnknownError" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { @@ -6898,7 +7020,7 @@ "description": [ "\r\nThe number of events that this counter refers to." ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false } ], @@ -7340,7 +7462,7 @@ "description": [ "\r\nTypes of the Telemetry Counter: It allows to differentiate what happened to the events" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "initialIsOpen": false } @@ -7412,7 +7534,7 @@ "signature": [ "string" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "initialIsOpen": false }, @@ -7903,7 +8025,7 @@ "signature": [ "Pick<", "Toast", - ", \"children\" | \"onClick\" | \"onChange\" | \"color\" | \"onKeyDown\" | \"className\" | \"security\" | \"defaultValue\" | \"hidden\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"lang\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"toastLifeTimeMs\" | \"iconType\" | \"onClose\" | \"data-test-subj\"> & { title?: string | ", + ", \"children\" | \"color\" | \"className\" | \"onChange\" | \"onKeyDown\" | \"onClick\" | \"security\" | \"defaultValue\" | \"hidden\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"lang\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"toastLifeTimeMs\" | \"iconType\" | \"onClose\" | \"data-test-subj\"> & { title?: string | ", { "pluginId": "core", "scope": "public", @@ -7960,7 +8082,7 @@ "signature": [ "Pick<", "Toast", - ", \"children\" | \"onClick\" | \"onChange\" | \"color\" | \"onKeyDown\" | \"className\" | \"security\" | \"defaultValue\" | \"hidden\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"lang\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"toastLifeTimeMs\" | \"iconType\" | \"onClose\" | \"data-test-subj\"> & { title?: string | ", + ", \"children\" | \"color\" | \"className\" | \"onChange\" | \"onKeyDown\" | \"onClick\" | \"security\" | \"defaultValue\" | \"hidden\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"lang\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"toastLifeTimeMs\" | \"iconType\" | \"onClose\" | \"data-test-subj\"> & { title?: string | ", { "pluginId": "core", "scope": "public", @@ -8750,7 +8872,7 @@ "label": "rawConfig", "description": [], "signature": [ - "Readonly<{ username?: string | undefined; password?: string | undefined; serviceAccountToken?: string | undefined; } & { 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; }>; healthCheck: Readonly<{} & { delay: moment.Duration; }>; hosts: string | string[]; sniffOnStart: boolean; sniffInterval: false | moment.Duration; sniffOnConnectionFault: boolean; maxSockets: number; compression: boolean; requestHeadersWhitelist: string | string[]; customHeaders: Record; shardTimeout: moment.Duration; requestTimeout: moment.Duration; pingTimeout: moment.Duration; logQueries: boolean; apiVersion: string; ignoreVersionMismatch: boolean; skipStartupConnectionCheck: boolean; }>" + "Readonly<{ username?: string | undefined; password?: string | undefined; serviceAccountToken?: string | undefined; } & { 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; }>; healthCheck: Readonly<{} & { delay: moment.Duration; }>; customHeaders: Record; hosts: string | string[]; sniffOnStart: boolean; sniffInterval: false | moment.Duration; sniffOnConnectionFault: boolean; maxSockets: number; compression: boolean; requestHeadersWhitelist: string | string[]; shardTimeout: moment.Duration; requestTimeout: moment.Duration; pingTimeout: moment.Duration; logQueries: boolean; apiVersion: string; ignoreVersionMismatch: boolean; skipStartupConnectionCheck: boolean; }>" ], "path": "src/core/server/elasticsearch/elasticsearch_config.ts", "deprecated": false, @@ -8918,7 +9040,7 @@ "description": [ "\r\nAnalytics client's public APIs" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { @@ -8933,7 +9055,7 @@ "signature": [ ">(eventType: string, eventData: EventTypeData) => void" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { @@ -8948,7 +9070,7 @@ "signature": [ "string" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true }, @@ -8964,7 +9086,7 @@ "signature": [ "EventTypeData" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true } @@ -8985,7 +9107,7 @@ "EventTypeOpts", ") => void" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { @@ -8999,7 +9121,7 @@ "EventTypeOpts", "" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true } @@ -9024,7 +9146,7 @@ "RegisterShipperOpts", " | undefined) => void" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { @@ -9040,7 +9162,7 @@ "ShipperClassConstructor", "" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true }, @@ -9056,7 +9178,7 @@ "signature": [ "ShipperConfig" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true }, @@ -9073,7 +9195,7 @@ "RegisterShipperOpts", " | undefined" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": false } @@ -9094,7 +9216,7 @@ "OptInConfig", ") => void" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { @@ -9109,7 +9231,7 @@ "signature": [ "OptInConfig" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true } @@ -9130,7 +9252,7 @@ "ContextProviderOpts", ") => void" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { @@ -9146,7 +9268,7 @@ "ContextProviderOpts", "" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true } @@ -9165,7 +9287,7 @@ "signature": [ "(contextProviderName: string) => void" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { @@ -9180,7 +9302,7 @@ "signature": [ "string" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true } @@ -9202,7 +9324,7 @@ "TelemetryCounter", ">" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false } ], @@ -10300,7 +10422,7 @@ "ContextProviderOpts", "" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { @@ -10312,7 +10434,7 @@ "description": [ "\r\nThe name of the provider." ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { @@ -10328,7 +10450,7 @@ "Observable", "" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { @@ -10345,7 +10467,7 @@ "SchemaValue", "; }" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false } ], @@ -10483,6 +10605,161 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "core", + "id": "def-server.CoreRequestHandlerContext", + "type": "Interface", + "tags": [], + "label": "CoreRequestHandlerContext", + "description": [ + "\nThe `core` context provided to route handler.\n\nProvides the following clients and services:\n - {@link SavedObjectsClient | savedObjects.client} - Saved Objects client\n which uses the credentials of the incoming request\n - {@link ISavedObjectTypeRegistry | savedObjects.typeRegistry} - Type registry containing\n all the registered types.\n - {@link IScopedClusterClient | elasticsearch.client} - Elasticsearch\n data client which uses the credentials of the incoming request\n - {@link IUiSettingsClient | uiSettings.client} - uiSettings client\n which uses the credentials of the incoming request" + ], + "path": "src/core/server/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.CoreRequestHandlerContext.savedObjects", + "type": "Object", + "tags": [], + "label": "savedObjects", + "description": [], + "signature": [ + "{ client: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClientContract", + "text": "SavedObjectsClientContract" + }, + "; typeRegistry: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.ISavedObjectTypeRegistry", + "text": "ISavedObjectTypeRegistry" + }, + "; getClient: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClientProviderOptions", + "text": "SavedObjectsClientProviderOptions" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClientContract", + "text": "SavedObjectsClientContract" + }, + "; getExporter: (client: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClientContract", + "text": "SavedObjectsClientContract" + }, + ") => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.ISavedObjectsExporter", + "text": "ISavedObjectsExporter" + }, + "; getImporter: (client: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClientContract", + "text": "SavedObjectsClientContract" + }, + ") => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.ISavedObjectsImporter", + "text": "ISavedObjectsImporter" + }, + "; }" + ], + "path": "src/core/server/index.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreRequestHandlerContext.elasticsearch", + "type": "Object", + "tags": [], + "label": "elasticsearch", + "description": [], + "signature": [ + "{ client: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.IScopedClusterClient", + "text": "IScopedClusterClient" + }, + "; }" + ], + "path": "src/core/server/index.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreRequestHandlerContext.uiSettings", + "type": "Object", + "tags": [], + "label": "uiSettings", + "description": [], + "signature": [ + "{ client: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.IUiSettingsClient", + "text": "IUiSettingsClient" + }, + "; }" + ], + "path": "src/core/server/index.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.CoreRequestHandlerContext.deprecations", + "type": "Object", + "tags": [], + "label": "deprecations", + "description": [], + "signature": [ + "{ client: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.DeprecationsClient", + "text": "DeprecationsClient" + }, + "; }" + ], + "path": "src/core/server/index.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "core", "id": "def-server.CoreSetup", @@ -11470,6 +11747,21 @@ ], "path": "src/core/server/plugins/types.ts", "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.DiscoveredPlugin.enabledOnAnonymousPages", + "type": "CompoundType", + "tags": [], + "label": "enabledOnAnonymousPages", + "description": [ + "\nSpecifies whether this plugin - and its required dependencies - will be enabled for anonymous pages (login page, status page when\nconfigured, etc.) Default is false." + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false } ], "initialIsOpen": false @@ -12002,7 +12294,7 @@ "signature": [ "Event" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { @@ -12014,7 +12306,7 @@ "description": [ "\r\nThe time the event was generated in ISO format." ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { @@ -12026,7 +12318,7 @@ "description": [ "\r\nThe event type." ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { @@ -12041,7 +12333,7 @@ "signature": [ "{ [x: string]: unknown; }" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { @@ -12056,7 +12348,7 @@ "signature": [ "EventContext" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false } ], @@ -12068,10 +12360,102 @@ "type": "Interface", "tags": [], "label": "EventContext", - "description": [], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "description": [ + "\r\nDefinition of the context that can be appended to the events through the {@link IAnalyticsClient.registerContextProvider}." + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ + { + "parentPluginId": "core", + "id": "def-server.EventContext.userId", + "type": "string", + "tags": [], + "label": "userId", + "description": [ + "\r\nThe unique user ID." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.EventContext.cloudId", + "type": "string", + "tags": [], + "label": "cloudId", + "description": [ + "\r\nThe Cloud ID." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.EventContext.version", + "type": "string", + "tags": [], + "label": "version", + "description": [ + "\r\nThe product's version." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.EventContext.pageName", + "type": "string", + "tags": [], + "label": "pageName", + "description": [ + "\r\nThe name of the current page." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.EventContext.applicationId", + "type": "string", + "tags": [], + "label": "applicationId", + "description": [ + "\r\nThe current application ID." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.EventContext.entityId", + "type": "string", + "tags": [], + "label": "entityId", + "description": [ + "\r\nThe current entity ID (dashboard ID, visualization ID, etc.)." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, { "parentPluginId": "core", "id": "def-server.EventContext.Unnamed", @@ -12082,7 +12466,7 @@ "signature": [ "[key: string]: unknown" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false } ], @@ -12101,7 +12485,7 @@ "EventTypeOpts", "" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { @@ -12113,7 +12497,7 @@ "description": [ "\r\nThe event type's unique name." ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { @@ -12130,7 +12514,7 @@ "SchemaValue", "; }" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false } ], @@ -12236,7 +12620,7 @@ "Headers used for authentication against Elasticsearch" ], "signature": [ - "{ from?: string | string[] | undefined; date?: string | string[] | undefined; range?: string | string[] | undefined; warning?: string | string[] | undefined; location?: string | string[] | undefined; origin?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; etag?: string | string[] | undefined; expect?: string | string[] | undefined; expires?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" + "{ warning?: string | string[] | undefined; from?: string | string[] | undefined; date?: string | string[] | undefined; range?: string | string[] | undefined; location?: string | string[] | undefined; origin?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; etag?: string | string[] | undefined; expect?: string | string[] | undefined; expires?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" ], "path": "src/core/server/elasticsearch/types.ts", "deprecated": false @@ -14725,6 +15109,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -14915,6 +15303,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -15151,6 +15543,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -15582,12 +15978,12 @@ "children": [ { "parentPluginId": "core", - "id": "def-server.IRenderOptions.includeUserSettings", + "id": "def-server.IRenderOptions.isAnonymousPage", "type": "CompoundType", "tags": [], - "label": "includeUserSettings", + "label": "isAnonymousPage", "description": [ - "\nSet whether to output user settings in the page metadata.\n`true` by default." + "\nSet whether the page is anonymous, which determines what plugins are enabled and whether to output user settings in the page metadata.\n`false` by default." ], "signature": [ "boolean | undefined" @@ -18028,7 +18424,7 @@ "description": [ "\r\nBasic structure of a Shipper" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { @@ -18045,7 +18441,7 @@ "Event", "[]) => void" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { @@ -18061,7 +18457,7 @@ "Event", "[]" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true } @@ -18080,7 +18476,7 @@ "signature": [ "(isOptedIn: boolean) => void" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { @@ -18095,7 +18491,7 @@ "signature": [ "boolean" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true } @@ -18116,7 +18512,7 @@ "EventContext", ") => void) | undefined" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { @@ -18129,7 +18525,7 @@ "signature": [ "EventContext" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "isRequired": true } @@ -18151,7 +18547,7 @@ "TelemetryCounter", "> | undefined" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false } ], @@ -18884,7 +19280,7 @@ "label": "loggers", "description": [], "signature": [ - "Readonly<{} & { name: string; level: \"all\" | \"error\" | \"info\" | \"off\" | \"debug\" | \"trace\" | \"warn\" | \"fatal\"; appenders: string[]; }>[] | undefined" + "Readonly<{} & { name: string; level: \"error\" | \"all\" | \"info\" | \"off\" | \"debug\" | \"trace\" | \"warn\" | \"fatal\"; appenders: string[]; }>[] | undefined" ], "path": "src/core/server/logging/logging_config.ts", "deprecated": false @@ -19593,7 +19989,7 @@ "description": [ "\r\n" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { @@ -19608,7 +20004,7 @@ "signature": [ "OptInConfigPerType" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { @@ -19625,7 +20021,7 @@ "OptInConfigPerType", " | undefined> | undefined" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false } ], @@ -20266,6 +20662,21 @@ ], "path": "src/core/server/plugins/types.ts", "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.PluginManifest.enabledOnAnonymousPages", + "type": "CompoundType", + "tags": [], + "label": "enabledOnAnonymousPages", + "description": [ + "\nSpecifies whether this plugin - and its required dependencies - will be enabled for anonymous pages (login page, status page when\nconfigured, etc.) Default is false." + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false } ], "initialIsOpen": false @@ -21781,7 +22192,24 @@ "tags": [], "label": "RequestHandlerContext", "description": [ - "\nPlugin specific context passed to a route handler.\n\nProvides the following clients and services:\n - {@link SavedObjectsClient | savedObjects.client} - Saved Objects client\n which uses the credentials of the incoming request\n - {@link ISavedObjectTypeRegistry | savedObjects.typeRegistry} - Type registry containing\n all the registered types.\n - {@link IScopedClusterClient | elasticsearch.client} - Elasticsearch\n data client which uses the credentials of the incoming request\n - {@link IUiSettingsClient | uiSettings.client} - uiSettings client\n which uses the credentials of the incoming request\n" + "\nBase context passed to a route handler.\n" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.RequestHandlerContext", + "text": "RequestHandlerContext" + }, + " extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.RequestHandlerContextBase", + "text": "RequestHandlerContextBase" + } ], "path": "src/core/server/index.ts", "deprecated": false, @@ -21794,95 +22222,15 @@ "label": "core", "description": [], "signature": [ - "{ savedObjects: { client: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, - "; typeRegistry: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.ISavedObjectTypeRegistry", - "text": "ISavedObjectTypeRegistry" - }, - "; getClient: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientProviderOptions", - "text": "SavedObjectsClientProviderOptions" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, - "; getExporter: (client: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.ISavedObjectsExporter", - "text": "ISavedObjectsExporter" - }, - "; getImporter: (client: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.ISavedObjectsImporter", - "text": "ISavedObjectsImporter" - }, - "; }; elasticsearch: { client: ", + "Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.IScopedClusterClient", - "text": "IScopedClusterClient" - }, - "; }; uiSettings: { client: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IUiSettingsClient", - "text": "IUiSettingsClient" - }, - "; }; deprecations: { client: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.DeprecationsClient", - "text": "DeprecationsClient" + "section": "def-server.CoreRequestHandlerContext", + "text": "CoreRequestHandlerContext" }, - "; }; }" + ">" ], "path": "src/core/server/index.ts", "deprecated": false @@ -21890,6 +22238,53 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "core", + "id": "def-server.RequestHandlerContextBase", + "type": "Interface", + "tags": [], + "label": "RequestHandlerContextBase", + "description": [], + "path": "src/core/server/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.RequestHandlerContextBase.resolve", + "type": "Function", + "tags": [], + "label": "resolve", + "description": [ + "\nAwait all the specified context parts and return them.\n" + ], + "signature": [ + ">(parts: T[]) => Promise<", + "AwaitedProperties", + ">>" + ], + "path": "src/core/server/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.RequestHandlerContextBase.resolve.$1", + "type": "Array", + "tags": [], + "label": "parts", + "description": [], + "signature": [ + "T[]" + ], + "path": "src/core/server/index.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, { "parentPluginId": "core", "id": "def-server.ResolveCapabilitiesOptions", @@ -22530,7 +22925,7 @@ "ShipperClassConstructor", "" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { @@ -22542,7 +22937,7 @@ "description": [ "\r\nThe shipper's unique name" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { @@ -22557,7 +22952,7 @@ "signature": [ "any" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false } ], @@ -22751,7 +23146,7 @@ "description": [ "\r\nShape of the events emitted by the telemetryCounter$ observable" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ { @@ -22766,7 +23161,7 @@ "signature": [ "TelemetryCounterType" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { @@ -22778,7 +23173,7 @@ "description": [ "\r\nWho emitted the event? It can be \"client\" or the name of the shipper." ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { @@ -22790,7 +23185,7 @@ "description": [ "\r\nThe event type the success/failure/drop event refers to." ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { @@ -22802,7 +23197,7 @@ "description": [ "\r\nCode to provide additional information about the success or failure. Examples are 200/400/504/ValidationError/UnknownError" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { @@ -22814,7 +23209,7 @@ "description": [ "\r\nThe number of events that this counter refers to." ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false } ], @@ -23486,7 +23881,7 @@ "description": [ "\r\nTypes of the Telemetry Counter: It allows to differentiate what happened to the events" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "initialIsOpen": false } @@ -23851,6 +24246,27 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "core", + "id": "def-server.CustomRequestHandlerContext", + "type": "Type", + "tags": [], + "label": "CustomRequestHandlerContext", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.RequestHandlerContext", + "text": "RequestHandlerContext" + }, + " & { [Key in keyof T]: T[Key] extends Promise ? T[Key] : Promise; }" + ], + "path": "src/core/server/index.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "core", "id": "def-server.DeprecationsDetails", @@ -23951,7 +24367,7 @@ "label": "EcsEventOutcome", "description": [], "signature": [ - "\"unknown\" | \"success\" | \"failure\"" + "\"success\" | \"unknown\" | \"failure\"" ], "path": "node_modules/@types/kbn__logging/index.d.ts", "deprecated": false, @@ -23965,7 +24381,7 @@ "label": "EcsEventType", "description": [], "signature": [ - "\"start\" | \"user\" | \"error\" | \"info\" | \"group\" | \"end\" | \"protocol\" | \"connection\" | \"access\" | \"admin\" | \"allowed\" | \"change\" | \"creation\" | \"deletion\" | \"denied\" | \"installation\"" + "\"start\" | \"error\" | \"user\" | \"info\" | \"group\" | \"end\" | \"admin\" | \"protocol\" | \"connection\" | \"access\" | \"allowed\" | \"change\" | \"creation\" | \"deletion\" | \"denied\" | \"installation\"" ], "path": "node_modules/@types/kbn__logging/index.d.ts", "deprecated": false, @@ -25193,7 +25609,7 @@ "section": "def-server.ElasticsearchConfig", "text": "ElasticsearchConfig" }, - ", \"username\" | \"hosts\" | \"password\" | \"sniffOnStart\" | \"sniffInterval\" | \"sniffOnConnectionFault\" | \"maxSockets\" | \"compression\" | \"serviceAccountToken\" | \"requestHeadersWhitelist\" | \"customHeaders\"> & { pingTimeout?: number | moment.Duration | undefined; requestTimeout?: number | moment.Duration | undefined; ssl?: Partial; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>, \"key\" | \"verificationMode\" | \"certificate\" | \"keyPassphrase\" | \"alwaysPresentCertificate\"> & { certificateAuthorities?: string[] | undefined; }> | undefined; keepAlive?: boolean | undefined; caFingerprint?: string | undefined; }" + ", \"username\" | \"customHeaders\" | \"hosts\" | \"password\" | \"sniffOnStart\" | \"sniffInterval\" | \"sniffOnConnectionFault\" | \"maxSockets\" | \"compression\" | \"serviceAccountToken\" | \"requestHeadersWhitelist\"> & { pingTimeout?: number | moment.Duration | undefined; requestTimeout?: number | moment.Duration | undefined; ssl?: Partial; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>, \"key\" | \"verificationMode\" | \"certificate\" | \"keyPassphrase\" | \"alwaysPresentCertificate\"> & { certificateAuthorities?: string[] | undefined; }> | undefined; keepAlive?: boolean | undefined; caFingerprint?: string | undefined; }" ], "path": "src/core/server/elasticsearch/client/client_config.ts", "deprecated": false, @@ -25211,7 +25627,7 @@ "signature": [ "string" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "initialIsOpen": false }, @@ -25488,6 +25904,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -25795,6 +26215,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -25851,7 +26275,9 @@ }, ") => ", "KibanaResponse", - "; }) => Context[ContextName] | Promise" + "; }) => ", + "MaybePromise", + ">" ], "path": "src/core/server/context/container/context.ts", "deprecated": false, @@ -26018,6 +26444,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -26106,7 +26536,7 @@ "label": "LoggerConfigType", "description": [], "signature": [ - "{ readonly name: string; readonly level: \"all\" | \"error\" | \"info\" | \"off\" | \"debug\" | \"trace\" | \"warn\" | \"fatal\"; readonly appenders: string[]; }" + "{ readonly name: string; readonly level: \"error\" | \"all\" | \"info\" | \"off\" | \"debug\" | \"trace\" | \"warn\" | \"fatal\"; readonly appenders: string[]; }" ], "path": "src/core/server/logging/logging_config.ts", "deprecated": false, diff --git a/api_docs/core.mdx b/api_docs/core.mdx index 0290b6009ea42..765f93b5bb6f9 100644 --- a/api_docs/core.mdx +++ b/api_docs/core.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core title: "core" image: https://source.unsplash.com/400x175/?github summary: API docs for the core plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2497 | 15 | 971 | 33 | +| 2524 | 15 | 977 | 33 | ## Client diff --git a/api_docs/core_application.devdocs.json b/api_docs/core_application.devdocs.json index cc3cb0a2d1dd2..1f59b41949a3a 100644 --- a/api_docs/core_application.devdocs.json +++ b/api_docs/core_application.devdocs.json @@ -510,7 +510,7 @@ "tags": [], "label": "id", "description": [ - "\nThe unique identifier of the application" + "\nThe unique identifier of the application.\n\nCan only be composed of alphanumeric characters, `-`, `:` and `_`" ], "path": "src/core/public/application/types.ts", "deprecated": false @@ -1210,7 +1210,9 @@ "type": "Object", "tags": [], "label": "options", - "description": [], + "description": [ + "- navigation options" + ], "signature": [ { "pluginId": "core", diff --git a/api_docs/core_application.mdx b/api_docs/core_application.mdx index ad976a37aa5db..680c5de7566c6 100644 --- a/api_docs/core_application.mdx +++ b/api_docs/core_application.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-application title: "core.application" image: https://source.unsplash.com/400x175/?github summary: API docs for the core.application plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.application'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2497 | 15 | 971 | 33 | +| 2524 | 15 | 977 | 33 | ## Client diff --git a/api_docs/core_chrome.mdx b/api_docs/core_chrome.mdx index 09e098a7bf1ba..43eda7a95eaf8 100644 --- a/api_docs/core_chrome.mdx +++ b/api_docs/core_chrome.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-chrome title: "core.chrome" image: https://source.unsplash.com/400x175/?github summary: API docs for the core.chrome plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.chrome'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2497 | 15 | 971 | 33 | +| 2524 | 15 | 977 | 33 | ## Client diff --git a/api_docs/core_http.devdocs.json b/api_docs/core_http.devdocs.json index 1f99d8f6e9bc1..ea42549b15bf9 100644 --- a/api_docs/core_http.devdocs.json +++ b/api_docs/core_http.devdocs.json @@ -2345,7 +2345,7 @@ "\nReadonly copy of incoming request headers." ], "signature": [ - "{ from?: string | string[] | undefined; date?: string | string[] | undefined; range?: string | string[] | undefined; warning?: string | string[] | undefined; location?: string | string[] | undefined; origin?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; etag?: string | string[] | undefined; expect?: string | string[] | undefined; expires?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" + "{ warning?: string | string[] | undefined; from?: string | string[] | undefined; date?: string | string[] | undefined; range?: string | string[] | undefined; location?: string | string[] | undefined; origin?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; etag?: string | string[] | undefined; expect?: string | string[] | undefined; expires?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" ], "path": "src/core/server/http/router/request.ts", "deprecated": false @@ -3946,7 +3946,7 @@ "section": "def-server.RequestHandlerContext", "text": "RequestHandlerContext" }, - ", ContextName extends keyof Context>(contextName: ContextName, provider: ", + ", ContextName extends Exclude>(contextName: ContextName, provider: ", { "pluginId": "core", "scope": "server", @@ -4613,6 +4613,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -4841,6 +4845,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -5121,6 +5129,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -5349,6 +5361,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -5629,6 +5645,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -5857,6 +5877,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -6137,6 +6161,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -6365,6 +6393,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -6645,6 +6677,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -6873,6 +6909,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -7161,6 +7201,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -7343,6 +7387,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -8950,6 +8998,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -9152,6 +9204,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -9397,7 +9453,7 @@ "\nHttp request headers to read." ], "signature": [ - "{ from?: string | string[] | undefined; date?: string | string[] | undefined; range?: string | string[] | undefined; warning?: string | string[] | undefined; location?: string | string[] | undefined; origin?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; etag?: string | string[] | undefined; expect?: string | string[] | undefined; expires?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" + "{ warning?: string | string[] | undefined; from?: string | string[] | undefined; date?: string | string[] | undefined; range?: string | string[] | undefined; location?: string | string[] | undefined; origin?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; etag?: string | string[] | undefined; expect?: string | string[] | undefined; expires?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" ], "path": "src/core/server/http/router/headers.ts", "deprecated": false, @@ -9670,6 +9726,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -9742,7 +9802,7 @@ "\nSet of well-known HTTP headers." ], "signature": [ - "\"from\" | \"date\" | \"range\" | \"warning\" | \"location\" | \"origin\" | \"allow\" | \"accept\" | \"host\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"etag\" | \"expect\" | \"expires\" | \"forwarded\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\"" + "\"warning\" | \"from\" | \"date\" | \"range\" | \"location\" | \"origin\" | \"allow\" | \"accept\" | \"host\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"etag\" | \"expect\" | \"expires\" | \"forwarded\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\"" ], "path": "src/core/server/http/router/headers.ts", "deprecated": false, @@ -9864,6 +9924,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -10016,6 +10080,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -10190,6 +10258,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -10363,6 +10435,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -10537,6 +10613,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -10811,6 +10891,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -10985,6 +11069,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -11318,6 +11406,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -11374,7 +11466,9 @@ }, ") => ", "KibanaResponse", - "; }) => Context[ContextName] | Promise" + "; }) => ", + "MaybePromise", + ">" ], "path": "src/core/server/http/types.ts", "deprecated": false, @@ -11535,6 +11629,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -11759,6 +11857,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -11941,6 +12043,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -12158,7 +12264,7 @@ "\nHttp response headers to set." ], "signature": [ - "Record<\"from\" | \"date\" | \"range\" | \"warning\" | \"location\" | \"origin\" | \"allow\" | \"accept\" | \"host\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"etag\" | \"expect\" | \"expires\" | \"forwarded\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\", string | string[]> | Record" + "Record<\"warning\" | \"from\" | \"date\" | \"range\" | \"location\" | \"origin\" | \"allow\" | \"accept\" | \"host\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"etag\" | \"expect\" | \"expires\" | \"forwarded\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\", string | string[]> | Record" ], "path": "src/core/server/http/router/headers.ts", "deprecated": false, @@ -12362,6 +12468,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -12586,6 +12696,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", diff --git a/api_docs/core_http.mdx b/api_docs/core_http.mdx index 394a7c613118c..954a5b1421f89 100644 --- a/api_docs/core_http.mdx +++ b/api_docs/core_http.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-http title: "core.http" image: https://source.unsplash.com/400x175/?github summary: API docs for the core.http plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.http'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2497 | 15 | 971 | 33 | +| 2524 | 15 | 977 | 33 | ## Client diff --git a/api_docs/core_saved_objects.devdocs.json b/api_docs/core_saved_objects.devdocs.json index 08b910c7268f8..ba6118416a1e1 100644 --- a/api_docs/core_saved_objects.devdocs.json +++ b/api_docs/core_saved_objects.devdocs.json @@ -9895,6 +9895,21 @@ "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", "deprecated": false }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectReferenceWithContext.originId", + "type": "string", + "tags": [], + "label": "originId", + "description": [ + "The origin ID of the referenced object (if it has one)" + ], + "signature": [ + "string | undefined" + ], + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "deprecated": false + }, { "parentPluginId": "core", "id": "def-server.SavedObjectReferenceWithContext.spaces", @@ -9954,6 +9969,21 @@ ], "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectReferenceWithContext.spacesWithMatchingOrigins", + "type": "Array", + "tags": [], + "label": "spacesWithMatchingOrigins", + "description": [ + "The space(s) that objects matching this origin exist in (including this one)" + ], + "signature": [ + "string[] | undefined" + ], + "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "deprecated": false } ], "initialIsOpen": false diff --git a/api_docs/core_saved_objects.mdx b/api_docs/core_saved_objects.mdx index 43c89a9e03e2f..3d2ddcc47ed8a 100644 --- a/api_docs/core_saved_objects.mdx +++ b/api_docs/core_saved_objects.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-savedObjects title: "core.savedObjects" image: https://source.unsplash.com/400x175/?github summary: API docs for the core.savedObjects plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.savedObjects'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2497 | 15 | 971 | 33 | +| 2524 | 15 | 977 | 33 | ## Client diff --git a/api_docs/custom_integrations.mdx b/api_docs/custom_integrations.mdx index d100081f7b272..3d1c022b25501 100644 --- a/api_docs/custom_integrations.mdx +++ b/api_docs/custom_integrations.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/customIntegrations title: "customIntegrations" image: https://source.unsplash.com/400x175/?github summary: API docs for the customIntegrations plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'customIntegrations'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/dashboard.devdocs.json b/api_docs/dashboard.devdocs.json index a7a90e41d4b05..840d4d1eee1e8 100644 --- a/api_docs/dashboard.devdocs.json +++ b/api_docs/dashboard.devdocs.json @@ -1219,7 +1219,13 @@ "label": "controlGroupInput", "description": [], "signature": [ - "DashboardContainerControlGroupInput", + { + "pluginId": "controls", + "scope": "common", + "docId": "kibControlsPluginApi", + "section": "def-common.PersistableControlGroupInput", + "text": "PersistableControlGroupInput" + }, " | undefined" ], "path": "src/plugins/dashboard/public/types.ts", @@ -1952,7 +1958,13 @@ "description": [], "signature": [ "Omit<", - "RawControlGroupAttributes", + { + "pluginId": "controls", + "scope": "common", + "docId": "kibControlsPluginApi", + "section": "def-common.RawControlGroupAttributes", + "text": "RawControlGroupAttributes" + }, ", \"id\"> | undefined" ], "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", @@ -2079,7 +2091,7 @@ "section": "def-common.RawSavedDashboardPanel730ToLatest", "text": "RawSavedDashboardPanel730ToLatest" }, - ", \"type\" | \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\" | \"panelRefName\"> & { readonly id?: string | undefined; readonly type: string; }" + ", \"title\" | \"type\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\" | \"panelRefName\"> & { readonly id?: string | undefined; readonly type: string; }" ], "path": "src/plugins/dashboard/common/types.ts", "deprecated": false, @@ -2431,78 +2443,6 @@ "common": { "classes": [], "functions": [ - { - "parentPluginId": "dashboard", - "id": "def-common.controlGroupInputToRawAttributes", - "type": "Function", - "tags": [], - "label": "controlGroupInputToRawAttributes", - "description": [], - "signature": [ - "(controlGroupInput: Omit<", - { - "pluginId": "controls", - "scope": "common", - "docId": "kibControlsPluginApi", - "section": "def-common.ControlGroupInput", - "text": "ControlGroupInput" - }, - ", \"id\">) => ", - "RawControlGroupAttributes" - ], - "path": "src/plugins/dashboard/common/embeddable/dashboard_control_group.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dashboard", - "id": "def-common.controlGroupInputToRawAttributes.$1", - "type": "Object", - "tags": [], - "label": "controlGroupInput", - "description": [], - "signature": [ - "Omit<", - { - "pluginId": "controls", - "scope": "common", - "docId": "kibControlsPluginApi", - "section": "def-common.ControlGroupInput", - "text": "ControlGroupInput" - }, - ", \"id\">" - ], - "path": "src/plugins/dashboard/common/embeddable/dashboard_control_group.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "dashboard", - "id": "def-common.getDefaultDashboardControlGroupInput", - "type": "Function", - "tags": [], - "label": "getDefaultDashboardControlGroupInput", - "description": [], - "signature": [ - "() => Omit<", - { - "pluginId": "controls", - "scope": "common", - "docId": "kibControlsPluginApi", - "section": "def-common.ControlGroupInput", - "text": "ControlGroupInput" - }, - ", \"id\">" - ], - "path": "src/plugins/dashboard/common/embeddable/dashboard_control_group.ts", - "deprecated": false, - "returnComment": [], - "children": [], - "initialIsOpen": false - }, { "parentPluginId": "dashboard", "id": "def-common.migratePanelsTo730", @@ -2677,118 +2617,6 @@ ], "returnComment": [], "initialIsOpen": false - }, - { - "parentPluginId": "dashboard", - "id": "def-common.rawAttributesToControlGroupInput", - "type": "Function", - "tags": [], - "label": "rawAttributesToControlGroupInput", - "description": [], - "signature": [ - "(rawControlGroupAttributes: ", - "RawControlGroupAttributes", - ") => Omit<", - { - "pluginId": "controls", - "scope": "common", - "docId": "kibControlsPluginApi", - "section": "def-common.ControlGroupInput", - "text": "ControlGroupInput" - }, - ", \"id\"> | undefined" - ], - "path": "src/plugins/dashboard/common/embeddable/dashboard_control_group.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dashboard", - "id": "def-common.rawAttributesToControlGroupInput.$1", - "type": "CompoundType", - "tags": [], - "label": "rawControlGroupAttributes", - "description": [], - "signature": [ - "RawControlGroupAttributes" - ], - "path": "src/plugins/dashboard/common/embeddable/dashboard_control_group.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "dashboard", - "id": "def-common.rawAttributesToSerializable", - "type": "Function", - "tags": [], - "label": "rawAttributesToSerializable", - "description": [], - "signature": [ - "(rawControlGroupAttributes: Omit<", - "RawControlGroupAttributes", - ", \"id\">) => ", - "SerializableRecord" - ], - "path": "src/plugins/dashboard/common/embeddable/dashboard_control_group.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dashboard", - "id": "def-common.rawAttributesToSerializable.$1", - "type": "Object", - "tags": [], - "label": "rawControlGroupAttributes", - "description": [], - "signature": [ - "Omit<", - "RawControlGroupAttributes", - ", \"id\">" - ], - "path": "src/plugins/dashboard/common/embeddable/dashboard_control_group.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "dashboard", - "id": "def-common.serializableToRawAttributes", - "type": "Function", - "tags": [], - "label": "serializableToRawAttributes", - "description": [], - "signature": [ - "(serializable: ", - "SerializableRecord", - ") => Omit<", - "RawControlGroupAttributes", - ", \"type\" | \"id\">" - ], - "path": "src/plugins/dashboard/common/embeddable/dashboard_control_group.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dashboard", - "id": "def-common.serializableToRawAttributes.$1", - "type": "Object", - "tags": [], - "label": "serializable", - "description": [], - "signature": [ - "SerializableRecord" - ], - "path": "src/plugins/dashboard/common/embeddable/dashboard_control_group.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false } ], "interfaces": [ @@ -2850,7 +2678,13 @@ "label": "controlGroupInput", "description": [], "signature": [ - "DashboardContainerControlGroupInput", + { + "pluginId": "controls", + "scope": "common", + "docId": "kibControlsPluginApi", + "section": "def-common.PersistableControlGroupInput", + "text": "PersistableControlGroupInput" + }, " | undefined" ], "path": "src/plugins/dashboard/common/types.ts", @@ -2944,7 +2778,7 @@ "signature": [ "Pick<", "RawSavedDashboardPanel610", - ", \"columns\" | \"title\" | \"sort\" | \"panelIndex\" | \"gridData\" | \"version\"> & { readonly id: string; readonly type: string; }" + ", \"title\" | \"columns\" | \"sort\" | \"panelIndex\" | \"gridData\" | \"version\"> & { readonly id: string; readonly type: string; }" ], "path": "src/plugins/dashboard/common/types.ts", "deprecated": false, @@ -2960,7 +2794,7 @@ "signature": [ "Pick<", "RawSavedDashboardPanel620", - ", \"columns\" | \"title\" | \"sort\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly id: string; readonly type: string; }" + ", \"title\" | \"columns\" | \"sort\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly id: string; readonly type: string; }" ], "path": "src/plugins/dashboard/common/types.ts", "deprecated": false, @@ -2976,7 +2810,7 @@ "signature": [ "Pick<", "RawSavedDashboardPanel620", - ", \"columns\" | \"title\" | \"sort\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly id: string; readonly type: string; }" + ", \"title\" | \"columns\" | \"sort\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly id: string; readonly type: string; }" ], "path": "src/plugins/dashboard/common/types.ts", "deprecated": false, @@ -3014,7 +2848,7 @@ "section": "def-common.RawSavedDashboardPanel730ToLatest", "text": "RawSavedDashboardPanel730ToLatest" }, - ", \"type\" | \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\" | \"panelRefName\"> & { readonly id?: string | undefined; readonly type: string; }" + ", \"title\" | \"type\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\" | \"panelRefName\"> & { readonly id?: string | undefined; readonly type: string; }" ], "path": "src/plugins/dashboard/common/types.ts", "deprecated": false, @@ -3030,7 +2864,7 @@ "signature": [ "Pick<", "RawSavedDashboardPanelTo60", - ", \"columns\" | \"title\" | \"sort\" | \"size_x\" | \"size_y\" | \"row\" | \"col\" | \"panelIndex\"> & { readonly id: string; readonly type: string; }" + ", \"title\" | \"columns\" | \"sort\" | \"size_x\" | \"size_y\" | \"row\" | \"col\" | \"panelIndex\"> & { readonly id: string; readonly type: string; }" ], "path": "src/plugins/dashboard/common/types.ts", "deprecated": false, diff --git a/api_docs/dashboard.mdx b/api_docs/dashboard.mdx index d0f5a00bab677..b7d6084864327 100644 --- a/api_docs/dashboard.mdx +++ b/api_docs/dashboard.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dashboard title: "dashboard" image: https://source.unsplash.com/400x175/?github summary: API docs for the dashboard plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-prese | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 151 | 0 | 149 | 14 | +| 142 | 0 | 140 | 12 | ## Client diff --git a/api_docs/dashboard_enhanced.mdx b/api_docs/dashboard_enhanced.mdx index 532dc65f407b6..458cdf96fef07 100644 --- a/api_docs/dashboard_enhanced.mdx +++ b/api_docs/dashboard_enhanced.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dashboardEnhanced title: "dashboardEnhanced" image: https://source.unsplash.com/400x175/?github summary: API docs for the dashboardEnhanced plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data.devdocs.json b/api_docs/data.devdocs.json index 75239e090a139..62c04ae8d5d64 100644 --- a/api_docs/data.devdocs.json +++ b/api_docs/data.devdocs.json @@ -2395,7 +2395,7 @@ "section": "def-public.PluginInitializerContext", "text": "PluginInitializerContext" }, - "; }>; }>; autocomplete: Readonly<{} & { querySuggestions: Readonly<{} & { enabled: boolean; }>; valueSuggestions: Readonly<{} & { timeout: moment.Duration; enabled: boolean; tiers: string[]; terminateAfter: moment.Duration; }>; }>; }>>" + "; }>; }>; }>>" ], "path": "src/plugins/data/public/plugin.ts", "deprecated": false, @@ -2731,26 +2731,6 @@ "plugin": "dataViewEditor", "path": "src/plugins/data_view_editor/public/open_editor.tsx" }, - { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/hooks/update_kuery_string.ts" - }, - { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/hooks/update_kuery_string.ts" - }, - { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" - }, - { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" - }, - { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" - }, { "plugin": "maps", "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" @@ -3265,6 +3245,96 @@ "children": [], "initialIsOpen": false }, + { + "parentPluginId": "data", + "id": "def-public.NowProvider", + "type": "Class", + "tags": [], + "label": "NowProvider", + "description": [ + "\nUsed to synchronize time between parallel searches with relative time range that rely on `now`." + ], + "path": "src/plugins/data/public/now_provider/now_provider.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.NowProvider.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/data/public/now_provider/now_provider.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-public.NowProvider.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [], + "signature": [ + "() => Date" + ], + "path": "src/plugins/data/public/now_provider/now_provider.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-public.NowProvider.set", + "type": "Function", + "tags": [], + "label": "set", + "description": [], + "signature": [ + "(now: Date) => void" + ], + "path": "src/plugins/data/public/now_provider/now_provider.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.NowProvider.set.$1", + "type": "Object", + "tags": [], + "label": "now", + "description": [], + "signature": [ + "Date" + ], + "path": "src/plugins/data/public/now_provider/now_provider.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-public.NowProvider.reset", + "type": "Function", + "tags": [], + "label": "reset", + "description": [], + "signature": [ + "() => void" + ], + "path": "src/plugins/data/public/now_provider/now_provider.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, { "parentPluginId": "data", "id": "def-public.OptionedParamType", @@ -7626,6 +7696,50 @@ "plugin": "dataViews", "path": "src/plugins/data_views/common/data_views/data_view.ts" }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" + }, { "plugin": "unifiedSearch", "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts" @@ -7660,31 +7774,27 @@ }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" + "path": "src/plugins/unified_search/server/autocomplete/terms_enum.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" + "path": "src/plugins/unified_search/server/autocomplete/terms_enum.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" + "path": "src/plugins/unified_search/server/autocomplete/terms_agg.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/server/utils.ts" + "path": "src/plugins/unified_search/server/autocomplete/terms_agg.ts" }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/server/utils.ts" + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/server/autocomplete/terms_agg.ts" }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/server/utils.ts" + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/server/autocomplete/terms_agg.ts" }, { "plugin": "unifiedSearch", @@ -7711,24 +7821,28 @@ "path": "src/plugins/unified_search/public/filter_bar/filter_editor/value_input_type.tsx" }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/utils.test.ts" + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/utils.test.ts" + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/fields.mocks.ts" + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" }, { "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/fields.mocks.ts" + "path": "src/plugins/data_views/common/utils.test.ts" }, { "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/fields.mocks.ts" + "path": "src/plugins/data_views/common/utils.test.ts" } ], "children": [ @@ -8028,155 +8142,31 @@ }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/query_string_input/query_bar_top_row.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/query_string_input/query_bar_top_row.tsx" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/alerts/components/param_details_form/use_derived_index_pattern.tsx" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/alerts/components/param_details_form/use_derived_index_pattern.tsx" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/components/kuery_bar/with_kuery_autocompletion.tsx" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/components/kuery_bar/with_kuery_autocompletion.tsx" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/components/kuery_bar/index.tsx" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/components/kuery_bar/index.tsx" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/lib/kuery.ts" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/lib/kuery.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/phrase_suggestor.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/phrase_suggestor.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_item.tsx" + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_item.tsx" + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_bar.tsx" + "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_bar.tsx" + "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/search_bar/search_bar.tsx" + "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/search_bar/search_bar.tsx" + "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/apply_filters/apply_filter_popover_content.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/apply_filters/apply_filter_popover_content.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/apply_filters/apply_filters_popover.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/apply_filters/apply_filters_popover.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/read_only_filter_items.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/read_only_filter_items.tsx" + "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" } ], "children": [ @@ -9581,7 +9571,7 @@ "label": "AggConfigOptions", "description": [], "signature": [ - "{ type: ", + "{ id?: string | undefined; type: ", { "pluginId": "data", "scope": "common", @@ -9589,7 +9579,7 @@ "section": "def-common.IAggType", "text": "IAggType" }, - "; id?: string | undefined; enabled?: boolean | undefined; params?: {} | ", + "; enabled?: boolean | undefined; params?: {} | ", "SerializableRecord", " | undefined; schema?: string | undefined; }" ], @@ -10727,14 +10717,6 @@ "plugin": "dataViews", "path": "src/plugins/data_views/public/index.ts" }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/query_string_input/fetch_index_patterns.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/query_string_input/fetch_index_patterns.ts" - }, { "plugin": "unifiedSearch", "path": "src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx" @@ -11119,12 +11101,60 @@ "removeBy": "8.1", "references": [ { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/types.ts" + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts" }, { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/types.ts" + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.test.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.test.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.test.ts" + }, + { + "plugin": "dataEnhanced", + "path": "x-pack/plugins/data_enhanced/server/search/session/types.ts" + }, + { + "plugin": "dataEnhanced", + "path": "x-pack/plugins/data_enhanced/server/search/session/types.ts" }, { "plugin": "dataEnhanced", @@ -11182,6 +11212,20 @@ "references": [], "initialIsOpen": false }, + { + "parentPluginId": "data", + "id": "def-public.NowProviderInternalContract", + "type": "Type", + "tags": [], + "label": "NowProviderInternalContract", + "description": [], + "signature": [ + "{ get: () => Date; set: (now: Date) => void; reset: () => void; }" + ], + "path": "src/plugins/data/public/now_provider/now_provider.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "data", "id": "def-public.ParsedInterval", @@ -12237,8 +12281,8 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, "[]) => string" ], @@ -12275,8 +12319,8 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, "[]" ], @@ -12560,9 +12604,9 @@ "Observable", "; getTimeUpdate$: () => ", "Observable", - "; getRefreshIntervalUpdate$: () => ", + "; getRefreshIntervalUpdate$: () => ", "Observable", - "; getAutoRefreshFetch$: () => ", + "; getAutoRefreshFetch$: () => ", "Observable", "<", { @@ -12574,7 +12618,7 @@ }, ">; getFetch$: () => ", "Observable", - "; getTime: () => ", + "; getTime: () => ", { "pluginId": "data", "scope": "common", @@ -14725,27 +14769,6 @@ "path": "src/plugins/data/public/types.ts", "deprecated": false, "children": [ - { - "parentPluginId": "data", - "id": "def-public.DataPublicPluginSetup.autocomplete", - "type": "Object", - "tags": [], - "label": "autocomplete", - "description": [], - "signature": [ - "{ getQuerySuggestions: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataAutocompletePluginApi", - "section": "def-public.QuerySuggestionGetFn", - "text": "QuerySuggestionGetFn" - }, - "; getAutocompleteSettings: () => { terminateAfter: number; timeout: number; }; }" - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": false - }, { "parentPluginId": "data", "id": "def-public.DataPublicPluginSetup.search", @@ -14782,7 +14805,13 @@ "text": "FilterManager" }, "; timefilter: ", - "TimefilterSetup", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.TimefilterSetup", + "text": "TimefilterSetup" + }, "; queryString: ", { "pluginId": "data", @@ -14851,31 +14880,6 @@ "path": "src/plugins/data/public/types.ts", "deprecated": false }, - { - "parentPluginId": "data", - "id": "def-public.DataPublicPluginStart.autocomplete", - "type": "Object", - "tags": [], - "label": "autocomplete", - "description": [ - "\nautocomplete service\n{@link AutocompleteStart}" - ], - "signature": [ - "{ getQuerySuggestions: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataAutocompletePluginApi", - "section": "def-public.QuerySuggestionGetFn", - "text": "QuerySuggestionGetFn" - }, - "; hasQuerySuggestions: (language: string) => boolean; getValueSuggestions: ", - "ValueSuggestionsGetFn", - "; }" - ], - "path": "src/plugins/data/public/types.ts", - "deprecated": false - }, { "parentPluginId": "data", "id": "def-public.DataPublicPluginStart.dataViews", @@ -14949,14 +14953,6 @@ "plugin": "graph", "path": "x-pack/plugins/graph/public/plugin.ts" }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/alerts/components/param_details_form/use_derived_index_pattern.tsx" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/alerts/components/param_details_form/use_derived_index_pattern.tsx" - }, { "plugin": "securitySolution", "path": "x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts" @@ -14981,10 +14977,6 @@ "plugin": "stackAlerts", "path": "x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx" }, - { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" - }, { "plugin": "inputControlVis", "path": "src/plugins/input_control_vis/public/control/list_control_factory.ts" @@ -15232,7 +15224,13 @@ "text": "QueryState" }, "; }>; timefilter: ", - "TimefilterSetup", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.TimefilterSetup", + "text": "TimefilterSetup" + }, "; getEsQuery: (indexPattern: ", { "pluginId": "dataViews", @@ -15352,7 +15350,7 @@ "section": "def-server.PluginInitializerContext", "text": "PluginInitializerContext" }, - "; }>; }>; autocomplete: Readonly<{} & { querySuggestions: Readonly<{} & { enabled: boolean; }>; valueSuggestions: Readonly<{} & { timeout: moment.Duration; enabled: boolean; tiers: string[]; terminateAfter: moment.Duration; }>; }>; }>>" + "; }>; }>; }>>" ], "path": "src/plugins/data/server/plugin.ts", "deprecated": false, @@ -15389,7 +15387,7 @@ }, ">, { bfetch, expressions, usageCollection, fieldFormats }: ", "DataPluginSetupDependencies", - ") => { autocomplete: { getAutocompleteSettings: () => { terminateAfter: number; timeout: number; }; }; __enhance: (enhancements: DataEnhancements) => void; search: ", + ") => { __enhance: (enhancements: DataEnhancements) => void; search: ", "ISearchSetup", "; query: { filterManager: { extract: (filters: ", "Filter", @@ -17157,26 +17155,6 @@ "plugin": "dataViewEditor", "path": "src/plugins/data_view_editor/public/open_editor.tsx" }, - { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/hooks/update_kuery_string.ts" - }, - { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/hooks/update_kuery_string.ts" - }, - { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" - }, - { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" - }, - { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" - }, { "plugin": "maps", "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" @@ -18113,6 +18091,44 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "data", + "id": "def-server.getRequestAbortedSignal", + "type": "Function", + "tags": [], + "label": "getRequestAbortedSignal", + "description": [ + "\nA simple utility function that returns an `AbortSignal` corresponding to an `AbortController`\nwhich aborts when the given request is aborted." + ], + "signature": [ + "(aborted$: ", + "Observable", + ") => AbortSignal" + ], + "path": "src/plugins/data/server/lib/get_request_aborted_signal.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.getRequestAbortedSignal.$1", + "type": "Object", + "tags": [], + "label": "aborted$", + "description": [ + "The observable of abort events (usually `request.events.aborted$`)" + ], + "signature": [ + "Observable", + "" + ], + "path": "src/plugins/data/server/lib/get_request_aborted_signal.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "data", "id": "def-server.getTime", @@ -18463,552 +18479,103 @@ }, { "parentPluginId": "data", - "id": "def-server.IFieldType", + "id": "def-server.ISearchOptions", "type": "Interface", - "tags": [ - "deprecated" - ], - "label": "IFieldType", + "tags": [], + "label": "ISearchOptions", "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " extends ", - "DataViewFieldBase" - ], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": true, - "removeBy": "8.2", - "references": [ + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false, + "children": [ { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/utils.ts" + "parentPluginId": "data", + "id": "def-server.ISearchOptions.abortSignal", + "type": "Object", + "tags": [], + "label": "abortSignal", + "description": [ + "\nAn `AbortSignal` that allows the caller of `search` to abort a search request." + ], + "signature": [ + "AbortSignal | undefined" + ], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/utils.ts" + "parentPluginId": "data", + "id": "def-server.ISearchOptions.strategy", + "type": "string", + "tags": [], + "label": "strategy", + "description": [ + "\nUse this option to force using a specific server side search strategy. Leave empty to use the default strategy." + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/data_view_field.ts" + "parentPluginId": "data", + "id": "def-server.ISearchOptions.legacyHitsTotal", + "type": "CompoundType", + "tags": [], + "label": "legacyHitsTotal", + "description": [ + "\nRequest the legacy format for the total number of hits. If sending `rest_total_hits_as_int` to\nsomething other than `true`, this should be set to `false`." + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/data_view_field.ts" + "parentPluginId": "data", + "id": "def-server.ISearchOptions.sessionId", + "type": "string", + "tags": [], + "label": "sessionId", + "description": [ + "\nA session ID, grouping multiple search requests into a single session." + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/field_list.ts" + "parentPluginId": "data", + "id": "def-server.ISearchOptions.isStored", + "type": "CompoundType", + "tags": [], + "label": "isStored", + "description": [ + "\nWhether the session is already saved (i.e. sent to background)" + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/field_list.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/field_list.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/field_list.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/types.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/types.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/types.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/types.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/index.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/data_views/data_view.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/phrase_suggestor.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/phrase_suggestor.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/range_value_input.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/range_value_input.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/server/utils.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/server/utils.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/server/utils.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_operators.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_operators.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_operators.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_operators.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/value_input_type.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/value_input_type.tsx" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/utils.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/utils.test.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/fields.mocks.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/fields.mocks.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/fields.mocks.ts" - } - ], - "children": [ - { - "parentPluginId": "data", - "id": "def-server.IFieldType.count", - "type": "number", - "tags": [], - "label": "count", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.IFieldType.esTypes", - "type": "Array", - "tags": [], - "label": "esTypes", - "description": [], - "signature": [ - "string[] | undefined" - ], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.IFieldType.aggregatable", - "type": "CompoundType", - "tags": [], - "label": "aggregatable", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.IFieldType.filterable", - "type": "CompoundType", - "tags": [], - "label": "filterable", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.IFieldType.searchable", - "type": "CompoundType", - "tags": [], - "label": "searchable", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.IFieldType.sortable", - "type": "CompoundType", - "tags": [], - "label": "sortable", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.IFieldType.visualizable", - "type": "CompoundType", - "tags": [], - "label": "visualizable", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.IFieldType.readFromDocValues", - "type": "CompoundType", - "tags": [], - "label": "readFromDocValues", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.IFieldType.displayName", - "type": "string", - "tags": [], - "label": "displayName", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.IFieldType.customLabel", - "type": "string", - "tags": [], - "label": "customLabel", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.IFieldType.format", - "type": "Any", - "tags": [], - "label": "format", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.IFieldType.toSpec", - "type": "Function", - "tags": [], - "label": "toSpec", - "description": [], - "signature": [ - "((options?: { getFormatterForField?: ((field: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - ") => ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - }, - ") | undefined; } | undefined) => ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - ") | undefined" - ], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.IFieldType.toSpec.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.IFieldType.toSpec.$1.getFormatterForField", - "type": "Function", - "tags": [], - "label": "getFormatterForField", - "description": [], - "signature": [ - "((field: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.FieldSpec", - "text": "FieldSpec" - }, - " | ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataViewField", - "text": "DataViewField" - }, - ") => ", - { - "pluginId": "fieldFormats", - "scope": "common", - "docId": "kibFieldFormatsPluginApi", - "section": "def-common.FieldFormat", - "text": "FieldFormat" - }, - ") | undefined" - ], - "path": "src/plugins/data_views/common/fields/types.ts", - "deprecated": false - } - ] - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.ISearchOptions", - "type": "Interface", - "tags": [], - "label": "ISearchOptions", - "description": [], - "path": "src/plugins/data/common/search/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.ISearchOptions.abortSignal", - "type": "Object", - "tags": [], - "label": "abortSignal", - "description": [ - "\nAn `AbortSignal` that allows the caller of `search` to abort a search request." - ], - "signature": [ - "AbortSignal | undefined" - ], - "path": "src/plugins/data/common/search/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.ISearchOptions.strategy", - "type": "string", - "tags": [], - "label": "strategy", - "description": [ - "\nUse this option to force using a specific server side search strategy. Leave empty to use the default strategy." - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data/common/search/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.ISearchOptions.legacyHitsTotal", - "type": "CompoundType", - "tags": [], - "label": "legacyHitsTotal", - "description": [ - "\nRequest the legacy format for the total number of hits. If sending `rest_total_hits_as_int` to\nsomething other than `true`, this should be set to `false`." - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data/common/search/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.ISearchOptions.sessionId", - "type": "string", - "tags": [], - "label": "sessionId", - "description": [ - "\nA session ID, grouping multiple search requests into a single session." - ], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data/common/search/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.ISearchOptions.isStored", - "type": "CompoundType", - "tags": [], - "label": "isStored", - "description": [ - "\nWhether the session is already saved (i.e. sent to background)" - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data/common/search/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-server.ISearchOptions.isRestore", - "type": "CompoundType", - "tags": [], - "label": "isRestore", - "description": [ - "\nWhether the session is restored (i.e. search requests should re-use the stored search IDs,\nrather than starting from scratch)" - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data/common/search/types.ts", - "deprecated": false + "parentPluginId": "data", + "id": "def-server.ISearchOptions.isRestore", + "type": "CompoundType", + "tags": [], + "label": "isRestore", + "description": [ + "\nWhether the session is restored (i.e. search requests should re-use the stored search IDs,\nrather than starting from scratch)" + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false }, { "parentPluginId": "data", @@ -19456,30 +19023,78 @@ "description": [], "signature": [ { - "pluginId": "dataViews", - "scope": "server", - "docId": "kibDataViewsPluginApi", - "section": "def-server.DataViewsServerPluginStart", - "text": "DataViewsServerPluginStart" - } - ], - "path": "src/plugins/data_views/server/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-server.KueryNode", - "type": "Type", - "tags": [ - "deprecated" - ], - "label": "KueryNode", - "description": [], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "removeBy": "8.1", - "references": [ + "pluginId": "dataViews", + "scope": "server", + "docId": "kibDataViewsPluginApi", + "section": "def-server.DataViewsServerPluginStart", + "text": "DataViewsServerPluginStart" + } + ], + "path": "src/plugins/data_views/server/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-server.KueryNode", + "type": "Type", + "tags": [ + "deprecated" + ], + "label": "KueryNode", + "description": [], + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "removeBy": "8.1", + "references": [ + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.test.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.test.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.test.ts" + }, { "plugin": "dataEnhanced", "path": "x-pack/plugins/data_enhanced/server/search/session/types.ts" @@ -20795,19 +20410,6 @@ "path": "src/plugins/data/server/plugin.ts", "deprecated": false, "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataPluginSetup.autocomplete", - "type": "Object", - "tags": [], - "label": "autocomplete", - "description": [], - "signature": [ - "{ getAutocompleteSettings: () => { terminateAfter: number; timeout: number; }; }" - ], - "path": "src/plugins/data/server/plugin.ts", - "deprecated": false - }, { "parentPluginId": "data", "id": "def-server.DataPluginSetup.search", @@ -25044,26 +24646,6 @@ "plugin": "dataViewEditor", "path": "src/plugins/data_view_editor/public/open_editor.tsx" }, - { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/hooks/update_kuery_string.ts" - }, - { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/hooks/update_kuery_string.ts" - }, - { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" - }, - { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" - }, - { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" - }, { "plugin": "maps", "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" @@ -29492,6 +29074,50 @@ "plugin": "dataViews", "path": "src/plugins/data_views/common/data_views/data_view.ts" }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" + }, { "plugin": "unifiedSearch", "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts" @@ -29526,31 +29152,27 @@ }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" + "path": "src/plugins/unified_search/server/autocomplete/terms_enum.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" + "path": "src/plugins/unified_search/server/autocomplete/terms_enum.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" + "path": "src/plugins/unified_search/server/autocomplete/terms_agg.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" + "path": "src/plugins/unified_search/server/autocomplete/terms_agg.ts" }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/server/utils.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/server/utils.ts" + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/server/autocomplete/terms_agg.ts" }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/server/utils.ts" + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/server/autocomplete/terms_agg.ts" }, { "plugin": "unifiedSearch", @@ -29577,24 +29199,28 @@ "path": "src/plugins/unified_search/public/filter_bar/filter_editor/value_input_type.tsx" }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/utils.test.ts" + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/utils.test.ts" + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" }, { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/fields.mocks.ts" + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" }, { "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/fields.mocks.ts" + "path": "src/plugins/data_views/common/utils.test.ts" }, { "plugin": "dataViews", - "path": "src/plugins/data_views/common/fields/fields.mocks.ts" + "path": "src/plugins/data_views/common/utils.test.ts" } ], "children": [ @@ -29894,155 +29520,31 @@ }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/query_string_input/query_bar_top_row.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/query_string_input/query_bar_top_row.tsx" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/alerts/components/param_details_form/use_derived_index_pattern.tsx" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/alerts/components/param_details_form/use_derived_index_pattern.tsx" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/components/kuery_bar/with_kuery_autocompletion.tsx" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/components/kuery_bar/with_kuery_autocompletion.tsx" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/components/kuery_bar/index.tsx" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/components/kuery_bar/index.tsx" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/lib/kuery.ts" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/lib/kuery.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/phrase_suggestor.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/phrase_suggestor.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_item.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_item.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_bar.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_bar.tsx" + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/search_bar/search_bar.tsx" + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/search_bar/search_bar.tsx" + "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/apply_filters/apply_filter_popover_content.tsx" + "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/apply_filters/apply_filter_popover_content.tsx" + "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/apply_filters/apply_filters_popover.tsx" + "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/apply_filters/apply_filters_popover.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/read_only_filter_items.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/read_only_filter_items.tsx" + "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" } ], "children": [ @@ -32586,14 +32088,6 @@ "plugin": "dataViews", "path": "src/plugins/data_views/public/index.ts" }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/query_string_input/fetch_index_patterns.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/query_string_input/fetch_index_patterns.ts" - }, { "plugin": "unifiedSearch", "path": "src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx" @@ -32648,6 +32142,54 @@ "deprecated": true, "removeBy": "8.1", "references": [ + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.test.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.test.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.test.ts" + }, { "plugin": "dataEnhanced", "path": "x-pack/plugins/data_enhanced/server/search/session/types.ts" @@ -32815,7 +32357,7 @@ "signature": [ "Pick<", "Toast", - ", \"children\" | \"onClick\" | \"onChange\" | \"color\" | \"onKeyDown\" | \"className\" | \"security\" | \"defaultValue\" | \"hidden\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"lang\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"toastLifeTimeMs\" | \"iconType\" | \"onClose\" | \"data-test-subj\"> & { title?: string | ", + ", \"children\" | \"color\" | \"className\" | \"onChange\" | \"onKeyDown\" | \"onClick\" | \"security\" | \"defaultValue\" | \"hidden\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"lang\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"toastLifeTimeMs\" | \"iconType\" | \"onClose\" | \"data-test-subj\"> & { title?: string | ", { "pluginId": "core", "scope": "public", diff --git a/api_docs/data.mdx b/api_docs/data.mdx index 354f58d2afd80..a876abb895181 100644 --- a/api_docs/data.mdx +++ b/api_docs/data.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/data title: "data" image: https://source.unsplash.com/400x175/?github summary: API docs for the data plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 3426 | 40 | 2816 | 20 | +| 3414 | 38 | 2802 | 18 | ## Client diff --git a/api_docs/data_autocomplete.devdocs.json b/api_docs/data_autocomplete.devdocs.json deleted file mode 100644 index 63229979a6082..0000000000000 --- a/api_docs/data_autocomplete.devdocs.json +++ /dev/null @@ -1,434 +0,0 @@ -{ - "id": "data.autocomplete", - "client": { - "classes": [], - "functions": [], - "interfaces": [ - { - "parentPluginId": "data", - "id": "def-public.QuerySuggestionBasic", - "type": "Interface", - "tags": [], - "label": "QuerySuggestionBasic", - "description": [], - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-public.QuerySuggestionBasic.type", - "type": "Enum", - "tags": [], - "label": "type", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataAutocompletePluginApi", - "section": "def-public.QuerySuggestionTypes", - "text": "QuerySuggestionTypes" - } - ], - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.QuerySuggestionBasic.description", - "type": "CompoundType", - "tags": [], - "label": "description", - "description": [], - "signature": [ - "string | JSX.Element | undefined" - ], - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.QuerySuggestionBasic.end", - "type": "number", - "tags": [], - "label": "end", - "description": [], - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.QuerySuggestionBasic.start", - "type": "number", - "tags": [], - "label": "start", - "description": [], - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.QuerySuggestionBasic.text", - "type": "string", - "tags": [], - "label": "text", - "description": [], - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.QuerySuggestionBasic.cursorIndex", - "type": "number", - "tags": [], - "label": "cursorIndex", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.QuerySuggestionField", - "type": "Interface", - "tags": [], - "label": "QuerySuggestionField", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataAutocompletePluginApi", - "section": "def-public.QuerySuggestionField", - "text": "QuerySuggestionField" - }, - " extends ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataAutocompletePluginApi", - "section": "def-public.QuerySuggestionBasic", - "text": "QuerySuggestionBasic" - } - ], - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-public.QuerySuggestionField.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataAutocompletePluginApi", - "section": "def-public.QuerySuggestionTypes", - "text": "QuerySuggestionTypes" - }, - ".Field" - ], - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.QuerySuggestionField.field", - "type": "Object", - "tags": [], - "label": "field", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" - } - ], - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.QuerySuggestionGetFnArgs", - "type": "Interface", - "tags": [], - "label": "QuerySuggestionGetFnArgs", - "description": [], - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-public.QuerySuggestionGetFnArgs.language", - "type": "string", - "tags": [], - "label": "language", - "description": [], - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.QuerySuggestionGetFnArgs.indexPatterns", - "type": "Array", - "tags": [], - "label": "indexPatterns", - "description": [], - "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" - }, - "[]" - ], - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.QuerySuggestionGetFnArgs.query", - "type": "string", - "tags": [], - "label": "query", - "description": [], - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.QuerySuggestionGetFnArgs.selectionStart", - "type": "number", - "tags": [], - "label": "selectionStart", - "description": [], - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.QuerySuggestionGetFnArgs.selectionEnd", - "type": "number", - "tags": [], - "label": "selectionEnd", - "description": [], - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.QuerySuggestionGetFnArgs.signal", - "type": "Object", - "tags": [], - "label": "signal", - "description": [], - "signature": [ - "AbortSignal | undefined" - ], - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.QuerySuggestionGetFnArgs.useTimeRange", - "type": "CompoundType", - "tags": [], - "label": "useTimeRange", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.QuerySuggestionGetFnArgs.boolFilter", - "type": "Any", - "tags": [], - "label": "boolFilter", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.QuerySuggestionGetFnArgs.method", - "type": "CompoundType", - "tags": [], - "label": "method", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataPluginApi", - "section": "def-common.ValueSuggestionsMethod", - "text": "ValueSuggestionsMethod" - }, - " | undefined" - ], - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", - "deprecated": false - } - ], - "initialIsOpen": false - } - ], - "enums": [ - { - "parentPluginId": "data", - "id": "def-public.QuerySuggestionTypes", - "type": "Enum", - "tags": [], - "label": "QuerySuggestionTypes", - "description": [], - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", - "deprecated": false, - "initialIsOpen": false - } - ], - "misc": [ - { - "parentPluginId": "data", - "id": "def-public.AutocompleteStart", - "type": "Type", - "tags": [], - "label": "AutocompleteStart", - "description": [], - "signature": [ - "{ getQuerySuggestions: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataAutocompletePluginApi", - "section": "def-public.QuerySuggestionGetFn", - "text": "QuerySuggestionGetFn" - }, - "; hasQuerySuggestions: (language: string) => boolean; getValueSuggestions: ", - "ValueSuggestionsGetFn", - "; }" - ], - "path": "src/plugins/data/public/autocomplete/autocomplete_service.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.QuerySuggestion", - "type": "Type", - "tags": [], - "label": "QuerySuggestion", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataAutocompletePluginApi", - "section": "def-public.QuerySuggestionBasic", - "text": "QuerySuggestionBasic" - }, - " | ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataAutocompletePluginApi", - "section": "def-public.QuerySuggestionField", - "text": "QuerySuggestionField" - } - ], - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.QuerySuggestionGetFn", - "type": "Type", - "tags": [], - "label": "QuerySuggestionGetFn", - "description": [], - "signature": [ - "(args: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataAutocompletePluginApi", - "section": "def-public.QuerySuggestionGetFnArgs", - "text": "QuerySuggestionGetFnArgs" - }, - ") => Promise<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataAutocompletePluginApi", - "section": "def-public.QuerySuggestion", - "text": "QuerySuggestion" - }, - "[]> | undefined" - ], - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "data", - "id": "def-public.QuerySuggestionGetFn.$1", - "type": "Object", - "tags": [], - "label": "args", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataAutocompletePluginApi", - "section": "def-public.QuerySuggestionGetFnArgs", - "text": "QuerySuggestionGetFnArgs" - } - ], - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", - "deprecated": false - } - ], - "initialIsOpen": false - } - ], - "objects": [] - }, - "server": { - "classes": [], - "functions": [], - "interfaces": [], - "enums": [], - "misc": [], - "objects": [] - }, - "common": { - "classes": [], - "functions": [], - "interfaces": [], - "enums": [], - "misc": [], - "objects": [] - } -} \ No newline at end of file diff --git a/api_docs/data_autocomplete.mdx b/api_docs/data_autocomplete.mdx deleted file mode 100644 index 731ed5bb655e7..0000000000000 --- a/api_docs/data_autocomplete.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -id: kibDataAutocompletePluginApi -slug: /kibana-dev-docs/api/data-autocomplete -title: "data.autocomplete" -image: https://source.unsplash.com/400x175/?github -summary: API docs for the data.autocomplete plugin -date: 2022-04-05 -tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.autocomplete'] -warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. ---- -import dataAutocompleteObj from './data_autocomplete.devdocs.json'; - -Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters. - -Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) for questions regarding this plugin. - -**Code health stats** - -| Public API count | Any count | Items lacking comments | Missing exports | -|-------------------|-----------|------------------------|-----------------| -| 3426 | 40 | 2816 | 20 | - -## Client - -### Interfaces - - -### Enums - - -### Consts, variables and types - - diff --git a/api_docs/data_enhanced.mdx b/api_docs/data_enhanced.mdx index 03a5d056398c2..6eb3ac5dc589d 100644 --- a/api_docs/data_enhanced.mdx +++ b/api_docs/data_enhanced.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataEnhanced title: "dataEnhanced" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataEnhanced plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataEnhanced'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data_query.devdocs.json b/api_docs/data_query.devdocs.json index 4cccb61a48547..db5f5e436135d 100644 --- a/api_docs/data_query.devdocs.json +++ b/api_docs/data_query.devdocs.json @@ -863,6 +863,347 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "data", + "id": "def-public.QueryService", + "type": "Class", + "tags": [], + "label": "QueryService", + "description": [], + "path": "src/plugins/data/public/query/query_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.QueryService.filterManager", + "type": "Object", + "tags": [], + "label": "filterManager", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.FilterManager", + "text": "FilterManager" + } + ], + "path": "src/plugins/data/public/query/query_service.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.QueryService.timefilter", + "type": "Object", + "tags": [], + "label": "timefilter", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.TimefilterSetup", + "text": "TimefilterSetup" + } + ], + "path": "src/plugins/data/public/query/query_service.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.QueryService.queryStringManager", + "type": "Object", + "tags": [], + "label": "queryStringManager", + "description": [], + "signature": [ + "{ getDefaultQuery: () => { query: string; language: any; }; formatQuery: (query: string | ", + "Query", + " | undefined) => ", + "Query", + "; getUpdates$: () => ", + "Observable", + "<", + "Query", + ">; getQuery: () => ", + "Query", + "; setQuery: (query: ", + "Query", + ") => void; clearQuery: () => void; }" + ], + "path": "src/plugins/data/public/query/query_service.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.QueryService.state$", + "type": "Object", + "tags": [], + "label": "state$", + "description": [], + "signature": [ + "Observable", + "<{ changes: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.QueryStateChange", + "text": "QueryStateChange" + }, + "; state: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.QueryState", + "text": "QueryState" + }, + "; }>" + ], + "path": "src/plugins/data/public/query/query_service.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.QueryService.setup", + "type": "Function", + "tags": [], + "label": "setup", + "description": [], + "signature": [ + "({ storage, uiSettings, nowProvider }: QueryServiceSetupDependencies) => { filterManager: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.FilterManager", + "text": "FilterManager" + }, + "; timefilter: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.TimefilterSetup", + "text": "TimefilterSetup" + }, + "; queryString: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.QueryStringContract", + "text": "QueryStringContract" + }, + "; state$: ", + "Observable", + "<{ changes: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.QueryStateChange", + "text": "QueryStateChange" + }, + "; state: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.QueryState", + "text": "QueryState" + }, + "; }>; }" + ], + "path": "src/plugins/data/public/query/query_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.QueryService.setup.$1", + "type": "Object", + "tags": [], + "label": "{ storage, uiSettings, nowProvider }", + "description": [], + "signature": [ + "QueryServiceSetupDependencies" + ], + "path": "src/plugins/data/public/query/query_service.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-public.QueryService.start", + "type": "Function", + "tags": [], + "label": "start", + "description": [], + "signature": [ + "({ storage, uiSettings, http }: QueryServiceStartDependencies) => { addToQueryLog: (appName: string, { language, query }: ", + "Query", + ") => void; filterManager: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.FilterManager", + "text": "FilterManager" + }, + "; queryString: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.QueryStringContract", + "text": "QueryStringContract" + }, + "; savedQueries: { createQuery: (attributes: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.SavedQueryAttributes", + "text": "SavedQueryAttributes" + }, + ", { overwrite }?: { overwrite?: boolean | undefined; }) => Promise<", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.SavedQuery", + "text": "SavedQuery" + }, + ">; updateQuery: (id: string, attributes: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.SavedQueryAttributes", + "text": "SavedQueryAttributes" + }, + ") => Promise<", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.SavedQuery", + "text": "SavedQuery" + }, + ">; getAllSavedQueries: () => Promise<", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.SavedQuery", + "text": "SavedQuery" + }, + "[]>; findSavedQueries: (search?: string, perPage?: number, page?: number) => Promise<{ total: number; queries: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.SavedQuery", + "text": "SavedQuery" + }, + "[]; }>; getSavedQuery: (id: string) => Promise<", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.SavedQuery", + "text": "SavedQuery" + }, + ">; deleteSavedQuery: (id: string) => Promise<{}>; getSavedQueryCount: () => Promise; }; state$: ", + "Observable", + "<{ changes: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.QueryStateChange", + "text": "QueryStateChange" + }, + "; state: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.QueryState", + "text": "QueryState" + }, + "; }>; timefilter: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.TimefilterSetup", + "text": "TimefilterSetup" + }, + "; getEsQuery: (indexPattern: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + }, + ", timeRange?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined) => { bool: ", + "BoolQuery", + "; }; }" + ], + "path": "src/plugins/data/public/query/query_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.QueryService.start.$1", + "type": "Object", + "tags": [], + "label": "{ storage, uiSettings, http }", + "description": [], + "signature": [ + "QueryServiceStartDependencies" + ], + "path": "src/plugins/data/public/query/query_service.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-public.QueryService.stop", + "type": "Function", + "tags": [], + "label": "stop", + "description": [], + "signature": [ + "() => void" + ], + "path": "src/plugins/data/public/query/query_service.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, { "parentPluginId": "data", "id": "def-public.TimeHistory", @@ -1118,7 +1459,13 @@ "text": "QueryState" }, "; }>; timefilter: ", - "TimefilterSetup", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.TimefilterSetup", + "text": "TimefilterSetup" + }, "; getEsQuery: (indexPattern: ", { "pluginId": "dataViews", @@ -1146,7 +1493,13 @@ "text": "FilterManager" }, "; timefilter: ", - "TimefilterSetup", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.TimefilterSetup", + "text": "TimefilterSetup" + }, "; queryString: ", { "pluginId": "data", @@ -1289,7 +1642,13 @@ "text": "QueryState" }, "; }>; timefilter: ", - "TimefilterSetup", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.TimefilterSetup", + "text": "TimefilterSetup" + }, "; getEsQuery: (indexPattern: ", { "pluginId": "dataViews", @@ -1317,7 +1676,13 @@ "text": "FilterManager" }, "; timefilter: ", - "TimefilterSetup", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.TimefilterSetup", + "text": "TimefilterSetup" + }, "; queryString: ", { "pluginId": "data", @@ -1780,8 +2145,8 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, "[]) => string" ], @@ -1814,8 +2179,8 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, "[]" ], @@ -1842,16 +2207,16 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, "[]) => ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, " | undefined" ], @@ -1884,8 +2249,8 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, "[]" ], @@ -2036,7 +2401,13 @@ "text": "QueryState" }, "; }>; timefilter: ", - "TimefilterSetup", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.TimefilterSetup", + "text": "TimefilterSetup" + }, "; getEsQuery: (indexPattern: ", { "pluginId": "dataViews", @@ -2064,7 +2435,13 @@ "text": "FilterManager" }, "; timefilter: ", - "TimefilterSetup", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.TimefilterSetup", + "text": "TimefilterSetup" + }, "; queryString: ", { "pluginId": "data", @@ -2205,7 +2582,13 @@ "text": "QueryState" }, "; }>; timefilter: ", - "TimefilterSetup", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.TimefilterSetup", + "text": "TimefilterSetup" + }, "; getEsQuery: (indexPattern: ", { "pluginId": "dataViews", @@ -2233,7 +2616,13 @@ "text": "FilterManager" }, "; timefilter: ", - "TimefilterSetup", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.TimefilterSetup", + "text": "TimefilterSetup" + }, "; queryString: ", { "pluginId": "data", @@ -2740,6 +3129,211 @@ } ], "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.TimefilterSetup", + "type": "Interface", + "tags": [], + "label": "TimefilterSetup", + "description": [], + "path": "src/plugins/data/public/query/timefilter/timefilter_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.TimefilterSetup.timefilter", + "type": "Object", + "tags": [], + "label": "timefilter", + "description": [], + "signature": [ + "{ isTimeRangeSelectorEnabled: () => boolean; isAutoRefreshSelectorEnabled: () => boolean; isTimeTouched: () => boolean; isRefreshIntervalTouched: () => boolean; getEnabledUpdated$: () => ", + "Observable", + "; getTimeUpdate$: () => ", + "Observable", + "; getRefreshIntervalUpdate$: () => ", + "Observable", + "; getAutoRefreshFetch$: () => ", + "Observable", + "<", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.AutoRefreshDoneFn", + "text": "AutoRefreshDoneFn" + }, + ">; getFetch$: () => ", + "Observable", + "; getTime: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + "; getAbsoluteTime: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + "; setTime: (time: ", + "InputTimeRange", + ") => void; getRefreshInterval: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.RefreshInterval", + "text": "RefreshInterval" + }, + "; setRefreshInterval: (refreshInterval: Partial<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.RefreshInterval", + "text": "RefreshInterval" + }, + ">) => void; createFilter: (indexPattern: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + ", timeRange?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined) => ", + "RangeFilter", + " | ", + "ScriptedRangeFilter", + " | MatchAllRangeFilter | undefined; createRelativeFilter: (indexPattern: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + ", timeRange?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined) => ", + "RangeFilter", + " | ", + "ScriptedRangeFilter", + " | MatchAllRangeFilter | undefined; getBounds: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRangeBounds", + "text": "TimeRangeBounds" + }, + "; calculateBounds: (timeRange: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRangeBounds", + "text": "TimeRangeBounds" + }, + "; getActiveBounds: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRangeBounds", + "text": "TimeRangeBounds" + }, + " | undefined; enableTimeRangeSelector: () => void; disableTimeRangeSelector: () => void; enableAutoRefreshSelector: () => void; disableAutoRefreshSelector: () => void; getTimeDefaults: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + "; getRefreshIntervalDefaults: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.RefreshInterval", + "text": "RefreshInterval" + }, + "; }" + ], + "path": "src/plugins/data/public/query/timefilter/timefilter_service.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.TimefilterSetup.history", + "type": "Object", + "tags": [], + "label": "history", + "description": [], + "signature": [ + "{ get$: () => ", + "Observable", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + "[]>; add: (time: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + ") => void; get: () => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + "[]; }" + ], + "path": "src/plugins/data/public/query/timefilter/timefilter_service.ts", + "deprecated": false + } + ], + "initialIsOpen": false } ], "enums": [], @@ -2777,7 +3371,13 @@ "text": "FilterManager" }, "; timefilter: ", - "TimefilterSetup", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.TimefilterSetup", + "text": "TimefilterSetup" + }, "; queryString: ", { "pluginId": "data", @@ -2911,7 +3511,13 @@ "text": "QueryState" }, "; }>; timefilter: ", - "TimefilterSetup", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.TimefilterSetup", + "text": "TimefilterSetup" + }, "; getEsQuery: (indexPattern: ", { "pluginId": "dataViews", @@ -3003,9 +3609,9 @@ "Observable", "; getTimeUpdate$: () => ", "Observable", - "; getRefreshIntervalUpdate$: () => ", + "; getRefreshIntervalUpdate$: () => ", "Observable", - "; getAutoRefreshFetch$: () => ", + "; getAutoRefreshFetch$: () => ", "Observable", "<", { @@ -3017,7 +3623,7 @@ }, ">; getFetch$: () => ", "Observable", - "; getTime: () => ", + "; getTime: () => ", { "pluginId": "data", "scope": "common", diff --git a/api_docs/data_query.mdx b/api_docs/data_query.mdx index c4ef7a0a5710b..76b3bbc03583e 100644 --- a/api_docs/data_query.mdx +++ b/api_docs/data_query.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/data-query title: "data.query" image: https://source.unsplash.com/400x175/?github summary: API docs for the data.query plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 3426 | 40 | 2816 | 20 | +| 3414 | 38 | 2802 | 18 | ## Client diff --git a/api_docs/data_search.devdocs.json b/api_docs/data_search.devdocs.json index 3519424309902..733c32b8df845 100644 --- a/api_docs/data_search.devdocs.json +++ b/api_docs/data_search.devdocs.json @@ -1474,55 +1474,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "data", - "id": "def-server.DataRequestHandlerContext", - "type": "Interface", - "tags": [], - "label": "DataRequestHandlerContext", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "server", - "docId": "kibDataSearchPluginApi", - "section": "def-server.DataRequestHandlerContext", - "text": "DataRequestHandlerContext" - }, - " extends ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.RequestHandlerContext", - "text": "RequestHandlerContext" - } - ], - "path": "src/plugins/data/server/search/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-server.DataRequestHandlerContext.search", - "type": "Object", - "tags": [], - "label": "search", - "description": [], - "signature": [ - { - "pluginId": "data", - "scope": "server", - "docId": "kibDataSearchPluginApi", - "section": "def-server.IScopedSearchClient", - "text": "IScopedSearchClient" - } - ], - "path": "src/plugins/data/server/search/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "data", "id": "def-server.IScopedSearchClient", @@ -2636,6 +2587,35 @@ ], "enums": [], "misc": [ + { + "parentPluginId": "data", + "id": "def-server.DataRequestHandlerContext", + "type": "Type", + "tags": [], + "label": "DataRequestHandlerContext", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.RequestHandlerContext", + "text": "RequestHandlerContext" + }, + " & { search: Promise<", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataSearchPluginApi", + "section": "def-server.IScopedSearchClient", + "text": "IScopedSearchClient" + }, + ">; }" + ], + "path": "src/plugins/data/server/search/types.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "data", "id": "def-server.SearchRequestHandlerContext", @@ -7599,6 +7579,117 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "data", + "id": "def-common.MultiFieldKey", + "type": "Class", + "tags": [], + "label": "MultiFieldKey", + "description": [], + "path": "src/plugins/data/common/search/aggs/buckets/multi_field_key.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.MultiFieldKey.id", + "type": "string", + "tags": [], + "label": "[id]", + "description": [], + "path": "src/plugins/data/common/search/aggs/buckets/multi_field_key.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.MultiFieldKey.keys", + "type": "Array", + "tags": [], + "label": "keys", + "description": [], + "signature": [ + "string[]" + ], + "path": "src/plugins/data/common/search/aggs/buckets/multi_field_key.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.MultiFieldKey.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/data/common/search/aggs/buckets/multi_field_key.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.MultiFieldKey.Unnamed.$1", + "type": "Unknown", + "tags": [], + "label": "bucket", + "description": [], + "signature": [ + "unknown" + ], + "path": "src/plugins/data/common/search/aggs/buckets/multi_field_key.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-common.MultiFieldKey.idBucket", + "type": "Function", + "tags": [], + "label": "idBucket", + "description": [], + "signature": [ + "(bucket: unknown) => string" + ], + "path": "src/plugins/data/common/search/aggs/buckets/multi_field_key.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.MultiFieldKey.idBucket.$1", + "type": "Unknown", + "tags": [], + "label": "bucket", + "description": [], + "signature": [ + "unknown" + ], + "path": "src/plugins/data/common/search/aggs/buckets/multi_field_key.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-common.MultiFieldKey.toString", + "type": "Function", + "tags": [], + "label": "toString", + "description": [], + "signature": [ + "() => string" + ], + "path": "src/plugins/data/common/search/aggs/buckets/multi_field_key.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, { "parentPluginId": "data", "id": "def-common.OptionedParamType", @@ -17986,6 +18077,19 @@ "path": "src/plugins/data/common/search/aggs/buckets/multi_terms.ts", "deprecated": false }, + { + "parentPluginId": "data", + "id": "def-common.AggParamsMultiTerms.shardSize", + "type": "number", + "tags": [], + "label": "shardSize", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "src/plugins/data/common/search/aggs/buckets/multi_terms.ts", + "deprecated": false + }, { "parentPluginId": "data", "id": "def-common.AggParamsMultiTerms.otherBucket", @@ -18778,6 +18882,19 @@ "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", "deprecated": false }, + { + "parentPluginId": "data", + "id": "def-common.AggParamsTerms.shardSize", + "type": "number", + "tags": [], + "label": "shardSize", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "src/plugins/data/common/search/aggs/buckets/terms.ts", + "deprecated": false + }, { "parentPluginId": "data", "id": "def-common.AggParamsTerms.missingBucket", @@ -24348,7 +24465,7 @@ "label": "AggConfigOptions", "description": [], "signature": [ - "{ type: ", + "{ id?: string | undefined; type: ", { "pluginId": "data", "scope": "common", @@ -24356,7 +24473,7 @@ "section": "def-common.IAggType", "text": "IAggType" }, - "; id?: string | undefined; enabled?: boolean | undefined; params?: {} | ", + "; enabled?: boolean | undefined; params?: {} | ", "SerializableRecord", " | undefined; schema?: string | undefined; }" ], @@ -25058,7 +25175,7 @@ "label": "CreateAggConfigParams", "description": [], "signature": [ - "{ type: string | ", + "{ id?: string | undefined; type: string | ", { "pluginId": "data", "scope": "common", @@ -25066,7 +25183,7 @@ "section": "def-common.IAggType", "text": "IAggType" }, - "; id?: string | undefined; enabled?: boolean | undefined; params?: {} | ", + "; enabled?: boolean | undefined; params?: {} | ", "SerializableRecord", " | undefined; schema?: string | undefined; }" ], diff --git a/api_docs/data_search.mdx b/api_docs/data_search.mdx index 608be3044f659..ae24c35139513 100644 --- a/api_docs/data_search.mdx +++ b/api_docs/data_search.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/data-search title: "data.search" image: https://source.unsplash.com/400x175/?github summary: API docs for the data.search plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 3426 | 40 | 2816 | 20 | +| 3414 | 38 | 2802 | 18 | ## Client diff --git a/api_docs/data_view_editor.mdx b/api_docs/data_view_editor.mdx index 8a11bfeccdeab..01bc3bf40b471 100644 --- a/api_docs/data_view_editor.mdx +++ b/api_docs/data_view_editor.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataViewEditor title: "dataViewEditor" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataViewEditor plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewEditor'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data_view_field_editor.mdx b/api_docs/data_view_field_editor.mdx index 7a72bfa2e79d6..27b12a115195c 100644 --- a/api_docs/data_view_field_editor.mdx +++ b/api_docs/data_view_field_editor.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataViewFieldEditor title: "dataViewFieldEditor" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataViewFieldEditor plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewFieldEditor'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data_view_management.mdx b/api_docs/data_view_management.mdx index 1d26cc3a65daa..b1bfe293c7c92 100644 --- a/api_docs/data_view_management.mdx +++ b/api_docs/data_view_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataViewManagement title: "dataViewManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataViewManagement plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data_views.devdocs.json b/api_docs/data_views.devdocs.json index 5ad402626c258..327d6e36ba3f4 100644 --- a/api_docs/data_views.devdocs.json +++ b/api_docs/data_views.devdocs.json @@ -4107,26 +4107,6 @@ "plugin": "dataViewEditor", "path": "src/plugins/data_view_editor/public/open_editor.tsx" }, - { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/hooks/update_kuery_string.ts" - }, - { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/hooks/update_kuery_string.ts" - }, - { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" - }, - { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" - }, - { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" - }, { "plugin": "maps", "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" @@ -7104,14 +7084,6 @@ "plugin": "data", "path": "src/plugins/data/public/search/search_service.ts" }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/query_string_input/fetch_index_patterns.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/query_string_input/fetch_index_patterns.ts" - }, { "plugin": "unifiedSearch", "path": "src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx" @@ -8116,8 +8088,8 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" + "section": "def-common.FieldSpec", + "text": "FieldSpec" }, " | undefined" ], @@ -15771,26 +15743,6 @@ "plugin": "dataViewEditor", "path": "src/plugins/data_view_editor/public/open_editor.tsx" }, - { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/hooks/update_kuery_string.ts" - }, - { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/hooks/update_kuery_string.ts" - }, - { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" - }, - { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" - }, - { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx" - }, { "plugin": "maps", "path": "x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts" @@ -18995,89 +18947,61 @@ "plugin": "data", "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts" }, - { - "plugin": "data", - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/autocomplete/providers/value_suggestion_provider.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/autocomplete/providers/value_suggestion_provider.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/autocomplete/providers/value_suggestion_provider.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/autocomplete/providers/value_suggestion_provider.ts" - }, { "plugin": "data", "path": "src/plugins/data/public/index.ts" }, { "plugin": "data", - "path": "src/plugins/data/public/autocomplete/providers/kql_query_suggestion/field.tsx" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/autocomplete/providers/kql_query_suggestion/field.tsx" + "path": "src/plugins/data/public/actions/filters/create_filters_from_range_select.ts" }, { "plugin": "data", - "path": "src/plugins/data/public/autocomplete/providers/kql_query_suggestion/field.tsx" + "path": "src/plugins/data/public/actions/filters/create_filters_from_range_select.ts" }, { - "plugin": "data", - "path": "src/plugins/data/public/autocomplete/providers/kql_query_suggestion/value.ts" + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx" }, { - "plugin": "data", - "path": "src/plugins/data/public/autocomplete/providers/kql_query_suggestion/value.ts" + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx" }, { - "plugin": "data", - "path": "src/plugins/data/public/actions/filters/create_filters_from_range_select.ts" + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx" }, { - "plugin": "data", - "path": "src/plugins/data/public/actions/filters/create_filters_from_range_select.ts" + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" }, { - "plugin": "data", - "path": "src/plugins/data/server/autocomplete/terms_enum.ts" + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" }, { - "plugin": "data", - "path": "src/plugins/data/server/autocomplete/terms_enum.ts" + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts" }, { - "plugin": "data", - "path": "src/plugins/data/server/autocomplete/terms_agg.ts" + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts" }, { - "plugin": "data", - "path": "src/plugins/data/server/autocomplete/terms_agg.ts" + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" }, { - "plugin": "data", - "path": "src/plugins/data/server/autocomplete/terms_agg.ts" + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" }, { - "plugin": "data", - "path": "src/plugins/data/server/autocomplete/terms_agg.ts" + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" }, { - "plugin": "data", - "path": "src/plugins/data/server/index.ts" + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" }, { "plugin": "unifiedSearch", @@ -19113,19 +19037,27 @@ }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" + "path": "src/plugins/unified_search/server/autocomplete/terms_enum.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" + "path": "src/plugins/unified_search/server/autocomplete/terms_enum.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" + "path": "src/plugins/unified_search/server/autocomplete/terms_agg.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" + "path": "src/plugins/unified_search/server/autocomplete/terms_agg.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/server/autocomplete/terms_agg.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/server/autocomplete/terms_agg.ts" }, { "plugin": "data", @@ -19174,6 +19106,22 @@ { "plugin": "unifiedSearch", "path": "src/plugins/unified_search/public/filter_bar/filter_editor/value_input_type.tsx" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" } ], "children": [ @@ -19511,30 +19459,6 @@ "plugin": "data", "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts" }, - { - "plugin": "data", - "path": "src/plugins/data/public/query/filter_manager/lib/get_index_pattern_from_filter.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/query/filter_manager/lib/get_index_pattern_from_filter.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/query/filter_manager/lib/get_index_pattern_from_filter.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/query/filter_manager/lib/get_display_value.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/query/filter_manager/lib/get_display_value.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/query/filter_manager/lib/get_display_value.ts" - }, { "plugin": "data", "path": "src/plugins/data/public/query/timefilter/timefilter.ts" @@ -19547,189 +19471,37 @@ "plugin": "data", "path": "src/plugins/data/public/query/timefilter/timefilter.ts" }, - { - "plugin": "data", - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/autocomplete/providers/value_suggestion_provider.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/autocomplete/providers/value_suggestion_provider.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/autocomplete/providers/value_suggestion_provider.ts" - }, { "plugin": "data", "path": "src/plugins/data/public/index.ts" }, - { - "plugin": "data", - "path": "src/plugins/data/public/autocomplete/providers/kql_query_suggestion/value.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/autocomplete/providers/kql_query_suggestion/value.ts" - }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx" + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx" + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx" + "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx" + "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx" + "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/query_string_input/query_bar_top_row.tsx" + "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/query_string_input/query_bar_top_row.tsx" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/alerts/components/param_details_form/use_derived_index_pattern.tsx" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/alerts/components/param_details_form/use_derived_index_pattern.tsx" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/components/kuery_bar/with_kuery_autocompletion.tsx" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/components/kuery_bar/with_kuery_autocompletion.tsx" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/components/kuery_bar/index.tsx" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/components/kuery_bar/index.tsx" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/lib/kuery.ts" - }, - { - "plugin": "monitoring", - "path": "x-pack/plugins/monitoring/public/lib/kuery.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/phrase_suggestor.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/phrase_suggestor.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_item.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_item.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_bar.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_bar.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/search_bar/search_bar.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/search_bar/search_bar.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/apply_filters/apply_filter_popover_content.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/apply_filters/apply_filter_popover_content.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/apply_filters/apply_filters_popover.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/apply_filters/apply_filters_popover.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/read_only_filter_items.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/read_only_filter_items.tsx" + "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" }, { "plugin": "data", @@ -22132,14 +21904,6 @@ "plugin": "data", "path": "src/plugins/data/public/search/search_service.ts" }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/query_string_input/fetch_index_patterns.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/query_string_input/fetch_index_patterns.ts" - }, { "plugin": "unifiedSearch", "path": "src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx" @@ -22286,7 +22050,7 @@ "signature": [ "Pick<", "Toast", - ", \"children\" | \"onClick\" | \"onChange\" | \"color\" | \"onKeyDown\" | \"className\" | \"security\" | \"defaultValue\" | \"hidden\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"lang\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"toastLifeTimeMs\" | \"iconType\" | \"onClose\" | \"data-test-subj\"> & { title?: string | ", + ", \"children\" | \"color\" | \"className\" | \"onChange\" | \"onKeyDown\" | \"onClick\" | \"security\" | \"defaultValue\" | \"hidden\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"lang\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"toastLifeTimeMs\" | \"iconType\" | \"onClose\" | \"data-test-subj\"> & { title?: string | ", { "pluginId": "core", "scope": "public", diff --git a/api_docs/data_views.mdx b/api_docs/data_views.mdx index b595999839c2c..24669a558c24f 100644 --- a/api_docs/data_views.mdx +++ b/api_docs/data_views.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataViews title: "dataViews" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataViews plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data_visualizer.mdx b/api_docs/data_visualizer.mdx index 7bc87154c95ff..dba30154fefa5 100644 --- a/api_docs/data_visualizer.mdx +++ b/api_docs/data_visualizer.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataVisualizer title: "dataVisualizer" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataVisualizer plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataVisualizer'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/deprecations_by_api.mdx b/api_docs/deprecations_by_api.mdx index 8db17bbe8bee3..a9ce0254cea52 100644 --- a/api_docs/deprecations_by_api.mdx +++ b/api_docs/deprecations_by_api.mdx @@ -3,7 +3,7 @@ id: kibDevDocsDeprecationsByApi slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-api title: Deprecated API usage by API summary: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by. -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. --- @@ -15,40 +15,39 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | ---------------|-----------|-----------| | | dataViews, maps, data | - | | | dataViews, unifiedSearch, maps, data | - | -| | dataViews, discover, ux, savedObjects, dataViewEditor, uptime, maps, visDefaultEditor, data | - | +| | dataViews, discover, ux, savedObjects, dataViewEditor, maps, visDefaultEditor, data | - | | | dataViews, dataViewEditor, maps, visDefaultEditor, data | - | -| | dataViews, unifiedSearch, monitoring, stackAlerts | - | +| | dataViews, unifiedSearch | - | | | dataViews, canvas | - | -| | dataViews, unifiedSearch, monitoring, stackAlerts, data | - | +| | dataViews, unifiedSearch, data | - | | | dataViews, canvas, data | - | | | dataViews, unifiedSearch, maps, data | - | | | dataViews, dataViewEditor, maps, visDefaultEditor, data | - | | | dataViews, maps, data | - | | | dataViews | - | -| | dataViews, discover, ux, savedObjects, dataViewEditor, uptime, maps, visDefaultEditor, data | - | +| | dataViews, discover, ux, savedObjects, dataViewEditor, maps, visDefaultEditor, data | - | | | dataViews, maps | - | | | dataViewManagement, dataViews | - | | | visTypeTimeseries, graph, dataViewManagement, dataViews | - | | | dataViews, dataViewManagement | - | | | dataViews, canvas | - | | | dataViews, dataViewEditor, maps, visDefaultEditor | - | -| | dataViews, discover, ux, savedObjects, dataViewEditor, uptime, maps, visDefaultEditor | - | +| | dataViews, discover, ux, savedObjects, dataViewEditor, maps, visDefaultEditor | - | | | dataViews, maps | - | | | dataViews, maps | - | | | dataViewManagement, dataViews | - | | | visTypeTimeseries, graph, dataViewManagement, dataViews | - | | | dataViews, dataViewManagement | - | -| | unifiedSearch, discover, maps, infra, graph, monitoring, securitySolution, stackAlerts, uptime, inputControlVis, savedObjects | - | +| | unifiedSearch, discover, maps, infra, graph, securitySolution, stackAlerts, inputControlVis, savedObjects | - | | | maps | - | | | data, infra, maps | - | -| | dashboard, maps | - | | | discover | - | | | discover | - | | | data, discover, embeddable | - | | | advancedSettings, discover | - | | | advancedSettings, discover | - | -| | esUiShared, home, spaces, fleet, visualizations, lens, observability, dataEnhanced, ml, apm, cloudSecurityPosture, indexLifecycleManagement, upgradeAssistant, uptime, ux, kibanaOverview, savedObjectsManagement | - | -| | dashboard, lens, stackAlerts, visTypeTable, visTypeTimeseries, visTypeXy, visTypeVislib, expressionPartitionVis | - | +| | management, observability, infra, apm, cloudSecurityPosture, enterpriseSearch, securitySolution, synthetics, ux, kibanaOverview | - | +| | esUiShared, home, spaces, fleet, visualizations, lens, observability, dataEnhanced, ml, apm, cloudSecurityPosture, indexLifecycleManagement, synthetics, upgradeAssistant, ux, kibanaOverview, savedObjectsManagement | - | | | canvas, visTypeXy | - | | | canvas | - | | | canvas | - | @@ -59,41 +58,40 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | canvas | - | | | canvas | - | | | canvas, visTypeXy | - | +| | management, spaces, observability, ml, canvas, cloudSecurityPosture, enterpriseSearch, osquery, securitySolution, kibanaOverview | - | +| | dashboard, lens, stackAlerts, visTypeTable, visTypeTimeseries, visTypeXy, visTypeVislib, expressionPartitionVis | - | | | visTypeTimeseries, graph, dataViewManagement | - | | | encryptedSavedObjects, actions, cloud, ml, dataEnhanced, logstash, securitySolution | - | +| | dashboard | - | | | visTypeTimeseries | - | | | dataViewManagement | - | | | dataViewManagement | - | +| | actions, ml, enterpriseSearch, savedObjectsTagging | - | | | spaces, savedObjectsManagement | - | | | spaces, savedObjectsManagement | - | -| | actions, ml, enterpriseSearch, savedObjectsTagging | - | | | visTypeGauge | - | | | visTypePie | - | | | visTypePie | - | | | actions, alerting | - | | | console | - | | | unifiedSearch | 8.1 | +| | unifiedSearch, dataEnhanced | 8.1 | | | unifiedSearch, discover, dashboard, urlDrilldown, stackAlerts | 8.1 | | | unifiedSearch | 8.1 | | | unifiedSearch | 8.1 | | | unifiedSearch, discover, dashboard, urlDrilldown, stackAlerts | 8.1 | +| | unifiedSearch, dataEnhanced | 8.1 | | | unifiedSearch, discover, dashboard, urlDrilldown, stackAlerts | 8.1 | +| | unifiedSearch, dataEnhanced | 8.1 | | | discover, stackAlerts, inputControlVis | 8.1 | | | discover, stackAlerts, inputControlVis | 8.1 | -| | dataEnhanced | 8.1 | | | dataEnhanced | 8.1 | -| | dataEnhanced | 8.1 | -| | dataEnhanced | 8.1 | | | apm | 8.1 | | | dataViews, unifiedSearch | 8.2 | | | dataViews, unifiedSearch, data | 8.2 | -| | dataViews, unifiedSearch | 8.2 | -| | visualizations, dashboard, maps, graph | 8.8.0 | | | visualizations, dashboard, lens, maps, ml, securitySolution, security | 8.8.0 | | | lens, dashboard, maps | 8.8.0 | -| | embeddable, presentationUtil, discover, dashboard, graph | 8.8.0 | -| | monitoring, visTypeVega | 8.8.0 | -| | monitoring, kibanaUsageCollection | 8.8.0 | +| | embeddable, discover, presentationUtil, dashboard, graph | 8.8.0 | | | spaces, security, actions, alerting, ml, remoteClusters, graph, indexLifecycleManagement, mapsEms, painlessLab, rollup, searchprofiler, snapshotRestore, transform, upgradeAssistant | 8.8.0 | | | apm, security, securitySolution | 8.8.0 | | | apm, security, securitySolution | 8.8.0 | @@ -102,14 +100,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | dashboard | 8.8.0 | | | cloud, apm | 8.8.0 | | | security, licenseManagement, ml, apm, crossClusterReplication, logstash, painlessLab, searchprofiler, watcher | 8.8.0 | +| | management, fleet, security, kibanaOverview | 8.8.0 | | | spaces, security, alerting | 8.8.0 | | | security, fleet | 8.8.0 | | | security, fleet | 8.8.0 | | | security, fleet | 8.8.0 | -| | management, fleet, security, kibanaOverview | 8.8.0 | | | security | 8.8.0 | | | mapsEms | 8.8.0 | | | visTypeVega | 8.8.0 | +| | monitoring, visTypeVega | 8.8.0 | +| | monitoring, kibanaUsageCollection | 8.8.0 | | | ml | 8.8.0 Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block, @@ -201,6 +201,7 @@ Safe to remove. | | expressions | | | expressions | | | expressions | +| | savedObjects | | | licensing | | | licensing | | | licensing | diff --git a/api_docs/deprecations_by_plugin.mdx b/api_docs/deprecations_by_plugin.mdx index 0005cd3853b72..bc9d1dac3a021 100644 --- a/api_docs/deprecations_by_plugin.mdx +++ b/api_docs/deprecations_by_plugin.mdx @@ -3,7 +3,7 @@ id: kibDevDocsDeprecationsByPlugin slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-plugin title: Deprecated API usage by plugin summary: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by. -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. --- @@ -45,6 +45,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | ---------------|-----------|-----------| | | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/components/shared/kuery_bar/index.tsx#:~:text=esKuery), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/components/shared/kuery_bar/index.tsx#:~:text=esKuery), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/components/shared/kuery_bar/index.tsx#:~:text=esKuery) | 8.1 | | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/plugin.ts#:~:text=environment) | 8.8.0 | +| | [no_data_config.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/components/routing/templates/no_data_config.ts#:~:text=KibanaPageTemplateProps), [no_data_config.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/components/routing/templates/no_data_config.ts#:~:text=KibanaPageTemplateProps), [apm_main_template.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/components/routing/templates/apm_main_template.tsx#:~:text=KibanaPageTemplateProps), [apm_main_template.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/components/routing/templates/apm_main_template.tsx#:~:text=KibanaPageTemplateProps), [service_group_template.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/components/routing/templates/service_group_template.tsx#:~:text=KibanaPageTemplateProps), [service_group_template.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/components/routing/templates/service_group_template.tsx#:~:text=KibanaPageTemplateProps) | - | | | [app_root.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/components/routing/app_root.tsx#:~:text=RedirectAppLinks), [app_root.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/components/routing/app_root.tsx#:~:text=RedirectAppLinks), [app_root.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/components/routing/app_root.tsx#:~:text=RedirectAppLinks) | - | | | [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/common/license_check.test.ts#:~:text=mode)+ 2 more | 8.8.0 | | | [license_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/apm/public/context/license/license_context.tsx#:~:text=license%24) | 8.8.0 | @@ -59,16 +60,17 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [es_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/lib/es_service.ts#:~:text=IndexPatternAttributes), [es_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/lib/es_service.ts#:~:text=IndexPatternAttributes), [es_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/lib/es_service.ts#:~:text=IndexPatternAttributes) | - | | | [es_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/lib/es_service.ts#:~:text=IndexPatternAttributes), [es_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/lib/es_service.ts#:~:text=IndexPatternAttributes), [es_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/lib/es_service.ts#:~:text=IndexPatternAttributes), [es_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/lib/es_service.ts#:~:text=IndexPatternAttributes), [es_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/lib/es_service.ts#:~:text=IndexPatternAttributes), [es_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/lib/es_service.ts#:~:text=IndexPatternAttributes) | - | | | [es_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/lib/es_service.ts#:~:text=IndexPatternAttributes), [es_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/lib/es_service.ts#:~:text=IndexPatternAttributes), [es_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/lib/es_service.ts#:~:text=IndexPatternAttributes) | - | -| | [embeddable.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/external/embeddable.ts#:~:text=context), [filters.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/common/functions/filters.ts#:~:text=context), [escount.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/escount.ts#:~:text=context), [esdocs.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/esdocs.ts#:~:text=context), [essql.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/essql.ts#:~:text=context), [neq.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/common/neq.ts#:~:text=context), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/server/pointseries/index.ts#:~:text=context), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/server/demodata/index.ts#:~:text=context) | - | +| | [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/server/demodata/index.ts#:~:text=context), [embeddable.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/external/embeddable.ts#:~:text=context), [esdocs.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/esdocs.ts#:~:text=context), [essql.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/essql.ts#:~:text=context), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/server/pointseries/index.ts#:~:text=context), [filters.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/common/functions/filters.ts#:~:text=context), [escount.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/escount.ts#:~:text=context), [neq.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/common/neq.ts#:~:text=context) | - | | | [setup_expressions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/setup_expressions.ts#:~:text=getFunction) | - | | | [application.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/application.tsx#:~:text=getFunctions), [functions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/server/routes/functions/functions.ts#:~:text=getFunctions), [functions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/server/routes/functions/functions.ts#:~:text=getFunctions), [functions.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/server/routes/functions/functions.test.ts#:~:text=getFunctions) | - | | | [setup_expressions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/setup_expressions.ts#:~:text=getTypes), [application.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/application.tsx#:~:text=getTypes), [functions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/server/routes/functions/functions.ts#:~:text=getTypes) | - | | | [state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/types/state.ts#:~:text=Render), [state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/types/state.ts#:~:text=Render), [markdown.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/markdown.ts#:~:text=Render), [markdown.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/markdown.ts#:~:text=Render), [timefilterControl.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/common/timefilterControl.ts#:~:text=Render), [timefilterControl.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/common/timefilterControl.ts#:~:text=Render), [pie.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/functions/pie.ts#:~:text=Render), [pie.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/functions/pie.ts#:~:text=Render), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/functions/plot/index.ts#:~:text=Render), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/functions/plot/index.ts#:~:text=Render)+ 2 more | - | -| | [embeddable.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/external/embeddable.ts#:~:text=context), [filters.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/common/functions/filters.ts#:~:text=context), [escount.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/escount.ts#:~:text=context), [esdocs.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/esdocs.ts#:~:text=context), [essql.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/essql.ts#:~:text=context), [neq.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/common/neq.ts#:~:text=context), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/server/pointseries/index.ts#:~:text=context), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/server/demodata/index.ts#:~:text=context) | - | +| | [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/server/demodata/index.ts#:~:text=context), [embeddable.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/external/embeddable.ts#:~:text=context), [esdocs.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/esdocs.ts#:~:text=context), [essql.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/essql.ts#:~:text=context), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/server/pointseries/index.ts#:~:text=context), [filters.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/common/functions/filters.ts#:~:text=context), [escount.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/escount.ts#:~:text=context), [neq.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/common/neq.ts#:~:text=context) | - | | | [setup_expressions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/setup_expressions.ts#:~:text=getFunction) | - | | | [application.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/application.tsx#:~:text=getFunctions), [functions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/server/routes/functions/functions.ts#:~:text=getFunctions), [functions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/server/routes/functions/functions.ts#:~:text=getFunctions), [functions.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/server/routes/functions/functions.test.ts#:~:text=getFunctions) | - | | | [setup_expressions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/setup_expressions.ts#:~:text=getTypes), [application.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/application.tsx#:~:text=getTypes), [functions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/server/routes/functions/functions.ts#:~:text=getTypes) | - | -| | [embeddable.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/external/embeddable.ts#:~:text=context), [filters.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/common/functions/filters.ts#:~:text=context), [escount.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/escount.ts#:~:text=context), [esdocs.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/esdocs.ts#:~:text=context), [essql.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/essql.ts#:~:text=context), [neq.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/common/neq.ts#:~:text=context), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/server/pointseries/index.ts#:~:text=context), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/server/demodata/index.ts#:~:text=context) | - | +| | [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/server/demodata/index.ts#:~:text=context), [embeddable.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/external/embeddable.ts#:~:text=context), [esdocs.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/esdocs.ts#:~:text=context), [essql.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/essql.ts#:~:text=context), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/server/pointseries/index.ts#:~:text=context), [filters.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/common/functions/filters.ts#:~:text=context), [escount.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/escount.ts#:~:text=context), [neq.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/common/neq.ts#:~:text=context) | - | +| | [home.component.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/components/home/home.component.tsx#:~:text=KibanaPageTemplate), [home.component.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/components/home/home.component.tsx#:~:text=KibanaPageTemplate), [home.component.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/components/home/home.component.tsx#:~:text=KibanaPageTemplate) | - | @@ -85,6 +87,8 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| +| | [csp_page_template.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cloud_security_posture/public/components/csp_page_template.tsx#:~:text=KibanaPageTemplateProps), [csp_page_template.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cloud_security_posture/public/components/csp_page_template.tsx#:~:text=KibanaPageTemplateProps), [csp_page_template.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cloud_security_posture/public/components/csp_page_template.tsx#:~:text=KibanaPageTemplateProps), [csp_page_template.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cloud_security_posture/public/components/csp_page_template.tsx#:~:text=KibanaPageTemplateProps), [csp_page_template.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cloud_security_posture/public/components/csp_page_template.tsx#:~:text=KibanaPageTemplateProps), [csp_page_template.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cloud_security_posture/public/components/csp_page_template.tsx#:~:text=KibanaPageTemplateProps), [csp_page_template.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cloud_security_posture/public/components/csp_page_template.tsx#:~:text=KibanaPageTemplateProps), [csp_page_template.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cloud_security_posture/public/components/csp_page_template.tsx#:~:text=KibanaPageTemplateProps), [compliance_dashboard.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cloud_security_posture/public/pages/compliance_dashboard/compliance_dashboard.tsx#:~:text=KibanaPageTemplateProps), [compliance_dashboard.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cloud_security_posture/public/pages/compliance_dashboard/compliance_dashboard.tsx#:~:text=KibanaPageTemplateProps)+ 2 more | - | +| | [csp_page_template.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cloud_security_posture/public/components/csp_page_template.tsx#:~:text=KibanaPageTemplate), [csp_page_template.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cloud_security_posture/public/components/csp_page_template.tsx#:~:text=KibanaPageTemplate), [csp_page_template.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cloud_security_posture/public/components/csp_page_template.tsx#:~:text=KibanaPageTemplate) | - | | | [app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cloud_security_posture/public/application/app.tsx#:~:text=RedirectAppLinks), [app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cloud_security_posture/public/application/app.tsx#:~:text=RedirectAppLinks), [app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cloud_security_posture/public/application/app.tsx#:~:text=RedirectAppLinks) | - | @@ -117,7 +121,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [saved_objects.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/saved_objects.ts#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/top_nav/save_modal.tsx#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/top_nav/save_modal.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 | | | [saved_object_loader.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/saved_object_loader.ts#:~:text=SavedObject), [saved_object_loader.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/saved_object_loader.ts#:~:text=SavedObject), [saved_object_loader.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/saved_object_loader.ts#:~:text=SavedObject), [saved_objects.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/saved_objects.ts#:~:text=SavedObject), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=SavedObject), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=SavedObject), [dashboard_tagging.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/dashboard_tagging.ts#:~:text=SavedObject), [dashboard_tagging.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/dashboard_tagging.ts#:~:text=SavedObject), [clone_panel_action.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/actions/clone_panel_action.tsx#:~:text=SavedObject), [clone_panel_action.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/actions/clone_panel_action.tsx#:~:text=SavedObject)+ 1 more | 8.8.0 | | | [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=SavedObjectClass) | 8.8.0 | -| | [dashboard_listing.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/listing/dashboard_listing.tsx#:~:text=settings), [dashboard_listing.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/listing/dashboard_listing.tsx#:~:text=settings) | 8.8.0 | | | [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=onAppLeave), [dashboard_router.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/dashboard_router.tsx#:~:text=onAppLeave), [plugin.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/plugin.tsx#:~:text=onAppLeave) | 8.8.0 | | | [migrations_730.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/server/saved_objects/migrations_730.ts#:~:text=warning), [migrations_730.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/server/saved_objects/migrations_730.ts#:~:text=warning) | 8.8.0 | @@ -131,9 +134,9 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPatternsContract), [create_search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/create_search_source.ts#:~:text=IndexPatternsContract), [create_search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/create_search_source.ts#:~:text=IndexPatternsContract), [search_source_service.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source_service.ts#:~:text=IndexPatternsContract), [search_source_service.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source_service.ts#:~:text=IndexPatternsContract), [esaggs_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts#:~:text=IndexPatternsContract), [esaggs_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts#:~:text=IndexPatternsContract), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/types.ts#:~:text=IndexPatternsContract), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/types.ts#:~:text=IndexPatternsContract), [create_search_source.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/create_search_source.test.ts#:~:text=IndexPatternsContract)+ 19 more | - | | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/index.ts#:~:text=IndexPatternsService) | - | | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/types.ts#:~:text=IndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPattern), [tabify_docs.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/tabify/tabify_docs.ts#:~:text=IndexPattern), [tabify_docs.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/tabify/tabify_docs.ts#:~:text=IndexPattern)+ 89 more | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IFieldType), [date_histogram.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/buckets/date_histogram.ts#:~:text=IFieldType), [date_histogram.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/buckets/date_histogram.ts#:~:text=IFieldType), [generate_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/query/filter_manager/lib/generate_filters.ts#:~:text=IFieldType), [generate_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/query/filter_manager/lib/generate_filters.ts#:~:text=IFieldType), [generate_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/query/filter_manager/lib/generate_filters.ts#:~:text=IFieldType), [generate_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/query/filter_manager/lib/generate_filters.ts#:~:text=IFieldType), [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IFieldType), [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType)+ 24 more | 8.2 | +| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IFieldType), [date_histogram.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/buckets/date_histogram.ts#:~:text=IFieldType), [date_histogram.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/buckets/date_histogram.ts#:~:text=IFieldType), [generate_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/query/filter_manager/lib/generate_filters.ts#:~:text=IFieldType), [generate_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/query/filter_manager/lib/generate_filters.ts#:~:text=IFieldType), [generate_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/query/filter_manager/lib/generate_filters.ts#:~:text=IFieldType), [generate_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/query/filter_manager/lib/generate_filters.ts#:~:text=IFieldType), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/index.ts#:~:text=IFieldType), [create_filters_from_range_select.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/actions/filters/create_filters_from_range_select.ts#:~:text=IFieldType), [create_filters_from_range_select.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/actions/filters/create_filters_from_range_select.ts#:~:text=IFieldType)+ 6 more | 8.2 | | | [field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/param_types/field.ts#:~:text=IndexPatternField), [field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/param_types/field.ts#:~:text=IndexPatternField), [field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/param_types/field.ts#:~:text=IndexPatternField), [field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/param_types/field.ts#:~:text=IndexPatternField), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPatternField), [kibana_context_type.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/kibana_context_type.ts#:~:text=IndexPatternField), [kibana_context_type.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/kibana_context_type.ts#:~:text=IndexPatternField), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPatternField), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPatternField), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPatternField)+ 16 more | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IIndexPattern), [get_time.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/query/timefilter/get_time.ts#:~:text=IIndexPattern), [get_time.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/query/timefilter/get_time.ts#:~:text=IIndexPattern), [get_time.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/query/timefilter/get_time.ts#:~:text=IIndexPattern), [get_time.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/query/timefilter/get_time.ts#:~:text=IIndexPattern), [normalize_sort_request.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/normalize_sort_request.ts#:~:text=IIndexPattern), [normalize_sort_request.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/normalize_sort_request.ts#:~:text=IIndexPattern), [normalize_sort_request.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/normalize_sort_request.ts#:~:text=IIndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IIndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IIndexPattern)+ 36 more | - | +| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IIndexPattern), [get_time.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/query/timefilter/get_time.ts#:~:text=IIndexPattern), [get_time.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/query/timefilter/get_time.ts#:~:text=IIndexPattern), [get_time.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/query/timefilter/get_time.ts#:~:text=IIndexPattern), [get_time.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/query/timefilter/get_time.ts#:~:text=IIndexPattern), [normalize_sort_request.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/normalize_sort_request.ts#:~:text=IIndexPattern), [normalize_sort_request.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/normalize_sort_request.ts#:~:text=IIndexPattern), [normalize_sort_request.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/normalize_sort_request.ts#:~:text=IIndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IIndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IIndexPattern)+ 23 more | - | | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPatternAttributes), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/index.ts#:~:text=IndexPatternAttributes), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/index.ts#:~:text=IndexPatternAttributes) | - | | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPatternsContract), [create_search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/create_search_source.ts#:~:text=IndexPatternsContract), [create_search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/create_search_source.ts#:~:text=IndexPatternsContract), [search_source_service.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source_service.ts#:~:text=IndexPatternsContract), [search_source_service.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source_service.ts#:~:text=IndexPatternsContract), [esaggs_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts#:~:text=IndexPatternsContract), [esaggs_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts#:~:text=IndexPatternsContract), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/types.ts#:~:text=IndexPatternsContract), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/types.ts#:~:text=IndexPatternsContract), [create_search_source.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/create_search_source.test.ts#:~:text=IndexPatternsContract)+ 19 more | - | | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/index.ts#:~:text=IndexPatternsService) | - | @@ -194,9 +197,9 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPattern), [data_view_field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.test.ts#:~:text=IndexPattern), [data_view_field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.test.ts#:~:text=IndexPattern), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/public/index.ts#:~:text=IndexPattern), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPattern), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPattern), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPattern), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPattern) | - | | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPatternField), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/public/index.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view_field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.test.ts#:~:text=IndexPatternField), [data_view_field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.test.ts#:~:text=IndexPatternField)+ 2 more | - | | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IIndexPattern), [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=IIndexPattern), [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=IIndexPattern) | - | -| | [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType)+ 13 more | 8.2 | +| | [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType)+ 7 more | 8.2 | | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPatternAttributes) | - | -| | [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType)+ 13 more | 8.2 | +| | [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType)+ 7 more | 8.2 | | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IIndexPattern), [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=IIndexPattern), [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=IIndexPattern) | - | | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPatternAttributes) | - | | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPatternsContract), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/public/index.ts#:~:text=IndexPatternsContract) | - | @@ -208,7 +211,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=removeScriptedField) | - | | | [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getNonScriptedFields) | - | | | [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=getScriptedFields), [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=getScriptedFields), [data_views.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_views.ts#:~:text=getScriptedFields), [register_index_pattern_usage_collection.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/server/register_index_pattern_usage_collection.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields) | - | -| | [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType)+ 13 more | 8.2 | | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPatternAttributes) | - | | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPatternField), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/public/index.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view_field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.test.ts#:~:text=IndexPatternField), [data_view_field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.test.ts#:~:text=IndexPatternField)+ 2 more | - | | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPattern), [data_view_field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.test.ts#:~:text=IndexPattern), [data_view_field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.test.ts#:~:text=IndexPattern), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/public/index.ts#:~:text=IndexPattern), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPattern), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPattern), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPattern), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPattern) | - | @@ -263,6 +265,8 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| +| | [page_template.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/enterprise_search/public/applications/shared/layout/page_template.tsx#:~:text=KibanaPageTemplateProps), [page_template.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/enterprise_search/public/applications/shared/layout/page_template.tsx#:~:text=KibanaPageTemplateProps) | - | +| | [version_mismatch_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/enterprise_search/public/applications/shared/version_mismatch/version_mismatch_page.tsx#:~:text=KibanaPageTemplate), [version_mismatch_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/enterprise_search/public/applications/shared/version_mismatch/version_mismatch_page.tsx#:~:text=KibanaPageTemplate), [version_mismatch_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/enterprise_search/public/applications/shared/version_mismatch/version_mismatch_page.tsx#:~:text=KibanaPageTemplate), [error_connecting.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/enterprise_search/public/applications/enterprise_search_overview/components/error_connecting/error_connecting.tsx#:~:text=KibanaPageTemplate), [error_connecting.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/enterprise_search/public/applications/enterprise_search_overview/components/error_connecting/error_connecting.tsx#:~:text=KibanaPageTemplate), [error_connecting.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/enterprise_search/public/applications/enterprise_search_overview/components/error_connecting/error_connecting.tsx#:~:text=KibanaPageTemplate), [product_selector.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/enterprise_search/public/applications/enterprise_search_overview/components/product_selector/product_selector.tsx#:~:text=KibanaPageTemplate), [product_selector.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/enterprise_search/public/applications/enterprise_search_overview/components/product_selector/product_selector.tsx#:~:text=KibanaPageTemplate), [product_selector.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/enterprise_search/public/applications/enterprise_search_overview/components/product_selector/product_selector.tsx#:~:text=KibanaPageTemplate), [page_template.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/enterprise_search/public/applications/shared/layout/page_template.tsx#:~:text=KibanaPageTemplate)+ 11 more | - | | | [check_access.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/enterprise_search/server/lib/check_access.ts#:~:text=authz), [check_access.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/enterprise_search/server/lib/check_access.ts#:~:text=authz), [check_access.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/enterprise_search/server/lib/check_access.ts#:~:text=authz) | - | @@ -304,7 +308,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [deserialize.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/services/persistence/deserialize.ts#:~:text=getNonScriptedFields), [datasource.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/state_management/datasource.test.ts#:~:text=getNonScriptedFields), [deserialize.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/services/persistence/deserialize.test.ts#:~:text=getNonScriptedFields), [deserialize.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/services/persistence/deserialize.test.ts#:~:text=getNonScriptedFields) | - | | | [deserialize.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/services/persistence/deserialize.ts#:~:text=getNonScriptedFields), [datasource.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/state_management/datasource.test.ts#:~:text=getNonScriptedFields), [deserialize.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/services/persistence/deserialize.test.ts#:~:text=getNonScriptedFields), [deserialize.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/services/persistence/deserialize.test.ts#:~:text=getNonScriptedFields) | - | | | [save_modal.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/components/save_modal.tsx#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/components/save_modal.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 | -| | [listing_route.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/apps/listing_route.tsx#:~:text=settings), [listing_route.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/apps/listing_route.tsx#:~:text=settings) | 8.8.0 | | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/server/plugin.ts#:~:text=license%24) | 8.8.0 | @@ -332,6 +335,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | ---------------|-----------|-----------| | | [use_kibana_index_patterns.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/hooks/use_kibana_index_patterns.ts#:~:text=indexPatterns) | - | | | [kibana_framework_adapter.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/server/lib/adapters/framework/kibana_framework_adapter.ts#:~:text=indexPatternsServiceFactory) | - | +| | [page_template.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/page_template.tsx#:~:text=KibanaPageTemplateProps), [page_template.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/logs/page_template.tsx#:~:text=KibanaPageTemplateProps), [page_template.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/metrics/page_template.tsx#:~:text=KibanaPageTemplateProps), [page_template.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/public/pages/metrics/page_template.tsx#:~:text=KibanaPageTemplateProps) | - | @@ -349,6 +353,8 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| +| | [overview.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_overview/public/components/overview/overview.tsx#:~:text=KibanaPageTemplateProps), [overview.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_overview/public/components/overview/overview.tsx#:~:text=KibanaPageTemplateProps) | - | +| | [overview.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_overview/public/components/overview/overview.tsx#:~:text=KibanaPageTemplate), [overview.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_overview/public/components/overview/overview.tsx#:~:text=KibanaPageTemplate), [overview.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_overview/public/components/overview/overview.tsx#:~:text=KibanaPageTemplate) | - | | | [add_data.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_overview/public/components/add_data/add_data.tsx#:~:text=RedirectAppLinks), [add_data.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_overview/public/components/add_data/add_data.tsx#:~:text=RedirectAppLinks), [add_data.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_overview/public/components/add_data/add_data.tsx#:~:text=RedirectAppLinks), [manage_data.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_overview/public/components/manage_data/manage_data.tsx#:~:text=RedirectAppLinks), [manage_data.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_overview/public/components/manage_data/manage_data.tsx#:~:text=RedirectAppLinks), [manage_data.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_overview/public/components/manage_data/manage_data.tsx#:~:text=RedirectAppLinks), [overview.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_overview/public/components/overview/overview.tsx#:~:text=RedirectAppLinks), [overview.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_overview/public/components/overview/overview.tsx#:~:text=RedirectAppLinks), [overview.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_overview/public/components/overview/overview.tsx#:~:text=RedirectAppLinks), [overview.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_overview/public/components/overview/overview.tsx#:~:text=RedirectAppLinks)+ 1 more | - | | | [application.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_overview/public/application.tsx#:~:text=appBasePath) | 8.8.0 | @@ -395,6 +401,8 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| +| | [management_app.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/management/public/components/management_app/management_app.tsx#:~:text=KibanaPageTemplateProps), [management_app.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/management/public/components/management_app/management_app.tsx#:~:text=KibanaPageTemplateProps) | - | +| | [management_app.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/management/public/components/management_app/management_app.tsx#:~:text=KibanaPageTemplate), [management_app.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/management/public/components/management_app/management_app.tsx#:~:text=KibanaPageTemplate), [management_app.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/management/public/components/management_app/management_app.tsx#:~:text=KibanaPageTemplate) | - | | | [application.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/management/public/application.tsx#:~:text=appBasePath) | 8.8.0 | @@ -419,8 +427,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit) | - | | | [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit), [es_search_source.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit) | - | | | [kibana_server_services.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/kibana_server_services.ts#:~:text=indexPatternsServiceFactory), [indexing_routes.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/data_indexing/indexing_routes.ts#:~:text=indexPatternsServiceFactory) | - | -| | [map_container.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/connected_components/map_container/map_container.tsx#:~:text=ExitFullScreenButton), [map_container.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/connected_components/map_container/map_container.tsx#:~:text=ExitFullScreenButton) | - | -| | [maps_list_view.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/list_page/maps_list_view.tsx#:~:text=settings), [maps_list_view.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/list_page/maps_list_view.tsx#:~:text=settings), [maps_list_view.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/list_page/maps_list_view.tsx#:~:text=settings) | 8.8.0 | | | [render_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/render_app.tsx#:~:text=onAppLeave), [map_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx#:~:text=onAppLeave), [map_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/map_page.tsx#:~:text=onAppLeave) | 8.8.0 | | | [saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/saved_objects/saved_object_migrations.ts#:~:text=warning) | 8.8.0 | @@ -439,6 +445,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| +| | [ml_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/components/ml_page/ml_page.tsx#:~:text=KibanaPageTemplate), [ml_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/components/ml_page/ml_page.tsx#:~:text=KibanaPageTemplate), [ml_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/components/ml_page/ml_page.tsx#:~:text=KibanaPageTemplate) | - | | | [ml_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/components/ml_page/ml_page.tsx#:~:text=RedirectAppLinks), [ml_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/components/ml_page/ml_page.tsx#:~:text=RedirectAppLinks), [ml_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/components/ml_page/ml_page.tsx#:~:text=RedirectAppLinks), [jobs_list_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/management/jobs_list/components/jobs_list_page/jobs_list_page.tsx#:~:text=RedirectAppLinks), [jobs_list_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/management/jobs_list/components/jobs_list_page/jobs_list_page.tsx#:~:text=RedirectAppLinks), [jobs_list_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/management/jobs_list/components/jobs_list_page/jobs_list_page.tsx#:~:text=RedirectAppLinks) | - | | | [check_license.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/license/check_license.tsx#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/plugin.ts#:~:text=license%24) | 8.8.0 | | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/server/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/server/plugin.ts#:~:text=license%24) | 8.8.0 | @@ -456,9 +463,6 @@ so TS and code-reference navigation might not highlight them. | | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [use_derived_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/alerts/components/param_details_form/use_derived_index_pattern.tsx#:~:text=IIndexPattern), [use_derived_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/alerts/components/param_details_form/use_derived_index_pattern.tsx#:~:text=IIndexPattern), [with_kuery_autocompletion.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/components/kuery_bar/with_kuery_autocompletion.tsx#:~:text=IIndexPattern), [with_kuery_autocompletion.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/components/kuery_bar/with_kuery_autocompletion.tsx#:~:text=IIndexPattern), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/components/kuery_bar/index.tsx#:~:text=IIndexPattern), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/components/kuery_bar/index.tsx#:~:text=IIndexPattern), [kuery.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/lib/kuery.ts#:~:text=IIndexPattern), [kuery.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/lib/kuery.ts#:~:text=IIndexPattern) | - | -| | [use_derived_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/alerts/components/param_details_form/use_derived_index_pattern.tsx#:~:text=indexPatterns), [use_derived_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/alerts/components/param_details_form/use_derived_index_pattern.tsx#:~:text=indexPatterns) | - | -| | [use_derived_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/alerts/components/param_details_form/use_derived_index_pattern.tsx#:~:text=IIndexPattern), [use_derived_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/alerts/components/param_details_form/use_derived_index_pattern.tsx#:~:text=IIndexPattern), [with_kuery_autocompletion.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/components/kuery_bar/with_kuery_autocompletion.tsx#:~:text=IIndexPattern), [with_kuery_autocompletion.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/components/kuery_bar/with_kuery_autocompletion.tsx#:~:text=IIndexPattern), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/components/kuery_bar/index.tsx#:~:text=IIndexPattern), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/components/kuery_bar/index.tsx#:~:text=IIndexPattern), [kuery.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/lib/kuery.ts#:~:text=IIndexPattern), [kuery.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/lib/kuery.ts#:~:text=IIndexPattern), [use_derived_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/alerts/components/param_details_form/use_derived_index_pattern.tsx#:~:text=IIndexPattern), [use_derived_index_pattern.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/alerts/components/param_details_form/use_derived_index_pattern.tsx#:~:text=IIndexPattern)+ 6 more | - | | | [legacy_shims.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/legacy_shims.ts#:~:text=injectedMetadata) | 8.8.0 | | | [bulk_uploader.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/kibana_monitoring/bulk_uploader.ts#:~:text=process) | 8.8.0 | @@ -468,10 +472,20 @@ so TS and code-reference navigation might not highlight them. | | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| +| | [page_template.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/page_template/page_template.tsx#:~:text=KibanaPageTemplateProps), [page_template.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/page_template/page_template.tsx#:~:text=KibanaPageTemplateProps), [no_data_config.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/utils/no_data_config.ts#:~:text=KibanaPageTemplateProps), [no_data_config.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/utils/no_data_config.ts#:~:text=KibanaPageTemplateProps) | - | +| | [page_template.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/page_template/page_template.tsx#:~:text=KibanaPageTemplate), [page_template.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/page_template/page_template.tsx#:~:text=KibanaPageTemplate), [page_template.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/page_template/page_template.tsx#:~:text=KibanaPageTemplate) | - | | | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/application/index.tsx#:~:text=RedirectAppLinks), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/application/index.tsx#:~:text=RedirectAppLinks), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/application/index.tsx#:~:text=RedirectAppLinks) | - | +## osquery + +| Deprecated API | Reference location(s) | Remove By | +| ---------------|-----------|-----------| +| | [empty_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/osquery/public/components/empty_state.tsx#:~:text=KibanaPageTemplate), [empty_state.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/osquery/public/components/empty_state.tsx#:~:text=KibanaPageTemplate) | - | + + + ## painlessLab | Deprecated API | Reference location(s) | Remove By | @@ -582,6 +596,8 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| | | [middleware.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#:~:text=indexPatterns), [dependencies_start_mock.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/mock/endpoint/dependencies_start_mock.ts#:~:text=indexPatterns) | - | +| | [use_primary_navigation.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/navigation/use_security_solution_navigation/use_primary_navigation.tsx#:~:text=KibanaPageTemplateProps), [use_primary_navigation.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/navigation/use_security_solution_navigation/use_primary_navigation.tsx#:~:text=KibanaPageTemplateProps), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/template_wrapper/bottom_bar/index.tsx#:~:text=KibanaPageTemplateProps), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/template_wrapper/bottom_bar/index.tsx#:~:text=KibanaPageTemplateProps) | - | +| | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/template_wrapper/index.tsx#:~:text=KibanaPageTemplate), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/template_wrapper/index.tsx#:~:text=KibanaPageTemplate) | - | | | [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode)+ 2 more | 8.8.0 | | | [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode)+ 2 more | 8.8.0 | | | [request_context_factory.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/request_context_factory.ts#:~:text=authc), [request_context_factory.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/request_context_factory.ts#:~:text=authc), [create_signals_migration_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/create_signals_migration_route.ts#:~:text=authc), [delete_signals_migration_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/delete_signals_migration_route.ts#:~:text=authc), [finalize_signals_migration_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/finalize_signals_migration_route.ts#:~:text=authc), [open_close_signals_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/open_close_signals_route.ts#:~:text=authc), [preview_rules_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/preview_rules_route.ts#:~:text=authc), [common.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/timeline/utils/common.ts#:~:text=authc) | - | @@ -602,6 +618,7 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| +| | [space_selector.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/public/space_selector/space_selector.tsx#:~:text=KibanaPageTemplate), [space_selector.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/public/space_selector/space_selector.tsx#:~:text=KibanaPageTemplate), [space_selector.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/public/space_selector/space_selector.tsx#:~:text=KibanaPageTemplate) | - | | | [spaces_management_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/public/management/spaces_management_app.tsx#:~:text=RedirectAppLinks), [spaces_management_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/public/management/spaces_management_app.tsx#:~:text=RedirectAppLinks), [spaces_management_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/public/management/spaces_management_app.tsx#:~:text=RedirectAppLinks) | - | | | [on_post_auth_interceptor.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/server/lib/request_interceptors/on_post_auth_interceptor.ts#:~:text=getKibanaFeatures), [spaces_usage_collector.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/server/usage_collection/spaces_usage_collector.ts#:~:text=getKibanaFeatures), [on_post_auth_interceptor.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/server/lib/request_interceptors/on_post_auth_interceptor.test.ts#:~:text=getKibanaFeatures) | 8.8.0 | | | [spaces_usage_collector.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/server/usage_collection/spaces_usage_collector.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/server/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/server/plugin.ts#:~:text=license%24), [spaces_usage_collector.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/server/usage_collection/spaces_usage_collector.test.ts#:~:text=license%24) | 8.8.0 | @@ -614,18 +631,25 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [read_only_filter_items.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/read_only_filter_items.tsx#:~:text=IIndexPattern), [read_only_filter_items.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/read_only_filter_items.tsx#:~:text=IIndexPattern) | - | | | [fetch_search_source_query.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/lib/fetch_search_source_query.ts#:~:text=fetch), [alert_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/alert_type.test.ts#:~:text=fetch), [alert_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/alert_type.test.ts#:~:text=fetch) | 8.1 | | | [entity_index_expression.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx#:~:text=indexPatterns), [boundary_index_expression.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx#:~:text=indexPatterns), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx#:~:text=indexPatterns), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx#:~:text=indexPatterns), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx#:~:text=indexPatterns) | - | | | [expression.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/threshold/expression.tsx#:~:text=fieldFormats) | - | | | [read_only_filter_items.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/read_only_filter_items.tsx#:~:text=Filter), [read_only_filter_items.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/read_only_filter_items.tsx#:~:text=Filter), [search_source_expression.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/search_source_expression.tsx#:~:text=Filter), [search_source_expression.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/search_source_expression.tsx#:~:text=Filter) | 8.1 | | | [read_only_filter_items.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/read_only_filter_items.tsx#:~:text=Filter), [read_only_filter_items.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/read_only_filter_items.tsx#:~:text=Filter), [search_source_expression.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/search_source_expression.tsx#:~:text=Filter), [search_source_expression.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/search_source_expression.tsx#:~:text=Filter) | 8.1 | -| | [read_only_filter_items.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/read_only_filter_items.tsx#:~:text=IIndexPattern), [read_only_filter_items.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/read_only_filter_items.tsx#:~:text=IIndexPattern), [read_only_filter_items.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/read_only_filter_items.tsx#:~:text=IIndexPattern), [read_only_filter_items.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/read_only_filter_items.tsx#:~:text=IIndexPattern) | - | | | [fetch_search_source_query.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/lib/fetch_search_source_query.ts#:~:text=fetch), [alert_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/alert_type.test.ts#:~:text=fetch), [alert_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/alert_type.test.ts#:~:text=fetch) | 8.1 | | | [read_only_filter_items.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/read_only_filter_items.tsx#:~:text=Filter), [read_only_filter_items.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/read_only_filter_items.tsx#:~:text=Filter), [search_source_expression.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/search_source_expression.tsx#:~:text=Filter), [search_source_expression.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/search_source_expression.tsx#:~:text=Filter) | 8.1 | +## synthetics + +| Deprecated API | Reference location(s) | Remove By | +| ---------------|-----------|-----------| +| | [use_no_data_config.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/synthetics/public/apps/use_no_data_config.ts#:~:text=KibanaPageTemplateProps), [use_no_data_config.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/synthetics/public/apps/use_no_data_config.ts#:~:text=KibanaPageTemplateProps) | - | +| | [alert_messages.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/synthetics/public/lib/alert_types/alert_messages.tsx#:~:text=RedirectAppLinks), [alert_messages.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/synthetics/public/lib/alert_types/alert_messages.tsx#:~:text=RedirectAppLinks), [alert_messages.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/synthetics/public/lib/alert_types/alert_messages.tsx#:~:text=RedirectAppLinks), [uptime_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/synthetics/public/apps/uptime_app.tsx#:~:text=RedirectAppLinks), [uptime_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/synthetics/public/apps/uptime_app.tsx#:~:text=RedirectAppLinks), [uptime_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/synthetics/public/apps/uptime_app.tsx#:~:text=RedirectAppLinks) | - | + + + ## transform | Deprecated API | Reference location(s) | Remove By | @@ -638,20 +662,22 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [fetch_index_patterns.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/query_string_input/fetch_index_patterns.ts#:~:text=IndexPatternsContract), [fetch_index_patterns.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/query_string_input/fetch_index_patterns.ts#:~:text=IndexPatternsContract), [index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx#:~:text=IndexPatternsContract), [index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx#:~:text=IndexPatternsContract), [create_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/create_index_pattern_select.tsx#:~:text=IndexPatternsContract), [create_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/create_index_pattern_select.tsx#:~:text=IndexPatternsContract), [fetch_index_patterns.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/query_string_input/fetch_index_patterns.ts#:~:text=IndexPatternsContract), [fetch_index_patterns.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/query_string_input/fetch_index_patterns.ts#:~:text=IndexPatternsContract), [index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx#:~:text=IndexPatternsContract), [index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx#:~:text=IndexPatternsContract)+ 2 more | - | -| | [query_string_input.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/query_string_input/query_string_input.tsx#:~:text=IIndexPattern), [query_string_input.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/query_string_input/query_string_input.tsx#:~:text=IIndexPattern), [query_string_input.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/query_string_input/query_string_input.tsx#:~:text=IIndexPattern), [query_string_input.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/query_string_input/query_string_input.tsx#:~:text=IIndexPattern), [query_string_input.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/query_string_input/query_string_input.tsx#:~:text=IIndexPattern), [query_bar_top_row.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/query_string_input/query_bar_top_row.tsx#:~:text=IIndexPattern), [query_bar_top_row.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/query_string_input/query_bar_top_row.tsx#:~:text=IIndexPattern), [filter_editor_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts#:~:text=IIndexPattern), [filter_editor_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts#:~:text=IIndexPattern), [filter_editor_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts#:~:text=IIndexPattern)+ 18 more | - | -| | [filter_editor_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts#:~:text=IFieldType), [filter_editor_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts#:~:text=IFieldType), [filter_editor_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts#:~:text=IFieldType), [filter_editor_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts#:~:text=IFieldType), [phrase_suggestor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/phrase_suggestor.tsx#:~:text=IFieldType), [phrase_suggestor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/phrase_suggestor.tsx#:~:text=IFieldType), [range_value_input.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/range_value_input.tsx#:~:text=IFieldType), [range_value_input.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/range_value_input.tsx#:~:text=IFieldType), [index.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx#:~:text=IFieldType), [index.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx#:~:text=IFieldType)+ 8 more | 8.2 | +| | [index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx#:~:text=IndexPatternsContract), [index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx#:~:text=IndexPatternsContract), [create_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/create_index_pattern_select.tsx#:~:text=IndexPatternsContract), [create_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/create_index_pattern_select.tsx#:~:text=IndexPatternsContract), [index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx#:~:text=IndexPatternsContract), [index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx#:~:text=IndexPatternsContract), [create_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/create_index_pattern_select.tsx#:~:text=IndexPatternsContract), [create_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/create_index_pattern_select.tsx#:~:text=IndexPatternsContract) | - | +| | [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IIndexPattern), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IIndexPattern), [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IIndexPattern), [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IIndexPattern), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IIndexPattern), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IIndexPattern), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IIndexPattern) | - | +| | [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IFieldType), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IFieldType), [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IFieldType), [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType)+ 25 more | 8.2 | | | [query_string_input.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/query_string_input/query_string_input.tsx#:~:text=indexPatterns) | - | | | [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=esFilters), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=esFilters), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=esFilters) | 8.1 | +| | [conjunction.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts#:~:text=KueryNode), [conjunction.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts#:~:text=KueryNode), [conjunction.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts#:~:text=KueryNode), [field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts#:~:text=KueryNode), [field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts#:~:text=KueryNode), [field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts#:~:text=KueryNode), [operator.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts#:~:text=KueryNode), [operator.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts#:~:text=KueryNode), [operator.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts#:~:text=KueryNode), [value.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.test.ts#:~:text=KueryNode)+ 2 more | 8.1 | | | [use_filter_manager.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/search_bar/lib/use_filter_manager.ts#:~:text=Filter), [use_filter_manager.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/search_bar/lib/use_filter_manager.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [get_stub_filter.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/test_helpers/get_stub_filter.ts#:~:text=Filter), [get_stub_filter.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/test_helpers/get_stub_filter.ts#:~:text=Filter), [filter_label.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx#:~:text=Filter)+ 10 more | 8.1 | | | [filter_label.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx#:~:text=FILTERS), [filter_label.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx#:~:text=FILTERS), [filter_label.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx#:~:text=FILTERS), [filter_label.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx#:~:text=FILTERS), [filter_label.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx#:~:text=FILTERS), [filter_label.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx#:~:text=FILTERS) | 8.1 | | | [filter_editor_utils.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.test.ts#:~:text=toggleFilterNegated), [filter_editor_utils.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.test.ts#:~:text=toggleFilterNegated), [filter_editor_utils.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.test.ts#:~:text=toggleFilterNegated), [filter_editor_utils.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.test.ts#:~:text=toggleFilterNegated), [filter_editor_utils.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.test.ts#:~:text=toggleFilterNegated) | 8.1 | | | [use_filter_manager.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/search_bar/lib/use_filter_manager.ts#:~:text=Filter), [use_filter_manager.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/search_bar/lib/use_filter_manager.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [get_stub_filter.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/test_helpers/get_stub_filter.ts#:~:text=Filter), [get_stub_filter.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/test_helpers/get_stub_filter.ts#:~:text=Filter), [filter_label.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx#:~:text=Filter)+ 10 more | 8.1 | -| | [filter_editor_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts#:~:text=IFieldType), [filter_editor_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts#:~:text=IFieldType), [filter_editor_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts#:~:text=IFieldType), [filter_editor_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts#:~:text=IFieldType), [phrase_suggestor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/phrase_suggestor.tsx#:~:text=IFieldType), [phrase_suggestor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/phrase_suggestor.tsx#:~:text=IFieldType), [range_value_input.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/range_value_input.tsx#:~:text=IFieldType), [range_value_input.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/range_value_input.tsx#:~:text=IFieldType), [index.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx#:~:text=IFieldType), [index.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx#:~:text=IFieldType)+ 26 more | 8.2 | -| | [query_string_input.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/query_string_input/query_string_input.tsx#:~:text=IIndexPattern), [query_string_input.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/query_string_input/query_string_input.tsx#:~:text=IIndexPattern), [query_string_input.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/query_string_input/query_string_input.tsx#:~:text=IIndexPattern), [query_string_input.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/query_string_input/query_string_input.tsx#:~:text=IIndexPattern), [query_string_input.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/query_string_input/query_string_input.tsx#:~:text=IIndexPattern), [query_bar_top_row.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/query_string_input/query_bar_top_row.tsx#:~:text=IIndexPattern), [query_bar_top_row.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/query_string_input/query_bar_top_row.tsx#:~:text=IIndexPattern), [filter_editor_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts#:~:text=IIndexPattern), [filter_editor_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts#:~:text=IIndexPattern), [filter_editor_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts#:~:text=IIndexPattern)+ 46 more | - | -| | [fetch_index_patterns.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/query_string_input/fetch_index_patterns.ts#:~:text=IndexPatternsContract), [fetch_index_patterns.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/query_string_input/fetch_index_patterns.ts#:~:text=IndexPatternsContract), [index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx#:~:text=IndexPatternsContract), [index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx#:~:text=IndexPatternsContract), [create_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/create_index_pattern_select.tsx#:~:text=IndexPatternsContract), [create_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/create_index_pattern_select.tsx#:~:text=IndexPatternsContract), [fetch_index_patterns.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/query_string_input/fetch_index_patterns.ts#:~:text=IndexPatternsContract), [fetch_index_patterns.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/query_string_input/fetch_index_patterns.ts#:~:text=IndexPatternsContract), [index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx#:~:text=IndexPatternsContract), [index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx#:~:text=IndexPatternsContract)+ 2 more | - | -| | [filter_editor_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts#:~:text=IFieldType), [filter_editor_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts#:~:text=IFieldType), [filter_editor_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts#:~:text=IFieldType), [filter_editor_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts#:~:text=IFieldType), [phrase_suggestor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/phrase_suggestor.tsx#:~:text=IFieldType), [phrase_suggestor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/phrase_suggestor.tsx#:~:text=IFieldType), [range_value_input.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/range_value_input.tsx#:~:text=IFieldType), [range_value_input.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/range_value_input.tsx#:~:text=IFieldType), [index.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx#:~:text=IFieldType), [index.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx#:~:text=IFieldType)+ 8 more | 8.2 | +| | [conjunction.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts#:~:text=KueryNode), [conjunction.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts#:~:text=KueryNode), [conjunction.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts#:~:text=KueryNode), [field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts#:~:text=KueryNode), [field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts#:~:text=KueryNode), [field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts#:~:text=KueryNode), [operator.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts#:~:text=KueryNode), [operator.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts#:~:text=KueryNode), [operator.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts#:~:text=KueryNode), [value.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.test.ts#:~:text=KueryNode)+ 2 more | 8.1 | +| | [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IFieldType), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IFieldType), [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IFieldType), [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType)+ 60 more | 8.2 | +| | [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IIndexPattern), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IIndexPattern), [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IIndexPattern), [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IIndexPattern), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IIndexPattern), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IIndexPattern), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IIndexPattern), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IIndexPattern), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IIndexPattern), [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IIndexPattern)+ 4 more | - | +| | [index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx#:~:text=IndexPatternsContract), [index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx#:~:text=IndexPatternsContract), [create_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/create_index_pattern_select.tsx#:~:text=IndexPatternsContract), [create_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/create_index_pattern_select.tsx#:~:text=IndexPatternsContract), [index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx#:~:text=IndexPatternsContract), [index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx#:~:text=IndexPatternsContract), [create_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/create_index_pattern_select.tsx#:~:text=IndexPatternsContract), [create_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/create_index_pattern_select.tsx#:~:text=IndexPatternsContract) | - | | | [use_filter_manager.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/search_bar/lib/use_filter_manager.ts#:~:text=Filter), [use_filter_manager.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/search_bar/lib/use_filter_manager.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [get_stub_filter.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/test_helpers/get_stub_filter.ts#:~:text=Filter), [get_stub_filter.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/test_helpers/get_stub_filter.ts#:~:text=Filter), [filter_label.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx#:~:text=Filter)+ 10 more | 8.1 | +| | [conjunction.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts#:~:text=KueryNode), [conjunction.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts#:~:text=KueryNode), [conjunction.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts#:~:text=KueryNode), [field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts#:~:text=KueryNode), [field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts#:~:text=KueryNode), [field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts#:~:text=KueryNode), [operator.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts#:~:text=KueryNode), [operator.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts#:~:text=KueryNode), [operator.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts#:~:text=KueryNode), [value.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.test.ts#:~:text=KueryNode)+ 2 more | 8.1 | @@ -664,18 +690,6 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ -## uptime - -| Deprecated API | Reference location(s) | Remove By | -| ---------------|-----------|-----------| -| | [update_kuery_string.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/hooks/update_kuery_string.ts#:~:text=IndexPattern), [update_kuery_string.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/hooks/update_kuery_string.ts#:~:text=IndexPattern), [uptime_index_pattern_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx#:~:text=IndexPattern), [uptime_index_pattern_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx#:~:text=IndexPattern), [uptime_index_pattern_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx#:~:text=IndexPattern), [update_kuery_string.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/hooks/update_kuery_string.ts#:~:text=IndexPattern), [update_kuery_string.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/hooks/update_kuery_string.ts#:~:text=IndexPattern), [uptime_index_pattern_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx#:~:text=IndexPattern), [uptime_index_pattern_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx#:~:text=IndexPattern), [uptime_index_pattern_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx#:~:text=IndexPattern) | - | -| | [uptime_index_pattern_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx#:~:text=indexPatterns) | - | -| | [update_kuery_string.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/hooks/update_kuery_string.ts#:~:text=IndexPattern), [update_kuery_string.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/hooks/update_kuery_string.ts#:~:text=IndexPattern), [uptime_index_pattern_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx#:~:text=IndexPattern), [uptime_index_pattern_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx#:~:text=IndexPattern), [uptime_index_pattern_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx#:~:text=IndexPattern), [update_kuery_string.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/hooks/update_kuery_string.ts#:~:text=IndexPattern), [update_kuery_string.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/hooks/update_kuery_string.ts#:~:text=IndexPattern), [uptime_index_pattern_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx#:~:text=IndexPattern), [uptime_index_pattern_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx#:~:text=IndexPattern), [uptime_index_pattern_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx#:~:text=IndexPattern) | - | -| | [update_kuery_string.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/hooks/update_kuery_string.ts#:~:text=IndexPattern), [update_kuery_string.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/hooks/update_kuery_string.ts#:~:text=IndexPattern), [uptime_index_pattern_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx#:~:text=IndexPattern), [uptime_index_pattern_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx#:~:text=IndexPattern), [uptime_index_pattern_context.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/contexts/uptime_index_pattern_context.tsx#:~:text=IndexPattern) | - | -| | [alert_messages.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/lib/alert_types/alert_messages.tsx#:~:text=RedirectAppLinks), [alert_messages.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/lib/alert_types/alert_messages.tsx#:~:text=RedirectAppLinks), [alert_messages.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/lib/alert_types/alert_messages.tsx#:~:text=RedirectAppLinks), [uptime_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/apps/uptime_app.tsx#:~:text=RedirectAppLinks), [uptime_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/apps/uptime_app.tsx#:~:text=RedirectAppLinks), [uptime_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/uptime/public/apps/uptime_app.tsx#:~:text=RedirectAppLinks) | - | - - - ## urlDrilldown | Deprecated API | Reference location(s) | Remove By | @@ -693,6 +707,7 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | | [selected_filters.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx#:~:text=IndexPattern), [selected_filters.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx#:~:text=IndexPattern), [selected_wildcards.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx#:~:text=IndexPattern), [selected_wildcards.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx#:~:text=IndexPattern), [selected_filters.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx#:~:text=IndexPattern), [selected_filters.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx#:~:text=IndexPattern), [selected_wildcards.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx#:~:text=IndexPattern), [selected_wildcards.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx#:~:text=IndexPattern) | - | | | [selected_filters.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx#:~:text=IndexPattern), [selected_filters.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx#:~:text=IndexPattern), [selected_wildcards.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx#:~:text=IndexPattern), [selected_wildcards.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx#:~:text=IndexPattern), [selected_filters.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx#:~:text=IndexPattern), [selected_filters.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx#:~:text=IndexPattern), [selected_wildcards.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx#:~:text=IndexPattern), [selected_wildcards.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx#:~:text=IndexPattern) | - | | | [selected_filters.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx#:~:text=IndexPattern), [selected_filters.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_filters.tsx#:~:text=IndexPattern), [selected_wildcards.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx#:~:text=IndexPattern), [selected_wildcards.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/local_uifilters/selected_wildcards.tsx#:~:text=IndexPattern) | - | +| | [rum_home.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/rum_home.tsx#:~:text=KibanaPageTemplateProps), [rum_home.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/components/app/rum_dashboard/rum_home.tsx#:~:text=KibanaPageTemplateProps) | - | | | [ux_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/application/ux_app.tsx#:~:text=RedirectAppLinks), [ux_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/application/ux_app.tsx#:~:text=RedirectAppLinks), [ux_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ux/public/application/ux_app.tsx#:~:text=RedirectAppLinks) | - | @@ -782,7 +797,6 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | ---------------|-----------|-----------| | | [get_table_columns.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/utils/get_table_columns.tsx#:~:text=RedirectAppLinks), [get_table_columns.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/utils/get_table_columns.tsx#:~:text=RedirectAppLinks), [get_table_columns.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/utils/get_table_columns.tsx#:~:text=RedirectAppLinks) | - | | | [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject) | 8.8.0 | -| | [visualize_listing.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_listing.tsx#:~:text=settings), [visualize_listing.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_listing.tsx#:~:text=settings) | 8.8.0 | | | [visualize_top_nav.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx#:~:text=onAppLeave), [visualize_editor_common.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_editor_common.tsx#:~:text=onAppLeave), [app.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/app.tsx#:~:text=onAppLeave), [index.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/index.tsx#:~:text=onAppLeave) | 8.8.0 | diff --git a/api_docs/deprecations_by_team.mdx b/api_docs/deprecations_by_team.mdx index 43a36e5f1cf9d..aab61180e9dc8 100644 --- a/api_docs/deprecations_by_team.mdx +++ b/api_docs/deprecations_by_team.mdx @@ -3,7 +3,7 @@ id: kibDevDocsDeprecationsDueByTeam slug: /kibana-dev-docs/api-meta/deprecations-due-by-team title: Deprecated APIs due to be removed, by team summary: Lists the teams that are referencing deprecated APIs with a remove by date. -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. --- @@ -25,9 +25,8 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Plugin | Deprecated API | Reference location(s) | Remove By | | --------|-------|-----------|-----------| -| dataViews | | [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType)+ 13 more | 8.2 | -| dataViews | | [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType)+ 47 more | 8.2 | -| dataViews | | [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType)+ 13 more | 8.2 | +| dataViews | | [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType)+ 7 more | 8.2 | +| dataViews | | [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType)+ 23 more | 8.2 | | dataEnhanced | | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode) | 8.1 | | dataEnhanced | | [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=nodeBuilder), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=nodeBuilder), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=nodeBuilder), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=nodeBuilder), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=nodeBuilder), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=nodeBuilder), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=nodeBuilder), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=nodeBuilder), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=nodeBuilder), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=nodeBuilder)+ 2 more | 8.1 | | dataEnhanced | | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode) | 8.1 | @@ -49,7 +48,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | discover | | [anchor.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/anchor.ts#:~:text=fetch), [fetch_hits_in_interval.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/utils/fetch_hits_in_interval.ts#:~:text=fetch) | 8.1 | | discover | | [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter), [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter) | 8.1 | | discover | | [on_save_search.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/top_nav/on_save_search.tsx#:~:text=SavedObjectSaveModal), [on_save_search.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/components/top_nav/on_save_search.tsx#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/components/save_modal.tsx#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/components/save_modal.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 | -| graph | | [listing_route.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/apps/listing_route.tsx#:~:text=settings), [listing_route.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/apps/listing_route.tsx#:~:text=settings) | 8.8.0 | | graph | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/server/plugin.ts#:~:text=license%24) | 8.8.0 | @@ -69,7 +67,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Plugin | Deprecated API | Reference location(s) | Remove By | | --------|-------|-----------|-----------| -| maps | | [maps_list_view.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/list_page/maps_list_view.tsx#:~:text=settings), [maps_list_view.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/list_page/maps_list_view.tsx#:~:text=settings), [maps_list_view.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/list_page/maps_list_view.tsx#:~:text=settings) | 8.8.0 | | maps | | [render_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/render_app.tsx#:~:text=onAppLeave), [map_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx#:~:text=onAppLeave), [map_page.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/map_page.tsx#:~:text=onAppLeave) | 8.8.0 | | maps | | [saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/server/saved_objects/saved_object_migrations.ts#:~:text=warning) | 8.8.0 | | mapsEms | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/maps_ems/server/index.ts#:~:text=license%24) | 8.8.0 | @@ -99,7 +96,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | dashboard | | [saved_objects.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/saved_objects.ts#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/top_nav/save_modal.tsx#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/top_nav/save_modal.tsx#:~:text=SavedObjectSaveModal), [saved_object_save_modal_dashboard.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx#:~:text=SavedObjectSaveModal), [saved_object_save_modal_dashboard.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 | | dashboard | | [saved_object_loader.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/saved_object_loader.ts#:~:text=SavedObject), [saved_object_loader.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/saved_object_loader.ts#:~:text=SavedObject), [saved_object_loader.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/saved_object_loader.ts#:~:text=SavedObject), [saved_objects.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/saved_objects.ts#:~:text=SavedObject), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=SavedObject), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=SavedObject), [dashboard_tagging.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/dashboard_tagging.ts#:~:text=SavedObject), [dashboard_tagging.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/dashboard_tagging.ts#:~:text=SavedObject), [clone_panel_action.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/actions/clone_panel_action.tsx#:~:text=SavedObject), [clone_panel_action.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/actions/clone_panel_action.tsx#:~:text=SavedObject)+ 1 more | 8.8.0 | | dashboard | | [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=SavedObjectClass) | 8.8.0 | -| dashboard | | [dashboard_listing.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/listing/dashboard_listing.tsx#:~:text=settings), [dashboard_listing.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/listing/dashboard_listing.tsx#:~:text=settings) | 8.8.0 | | dashboard | | [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/types.ts#:~:text=onAppLeave), [dashboard_router.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/dashboard_router.tsx#:~:text=onAppLeave), [plugin.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/plugin.tsx#:~:text=onAppLeave) | 8.8.0 | | dashboard | | [migrations_730.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/server/saved_objects/migrations_730.ts#:~:text=warning), [migrations_730.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/server/saved_objects/migrations_730.ts#:~:text=warning) | 8.8.0 | @@ -208,15 +204,17 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | Plugin | Deprecated API | Reference location(s) | Remove By | | --------|-------|-----------|-----------| -| unifiedSearch | | [filter_editor_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts#:~:text=IFieldType), [filter_editor_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts#:~:text=IFieldType), [filter_editor_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts#:~:text=IFieldType), [filter_editor_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts#:~:text=IFieldType), [phrase_suggestor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/phrase_suggestor.tsx#:~:text=IFieldType), [phrase_suggestor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/phrase_suggestor.tsx#:~:text=IFieldType), [range_value_input.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/range_value_input.tsx#:~:text=IFieldType), [range_value_input.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/range_value_input.tsx#:~:text=IFieldType), [index.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx#:~:text=IFieldType), [index.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx#:~:text=IFieldType)+ 8 more | 8.2 | +| unifiedSearch | | [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IFieldType), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IFieldType), [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IFieldType), [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType)+ 25 more | 8.2 | | unifiedSearch | | [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=esFilters), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=esFilters), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=esFilters) | 8.1 | +| unifiedSearch | | [conjunction.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts#:~:text=KueryNode), [conjunction.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts#:~:text=KueryNode), [conjunction.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts#:~:text=KueryNode), [field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts#:~:text=KueryNode), [field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts#:~:text=KueryNode), [field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts#:~:text=KueryNode), [operator.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts#:~:text=KueryNode), [operator.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts#:~:text=KueryNode), [operator.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts#:~:text=KueryNode), [value.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.test.ts#:~:text=KueryNode)+ 2 more | 8.1 | | unifiedSearch | | [use_filter_manager.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/search_bar/lib/use_filter_manager.ts#:~:text=Filter), [use_filter_manager.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/search_bar/lib/use_filter_manager.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [get_stub_filter.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/test_helpers/get_stub_filter.ts#:~:text=Filter), [get_stub_filter.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/test_helpers/get_stub_filter.ts#:~:text=Filter), [filter_label.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx#:~:text=Filter)+ 10 more | 8.1 | | unifiedSearch | | [filter_label.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx#:~:text=FILTERS), [filter_label.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx#:~:text=FILTERS), [filter_label.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx#:~:text=FILTERS), [filter_label.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx#:~:text=FILTERS), [filter_label.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx#:~:text=FILTERS), [filter_label.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx#:~:text=FILTERS) | 8.1 | | unifiedSearch | | [filter_editor_utils.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.test.ts#:~:text=toggleFilterNegated), [filter_editor_utils.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.test.ts#:~:text=toggleFilterNegated), [filter_editor_utils.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.test.ts#:~:text=toggleFilterNegated), [filter_editor_utils.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.test.ts#:~:text=toggleFilterNegated), [filter_editor_utils.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.test.ts#:~:text=toggleFilterNegated) | 8.1 | | unifiedSearch | | [use_filter_manager.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/search_bar/lib/use_filter_manager.ts#:~:text=Filter), [use_filter_manager.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/search_bar/lib/use_filter_manager.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [get_stub_filter.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/test_helpers/get_stub_filter.ts#:~:text=Filter), [get_stub_filter.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/test_helpers/get_stub_filter.ts#:~:text=Filter), [filter_label.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx#:~:text=Filter)+ 10 more | 8.1 | -| unifiedSearch | | [filter_editor_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts#:~:text=IFieldType), [filter_editor_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts#:~:text=IFieldType), [filter_editor_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts#:~:text=IFieldType), [filter_editor_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts#:~:text=IFieldType), [phrase_suggestor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/phrase_suggestor.tsx#:~:text=IFieldType), [phrase_suggestor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/phrase_suggestor.tsx#:~:text=IFieldType), [range_value_input.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/range_value_input.tsx#:~:text=IFieldType), [range_value_input.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/range_value_input.tsx#:~:text=IFieldType), [index.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx#:~:text=IFieldType), [index.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx#:~:text=IFieldType)+ 26 more | 8.2 | -| unifiedSearch | | [filter_editor_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts#:~:text=IFieldType), [filter_editor_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts#:~:text=IFieldType), [filter_editor_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts#:~:text=IFieldType), [filter_editor_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts#:~:text=IFieldType), [phrase_suggestor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/phrase_suggestor.tsx#:~:text=IFieldType), [phrase_suggestor.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/phrase_suggestor.tsx#:~:text=IFieldType), [range_value_input.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/range_value_input.tsx#:~:text=IFieldType), [range_value_input.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/range_value_input.tsx#:~:text=IFieldType), [index.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx#:~:text=IFieldType), [index.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx#:~:text=IFieldType)+ 8 more | 8.2 | +| unifiedSearch | | [conjunction.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts#:~:text=KueryNode), [conjunction.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts#:~:text=KueryNode), [conjunction.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts#:~:text=KueryNode), [field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts#:~:text=KueryNode), [field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts#:~:text=KueryNode), [field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts#:~:text=KueryNode), [operator.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts#:~:text=KueryNode), [operator.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts#:~:text=KueryNode), [operator.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts#:~:text=KueryNode), [value.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.test.ts#:~:text=KueryNode)+ 2 more | 8.1 | +| unifiedSearch | | [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IFieldType), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IFieldType), [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IFieldType), [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType)+ 60 more | 8.2 | | unifiedSearch | | [use_filter_manager.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/search_bar/lib/use_filter_manager.ts#:~:text=Filter), [use_filter_manager.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/search_bar/lib/use_filter_manager.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [get_stub_filter.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/test_helpers/get_stub_filter.ts#:~:text=Filter), [get_stub_filter.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/test_helpers/get_stub_filter.ts#:~:text=Filter), [filter_label.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx#:~:text=Filter)+ 10 more | 8.1 | +| unifiedSearch | | [conjunction.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts#:~:text=KueryNode), [conjunction.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts#:~:text=KueryNode), [conjunction.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts#:~:text=KueryNode), [field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts#:~:text=KueryNode), [field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts#:~:text=KueryNode), [field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts#:~:text=KueryNode), [operator.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts#:~:text=KueryNode), [operator.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts#:~:text=KueryNode), [operator.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts#:~:text=KueryNode), [value.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.test.ts#:~:text=KueryNode)+ 2 more | 8.1 | @@ -227,7 +225,6 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | lens | | [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject) | 8.8.0 | | lens | | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/types.ts#:~:text=onAppLeave), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/types.ts#:~:text=onAppLeave), [mounter.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/mounter.tsx#:~:text=onAppLeave), [visualize_top_nav.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx#:~:text=onAppLeave), [visualize_editor_common.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_editor_common.tsx#:~:text=onAppLeave), [app.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/app.tsx#:~:text=onAppLeave), [index.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/index.tsx#:~:text=onAppLeave) | 8.8.0 | | lens | | [saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/migrations/saved_object_migrations.ts#:~:text=warning), [saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/migrations/saved_object_migrations.ts#:~:text=warning) | 8.8.0 | -| visualizations | | [visualize_listing.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_listing.tsx#:~:text=settings), [visualize_listing.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_listing.tsx#:~:text=settings) | 8.8.0 | | management | | [application.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/management/public/application.tsx#:~:text=appBasePath) | 8.8.0 | | visTypeVega | | [plugin.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/plugin.ts#:~:text=injectedMetadata) | 8.8.0 | | visTypeVega | | [search_api.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/data_model/search_api.ts#:~:text=injectedMetadata), [plugin.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/plugin.ts#:~:text=injectedMetadata) | 8.8.0 | \ No newline at end of file diff --git a/api_docs/dev_tools.mdx b/api_docs/dev_tools.mdx index fefa3a0c3391c..21a175173b3f6 100644 --- a/api_docs/dev_tools.mdx +++ b/api_docs/dev_tools.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/devTools title: "devTools" image: https://source.unsplash.com/400x175/?github summary: API docs for the devTools plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/discover.devdocs.json b/api_docs/discover.devdocs.json index 4f5f940b63275..e4d6e9e749105 100644 --- a/api_docs/discover.devdocs.json +++ b/api_docs/discover.devdocs.json @@ -1222,20 +1222,6 @@ "interfaces": [], "enums": [], "misc": [ - { - "parentPluginId": "discover", - "id": "def-common.APP_ID", - "type": "string", - "tags": [], - "label": "APP_ID", - "description": [], - "signature": [ - "\"discover\"" - ], - "path": "src/plugins/discover/common/index.ts", - "deprecated": false, - "initialIsOpen": false - }, { "parentPluginId": "discover", "id": "def-common.CONTEXT_DEFAULT_SIZE_SETTING", diff --git a/api_docs/discover.mdx b/api_docs/discover.mdx index 43970283258bf..960d60c26777d 100644 --- a/api_docs/discover.mdx +++ b/api_docs/discover.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/discover title: "discover" image: https://source.unsplash.com/400x175/?github summary: API docs for the discover plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Data Discovery](https://github.com/orgs/elastic/teams/kibana-data-disco | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 77 | 0 | 61 | 7 | +| 76 | 0 | 60 | 7 | ## Client diff --git a/api_docs/discover_enhanced.mdx b/api_docs/discover_enhanced.mdx index 76d0262f5cfe8..e8c18b01c1cfc 100644 --- a/api_docs/discover_enhanced.mdx +++ b/api_docs/discover_enhanced.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/discoverEnhanced title: "discoverEnhanced" image: https://source.unsplash.com/400x175/?github summary: API docs for the discoverEnhanced plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/elastic_analytics.mdx b/api_docs/elastic_analytics.mdx deleted file mode 100644 index 2d00c52f5e6a0..0000000000000 --- a/api_docs/elastic_analytics.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -id: kibElasticAnalyticsPluginApi -slug: /kibana-dev-docs/api/elastic-analytics -title: "@elastic/analytics" -image: https://source.unsplash.com/400x175/?github -summary: API docs for the @elastic/analytics plugin -date: 2022-04-05 -tags: ['contributor', 'dev', 'apidocs', 'kibana', '@elastic/analytics'] -warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. ---- -import elasticAnalyticsObj from './elastic_analytics.devdocs.json'; - - - -Contact [Owner missing] for questions regarding this plugin. - -**Code health stats** - -| Public API count | Any count | Items lacking comments | Missing exports | -|-------------------|-----------|------------------------|-----------------| -| 82 | 1 | 11 | 0 | - -## Server - -### Functions - - -### Interfaces - - -### Enums - - -### Consts, variables and types - - diff --git a/api_docs/elastic_apm_synthtrace.devdocs.json b/api_docs/elastic_apm_synthtrace.devdocs.json index 0e802d55936c3..aa59d75c2508a 100644 --- a/api_docs/elastic_apm_synthtrace.devdocs.json +++ b/api_docs/elastic_apm_synthtrace.devdocs.json @@ -64,20 +64,36 @@ { "parentPluginId": "@elastic/apm-synthtrace", "id": "def-server.ApmSynthtraceEsClient.Unnamed.$3", - "type": "boolean", + "type": "Object", "tags": [], - "label": "forceDataStreams", + "label": "options", "description": [], "signature": [ - "boolean" + "ApmSynthtraceEsClientOptions", + " | undefined" ], "path": "packages/elastic-apm-synthtrace/src/lib/apm/client/apm_synthtrace_es_client.ts", "deprecated": false, - "isRequired": true + "isRequired": false } ], "returnComment": [] }, + { + "parentPluginId": "@elastic/apm-synthtrace", + "id": "def-server.ApmSynthtraceEsClient.runningVersion", + "type": "Function", + "tags": [], + "label": "runningVersion", + "description": [], + "signature": [ + "() => Promise" + ], + "path": "packages/elastic-apm-synthtrace/src/lib/apm/client/apm_synthtrace_es_client.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, { "parentPluginId": "@elastic/apm-synthtrace", "id": "def-server.ApmSynthtraceEsClient.clean", @@ -123,6 +139,53 @@ ], "returnComment": [] }, + { + "parentPluginId": "@elastic/apm-synthtrace", + "id": "def-server.ApmSynthtraceEsClient.registerGcpRepository", + "type": "Function", + "tags": [], + "label": "registerGcpRepository", + "description": [], + "signature": [ + "(connectionString: string) => Promise" + ], + "path": "packages/elastic-apm-synthtrace/src/lib/apm/client/apm_synthtrace_es_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@elastic/apm-synthtrace", + "id": "def-server.ApmSynthtraceEsClient.registerGcpRepository.$1", + "type": "string", + "tags": [], + "label": "connectionString", + "description": [], + "signature": [ + "string" + ], + "path": "packages/elastic-apm-synthtrace/src/lib/apm/client/apm_synthtrace_es_client.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@elastic/apm-synthtrace", + "id": "def-server.ApmSynthtraceEsClient.refresh", + "type": "Function", + "tags": [], + "label": "refresh", + "description": [], + "signature": [ + "() => Promise<", + "ShardsOperationResponseBase", + ">" + ], + "path": "packages/elastic-apm-synthtrace/src/lib/apm/client/apm_synthtrace_es_client.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, { "parentPluginId": "@elastic/apm-synthtrace", "id": "def-server.ApmSynthtraceEsClient.index", @@ -131,27 +194,43 @@ "label": "index", "description": [], "signature": [ - "(events: ", + "(events: ", { "pluginId": "@elastic/apm-synthtrace", "scope": "server", "docId": "kibElasticApmSynthtracePluginApi", - "section": "def-server.SpanIterable", - "text": "SpanIterable" + "section": "def-server.EntityIterable", + "text": "EntityIterable" }, - " | ", + " | ", { "pluginId": "@elastic/apm-synthtrace", "scope": "server", "docId": "kibElasticApmSynthtracePluginApi", - "section": "def-server.SpanIterable", - "text": "SpanIterable" + "section": "def-server.EntityIterable", + "text": "EntityIterable" }, - "[], options?: ", + "[], options?: ", "StreamToBulkOptions", - " | undefined) => Promise<", - "ShardsOperationResponseBase", - ">" + "<", + { + "pluginId": "@elastic/apm-synthtrace", + "scope": "server", + "docId": "kibElasticApmSynthtracePluginApi", + "section": "def-server.ApmFields", + "text": "ApmFields" + }, + "> | undefined, streamProcessor?: ", + "StreamProcessor", + "<", + { + "pluginId": "@elastic/apm-synthtrace", + "scope": "server", + "docId": "kibElasticApmSynthtracePluginApi", + "section": "def-server.ApmFields", + "text": "ApmFields" + }, + "> | undefined) => Promise" ], "path": "packages/elastic-apm-synthtrace/src/lib/apm/client/apm_synthtrace_es_client.ts", "deprecated": false, @@ -168,18 +247,18 @@ "pluginId": "@elastic/apm-synthtrace", "scope": "server", "docId": "kibElasticApmSynthtracePluginApi", - "section": "def-server.SpanIterable", - "text": "SpanIterable" + "section": "def-server.EntityIterable", + "text": "EntityIterable" }, - " | ", + " | ", { "pluginId": "@elastic/apm-synthtrace", "scope": "server", "docId": "kibElasticApmSynthtracePluginApi", - "section": "def-server.SpanIterable", - "text": "SpanIterable" + "section": "def-server.EntityIterable", + "text": "EntityIterable" }, - "[]" + "[]" ], "path": "packages/elastic-apm-synthtrace/src/lib/apm/client/apm_synthtrace_es_client.ts", "deprecated": false, @@ -194,7 +273,38 @@ "description": [], "signature": [ "StreamToBulkOptions", - " | undefined" + "<", + { + "pluginId": "@elastic/apm-synthtrace", + "scope": "server", + "docId": "kibElasticApmSynthtracePluginApi", + "section": "def-server.ApmFields", + "text": "ApmFields" + }, + "> | undefined" + ], + "path": "packages/elastic-apm-synthtrace/src/lib/apm/client/apm_synthtrace_es_client.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "@elastic/apm-synthtrace", + "id": "def-server.ApmSynthtraceEsClient.index.$3", + "type": "Object", + "tags": [], + "label": "streamProcessor", + "description": [], + "signature": [ + "StreamProcessor", + "<", + { + "pluginId": "@elastic/apm-synthtrace", + "scope": "server", + "docId": "kibElasticApmSynthtracePluginApi", + "section": "def-server.ApmFields", + "text": "ApmFields" + }, + "> | undefined" ], "path": "packages/elastic-apm-synthtrace/src/lib/apm/client/apm_synthtrace_es_client.ts", "deprecated": false, @@ -208,34 +318,35 @@ }, { "parentPluginId": "@elastic/apm-synthtrace", - "id": "def-server.SpanArrayIterable", + "id": "def-server.EntityArrayIterable", "type": "Class", "tags": [], - "label": "SpanArrayIterable", + "label": "EntityArrayIterable", "description": [], "signature": [ { "pluginId": "@elastic/apm-synthtrace", "scope": "server", "docId": "kibElasticApmSynthtracePluginApi", - "section": "def-server.SpanArrayIterable", - "text": "SpanArrayIterable" + "section": "def-server.EntityArrayIterable", + "text": "EntityArrayIterable" }, - " implements ", + " implements ", { "pluginId": "@elastic/apm-synthtrace", "scope": "server", "docId": "kibElasticApmSynthtracePluginApi", - "section": "def-server.SpanIterable", - "text": "SpanIterable" - } + "section": "def-server.EntityIterable", + "text": "EntityIterable" + }, + "" ], - "path": "packages/elastic-apm-synthtrace/src/lib/span_iterable.ts", + "path": "packages/elastic-apm-synthtrace/src/lib/entity_iterable.ts", "deprecated": false, "children": [ { "parentPluginId": "@elastic/apm-synthtrace", - "id": "def-server.SpanArrayIterable.Unnamed", + "id": "def-server.EntityArrayIterable.Unnamed", "type": "Function", "tags": [], "label": "Constructor", @@ -243,21 +354,20 @@ "signature": [ "any" ], - "path": "packages/elastic-apm-synthtrace/src/lib/span_iterable.ts", + "path": "packages/elastic-apm-synthtrace/src/lib/entity_iterable.ts", "deprecated": false, "children": [ { "parentPluginId": "@elastic/apm-synthtrace", - "id": "def-server.SpanArrayIterable.Unnamed.$1", + "id": "def-server.EntityArrayIterable.Unnamed.$1", "type": "Array", "tags": [], "label": "fields", "description": [], "signature": [ - "ApmFields", - "[]" + "TFields[]" ], - "path": "packages/elastic-apm-synthtrace/src/lib/span_iterable.ts", + "path": "packages/elastic-apm-synthtrace/src/lib/entity_iterable.ts", "deprecated": false, "isRequired": true } @@ -266,7 +376,7 @@ }, { "parentPluginId": "@elastic/apm-synthtrace", - "id": "def-server.SpanArrayIterable.order", + "id": "def-server.EntityArrayIterable.order", "type": "Function", "tags": [], "label": "order", @@ -274,51 +384,62 @@ "signature": [ "() => \"asc\" | \"desc\"" ], - "path": "packages/elastic-apm-synthtrace/src/lib/span_iterable.ts", + "path": "packages/elastic-apm-synthtrace/src/lib/entity_iterable.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "@elastic/apm-synthtrace", - "id": "def-server.SpanArrayIterable.Symbol.asyncIterator", + "id": "def-server.EntityArrayIterable.ratePerMinute", + "type": "Function", + "tags": [], + "label": "ratePerMinute", + "description": [], + "signature": [ + "() => number" + ], + "path": "packages/elastic-apm-synthtrace/src/lib/entity_iterable.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@elastic/apm-synthtrace", + "id": "def-server.EntityArrayIterable.Symbol.asyncIterator", "type": "Function", "tags": [], "label": "[Symbol.asyncIterator]", "description": [], "signature": [ - "() => AsyncIterator<", - "ApmFields", - ", any, undefined>" + "() => AsyncIterator" ], - "path": "packages/elastic-apm-synthtrace/src/lib/span_iterable.ts", + "path": "packages/elastic-apm-synthtrace/src/lib/entity_iterable.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "@elastic/apm-synthtrace", - "id": "def-server.SpanArrayIterable.Symbol.iterator", + "id": "def-server.EntityArrayIterable.Symbol.iterator", "type": "Function", "tags": [], "label": "[Symbol.iterator]", "description": [], "signature": [ - "() => Iterator<", - "ApmFields", - ", any, undefined>" + "() => Iterator" ], - "path": "packages/elastic-apm-synthtrace/src/lib/span_iterable.ts", + "path": "packages/elastic-apm-synthtrace/src/lib/entity_iterable.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "@elastic/apm-synthtrace", - "id": "def-server.SpanArrayIterable.concat", + "id": "def-server.EntityArrayIterable.merge", "type": "Function", "tags": [], - "label": "concat", + "label": "merge", "description": [], "signature": [ "(...iterables: ", @@ -326,18 +447,19 @@ "pluginId": "@elastic/apm-synthtrace", "scope": "server", "docId": "kibElasticApmSynthtracePluginApi", - "section": "def-server.SpanIterable", - "text": "SpanIterable" + "section": "def-server.EntityIterable", + "text": "EntityIterable" }, - "[]) => ", - "SpanGeneratorsUnion" + "[]) => ", + "EntityStreams", + "" ], - "path": "packages/elastic-apm-synthtrace/src/lib/span_iterable.ts", + "path": "packages/elastic-apm-synthtrace/src/lib/entity_iterable.ts", "deprecated": false, "children": [ { "parentPluginId": "@elastic/apm-synthtrace", - "id": "def-server.SpanArrayIterable.concat.$1", + "id": "def-server.EntityArrayIterable.merge.$1", "type": "Array", "tags": [], "label": "iterables", @@ -347,12 +469,12 @@ "pluginId": "@elastic/apm-synthtrace", "scope": "server", "docId": "kibElasticApmSynthtracePluginApi", - "section": "def-server.SpanIterable", - "text": "SpanIterable" + "section": "def-server.EntityIterable", + "text": "EntityIterable" }, - "[]" + "[]" ], - "path": "packages/elastic-apm-synthtrace/src/lib/span_iterable.ts", + "path": "packages/elastic-apm-synthtrace/src/lib/entity_iterable.ts", "deprecated": false, "isRequired": true } @@ -361,17 +483,15 @@ }, { "parentPluginId": "@elastic/apm-synthtrace", - "id": "def-server.SpanArrayIterable.toArray", + "id": "def-server.EntityArrayIterable.toArray", "type": "Function", "tags": [], "label": "toArray", "description": [], "signature": [ - "() => ", - "ApmFields", - "[]" + "() => TFields[]" ], - "path": "packages/elastic-apm-synthtrace/src/lib/span_iterable.ts", + "path": "packages/elastic-apm-synthtrace/src/lib/entity_iterable.ts", "deprecated": false, "children": [], "returnComment": [] @@ -569,57 +689,27 @@ }, { "parentPluginId": "@elastic/apm-synthtrace", - "id": "def-server.Fields", - "type": "Interface", - "tags": [], - "label": "Fields", - "description": [], - "path": "packages/elastic-apm-synthtrace/src/lib/entity.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@elastic/apm-synthtrace", - "id": "def-server.Fields.timestamp", - "type": "number", - "tags": [], - "label": "'@timestamp'", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "packages/elastic-apm-synthtrace/src/lib/entity.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "@elastic/apm-synthtrace", - "id": "def-server.SpanIterable", + "id": "def-server.EntityIterable", "type": "Interface", "tags": [], - "label": "SpanIterable", + "label": "EntityIterable", "description": [], "signature": [ { "pluginId": "@elastic/apm-synthtrace", "scope": "server", "docId": "kibElasticApmSynthtracePluginApi", - "section": "def-server.SpanIterable", - "text": "SpanIterable" + "section": "def-server.EntityIterable", + "text": "EntityIterable" }, - " extends Iterable<", - "ApmFields", - ">,AsyncIterable<", - "ApmFields", - ">" + " extends Iterable,AsyncIterable" ], - "path": "packages/elastic-apm-synthtrace/src/lib/span_iterable.ts", + "path": "packages/elastic-apm-synthtrace/src/lib/entity_iterable.ts", "deprecated": false, "children": [ { "parentPluginId": "@elastic/apm-synthtrace", - "id": "def-server.SpanIterable.order", + "id": "def-server.EntityIterable.order", "type": "Function", "tags": [], "label": "order", @@ -627,34 +717,55 @@ "signature": [ "() => \"asc\" | \"desc\"" ], - "path": "packages/elastic-apm-synthtrace/src/lib/span_iterable.ts", + "path": "packages/elastic-apm-synthtrace/src/lib/entity_iterable.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "@elastic/apm-synthtrace", - "id": "def-server.SpanIterable.toArray", + "id": "def-server.EntityIterable.ratePerMinute", + "type": "Function", + "tags": [], + "label": "ratePerMinute", + "description": [], + "signature": [ + "() => number" + ], + "path": "packages/elastic-apm-synthtrace/src/lib/entity_iterable.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@elastic/apm-synthtrace", + "id": "def-server.EntityIterable.toArray", "type": "Function", "tags": [], "label": "toArray", "description": [], "signature": [ "() => ", - "ApmFields", + { + "pluginId": "@elastic/apm-synthtrace", + "scope": "server", + "docId": "kibElasticApmSynthtracePluginApi", + "section": "def-server.ApmFields", + "text": "ApmFields" + }, "[]" ], - "path": "packages/elastic-apm-synthtrace/src/lib/span_iterable.ts", + "path": "packages/elastic-apm-synthtrace/src/lib/entity_iterable.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "@elastic/apm-synthtrace", - "id": "def-server.SpanIterable.concat", + "id": "def-server.EntityIterable.merge", "type": "Function", "tags": [], - "label": "concat", + "label": "merge", "description": [], "signature": [ "(...iterables: ", @@ -662,18 +773,19 @@ "pluginId": "@elastic/apm-synthtrace", "scope": "server", "docId": "kibElasticApmSynthtracePluginApi", - "section": "def-server.SpanIterable", - "text": "SpanIterable" + "section": "def-server.EntityIterable", + "text": "EntityIterable" }, - "[]) => ", - "SpanGeneratorsUnion" + "[]) => ", + "EntityStreams", + "" ], - "path": "packages/elastic-apm-synthtrace/src/lib/span_iterable.ts", + "path": "packages/elastic-apm-synthtrace/src/lib/entity_iterable.ts", "deprecated": false, "children": [ { "parentPluginId": "@elastic/apm-synthtrace", - "id": "def-server.SpanIterable.concat.$1", + "id": "def-server.EntityIterable.merge.$1", "type": "Array", "tags": [], "label": "iterables", @@ -683,12 +795,12 @@ "pluginId": "@elastic/apm-synthtrace", "scope": "server", "docId": "kibElasticApmSynthtracePluginApi", - "section": "def-server.SpanIterable", - "text": "SpanIterable" + "section": "def-server.EntityIterable", + "text": "EntityIterable" }, - "[]" + "[]" ], - "path": "packages/elastic-apm-synthtrace/src/lib/span_iterable.ts", + "path": "packages/elastic-apm-synthtrace/src/lib/entity_iterable.ts", "deprecated": false, "isRequired": true } @@ -697,6 +809,32 @@ } ], "initialIsOpen": false + }, + { + "parentPluginId": "@elastic/apm-synthtrace", + "id": "def-server.Fields", + "type": "Interface", + "tags": [], + "label": "Fields", + "description": [], + "path": "packages/elastic-apm-synthtrace/src/lib/entity.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@elastic/apm-synthtrace", + "id": "def-server.Fields.timestamp", + "type": "number", + "tags": [], + "label": "'@timestamp'", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "packages/elastic-apm-synthtrace/src/lib/entity.ts", + "deprecated": false + } + ], + "initialIsOpen": false } ], "enums": [ @@ -712,7 +850,39 @@ "initialIsOpen": false } ], - "misc": [], + "misc": [ + { + "parentPluginId": "@elastic/apm-synthtrace", + "id": "def-server.ApmFields", + "type": "Type", + "tags": [], + "label": "ApmFields", + "description": [], + "signature": [ + { + "pluginId": "@elastic/apm-synthtrace", + "scope": "server", + "docId": "kibElasticApmSynthtracePluginApi", + "section": "def-server.Fields", + "text": "Fields" + }, + " & Partial<{ 'timestamp.us'?: number | undefined; 'agent.name': string; 'agent.version': string; 'container.id': string; 'ecs.version': string; 'event.outcome': string; 'event.ingested': number; 'error.id': string; 'error.exception': ", + { + "pluginId": "@elastic/apm-synthtrace", + "scope": "server", + "docId": "kibElasticApmSynthtracePluginApi", + "section": "def-server.ApmException", + "text": "ApmException" + }, + "[]; 'error.grouping_name': string; 'error.grouping_key': string; 'host.name': string; 'kubernetes.pod.uid': 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; '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; '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; }>" + ], + "path": "packages/elastic-apm-synthtrace/src/lib/apm/apm_fields.ts", + "deprecated": false, + "initialIsOpen": false + } + ], "objects": [ { "parentPluginId": "@elastic/apm-synthtrace", @@ -830,7 +1000,13 @@ "description": [], "signature": [ "(events: ", - "ApmFields", + { + "pluginId": "@elastic/apm-synthtrace", + "scope": "server", + "docId": "kibElasticApmSynthtracePluginApi", + "section": "def-server.ApmFields", + "text": "ApmFields" + }, "[]) => { 'metricset.name': string; 'transaction.duration.histogram': { values: number[]; counts: number[]; }; _doc_count: number; '@timestamp'?: number | undefined; 'timestamp.us'?: number | undefined; 'agent.name'?: string | undefined; 'agent.version'?: string | undefined; 'container.id'?: string | undefined; 'ecs.version'?: string | undefined; 'event.outcome'?: string | undefined; 'event.ingested'?: number | undefined; 'error.id'?: string | undefined; 'error.exception'?: ", { "pluginId": "@elastic/apm-synthtrace", @@ -855,7 +1031,13 @@ "label": "events", "description": [], "signature": [ - "ApmFields", + { + "pluginId": "@elastic/apm-synthtrace", + "scope": "server", + "docId": "kibElasticApmSynthtracePluginApi", + "section": "def-server.ApmFields", + "text": "ApmFields" + }, "[]" ], "path": "packages/elastic-apm-synthtrace/src/lib/apm/processors/get_transaction_metrics.ts", @@ -872,7 +1054,13 @@ "description": [], "signature": [ "(events: ", - "ApmFields", + { + "pluginId": "@elastic/apm-synthtrace", + "scope": "server", + "docId": "kibElasticApmSynthtracePluginApi", + "section": "def-server.ApmFields", + "text": "ApmFields" + }, "[]) => { \"metricset.name\": string; 'span.destination.service.response_time.sum.us': number; 'span.destination.service.response_time.count': number; '@timestamp'?: number | undefined; 'timestamp.us'?: number | undefined; 'agent.name'?: string | undefined; 'agent.version'?: string | undefined; 'container.id'?: string | undefined; 'ecs.version'?: string | undefined; 'event.outcome'?: string | undefined; 'event.ingested'?: number | undefined; 'error.id'?: string | undefined; 'error.exception'?: ", { "pluginId": "@elastic/apm-synthtrace", @@ -897,7 +1085,13 @@ "label": "events", "description": [], "signature": [ - "ApmFields", + { + "pluginId": "@elastic/apm-synthtrace", + "scope": "server", + "docId": "kibElasticApmSynthtracePluginApi", + "section": "def-server.ApmFields", + "text": "ApmFields" + }, "[]" ], "path": "packages/elastic-apm-synthtrace/src/lib/apm/processors/get_span_destination_metrics.ts", @@ -929,9 +1123,21 @@ "description": [], "signature": [ "(events: ", - "ApmFields", + { + "pluginId": "@elastic/apm-synthtrace", + "scope": "server", + "docId": "kibElasticApmSynthtracePluginApi", + "section": "def-server.ApmFields", + "text": "ApmFields" + }, "[]) => ", - "ApmFields", + { + "pluginId": "@elastic/apm-synthtrace", + "scope": "server", + "docId": "kibElasticApmSynthtracePluginApi", + "section": "def-server.ApmFields", + "text": "ApmFields" + }, "[]" ], "path": "packages/elastic-apm-synthtrace/src/lib/apm/index.ts", @@ -946,7 +1152,13 @@ "label": "events", "description": [], "signature": [ - "ApmFields", + { + "pluginId": "@elastic/apm-synthtrace", + "scope": "server", + "docId": "kibElasticApmSynthtracePluginApi", + "section": "def-server.ApmFields", + "text": "ApmFields" + }, "[]" ], "path": "packages/elastic-apm-synthtrace/src/lib/apm/processors/get_breakdown_metrics.ts", @@ -962,9 +1174,9 @@ "label": "getApmWriteTargets", "description": [], "signature": [ - "({ client, forceDataStreams, }: { client: ", + "({ client, forceLegacyIndices, }: { client: ", "default", - "; forceDataStreams?: boolean | undefined; }) => Promise<", + "; forceLegacyIndices?: boolean | undefined; }) => Promise<", "ApmElasticsearchOutputWriteTargets", ">" ], @@ -982,7 +1194,7 @@ "signature": [ "{ client: ", "default", - "; forceDataStreams?: boolean | undefined; }" + "; forceLegacyIndices?: boolean | undefined; }" ], "path": "packages/elastic-apm-synthtrace/src/lib/apm/utils/get_apm_write_targets.ts", "deprecated": false diff --git a/api_docs/elastic_apm_synthtrace.mdx b/api_docs/elastic_apm_synthtrace.mdx index a1ce9ad2020bd..727d8b367a3a2 100644 --- a/api_docs/elastic_apm_synthtrace.mdx +++ b/api_docs/elastic_apm_synthtrace.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/elastic-apm-synthtrace title: "@elastic/apm-synthtrace" image: https://source.unsplash.com/400x175/?github summary: API docs for the @elastic/apm-synthtrace plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@elastic/apm-synthtrace'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 62 | 0 | 62 | 9 | +| 70 | 0 | 70 | 10 | ## Server @@ -37,3 +37,6 @@ Contact [Owner missing] for questions regarding this plugin. ### Enums +### Consts, variables and types + + diff --git a/api_docs/embeddable.devdocs.json b/api_docs/embeddable.devdocs.json index 4ff19a79a26b4..d8d5fd3006360 100644 --- a/api_docs/embeddable.devdocs.json +++ b/api_docs/embeddable.devdocs.json @@ -8749,7 +8749,7 @@ "section": "def-public.EmbeddableFactory", "text": "EmbeddableFactory" }, - ", \"type\" | \"create\" | \"isEditable\" | \"getDisplayName\"> & Partial, \"create\" | \"type\" | \"isEditable\" | \"getDisplayName\"> & Partial; readonly accessCheckTimeout: number; readonly accessCheckTimeoutWarning: number; }" + "{ readonly host?: string | undefined; readonly customHeaders?: Readonly<{} & {}> | undefined; readonly ssl: Readonly<{ certificateAuthorities?: string | string[] | undefined; } & { verificationMode: \"none\" | \"full\" | \"certificate\"; }>; readonly accessCheckTimeout: number; readonly accessCheckTimeoutWarning: number; }" ], "path": "x-pack/plugins/enterprise_search/server/index.ts", "deprecated": false, @@ -51,7 +51,9 @@ "Type", "; verificationMode: ", "Type", - "<\"none\" | \"full\" | \"certificate\">; }>; }>" + "<\"none\" | \"full\" | \"certificate\">; }>; customHeaders: ", + "Type", + " | undefined>; }>" ], "path": "x-pack/plugins/enterprise_search/server/index.ts", "deprecated": false, diff --git a/api_docs/enterprise_search.mdx b/api_docs/enterprise_search.mdx index 8ea1f6d5c47b3..4e4c43e2977c1 100644 --- a/api_docs/enterprise_search.mdx +++ b/api_docs/enterprise_search.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/enterpriseSearch title: "enterpriseSearch" image: https://source.unsplash.com/400x175/?github summary: API docs for the enterpriseSearch plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/es_ui_shared.mdx b/api_docs/es_ui_shared.mdx index 3f8b8a4e25633..937c0be2c8ba3 100644 --- a/api_docs/es_ui_shared.mdx +++ b/api_docs/es_ui_shared.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/esUiShared title: "esUiShared" image: https://source.unsplash.com/400x175/?github summary: API docs for the esUiShared plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/event_annotation.mdx b/api_docs/event_annotation.mdx index db8d13ecbffad..5e3d34fcae086 100644 --- a/api_docs/event_annotation.mdx +++ b/api_docs/event_annotation.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/eventAnnotation title: "eventAnnotation" image: https://source.unsplash.com/400x175/?github summary: API docs for the eventAnnotation plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/event_log.devdocs.json b/api_docs/event_log.devdocs.json index cf94115cf3b25..1a4840efc4729 100644 --- a/api_docs/event_log.devdocs.json +++ b/api_docs/event_log.devdocs.json @@ -1047,7 +1047,7 @@ "label": "data", "description": [], "signature": [ - "(Readonly<{ user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; error?: Readonly<{ message?: string | undefined; type?: string | undefined; id?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: number | undefined; number_of_scheduled_actions?: number | undefined; number_of_searches?: number | undefined; total_indexing_duration_ms?: number | undefined; es_search_duration_ms?: number | undefined; total_search_duration_ms?: number | undefined; execution_gap_duration_s?: number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | 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?: number | undefined; scheduled?: string | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: 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; category?: string[] | undefined; url?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: number | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: number | undefined; created?: string | 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?: number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}> | undefined)[]" + "(Readonly<{ error?: Readonly<{ message?: string | undefined; id?: string | undefined; type?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: number | undefined; number_of_generated_actions?: number | undefined; number_of_new_alerts?: number | undefined; number_of_active_alerts?: number | undefined; number_of_recovered_alerts?: number | undefined; total_number_of_alerts?: number | undefined; number_of_searches?: number | undefined; total_indexing_duration_ms?: number | undefined; es_search_duration_ms?: number | undefined; total_search_duration_ms?: number | undefined; execution_gap_duration_s?: number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; saved_objects?: Readonly<{ id?: string | undefined; type?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | 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?: number | undefined; scheduled?: string | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: 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; id?: string | undefined; type?: string[] | undefined; outcome?: string | undefined; category?: string[] | undefined; url?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: number | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: number | undefined; created?: string | 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?: number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}> | undefined)[]" ], "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", "deprecated": false @@ -1066,7 +1066,7 @@ "label": "IEvent", "description": [], "signature": [ - "DeepPartial | undefined; message?: string | undefined; error?: Readonly<{ message?: string | undefined; type?: string | undefined; id?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: number | undefined; number_of_scheduled_actions?: number | undefined; number_of_searches?: number | undefined; total_indexing_duration_ms?: number | undefined; es_search_duration_ms?: number | undefined; total_search_duration_ms?: number | undefined; execution_gap_duration_s?: number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | 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?: number | undefined; scheduled?: string | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: 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; category?: string[] | undefined; url?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: number | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: number | undefined; created?: string | 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?: number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}>>> | undefined" + "DeepPartial | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: number | undefined; number_of_generated_actions?: number | undefined; number_of_new_alerts?: number | undefined; number_of_active_alerts?: number | undefined; number_of_recovered_alerts?: number | undefined; total_number_of_alerts?: number | undefined; number_of_searches?: number | undefined; total_indexing_duration_ms?: number | undefined; es_search_duration_ms?: number | undefined; total_search_duration_ms?: number | undefined; execution_gap_duration_s?: number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; saved_objects?: Readonly<{ id?: string | undefined; type?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | 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?: number | undefined; scheduled?: string | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: 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; id?: string | undefined; type?: string[] | undefined; outcome?: string | undefined; category?: string[] | undefined; url?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: number | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: number | undefined; created?: string | 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?: number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}>>> | undefined" ], "path": "x-pack/plugins/event_log/generated/schemas.ts", "deprecated": false, @@ -1080,7 +1080,7 @@ "label": "IValidatedEvent", "description": [], "signature": [ - "Readonly<{ user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; error?: Readonly<{ message?: string | undefined; type?: string | undefined; id?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: number | undefined; number_of_scheduled_actions?: number | undefined; number_of_searches?: number | undefined; total_indexing_duration_ms?: number | undefined; es_search_duration_ms?: number | undefined; total_search_duration_ms?: number | undefined; execution_gap_duration_s?: number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | 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?: number | undefined; scheduled?: string | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: 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; category?: string[] | undefined; url?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: number | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: number | undefined; created?: string | 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?: number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}> | undefined" + "Readonly<{ error?: Readonly<{ message?: string | undefined; id?: string | undefined; type?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: number | undefined; number_of_generated_actions?: number | undefined; number_of_new_alerts?: number | undefined; number_of_active_alerts?: number | undefined; number_of_recovered_alerts?: number | undefined; total_number_of_alerts?: number | undefined; number_of_searches?: number | undefined; total_indexing_duration_ms?: number | undefined; es_search_duration_ms?: number | undefined; total_search_duration_ms?: number | undefined; execution_gap_duration_s?: number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; saved_objects?: Readonly<{ id?: string | undefined; type?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | 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?: number | undefined; scheduled?: string | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: 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; id?: string | undefined; type?: string[] | undefined; outcome?: string | undefined; category?: string[] | undefined; url?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: number | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: number | undefined; created?: string | 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?: 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 40049f0fbe11d..562f7fee9dbbb 100644 --- a/api_docs/event_log.mdx +++ b/api_docs/event_log.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/eventLog title: "eventLog" image: https://source.unsplash.com/400x175/?github summary: API docs for the eventLog plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_error.mdx b/api_docs/expression_error.mdx index 47da67003080d..22245b38031d1 100644 --- a/api_docs/expression_error.mdx +++ b/api_docs/expression_error.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionError title: "expressionError" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionError plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionError'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_gauge.devdocs.json b/api_docs/expression_gauge.devdocs.json index 63e409a1a6c3a..111082f04d28a 100644 --- a/api_docs/expression_gauge.devdocs.json +++ b/api_docs/expression_gauge.devdocs.json @@ -103,13 +103,7 @@ "text": "Accessors" }, " | undefined, paletteParams?: ", - { - "pluginId": "expressionGauge", - "scope": "common", - "docId": "kibExpressionGaugePluginApi", - "section": "def-common.CustomPaletteParams", - "text": "CustomPaletteParams" - }, + "CustomPaletteParams", " | undefined, isRespectRanges?: boolean | undefined) => number" ], "path": "src/plugins/chart_expressions/expression_gauge/public/components/utils/accessors.ts", @@ -165,13 +159,7 @@ "label": "paletteParams", "description": [], "signature": [ - { - "pluginId": "expressionGauge", - "scope": "common", - "docId": "kibExpressionGaugePluginApi", - "section": "def-common.CustomPaletteParams", - "text": "CustomPaletteParams" - }, + "CustomPaletteParams", " | undefined" ], "path": "src/plugins/chart_expressions/expression_gauge/public/components/utils/accessors.ts", @@ -221,13 +209,7 @@ "text": "Accessors" }, " | undefined, paletteParams?: ", - { - "pluginId": "expressionGauge", - "scope": "common", - "docId": "kibExpressionGaugePluginApi", - "section": "def-common.CustomPaletteParams", - "text": "CustomPaletteParams" - }, + "CustomPaletteParams", " | undefined, isRespectRanges?: boolean | undefined) => any" ], "path": "src/plugins/chart_expressions/expression_gauge/public/components/utils/accessors.ts", @@ -283,13 +265,7 @@ "label": "paletteParams", "description": [], "signature": [ - { - "pluginId": "expressionGauge", - "scope": "common", - "docId": "kibExpressionGaugePluginApi", - "section": "def-common.CustomPaletteParams", - "text": "CustomPaletteParams" - }, + "CustomPaletteParams", " | undefined" ], "path": "src/plugins/chart_expressions/expression_gauge/public/components/utils/accessors.ts", @@ -551,196 +527,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "expressionGauge", - "id": "def-common.ColorStop", - "type": "Interface", - "tags": [], - "label": "ColorStop", - "description": [], - "path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_renderers.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionGauge", - "id": "def-common.ColorStop.color", - "type": "string", - "tags": [], - "label": "color", - "description": [], - "path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_renderers.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionGauge", - "id": "def-common.ColorStop.stop", - "type": "number", - "tags": [], - "label": "stop", - "description": [], - "path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_renderers.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "expressionGauge", - "id": "def-common.CustomPaletteParams", - "type": "Interface", - "tags": [], - "label": "CustomPaletteParams", - "description": [], - "path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_renderers.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionGauge", - "id": "def-common.CustomPaletteParams.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_renderers.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionGauge", - "id": "def-common.CustomPaletteParams.reverse", - "type": "CompoundType", - "tags": [], - "label": "reverse", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_renderers.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionGauge", - "id": "def-common.CustomPaletteParams.rangeType", - "type": "CompoundType", - "tags": [], - "label": "rangeType", - "description": [], - "signature": [ - "\"number\" | \"percent\" | undefined" - ], - "path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_renderers.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionGauge", - "id": "def-common.CustomPaletteParams.continuity", - "type": "CompoundType", - "tags": [], - "label": "continuity", - "description": [], - "signature": [ - "\"above\" | \"below\" | \"none\" | \"all\" | undefined" - ], - "path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_renderers.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionGauge", - "id": "def-common.CustomPaletteParams.progression", - "type": "string", - "tags": [], - "label": "progression", - "description": [], - "signature": [ - "\"fixed\" | undefined" - ], - "path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_renderers.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionGauge", - "id": "def-common.CustomPaletteParams.rangeMin", - "type": "number", - "tags": [], - "label": "rangeMin", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_renderers.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionGauge", - "id": "def-common.CustomPaletteParams.rangeMax", - "type": "number", - "tags": [], - "label": "rangeMax", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_renderers.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionGauge", - "id": "def-common.CustomPaletteParams.stops", - "type": "Array", - "tags": [], - "label": "stops", - "description": [], - "signature": [ - { - "pluginId": "expressionGauge", - "scope": "common", - "docId": "kibExpressionGaugePluginApi", - "section": "def-common.ColorStop", - "text": "ColorStop" - }, - "[] | undefined" - ], - "path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_renderers.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionGauge", - "id": "def-common.CustomPaletteParams.colorStops", - "type": "Array", - "tags": [], - "label": "colorStops", - "description": [], - "signature": [ - { - "pluginId": "expressionGauge", - "scope": "common", - "docId": "kibExpressionGaugePluginApi", - "section": "def-common.ColorStop", - "text": "ColorStop" - }, - "[] | undefined" - ], - "path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_renderers.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionGauge", - "id": "def-common.CustomPaletteParams.steps", - "type": "number", - "tags": [], - "label": "steps", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_renderers.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "expressionGauge", "id": "def-common.GaugeExpressionProps", @@ -796,13 +582,7 @@ "; colorMode: ", "GaugeColorMode", "; palette?: ", - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteOutput", - "text": "PaletteOutput" - }, + "PaletteOutput", "<", { "pluginId": "charts", @@ -1014,21 +794,9 @@ "label": "palette", "description": [], "signature": [ - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteOutput", - "text": "PaletteOutput" - }, + "PaletteOutput", "<", - { - "pluginId": "expressionGauge", - "scope": "common", - "docId": "kibExpressionGaugePluginApi", - "section": "def-common.CustomPaletteParams", - "text": "CustomPaletteParams" - }, + "CustomPaletteParams", "> | undefined" ], "path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts", @@ -1208,13 +976,7 @@ "; colorMode: ", "GaugeColorMode", "; palette?: ", - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteOutput", - "text": "PaletteOutput" - }, + "PaletteOutput", "<", { "pluginId": "charts", @@ -1340,13 +1102,7 @@ "; chartsThemeService: ", "Theme", "; paletteService: ", - { - "pluginId": "charts", - "scope": "public", - "docId": "kibChartsPluginApi", - "section": "def-public.PaletteRegistry", - "text": "PaletteRegistry" - }, + "PaletteRegistry", "; uiState: ", { "pluginId": "visualizations", @@ -1416,36 +1172,6 @@ "path": "src/plugins/chart_expressions/expression_gauge/common/index.ts", "deprecated": false, "initialIsOpen": false - }, - { - "parentPluginId": "expressionGauge", - "id": "def-common.RequiredPaletteParamTypes", - "type": "Type", - "tags": [], - "label": "RequiredPaletteParamTypes", - "description": [], - "signature": [ - "{ name: string; reverse: boolean; rangeType: \"number\" | \"percent\"; continuity: \"above\" | \"below\" | \"none\" | \"all\"; progression: \"fixed\"; rangeMin: number; rangeMax: number; stops: ", - { - "pluginId": "expressionGauge", - "scope": "common", - "docId": "kibExpressionGaugePluginApi", - "section": "def-common.ColorStop", - "text": "ColorStop" - }, - "[]; colorStops: ", - { - "pluginId": "expressionGauge", - "scope": "common", - "docId": "kibExpressionGaugePluginApi", - "section": "def-common.ColorStop", - "text": "ColorStop" - }, - "[]; steps: number; }" - ], - "path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_renderers.ts", - "deprecated": false, - "initialIsOpen": false } ], "objects": [ diff --git a/api_docs/expression_gauge.mdx b/api_docs/expression_gauge.mdx index b99d793cc0063..f83a1b80f6f29 100644 --- a/api_docs/expression_gauge.mdx +++ b/api_docs/expression_gauge.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionGauge title: "expressionGauge" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionGauge plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionGauge'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 76 | 0 | 76 | 2 | +| 61 | 0 | 61 | 2 | ## Client diff --git a/api_docs/expression_heatmap.devdocs.json b/api_docs/expression_heatmap.devdocs.json index fa4e095495ed6..e686e8a1e7b76 100644 --- a/api_docs/expression_heatmap.devdocs.json +++ b/api_docs/expression_heatmap.devdocs.json @@ -121,196 +121,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "expressionHeatmap", - "id": "def-common.ColorStop", - "type": "Interface", - "tags": [], - "label": "ColorStop", - "description": [], - "path": "src/plugins/chart_expressions/expression_heatmap/common/types/expression_renderers.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionHeatmap", - "id": "def-common.ColorStop.color", - "type": "string", - "tags": [], - "label": "color", - "description": [], - "path": "src/plugins/chart_expressions/expression_heatmap/common/types/expression_renderers.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionHeatmap", - "id": "def-common.ColorStop.stop", - "type": "number", - "tags": [], - "label": "stop", - "description": [], - "path": "src/plugins/chart_expressions/expression_heatmap/common/types/expression_renderers.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "expressionHeatmap", - "id": "def-common.CustomPaletteParams", - "type": "Interface", - "tags": [], - "label": "CustomPaletteParams", - "description": [], - "path": "src/plugins/chart_expressions/expression_heatmap/common/types/expression_renderers.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionHeatmap", - "id": "def-common.CustomPaletteParams.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/chart_expressions/expression_heatmap/common/types/expression_renderers.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionHeatmap", - "id": "def-common.CustomPaletteParams.reverse", - "type": "CompoundType", - "tags": [], - "label": "reverse", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/chart_expressions/expression_heatmap/common/types/expression_renderers.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionHeatmap", - "id": "def-common.CustomPaletteParams.rangeType", - "type": "CompoundType", - "tags": [], - "label": "rangeType", - "description": [], - "signature": [ - "\"number\" | \"percent\" | undefined" - ], - "path": "src/plugins/chart_expressions/expression_heatmap/common/types/expression_renderers.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionHeatmap", - "id": "def-common.CustomPaletteParams.continuity", - "type": "CompoundType", - "tags": [], - "label": "continuity", - "description": [], - "signature": [ - "\"above\" | \"below\" | \"none\" | \"all\" | undefined" - ], - "path": "src/plugins/chart_expressions/expression_heatmap/common/types/expression_renderers.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionHeatmap", - "id": "def-common.CustomPaletteParams.progression", - "type": "string", - "tags": [], - "label": "progression", - "description": [], - "signature": [ - "\"fixed\" | undefined" - ], - "path": "src/plugins/chart_expressions/expression_heatmap/common/types/expression_renderers.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionHeatmap", - "id": "def-common.CustomPaletteParams.rangeMin", - "type": "number", - "tags": [], - "label": "rangeMin", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "src/plugins/chart_expressions/expression_heatmap/common/types/expression_renderers.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionHeatmap", - "id": "def-common.CustomPaletteParams.rangeMax", - "type": "number", - "tags": [], - "label": "rangeMax", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "src/plugins/chart_expressions/expression_heatmap/common/types/expression_renderers.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionHeatmap", - "id": "def-common.CustomPaletteParams.stops", - "type": "Array", - "tags": [], - "label": "stops", - "description": [], - "signature": [ - { - "pluginId": "expressionHeatmap", - "scope": "common", - "docId": "kibExpressionHeatmapPluginApi", - "section": "def-common.ColorStop", - "text": "ColorStop" - }, - "[] | undefined" - ], - "path": "src/plugins/chart_expressions/expression_heatmap/common/types/expression_renderers.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionHeatmap", - "id": "def-common.CustomPaletteParams.colorStops", - "type": "Array", - "tags": [], - "label": "colorStops", - "description": [], - "signature": [ - { - "pluginId": "expressionHeatmap", - "scope": "common", - "docId": "kibExpressionHeatmapPluginApi", - "section": "def-common.ColorStop", - "text": "ColorStop" - }, - "[] | undefined" - ], - "path": "src/plugins/chart_expressions/expression_heatmap/common/types/expression_renderers.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionHeatmap", - "id": "def-common.CustomPaletteParams.steps", - "type": "number", - "tags": [], - "label": "steps", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "src/plugins/chart_expressions/expression_heatmap/common/types/expression_renderers.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "expressionHeatmap", "id": "def-common.FilterEvent", @@ -428,13 +238,7 @@ "label": "palette", "description": [], "signature": [ - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteOutput", - "text": "PaletteOutput" - }, + "PaletteOutput", "<", { "pluginId": "charts", @@ -805,13 +609,7 @@ "text": "Datatable" }, "; column: number; range: number[]; timeFieldName?: string | undefined; }) => void; paletteService: ", - { - "pluginId": "charts", - "scope": "public", - "docId": "kibChartsPluginApi", - "section": "def-public.PaletteRegistry", - "text": "PaletteRegistry" - }, + "PaletteRegistry", "; uiState: ", { "pluginId": "visualizations", @@ -853,36 +651,6 @@ "path": "src/plugins/chart_expressions/expression_heatmap/common/index.ts", "deprecated": false, "initialIsOpen": false - }, - { - "parentPluginId": "expressionHeatmap", - "id": "def-common.RequiredPaletteParamTypes", - "type": "Type", - "tags": [], - "label": "RequiredPaletteParamTypes", - "description": [], - "signature": [ - "{ name: string; reverse: boolean; rangeType: \"number\" | \"percent\"; continuity: \"above\" | \"below\" | \"none\" | \"all\"; progression: \"fixed\"; rangeMin: number; rangeMax: number; stops: ", - { - "pluginId": "expressionHeatmap", - "scope": "common", - "docId": "kibExpressionHeatmapPluginApi", - "section": "def-common.ColorStop", - "text": "ColorStop" - }, - "[]; colorStops: ", - { - "pluginId": "expressionHeatmap", - "scope": "common", - "docId": "kibExpressionHeatmapPluginApi", - "section": "def-common.ColorStop", - "text": "ColorStop" - }, - "[]; steps: number; }" - ], - "path": "src/plugins/chart_expressions/expression_heatmap/common/types/expression_renderers.ts", - "deprecated": false, - "initialIsOpen": false } ], "objects": [ diff --git a/api_docs/expression_heatmap.mdx b/api_docs/expression_heatmap.mdx index aad7b2efe25d8..d828747b22637 100644 --- a/api_docs/expression_heatmap.mdx +++ b/api_docs/expression_heatmap.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionHeatmap title: "expressionHeatmap" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionHeatmap plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionHeatmap'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 119 | 0 | 115 | 3 | +| 104 | 0 | 100 | 3 | ## Client diff --git a/api_docs/expression_image.mdx b/api_docs/expression_image.mdx index feea2fe660d34..093aecd94cd99 100644 --- a/api_docs/expression_image.mdx +++ b/api_docs/expression_image.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionImage title: "expressionImage" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionImage plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionImage'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_metric.mdx b/api_docs/expression_metric.mdx index 8affa769b01a2..527d9a85c187c 100644 --- a/api_docs/expression_metric.mdx +++ b/api_docs/expression_metric.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionMetric title: "expressionMetric" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionMetric plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetric'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_metric_vis.devdocs.json b/api_docs/expression_metric_vis.devdocs.json index 43cb1a3470887..de4956164a459 100644 --- a/api_docs/expression_metric_vis.devdocs.json +++ b/api_docs/expression_metric_vis.devdocs.json @@ -150,13 +150,7 @@ "label": "palette", "description": [], "signature": [ - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteOutput", - "text": "PaletteOutput" - }, + "PaletteOutput", "<", { "pluginId": "charts", diff --git a/api_docs/expression_metric_vis.mdx b/api_docs/expression_metric_vis.mdx index a428ff8611edf..e4d8c09eb36cd 100644 --- a/api_docs/expression_metric_vis.mdx +++ b/api_docs/expression_metric_vis.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionMetricVis title: "expressionMetricVis" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionMetricVis plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetricVis'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_partition_vis.devdocs.json b/api_docs/expression_partition_vis.devdocs.json index 6511db71b8625..4953f5401fb20 100644 --- a/api_docs/expression_partition_vis.devdocs.json +++ b/api_docs/expression_partition_vis.devdocs.json @@ -609,13 +609,7 @@ "label": "palette", "description": [], "signature": [ - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteOutput", - "text": "PaletteOutput" - }, + "PaletteOutput", "<{ [key: string]: unknown; }>" ], "path": "src/plugins/chart_expressions/expression_partition_vis/common/types/expression_renderers.ts", diff --git a/api_docs/expression_partition_vis.mdx b/api_docs/expression_partition_vis.mdx index 2ed4287363bf1..97c89c561e56c 100644 --- a/api_docs/expression_partition_vis.mdx +++ b/api_docs/expression_partition_vis.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionPartitionVis title: "expressionPartitionVis" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionPartitionVis plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionPartitionVis'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_repeat_image.mdx b/api_docs/expression_repeat_image.mdx index 30b19d8b19abb..5b0af3d5efbc8 100644 --- a/api_docs/expression_repeat_image.mdx +++ b/api_docs/expression_repeat_image.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionRepeatImage title: "expressionRepeatImage" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionRepeatImage plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRepeatImage'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_reveal_image.mdx b/api_docs/expression_reveal_image.mdx index 8e270f3640f04..c7eca19a624cb 100644 --- a/api_docs/expression_reveal_image.mdx +++ b/api_docs/expression_reveal_image.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionRevealImage title: "expressionRevealImage" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionRevealImage plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRevealImage'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_shape.mdx b/api_docs/expression_shape.mdx index 54a9aa6e92925..f3ee5306578c3 100644 --- a/api_docs/expression_shape.mdx +++ b/api_docs/expression_shape.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionShape title: "expressionShape" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionShape plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionShape'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_tagcloud.mdx b/api_docs/expression_tagcloud.mdx index e3f34e10096c9..8331a345d07cc 100644 --- a/api_docs/expression_tagcloud.mdx +++ b/api_docs/expression_tagcloud.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionTagcloud title: "expressionTagcloud" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionTagcloud plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionTagcloud'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_x_y.devdocs.json b/api_docs/expression_x_y.devdocs.json index c8e2d0f579833..7064fd2035207 100644 --- a/api_docs/expression_x_y.devdocs.json +++ b/api_docs/expression_x_y.devdocs.json @@ -452,13 +452,7 @@ "label": "palette", "description": [], "signature": [ - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteOutput", - "text": "PaletteOutput" - }, + "PaletteOutput", "<{ [key: string]: unknown; }>" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", @@ -3086,7 +3080,7 @@ "label": "types", "description": [], "signature": [ - "(\"palette\" | \"system_palette\")[]" + "(\"system_palette\" | \"palette\")[]" ], "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", "deprecated": false @@ -3156,13 +3150,7 @@ "text": "XScaleType" }, "; isHistogram: boolean; palette: ", - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteOutput", - "text": "PaletteOutput" - }, + "PaletteOutput", "<{ [key: string]: unknown; }>; yConfig?: ", { "pluginId": "expressionXY", diff --git a/api_docs/expression_x_y.mdx b/api_docs/expression_x_y.mdx index 1bb894548102d..90fa5545dffd1 100644 --- a/api_docs/expression_x_y.mdx +++ b/api_docs/expression_x_y.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionXY title: "expressionXY" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionXY plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionXY'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expressions.devdocs.json b/api_docs/expressions.devdocs.json index 5da80bd20a369..193a9d90ba337 100644 --- a/api_docs/expressions.devdocs.json +++ b/api_docs/expressions.devdocs.json @@ -6361,7 +6361,13 @@ "description": [], "signature": [ "(nodeRef: React.RefObject, {\n debounce,\n expression,\n hasCustomErrorRenderer,\n onData$,\n onEvent,\n onRender$,\n reload$,\n ...loaderParams\n }: ", - "ExpressionRendererParams", + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ExpressionRendererParams", + "text": "ExpressionRendererParams" + }, ") => ExpressionRendererState" ], "path": "src/plugins/expressions/public/react_expression_renderer/use_expression_renderer.ts", @@ -6389,7 +6395,13 @@ "label": "{\n debounce,\n expression,\n hasCustomErrorRenderer,\n onData$,\n onEvent,\n onRender$,\n reload$,\n ...loaderParams\n }", "description": [], "signature": [ - "ExpressionRendererParams" + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ExpressionRendererParams", + "text": "ExpressionRendererParams" + } ], "path": "src/plugins/expressions/public/react_expression_renderer/use_expression_renderer.ts", "deprecated": false, @@ -7877,35 +7889,35 @@ "references": [ { "plugin": "canvas", - "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/external/embeddable.ts" + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/demodata/index.ts" }, { "plugin": "canvas", - "path": "x-pack/plugins/canvas/common/functions/filters.ts" + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/external/embeddable.ts" }, { "plugin": "canvas", - "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/escount.ts" + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/esdocs.ts" }, { "plugin": "canvas", - "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/esdocs.ts" + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/essql.ts" }, { "plugin": "canvas", - "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/essql.ts" + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/pointseries/index.ts" }, { "plugin": "canvas", - "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/common/neq.ts" + "path": "x-pack/plugins/canvas/common/functions/filters.ts" }, { "plugin": "canvas", - "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/pointseries/index.ts" + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/escount.ts" }, { "plugin": "canvas", - "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/demodata/index.ts" + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/common/neq.ts" }, { "plugin": "visTypeXy", @@ -8612,6 +8624,230 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionRendererParams", + "type": "Interface", + "tags": [], + "label": "ExpressionRendererParams", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ExpressionRendererParams", + "text": "ExpressionRendererParams" + }, + " extends ", + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.IExpressionLoaderParams", + "text": "IExpressionLoaderParams" + } + ], + "path": "src/plugins/expressions/public/react_expression_renderer/use_expression_renderer.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionRendererParams.debounce", + "type": "number", + "tags": [], + "label": "debounce", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "src/plugins/expressions/public/react_expression_renderer/use_expression_renderer.ts", + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionRendererParams.expression", + "type": "CompoundType", + "tags": [], + "label": "expression", + "description": [], + "signature": [ + "string | ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" + } + ], + "path": "src/plugins/expressions/public/react_expression_renderer/use_expression_renderer.ts", + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionRendererParams.hasCustomErrorRenderer", + "type": "CompoundType", + "tags": [], + "label": "hasCustomErrorRenderer", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/expressions/public/react_expression_renderer/use_expression_renderer.ts", + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionRendererParams.onData$", + "type": "Function", + "tags": [], + "label": "onData$", + "description": [], + "signature": [ + "((data: TData, adapters?: TInspectorAdapters | undefined, partial?: boolean | undefined) => void) | undefined" + ], + "path": "src/plugins/expressions/public/react_expression_renderer/use_expression_renderer.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionRendererParams.onData$.$1", + "type": "Uncategorized", + "tags": [], + "label": "data", + "description": [], + "signature": [ + "TData" + ], + "path": "src/plugins/expressions/public/react_expression_renderer/use_expression_renderer.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionRendererParams.onData$.$2", + "type": "Uncategorized", + "tags": [], + "label": "adapters", + "description": [], + "signature": [ + "TInspectorAdapters | undefined" + ], + "path": "src/plugins/expressions/public/react_expression_renderer/use_expression_renderer.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionRendererParams.onData$.$3", + "type": "CompoundType", + "tags": [], + "label": "partial", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/expressions/public/react_expression_renderer/use_expression_renderer.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionRendererParams.onEvent", + "type": "Function", + "tags": [], + "label": "onEvent", + "description": [], + "signature": [ + "((event: ", + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ExpressionRendererEvent", + "text": "ExpressionRendererEvent" + }, + ") => void) | undefined" + ], + "path": "src/plugins/expressions/public/react_expression_renderer/use_expression_renderer.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionRendererParams.onEvent.$1", + "type": "Object", + "tags": [], + "label": "event", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ExpressionRendererEvent", + "text": "ExpressionRendererEvent" + } + ], + "path": "src/plugins/expressions/public/react_expression_renderer/use_expression_renderer.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionRendererParams.onRender$", + "type": "Function", + "tags": [], + "label": "onRender$", + "description": [], + "signature": [ + "((item: number) => void) | undefined" + ], + "path": "src/plugins/expressions/public/react_expression_renderer/use_expression_renderer.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionRendererParams.onRender$.$1", + "type": "number", + "tags": [], + "label": "item", + "description": [], + "signature": [ + "number" + ], + "path": "src/plugins/expressions/public/react_expression_renderer/use_expression_renderer.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionRendererParams.reload$", + "type": "Object", + "tags": [], + "label": "reload$", + "description": [ + "\nAn observable which can be used to re-run the expression without destroying the component" + ], + "signature": [ + "Observable", + " | undefined" + ], + "path": "src/plugins/expressions/public/react_expression_renderer/use_expression_renderer.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "expressions", "id": "def-public.ExpressionRenderError", @@ -10366,7 +10602,13 @@ "text": "ReactExpressionRendererProps" }, " extends Omit<", - "ExpressionRendererParams", + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ExpressionRendererParams", + "text": "ExpressionRendererParams" + }, ", \"hasCustomErrorRenderer\">" ], "path": "src/plugins/expressions/public/react_expression_renderer/react_expression_renderer.tsx", @@ -11266,7 +11508,7 @@ "\nAllowed column names in a PointSeries" ], "signature": [ - "\"color\" | \"y\" | \"x\" | \"size\" | \"text\"" + "\"color\" | \"size\" | \"text\" | \"y\" | \"x\"" ], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, @@ -17996,35 +18238,35 @@ "references": [ { "plugin": "canvas", - "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/external/embeddable.ts" + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/demodata/index.ts" }, { "plugin": "canvas", - "path": "x-pack/plugins/canvas/common/functions/filters.ts" + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/external/embeddable.ts" }, { "plugin": "canvas", - "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/escount.ts" + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/esdocs.ts" }, { "plugin": "canvas", - "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/esdocs.ts" + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/essql.ts" }, { "plugin": "canvas", - "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/essql.ts" + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/pointseries/index.ts" }, { "plugin": "canvas", - "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/common/neq.ts" + "path": "x-pack/plugins/canvas/common/functions/filters.ts" }, { "plugin": "canvas", - "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/pointseries/index.ts" + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/escount.ts" }, { "plugin": "canvas", - "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/demodata/index.ts" + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/common/neq.ts" }, { "plugin": "visTypeXy", @@ -20218,7 +20460,7 @@ "\nAllowed column names in a PointSeries" ], "signature": [ - "\"color\" | \"y\" | \"x\" | \"size\" | \"text\"" + "\"color\" | \"size\" | \"text\" | \"y\" | \"x\"" ], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, @@ -29735,35 +29977,35 @@ "references": [ { "plugin": "canvas", - "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/external/embeddable.ts" + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/demodata/index.ts" }, { "plugin": "canvas", - "path": "x-pack/plugins/canvas/common/functions/filters.ts" + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/external/embeddable.ts" }, { "plugin": "canvas", - "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/escount.ts" + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/esdocs.ts" }, { "plugin": "canvas", - "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/esdocs.ts" + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/essql.ts" }, { "plugin": "canvas", - "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/essql.ts" + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/pointseries/index.ts" }, { "plugin": "canvas", - "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/common/neq.ts" + "path": "x-pack/plugins/canvas/common/functions/filters.ts" }, { "plugin": "canvas", - "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/pointseries/index.ts" + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/escount.ts" }, { "plugin": "canvas", - "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/demodata/index.ts" + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/common/neq.ts" }, { "plugin": "visTypeXy", @@ -34299,7 +34541,7 @@ "\nAllowed column names in a PointSeries" ], "signature": [ - "\"color\" | \"y\" | \"x\" | \"size\" | \"text\"" + "\"color\" | \"size\" | \"text\" | \"y\" | \"x\"" ], "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "deprecated": false, @@ -38006,7 +38248,15 @@ "section": "def-common.DatatableRow", "text": "DatatableRow" }, - "[]; type: \"datatable\"; meta?: ", + "[] | (", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.DatatableRow", + "text": "DatatableRow" + }, + " | { [x: string]: any; })[]; type: \"datatable\"; meta?: ", "DatatableMeta", " | undefined; }>" ], diff --git a/api_docs/expressions.mdx b/api_docs/expressions.mdx index 8470b4f8a9643..48f344a1fc219 100644 --- a/api_docs/expressions.mdx +++ b/api_docs/expressions.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressions title: "expressions" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressions plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2145 | 17 | 1701 | 6 | +| 2158 | 17 | 1713 | 5 | ## Client diff --git a/api_docs/features.mdx b/api_docs/features.mdx index 19443c000875b..27dc3a6e8652a 100644 --- a/api_docs/features.mdx +++ b/api_docs/features.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/features title: "features" image: https://source.unsplash.com/400x175/?github summary: API docs for the features plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/field_formats.devdocs.json b/api_docs/field_formats.devdocs.json index 3128c6077b0c5..fbe312ee376af 100644 --- a/api_docs/field_formats.devdocs.json +++ b/api_docs/field_formats.devdocs.json @@ -4807,7 +4807,7 @@ "label": "FieldFormatsContentType", "description": [], "signature": [ - "\"html\" | \"text\"" + "\"text\" | \"html\"" ], "path": "src/plugins/field_formats/common/types.ts", "deprecated": false, @@ -5083,7 +5083,7 @@ "label": "HTML_CONTEXT_TYPE", "description": [], "signature": [ - "\"html\" | \"text\"" + "\"text\" | \"html\"" ], "path": "src/plugins/field_formats/common/content_types/html_content_type.ts", "deprecated": false, @@ -5361,7 +5361,7 @@ "label": "TEXT_CONTEXT_TYPE", "description": [], "signature": [ - "\"html\" | \"text\"" + "\"text\" | \"html\"" ], "path": "src/plugins/field_formats/common/content_types/text_content_type.ts", "deprecated": false, diff --git a/api_docs/field_formats.mdx b/api_docs/field_formats.mdx index 41c16cfcde6a2..c425ca2c5924c 100644 --- a/api_docs/field_formats.mdx +++ b/api_docs/field_formats.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/fieldFormats title: "fieldFormats" image: https://source.unsplash.com/400x175/?github summary: API docs for the fieldFormats plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/file_upload.mdx b/api_docs/file_upload.mdx index 5361e280670e0..670175e6463d6 100644 --- a/api_docs/file_upload.mdx +++ b/api_docs/file_upload.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/fileUpload title: "fileUpload" image: https://source.unsplash.com/400x175/?github summary: API docs for the fileUpload plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/fleet.devdocs.json b/api_docs/fleet.devdocs.json index 71cb3650bbbce..530b55d549f63 100644 --- a/api_docs/fleet.devdocs.json +++ b/api_docs/fleet.devdocs.json @@ -6882,7 +6882,7 @@ "label": "runExternalCallbacks", "description": [], "signature": [ - "(externalCallbackType: A, packagePolicy: A extends \"postPackagePolicyDelete\" ? ", + "(externalCallbackType: A, packagePolicy: A extends \"postPackagePolicyDelete\" ? ", { "pluginId": "fleet", "scope": "common", @@ -6890,6 +6890,14 @@ "section": "def-common.DeletePackagePoliciesResponse", "text": "DeletePackagePoliciesResponse" }, + " : A extends \"packagePolicyPostCreate\" ? ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicy", + "text": "PackagePolicy" + }, " : ", { "pluginId": "fleet", @@ -6914,7 +6922,15 @@ "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, - ") => Promise) => Promise) => Promise<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicy", + "text": "PackagePolicy" + }, + ">" + ], + "path": "x-pack/plugins/fleet/server/types/extensions.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "fleet", + "id": "def-server.PostPackagePolicyPostCreateCallback.$1", + "type": "Object", + "tags": [], + "label": "packagePolicy", + "description": [], + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicy", + "text": "PackagePolicy" + } + ], + "path": "x-pack/plugins/fleet/server/types/extensions.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-server.PostPackagePolicyPostCreateCallback.$2", + "type": "Object", + "tags": [], + "label": "context", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.RequestHandlerContext", + "text": "RequestHandlerContext" + } + ], + "path": "x-pack/plugins/fleet/server/types/extensions.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-server.PostPackagePolicyPostCreateCallback.$3", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "x-pack/plugins/fleet/server/types/extensions.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "fleet", "id": "def-server.PutPackagePolicyUpdateCallback", @@ -11410,7 +11543,7 @@ "\nLst checkin status" ], "signature": [ - "\"online\" | \"error\" | \"updating\" | \"degraded\" | undefined" + "\"error\" | \"online\" | \"updating\" | \"degraded\" | undefined" ], "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "deprecated": false @@ -12800,7 +12933,20 @@ "label": "missing_requirements", "description": [], "signature": [ - "(\"fleet_server\" | \"security_required\" | \"tls_required\" | \"api_keys\" | \"fleet_admin_user\" | \"encrypted_saved_object_encryption_key_required\")[]" + "(\"fleet_server\" | \"security_required\" | \"tls_required\" | \"api_keys\" | \"fleet_admin_user\")[]" + ], + "path": "x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.GetFleetStatusResponse.missing_optional_features", + "type": "Array", + "tags": [], + "label": "missing_optional_features", + "description": [], + "signature": [ + "\"encrypted_saved_object_encryption_key_required\"[]" ], "path": "x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts", "deprecated": false @@ -13411,7 +13557,7 @@ "label": "query", "description": [], "signature": [ - "{ category?: string | undefined; experimental?: boolean | undefined; }" + "{ category?: string | undefined; experimental?: boolean | undefined; excludeInstallStatus?: boolean | undefined; }" ], "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", "deprecated": false @@ -18630,7 +18776,7 @@ "label": "AgentStatus", "description": [], "signature": [ - "\"offline\" | \"online\" | \"error\" | \"warning\" | \"inactive\" | \"enrolling\" | \"unenrolling\" | \"updating\" | \"degraded\"" + "\"error\" | \"offline\" | \"online\" | \"warning\" | \"inactive\" | \"enrolling\" | \"unenrolling\" | \"updating\" | \"degraded\"" ], "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "deprecated": false, @@ -19661,6 +19807,14 @@ "label": "Installable", "description": [], "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.InstallStatusExcluded", + "text": "InstallStatusExcluded" + }, + " | ", { "pluginId": "fleet", "scope": "common", @@ -19838,6 +19992,20 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "fleet", + "id": "def-common.InstallStatusExcluded", + "type": "Type", + "tags": [], + "label": "InstallStatusExcluded", + "description": [], + "signature": [ + "T & { status: undefined; }" + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "fleet", "id": "def-common.InstallType", @@ -20194,7 +20362,7 @@ "section": "def-common.NewOutput", "text": "NewOutput" }, - " & { output_id?: string | undefined; }" + " & { output_id?: string | undefined; ssl?: string | undefined; }" ], "path": "x-pack/plugins/fleet/common/types/models/output.ts", "deprecated": false, @@ -20749,7 +20917,7 @@ "label": "RegistrySearchResult", "description": [], "signature": [ - "{ download: string; type?: \"integration\" | undefined; title: string; description: string; icons?: (", + "{ download: string; title: string; type?: \"integration\" | undefined; description: string; icons?: (", { "pluginId": "fleet", "scope": "common", diff --git a/api_docs/fleet.mdx b/api_docs/fleet.mdx index 35b1cf07adef1..221ed6ae0e6e0 100644 --- a/api_docs/fleet.mdx +++ b/api_docs/fleet.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/fleet title: "fleet" image: https://source.unsplash.com/400x175/?github summary: API docs for the fleet plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Fleet](https://github.com/orgs/elastic/teams/fleet) for questions regar | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 1379 | 8 | 1262 | 9 | +| 1385 | 8 | 1268 | 10 | ## Client diff --git a/api_docs/global_search.mdx b/api_docs/global_search.mdx index 9f756367f808c..31f9aa31263a9 100644 --- a/api_docs/global_search.mdx +++ b/api_docs/global_search.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/globalSearch title: "globalSearch" image: https://source.unsplash.com/400x175/?github summary: API docs for the globalSearch plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/home.devdocs.json b/api_docs/home.devdocs.json index 56a7ef14f9710..516a1e6965511 100644 --- a/api_docs/home.devdocs.json +++ b/api_docs/home.devdocs.json @@ -368,20 +368,14 @@ { "parentPluginId": "home", "id": "def-public.FeatureCatalogueEntry.category", - "type": "Enum", + "type": "CompoundType", "tags": [], "label": "category", "description": [ "{@link FeatureCatalogueCategory} to display this feature in." ], "signature": [ - { - "pluginId": "home", - "scope": "public", - "docId": "kibHomePluginApi", - "section": "def-public.FeatureCatalogueCategory", - "text": "FeatureCatalogueCategory" - } + "\"data\" | \"other\" | \"admin\"" ], "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", "deprecated": false @@ -682,19 +676,7 @@ "initialIsOpen": false } ], - "enums": [ - { - "parentPluginId": "home", - "id": "def-public.FeatureCatalogueCategory", - "type": "Enum", - "tags": [], - "label": "FeatureCatalogueCategory", - "description": [], - "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", - "deprecated": false, - "initialIsOpen": false - } - ], + "enums": [], "misc": [ { "parentPluginId": "home", @@ -718,6 +700,20 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "home", + "id": "def-public.FeatureCatalogueCategory", + "type": "Type", + "tags": [], + "label": "FeatureCatalogueCategory", + "description": [], + "signature": [ + "\"data\" | \"other\" | \"admin\"" + ], + "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "home", "id": "def-public.FeatureCatalogueSetup", @@ -1577,7 +1573,7 @@ "label": "InstructionSetSchema", "description": [], "signature": [ - "{ readonly title?: string | undefined; readonly callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; readonly statusCheck?: Readonly<{ title?: string | undefined; error?: string | undefined; text?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record; index: string | string[]; }>; }> | undefined; readonly 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 title?: string | undefined; readonly callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; readonly 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; readonly 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, @@ -1591,7 +1587,7 @@ "label": "InstructionsSchema", "description": [], "signature": [ - "{ readonly params?: Readonly<{ defaultValue?: any; } & { label: string; type: \"string\" | \"number\"; id: string; }>[] | undefined; readonly instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; error?: string | undefined; text?: string | undefined; success?: 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 params?: Readonly<{ defaultValue?: any; } & { label: string; id: string; type: \"string\" | \"number\"; }>[] | undefined; readonly 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, @@ -1607,7 +1603,7 @@ "signature": [ "{ getSampleDatasets: () => ", "Writable", - "[]; defaultIndex: string; previewImagePath: string; overviewDashboard: string; dataIndices: Readonly<{} & { id: string; fields: Record; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ", + "[]; defaultIndex: string; previewImagePath: string; overviewDashboard: 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: ", { @@ -1641,7 +1637,7 @@ "signature": [ "() => ", "Writable", - "[]; defaultIndex: string; previewImagePath: string; overviewDashboard: string; dataIndices: Readonly<{} & { id: string; fields: Record; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>" + "[]; defaultIndex: string; previewImagePath: string; overviewDashboard: 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, @@ -1695,7 +1691,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; } & { label: string; type: \"string\" | \"number\"; id: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; error?: string | undefined; text?: string | undefined; success?: 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; } & { label: string; type: \"string\" | \"number\"; id: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; error?: string | undefined; text?: string | undefined; success?: 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<{} & { label: string; path: 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; } & { label: string; type: \"string\" | \"number\"; id: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; error?: string | undefined; text?: string | undefined; success?: 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; } & { label: string; id: string; type: \"string\" | \"number\"; }>[] | 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; } & { label: string; id: string; type: \"string\" | \"number\"; }>[] | 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<{} & { label: string; path: 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; } & { label: string; id: string; type: \"string\" | \"number\"; }>[] | 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, @@ -1731,7 +1727,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; } & { label: string; type: \"string\" | \"number\"; id: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; error?: string | undefined; text?: string | undefined; success?: 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; } & { label: string; type: \"string\" | \"number\"; id: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; error?: string | undefined; text?: string | undefined; success?: 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<{} & { label: string; path: 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; } & { label: string; type: \"string\" | \"number\"; id: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ title?: string | undefined; error?: string | undefined; text?: string | undefined; success?: 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; } & { label: string; id: string; type: \"string\" | \"number\"; }>[] | 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; } & { label: string; id: string; type: \"string\" | \"number\"; }>[] | 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<{} & { label: string; path: 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; } & { label: string; id: string; type: \"string\" | \"number\"; }>[] | 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, @@ -1990,7 +1986,7 @@ "signature": [ "{ getSampleDatasets: () => ", "Writable", - "[]; defaultIndex: string; previewImagePath: string; overviewDashboard: string; dataIndices: Readonly<{} & { id: string; fields: Record; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ", + "[]; defaultIndex: string; previewImagePath: string; overviewDashboard: 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 ba9950de8c4df..2f65dcfe6a656 100644 --- a/api_docs/home.mdx +++ b/api_docs/home.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/home title: "home" image: https://source.unsplash.com/400x175/?github summary: API docs for the home plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'home'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -40,9 +40,6 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que ### Interfaces -### Enums - - ### Consts, variables and types diff --git a/api_docs/index_lifecycle_management.mdx b/api_docs/index_lifecycle_management.mdx index 4b3d1ee7c566a..3b508d1e26456 100644 --- a/api_docs/index_lifecycle_management.mdx +++ b/api_docs/index_lifecycle_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/indexLifecycleManagement title: "indexLifecycleManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the indexLifecycleManagement plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexLifecycleManagement'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/index_management.mdx b/api_docs/index_management.mdx index 9350e37eebf19..521963fb92b77 100644 --- a/api_docs/index_management.mdx +++ b/api_docs/index_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/indexManagement title: "indexManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the indexManagement plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/infra.mdx b/api_docs/infra.mdx index 1ad1b38648945..599b5bd6cfcab 100644 --- a/api_docs/infra.mdx +++ b/api_docs/infra.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/infra title: "infra" image: https://source.unsplash.com/400x175/?github summary: API docs for the infra plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'infra'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/inspector.mdx b/api_docs/inspector.mdx index 5ebe20d7baa93..fff575d6b0e7c 100644 --- a/api_docs/inspector.mdx +++ b/api_docs/inspector.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/inspector title: "inspector" image: https://source.unsplash.com/400x175/?github summary: API docs for the inspector plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inspector'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/interactive_setup.mdx b/api_docs/interactive_setup.mdx index 2e1ad77a61fb9..869fe720402e9 100644 --- a/api_docs/interactive_setup.mdx +++ b/api_docs/interactive_setup.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/interactiveSetup title: "interactiveSetup" image: https://source.unsplash.com/400x175/?github summary: API docs for the interactiveSetup plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'interactiveSetup'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_ace.mdx b/api_docs/kbn_ace.mdx index 28ed37ce7ba84..b937c8289d677 100644 --- a/api_docs/kbn_ace.mdx +++ b/api_docs/kbn_ace.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ace title: "@kbn/ace" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ace plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ace'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_alerts.mdx b/api_docs/kbn_alerts.mdx index feba71871e675..09fb9c17c487d 100644 --- a/api_docs/kbn_alerts.mdx +++ b/api_docs/kbn_alerts.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-alerts title: "@kbn/alerts" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/alerts plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_analytics.mdx b/api_docs/kbn_analytics.mdx index 523542b3a852d..045b97520eb11 100644 --- a/api_docs/kbn_analytics.mdx +++ b/api_docs/kbn_analytics.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics title: "@kbn/analytics" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/analytics plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/elastic_analytics.devdocs.json b/api_docs/kbn_analytics_client.devdocs.json similarity index 68% rename from api_docs/elastic_analytics.devdocs.json rename to api_docs/kbn_analytics_client.devdocs.json index 0d1df6975ed2f..b2111b6f6fbfd 100644 --- a/api_docs/elastic_analytics.devdocs.json +++ b/api_docs/kbn_analytics_client.devdocs.json @@ -1,5 +1,5 @@ { - "id": "@elastic/analytics", + "id": "@kbn/analytics-client", "client": { "classes": [], "functions": [], @@ -12,7 +12,7 @@ "classes": [], "functions": [ { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.createAnalytics", "type": "Function", "tags": [], @@ -23,26 +23,26 @@ "signature": [ "(initContext: ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.AnalyticsClientInitContext", "text": "AnalyticsClientInitContext" }, ") => ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.IAnalyticsClient", "text": "IAnalyticsClient" } ], - "path": "packages/elastic-analytics/src/index.ts", + "path": "packages/analytics/client/src/index.ts", "deprecated": false, "children": [ { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.createAnalytics.$1", "type": "Object", "tags": [], @@ -52,14 +52,14 @@ ], "signature": [ { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.AnalyticsClientInitContext", "text": "AnalyticsClientInitContext" } ], - "path": "packages/elastic-analytics/src/index.ts", + "path": "packages/analytics/client/src/index.ts", "deprecated": false, "isRequired": true } @@ -70,7 +70,7 @@ ], "interfaces": [ { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.AnalyticsClientInitContext", "type": "Interface", "tags": [], @@ -78,11 +78,11 @@ "description": [ "\nGeneral settings of the analytics client" ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false, "children": [ { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.AnalyticsClientInitContext.isDev", "type": "boolean", "tags": [], @@ -90,11 +90,11 @@ "description": [ "\nBoolean indicating if it's running in developer mode." ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.AnalyticsClientInitContext.sendTo", "type": "CompoundType", "tags": [], @@ -105,11 +105,11 @@ "signature": [ "\"staging\" | \"production\"" ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.AnalyticsClientInitContext.logger", "type": "Object", "tags": [], @@ -120,14 +120,14 @@ "signature": [ "Logger" ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false } ], "initialIsOpen": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.ContextProviderOpts", "type": "Interface", "tags": [], @@ -137,19 +137,19 @@ ], "signature": [ { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.ContextProviderOpts", "text": "ContextProviderOpts" }, "" ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false, "children": [ { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.ContextProviderOpts.name", "type": "string", "tags": [], @@ -157,11 +157,11 @@ "description": [ "\nThe name of the provider." ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.ContextProviderOpts.context$", "type": "Object", "tags": [], @@ -173,11 +173,11 @@ "Observable", "" ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.ContextProviderOpts.schema", "type": "Object", "tags": [], @@ -188,22 +188,22 @@ "signature": [ "{ [Key in keyof Required]: ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.SchemaValue", "text": "SchemaValue" }, "; }" ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false } ], "initialIsOpen": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.Event", "type": "Interface", "tags": [], @@ -211,11 +211,11 @@ "description": [ "\nDefinition of the full event structure" ], - "path": "packages/elastic-analytics/src/events/types.ts", + "path": "packages/analytics/client/src/events/types.ts", "deprecated": false, "children": [ { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.Event.timestamp", "type": "string", "tags": [], @@ -223,11 +223,11 @@ "description": [ "\nThe time the event was generated in ISO format." ], - "path": "packages/elastic-analytics/src/events/types.ts", + "path": "packages/analytics/client/src/events/types.ts", "deprecated": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.Event.event_type", "type": "string", "tags": [], @@ -235,11 +235,11 @@ "description": [ "\nThe event type." ], - "path": "packages/elastic-analytics/src/events/types.ts", + "path": "packages/analytics/client/src/events/types.ts", "deprecated": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.Event.properties", "type": "Object", "tags": [], @@ -250,11 +250,11 @@ "signature": [ "{ [x: string]: unknown; }" ], - "path": "packages/elastic-analytics/src/events/types.ts", + "path": "packages/analytics/client/src/events/types.ts", "deprecated": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.Event.context", "type": "Object", "tags": [], @@ -264,31 +264,123 @@ ], "signature": [ { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.EventContext", "text": "EventContext" } ], - "path": "packages/elastic-analytics/src/events/types.ts", + "path": "packages/analytics/client/src/events/types.ts", "deprecated": false } ], "initialIsOpen": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.EventContext", "type": "Interface", "tags": [], "label": "EventContext", - "description": [], - "path": "packages/elastic-analytics/src/events/types.ts", + "description": [ + "\nDefinition of the context that can be appended to the events through the {@link IAnalyticsClient.registerContextProvider}." + ], + "path": "packages/analytics/client/src/events/types.ts", "deprecated": false, "children": [ { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", + "id": "def-server.EventContext.userId", + "type": "string", + "tags": [], + "label": "userId", + "description": [ + "\nThe unique user ID." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/analytics/client/src/events/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/analytics-client", + "id": "def-server.EventContext.cloudId", + "type": "string", + "tags": [], + "label": "cloudId", + "description": [ + "\nThe Cloud ID." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/analytics/client/src/events/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/analytics-client", + "id": "def-server.EventContext.version", + "type": "string", + "tags": [], + "label": "version", + "description": [ + "\nThe product's version." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/analytics/client/src/events/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/analytics-client", + "id": "def-server.EventContext.pageName", + "type": "string", + "tags": [], + "label": "pageName", + "description": [ + "\nThe name of the current page." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/analytics/client/src/events/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/analytics-client", + "id": "def-server.EventContext.applicationId", + "type": "string", + "tags": [], + "label": "applicationId", + "description": [ + "\nThe current application ID." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/analytics/client/src/events/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/analytics-client", + "id": "def-server.EventContext.entityId", + "type": "string", + "tags": [], + "label": "entityId", + "description": [ + "\nThe current entity ID (dashboard ID, visualization ID, etc.)." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/analytics/client/src/events/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/analytics-client", "id": "def-server.EventContext.Unnamed", "type": "IndexSignature", "tags": [], @@ -297,14 +389,14 @@ "signature": [ "[key: string]: unknown" ], - "path": "packages/elastic-analytics/src/events/types.ts", + "path": "packages/analytics/client/src/events/types.ts", "deprecated": false } ], "initialIsOpen": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.EventTypeOpts", "type": "Interface", "tags": [], @@ -314,19 +406,19 @@ ], "signature": [ { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.EventTypeOpts", "text": "EventTypeOpts" }, "" ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false, "children": [ { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.EventTypeOpts.eventType", "type": "string", "tags": [], @@ -334,11 +426,11 @@ "description": [ "\nThe event type's unique name." ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.EventTypeOpts.schema", "type": "Object", "tags": [], @@ -349,22 +441,22 @@ "signature": [ "{ [Key in keyof Required]: ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.SchemaValue", "text": "SchemaValue" }, "; }" ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false } ], "initialIsOpen": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.IAnalyticsClient", "type": "Interface", "tags": [], @@ -372,11 +464,11 @@ "description": [ "\nAnalytics client's public APIs" ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false, "children": [ { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.IAnalyticsClient.reportEvent", "type": "Function", "tags": [], @@ -387,11 +479,11 @@ "signature": [ ">(eventType: string, eventData: EventTypeData) => void" ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false, "children": [ { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.IAnalyticsClient.reportEvent.$1", "type": "string", "tags": [], @@ -402,12 +494,12 @@ "signature": [ "string" ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false, "isRequired": true }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.IAnalyticsClient.reportEvent.$2", "type": "Uncategorized", "tags": [], @@ -418,7 +510,7 @@ "signature": [ "EventTypeData" ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false, "isRequired": true } @@ -426,7 +518,7 @@ "returnComment": [] }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.IAnalyticsClient.registerEventType", "type": "Function", "tags": [], @@ -437,19 +529,19 @@ "signature": [ "(eventTypeOps: ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.EventTypeOpts", "text": "EventTypeOpts" }, ") => void" ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false, "children": [ { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.IAnalyticsClient.registerEventType.$1", "type": "Object", "tags": [], @@ -457,15 +549,15 @@ "description": [], "signature": [ { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.EventTypeOpts", "text": "EventTypeOpts" }, "" ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false, "isRequired": true } @@ -473,7 +565,7 @@ "returnComment": [] }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.IAnalyticsClient.registerShipper", "type": "Function", "tags": [], @@ -484,35 +576,35 @@ "signature": [ "(Shipper: ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.ShipperClassConstructor", "text": "ShipperClassConstructor" }, ", shipperConfig: ShipperConfig, opts?: ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.RegisterShipperOpts", "text": "RegisterShipperOpts" }, " | undefined) => void" ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false, "children": [ { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.IAnalyticsClient.registerShipper.$1", "type": "Object", "tags": [], @@ -522,20 +614,20 @@ ], "signature": [ { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.ShipperClassConstructor", "text": "ShipperClassConstructor" }, "" ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false, "isRequired": true }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.IAnalyticsClient.registerShipper.$2", "type": "Uncategorized", "tags": [], @@ -546,12 +638,12 @@ "signature": [ "ShipperConfig" ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false, "isRequired": true }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.IAnalyticsClient.registerShipper.$3", "type": "Object", "tags": [], @@ -561,15 +653,15 @@ ], "signature": [ { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.RegisterShipperOpts", "text": "RegisterShipperOpts" }, " | undefined" ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false, "isRequired": false } @@ -577,7 +669,7 @@ "returnComment": [] }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.IAnalyticsClient.optIn", "type": "Function", "tags": [], @@ -588,19 +680,19 @@ "signature": [ "(optInConfig: ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.OptInConfig", "text": "OptInConfig" }, ") => void" ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false, "children": [ { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.IAnalyticsClient.optIn.$1", "type": "Object", "tags": [], @@ -610,14 +702,14 @@ ], "signature": [ { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.OptInConfig", "text": "OptInConfig" } ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false, "isRequired": true } @@ -625,7 +717,7 @@ "returnComment": [] }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.IAnalyticsClient.registerContextProvider", "type": "Function", "tags": [], @@ -636,19 +728,19 @@ "signature": [ "(contextProviderOpts: ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.ContextProviderOpts", "text": "ContextProviderOpts" }, ") => void" ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false, "children": [ { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.IAnalyticsClient.registerContextProvider.$1", "type": "Object", "tags": [], @@ -658,15 +750,15 @@ ], "signature": [ { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.ContextProviderOpts", "text": "ContextProviderOpts" }, "" ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false, "isRequired": true } @@ -674,7 +766,7 @@ "returnComment": [] }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.IAnalyticsClient.removeContextProvider", "type": "Function", "tags": [], @@ -685,11 +777,11 @@ "signature": [ "(contextProviderName: string) => void" ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false, "children": [ { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.IAnalyticsClient.removeContextProvider.$1", "type": "string", "tags": [], @@ -700,7 +792,7 @@ "signature": [ "string" ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false, "isRequired": true } @@ -708,7 +800,7 @@ "returnComment": [] }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.IAnalyticsClient.telemetryCounter$", "type": "Object", "tags": [], @@ -720,22 +812,22 @@ "Observable", "<", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.TelemetryCounter", "text": "TelemetryCounter" }, ">" ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false } ], "initialIsOpen": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.IShipper", "type": "Interface", "tags": [], @@ -743,11 +835,11 @@ "description": [ "\nBasic structure of a Shipper" ], - "path": "packages/elastic-analytics/src/shippers/types.ts", + "path": "packages/analytics/client/src/shippers/types.ts", "deprecated": false, "children": [ { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.IShipper.reportEvents", "type": "Function", "tags": [], @@ -758,19 +850,19 @@ "signature": [ "(events: ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.Event", "text": "Event" }, "[]) => void" ], - "path": "packages/elastic-analytics/src/shippers/types.ts", + "path": "packages/analytics/client/src/shippers/types.ts", "deprecated": false, "children": [ { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.IShipper.reportEvents.$1", "type": "Array", "tags": [], @@ -780,15 +872,15 @@ ], "signature": [ { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.Event", "text": "Event" }, "[]" ], - "path": "packages/elastic-analytics/src/shippers/types.ts", + "path": "packages/analytics/client/src/shippers/types.ts", "deprecated": false, "isRequired": true } @@ -796,7 +888,7 @@ "returnComment": [] }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.IShipper.optIn", "type": "Function", "tags": [], @@ -807,11 +899,11 @@ "signature": [ "(isOptedIn: boolean) => void" ], - "path": "packages/elastic-analytics/src/shippers/types.ts", + "path": "packages/analytics/client/src/shippers/types.ts", "deprecated": false, "children": [ { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.IShipper.optIn.$1", "type": "boolean", "tags": [], @@ -822,7 +914,7 @@ "signature": [ "boolean" ], - "path": "packages/elastic-analytics/src/shippers/types.ts", + "path": "packages/analytics/client/src/shippers/types.ts", "deprecated": false, "isRequired": true } @@ -830,7 +922,7 @@ "returnComment": [] }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.IShipper.extendContext", "type": "Function", "tags": [], @@ -841,19 +933,19 @@ "signature": [ "((newContext: ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.EventContext", "text": "EventContext" }, ") => void) | undefined" ], - "path": "packages/elastic-analytics/src/shippers/types.ts", + "path": "packages/analytics/client/src/shippers/types.ts", "deprecated": false, "children": [ { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.IShipper.extendContext.$1", "type": "Object", "tags": [], @@ -861,14 +953,14 @@ "description": [], "signature": [ { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.EventContext", "text": "EventContext" } ], - "path": "packages/elastic-analytics/src/shippers/types.ts", + "path": "packages/analytics/client/src/shippers/types.ts", "deprecated": false, "isRequired": true } @@ -876,7 +968,7 @@ "returnComment": [] }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.IShipper.telemetryCounter$", "type": "Object", "tags": [], @@ -888,22 +980,22 @@ "Observable", "<", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.TelemetryCounter", "text": "TelemetryCounter" }, "> | undefined" ], - "path": "packages/elastic-analytics/src/shippers/types.ts", + "path": "packages/analytics/client/src/shippers/types.ts", "deprecated": false } ], "initialIsOpen": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.OptInConfig", "type": "Interface", "tags": [], @@ -911,11 +1003,11 @@ "description": [ "\n" ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false, "children": [ { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.OptInConfig.global", "type": "Object", "tags": [], @@ -925,18 +1017,18 @@ ], "signature": [ { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.OptInConfigPerType", "text": "OptInConfigPerType" } ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.OptInConfig.event_types", "type": "Object", "tags": [], @@ -947,22 +1039,22 @@ "signature": [ "Record | undefined" ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false } ], "initialIsOpen": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.OptInConfigPerType", "type": "Interface", "tags": [], @@ -970,11 +1062,11 @@ "description": [ "\nSets whether a type of event is enabled/disabled globally or per shipper." ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false, "children": [ { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.OptInConfigPerType.enabled", "type": "boolean", "tags": [], @@ -982,11 +1074,11 @@ "description": [ "\nThe event type is globally enabled." ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.OptInConfigPerType.shippers", "type": "Object", "tags": [], @@ -997,14 +1089,14 @@ "signature": [ "Record | undefined" ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false } ], "initialIsOpen": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.RegisterShipperOpts", "type": "Interface", "tags": [], @@ -1012,13 +1104,13 @@ "description": [ "\nOptional options to register a shipper" ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false, "children": [], "initialIsOpen": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.SchemaArray", "type": "Interface", "tags": [], @@ -1028,27 +1120,27 @@ ], "signature": [ { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.SchemaArray", "text": "SchemaArray" }, " extends ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.SchemaMeta", "text": "SchemaMeta" }, "" ], - "path": "packages/elastic-analytics/src/schema/types.ts", + "path": "packages/analytics/client/src/schema/types.ts", "deprecated": false, "children": [ { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.SchemaArray.type", "type": "string", "tags": [], @@ -1057,11 +1149,11 @@ "signature": [ "\"array\"" ], - "path": "packages/elastic-analytics/src/schema/types.ts", + "path": "packages/analytics/client/src/schema/types.ts", "deprecated": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.SchemaArray.items", "type": "CompoundType", "tags": [], @@ -1070,70 +1162,70 @@ "signature": [ "{ type: \"pass_through\"; _meta: { description: string; } & ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.SchemaMetaOptional", "text": "SchemaMetaOptional" }, "; } | (unknown extends Value ? ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.SchemaArray", "text": "SchemaArray" }, " | ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.SchemaObject", "text": "SchemaObject" }, " | ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.SchemaChildValue", "text": "SchemaChildValue" }, " : NonNullable extends (infer U)[] ? ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.SchemaArray", "text": "SchemaArray" }, " : NonNullable extends object ? ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.SchemaObject", "text": "SchemaObject" }, " : ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.SchemaChildValue", "text": "SchemaChildValue" }, ")" ], - "path": "packages/elastic-analytics/src/schema/types.ts", + "path": "packages/analytics/client/src/schema/types.ts", "deprecated": false } ], "initialIsOpen": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.SchemaChildValue", "type": "Interface", "tags": [], @@ -1141,19 +1233,19 @@ "description": [], "signature": [ { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.SchemaChildValue", "text": "SchemaChildValue" }, "" ], - "path": "packages/elastic-analytics/src/schema/types.ts", + "path": "packages/analytics/client/src/schema/types.ts", "deprecated": false, "children": [ { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.SchemaChildValue.type", "type": "Uncategorized", "tags": [], @@ -1162,34 +1254,34 @@ "signature": [ "NonNullable extends string ? ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.AllowedSchemaStringTypes", "text": "AllowedSchemaStringTypes" }, " : NonNullable extends number ? ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.AllowedSchemaNumberTypes", "text": "AllowedSchemaNumberTypes" }, " : NonNullable extends boolean ? \"boolean\" : ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.AllowedSchemaTypes", "text": "AllowedSchemaTypes" } ], - "path": "packages/elastic-analytics/src/schema/types.ts", + "path": "packages/analytics/client/src/schema/types.ts", "deprecated": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.SchemaChildValue._meta", "type": "CompoundType", "tags": [], @@ -1198,22 +1290,22 @@ "signature": [ "{ description: string; } & ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.SchemaMetaOptional", "text": "SchemaMetaOptional" }, "" ], - "path": "packages/elastic-analytics/src/schema/types.ts", + "path": "packages/analytics/client/src/schema/types.ts", "deprecated": false } ], "initialIsOpen": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.SchemaMeta", "type": "Interface", "tags": [], @@ -1223,19 +1315,19 @@ ], "signature": [ { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.SchemaMeta", "text": "SchemaMeta" }, "" ], - "path": "packages/elastic-analytics/src/schema/types.ts", + "path": "packages/analytics/client/src/schema/types.ts", "deprecated": false, "children": [ { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.SchemaMeta._meta", "type": "CompoundType", "tags": [], @@ -1244,22 +1336,22 @@ "signature": [ "({ description?: string | undefined; } & ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.SchemaMetaOptional", "text": "SchemaMetaOptional" }, ") | undefined" ], - "path": "packages/elastic-analytics/src/schema/types.ts", + "path": "packages/analytics/client/src/schema/types.ts", "deprecated": false } ], "initialIsOpen": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.SchemaObject", "type": "Interface", "tags": [], @@ -1269,27 +1361,27 @@ ], "signature": [ { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.SchemaObject", "text": "SchemaObject" }, " extends ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.SchemaMeta", "text": "SchemaMeta" }, "" ], - "path": "packages/elastic-analytics/src/schema/types.ts", + "path": "packages/analytics/client/src/schema/types.ts", "deprecated": false, "children": [ { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.SchemaObject.properties", "type": "Object", "tags": [], @@ -1298,22 +1390,22 @@ "signature": [ "{ [Key in keyof Required]: ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.SchemaValue", "text": "SchemaValue" }, "; }" ], - "path": "packages/elastic-analytics/src/schema/types.ts", + "path": "packages/analytics/client/src/schema/types.ts", "deprecated": false } ], "initialIsOpen": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.ShipperClassConstructor", "type": "Interface", "tags": [], @@ -1323,19 +1415,19 @@ ], "signature": [ { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.ShipperClassConstructor", "text": "ShipperClassConstructor" }, "" ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false, "children": [ { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.ShipperClassConstructor.shipperName", "type": "string", "tags": [], @@ -1343,11 +1435,11 @@ "description": [ "\nThe shipper's unique name" ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.ShipperClassConstructor.Unnamed", "type": "Any", "tags": [], @@ -1358,14 +1450,14 @@ "signature": [ "any" ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false } ], "initialIsOpen": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.TelemetryCounter", "type": "Interface", "tags": [], @@ -1373,11 +1465,11 @@ "description": [ "\nShape of the events emitted by the telemetryCounter$ observable" ], - "path": "packages/elastic-analytics/src/events/types.ts", + "path": "packages/analytics/client/src/events/types.ts", "deprecated": false, "children": [ { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.TelemetryCounter.type", "type": "Enum", "tags": [], @@ -1387,18 +1479,18 @@ ], "signature": [ { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.TelemetryCounterType", "text": "TelemetryCounterType" } ], - "path": "packages/elastic-analytics/src/events/types.ts", + "path": "packages/analytics/client/src/events/types.ts", "deprecated": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.TelemetryCounter.source", "type": "string", "tags": [], @@ -1406,11 +1498,11 @@ "description": [ "\nWho emitted the event? It can be \"client\" or the name of the shipper." ], - "path": "packages/elastic-analytics/src/events/types.ts", + "path": "packages/analytics/client/src/events/types.ts", "deprecated": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.TelemetryCounter.event_type", "type": "string", "tags": [], @@ -1418,11 +1510,11 @@ "description": [ "\nThe event type the success/failure/drop event refers to." ], - "path": "packages/elastic-analytics/src/events/types.ts", + "path": "packages/analytics/client/src/events/types.ts", "deprecated": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.TelemetryCounter.code", "type": "string", "tags": [], @@ -1430,11 +1522,11 @@ "description": [ "\nCode to provide additional information about the success or failure. Examples are 200/400/504/ValidationError/UnknownError" ], - "path": "packages/elastic-analytics/src/events/types.ts", + "path": "packages/analytics/client/src/events/types.ts", "deprecated": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.TelemetryCounter.count", "type": "number", "tags": [], @@ -1442,7 +1534,7 @@ "description": [ "\nThe number of events that this counter refers to." ], - "path": "packages/elastic-analytics/src/events/types.ts", + "path": "packages/analytics/client/src/events/types.ts", "deprecated": false } ], @@ -1451,7 +1543,7 @@ ], "enums": [ { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.TelemetryCounterType", "type": "Enum", "tags": [], @@ -1459,14 +1551,14 @@ "description": [ "\nTypes of the Telemetry Counter: It allows to differentiate what happened to the events" ], - "path": "packages/elastic-analytics/src/events/types.ts", + "path": "packages/analytics/client/src/events/types.ts", "deprecated": false, "initialIsOpen": false } ], "misc": [ { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.AllowedSchemaBooleanTypes", "type": "Type", "tags": [], @@ -1477,12 +1569,12 @@ "signature": [ "\"boolean\"" ], - "path": "packages/elastic-analytics/src/schema/types.ts", + "path": "packages/analytics/client/src/schema/types.ts", "deprecated": false, "initialIsOpen": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.AllowedSchemaNumberTypes", "type": "Type", "tags": [], @@ -1493,12 +1585,12 @@ "signature": [ "\"date\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"double\"" ], - "path": "packages/elastic-analytics/src/schema/types.ts", + "path": "packages/analytics/client/src/schema/types.ts", "deprecated": false, "initialIsOpen": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.AllowedSchemaStringTypes", "type": "Type", "tags": [], @@ -1507,14 +1599,14 @@ "Types matching string values" ], "signature": [ - "\"keyword\" | \"date\" | \"text\"" + "\"keyword\" | \"text\" | \"date\"" ], - "path": "packages/elastic-analytics/src/schema/types.ts", + "path": "packages/analytics/client/src/schema/types.ts", "deprecated": false, "initialIsOpen": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.AllowedSchemaTypes", "type": "Type", "tags": [], @@ -1523,14 +1615,14 @@ "\nPossible type values in the schema" ], "signature": [ - "\"boolean\" | \"keyword\" | \"date\" | \"text\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"double\"" + "\"boolean\" | \"keyword\" | \"text\" | \"date\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"double\"" ], - "path": "packages/elastic-analytics/src/schema/types.ts", + "path": "packages/analytics/client/src/schema/types.ts", "deprecated": false, "initialIsOpen": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.EventType", "type": "Type", "tags": [], @@ -1541,12 +1633,12 @@ "signature": [ "string" ], - "path": "packages/elastic-analytics/src/events/types.ts", + "path": "packages/analytics/client/src/events/types.ts", "deprecated": false, "initialIsOpen": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.PossibleSchemaTypes", "type": "Type", "tags": [], @@ -1557,35 +1649,35 @@ "signature": [ "Value extends string ? ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.AllowedSchemaStringTypes", "text": "AllowedSchemaStringTypes" }, " : Value extends number ? ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.AllowedSchemaNumberTypes", "text": "AllowedSchemaNumberTypes" }, " : Value extends boolean ? \"boolean\" : ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.AllowedSchemaTypes", "text": "AllowedSchemaTypes" } ], - "path": "packages/elastic-analytics/src/schema/types.ts", + "path": "packages/analytics/client/src/schema/types.ts", "deprecated": false, "initialIsOpen": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.RootSchema", "type": "Type", "tags": [], @@ -1596,20 +1688,20 @@ "signature": [ "{ [Key in keyof Required]: ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.SchemaValue", "text": "SchemaValue" }, "; }" ], - "path": "packages/elastic-analytics/src/schema/types.ts", + "path": "packages/analytics/client/src/schema/types.ts", "deprecated": false, "initialIsOpen": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.SchemaMetaOptional", "type": "Type", "tags": [], @@ -1620,12 +1712,12 @@ "signature": [ "unknown extends Value ? { optional?: boolean | undefined; } : undefined extends Value ? { optional: true; } : { optional?: false | undefined; }" ], - "path": "packages/elastic-analytics/src/schema/types.ts", + "path": "packages/analytics/client/src/schema/types.ts", "deprecated": false, "initialIsOpen": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.SchemaValue", "type": "Type", "tags": [], @@ -1636,68 +1728,68 @@ "signature": [ "{ type: \"pass_through\"; _meta: { description: string; } & ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.SchemaMetaOptional", "text": "SchemaMetaOptional" }, "; } | (unknown extends Value ? ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.SchemaArray", "text": "SchemaArray" }, " | ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.SchemaObject", "text": "SchemaObject" }, " | ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.SchemaChildValue", "text": "SchemaChildValue" }, " : NonNullable extends (infer U)[] ? ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.SchemaArray", "text": "SchemaArray" }, " : NonNullable extends object ? ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.SchemaObject", "text": "SchemaObject" }, " : ", { - "pluginId": "@elastic/analytics", + "pluginId": "@kbn/analytics-client", "scope": "server", - "docId": "kibElasticAnalyticsPluginApi", + "docId": "kibKbnAnalyticsClientPluginApi", "section": "def-server.SchemaChildValue", "text": "SchemaChildValue" }, ")" ], - "path": "packages/elastic-analytics/src/schema/types.ts", + "path": "packages/analytics/client/src/schema/types.ts", "deprecated": false, "initialIsOpen": false }, { - "parentPluginId": "@elastic/analytics", + "parentPluginId": "@kbn/analytics-client", "id": "def-server.ShipperName", "type": "Type", "tags": [], @@ -1708,7 +1800,7 @@ "signature": [ "string" ], - "path": "packages/elastic-analytics/src/analytics_client/types.ts", + "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false, "initialIsOpen": false } diff --git a/api_docs/kbn_analytics_client.mdx b/api_docs/kbn_analytics_client.mdx new file mode 100644 index 0000000000000..e51ae9a874e9f --- /dev/null +++ b/api_docs/kbn_analytics_client.mdx @@ -0,0 +1,36 @@ +--- +id: kibKbnAnalyticsClientPluginApi +slug: /kibana-dev-docs/api/kbn-analytics-client +title: "@kbn/analytics-client" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/analytics-client plugin +date: 2022-04-26 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-client'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnAnalyticsClientObj from './kbn_analytics_client.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 88 | 1 | 10 | 0 | + +## Server + +### Functions + + +### Interfaces + + +### Enums + + +### Consts, variables and types + + diff --git a/api_docs/kbn_analytics_shippers_fullstory.devdocs.json b/api_docs/kbn_analytics_shippers_fullstory.devdocs.json new file mode 100644 index 0000000000000..3f79e43e3a09c --- /dev/null +++ b/api_docs/kbn_analytics_shippers_fullstory.devdocs.json @@ -0,0 +1,314 @@ +{ + "id": "@kbn/analytics-shippers-fullstory", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [ + { + "parentPluginId": "@kbn/analytics-shippers-fullstory", + "id": "def-server.FullStoryShipper", + "type": "Class", + "tags": [], + "label": "FullStoryShipper", + "description": [], + "signature": [ + { + "pluginId": "@kbn/analytics-shippers-fullstory", + "scope": "server", + "docId": "kibKbnAnalyticsShippersFullstoryPluginApi", + "section": "def-server.FullStoryShipper", + "text": "FullStoryShipper" + }, + " implements ", + "IShipper" + ], + "path": "packages/analytics/shippers/fullstory/src/fullstory_shipper.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/analytics-shippers-fullstory", + "id": "def-server.FullStoryShipper.shipperName", + "type": "string", + "tags": [], + "label": "shipperName", + "description": [], + "path": "packages/analytics/shippers/fullstory/src/fullstory_shipper.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/analytics-shippers-fullstory", + "id": "def-server.FullStoryShipper.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "packages/analytics/shippers/fullstory/src/fullstory_shipper.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/analytics-shippers-fullstory", + "id": "def-server.FullStoryShipper.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "config", + "description": [], + "signature": [ + { + "pluginId": "@kbn/analytics-shippers-fullstory", + "scope": "server", + "docId": "kibKbnAnalyticsShippersFullstoryPluginApi", + "section": "def-server.FullStorySnippetConfig", + "text": "FullStorySnippetConfig" + } + ], + "path": "packages/analytics/shippers/fullstory/src/fullstory_shipper.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/analytics-shippers-fullstory", + "id": "def-server.FullStoryShipper.Unnamed.$2", + "type": "Object", + "tags": [], + "label": "initContext", + "description": [], + "signature": [ + "AnalyticsClientInitContext" + ], + "path": "packages/analytics/shippers/fullstory/src/fullstory_shipper.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/analytics-shippers-fullstory", + "id": "def-server.FullStoryShipper.extendContext", + "type": "Function", + "tags": [], + "label": "extendContext", + "description": [], + "signature": [ + "(newContext: ", + "EventContext", + ") => void" + ], + "path": "packages/analytics/shippers/fullstory/src/fullstory_shipper.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/analytics-shippers-fullstory", + "id": "def-server.FullStoryShipper.extendContext.$1", + "type": "Object", + "tags": [], + "label": "newContext", + "description": [], + "signature": [ + "EventContext" + ], + "path": "packages/analytics/shippers/fullstory/src/fullstory_shipper.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/analytics-shippers-fullstory", + "id": "def-server.FullStoryShipper.optIn", + "type": "Function", + "tags": [], + "label": "optIn", + "description": [], + "signature": [ + "(isOptedIn: boolean) => void" + ], + "path": "packages/analytics/shippers/fullstory/src/fullstory_shipper.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/analytics-shippers-fullstory", + "id": "def-server.FullStoryShipper.optIn.$1", + "type": "boolean", + "tags": [], + "label": "isOptedIn", + "description": [], + "signature": [ + "boolean" + ], + "path": "packages/analytics/shippers/fullstory/src/fullstory_shipper.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/analytics-shippers-fullstory", + "id": "def-server.FullStoryShipper.reportEvents", + "type": "Function", + "tags": [], + "label": "reportEvents", + "description": [], + "signature": [ + "(events: ", + "Event", + "[]) => void" + ], + "path": "packages/analytics/shippers/fullstory/src/fullstory_shipper.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/analytics-shippers-fullstory", + "id": "def-server.FullStoryShipper.reportEvents.$1", + "type": "Array", + "tags": [], + "label": "events", + "description": [], + "signature": [ + "Event", + "[]" + ], + "path": "packages/analytics/shippers/fullstory/src/fullstory_shipper.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [ + { + "parentPluginId": "@kbn/analytics-shippers-fullstory", + "id": "def-server.FullStorySnippetConfig", + "type": "Interface", + "tags": [], + "label": "FullStorySnippetConfig", + "description": [], + "path": "packages/analytics/shippers/fullstory/src/load_snippet.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/analytics-shippers-fullstory", + "id": "def-server.FullStorySnippetConfig.fullStoryOrgId", + "type": "string", + "tags": [], + "label": "fullStoryOrgId", + "description": [ + "\nThe FullStory account id." + ], + "path": "packages/analytics/shippers/fullstory/src/load_snippet.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/analytics-shippers-fullstory", + "id": "def-server.FullStorySnippetConfig.host", + "type": "string", + "tags": [], + "label": "host", + "description": [ + "\nThe host to send the data to. Used to overcome AdBlockers by using custom DNSs.\nIf not specified, it defaults to `fullstory.com`." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/analytics/shippers/fullstory/src/load_snippet.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/analytics-shippers-fullstory", + "id": "def-server.FullStorySnippetConfig.scriptUrl", + "type": "string", + "tags": [], + "label": "scriptUrl", + "description": [ + "\nThe URL to load the FullStory client from. Falls back to `edge.fullstory.com/s/fs.js` if not specified." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/analytics/shippers/fullstory/src/load_snippet.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/analytics-shippers-fullstory", + "id": "def-server.FullStorySnippetConfig.debug", + "type": "CompoundType", + "tags": [], + "label": "debug", + "description": [ + "\nWhether the debug logs should be printed to the console." + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/analytics/shippers/fullstory/src/load_snippet.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/analytics-shippers-fullstory", + "id": "def-server.FullStorySnippetConfig.namespace", + "type": "string", + "tags": [], + "label": "namespace", + "description": [ + "\nThe name of the variable where the API is stored: `window[namespace]`. Defaults to `FS`." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/analytics/shippers/fullstory/src/load_snippet.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/analytics-shippers-fullstory", + "id": "def-server.FullStoryShipperConfig", + "type": "Type", + "tags": [], + "label": "FullStoryShipperConfig", + "description": [], + "signature": [ + { + "pluginId": "@kbn/analytics-shippers-fullstory", + "scope": "server", + "docId": "kibKbnAnalyticsShippersFullstoryPluginApi", + "section": "def-server.FullStorySnippetConfig", + "text": "FullStorySnippetConfig" + } + ], + "path": "packages/analytics/shippers/fullstory/src/fullstory_shipper.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_analytics_shippers_fullstory.mdx b/api_docs/kbn_analytics_shippers_fullstory.mdx new file mode 100644 index 0000000000000..326388928255e --- /dev/null +++ b/api_docs/kbn_analytics_shippers_fullstory.mdx @@ -0,0 +1,33 @@ +--- +id: kibKbnAnalyticsShippersFullstoryPluginApi +slug: /kibana-dev-docs/api/kbn-analytics-shippers-fullstory +title: "@kbn/analytics-shippers-fullstory" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/analytics-shippers-fullstory plugin +date: 2022-04-26 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-fullstory'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnAnalyticsShippersFullstoryObj from './kbn_analytics_shippers_fullstory.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 18 | 0 | 13 | 0 | + +## Server + +### Classes + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/kbn_apm_config_loader.mdx b/api_docs/kbn_apm_config_loader.mdx index 2ed7dbdbfda88..5e544916f7581 100644 --- a/api_docs/kbn_apm_config_loader.mdx +++ b/api_docs/kbn_apm_config_loader.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-apm-config-loader title: "@kbn/apm-config-loader" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/apm-config-loader plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-config-loader'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_apm_utils.mdx b/api_docs/kbn_apm_utils.mdx index 49fb44941d1dc..6b8bd73db26cd 100644 --- a/api_docs/kbn_apm_utils.mdx +++ b/api_docs/kbn_apm_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-apm-utils title: "@kbn/apm-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/apm-utils plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_axe_config.mdx b/api_docs/kbn_axe_config.mdx index 6acea95d20cc4..91196a5c6fff9 100644 --- a/api_docs/kbn_axe_config.mdx +++ b/api_docs/kbn_axe_config.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-axe-config title: "@kbn/axe-config" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/axe-config plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/axe-config'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_bazel_packages.devdocs.json b/api_docs/kbn_bazel_packages.devdocs.json index babc54a49973c..993554aca7636 100644 --- a/api_docs/kbn_bazel_packages.devdocs.json +++ b/api_docs/kbn_bazel_packages.devdocs.json @@ -29,7 +29,7 @@ "tags": [], "label": "fromDir", "description": [ - "\nCreate a BazelPackage object from a package directory. Reads some files from the package and returns\na Promise for a BazelPackage instance" + "\nCreate a BazelPackage object from a package directory. Reads some files from the package and returns\na Promise for a BazelPackage instance." ], "signature": [ "(dir: string) => Promise<", @@ -154,6 +154,23 @@ "children": [], "returnComment": [] }, + { + "parentPluginId": "@kbn/bazel-packages", + "id": "def-server.BazelPackage.isDevOnly", + "type": "Function", + "tags": [], + "label": "isDevOnly", + "description": [ + "\nReturns true if the package is not intended to be in the build" + ], + "signature": [ + "() => boolean" + ], + "path": "packages/kbn-bazel-packages/src/bazel_package.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, { "parentPluginId": "@kbn/bazel-packages", "id": "def-server.BazelPackage.inspect.custom", @@ -176,17 +193,46 @@ } ], "functions": [ + { + "parentPluginId": "@kbn/bazel-packages", + "id": "def-server.discoverBazelPackageLocations", + "type": "Function", + "tags": [], + "label": "discoverBazelPackageLocations", + "description": [], + "signature": [ + "(repoRoot: string) => string[]" + ], + "path": "packages/kbn-bazel-packages/src/discover_packages.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/bazel-packages", + "id": "def-server.discoverBazelPackageLocations.$1", + "type": "string", + "tags": [], + "label": "repoRoot", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-bazel-packages/src/discover_packages.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/bazel-packages", "id": "def-server.discoverBazelPackages", "type": "Function", "tags": [], "label": "discoverBazelPackages", - "description": [ - "\nSearch the local Kibana repo for bazel packages and return an array of BazelPackage objects\nrepresenting each package found." - ], + "description": [], "signature": [ - "() => Promise<", + "(repoRoot: string) => Promise<", { "pluginId": "@kbn/bazel-packages", "scope": "server", @@ -198,6 +244,57 @@ ], "path": "packages/kbn-bazel-packages/src/discover_packages.ts", "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/bazel-packages", + "id": "def-server.discoverBazelPackages.$1", + "type": "string", + "tags": [], + "label": "repoRoot", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-bazel-packages/src/discover_packages.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/bazel-packages", + "id": "def-server.getAllBazelPackageDirs", + "type": "Function", + "tags": [], + "label": "getAllBazelPackageDirs", + "description": [ + "\nResolve all the BAZEL_PACKAGE_DIRS to absolute paths" + ], + "signature": [ + "() => EntryInternal[] & string[]" + ], + "path": "packages/kbn-bazel-packages/src/bazel_package_dirs.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/bazel-packages", + "id": "def-server.getAllRepoRelativeBazelPackageDirs", + "type": "Function", + "tags": [], + "label": "getAllRepoRelativeBazelPackageDirs", + "description": [ + "\nResolve all the BAZEL_PACKAGE_DIRS to repo-relative paths" + ], + "signature": [ + "() => string[]" + ], + "path": "packages/kbn-bazel-packages/src/bazel_package_dirs.ts", + "deprecated": false, "children": [], "returnComment": [], "initialIsOpen": false @@ -213,7 +310,7 @@ "tags": [], "label": "BAZEL_PACKAGE_DIRS", "description": [ - "\nThis is a list of repo-relative paths to directories containing packages. Do not\ninclude `**` in these, one or two `*` segments is acceptable, we need this search\nto be super fast so please avoid deep recursive searching.\n\n eg. src/vis-editors => would find a package at src/vis-editors/foo/package.json\n src/vis-editors/* => would find a package at src/vis-editors/foo/bar/package.json" + "\nThis is a list of repo-relative paths to directories containing packages. Do not\ninclude `**` in these, one or two `*` segments is acceptable, we need this search\nto be super fast so please avoid deep recursive searching.\n\n eg. src/vis_editors => would find a package at src/vis_editors/foo/package.json\n src/vis_editors/* => would find a package at src/vis_editors/foo/bar/package.json" ], "signature": [ "string[]" diff --git a/api_docs/kbn_bazel_packages.mdx b/api_docs/kbn_bazel_packages.mdx index 4cecba08dd051..a6dbbd7872270 100644 --- a/api_docs/kbn_bazel_packages.mdx +++ b/api_docs/kbn_bazel_packages.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-bazel-packages title: "@kbn/bazel-packages" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/bazel-packages plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/bazel-packages'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 12 | 0 | 5 | 1 | +| 18 | 0 | 9 | 1 | ## Server diff --git a/api_docs/kbn_bazel_runner.devdocs.json b/api_docs/kbn_bazel_runner.devdocs.json new file mode 100644 index 0000000000000..e5f5473949f65 --- /dev/null +++ b/api_docs/kbn_bazel_runner.devdocs.json @@ -0,0 +1,90 @@ +{ + "id": "@kbn/bazel-runner", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/bazel-runner", + "id": "def-server.runBazel", + "type": "Function", + "tags": [], + "label": "runBazel", + "description": [], + "signature": [ + "(options: BazelRunOptions) => Promise" + ], + "path": "packages/kbn-bazel-runner/src/bazel_runner.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/bazel-runner", + "id": "def-server.runBazel.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "BazelRunOptions" + ], + "path": "packages/kbn-bazel-runner/src/bazel_runner.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/bazel-runner", + "id": "def-server.runIBazel", + "type": "Function", + "tags": [], + "label": "runIBazel", + "description": [], + "signature": [ + "(options: BazelRunOptions) => Promise" + ], + "path": "packages/kbn-bazel-runner/src/bazel_runner.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/bazel-runner", + "id": "def-server.runIBazel.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "BazelRunOptions" + ], + "path": "packages/kbn-bazel-runner/src/bazel_runner.ts", + "deprecated": 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_bazel_runner.mdx b/api_docs/kbn_bazel_runner.mdx new file mode 100644 index 0000000000000..e26e06d6d8241 --- /dev/null +++ b/api_docs/kbn_bazel_runner.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnBazelRunnerPluginApi +slug: /kibana-dev-docs/api/kbn-bazel-runner +title: "@kbn/bazel-runner" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/bazel-runner plugin +date: 2022-04-26 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/bazel-runner'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnBazelRunnerObj from './kbn_bazel_runner.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 4 | 0 | 4 | 0 | + +## Server + +### Functions + + diff --git a/api_docs/kbn_ci_stats_client.devdocs.json b/api_docs/kbn_ci_stats_client.devdocs.json new file mode 100644 index 0000000000000..bc6b6ba628f44 --- /dev/null +++ b/api_docs/kbn_ci_stats_client.devdocs.json @@ -0,0 +1,158 @@ +{ + "id": "@kbn/ci-stats-client", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [ + { + "parentPluginId": "@kbn/ci-stats-client", + "id": "def-server.CiStatsClient", + "type": "Class", + "tags": [], + "label": "CiStatsClient", + "description": [], + "path": "packages/kbn-ci-stats-client/src/ci_stats_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/ci-stats-client", + "id": "def-server.CiStatsClient.fromEnv", + "type": "Function", + "tags": [], + "label": "fromEnv", + "description": [ + "\nCreate a CiStatsReporter by inspecting the ENV for the necessary config" + ], + "signature": [ + "(log: ", + "ToolingLog", + ") => ", + { + "pluginId": "@kbn/ci-stats-client", + "scope": "server", + "docId": "kibKbnCiStatsClientPluginApi", + "section": "def-server.CiStatsClient", + "text": "CiStatsClient" + } + ], + "path": "packages/kbn-ci-stats-client/src/ci_stats_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/ci-stats-client", + "id": "def-server.CiStatsClient.fromEnv.$1", + "type": "Object", + "tags": [], + "label": "log", + "description": [], + "signature": [ + "ToolingLog" + ], + "path": "packages/kbn-ci-stats-client/src/ci_stats_client.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/ci-stats-client", + "id": "def-server.CiStatsClient.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "packages/kbn-ci-stats-client/src/ci_stats_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/ci-stats-client", + "id": "def-server.CiStatsClient.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "config", + "description": [], + "signature": [ + "Config", + " | undefined" + ], + "path": "packages/kbn-ci-stats-client/src/ci_stats_client.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/ci-stats-client", + "id": "def-server.CiStatsClient.isEnabled", + "type": "Function", + "tags": [], + "label": "isEnabled", + "description": [], + "signature": [ + "() => boolean" + ], + "path": "packages/kbn-ci-stats-client/src/ci_stats_client.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/ci-stats-client", + "id": "def-server.CiStatsClient.getLatestTestGroupStats", + "type": "Function", + "tags": [], + "label": "getLatestTestGroupStats", + "description": [], + "signature": [ + "(options: LatestTestGroupStatsOptions) => Promise" + ], + "path": "packages/kbn-ci-stats-client/src/ci_stats_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/ci-stats-client", + "id": "def-server.CiStatsClient.getLatestTestGroupStats.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "LatestTestGroupStatsOptions" + ], + "path": "packages/kbn-ci-stats-client/src/ci_stats_client.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_ci_stats_client.mdx b/api_docs/kbn_ci_stats_client.mdx new file mode 100644 index 0000000000000..7e081672825d1 --- /dev/null +++ b/api_docs/kbn_ci_stats_client.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnCiStatsClientPluginApi +slug: /kibana-dev-docs/api/kbn-ci-stats-client +title: "@kbn/ci-stats-client" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/ci-stats-client plugin +date: 2022-04-26 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-client'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnCiStatsClientObj from './kbn_ci_stats_client.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 8 | 0 | 7 | 0 | + +## Server + +### Classes + + diff --git a/api_docs/kbn_ci_stats_core.devdocs.json b/api_docs/kbn_ci_stats_core.devdocs.json new file mode 100644 index 0000000000000..d088822187665 --- /dev/null +++ b/api_docs/kbn_ci_stats_core.devdocs.json @@ -0,0 +1,139 @@ +{ + "id": "@kbn/ci-stats-core", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/ci-stats-core", + "id": "def-server.parseConfig", + "type": "Function", + "tags": [], + "label": "parseConfig", + "description": [], + "signature": [ + "(log: ", + "ToolingLog", + ") => ", + { + "pluginId": "@kbn/ci-stats-core", + "scope": "server", + "docId": "kibKbnCiStatsCorePluginApi", + "section": "def-server.Config", + "text": "Config" + }, + " | undefined" + ], + "path": "packages/kbn-ci-stats-core/src/ci_stats_config.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/ci-stats-core", + "id": "def-server.parseConfig.$1", + "type": "Object", + "tags": [], + "label": "log", + "description": [], + "signature": [ + "ToolingLog" + ], + "path": "packages/kbn-ci-stats-core/src/ci_stats_config.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "@kbn/ci-stats-core", + "id": "def-server.CiStatsMetadata", + "type": "Interface", + "tags": [], + "label": "CiStatsMetadata", + "description": [ + "Container for metadata that can be attached to different ci-stats objects" + ], + "path": "packages/kbn-ci-stats-core/src/ci_stats_metadata.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/ci-stats-core", + "id": "def-server.CiStatsMetadata.Unnamed", + "type": "IndexSignature", + "tags": [], + "label": "[key: string]: string | number | boolean | string[] | undefined", + "description": [ + "\nArbitrary key-value pairs which can be attached to CiStatsTiming and CiStatsMetric\nobjects stored in the ci-stats service" + ], + "signature": [ + "[key: string]: string | number | boolean | string[] | undefined" + ], + "path": "packages/kbn-ci-stats-core/src/ci_stats_metadata.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/ci-stats-core", + "id": "def-server.Config", + "type": "Interface", + "tags": [], + "label": "Config", + "description": [ + "\nInformation about how CiStatsReporter should talk to the ci-stats service. Normally\nit is read from a JSON environment variable using the `parseConfig()` function\nexported by this module." + ], + "path": "packages/kbn-ci-stats-core/src/ci_stats_config.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/ci-stats-core", + "id": "def-server.Config.apiToken", + "type": "string", + "tags": [], + "label": "apiToken", + "description": [ + "ApiToken necessary for writing build data to ci-stats service" + ], + "path": "packages/kbn-ci-stats-core/src/ci_stats_config.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/ci-stats-core", + "id": "def-server.Config.buildId", + "type": "string", + "tags": [], + "label": "buildId", + "description": [ + "\nuuid which should be obtained by first creating a build with the\nci-stats service and then passing it to all subsequent steps" + ], + "path": "packages/kbn-ci-stats-core/src/ci_stats_config.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_ci_stats_core.mdx b/api_docs/kbn_ci_stats_core.mdx new file mode 100644 index 0000000000000..a309e10212e64 --- /dev/null +++ b/api_docs/kbn_ci_stats_core.mdx @@ -0,0 +1,30 @@ +--- +id: kibKbnCiStatsCorePluginApi +slug: /kibana-dev-docs/api/kbn-ci-stats-core +title: "@kbn/ci-stats-core" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/ci-stats-core plugin +date: 2022-04-26 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-core'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnCiStatsCoreObj from './kbn_ci_stats_core.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 7 | 0 | 2 | 0 | + +## Server + +### Functions + + +### Interfaces + + diff --git a/api_docs/kbn_ci_stats_reporter.devdocs.json b/api_docs/kbn_ci_stats_reporter.devdocs.json new file mode 100644 index 0000000000000..f579d304c08db --- /dev/null +++ b/api_docs/kbn_ci_stats_reporter.devdocs.json @@ -0,0 +1,968 @@ +{ + "id": "@kbn/ci-stats-reporter", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [ + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsReporter", + "type": "Class", + "tags": [], + "label": "CiStatsReporter", + "description": [ + "Object that helps report data to the ci-stats service" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsReporter.fromEnv", + "type": "Function", + "tags": [], + "label": "fromEnv", + "description": [ + "\nCreate a CiStatsReporter by inspecting the ENV for the necessary config" + ], + "signature": [ + "(log: ", + "ToolingLog", + ") => ", + { + "pluginId": "@kbn/ci-stats-reporter", + "scope": "server", + "docId": "kibKbnCiStatsReporterPluginApi", + "section": "def-server.CiStatsReporter", + "text": "CiStatsReporter" + } + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsReporter.fromEnv.$1", + "type": "Object", + "tags": [], + "label": "log", + "description": [], + "signature": [ + "ToolingLog" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsReporter.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsReporter.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "config", + "description": [], + "signature": [ + "Config", + " | undefined" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsReporter.Unnamed.$2", + "type": "Object", + "tags": [], + "label": "log", + "description": [], + "signature": [ + "ToolingLog" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsReporter.isEnabled", + "type": "Function", + "tags": [], + "label": "isEnabled", + "description": [ + "\nDetermine if CI_STATS is explicitly disabled by the environment. To determine\nif the CiStatsReporter has enough information in the environment to send metrics\nfor builds use #hasBuildConfig()." + ], + "signature": [ + "() => boolean" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsReporter.hasBuildConfig", + "type": "Function", + "tags": [], + "label": "hasBuildConfig", + "description": [ + "\nDetermines if the CiStatsReporter is disabled by the environment, or properly\nconfigured and able to send stats" + ], + "signature": [ + "() => boolean" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsReporter.timings", + "type": "Function", + "tags": [], + "label": "timings", + "description": [ + "\nReport timings data to the ci-stats service. If running in CI then the reporter\nwill include the buildId in the report with the access token, otherwise the timings\ndata will be recorded as anonymous timing data." + ], + "signature": [ + "(options: ", + { + "pluginId": "@kbn/ci-stats-reporter", + "scope": "server", + "docId": "kibKbnCiStatsReporterPluginApi", + "section": "def-server.TimingsOptions", + "text": "TimingsOptions" + }, + ") => Promise" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsReporter.timings.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/ci-stats-reporter", + "scope": "server", + "docId": "kibKbnCiStatsReporterPluginApi", + "section": "def-server.TimingsOptions", + "text": "TimingsOptions" + } + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsReporter.metrics", + "type": "Function", + "tags": [], + "label": "metrics", + "description": [ + "\nReport metrics data to the ci-stats service. If running outside of CI this method\ndoes nothing as metrics can only be reported when associated with a specific CI build." + ], + "signature": [ + "(metrics: ", + { + "pluginId": "@kbn/ci-stats-reporter", + "scope": "server", + "docId": "kibKbnCiStatsReporterPluginApi", + "section": "def-server.CiStatsMetric", + "text": "CiStatsMetric" + }, + "[], options?: ", + { + "pluginId": "@kbn/ci-stats-reporter", + "scope": "server", + "docId": "kibKbnCiStatsReporterPluginApi", + "section": "def-server.MetricsOptions", + "text": "MetricsOptions" + }, + " | undefined) => Promise" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsReporter.metrics.$1", + "type": "Array", + "tags": [], + "label": "metrics", + "description": [], + "signature": [ + { + "pluginId": "@kbn/ci-stats-reporter", + "scope": "server", + "docId": "kibKbnCiStatsReporterPluginApi", + "section": "def-server.CiStatsMetric", + "text": "CiStatsMetric" + }, + "[]" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsReporter.metrics.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/ci-stats-reporter", + "scope": "server", + "docId": "kibKbnCiStatsReporterPluginApi", + "section": "def-server.MetricsOptions", + "text": "MetricsOptions" + }, + " | undefined" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsReporter.reportTests", + "type": "Function", + "tags": [], + "label": "reportTests", + "description": [ + "\nSend test reports to ci-stats" + ], + "signature": [ + "({ group, testRuns }: ", + { + "pluginId": "@kbn/ci-stats-reporter", + "scope": "server", + "docId": "kibKbnCiStatsReporterPluginApi", + "section": "def-server.CiStatsReportTestsOptions", + "text": "CiStatsReportTestsOptions" + }, + ") => Promise" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsReporter.reportTests.$1", + "type": "Object", + "tags": [], + "label": "{ group, testRuns }", + "description": [], + "signature": [ + { + "pluginId": "@kbn/ci-stats-reporter", + "scope": "server", + "docId": "kibKbnCiStatsReporterPluginApi", + "section": "def-server.CiStatsReportTestsOptions", + "text": "CiStatsReportTestsOptions" + } + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [ + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.getTimeReporter", + "type": "Function", + "tags": [], + "label": "getTimeReporter", + "description": [], + "signature": [ + "(log: ", + "ToolingLog", + ", group: string) => (startTime: number, id: string, meta: Record) => Promise" + ], + "path": "packages/kbn-ci-stats-reporter/src/report_time.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.getTimeReporter.$1", + "type": "Object", + "tags": [], + "label": "log", + "description": [], + "signature": [ + "ToolingLog" + ], + "path": "packages/kbn-ci-stats-reporter/src/report_time.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.getTimeReporter.$2", + "type": "string", + "tags": [], + "label": "group", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-ci-stats-reporter/src/report_time.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsMetric", + "type": "Interface", + "tags": [], + "label": "CiStatsMetric", + "description": [ + "A ci-stats metric record" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsMetric.group", + "type": "string", + "tags": [], + "label": "group", + "description": [ + "Top-level categorization for the metric, e.g. \"page load bundle size\"" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsMetric.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "Specific sub-set of the \"group\", e.g. \"dashboard\"" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsMetric.value", + "type": "number", + "tags": [], + "label": "value", + "description": [ + "integer value recorded as the value of this metric" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsMetric.limit", + "type": "number", + "tags": [], + "label": "limit", + "description": [ + "optional limit which will generate an error on PRs when the metric exceeds the limit" + ], + "signature": [ + "number | undefined" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsMetric.limitConfigPath", + "type": "string", + "tags": [], + "label": "limitConfigPath", + "description": [ + "\npath, relative to the repo, where the config file contianing limits\nis kept. Linked from PR comments instructing contributors how to fix\ntheir PRs." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsMetric.meta", + "type": "Object", + "tags": [], + "label": "meta", + "description": [ + "Arbitrary key-value pairs which can be used for additional filtering/reporting" + ], + "signature": [ + "CiStatsMetadata", + " | undefined" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsReportTestsOptions", + "type": "Interface", + "tags": [], + "label": "CiStatsReportTestsOptions", + "description": [ + "Options for reporting tests to ci-stats" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsReportTestsOptions.group", + "type": "Object", + "tags": [], + "label": "group", + "description": [ + "\nInformation about the group of tests that were run" + ], + "signature": [ + { + "pluginId": "@kbn/ci-stats-reporter", + "scope": "server", + "docId": "kibKbnCiStatsReporterPluginApi", + "section": "def-server.CiStatsTestGroupInfo", + "text": "CiStatsTestGroupInfo" + } + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsReportTestsOptions.testRuns", + "type": "Array", + "tags": [], + "label": "testRuns", + "description": [ + "\nInformation about each test that ran, including failure information" + ], + "signature": [ + { + "pluginId": "@kbn/ci-stats-reporter", + "scope": "server", + "docId": "kibKbnCiStatsReporterPluginApi", + "section": "def-server.CiStatsTestRun", + "text": "CiStatsTestRun" + }, + "[]" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsTestGroupInfo", + "type": "Interface", + "tags": [], + "label": "CiStatsTestGroupInfo", + "description": [], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsTestGroupInfo.startTime", + "type": "string", + "tags": [], + "label": "startTime", + "description": [ + "\nISO-8601 formatted datetime representing when the group of tests started running" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsTestGroupInfo.durationMs", + "type": "number", + "tags": [], + "label": "durationMs", + "description": [ + "\nThe number of miliseconds that the tests ran for" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsTestGroupInfo.type", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "\nThe type of tests run in this group, any value is valid but test groups are groupped by type in the UI so use something consistent" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsTestGroupInfo.name", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "\nThe name of this specific group (within the \"type\")" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsTestGroupInfo.meta", + "type": "Object", + "tags": [], + "label": "meta", + "description": [ + "\nArbitrary metadata associated with this group. We currently look for a ciGroup metadata property for highlighting that when appropriate" + ], + "signature": [ + "CiStatsMetadata" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsTestRun", + "type": "Interface", + "tags": [], + "label": "CiStatsTestRun", + "description": [], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsTestRun.startTime", + "type": "string", + "tags": [], + "label": "startTime", + "description": [ + "\nISO-8601 formatted datetime representing when the tests started running" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsTestRun.durationMs", + "type": "number", + "tags": [], + "label": "durationMs", + "description": [ + "\nDuration of the tests in milliseconds" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsTestRun.seq", + "type": "number", + "tags": [], + "label": "seq", + "description": [ + "\nA sequence number, this is used to order the tests in a specific test run" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsTestRun.type", + "type": "CompoundType", + "tags": [], + "label": "type", + "description": [ + "\nThe type of this \"test run\", usually this is just \"test\" but when reporting issues in hooks it can be set to the type of hook" + ], + "signature": [ + "\"after all hook\" | \"after each hook\" | \"before all hook\" | \"before each hook\" | \"test\"" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsTestRun.result", + "type": "CompoundType", + "tags": [], + "label": "result", + "description": [ + "\n\"fail\", \"pass\" or \"skip\", the result of the tests" + ], + "signature": [ + "\"fail\" | \"pass\" | \"skip\"" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsTestRun.suites", + "type": "Array", + "tags": [], + "label": "suites", + "description": [ + "\nThe list of suite names containing this test, the first being the outermost suite" + ], + "signature": [ + "string[]" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsTestRun.name", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "\nThe name of this specific test run" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsTestRun.file", + "type": "string", + "tags": [], + "label": "file", + "description": [ + "\nRelative path from the root of the repo contianing this test" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsTestRun.error", + "type": "string", + "tags": [], + "label": "error", + "description": [ + "\nError message if the test failed" + ], + "signature": [ + "string | undefined" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsTestRun.stdout", + "type": "string", + "tags": [], + "label": "stdout", + "description": [ + "\nDebug output/stdout produced by the test" + ], + "signature": [ + "string | undefined" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsTestRun.screenshots", + "type": "Array", + "tags": [], + "label": "screenshots", + "description": [ + "\nScreenshots captured during the test run" + ], + "signature": [ + "{ name: string; base64Png: string; }[] | undefined" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsTiming", + "type": "Interface", + "tags": [], + "label": "CiStatsTiming", + "description": [ + "A ci-stats timing event" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsTiming.group", + "type": "string", + "tags": [], + "label": "group", + "description": [ + "Top-level categorization for the timing, e.g. \"scripts/foo\", process type, etc." + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsTiming.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "Specific timing (witin the \"group\" being tracked) e.g. \"total\"" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsTiming.ms", + "type": "number", + "tags": [], + "label": "ms", + "description": [ + "time in milliseconds which should be recorded" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsTiming.meta", + "type": "Object", + "tags": [], + "label": "meta", + "description": [ + "hash of key-value pairs which will be stored with the timing for additional filtering and reporting" + ], + "signature": [ + "CiStatsMetadata", + " | undefined" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.MetricsOptions", + "type": "Interface", + "tags": [], + "label": "MetricsOptions", + "description": [ + "Options for reporting metrics to ci-stats" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.MetricsOptions.defaultMeta", + "type": "Object", + "tags": [], + "label": "defaultMeta", + "description": [ + "Default metadata to add to each metric" + ], + "signature": [ + "CiStatsMetadata", + " | undefined" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.TimingsOptions", + "type": "Interface", + "tags": [], + "label": "TimingsOptions", + "description": [ + "Options for reporting timings to ci-stats" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.TimingsOptions.timings", + "type": "Array", + "tags": [], + "label": "timings", + "description": [ + "list of timings to record" + ], + "signature": [ + { + "pluginId": "@kbn/ci-stats-reporter", + "scope": "server", + "docId": "kibKbnCiStatsReporterPluginApi", + "section": "def-server.CiStatsTiming", + "text": "CiStatsTiming" + }, + "[]" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.TimingsOptions.upstreamBranch", + "type": "string", + "tags": [], + "label": "upstreamBranch", + "description": [ + "master, 7.x, etc, automatically detected from package.json if not specified" + ], + "signature": [ + "string | undefined" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.TimingsOptions.kibanaUuid", + "type": "CompoundType", + "tags": [], + "label": "kibanaUuid", + "description": [ + "value of data/uuid, automatically loaded if not specified" + ], + "signature": [ + "string | null | undefined" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsTestResult", + "type": "Type", + "tags": [], + "label": "CiStatsTestResult", + "description": [], + "signature": [ + "\"fail\" | \"pass\" | \"skip\"" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsTestType", + "type": "Type", + "tags": [], + "label": "CiStatsTestType", + "description": [], + "signature": [ + "\"after all hook\" | \"after each hook\" | \"before all hook\" | \"before each hook\" | \"test\"" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_ci_stats_reporter.mdx b/api_docs/kbn_ci_stats_reporter.mdx new file mode 100644 index 0000000000000..0cc182de00726 --- /dev/null +++ b/api_docs/kbn_ci_stats_reporter.mdx @@ -0,0 +1,36 @@ +--- +id: kibKbnCiStatsReporterPluginApi +slug: /kibana-dev-docs/api/kbn-ci-stats-reporter +title: "@kbn/ci-stats-reporter" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/ci-stats-reporter plugin +date: 2022-04-26 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-reporter'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnCiStatsReporterObj from './kbn_ci_stats_reporter.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 59 | 0 | 15 | 0 | + +## Server + +### Functions + + +### Classes + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/kbn_cli_dev_mode.mdx b/api_docs/kbn_cli_dev_mode.mdx index c3491abc76979..5f3a928f804bc 100644 --- a/api_docs/kbn_cli_dev_mode.mdx +++ b/api_docs/kbn_cli_dev_mode.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-cli-dev-mode title: "@kbn/cli-dev-mode" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/cli-dev-mode plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cli-dev-mode'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_coloring.devdocs.json b/api_docs/kbn_coloring.devdocs.json new file mode 100644 index 0000000000000..b6c631706bfaf --- /dev/null +++ b/api_docs/kbn_coloring.devdocs.json @@ -0,0 +1,1791 @@ +{ + "id": "@kbn/coloring", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.checkIsMaxContinuity", + "type": "Function", + "tags": [], + "label": "checkIsMaxContinuity", + "description": [], + "signature": [ + "(continuity: ", + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.PaletteContinuity", + "text": "PaletteContinuity" + }, + " | undefined) => boolean" + ], + "path": "packages/kbn-coloring/src/palettes/utils.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.checkIsMaxContinuity.$1", + "type": "CompoundType", + "tags": [], + "label": "continuity", + "description": [], + "signature": [ + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.PaletteContinuity", + "text": "PaletteContinuity" + }, + " | undefined" + ], + "path": "packages/kbn-coloring/src/palettes/utils.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.checkIsMinContinuity", + "type": "Function", + "tags": [], + "label": "checkIsMinContinuity", + "description": [], + "signature": [ + "(continuity: ", + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.PaletteContinuity", + "text": "PaletteContinuity" + }, + " | undefined) => boolean" + ], + "path": "packages/kbn-coloring/src/palettes/utils.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.checkIsMinContinuity.$1", + "type": "CompoundType", + "tags": [], + "label": "continuity", + "description": [], + "signature": [ + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.PaletteContinuity", + "text": "PaletteContinuity" + }, + " | undefined" + ], + "path": "packages/kbn-coloring/src/palettes/utils.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.CustomizablePalette", + "type": "Function", + "tags": [], + "label": "CustomizablePalette", + "description": [ + "\nA `CustomizablePalette` component that is wrapped by the `withSuspense` HOC. This component can\nbe used directly by consumers and will load the `KibanaPageTemplateSolutionNavAvatarLazy` component lazily with\na predefined fallback and error boundary." + ], + "signature": [ + "React.ForwardRefExoticComponent<", + "CustomizablePaletteProps", + " & React.RefAttributes<{}>>" + ], + "path": "packages/kbn-coloring/src/shared_components/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.CustomizablePalette.$1", + "type": "Uncategorized", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.CustomizablePaletteLazy", + "type": "Function", + "tags": [], + "label": "CustomizablePaletteLazy", + "description": [ + "\nThe Lazily-loaded `CustomizablePalette` component. Consumers should use `React.Suspense` or\nthe withSuspense` HOC to load this component." + ], + "signature": [ + "React.ExoticComponent<", + "CustomizablePaletteProps", + "> & { readonly _result: ({ palettes, activePalette, setPalette, dataBounds, showExtraActions, showRangeTypeSelector, disableSwitchingContinuity, }: ", + "CustomizablePaletteProps", + ") => JSX.Element; }" + ], + "path": "packages/kbn-coloring/src/shared_components/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.CustomizablePaletteLazy.$1", + "type": "Uncategorized", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.getDataMinMax", + "type": "Function", + "tags": [], + "label": "getDataMinMax", + "description": [], + "signature": [ + "(rangeType: \"number\" | \"percent\" | undefined, dataBounds: ", + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.DataBounds", + "text": "DataBounds" + }, + ") => { min: number; max: number; }" + ], + "path": "packages/kbn-coloring/src/palettes/utils.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.getDataMinMax.$1", + "type": "CompoundType", + "tags": [], + "label": "rangeType", + "description": [], + "signature": [ + "\"number\" | \"percent\" | undefined" + ], + "path": "packages/kbn-coloring/src/palettes/utils.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.getDataMinMax.$2", + "type": "Object", + "tags": [], + "label": "dataBounds", + "description": [], + "signature": [ + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.DataBounds", + "text": "DataBounds" + } + ], + "path": "packages/kbn-coloring/src/palettes/utils.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.getFallbackDataBounds", + "type": "Function", + "tags": [], + "label": "getFallbackDataBounds", + "description": [], + "signature": [ + "(rangeType?: \"number\" | \"percent\" | undefined) => ", + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.DataBounds", + "text": "DataBounds" + } + ], + "path": "packages/kbn-coloring/src/palettes/utils.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.getFallbackDataBounds.$1", + "type": "CompoundType", + "tags": [], + "label": "rangeType", + "description": [], + "signature": [ + "\"number\" | \"percent\" | undefined" + ], + "path": "packages/kbn-coloring/src/palettes/utils.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.getPaletteStops", + "type": "Function", + "tags": [], + "label": "getPaletteStops", + "description": [ + "\nThis is a generic function to compute stops from the current parameters." + ], + "signature": [ + "(palettes: ", + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.PaletteRegistry", + "text": "PaletteRegistry" + }, + ", activePaletteParams: ", + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.CustomPaletteParams", + "text": "CustomPaletteParams" + }, + ", {\n prevPalette,\n dataBounds,\n mapFromMinValue,\n defaultPaletteName,\n }: { prevPalette?: string | undefined; dataBounds: ", + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.DataBounds", + "text": "DataBounds" + }, + "; mapFromMinValue?: boolean | undefined; defaultPaletteName?: string | undefined; }) => { stop: number; color: string; }[]" + ], + "path": "packages/kbn-coloring/src/palettes/utils.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.getPaletteStops.$1", + "type": "Object", + "tags": [], + "label": "palettes", + "description": [], + "signature": [ + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.PaletteRegistry", + "text": "PaletteRegistry" + } + ], + "path": "packages/kbn-coloring/src/palettes/utils.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.getPaletteStops.$2", + "type": "Object", + "tags": [], + "label": "activePaletteParams", + "description": [], + "signature": [ + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.CustomPaletteParams", + "text": "CustomPaletteParams" + } + ], + "path": "packages/kbn-coloring/src/palettes/utils.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.getPaletteStops.$3", + "type": "Object", + "tags": [], + "label": "{\n prevPalette,\n dataBounds,\n mapFromMinValue,\n defaultPaletteName,\n }", + "description": [], + "path": "packages/kbn-coloring/src/palettes/utils.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.getPaletteStops.$3.prevPalette", + "type": "string", + "tags": [], + "label": "prevPalette", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/kbn-coloring/src/palettes/utils.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.getPaletteStops.$3.dataBounds", + "type": "Object", + "tags": [], + "label": "dataBounds", + "description": [], + "signature": [ + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.DataBounds", + "text": "DataBounds" + } + ], + "path": "packages/kbn-coloring/src/palettes/utils.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.getPaletteStops.$3.mapFromMinValue", + "type": "CompoundType", + "tags": [], + "label": "mapFromMinValue", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "packages/kbn-coloring/src/palettes/utils.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.getPaletteStops.$3.defaultPaletteName", + "type": "string", + "tags": [], + "label": "defaultPaletteName", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/kbn-coloring/src/palettes/utils.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.getStepValue", + "type": "Function", + "tags": [], + "label": "getStepValue", + "description": [], + "signature": [ + "(colorStops: ", + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.ColorStop", + "text": "ColorStop" + }, + "[], newColorStops: ", + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.ColorStop", + "text": "ColorStop" + }, + "[], max: number) => number" + ], + "path": "packages/kbn-coloring/src/palettes/utils.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.getStepValue.$1", + "type": "Array", + "tags": [], + "label": "colorStops", + "description": [], + "signature": [ + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.ColorStop", + "text": "ColorStop" + }, + "[]" + ], + "path": "packages/kbn-coloring/src/palettes/utils.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.getStepValue.$2", + "type": "Array", + "tags": [], + "label": "newColorStops", + "description": [], + "signature": [ + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.ColorStop", + "text": "ColorStop" + }, + "[]" + ], + "path": "packages/kbn-coloring/src/palettes/utils.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.getStepValue.$3", + "type": "number", + "tags": [], + "label": "max", + "description": [], + "signature": [ + "number" + ], + "path": "packages/kbn-coloring/src/palettes/utils.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.remapStopsByNewInterval", + "type": "Function", + "tags": [], + "label": "remapStopsByNewInterval", + "description": [], + "signature": [ + "(controlStops: ", + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.ColorStop", + "text": "ColorStop" + }, + "[], {\n newInterval,\n oldInterval,\n newMin,\n oldMin,\n }: { newInterval: number; oldInterval: number; newMin: number; oldMin: number; }) => { color: string; stop: number; }[]" + ], + "path": "packages/kbn-coloring/src/palettes/utils.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.remapStopsByNewInterval.$1", + "type": "Array", + "tags": [], + "label": "controlStops", + "description": [], + "signature": [ + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.ColorStop", + "text": "ColorStop" + }, + "[]" + ], + "path": "packages/kbn-coloring/src/palettes/utils.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.remapStopsByNewInterval.$2", + "type": "Object", + "tags": [], + "label": "{\n newInterval,\n oldInterval,\n newMin,\n oldMin,\n }", + "description": [], + "path": "packages/kbn-coloring/src/palettes/utils.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.remapStopsByNewInterval.$2.newInterval", + "type": "number", + "tags": [], + "label": "newInterval", + "description": [], + "path": "packages/kbn-coloring/src/palettes/utils.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.remapStopsByNewInterval.$2.oldInterval", + "type": "number", + "tags": [], + "label": "oldInterval", + "description": [], + "path": "packages/kbn-coloring/src/palettes/utils.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.remapStopsByNewInterval.$2.newMin", + "type": "number", + "tags": [], + "label": "newMin", + "description": [], + "path": "packages/kbn-coloring/src/palettes/utils.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.remapStopsByNewInterval.$2.oldMin", + "type": "number", + "tags": [], + "label": "oldMin", + "description": [], + "path": "packages/kbn-coloring/src/palettes/utils.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.reversePalette", + "type": "Function", + "tags": [], + "label": "reversePalette", + "description": [], + "signature": [ + "(paletteColorRepresentation: ", + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.ColorStop", + "text": "ColorStop" + }, + "[]) => { color: string; stop: number; }[]" + ], + "path": "packages/kbn-coloring/src/palettes/utils.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.reversePalette.$1", + "type": "Array", + "tags": [], + "label": "paletteColorRepresentation", + "description": [], + "signature": [ + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.ColorStop", + "text": "ColorStop" + }, + "[]" + ], + "path": "packages/kbn-coloring/src/palettes/utils.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.roundValue", + "type": "Function", + "tags": [], + "label": "roundValue", + "description": [], + "signature": [ + "(value: number, fractionDigits: number) => number" + ], + "path": "packages/kbn-coloring/src/palettes/utils.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.roundValue.$1", + "type": "number", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "number" + ], + "path": "packages/kbn-coloring/src/palettes/utils.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.roundValue.$2", + "type": "number", + "tags": [], + "label": "fractionDigits", + "description": [], + "signature": [ + "number" + ], + "path": "packages/kbn-coloring/src/palettes/utils.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.shiftPalette", + "type": "Function", + "tags": [], + "label": "shiftPalette", + "description": [], + "signature": [ + "(stops: ", + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.ColorStop", + "text": "ColorStop" + }, + "[], max: number) => { stop: number; color: string; }[]" + ], + "path": "packages/kbn-coloring/src/palettes/utils.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.shiftPalette.$1", + "type": "Array", + "tags": [], + "label": "stops", + "description": [], + "signature": [ + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.ColorStop", + "text": "ColorStop" + }, + "[]" + ], + "path": "packages/kbn-coloring/src/palettes/utils.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.shiftPalette.$2", + "type": "number", + "tags": [], + "label": "max", + "description": [], + "signature": [ + "number" + ], + "path": "packages/kbn-coloring/src/palettes/utils.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.ChartColorConfiguration", + "type": "Interface", + "tags": [], + "label": "ChartColorConfiguration", + "description": [ + "\nInformation about the structure of a chart to determine the color of a series within it." + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.ChartColorConfiguration.totalSeries", + "type": "number", + "tags": [], + "label": "totalSeries", + "description": [ + "\nOverall number of series in the current chart" + ], + "signature": [ + "number | undefined" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.ChartColorConfiguration.maxDepth", + "type": "number", + "tags": [], + "label": "maxDepth", + "description": [ + "\nMax nesting depth of the series tree" + ], + "signature": [ + "number | undefined" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.ChartColorConfiguration.behindText", + "type": "CompoundType", + "tags": [], + "label": "behindText", + "description": [ + "\nFlag whether the color will be used behind text. The palette can use this information to\nadjust colors for better a11y. Might be ignored depending on the palette." + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.ChartColorConfiguration.syncColors", + "type": "CompoundType", + "tags": [], + "label": "syncColors", + "description": [ + "\nFlag whether a color assignment to a given key should be remembered and re-used the next time the key shows up.\nThis setting might be ignored based on the palette." + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.ColorStop", + "type": "Interface", + "tags": [], + "label": "ColorStop", + "description": [], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.ColorStop.color", + "type": "string", + "tags": [], + "label": "color", + "description": [], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.ColorStop.stop", + "type": "number", + "tags": [], + "label": "stop", + "description": [], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.CustomPaletteParams", + "type": "Interface", + "tags": [], + "label": "CustomPaletteParams", + "description": [], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.CustomPaletteParams.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.CustomPaletteParams.reverse", + "type": "CompoundType", + "tags": [], + "label": "reverse", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.CustomPaletteParams.rangeType", + "type": "CompoundType", + "tags": [], + "label": "rangeType", + "description": [], + "signature": [ + "\"number\" | \"percent\" | undefined" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.CustomPaletteParams.continuity", + "type": "CompoundType", + "tags": [], + "label": "continuity", + "description": [], + "signature": [ + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.PaletteContinuity", + "text": "PaletteContinuity" + }, + " | undefined" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.CustomPaletteParams.progression", + "type": "string", + "tags": [], + "label": "progression", + "description": [], + "signature": [ + "\"fixed\" | undefined" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.CustomPaletteParams.rangeMin", + "type": "number", + "tags": [], + "label": "rangeMin", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.CustomPaletteParams.rangeMax", + "type": "number", + "tags": [], + "label": "rangeMax", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.CustomPaletteParams.stops", + "type": "Array", + "tags": [], + "label": "stops", + "description": [], + "signature": [ + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.ColorStop", + "text": "ColorStop" + }, + "[] | undefined" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.CustomPaletteParams.colorStops", + "type": "Array", + "tags": [], + "label": "colorStops", + "description": [], + "signature": [ + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.ColorStop", + "text": "ColorStop" + }, + "[] | undefined" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.CustomPaletteParams.steps", + "type": "number", + "tags": [], + "label": "steps", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.CustomPaletteParams.maxSteps", + "type": "number", + "tags": [], + "label": "maxSteps", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.DataBounds", + "type": "Interface", + "tags": [], + "label": "DataBounds", + "description": [], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.DataBounds.min", + "type": "number", + "tags": [], + "label": "min", + "description": [], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.DataBounds.max", + "type": "number", + "tags": [], + "label": "max", + "description": [], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.DataBounds.fallback", + "type": "CompoundType", + "tags": [], + "label": "fallback", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.PaletteDefinition", + "type": "Interface", + "tags": [], + "label": "PaletteDefinition", + "description": [ + "\nDefinition of a global palette.\n\nA palette controls the appearance of Lens charts on an editor level.\nThe palette wont get reset when switching charts.\n\nA palette can hold internal state (e.g. for customizations) and also includes\nan editor component to edit the internal state." + ], + "signature": [ + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.PaletteDefinition", + "text": "PaletteDefinition" + }, + "" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.PaletteDefinition.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "\nUnique id of the palette (this will be persisted along with the visualization state)" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.PaletteDefinition.title", + "type": "string", + "tags": [], + "label": "title", + "description": [ + "\nUser facing title (should be i18n-ized)" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.PaletteDefinition.internal", + "type": "CompoundType", + "tags": [], + "label": "internal", + "description": [ + "\nFlag indicating whether users should be able to pick this palette manually." + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.PaletteDefinition.toExpression", + "type": "Function", + "tags": [], + "label": "toExpression", + "description": [ + "\nSerialize the internal state of the palette into an expression function.\nThis function should be used to pass the palette to the expression function applying color and other styles" + ], + "signature": [ + "(state?: T | undefined) => ", + "Ast" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.PaletteDefinition.toExpression.$1", + "type": "Uncategorized", + "tags": [], + "label": "state", + "description": [ + "The internal state of the palette" + ], + "signature": [ + "T | undefined" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.PaletteDefinition.getCategoricalColor", + "type": "Function", + "tags": [], + "label": "getCategoricalColor", + "description": [ + "\nColor a series according to the internal rules of the palette." + ], + "signature": [ + "(series: ", + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.SeriesLayer", + "text": "SeriesLayer" + }, + "[], chartConfiguration?: ", + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.ChartColorConfiguration", + "text": "ChartColorConfiguration" + }, + " | undefined, state?: T | undefined) => string | null" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.PaletteDefinition.getCategoricalColor.$1", + "type": "Array", + "tags": [], + "label": "series", + "description": [ + "The current series along with its ancestors." + ], + "signature": [ + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.SeriesLayer", + "text": "SeriesLayer" + }, + "[]" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.PaletteDefinition.getCategoricalColor.$2", + "type": "Object", + "tags": [], + "label": "chartConfiguration", + "description": [], + "signature": [ + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.ChartColorConfiguration", + "text": "ChartColorConfiguration" + }, + " | undefined" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.PaletteDefinition.getCategoricalColor.$3", + "type": "Uncategorized", + "tags": [], + "label": "state", + "description": [ + "The internal state of the palette" + ], + "signature": [ + "T | undefined" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.PaletteDefinition.getCategoricalColors", + "type": "Function", + "tags": [], + "label": "getCategoricalColors", + "description": [ + "\nGet a spectrum of colors of the current palette.\nThis can be used if the chart wants to control color assignment locally." + ], + "signature": [ + "(size: number, state?: T | undefined) => string[]" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.PaletteDefinition.getCategoricalColors.$1", + "type": "number", + "tags": [], + "label": "size", + "description": [], + "signature": [ + "number" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.PaletteDefinition.getCategoricalColors.$2", + "type": "Uncategorized", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "T | undefined" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.PaletteDefinition.canDynamicColoring", + "type": "CompoundType", + "tags": [], + "label": "canDynamicColoring", + "description": [ + "\nDefine whether a palette supports dynamic coloring (i.e. gradient colors mapped to number values)" + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.PaletteDefinition.getColorForValue", + "type": "Function", + "tags": [], + "label": "getColorForValue", + "description": [ + "\nGet the assigned color for the given value based on its data domain and state settings.\nThis can be used for dynamic coloring based on uniform color distribution or custom stops." + ], + "signature": [ + "((value: number | undefined, state: T, { min, max }: { min: number; max: number; }) => string | undefined) | undefined" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.PaletteDefinition.getColorForValue.$1", + "type": "number", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.PaletteDefinition.getColorForValue.$2", + "type": "Uncategorized", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "T" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.PaletteDefinition.getColorForValue.$3", + "type": "Object", + "tags": [], + "label": "{ min, max }", + "description": [], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.PaletteDefinition.getColorForValue.$3.min", + "type": "number", + "tags": [], + "label": "min", + "description": [], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.PaletteDefinition.getColorForValue.$3.max", + "type": "number", + "tags": [], + "label": "max", + "description": [], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.PaletteOutput", + "type": "Interface", + "tags": [], + "label": "PaletteOutput", + "description": [], + "signature": [ + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.PaletteOutput", + "text": "PaletteOutput" + }, + "" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.PaletteOutput.type", + "type": "CompoundType", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"system_palette\" | \"palette\"" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.PaletteOutput.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.PaletteOutput.params", + "type": "Uncategorized", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "T | undefined" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.PaletteRegistry", + "type": "Interface", + "tags": [], + "label": "PaletteRegistry", + "description": [], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.PaletteRegistry.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [], + "signature": [ + "(name: string) => ", + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.PaletteDefinition", + "text": "PaletteDefinition" + }, + "" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.PaletteRegistry.get.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.PaletteRegistry.getAll", + "type": "Function", + "tags": [], + "label": "getAll", + "description": [], + "signature": [ + "() => ", + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.PaletteDefinition", + "text": "PaletteDefinition" + }, + "[]" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.SeriesLayer", + "type": "Interface", + "tags": [], + "label": "SeriesLayer", + "description": [ + "\nInformation about a series in a chart used to determine its color.\nSeries layers can be nested, this means each series layer can have an ancestor." + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.SeriesLayer.name", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "\nName of the series (can be used for lookup-based coloring)" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.SeriesLayer.rankAtDepth", + "type": "number", + "tags": [], + "label": "rankAtDepth", + "description": [ + "\nRank of the series compared to siblings with the same ancestor" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.SeriesLayer.totalSeriesAtDepth", + "type": "number", + "tags": [], + "label": "totalSeriesAtDepth", + "description": [ + "\nTotal number of series with the same ancestor" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.CUSTOM_PALETTE", + "type": "string", + "tags": [], + "label": "CUSTOM_PALETTE", + "description": [], + "signature": [ + "\"custom\"" + ], + "path": "packages/kbn-coloring/src/palettes/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.DEFAULT_COLOR_STEPS", + "type": "number", + "tags": [], + "label": "DEFAULT_COLOR_STEPS", + "description": [], + "signature": [ + "5" + ], + "path": "packages/kbn-coloring/src/palettes/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.DEFAULT_CONTINUITY", + "type": "string", + "tags": [], + "label": "DEFAULT_CONTINUITY", + "description": [], + "signature": [ + "\"above\"" + ], + "path": "packages/kbn-coloring/src/palettes/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.DEFAULT_MAX_STOP", + "type": "number", + "tags": [], + "label": "DEFAULT_MAX_STOP", + "description": [], + "signature": [ + "100" + ], + "path": "packages/kbn-coloring/src/palettes/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.DEFAULT_MIN_STOP", + "type": "number", + "tags": [], + "label": "DEFAULT_MIN_STOP", + "description": [], + "signature": [ + "0" + ], + "path": "packages/kbn-coloring/src/palettes/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.DEFAULT_PALETTE_NAME", + "type": "string", + "tags": [], + "label": "DEFAULT_PALETTE_NAME", + "description": [], + "signature": [ + "\"positive\"" + ], + "path": "packages/kbn-coloring/src/palettes/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.DEFAULT_RANGE_TYPE", + "type": "string", + "tags": [], + "label": "DEFAULT_RANGE_TYPE", + "description": [], + "signature": [ + "\"percent\"" + ], + "path": "packages/kbn-coloring/src/palettes/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.FIXED_PROGRESSION", + "type": "string", + "tags": [], + "label": "FIXED_PROGRESSION", + "description": [], + "signature": [ + "\"fixed\"" + ], + "path": "packages/kbn-coloring/src/palettes/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.PaletteContinuity", + "type": "Type", + "tags": [], + "label": "PaletteContinuity", + "description": [], + "signature": [ + "\"above\" | \"below\" | \"none\" | \"all\"" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/coloring", + "id": "def-common.RequiredPaletteParamTypes", + "type": "Type", + "tags": [], + "label": "RequiredPaletteParamTypes", + "description": [], + "signature": [ + "{ name: string; reverse: boolean; rangeMin: number; rangeType: \"number\" | \"percent\"; continuity: ", + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.PaletteContinuity", + "text": "PaletteContinuity" + }, + "; progression: \"fixed\"; rangeMax: number; stops: ", + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.ColorStop", + "text": "ColorStop" + }, + "[]; colorStops: ", + { + "pluginId": "@kbn/coloring", + "scope": "common", + "docId": "kibKbnColoringPluginApi", + "section": "def-common.ColorStop", + "text": "ColorStop" + }, + "[]; steps: number; maxSteps?: number | undefined; }" + ], + "path": "packages/kbn-coloring/src/palettes/types.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_coloring.mdx b/api_docs/kbn_coloring.mdx new file mode 100644 index 0000000000000..6138cd2a95837 --- /dev/null +++ b/api_docs/kbn_coloring.mdx @@ -0,0 +1,33 @@ +--- +id: kibKbnColoringPluginApi +slug: /kibana-dev-docs/api/kbn-coloring +title: "@kbn/coloring" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/coloring plugin +date: 2022-04-26 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/coloring'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnColoringObj from './kbn_coloring.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 106 | 0 | 80 | 1 | + +## Common + +### Functions + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/kbn_config.devdocs.json b/api_docs/kbn_config.devdocs.json index 383df777d15f6..f87e73f517cbe 100644 --- a/api_docs/kbn_config.devdocs.json +++ b/api_docs/kbn_config.devdocs.json @@ -55,37 +55,6 @@ } ], "functions": [ - { - "parentPluginId": "@kbn/config", - "id": "def-server.getPluginSearchPaths", - "type": "Function", - "tags": [], - "label": "getPluginSearchPaths", - "description": [], - "signature": [ - "({ rootDir, oss, examples }: SearchOptions) => string[]" - ], - "path": "packages/kbn-config/src/plugins/plugin_search_paths.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/config", - "id": "def-server.getPluginSearchPaths.$1", - "type": "Object", - "tags": [], - "label": "{ rootDir, oss, examples }", - "description": [], - "signature": [ - "SearchOptions" - ], - "path": "packages/kbn-config/src/plugins/plugin_search_paths.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, { "parentPluginId": "@kbn/config", "id": "def-server.hasConfigPathIntersection", diff --git a/api_docs/kbn_config.mdx b/api_docs/kbn_config.mdx index ae52de0962bce..1ce3218bfedb3 100644 --- a/api_docs/kbn_config.mdx +++ b/api_docs/kbn_config.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-config title: "@kbn/config" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/config plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 66 | 0 | 46 | 2 | +| 64 | 0 | 44 | 2 | ## Server diff --git a/api_docs/kbn_config_schema.devdocs.json b/api_docs/kbn_config_schema.devdocs.json index b2c350d51f4ce..b765279edb5d2 100644 --- a/api_docs/kbn_config_schema.devdocs.json +++ b/api_docs/kbn_config_schema.devdocs.json @@ -1031,6 +1031,29 @@ ], "returnComment": [] }, + { + "parentPluginId": "@kbn/config-schema", + "id": "def-server.Type.getSchemaStructure", + "type": "Function", + "tags": [], + "label": "getSchemaStructure", + "description": [], + "signature": [ + "() => ", + { + "pluginId": "@kbn/config-schema", + "scope": "server", + "docId": "kibKbnConfigSchemaPluginApi", + "section": "def-server.SchemaStructureEntry", + "text": "SchemaStructureEntry" + }, + "[]" + ], + "path": "packages/kbn-config-schema/src/types/type.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, { "parentPluginId": "@kbn/config-schema", "id": "def-server.Type.handleError", @@ -1207,7 +1230,44 @@ "initialIsOpen": false } ], - "interfaces": [], + "interfaces": [ + { + "parentPluginId": "@kbn/config-schema", + "id": "def-server.SchemaStructureEntry", + "type": "Interface", + "tags": [], + "label": "SchemaStructureEntry", + "description": [], + "path": "packages/kbn-config-schema/src/types/type.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/config-schema", + "id": "def-server.SchemaStructureEntry.path", + "type": "Array", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "string[]" + ], + "path": "packages/kbn-config-schema/src/types/type.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/config-schema", + "id": "def-server.SchemaStructureEntry.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "packages/kbn-config-schema/src/types/type.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], "enums": [], "misc": [ { diff --git a/api_docs/kbn_config_schema.mdx b/api_docs/kbn_config_schema.mdx index 2eebafa2279fe..784035631256b 100644 --- a/api_docs/kbn_config_schema.mdx +++ b/api_docs/kbn_config_schema.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-config-schema title: "@kbn/config-schema" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/config-schema plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config-schema'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 125 | 3 | 123 | 17 | +| 129 | 3 | 127 | 17 | ## Server @@ -31,6 +31,9 @@ Contact [Owner missing] for questions regarding this plugin. ### Classes +### Interfaces + + ### Consts, variables and types diff --git a/api_docs/kbn_crypto.mdx b/api_docs/kbn_crypto.mdx index de871c1b01bbd..f044e9213163c 100644 --- a/api_docs/kbn_crypto.mdx +++ b/api_docs/kbn_crypto.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-crypto title: "@kbn/crypto" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/crypto plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/crypto'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/elastic_datemath.devdocs.json b/api_docs/kbn_datemath.devdocs.json similarity index 71% rename from api_docs/elastic_datemath.devdocs.json rename to api_docs/kbn_datemath.devdocs.json index 166f816481b33..4905365143524 100644 --- a/api_docs/elastic_datemath.devdocs.json +++ b/api_docs/kbn_datemath.devdocs.json @@ -1,5 +1,5 @@ { - "id": "@elastic/datemath", + "id": "@kbn/datemath", "client": { "classes": [], "functions": [], @@ -12,7 +12,7 @@ "classes": [], "functions": [ { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.parse", "type": "Function", "tags": [], @@ -21,11 +21,11 @@ "signature": [ "(input: string, options: { roundUp?: boolean | undefined; momentInstance?: typeof moment | undefined; forceNow?: Date | undefined; }) => moment.Moment | undefined" ], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false, "children": [ { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.parse.$1", "type": "string", "tags": [], @@ -34,22 +34,22 @@ "signature": [ "string" ], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false, "isRequired": true }, { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.parse.$2", "type": "Object", "tags": [], "label": "options", "description": [], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false, "children": [ { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.parse.$2.roundUp", "type": "CompoundType", "tags": [], @@ -58,11 +58,11 @@ "signature": [ "boolean | undefined" ], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false }, { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.parse.$2.momentInstance", "type": "Function", "tags": [], @@ -71,11 +71,11 @@ "signature": [ "typeof moment | undefined" ], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false }, { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.parse.$2.forceNow", "type": "Object", "tags": [], @@ -84,7 +84,7 @@ "signature": [ "Date | undefined" ], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false } ] @@ -98,7 +98,7 @@ "enums": [], "misc": [ { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.Unit", "type": "Type", "tags": [], @@ -107,12 +107,12 @@ "signature": [ "\"y\" | \"M\" | \"w\" | \"d\" | \"h\" | \"m\" | \"s\" | \"ms\"" ], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false, "initialIsOpen": false }, { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.units", "type": "Array", "tags": [], @@ -120,20 +120,20 @@ "description": [], "signature": [ { - "pluginId": "@elastic/datemath", + "pluginId": "@kbn/datemath", "scope": "server", - "docId": "kibElasticDatemathPluginApi", + "docId": "kibKbnDatemathPluginApi", "section": "def-server.Unit", "text": "Unit" }, "[]" ], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false, "initialIsOpen": false }, { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.unitsAsc", "type": "Array", "tags": [], @@ -141,20 +141,20 @@ "description": [], "signature": [ { - "pluginId": "@elastic/datemath", + "pluginId": "@kbn/datemath", "scope": "server", - "docId": "kibElasticDatemathPluginApi", + "docId": "kibKbnDatemathPluginApi", "section": "def-server.Unit", "text": "Unit" }, "[]" ], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false, "initialIsOpen": false }, { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.unitsDesc", "type": "Array", "tags": [], @@ -162,20 +162,20 @@ "description": [], "signature": [ { - "pluginId": "@elastic/datemath", + "pluginId": "@kbn/datemath", "scope": "server", - "docId": "kibElasticDatemathPluginApi", + "docId": "kibKbnDatemathPluginApi", "section": "def-server.Unit", "text": "Unit" }, "[]" ], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false, "initialIsOpen": false }, { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.UnitsMap", "type": "Type", "tags": [], @@ -184,44 +184,44 @@ "signature": [ "{ y: { weight: number; type: \"calendar\" | \"fixed\" | \"mixed\"; base: number; }; M: { weight: number; type: \"calendar\" | \"fixed\" | \"mixed\"; base: number; }; w: { weight: number; type: \"calendar\" | \"fixed\" | \"mixed\"; base: number; }; d: { weight: number; type: \"calendar\" | \"fixed\" | \"mixed\"; base: number; }; h: { weight: number; type: \"calendar\" | \"fixed\" | \"mixed\"; base: number; }; m: { weight: number; type: \"calendar\" | \"fixed\" | \"mixed\"; base: number; }; s: { weight: number; type: \"calendar\" | \"fixed\" | \"mixed\"; base: number; }; ms: { weight: number; type: \"calendar\" | \"fixed\" | \"mixed\"; base: number; }; }" ], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false, "initialIsOpen": false } ], "objects": [ { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.unitsMap", "type": "Object", "tags": [], "label": "unitsMap", "description": [], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false, "children": [ { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.unitsMap.ms", "type": "Object", "tags": [], "label": "ms", "description": [], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false, "children": [ { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.unitsMap.ms.weight", "type": "number", "tags": [], "label": "weight", "description": [], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false }, { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.unitsMap.ms.type", "type": "string", "tags": [], @@ -230,43 +230,43 @@ "signature": [ "\"fixed\"" ], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false }, { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.unitsMap.ms.base", "type": "number", "tags": [], "label": "base", "description": [], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false } ] }, { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.unitsMap.s", "type": "Object", "tags": [], "label": "s", "description": [], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false, "children": [ { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.unitsMap.s.weight", "type": "number", "tags": [], "label": "weight", "description": [], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false }, { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.unitsMap.s.type", "type": "string", "tags": [], @@ -275,43 +275,43 @@ "signature": [ "\"fixed\"" ], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false }, { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.unitsMap.s.base", "type": "number", "tags": [], "label": "base", "description": [], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false } ] }, { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.unitsMap.m", "type": "Object", "tags": [], "label": "m", "description": [], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false, "children": [ { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.unitsMap.m.weight", "type": "number", "tags": [], "label": "weight", "description": [], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false }, { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.unitsMap.m.type", "type": "string", "tags": [], @@ -320,43 +320,43 @@ "signature": [ "\"mixed\"" ], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false }, { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.unitsMap.m.base", "type": "number", "tags": [], "label": "base", "description": [], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false } ] }, { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.unitsMap.h", "type": "Object", "tags": [], "label": "h", "description": [], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false, "children": [ { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.unitsMap.h.weight", "type": "number", "tags": [], "label": "weight", "description": [], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false }, { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.unitsMap.h.type", "type": "string", "tags": [], @@ -365,43 +365,43 @@ "signature": [ "\"mixed\"" ], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false }, { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.unitsMap.h.base", "type": "number", "tags": [], "label": "base", "description": [], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false } ] }, { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.unitsMap.d", "type": "Object", "tags": [], "label": "d", "description": [], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false, "children": [ { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.unitsMap.d.weight", "type": "number", "tags": [], "label": "weight", "description": [], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false }, { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.unitsMap.d.type", "type": "string", "tags": [], @@ -410,43 +410,43 @@ "signature": [ "\"mixed\"" ], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false }, { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.unitsMap.d.base", "type": "number", "tags": [], "label": "base", "description": [], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false } ] }, { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.unitsMap.w", "type": "Object", "tags": [], "label": "w", "description": [], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false, "children": [ { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.unitsMap.w.weight", "type": "number", "tags": [], "label": "weight", "description": [], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false }, { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.unitsMap.w.type", "type": "string", "tags": [], @@ -455,43 +455,43 @@ "signature": [ "\"calendar\"" ], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false }, { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.unitsMap.w.base", "type": "number", "tags": [], "label": "base", "description": [], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false } ] }, { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.unitsMap.M", "type": "Object", "tags": [], "label": "M", "description": [], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false, "children": [ { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.unitsMap.M.weight", "type": "number", "tags": [], "label": "weight", "description": [], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false }, { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.unitsMap.M.type", "type": "string", "tags": [], @@ -500,23 +500,23 @@ "signature": [ "\"calendar\"" ], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false }, { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.unitsMap.M.base", "type": "number", "tags": [], "label": "base", "description": [], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false } ] }, { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.unitsMap.y", "type": "Object", "tags": [], @@ -524,21 +524,21 @@ "description": [ "// q: { weight: 8, type: 'calendar' }, // TODO: moment duration does not support quarter" ], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false, "children": [ { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.unitsMap.y.weight", "type": "number", "tags": [], "label": "weight", "description": [], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false }, { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.unitsMap.y.type", "type": "string", "tags": [], @@ -547,17 +547,17 @@ "signature": [ "\"calendar\"" ], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false }, { - "parentPluginId": "@elastic/datemath", + "parentPluginId": "@kbn/datemath", "id": "def-server.unitsMap.y.base", "type": "number", "tags": [], "label": "base", "description": [], - "path": "packages/elastic-datemath/src/index.ts", + "path": "packages/kbn-datemath/src/index.ts", "deprecated": false } ] diff --git a/api_docs/elastic_datemath.mdx b/api_docs/kbn_datemath.mdx similarity index 54% rename from api_docs/elastic_datemath.mdx rename to api_docs/kbn_datemath.mdx index 14fd7fef84034..782b942ba952b 100644 --- a/api_docs/elastic_datemath.mdx +++ b/api_docs/kbn_datemath.mdx @@ -1,14 +1,14 @@ --- -id: kibElasticDatemathPluginApi -slug: /kibana-dev-docs/api/elastic-datemath -title: "@elastic/datemath" +id: kibKbnDatemathPluginApi +slug: /kibana-dev-docs/api/kbn-datemath +title: "@kbn/datemath" image: https://source.unsplash.com/400x175/?github -summary: API docs for the @elastic/datemath plugin -date: 2022-04-05 -tags: ['contributor', 'dev', 'apidocs', 'kibana', '@elastic/datemath'] +summary: API docs for the @kbn/datemath plugin +date: 2022-04-26 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/datemath'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- -import elasticDatemathObj from './elastic_datemath.devdocs.json'; +import kbnDatemathObj from './kbn_datemath.devdocs.json'; elasticsearch datemath parser, used in kibana @@ -23,11 +23,11 @@ Contact [Owner missing] for questions regarding this plugin. ## Server ### Objects - + ### Functions - + ### Consts, variables and types - + diff --git a/api_docs/kbn_dev_utils.devdocs.json b/api_docs/kbn_dev_utils.devdocs.json index c45d0515c0bb4..7ffb74a9f9220 100644 --- a/api_docs/kbn_dev_utils.devdocs.json +++ b/api_docs/kbn_dev_utils.devdocs.json @@ -12,61 +12,42 @@ "classes": [ { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsClient", + "id": "def-server.ProcRunner", "type": "Class", - "tags": [], - "label": "CiStatsClient", - "description": [], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_client.ts", + "tags": [ + "class" + ], + "label": "ProcRunner", + "description": [ + "\n Helper for starting and managing processes. In many ways it resembles the\n API from `grunt_run`, processes are named and can be started, waited for,\n backgrounded once they log something matching a RegExp...\n" + ], + "path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsClient.fromEnv", + "id": "def-server.ProcRunner.Unnamed", "type": "Function", "tags": [], - "label": "fromEnv", - "description": [ - "\nCreate a CiStatsReporter by inspecting the ENV for the necessary config" - ], + "label": "Constructor", + "description": [], "signature": [ - "(log: ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.ToolingLog", - "text": "ToolingLog" - }, - ") => ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.CiStatsClient", - "text": "CiStatsClient" - } + "any" ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_client.ts", + "path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsClient.fromEnv.$1", + "id": "def-server.ProcRunner.Unnamed.$1", "type": "Object", "tags": [], "label": "log", "description": [], "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.ToolingLog", - "text": "ToolingLog" - } + "ToolingLog" ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_client.ts", + "path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts", "deprecated": false, "isRequired": true } @@ -75,157 +56,181 @@ }, { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsClient.Unnamed", + "id": "def-server.ProcRunner.run", "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], + "tags": [ + "property", + "property", + "property", + "property", + "return" + ], + "label": "run", + "description": [ + "\n Start a process, tracking it by `name`" + ], "signature": [ - "any" + "(name: string, options: RunOptions) => Promise" ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_client.ts", + "path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsClient.Unnamed.$1", + "id": "def-server.ProcRunner.run.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/dev-utils", + "id": "def-server.ProcRunner.run.$2", "type": "Object", "tags": [], - "label": "config", + "label": "options", "description": [], "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.Config", - "text": "Config" - }, - " | undefined" + "RunOptions" ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_client.ts", + "path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsClient.isEnabled", + "id": "def-server.ProcRunner.stop", "type": "Function", "tags": [], - "label": "isEnabled", - "description": [], - "signature": [ - "() => boolean" + "label": "stop", + "description": [ + "\n Stop a named proc" ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_client.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsClient.getLatestTestGroupStats", - "type": "Function", - "tags": [], - "label": "getLatestTestGroupStats", - "description": [], "signature": [ - "(options: LatestTestGroupStatsOptions) => Promise" + "(name: string, signal?: NodeJS.Signals) => Promise" ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_client.ts", + "path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsClient.getLatestTestGroupStats.$1", - "type": "Object", + "id": "def-server.ProcRunner.stop.$1", + "type": "string", "tags": [], - "label": "options", + "label": "name", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/dev-utils", + "id": "def-server.ProcRunner.stop.$2", + "type": "CompoundType", + "tags": [], + "label": "signal", "description": [], "signature": [ - "LatestTestGroupStatsOptions" + "NodeJS.Signals" ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_client.ts", + "path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsReporter", - "type": "Class", - "tags": [], - "label": "CiStatsReporter", - "description": [ - "Object that helps report data to the ci-stats service" - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsReporter.fromEnv", + "id": "def-server.ProcRunner.waitForAllToStop", "type": "Function", - "tags": [], - "label": "fromEnv", + "tags": [ + "return" + ], + "label": "waitForAllToStop", "description": [ - "\nCreate a CiStatsReporter by inspecting the ENV for the necessary config" + "\n Wait for all running processes to stop naturally" ], "signature": [ - "(log: ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.ToolingLog", - "text": "ToolingLog" - }, - ") => ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.CiStatsReporter", - "text": "CiStatsReporter" - } + "() => Promise" + ], + "path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/dev-utils", + "id": "def-server.ProcRunner.teardown", + "type": "Function", + "tags": [ + "return" + ], + "label": "teardown", + "description": [ + "\n Close the ProcRunner and stop all running\n processes with `signal`\n" + ], + "signature": [ + "(signal?: \"exit\" | NodeJS.Signals) => Promise" ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts", + "path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsReporter.fromEnv.$1", - "type": "Object", + "id": "def-server.ProcRunner.teardown.$1", + "type": "CompoundType", "tags": [], - "label": "log", + "label": "signal", "description": [], "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.ToolingLog", - "text": "ToolingLog" - } + "\"exit\" | NodeJS.Signals" ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts", + "path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/dev-utils", + "id": "def-server.RunWithCommands", + "type": "Class", + "tags": [], + "label": "RunWithCommands", + "description": [], + "signature": [ + { + "pluginId": "@kbn/dev-utils", + "scope": "server", + "docId": "kibKbnDevUtilsPluginApi", + "section": "def-server.RunWithCommands", + "text": "RunWithCommands" }, + "" + ], + "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", + "deprecated": false, + "children": [ { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsReporter.Unnamed", + "id": "def-server.RunWithCommands.Unnamed", "type": "Function", "tags": [], "label": "Constructor", @@ -233,47 +238,48 @@ "signature": [ "any" ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts", + "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsReporter.Unnamed.$1", + "id": "def-server.RunWithCommands.Unnamed.$1", "type": "Object", "tags": [], - "label": "config", + "label": "options", "description": [], "signature": [ { "pluginId": "@kbn/dev-utils", "scope": "server", "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.Config", - "text": "Config" + "section": "def-server.RunWithCommandsOptions", + "text": "RunWithCommandsOptions" }, - " | undefined" + "" ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts", + "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", "deprecated": false, - "isRequired": false + "isRequired": true }, { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsReporter.Unnamed.$2", - "type": "Object", + "id": "def-server.RunWithCommands.Unnamed.$2", + "type": "Array", "tags": [], - "label": "log", + "label": "commands", "description": [], "signature": [ { "pluginId": "@kbn/dev-utils", "scope": "server", "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.ToolingLog", - "text": "ToolingLog" - } + "section": "def-server.Command", + "text": "Command" + }, + "[]" ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts", + "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", "deprecated": false, "isRequired": true } @@ -282,139 +288,36 @@ }, { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsReporter.isEnabled", - "type": "Function", - "tags": [], - "label": "isEnabled", - "description": [ - "\nDetermine if CI_STATS is explicitly disabled by the environment. To determine\nif the CiStatsReporter has enough information in the environment to send metrics\nfor builds use #hasBuildConfig()." - ], - "signature": [ - "() => boolean" - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsReporter.hasBuildConfig", - "type": "Function", - "tags": [], - "label": "hasBuildConfig", - "description": [ - "\nDetermines if the CiStatsReporter is disabled by the environment, or properly\nconfigured and able to send stats" - ], - "signature": [ - "() => boolean" - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsReporter.timings", + "id": "def-server.RunWithCommands.command", "type": "Function", "tags": [], - "label": "timings", - "description": [ - "\nReport timings data to the ci-stats service. If running in CI then the reporter\nwill include the buildId in the report with the access token, otherwise the timings\ndata will be recorded as anonymous timing data." - ], + "label": "command", + "description": [], "signature": [ "(options: ", { "pluginId": "@kbn/dev-utils", "scope": "server", "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.TimingsOptions", - "text": "TimingsOptions" + "section": "def-server.Command", + "text": "Command" }, - ") => Promise" - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsReporter.timings.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.TimingsOptions", - "text": "TimingsOptions" - } - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsReporter.metrics", - "type": "Function", - "tags": [], - "label": "metrics", - "description": [ - "\nReport metrics data to the ci-stats service. If running outside of CI this method\ndoes nothing as metrics can only be reported when associated with a specific CI build." - ], - "signature": [ - "(metrics: ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.CiStatsMetric", - "text": "CiStatsMetric" - }, - "[], options?: ", + ") => ", { "pluginId": "@kbn/dev-utils", "scope": "server", "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.MetricsOptions", - "text": "MetricsOptions" + "section": "def-server.RunWithCommands", + "text": "RunWithCommands" }, - " | undefined) => Promise" + "" ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts", + "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsReporter.metrics.$1", - "type": "Array", - "tags": [], - "label": "metrics", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.CiStatsMetric", - "text": "CiStatsMetric" - }, - "[]" - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsReporter.metrics.$2", + "id": "def-server.RunWithCommands.command.$1", "type": "Object", "tags": [], "label": "options", @@ -424,1968 +327,138 @@ "pluginId": "@kbn/dev-utils", "scope": "server", "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.MetricsOptions", - "text": "MetricsOptions" + "section": "def-server.Command", + "text": "Command" }, - " | undefined" + "" ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts", + "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsReporter.reportTests", + "id": "def-server.RunWithCommands.execute", "type": "Function", "tags": [], - "label": "reportTests", - "description": [ - "\nSend test reports to ci-stats" - ], + "label": "execute", + "description": [], "signature": [ - "({ group, testRuns }: ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.CiStatsReportTestsOptions", - "text": "CiStatsReportTestsOptions" - }, - ") => Promise" + "() => Promise" ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts", + "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsReporter.reportTests.$1", - "type": "Object", - "tags": [], - "label": "{ group, testRuns }", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.CiStatsReportTestsOptions", - "text": "CiStatsReportTestsOptions" - } - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts", - "deprecated": false, - "isRequired": true - } - ], + "children": [], "returnComment": [] } ], "initialIsOpen": false - }, + } + ], + "functions": [ { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ProcRunner", - "type": "Class", - "tags": [ - "class" - ], - "label": "ProcRunner", - "description": [ - "\n Helper for starting and managing processes. In many ways it resembles the\n API from `grunt_run`, processes are named and can be started, waited for,\n backgrounded once they log something matching a RegExp...\n" + "id": "def-server.combineErrors", + "type": "Function", + "tags": [], + "label": "combineErrors", + "description": [], + "signature": [ + "(errors: (Error | FailError)[]) => Error" ], - "path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts", + "path": "packages/kbn-dev-utils/src/run/fail.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ProcRunner.Unnamed", - "type": "Function", + "id": "def-server.combineErrors.$1", + "type": "Array", "tags": [], - "label": "Constructor", + "label": "errors", "description": [], "signature": [ - "any" + "(Error | FailError)[]" ], - "path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts", + "path": "packages/kbn-dev-utils/src/run/fail.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ProcRunner.Unnamed.$1", - "type": "Object", - "tags": [], - "label": "log", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.ToolingLog", - "text": "ToolingLog" - } - ], - "path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/dev-utils", + "id": "def-server.createFailError", + "type": "Function", + "tags": [], + "label": "createFailError", + "description": [], + "signature": [ + "(reason: string, options: FailErrorOptions) => FailError" + ], + "path": "packages/kbn-dev-utils/src/run/fail.ts", + "deprecated": false, + "children": [ { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ProcRunner.run", - "type": "Function", - "tags": [ - "property", - "property", - "property", - "property", - "return" - ], - "label": "run", - "description": [ - "\n Start a process, tracking it by `name`" - ], + "id": "def-server.createFailError.$1", + "type": "string", + "tags": [], + "label": "reason", + "description": [], "signature": [ - "(name: string, options: RunOptions) => Promise" + "string" ], - "path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts", + "path": "packages/kbn-dev-utils/src/run/fail.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ProcRunner.run.$1", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "signature": [ - "string" - ], - "path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ProcRunner.run.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "RunOptions" - ], - "path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "isRequired": true }, { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ProcRunner.stop", - "type": "Function", + "id": "def-server.createFailError.$2", + "type": "Object", "tags": [], - "label": "stop", - "description": [ - "\n Stop a named proc" + "label": "options", + "description": [], + "signature": [ + "FailErrorOptions" ], + "path": "packages/kbn-dev-utils/src/run/fail.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/dev-utils", + "id": "def-server.createFlagError", + "type": "Function", + "tags": [], + "label": "createFlagError", + "description": [], + "signature": [ + "(reason: string) => FailError" + ], + "path": "packages/kbn-dev-utils/src/run/fail.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/dev-utils", + "id": "def-server.createFlagError.$1", + "type": "string", + "tags": [], + "label": "reason", + "description": [], "signature": [ - "(name: string, signal?: NodeJS.Signals) => Promise" + "string" ], - "path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ProcRunner.stop.$1", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "signature": [ - "string" - ], - "path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ProcRunner.stop.$2", - "type": "CompoundType", - "tags": [], - "label": "signal", - "description": [], - "signature": [ - "NodeJS.Signals" - ], - "path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ProcRunner.waitForAllToStop", - "type": "Function", - "tags": [ - "return" - ], - "label": "waitForAllToStop", - "description": [ - "\n Wait for all running processes to stop naturally" - ], - "signature": [ - "() => Promise" - ], - "path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ProcRunner.teardown", - "type": "Function", - "tags": [ - "return" - ], - "label": "teardown", - "description": [ - "\n Close the ProcRunner and stop all running\n processes with `signal`\n" - ], - "signature": [ - "(signal?: \"exit\" | NodeJS.Signals) => Promise" - ], - "path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ProcRunner.teardown.$1", - "type": "CompoundType", - "tags": [], - "label": "signal", - "description": [], - "signature": [ - "\"exit\" | NodeJS.Signals" - ], - "path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.RunWithCommands", - "type": "Class", - "tags": [], - "label": "RunWithCommands", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.RunWithCommands", - "text": "RunWithCommands" - }, - "" - ], - "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.RunWithCommands.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], - "signature": [ - "any" - ], - "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.RunWithCommands.Unnamed.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.RunWithCommandsOptions", - "text": "RunWithCommandsOptions" - }, - "" - ], - "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.RunWithCommands.Unnamed.$2", - "type": "Array", - "tags": [], - "label": "commands", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.Command", - "text": "Command" - }, - "[]" - ], - "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.RunWithCommands.command", - "type": "Function", - "tags": [], - "label": "command", - "description": [], - "signature": [ - "(options: ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.Command", - "text": "Command" - }, - ") => ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.RunWithCommands", - "text": "RunWithCommands" - }, - "" - ], - "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.RunWithCommands.command.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.Command", - "text": "Command" - }, - "" - ], - "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.RunWithCommands.execute", - "type": "Function", - "tags": [], - "label": "execute", - "description": [], - "signature": [ - "() => Promise" - ], - "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLog", - "type": "Class", - "tags": [], - "label": "ToolingLog", - "description": [], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLog.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], - "signature": [ - "any" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLog.Unnamed.$1", - "type": "Object", - "tags": [], - "label": "writerConfig", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.ToolingLogTextWriterConfig", - "text": "ToolingLogTextWriterConfig" - }, - " | undefined" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts", - "deprecated": false, - "isRequired": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLog.Unnamed.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.ToolingLogOptions", - "text": "ToolingLogOptions" - }, - " | undefined" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLog.getIndent", - "type": "Function", - "tags": [], - "label": "getIndent", - "description": [ - "\nGet the current indentation level of the ToolingLog" - ], - "signature": [ - "() => number" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLog.indent", - "type": "Function", - "tags": [], - "label": "indent", - "description": [], - "signature": [ - "{ (delta: number): void; (delta: number, block: () => Promise): Promise; (delta: number, block: () => T): T; }" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLog.indent.$1", - "type": "number", - "tags": [], - "label": "delta", - "description": [], - "signature": [ - "number" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLog.indent.$2", - "type": "Function", - "tags": [], - "label": "block", - "description": [], - "signature": [ - "(() => T | Promise) | undefined" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLog.verbose", - "type": "Function", - "tags": [], - "label": "verbose", - "description": [], - "signature": [ - "(...args: any[]) => void" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLog.verbose.$1", - "type": "Array", - "tags": [], - "label": "args", - "description": [], - "signature": [ - "any[]" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLog.debug", - "type": "Function", - "tags": [], - "label": "debug", - "description": [], - "signature": [ - "(...args: any[]) => void" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLog.debug.$1", - "type": "Array", - "tags": [], - "label": "args", - "description": [], - "signature": [ - "any[]" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLog.info", - "type": "Function", - "tags": [], - "label": "info", - "description": [], - "signature": [ - "(...args: any[]) => void" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLog.info.$1", - "type": "Array", - "tags": [], - "label": "args", - "description": [], - "signature": [ - "any[]" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLog.success", - "type": "Function", - "tags": [], - "label": "success", - "description": [], - "signature": [ - "(...args: any[]) => void" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLog.success.$1", - "type": "Array", - "tags": [], - "label": "args", - "description": [], - "signature": [ - "any[]" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLog.warning", - "type": "Function", - "tags": [], - "label": "warning", - "description": [], - "signature": [ - "(...args: any[]) => void" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLog.warning.$1", - "type": "Array", - "tags": [], - "label": "args", - "description": [], - "signature": [ - "any[]" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLog.error", - "type": "Function", - "tags": [], - "label": "error", - "description": [], - "signature": [ - "(error: string | Error) => void" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLog.error.$1", - "type": "CompoundType", - "tags": [], - "label": "error", - "description": [], - "signature": [ - "string | Error" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLog.write", - "type": "Function", - "tags": [], - "label": "write", - "description": [], - "signature": [ - "(...args: any[]) => void" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLog.write.$1", - "type": "Array", - "tags": [], - "label": "args", - "description": [], - "signature": [ - "any[]" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLog.getWriters", - "type": "Function", - "tags": [], - "label": "getWriters", - "description": [], - "signature": [ - "() => ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.Writer", - "text": "Writer" - }, - "[]" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLog.setWriters", - "type": "Function", - "tags": [], - "label": "setWriters", - "description": [], - "signature": [ - "(writers: ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.Writer", - "text": "Writer" - }, - "[]) => void" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLog.setWriters.$1", - "type": "Array", - "tags": [], - "label": "writers", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.Writer", - "text": "Writer" - }, - "[]" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLog.getWritten$", - "type": "Function", - "tags": [], - "label": "getWritten$", - "description": [], - "signature": [ - "() => ", - "Observable", - "<", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.Message", - "text": "Message" - }, - ">" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLog.withType", - "type": "Function", - "tags": [], - "label": "withType", - "description": [ - "\nCreate a new ToolingLog which sets a different \"type\", allowing messages to be filtered out by \"source\"" - ], - "signature": [ - "(type: string) => ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.ToolingLog", - "text": "ToolingLog" - } - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLog.withType.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [ - "A string that will be passed along with messages from this logger which can be used to filter messages with `ignoreSources`" - ], - "signature": [ - "string" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLogCollectingWriter", - "type": "Class", - "tags": [], - "label": "ToolingLogCollectingWriter", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.ToolingLogCollectingWriter", - "text": "ToolingLogCollectingWriter" - }, - " extends ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.ToolingLogTextWriter", - "text": "ToolingLogTextWriter" - } - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_collecting_writer.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLogCollectingWriter.messages", - "type": "Array", - "tags": [], - "label": "messages", - "description": [], - "signature": [ - "string[]" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_collecting_writer.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLogCollectingWriter.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], - "signature": [ - "any" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_collecting_writer.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLogCollectingWriter.Unnamed.$1", - "type": "CompoundType", - "tags": [], - "label": "level", - "description": [], - "signature": [ - "\"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\"" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_collecting_writer.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLogCollectingWriter.write", - "type": "Function", - "tags": [], - "label": "write", - "description": [ - "\nCalled by ToolingLog, extends messages with the source if message includes one." - ], - "signature": [ - "(msg: ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.Message", - "text": "Message" - }, - ") => boolean" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_collecting_writer.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLogCollectingWriter.write.$1", - "type": "Object", - "tags": [], - "label": "msg", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.Message", - "text": "Message" - } - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_collecting_writer.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLogTextWriter", - "type": "Class", - "tags": [], - "label": "ToolingLogTextWriter", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.ToolingLogTextWriter", - "text": "ToolingLogTextWriter" - }, - " implements ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.Writer", - "text": "Writer" - } - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_text_writer.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLogTextWriter.level", - "type": "Object", - "tags": [], - "label": "level", - "description": [], - "signature": [ - "{ name: \"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\"; flags: { error: boolean; info: boolean; success: boolean; warning: boolean; debug: boolean; silent: boolean; verbose: boolean; }; }" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_text_writer.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLogTextWriter.writeTo", - "type": "Object", - "tags": [], - "label": "writeTo", - "description": [], - "signature": [ - "{ write(msg: string): void; }" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_text_writer.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLogTextWriter.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], - "signature": [ - "any" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_text_writer.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLogTextWriter.Unnamed.$1", - "type": "Object", - "tags": [], - "label": "config", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.ToolingLogTextWriterConfig", - "text": "ToolingLogTextWriterConfig" - } - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_text_writer.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLogTextWriter.write", - "type": "Function", - "tags": [], - "label": "write", - "description": [], - "signature": [ - "(msg: ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.Message", - "text": "Message" - }, - ") => boolean" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_text_writer.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLogTextWriter.write.$1", - "type": "Object", - "tags": [], - "label": "msg", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.Message", - "text": "Message" - } - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_text_writer.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLogTextWriter.write", - "type": "Function", - "tags": [], - "label": "write", - "description": [], - "signature": [ - "(writeTo: { write(msg: string): void; }, prefix: string, msg: ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.Message", - "text": "Message" - }, - ") => void" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_text_writer.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLogTextWriter.write.$1", - "type": "Object", - "tags": [], - "label": "writeTo", - "description": [], - "signature": [ - "{ write(msg: string): void; }" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_text_writer.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLogTextWriter.write.$2", - "type": "string", - "tags": [], - "label": "prefix", - "description": [], - "signature": [ - "string" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_text_writer.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLogTextWriter.write.$3", - "type": "Object", - "tags": [], - "label": "msg", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.Message", - "text": "Message" - } - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_text_writer.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - } - ], - "functions": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.combineErrors", - "type": "Function", - "tags": [], - "label": "combineErrors", - "description": [], - "signature": [ - "(errors: (Error | FailError)[]) => Error" - ], - "path": "packages/kbn-dev-utils/src/run/fail.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.combineErrors.$1", - "type": "Array", - "tags": [], - "label": "errors", - "description": [], - "signature": [ - "(Error | FailError)[]" - ], - "path": "packages/kbn-dev-utils/src/run/fail.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.createAbsolutePathSerializer", - "type": "Function", - "tags": [], - "label": "createAbsolutePathSerializer", - "description": [], - "signature": [ - "(rootPath: string, replacement: string) => { test: (value: any) => boolean; serialize: (value: string) => string; }" - ], - "path": "packages/kbn-dev-utils/src/serializers/absolute_path_serializer.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.createAbsolutePathSerializer.$1", - "type": "string", - "tags": [], - "label": "rootPath", - "description": [], - "signature": [ - "string" - ], - "path": "packages/kbn-dev-utils/src/serializers/absolute_path_serializer.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.createAbsolutePathSerializer.$2", - "type": "string", - "tags": [], - "label": "replacement", - "description": [], - "signature": [ - "string" - ], - "path": "packages/kbn-dev-utils/src/serializers/absolute_path_serializer.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.createAnyInstanceSerializer", - "type": "Function", - "tags": [], - "label": "createAnyInstanceSerializer", - "description": [], - "signature": [ - "(Class: Function, name: string | ((instance: any) => string) | undefined) => { test: (v: any) => boolean; serialize: (v: any) => string; }" - ], - "path": "packages/kbn-dev-utils/src/serializers/any_instance_serizlizer.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.createAnyInstanceSerializer.$1", - "type": "Object", - "tags": [], - "label": "Class", - "description": [], - "signature": [ - "Function" - ], - "path": "packages/kbn-dev-utils/src/serializers/any_instance_serizlizer.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.createAnyInstanceSerializer.$2", - "type": "CompoundType", - "tags": [], - "label": "name", - "description": [], - "signature": [ - "string | ((instance: any) => string) | undefined" - ], - "path": "packages/kbn-dev-utils/src/serializers/any_instance_serizlizer.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.createFailError", - "type": "Function", - "tags": [], - "label": "createFailError", - "description": [], - "signature": [ - "(reason: string, options: FailErrorOptions) => FailError" - ], - "path": "packages/kbn-dev-utils/src/run/fail.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.createFailError.$1", - "type": "string", - "tags": [], - "label": "reason", - "description": [], - "signature": [ - "string" - ], - "path": "packages/kbn-dev-utils/src/run/fail.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.createFailError.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "FailErrorOptions" - ], - "path": "packages/kbn-dev-utils/src/run/fail.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.createFlagError", - "type": "Function", - "tags": [], - "label": "createFlagError", - "description": [], - "signature": [ - "(reason: string) => FailError" - ], - "path": "packages/kbn-dev-utils/src/run/fail.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.createFlagError.$1", - "type": "string", - "tags": [], - "label": "reason", - "description": [], - "signature": [ - "string" - ], - "path": "packages/kbn-dev-utils/src/run/fail.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.createRecursiveSerializer", - "type": "Function", - "tags": [], - "label": "createRecursiveSerializer", - "description": [], - "signature": [ - "(test: (v: any) => boolean, print: (v: any, printRaw: (v: string) => RawPrint) => string | RawPrint) => { test: (v: any) => boolean; serialize: (v: any, ...rest: any[]) => any; }" - ], - "path": "packages/kbn-dev-utils/src/serializers/recursive_serializer.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.createRecursiveSerializer.$1", - "type": "Function", - "tags": [], - "label": "test", - "description": [], - "signature": [ - "(v: any) => boolean" - ], - "path": "packages/kbn-dev-utils/src/serializers/recursive_serializer.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.createRecursiveSerializer.$2", - "type": "Function", - "tags": [], - "label": "print", - "description": [], - "signature": [ - "(v: any, printRaw: (v: string) => RawPrint) => string | RawPrint" - ], - "path": "packages/kbn-dev-utils/src/serializers/recursive_serializer.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.createReplaceSerializer", - "type": "Function", - "tags": [], - "label": "createReplaceSerializer", - "description": [], - "signature": [ - "(toReplace: string | RegExp, replaceWith: string | Replacer) => { test: (v: any) => boolean; serialize: (v: any, ...rest: any[]) => any; }" - ], - "path": "packages/kbn-dev-utils/src/serializers/replace_serializer.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.createReplaceSerializer.$1", - "type": "CompoundType", - "tags": [], - "label": "toReplace", - "description": [], - "signature": [ - "string | RegExp" - ], - "path": "packages/kbn-dev-utils/src/serializers/replace_serializer.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.createReplaceSerializer.$2", - "type": "CompoundType", - "tags": [], - "label": "replaceWith", - "description": [], - "signature": [ - "string | Replacer" - ], - "path": "packages/kbn-dev-utils/src/serializers/replace_serializer.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.createStripAnsiSerializer", - "type": "Function", - "tags": [], - "label": "createStripAnsiSerializer", - "description": [], - "signature": [ - "() => { test: (v: any) => boolean; serialize: (v: any, ...rest: any[]) => any; }" - ], - "path": "packages/kbn-dev-utils/src/serializers/strip_ansi_serializer.ts", - "deprecated": false, - "children": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.diffStrings", - "type": "Function", - "tags": [], - "label": "diffStrings", - "description": [ - "\nProduces a diff string which is nicely formatted to show the differences between two strings. This will\nbe a multi-line string so it's generally a good idea to include a `\\n` before this first line of the diff\nif you are concatenating it with another message." - ], - "signature": [ - "(expected: string, received: string) => string | undefined" - ], - "path": "packages/kbn-dev-utils/src/diff_strings.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.diffStrings.$1", - "type": "string", - "tags": [], - "label": "expected", - "description": [], - "signature": [ - "string" - ], - "path": "packages/kbn-dev-utils/src/diff_strings.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.diffStrings.$2", - "type": "string", - "tags": [], - "label": "received", - "description": [], - "signature": [ - "string" - ], - "path": "packages/kbn-dev-utils/src/diff_strings.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.extract", - "type": "Function", - "tags": [], - "label": "extract", - "description": [ - "\nExtract tar and zip archives using a single function, supporting stripComponents\nfor both archive types, only tested with familiar archives we create so might not\nsupport some weird exotic zip features we don't use in our own snapshot/build tooling" - ], - "signature": [ - "({\n archivePath,\n targetDir,\n stripComponents = 0,\n setModifiedTimes,\n}: Options) => Promise" - ], - "path": "packages/kbn-dev-utils/src/extract.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.extract.$1", - "type": "Object", - "tags": [], - "label": "{\n archivePath,\n targetDir,\n stripComponents = 0,\n setModifiedTimes,\n}", - "description": [], - "signature": [ - "Options" - ], - "path": "packages/kbn-dev-utils/src/extract.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.getFlags", - "type": "Function", - "tags": [], - "label": "getFlags", - "description": [], - "signature": [ - "(argv: string[], flagOptions: ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.FlagOptions", - "text": "FlagOptions" - }, - " | undefined, defaultLogLevel: string) => ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.Flags", - "text": "Flags" - } - ], - "path": "packages/kbn-dev-utils/src/run/flags.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.getFlags.$1", - "type": "Array", - "tags": [], - "label": "argv", - "description": [], - "signature": [ - "string[]" - ], - "path": "packages/kbn-dev-utils/src/run/flags.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.getFlags.$2", - "type": "Object", - "tags": [], - "label": "flagOptions", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.FlagOptions", - "text": "FlagOptions" - }, - " | undefined" - ], - "path": "packages/kbn-dev-utils/src/run/flags.ts", - "deprecated": false, - "isRequired": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.getFlags.$3", - "type": "string", - "tags": [], - "label": "defaultLogLevel", - "description": [], - "signature": [ - "string" - ], - "path": "packages/kbn-dev-utils/src/run/flags.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.getTimeReporter", - "type": "Function", - "tags": [], - "label": "getTimeReporter", - "description": [], - "signature": [ - "(log: ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.ToolingLog", - "text": "ToolingLog" - }, - ", group: string) => (startTime: number, id: string, meta: Record) => Promise" - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/report_time.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.getTimeReporter.$1", - "type": "Object", - "tags": [], - "label": "log", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.ToolingLog", - "text": "ToolingLog" - } - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/report_time.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.getTimeReporter.$2", - "type": "string", - "tags": [], - "label": "group", - "description": [], - "signature": [ - "string" - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/report_time.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.isAxiosRequestError", - "type": "Function", - "tags": [], - "label": "isAxiosRequestError", - "description": [], - "signature": [ - "(error: any) => error is ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.AxiosRequestError", - "text": "AxiosRequestError" - } - ], - "path": "packages/kbn-dev-utils/src/axios/errors.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.isAxiosRequestError.$1", - "type": "Any", - "tags": [], - "label": "error", - "description": [], - "signature": [ - "any" - ], - "path": "packages/kbn-dev-utils/src/axios/errors.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.isAxiosResponseError", - "type": "Function", - "tags": [], - "label": "isAxiosResponseError", - "description": [], - "signature": [ - "(error: any) => error is ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.AxiosResponseError", - "text": "AxiosResponseError" - }, - "" - ], - "path": "packages/kbn-dev-utils/src/axios/errors.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.isAxiosResponseError.$1", - "type": "Any", - "tags": [], - "label": "error", - "description": [], - "signature": [ - "any" - ], - "path": "packages/kbn-dev-utils/src/axios/errors.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.isFailError", - "type": "Function", - "tags": [], - "label": "isFailError", - "description": [], - "signature": [ - "(error: any) => boolean" - ], - "path": "packages/kbn-dev-utils/src/run/fail.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.isFailError.$1", - "type": "Any", - "tags": [], - "label": "error", - "description": [], - "signature": [ - "any" - ], - "path": "packages/kbn-dev-utils/src/run/fail.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.mergeFlagOptions", - "type": "Function", - "tags": [], - "label": "mergeFlagOptions", - "description": [], - "signature": [ - "(global: ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.FlagOptions", - "text": "FlagOptions" - }, - ", local: ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.FlagOptions", - "text": "FlagOptions" - }, - ") => ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.FlagOptions", - "text": "FlagOptions" - } - ], - "path": "packages/kbn-dev-utils/src/run/flags.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.mergeFlagOptions.$1", - "type": "Object", - "tags": [], - "label": "global", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.FlagOptions", - "text": "FlagOptions" - } - ], - "path": "packages/kbn-dev-utils/src/run/flags.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.mergeFlagOptions.$2", - "type": "Object", - "tags": [], - "label": "local", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.FlagOptions", - "text": "FlagOptions" - } - ], - "path": "packages/kbn-dev-utils/src/run/flags.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.observeLines", - "type": "Function", - "tags": [ - "return" - ], - "label": "observeLines", - "description": [ - "\n Creates an Observable from a Readable Stream that:\n - splits data from `readable` into lines\n - completes when `readable` emits \"end\"\n - fails if `readable` emits \"errors\"\n" - ], - "signature": [ - "(readable: ", - "Readable", - ") => ", - "Observable", - "" - ], - "path": "packages/kbn-dev-utils/src/stdio/observe_lines.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.observeLines.$1", - "type": "Object", - "tags": [], - "label": "readable", - "description": [], - "signature": [ - "Readable" - ], - "path": "packages/kbn-dev-utils/src/stdio/observe_lines.ts", + "path": "packages/kbn-dev-utils/src/run/fail.ts", "deprecated": false, "isRequired": true } @@ -2395,315 +468,44 @@ }, { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.observeReadable", + "id": "def-server.diffStrings", "type": "Function", "tags": [], - "label": "observeReadable", + "label": "diffStrings", "description": [ - "\n Produces an Observable from a ReadableSteam that:\n - completes on the first \"end\" event\n - fails on the first \"error\" event" - ], - "signature": [ - "(readable: ", - "Readable", - ") => ", - "Observable", - "" - ], - "path": "packages/kbn-dev-utils/src/stdio/observe_readable.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.observeReadable.$1", - "type": "Object", - "tags": [], - "label": "readable", - "description": [], - "signature": [ - "Readable" - ], - "path": "packages/kbn-dev-utils/src/stdio/observe_readable.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.parseLogLevel", - "type": "Function", - "tags": [], - "label": "parseLogLevel", - "description": [], - "signature": [ - "(name: \"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\") => { name: \"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\"; flags: { error: boolean; info: boolean; success: boolean; warning: boolean; debug: boolean; silent: boolean; verbose: boolean; }; }" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/log_levels.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.parseLogLevel.$1", - "type": "CompoundType", - "tags": [], - "label": "name", - "description": [], - "signature": [ - "\"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\"" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/log_levels.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.pickLevelFromFlags", - "type": "Function", - "tags": [], - "label": "pickLevelFromFlags", - "description": [], - "signature": [ - "(flags: Record, options: { default?: \"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\" | undefined; }) => \"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\"" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/log_levels.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.pickLevelFromFlags.$1", - "type": "Object", - "tags": [], - "label": "flags", - "description": [], - "signature": [ - "Record" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/log_levels.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.pickLevelFromFlags.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "path": "packages/kbn-dev-utils/src/tooling_log/log_levels.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.pickLevelFromFlags.$2.default", - "type": "CompoundType", - "tags": [], - "label": "default", - "description": [], - "signature": [ - "\"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\" | undefined" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/log_levels.ts", - "deprecated": false - } - ] - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.run", - "type": "Function", - "tags": [], - "label": "run", - "description": [], - "signature": [ - "(fn: ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.RunFn", - "text": "RunFn" - }, - ", options: ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.RunOptions", - "text": "RunOptions" - }, - ") => Promise" - ], - "path": "packages/kbn-dev-utils/src/run/run.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.run.$1", - "type": "Function", - "tags": [], - "label": "fn", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.RunFn", - "text": "RunFn" - } - ], - "path": "packages/kbn-dev-utils/src/run/run.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.run.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.RunOptions", - "text": "RunOptions" - } - ], - "path": "packages/kbn-dev-utils/src/run/run.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.runPluginListCli", - "type": "Function", - "tags": [], - "label": "runPluginListCli", - "description": [], - "signature": [ - "() => void" - ], - "path": "packages/kbn-dev-utils/src/plugin_list/run_plugin_list_cli.ts", - "deprecated": false, - "children": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.runUpdateVscodeConfigCli", - "type": "Function", - "tags": [], - "label": "runUpdateVscodeConfigCli", - "description": [], - "signature": [ - "() => void" - ], - "path": "packages/kbn-dev-utils/src/vscode_config/update_vscode_config_cli.ts", - "deprecated": false, - "children": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.shipCiStatsCli", - "type": "Function", - "tags": [], - "label": "shipCiStatsCli", - "description": [], - "signature": [ - "() => void" + "\nProduces a diff string which is nicely formatted to show the differences between two strings. This will\nbe a multi-line string so it's generally a good idea to include a `\\n` before this first line of the diff\nif you are concatenating it with another message." ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ship_ci_stats_cli.ts", - "deprecated": false, - "children": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.sortPackageJson", - "type": "Function", - "tags": [], - "label": "sortPackageJson", - "description": [], "signature": [ - "(json: string) => string" + "(expected: string, received: string) => string | undefined" ], - "path": "packages/kbn-dev-utils/src/sort_package_json.ts", + "path": "packages/kbn-dev-utils/src/diff_strings.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.sortPackageJson.$1", + "id": "def-server.diffStrings.$1", "type": "string", "tags": [], - "label": "json", + "label": "expected", "description": [], "signature": [ "string" ], - "path": "packages/kbn-dev-utils/src/sort_package_json.ts", + "path": "packages/kbn-dev-utils/src/diff_strings.ts", "deprecated": false, "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.transformFileStream", - "type": "Function", - "tags": [], - "label": "transformFileStream", - "description": [ - "\nCreate a transform stream that processes Vinyl fs streams and\ncalls a function for each file, allowing the function to either\nmutate the file, replace it with another file (return a new File\nobject), or drop it from the stream (return null)" - ], - "signature": [ - "(fn: (file: BufferedFile) => void | ", - "node_modules/@types/vinyl/index", - " | Promise | null) => ", - "Transform" - ], - "path": "packages/kbn-dev-utils/src/streams.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.transformFileStream.$1", - "type": "Function", + "id": "def-server.diffStrings.$2", + "type": "string", "tags": [], - "label": "fn", + "label": "received", "description": [], "signature": [ - "(file: BufferedFile) => void | ", - "node_modules/@types/vinyl/index", - " | Promise | null" + "string" ], - "path": "packages/kbn-dev-utils/src/streams.ts", + "path": "packages/kbn-dev-utils/src/diff_strings.ts", "deprecated": false, "isRequired": true } @@ -2713,32 +515,30 @@ }, { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.transformFileWithBabel", + "id": "def-server.extract", "type": "Function", "tags": [], - "label": "transformFileWithBabel", + "label": "extract", "description": [ - "\nReturns a promise that resolves when the file has been\nmutated so the contents of the file are tranformed with\nbabel, include inline sourcemaps, and the filename has\nbeen updated to use .js.\n\nIf the file was previously transformed with this function\nthe promise will just resolve immediately." + "\nExtract tar and zip archives using a single function, supporting stripComponents\nfor both archive types, only tested with familiar archives we create so might not\nsupport some weird exotic zip features we don't use in our own snapshot/build tooling" ], "signature": [ - "(file: ", - "node_modules/@types/vinyl/index", - ") => Promise" + "({\n archivePath,\n targetDir,\n stripComponents = 0,\n setModifiedTimes,\n}: Options) => Promise" ], - "path": "packages/kbn-dev-utils/src/babel.ts", + "path": "packages/kbn-dev-utils/src/extract.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.transformFileWithBabel.$1", + "id": "def-server.extract.$1", "type": "Object", "tags": [], - "label": "file", + "label": "{\n archivePath,\n targetDir,\n stripComponents = 0,\n setModifiedTimes,\n}", "description": [], "signature": [ - "node_modules/@types/vinyl/index" + "Options" ], - "path": "packages/kbn-dev-utils/src/babel.ts", + "path": "packages/kbn-dev-utils/src/extract.ts", "deprecated": false, "isRequired": true } @@ -2748,131 +548,132 @@ }, { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.withProcRunner", + "id": "def-server.getFlags", "type": "Function", - "tags": [ - "return" - ], - "label": "withProcRunner", - "description": [ - "\n Create a ProcRunner and pass it to an async function. When\n the async function finishes the ProcRunner is torn-down\n automatically\n" - ], + "tags": [], + "label": "getFlags", + "description": [], "signature": [ - "(log: ", + "(argv: string[], flagOptions: ", { "pluginId": "@kbn/dev-utils", "scope": "server", "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.ToolingLog", - "text": "ToolingLog" + "section": "def-server.FlagOptions", + "text": "FlagOptions" }, - ", fn: (procs: ", + " | undefined, defaultLogLevel: string) => ", { "pluginId": "@kbn/dev-utils", "scope": "server", "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.ProcRunner", - "text": "ProcRunner" - }, - ") => Promise) => Promise" + "section": "def-server.Flags", + "text": "Flags" + } ], - "path": "packages/kbn-dev-utils/src/proc_runner/with_proc_runner.ts", + "path": "packages/kbn-dev-utils/src/run/flags.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.withProcRunner.$1", - "type": "Object", + "id": "def-server.getFlags.$1", + "type": "Array", "tags": [], - "label": "log", + "label": "argv", "description": [], "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.ToolingLog", - "text": "ToolingLog" - } + "string[]" ], - "path": "packages/kbn-dev-utils/src/proc_runner/with_proc_runner.ts", + "path": "packages/kbn-dev-utils/src/run/flags.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.withProcRunner.$2", - "type": "Function", + "id": "def-server.getFlags.$2", + "type": "Object", "tags": [], - "label": "fn", + "label": "flagOptions", "description": [], "signature": [ - "(procs: ", { "pluginId": "@kbn/dev-utils", "scope": "server", "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.ProcRunner", - "text": "ProcRunner" + "section": "def-server.FlagOptions", + "text": "FlagOptions" }, - ") => Promise" + " | undefined" ], - "path": "packages/kbn-dev-utils/src/proc_runner/with_proc_runner.ts", + "path": "packages/kbn-dev-utils/src/run/flags.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "@kbn/dev-utils", + "id": "def-server.getFlags.$3", + "type": "string", + "tags": [], + "label": "defaultLogLevel", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-dev-utils/src/run/flags.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false - } - ], - "interfaces": [ + }, { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.AxiosRequestError", - "type": "Interface", + "id": "def-server.isAxiosRequestError", + "type": "Function", "tags": [], - "label": "AxiosRequestError", + "label": "isAxiosRequestError", "description": [], "signature": [ + "(error: any) => error is ", { "pluginId": "@kbn/dev-utils", "scope": "server", "docId": "kibKbnDevUtilsPluginApi", "section": "def-server.AxiosRequestError", "text": "AxiosRequestError" - }, - " extends ", - "AxiosError", - "" + } ], "path": "packages/kbn-dev-utils/src/axios/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.AxiosRequestError.response", - "type": "Uncategorized", + "id": "def-server.isAxiosRequestError.$1", + "type": "Any", "tags": [], - "label": "response", + "label": "error", "description": [], "signature": [ - "undefined" + "any" ], "path": "packages/kbn-dev-utils/src/axios/errors.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } ], + "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.AxiosResponseError", - "type": "Interface", + "id": "def-server.isAxiosResponseError", + "type": "Function", "tags": [], - "label": "AxiosResponseError", + "label": "isAxiosResponseError", "description": [], "signature": [ + "(error: any) => error is ", { "pluginId": "@kbn/dev-utils", "scope": "server", @@ -2880,486 +681,479 @@ "section": "def-server.AxiosResponseError", "text": "AxiosResponseError" }, - " extends ", - "AxiosError", - "" + "" ], "path": "packages/kbn-dev-utils/src/axios/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.AxiosResponseError.response", - "type": "Object", + "id": "def-server.isAxiosResponseError.$1", + "type": "Any", "tags": [], - "label": "response", + "label": "error", "description": [], "signature": [ - "AxiosResponse", - "" + "any" ], "path": "packages/kbn-dev-utils/src/axios/errors.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } ], + "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsMetric", - "type": "Interface", + "id": "def-server.isFailError", + "type": "Function", "tags": [], - "label": "CiStatsMetric", - "description": [ - "A ci-stats metric record" + "label": "isFailError", + "description": [], + "signature": [ + "(error: any) => boolean" ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts", + "path": "packages/kbn-dev-utils/src/run/fail.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsMetric.group", - "type": "string", + "id": "def-server.isFailError.$1", + "type": "Any", "tags": [], - "label": "group", - "description": [ - "Top-level categorization for the metric, e.g. \"page load bundle size\"" + "label": "error", + "description": [], + "signature": [ + "any" ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts", - "deprecated": false - }, + "path": "packages/kbn-dev-utils/src/run/fail.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/dev-utils", + "id": "def-server.mergeFlagOptions", + "type": "Function", + "tags": [], + "label": "mergeFlagOptions", + "description": [], + "signature": [ + "(global: ", { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsMetric.id", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "Specific sub-set of the \"group\", e.g. \"dashboard\"" - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts", - "deprecated": false + "pluginId": "@kbn/dev-utils", + "scope": "server", + "docId": "kibKbnDevUtilsPluginApi", + "section": "def-server.FlagOptions", + "text": "FlagOptions" }, + ", local: ", { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsMetric.value", - "type": "number", - "tags": [], - "label": "value", - "description": [ - "integer value recorded as the value of this metric" - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts", - "deprecated": false + "pluginId": "@kbn/dev-utils", + "scope": "server", + "docId": "kibKbnDevUtilsPluginApi", + "section": "def-server.FlagOptions", + "text": "FlagOptions" }, + ") => ", { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsMetric.limit", - "type": "number", - "tags": [], - "label": "limit", - "description": [ - "optional limit which will generate an error on PRs when the metric exceeds the limit" - ], - "signature": [ - "number | undefined" - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts", - "deprecated": false - }, + "pluginId": "@kbn/dev-utils", + "scope": "server", + "docId": "kibKbnDevUtilsPluginApi", + "section": "def-server.FlagOptions", + "text": "FlagOptions" + } + ], + "path": "packages/kbn-dev-utils/src/run/flags.ts", + "deprecated": false, + "children": [ { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsMetric.limitConfigPath", - "type": "string", + "id": "def-server.mergeFlagOptions.$1", + "type": "Object", "tags": [], - "label": "limitConfigPath", - "description": [ - "\npath, relative to the repo, where the config file contianing limits\nis kept. Linked from PR comments instructing contributors how to fix\ntheir PRs." - ], + "label": "global", + "description": [], "signature": [ - "string | undefined" + { + "pluginId": "@kbn/dev-utils", + "scope": "server", + "docId": "kibKbnDevUtilsPluginApi", + "section": "def-server.FlagOptions", + "text": "FlagOptions" + } ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts", - "deprecated": false + "path": "packages/kbn-dev-utils/src/run/flags.ts", + "deprecated": false, + "isRequired": true }, { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsMetric.meta", + "id": "def-server.mergeFlagOptions.$2", "type": "Object", "tags": [], - "label": "meta", - "description": [ - "Arbitrary key-value pairs which can be used for additional filtering/reporting" - ], + "label": "local", + "description": [], "signature": [ - "CiStatsMetadata", - " | undefined" + { + "pluginId": "@kbn/dev-utils", + "scope": "server", + "docId": "kibKbnDevUtilsPluginApi", + "section": "def-server.FlagOptions", + "text": "FlagOptions" + } ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts", - "deprecated": false + "path": "packages/kbn-dev-utils/src/run/flags.ts", + "deprecated": false, + "isRequired": true } ], + "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsReportTestsOptions", - "type": "Interface", + "id": "def-server.run", + "type": "Function", "tags": [], - "label": "CiStatsReportTestsOptions", - "description": [ - "Options for reporting tests to ci-stats" + "label": "run", + "description": [], + "signature": [ + "(fn: ", + { + "pluginId": "@kbn/dev-utils", + "scope": "server", + "docId": "kibKbnDevUtilsPluginApi", + "section": "def-server.RunFn", + "text": "RunFn" + }, + ", options: ", + { + "pluginId": "@kbn/dev-utils", + "scope": "server", + "docId": "kibKbnDevUtilsPluginApi", + "section": "def-server.RunOptions", + "text": "RunOptions" + }, + ") => Promise" ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts", + "path": "packages/kbn-dev-utils/src/run/run.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsReportTestsOptions.group", - "type": "Object", + "id": "def-server.run.$1", + "type": "Function", "tags": [], - "label": "group", - "description": [ - "\nInformation about the group of tests that were run" - ], + "label": "fn", + "description": [], "signature": [ { "pluginId": "@kbn/dev-utils", "scope": "server", "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.CiStatsTestGroupInfo", - "text": "CiStatsTestGroupInfo" + "section": "def-server.RunFn", + "text": "RunFn" } ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts", - "deprecated": false + "path": "packages/kbn-dev-utils/src/run/run.ts", + "deprecated": false, + "isRequired": true }, { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsReportTestsOptions.testRuns", - "type": "Array", + "id": "def-server.run.$2", + "type": "Object", "tags": [], - "label": "testRuns", - "description": [ - "\nInformation about each test that ran, including failure information" - ], + "label": "options", + "description": [], "signature": [ { "pluginId": "@kbn/dev-utils", "scope": "server", "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.CiStatsTestRun", - "text": "CiStatsTestRun" - }, - "[]" + "section": "def-server.RunOptions", + "text": "RunOptions" + } ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts", - "deprecated": false + "path": "packages/kbn-dev-utils/src/run/run.ts", + "deprecated": false, + "isRequired": true } ], + "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsTestGroupInfo", - "type": "Interface", + "id": "def-server.runPluginListCli", + "type": "Function", + "tags": [], + "label": "runPluginListCli", + "description": [], + "signature": [ + "() => void" + ], + "path": "packages/kbn-dev-utils/src/plugin_list/run_plugin_list_cli.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/dev-utils", + "id": "def-server.runUpdateVscodeConfigCli", + "type": "Function", + "tags": [], + "label": "runUpdateVscodeConfigCli", + "description": [], + "signature": [ + "() => void" + ], + "path": "packages/kbn-dev-utils/src/vscode_config/update_vscode_config_cli.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/dev-utils", + "id": "def-server.shipCiStatsCli", + "type": "Function", "tags": [], - "label": "CiStatsTestGroupInfo", + "label": "shipCiStatsCli", "description": [], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts", + "signature": [ + "() => void" + ], + "path": "packages/kbn-dev-utils/src/ship_ci_stats_cli.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/dev-utils", + "id": "def-server.transformFileStream", + "type": "Function", + "tags": [], + "label": "transformFileStream", + "description": [ + "\nCreate a transform stream that processes Vinyl fs streams and\ncalls a function for each file, allowing the function to either\nmutate the file, replace it with another file (return a new File\nobject), or drop it from the stream (return null)" + ], + "signature": [ + "(fn: (file: BufferedFile) => void | ", + "node_modules/@types/vinyl/index", + " | Promise | null) => ", + "Transform" + ], + "path": "packages/kbn-dev-utils/src/streams.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsTestGroupInfo.startTime", - "type": "string", - "tags": [], - "label": "startTime", - "description": [ - "\nISO-8601 formatted datetime representing when the group of tests started running" - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsTestGroupInfo.durationMs", - "type": "number", - "tags": [], - "label": "durationMs", - "description": [ - "\nThe number of miliseconds that the tests ran for" - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsTestGroupInfo.type", - "type": "string", - "tags": [], - "label": "type", - "description": [ - "\nThe type of tests run in this group, any value is valid but test groups are groupped by type in the UI so use something consistent" - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsTestGroupInfo.name", - "type": "string", - "tags": [], - "label": "name", - "description": [ - "\nThe name of this specific group (within the \"type\")" - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsTestGroupInfo.meta", - "type": "Object", + "id": "def-server.transformFileStream.$1", + "type": "Function", "tags": [], - "label": "meta", - "description": [ - "\nArbitrary metadata associated with this group. We currently look for a ciGroup metadata property for highlighting that when appropriate" - ], + "label": "fn", + "description": [], "signature": [ - "CiStatsMetadata" + "(file: BufferedFile) => void | ", + "node_modules/@types/vinyl/index", + " | Promise | null" ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts", - "deprecated": false + "path": "packages/kbn-dev-utils/src/streams.ts", + "deprecated": false, + "isRequired": true } ], + "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsTestRun", - "type": "Interface", + "id": "def-server.transformFileWithBabel", + "type": "Function", "tags": [], - "label": "CiStatsTestRun", - "description": [], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts", + "label": "transformFileWithBabel", + "description": [ + "\nReturns a promise that resolves when the file has been\nmutated so the contents of the file are tranformed with\nbabel, include inline sourcemaps, and the filename has\nbeen updated to use .js.\n\nIf the file was previously transformed with this function\nthe promise will just resolve immediately." + ], + "signature": [ + "(file: ", + "node_modules/@types/vinyl/index", + ") => Promise" + ], + "path": "packages/kbn-dev-utils/src/babel.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsTestRun.startTime", - "type": "string", - "tags": [], - "label": "startTime", - "description": [ - "\nISO-8601 formatted datetime representing when the tests started running" - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsTestRun.durationMs", - "type": "number", - "tags": [], - "label": "durationMs", - "description": [ - "\nDuration of the tests in milliseconds" - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsTestRun.seq", - "type": "number", - "tags": [], - "label": "seq", - "description": [ - "\nA sequence number, this is used to order the tests in a specific test run" - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsTestRun.type", - "type": "CompoundType", - "tags": [], - "label": "type", - "description": [ - "\nThe type of this \"test run\", usually this is just \"test\" but when reporting issues in hooks it can be set to the type of hook" - ], - "signature": [ - "\"after all hook\" | \"after each hook\" | \"before all hook\" | \"before each hook\" | \"test\"" - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsTestRun.result", - "type": "CompoundType", - "tags": [], - "label": "result", - "description": [ - "\n\"fail\", \"pass\" or \"skip\", the result of the tests" - ], - "signature": [ - "\"fail\" | \"pass\" | \"skip\"" - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsTestRun.suites", - "type": "Array", - "tags": [], - "label": "suites", - "description": [ - "\nThe list of suite names containing this test, the first being the outermost suite" - ], - "signature": [ - "string[]" - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsTestRun.name", - "type": "string", - "tags": [], - "label": "name", - "description": [ - "\nThe name of this specific test run" - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsTestRun.file", - "type": "string", + "id": "def-server.transformFileWithBabel.$1", + "type": "Object", "tags": [], "label": "file", - "description": [ - "\nRelative path from the root of the repo contianing this test" - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsTestRun.error", - "type": "string", - "tags": [], - "label": "error", - "description": [ - "\nError message if the test failed" - ], + "description": [], "signature": [ - "string | undefined" + "node_modules/@types/vinyl/index" ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts", - "deprecated": false + "path": "packages/kbn-dev-utils/src/babel.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/dev-utils", + "id": "def-server.withProcRunner", + "type": "Function", + "tags": [ + "return" + ], + "label": "withProcRunner", + "description": [ + "\n Create a ProcRunner and pass it to an async function. When\n the async function finishes the ProcRunner is torn-down\n automatically\n" + ], + "signature": [ + "(log: ", + "ToolingLog", + ", fn: (procs: ", + { + "pluginId": "@kbn/dev-utils", + "scope": "server", + "docId": "kibKbnDevUtilsPluginApi", + "section": "def-server.ProcRunner", + "text": "ProcRunner" }, + ") => Promise) => Promise" + ], + "path": "packages/kbn-dev-utils/src/proc_runner/with_proc_runner.ts", + "deprecated": false, + "children": [ { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsTestRun.stdout", - "type": "string", + "id": "def-server.withProcRunner.$1", + "type": "Object", "tags": [], - "label": "stdout", - "description": [ - "\nDebug output/stdout produced by the test" - ], + "label": "log", + "description": [], "signature": [ - "string | undefined" + "ToolingLog" ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts", - "deprecated": false + "path": "packages/kbn-dev-utils/src/proc_runner/with_proc_runner.ts", + "deprecated": false, + "isRequired": true }, { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsTestRun.screenshots", - "type": "Array", + "id": "def-server.withProcRunner.$2", + "type": "Function", "tags": [], - "label": "screenshots", - "description": [ - "\nScreenshots captured during the test run" - ], + "label": "fn", + "description": [], "signature": [ - "{ name: string; base64Png: string; }[] | undefined" + "(procs: ", + { + "pluginId": "@kbn/dev-utils", + "scope": "server", + "docId": "kibKbnDevUtilsPluginApi", + "section": "def-server.ProcRunner", + "text": "ProcRunner" + }, + ") => Promise" ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts", - "deprecated": false + "path": "packages/kbn-dev-utils/src/proc_runner/with_proc_runner.ts", + "deprecated": false, + "isRequired": true } ], + "returnComment": [], "initialIsOpen": false - }, + } + ], + "interfaces": [ { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsTiming", + "id": "def-server.AxiosRequestError", "type": "Interface", "tags": [], - "label": "CiStatsTiming", - "description": [ - "A ci-stats timing event" + "label": "AxiosRequestError", + "description": [], + "signature": [ + { + "pluginId": "@kbn/dev-utils", + "scope": "server", + "docId": "kibKbnDevUtilsPluginApi", + "section": "def-server.AxiosRequestError", + "text": "AxiosRequestError" + }, + " extends ", + "AxiosError", + "" ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts", + "path": "packages/kbn-dev-utils/src/axios/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsTiming.group", - "type": "string", - "tags": [], - "label": "group", - "description": [ - "Top-level categorization for the timing, e.g. \"scripts/foo\", process type, etc." - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsTiming.id", - "type": "string", + "id": "def-server.AxiosRequestError.response", + "type": "Uncategorized", "tags": [], - "label": "id", - "description": [ - "Specific timing (witin the \"group\" being tracked) e.g. \"total\"" + "label": "response", + "description": [], + "signature": [ + "undefined" ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts", + "path": "packages/kbn-dev-utils/src/axios/errors.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/dev-utils", + "id": "def-server.AxiosResponseError", + "type": "Interface", + "tags": [], + "label": "AxiosResponseError", + "description": [], + "signature": [ { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsTiming.ms", - "type": "number", - "tags": [], - "label": "ms", - "description": [ - "time in milliseconds which should be recorded" - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts", - "deprecated": false + "pluginId": "@kbn/dev-utils", + "scope": "server", + "docId": "kibKbnDevUtilsPluginApi", + "section": "def-server.AxiosResponseError", + "text": "AxiosResponseError" }, + " extends ", + "AxiosError", + "" + ], + "path": "packages/kbn-dev-utils/src/axios/errors.ts", + "deprecated": false, + "children": [ { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsTiming.meta", + "id": "def-server.AxiosResponseError.response", "type": "Object", "tags": [], - "label": "meta", - "description": [ - "hash of key-value pairs which will be stored with the timing for additional filtering and reporting" - ], + "label": "response", + "description": [], "signature": [ - "CiStatsMetadata", - " | undefined" + "AxiosResponse", + "" ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts", + "path": "packages/kbn-dev-utils/src/axios/errors.ts", "deprecated": false } ], @@ -3488,45 +1282,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.Config", - "type": "Interface", - "tags": [], - "label": "Config", - "description": [ - "\nInformation about how CiStatsReporter should talk to the ci-stats service. Normally\nit is read from a JSON environment variable using the `parseConfig()` function\nexported by this module." - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.Config.apiToken", - "type": "string", - "tags": [], - "label": "apiToken", - "description": [ - "ApiToken necessary for writing build data to ci-stats service" - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_config.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.Config.buildId", - "type": "string", - "tags": [], - "label": "buildId", - "description": [ - "\nuuid which should be obtained by first creating a build with the\nci-stats service and then passing it to all subsequent steps" - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_config.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "@kbn/dev-utils", "id": "def-server.FlagOptions", @@ -3687,150 +1442,47 @@ "type": "boolean", "tags": [], "label": "help", - "description": [], - "path": "packages/kbn-dev-utils/src/run/flags.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.Flags._", - "type": "Array", - "tags": [], - "label": "_", - "description": [], - "signature": [ - "string[]" - ], - "path": "packages/kbn-dev-utils/src/run/flags.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.Flags.unexpected", - "type": "Array", - "tags": [], - "label": "unexpected", - "description": [], - "signature": [ - "string[]" - ], - "path": "packages/kbn-dev-utils/src/run/flags.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.Flags.Unnamed", - "type": "IndexSignature", - "tags": [], - "label": "[key: string]: string | boolean | string[] | undefined", - "description": [], - "signature": [ - "[key: string]: string | boolean | string[] | undefined" - ], - "path": "packages/kbn-dev-utils/src/run/flags.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.Message", - "type": "Interface", - "tags": [], - "label": "Message", - "description": [ - "\nThe object shape passed to ToolingLog writers each time the log is used." - ], - "path": "packages/kbn-dev-utils/src/tooling_log/message.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.Message.type", - "type": "CompoundType", - "tags": [], - "label": "type", - "description": [ - "level/type of message" - ], - "signature": [ - "\"error\" | \"write\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"verbose\"" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/message.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.Message.indent", - "type": "number", - "tags": [], - "label": "indent", - "description": [ - "indentation intended when message written to a text log" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/message.ts", + "description": [], + "path": "packages/kbn-dev-utils/src/run/flags.ts", "deprecated": false }, { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.Message.source", - "type": "string", + "id": "def-server.Flags._", + "type": "Array", "tags": [], - "label": "source", - "description": [ - "type of logger this message came from" - ], + "label": "_", + "description": [], "signature": [ - "string | undefined" + "string[]" ], - "path": "packages/kbn-dev-utils/src/tooling_log/message.ts", + "path": "packages/kbn-dev-utils/src/run/flags.ts", "deprecated": false }, { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.Message.args", + "id": "def-server.Flags.unexpected", "type": "Array", "tags": [], - "label": "args", - "description": [ - "args passed to the logging method" - ], + "label": "unexpected", + "description": [], "signature": [ - "any[]" + "string[]" ], - "path": "packages/kbn-dev-utils/src/tooling_log/message.ts", + "path": "packages/kbn-dev-utils/src/run/flags.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.MetricsOptions", - "type": "Interface", - "tags": [], - "label": "MetricsOptions", - "description": [ - "Options for reporting metrics to ci-stats" - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.MetricsOptions.defaultMeta", - "type": "Object", + "id": "def-server.Flags.Unnamed", + "type": "IndexSignature", "tags": [], - "label": "defaultMeta", - "description": [ - "Default metadata to add to each metric" - ], + "label": "[key: string]: string | boolean | string[] | undefined", + "description": [], "signature": [ - "CiStatsMetadata", - " | undefined" + "[key: string]: string | boolean | string[] | undefined" ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts", + "path": "packages/kbn-dev-utils/src/run/flags.ts", "deprecated": false } ], @@ -3854,13 +1506,7 @@ "label": "log", "description": [], "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.ToolingLog", - "text": "ToolingLog" - } + "ToolingLog" ], "path": "packages/kbn-dev-utils/src/run/run.ts", "deprecated": false @@ -4007,7 +1653,7 @@ "label": "log", "description": [], "signature": [ - "{ defaultLevel?: \"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\" | undefined; } | undefined" + "{ defaultLevel?: \"error\" | \"success\" | \"warning\" | \"info\" | \"debug\" | \"silent\" | \"verbose\" | undefined; } | undefined" ], "path": "packages/kbn-dev-utils/src/run/run.ts", "deprecated": false @@ -4063,7 +1709,7 @@ "label": "log", "description": [], "signature": [ - "{ defaultLevel?: \"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\" | undefined; } | undefined" + "{ defaultLevel?: \"error\" | \"success\" | \"warning\" | \"info\" | \"debug\" | \"silent\" | \"verbose\" | undefined; } | undefined" ], "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", "deprecated": false @@ -4160,244 +1806,6 @@ } ], "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.TimingsOptions", - "type": "Interface", - "tags": [], - "label": "TimingsOptions", - "description": [ - "Options for reporting timings to ci-stats" - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.TimingsOptions.timings", - "type": "Array", - "tags": [], - "label": "timings", - "description": [ - "list of timings to record" - ], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.CiStatsTiming", - "text": "CiStatsTiming" - }, - "[]" - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.TimingsOptions.upstreamBranch", - "type": "string", - "tags": [], - "label": "upstreamBranch", - "description": [ - "master, 7.x, etc, automatically detected from package.json if not specified" - ], - "signature": [ - "string | undefined" - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.TimingsOptions.kibanaUuid", - "type": "CompoundType", - "tags": [], - "label": "kibanaUuid", - "description": [ - "value of data/uuid, automatically loaded if not specified" - ], - "signature": [ - "string | null | undefined" - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_reporter.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLogOptions", - "type": "Interface", - "tags": [], - "label": "ToolingLogOptions", - "description": [], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLogOptions.type", - "type": "string", - "tags": [], - "label": "type", - "description": [ - "\ntype name for this logger, will be assigned to the \"source\"\nproperties of messages produced by this logger" - ], - "signature": [ - "string | undefined" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLogOptions.parent", - "type": "Object", - "tags": [], - "label": "parent", - "description": [ - "\nparent ToolingLog. When a ToolingLog has a parent they will both\nshare indent and writers state. Changing the indent width or\nwriters on either log will update the other too." - ], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.ToolingLog", - "text": "ToolingLog" - }, - " | undefined" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLogTextWriterConfig", - "type": "Interface", - "tags": [], - "label": "ToolingLogTextWriterConfig", - "description": [], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_text_writer.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLogTextWriterConfig.level", - "type": "CompoundType", - "tags": [], - "label": "level", - "description": [ - "\nLog level, messages below this level will be ignored" - ], - "signature": [ - "\"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\"" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_text_writer.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLogTextWriterConfig.ignoreSources", - "type": "Array", - "tags": [], - "label": "ignoreSources", - "description": [ - "\nList of message sources/ToolingLog types which will be ignored. Create\na logger with `ToolingLog#withType()` to create messages with a specific\nsource. Ignored messages will be dropped without writing." - ], - "signature": [ - "string[] | undefined" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_text_writer.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ToolingLogTextWriterConfig.writeTo", - "type": "Object", - "tags": [], - "label": "writeTo", - "description": [ - "\nTarget which will receive formatted message lines, a common value for `writeTo`\nis process.stdout" - ], - "signature": [ - "{ write(s: string): void; }" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/tooling_log_text_writer.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.Writer", - "type": "Interface", - "tags": [], - "label": "Writer", - "description": [ - "\nAn object which received ToolingLog `Messages` and sends them to\nsome interface for collecting logs like stdio, or a file" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/writer.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.Writer.write", - "type": "Function", - "tags": [], - "label": "write", - "description": [ - "\nCalled with every log message, should return true if the message\nwas written and false if it was ignored." - ], - "signature": [ - "(msg: ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.Message", - "text": "Message" - }, - ") => boolean" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/writer.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.Writer.write.$1", - "type": "Object", - "tags": [], - "label": "msg", - "description": [ - "The log message to write" - ], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.Message", - "text": "Message" - } - ], - "path": "packages/kbn-dev-utils/src/tooling_log/writer.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false } ], "enums": [], @@ -4413,34 +1821,6 @@ "deprecated": false, "initialIsOpen": false }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsTestResult", - "type": "Type", - "tags": [], - "label": "CiStatsTestResult", - "description": [], - "signature": [ - "\"fail\" | \"pass\" | \"skip\"" - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CiStatsTestType", - "type": "Type", - "tags": [], - "label": "CiStatsTestType", - "description": [], - "signature": [ - "\"after all hook\" | \"after each hook\" | \"before all hook\" | \"before each hook\" | \"test\"" - ], - "path": "packages/kbn-dev-utils/src/ci_stats_reporter/ci_stats_test_group_types.ts", - "deprecated": false, - "initialIsOpen": false - }, { "parentPluginId": "@kbn/dev-utils", "id": "def-server.CleanupTask", @@ -4620,34 +2000,6 @@ "deprecated": false, "initialIsOpen": false }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.LogLevel", - "type": "Type", - "tags": [], - "label": "LogLevel", - "description": [], - "signature": [ - "\"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\"" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/log_levels.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ParsedLogLevel", - "type": "Type", - "tags": [], - "label": "ParsedLogLevel", - "description": [], - "signature": [ - "{ name: \"error\" | \"info\" | \"success\" | \"warning\" | \"debug\" | \"silent\" | \"verbose\"; flags: { error: boolean; info: boolean; success: boolean; warning: boolean; debug: boolean; silent: boolean; verbose: boolean; }; }" - ], - "path": "packages/kbn-dev-utils/src/tooling_log/log_levels.ts", - "deprecated": false, - "initialIsOpen": false - }, { "parentPluginId": "@kbn/dev-utils", "id": "def-server.RunFn", diff --git a/api_docs/kbn_dev_utils.mdx b/api_docs/kbn_dev_utils.mdx index 39d04687e47e7..66ac63e6464b6 100644 --- a/api_docs/kbn_dev_utils.mdx +++ b/api_docs/kbn_dev_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-dev-utils title: "@kbn/dev-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/dev-utils plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 277 | 3 | 199 | 1 | +| 120 | 3 | 109 | 0 | ## Server diff --git a/api_docs/kbn_doc_links.devdocs.json b/api_docs/kbn_doc_links.devdocs.json index 48d1068132518..d0d228ea60e36 100644 --- a/api_docs/kbn_doc_links.devdocs.json +++ b/api_docs/kbn_doc_links.devdocs.json @@ -261,7 +261,7 @@ "label": "appSearch", "description": [], "signature": [ - "{ readonly apiRef: string; readonly apiClients: string; readonly apiKeys: string; readonly authentication: string; readonly crawlRules: string; readonly curations: string; readonly duplicateDocuments: string; readonly entryPoints: string; readonly guide: string; readonly indexingDocuments: string; readonly indexingDocumentsSchema: string; readonly logSettings: string; readonly metaEngines: string; readonly precisionTuning: string; readonly relevanceTuning: string; readonly resultSettings: string; readonly searchUI: string; readonly security: string; readonly synonyms: string; readonly webCrawler: string; readonly webCrawlerEventLogs: string; }" + "{ readonly apiRef: string; readonly apiClients: string; readonly apiKeys: string; readonly authentication: string; readonly crawlRules: string; readonly curations: string; readonly duplicateDocuments: string; readonly elasticsearchIndexedEngines: string; readonly entryPoints: string; readonly guide: string; readonly indexingDocuments: string; readonly indexingDocumentsSchema: string; readonly logSettings: string; readonly metaEngines: string; readonly precisionTuning: string; readonly relevanceTuning: string; readonly resultSettings: string; readonly searchUI: string; readonly security: string; readonly synonyms: string; readonly webCrawler: string; readonly webCrawlerEventLogs: string; }" ], "path": "packages/kbn-doc-links/src/types.ts", "deprecated": false @@ -326,7 +326,7 @@ "label": "logstash", "description": [], "signature": [ - "{ readonly base: string; }" + "{ readonly base: string; readonly inputElasticAgent: string; }" ], "path": "packages/kbn-doc-links/src/types.ts", "deprecated": false @@ -440,7 +440,7 @@ "label": "kibana", "description": [], "signature": [ - "{ readonly guide: string; readonly autocompleteSuggestions: string; readonly xpackSecurity: string; }" + "{ readonly guide: string; readonly autocompleteSuggestions: string; readonly secureSavedObject: string; readonly xpackSecurity: string; }" ], "path": "packages/kbn-doc-links/src/types.ts", "deprecated": false @@ -489,7 +489,7 @@ "label": "siem", "description": [], "signature": [ - "{ readonly privileges: string; readonly guide: string; readonly gettingStarted: string; readonly ml: string; readonly ruleChangeLog: string; readonly detectionsReq: string; readonly networkMap: string; readonly troubleshootGaps: string; }" + "{ readonly privileges: string; readonly guide: string; readonly gettingStarted: string; readonly ml: string; readonly ruleChangeLog: string; readonly detectionsReq: string; readonly networkMap: string; readonly troubleshootGaps: string; readonly ruleApiOverview: string; }" ], "path": "packages/kbn-doc-links/src/types.ts", "deprecated": false @@ -502,7 +502,7 @@ "label": "securitySolution", "description": [], "signature": [ - "{ readonly trustedApps: string; readonly eventFilters: string; }" + "{ readonly trustedApps: string; readonly eventFilters: string; readonly blocklist: string; }" ], "path": "packages/kbn-doc-links/src/types.ts", "deprecated": false @@ -749,7 +749,7 @@ "label": "fleet", "description": [], "signature": [ - "{ readonly beatsAgentComparison: string; readonly guide: string; readonly fleetServer: string; readonly fleetServerAddFleetServer: string; readonly settings: string; readonly settingsFleetServerHostSettings: string; readonly settingsFleetServerProxySettings: string; readonly troubleshooting: string; readonly elasticAgent: string; readonly datastreams: string; readonly datastreamsILM: string; readonly datastreamsNamingScheme: string; readonly installElasticAgent: string; readonly installElasticAgentStandalone: string; readonly upgradeElasticAgent: string; readonly upgradeElasticAgent712lower: string; readonly learnMoreBlog: string; readonly apiKeysLearnMore: string; readonly onPremRegistry: string; }" + "{ readonly beatsAgentComparison: string; readonly guide: string; readonly fleetServer: string; readonly fleetServerAddFleetServer: string; readonly settings: string; readonly settingsFleetServerHostSettings: string; readonly settingsFleetServerProxySettings: string; readonly troubleshooting: string; readonly elasticAgent: string; readonly datastreams: string; readonly datastreamsILM: string; readonly datastreamsNamingScheme: string; readonly installElasticAgent: string; readonly installElasticAgentStandalone: string; readonly upgradeElasticAgent: string; readonly upgradeElasticAgent712lower: string; readonly learnMoreBlog: string; readonly apiKeysLearnMore: string; readonly onPremRegistry: string; readonly secureLogstash: string; }" ], "path": "packages/kbn-doc-links/src/types.ts", "deprecated": false @@ -805,6 +805,19 @@ ], "path": "packages/kbn-doc-links/src/types.ts", "deprecated": false + }, + { + "parentPluginId": "@kbn/doc-links", + "id": "def-server.DocLinks.kibanaUpgradeSavedObjects", + "type": "Object", + "tags": [], + "label": "kibanaUpgradeSavedObjects", + "description": [], + "signature": [ + "{ readonly resolveMigrationFailures: string; }" + ], + "path": "packages/kbn-doc-links/src/types.ts", + "deprecated": false } ], "initialIsOpen": false diff --git a/api_docs/kbn_doc_links.mdx b/api_docs/kbn_doc_links.mdx index 3f83c0371ca56..4d23bdfc99533 100644 --- a/api_docs/kbn_doc_links.mdx +++ b/api_docs/kbn_doc_links.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-doc-links title: "@kbn/doc-links" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/doc-links plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/doc-links'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 63 | 0 | 63 | 2 | +| 64 | 0 | 64 | 2 | ## Server diff --git a/api_docs/kbn_docs_utils.mdx b/api_docs/kbn_docs_utils.mdx index a2568bc87ea2a..3fd9067f34bae 100644 --- a/api_docs/kbn_docs_utils.mdx +++ b/api_docs/kbn_docs_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-docs-utils title: "@kbn/docs-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/docs-utils plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/docs-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_es_archiver.mdx b/api_docs/kbn_es_archiver.mdx index 965ed6526f6a9..2372ce2f44342 100644 --- a/api_docs/kbn_es_archiver.mdx +++ b/api_docs/kbn_es_archiver.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-es-archiver title: "@kbn/es-archiver" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/es-archiver plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-archiver'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_es_query.mdx b/api_docs/kbn_es_query.mdx index 3c39bf2f5d09d..f51fa006128aa 100644 --- a/api_docs/kbn_es_query.mdx +++ b/api_docs/kbn_es_query.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-es-query title: "@kbn/es-query" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/es-query plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-query'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_eslint_plugin_imports.devdocs.json b/api_docs/kbn_eslint_plugin_imports.devdocs.json index 47400f2102348..c1b952dc57cd6 100644 --- a/api_docs/kbn_eslint_plugin_imports.devdocs.json +++ b/api_docs/kbn_eslint_plugin_imports.devdocs.json @@ -13,56 +13,34 @@ "functions": [ { "parentPluginId": "@kbn/eslint-plugin-imports", - "id": "def-server.resolveKibanaImport", + "id": "def-server.getImportResolver", "type": "Function", "tags": [], - "label": "resolveKibanaImport", + "label": "getImportResolver", "description": [ - "\nResolve an import request. All import requests in the repository should return a result, if they don't it's a bug\nwhich should be caught by the `@kbn/import/no_unresolved` rule, which should never be disabled. If you need help\nadding support for an import style please reach out to operations.\n" + "\nCreate a request resolver for ESLint, requires a PluginPackageResolver from @kbn/bazel-packages which will\nbe created and cached on contextServices automatically.\n\nAll import requests in the repository should return a result, if they don't it's a bug\nwhich should be caught by the `@kbn/import/no_unresolved` rule, which should never be disabled. If you need help\nadding support for an import style please reach out to operations." ], "signature": [ - "(req: string, dirname: string) => ", - { - "pluginId": "@kbn/eslint-plugin-imports", - "scope": "server", - "docId": "kibKbnEslintPluginImportsPluginApi", - "section": "def-server.ResolveResult", - "text": "ResolveResult" - }, - " | null" + "(context: ", + "Rule", + ".RuleContext) => ", + "ImportResolver" ], - "path": "packages/kbn-eslint-plugin-imports/src/resolve_kibana_import.ts", + "path": "packages/kbn-eslint-plugin-imports/src/get_import_resolver.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/eslint-plugin-imports", - "id": "def-server.resolveKibanaImport.$1", - "type": "string", - "tags": [], - "label": "req", - "description": [ - "Text from an import/require, like `../../src/core/public` or `@kbn/std`" - ], - "signature": [ - "string" - ], - "path": "packages/kbn-eslint-plugin-imports/src/resolve_kibana_import.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/eslint-plugin-imports", - "id": "def-server.resolveKibanaImport.$2", - "type": "string", + "id": "def-server.getImportResolver.$1", + "type": "Object", "tags": [], - "label": "dirname", - "description": [ - "The directory of the file where the req was found" - ], + "label": "context", + "description": [], "signature": [ - "string" + "Rule", + ".RuleContext" ], - "path": "packages/kbn-eslint-plugin-imports/src/resolve_kibana_import.ts", + "path": "packages/kbn-eslint-plugin-imports/src/get_import_resolver.ts", "deprecated": false, "isRequired": true } @@ -71,166 +49,9 @@ "initialIsOpen": false } ], - "interfaces": [ - { - "parentPluginId": "@kbn/eslint-plugin-imports", - "id": "def-server.FileResult", - "type": "Interface", - "tags": [], - "label": "FileResult", - "description": [ - "\nResolution result indicating that the import resolves to a specific file, possible in a nodeModule, with\nthe path of that file and the name of the nodeModule if applicable" - ], - "path": "packages/kbn-eslint-plugin-imports/src/resolve_result.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/eslint-plugin-imports", - "id": "def-server.FileResult.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"file\"" - ], - "path": "packages/kbn-eslint-plugin-imports/src/resolve_result.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/eslint-plugin-imports", - "id": "def-server.FileResult.absolute", - "type": "string", - "tags": [], - "label": "absolute", - "description": [], - "path": "packages/kbn-eslint-plugin-imports/src/resolve_result.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/eslint-plugin-imports", - "id": "def-server.FileResult.nodeModule", - "type": "string", - "tags": [], - "label": "nodeModule", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "packages/kbn-eslint-plugin-imports/src/resolve_result.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/eslint-plugin-imports", - "id": "def-server.IgnoreResult", - "type": "Interface", - "tags": [], - "label": "IgnoreResult", - "description": [ - "\nResolution result indicating that the import request can't be resolved, but it shouldn't need to be\nbecause the file that is imported can't be resolved from the source alone, usually because it is explicitly\nimporting a build asset. Import requests which meet this criteria are manually added to the resolver and\ncan be trusted to exist after the build it complete or in their used location." - ], - "path": "packages/kbn-eslint-plugin-imports/src/resolve_result.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/eslint-plugin-imports", - "id": "def-server.IgnoreResult.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"ignore\"" - ], - "path": "packages/kbn-eslint-plugin-imports/src/resolve_result.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/eslint-plugin-imports", - "id": "def-server.TypesResult", - "type": "Interface", - "tags": [], - "label": "TypesResult", - "description": [ - "\nResolution result indicating that the import only resolves to an @types package, including the name of\nthe @types package. We don't validate the sub-path of these import strings and assume that TS will validate\nthem, we just need to know that they don't map to actual files on the filesystem or modules which will\nend up in the build or running code." - ], - "path": "packages/kbn-eslint-plugin-imports/src/resolve_result.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/eslint-plugin-imports", - "id": "def-server.TypesResult.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"@types\"" - ], - "path": "packages/kbn-eslint-plugin-imports/src/resolve_result.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/eslint-plugin-imports", - "id": "def-server.TypesResult.module", - "type": "string", - "tags": [], - "label": "module", - "description": [], - "path": "packages/kbn-eslint-plugin-imports/src/resolve_result.ts", - "deprecated": false - } - ], - "initialIsOpen": false - } - ], + "interfaces": [], "enums": [], - "misc": [ - { - "parentPluginId": "@kbn/eslint-plugin-imports", - "id": "def-server.ResolveResult", - "type": "Type", - "tags": [], - "label": "ResolveResult", - "description": [ - "\nPossible resolve result types" - ], - "signature": [ - { - "pluginId": "@kbn/eslint-plugin-imports", - "scope": "server", - "docId": "kibKbnEslintPluginImportsPluginApi", - "section": "def-server.IgnoreResult", - "text": "IgnoreResult" - }, - " | ", - { - "pluginId": "@kbn/eslint-plugin-imports", - "scope": "server", - "docId": "kibKbnEslintPluginImportsPluginApi", - "section": "def-server.TypesResult", - "text": "TypesResult" - }, - " | ", - { - "pluginId": "@kbn/eslint-plugin-imports", - "scope": "server", - "docId": "kibKbnEslintPluginImportsPluginApi", - "section": "def-server.FileResult", - "text": "FileResult" - } - ], - "path": "packages/kbn-eslint-plugin-imports/src/resolve_result.ts", - "deprecated": false, - "initialIsOpen": false - } - ], + "misc": [], "objects": [] }, "common": { diff --git a/api_docs/kbn_eslint_plugin_imports.mdx b/api_docs/kbn_eslint_plugin_imports.mdx index b1469acd5ce18..39fd23924e882 100644 --- a/api_docs/kbn_eslint_plugin_imports.mdx +++ b/api_docs/kbn_eslint_plugin_imports.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-eslint-plugin-imports title: "@kbn/eslint-plugin-imports" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/eslint-plugin-imports plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/eslint-plugin-imports'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,16 +18,10 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 13 | 0 | 6 | 0 | +| 2 | 0 | 1 | 0 | ## Server ### Functions -### Interfaces - - -### Consts, variables and types - - diff --git a/api_docs/kbn_field_types.mdx b/api_docs/kbn_field_types.mdx index b100124a4b173..34d156709b95c 100644 --- a/api_docs/kbn_field_types.mdx +++ b/api_docs/kbn_field_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-field-types title: "@kbn/field-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/field-types plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/field-types'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_find_used_node_modules.devdocs.json b/api_docs/kbn_find_used_node_modules.devdocs.json new file mode 100644 index 0000000000000..8635fa4c975ef --- /dev/null +++ b/api_docs/kbn_find_used_node_modules.devdocs.json @@ -0,0 +1,61 @@ +{ + "id": "@kbn/find-used-node-modules", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/find-used-node-modules", + "id": "def-server.findUsedNodeModules", + "type": "Function", + "tags": [], + "label": "findUsedNodeModules", + "description": [ + "\nParse a list of entry paths and find the node_modules which are required by them. If the\nentry path requires/imports a non-node_module then that file is scanned too, deeply, until\nall referenced files are scanned.\n\nOptionally, we can find the used peers of the used node_modules. This will keep track of all\nthe paths we use to enter a node_module and then traverse from those points, finding the\nused modules and comparing those to the `peerDependencies` listed in the node_module's package.json\nfile. If a used dependeny is in the `peerDependencies` and is used by the node_module it will\nbe included in the results.\n\nThis was implemented mostly for `@emotion/react` which is used by @elastic/eui but only listed\nas a peerDependency. If we didn't keep it in the Kibana package.json then the package would not\nbe installed and cause an error on startup because `@emotion/react` can't be found. We used to\nsolve this by scanning the node_modules directory for all the packages which are used but that\nwas much slower and lead to extra entries in package.json." + ], + "signature": [ + "(options: Options) => Promise" + ], + "path": "packages/kbn-find-used-node-modules/src/find_used_node_modules.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/find-used-node-modules", + "id": "def-server.findUsedNodeModules.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "Options" + ], + "path": "packages/kbn-find-used-node-modules/src/find_used_node_modules.ts", + "deprecated": 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_find_used_node_modules.mdx b/api_docs/kbn_find_used_node_modules.mdx new file mode 100644 index 0000000000000..95310ec27972b --- /dev/null +++ b/api_docs/kbn_find_used_node_modules.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnFindUsedNodeModulesPluginApi +slug: /kibana-dev-docs/api/kbn-find-used-node-modules +title: "@kbn/find-used-node-modules" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/find-used-node-modules plugin +date: 2022-04-26 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/find-used-node-modules'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnFindUsedNodeModulesObj from './kbn_find_used_node_modules.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 | 0 | 0 | + +## Server + +### Functions + + diff --git a/api_docs/kbn_generate.mdx b/api_docs/kbn_generate.mdx index f678ebba804cc..891a77319d2c0 100644 --- a/api_docs/kbn_generate.mdx +++ b/api_docs/kbn_generate.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-generate title: "@kbn/generate" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/generate plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/generate'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_i18n.mdx b/api_docs/kbn_i18n.mdx index cadd77a894b98..f1c2d35173a65 100644 --- a/api_docs/kbn_i18n.mdx +++ b/api_docs/kbn_i18n.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-i18n title: "@kbn/i18n" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/i18n plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/i18n'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_import_resolver.devdocs.json b/api_docs/kbn_import_resolver.devdocs.json new file mode 100644 index 0000000000000..50e7cdda82ff7 --- /dev/null +++ b/api_docs/kbn_import_resolver.devdocs.json @@ -0,0 +1,715 @@ +{ + "id": "@kbn/import-resolver", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [ + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.ImportResolver", + "type": "Class", + "tags": [], + "label": "ImportResolver", + "description": [], + "path": "packages/kbn-import-resolver/src/import_resolver.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.ImportResolver.create", + "type": "Function", + "tags": [], + "label": "create", + "description": [], + "signature": [ + "(repoRoot: string) => ", + { + "pluginId": "@kbn/import-resolver", + "scope": "server", + "docId": "kibKbnImportResolverPluginApi", + "section": "def-server.ImportResolver", + "text": "ImportResolver" + } + ], + "path": "packages/kbn-import-resolver/src/import_resolver.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.ImportResolver.create.$1", + "type": "string", + "tags": [], + "label": "repoRoot", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-import-resolver/src/import_resolver.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.ImportResolver.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "packages/kbn-import-resolver/src/import_resolver.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.ImportResolver.Unnamed.$1", + "type": "string", + "tags": [], + "label": "cwd", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-import-resolver/src/import_resolver.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.ImportResolver.Unnamed.$2", + "type": "Object", + "tags": [], + "label": "pkgMap", + "description": [], + "signature": [ + "PackageMap" + ], + "path": "packages/kbn-import-resolver/src/import_resolver.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.ImportResolver.Unnamed.$3", + "type": "Object", + "tags": [], + "label": "synthPkgMap", + "description": [], + "signature": [ + "PackageMap" + ], + "path": "packages/kbn-import-resolver/src/import_resolver.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.ImportResolver.getPackageIdForPath", + "type": "Function", + "tags": [], + "label": "getPackageIdForPath", + "description": [], + "signature": [ + "(path: string) => string | null" + ], + "path": "packages/kbn-import-resolver/src/import_resolver.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.ImportResolver.getPackageIdForPath.$1", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-import-resolver/src/import_resolver.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.ImportResolver.getAbsolutePackageDir", + "type": "Function", + "tags": [], + "label": "getAbsolutePackageDir", + "description": [], + "signature": [ + "(pkgId: string) => string | null" + ], + "path": "packages/kbn-import-resolver/src/import_resolver.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.ImportResolver.getAbsolutePackageDir.$1", + "type": "string", + "tags": [], + "label": "pkgId", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-import-resolver/src/import_resolver.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.ImportResolver.isBazelPackage", + "type": "Function", + "tags": [], + "label": "isBazelPackage", + "description": [], + "signature": [ + "(pkgId: string) => boolean" + ], + "path": "packages/kbn-import-resolver/src/import_resolver.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.ImportResolver.isBazelPackage.$1", + "type": "string", + "tags": [], + "label": "pkgId", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-import-resolver/src/import_resolver.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.ImportResolver.isSyntheticPackage", + "type": "Function", + "tags": [], + "label": "isSyntheticPackage", + "description": [], + "signature": [ + "(pkgId: string) => boolean" + ], + "path": "packages/kbn-import-resolver/src/import_resolver.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.ImportResolver.isSyntheticPackage.$1", + "type": "string", + "tags": [], + "label": "pkgId", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-import-resolver/src/import_resolver.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.ImportResolver.resolve", + "type": "Function", + "tags": [], + "label": "resolve", + "description": [ + "\nResolve an import request from a file in the given dirname" + ], + "signature": [ + "(req: string, dirname: string) => ", + { + "pluginId": "@kbn/import-resolver", + "scope": "server", + "docId": "kibKbnImportResolverPluginApi", + "section": "def-server.ResolveResult", + "text": "ResolveResult" + }, + " | null" + ], + "path": "packages/kbn-import-resolver/src/import_resolver.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.ImportResolver.resolve.$1", + "type": "string", + "tags": [], + "label": "req", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-import-resolver/src/import_resolver.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.ImportResolver.resolve.$2", + "type": "string", + "tags": [], + "label": "dirname", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-import-resolver/src/import_resolver.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [ + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.getPackageRelativeImportReq", + "type": "Function", + "tags": [], + "label": "getPackageRelativeImportReq", + "description": [], + "signature": [ + "(options: PackageRelativeImportReqOptions) => string" + ], + "path": "packages/kbn-import-resolver/src/helpers/import_req.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.getPackageRelativeImportReq.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "PackageRelativeImportReqOptions" + ], + "path": "packages/kbn-import-resolver/src/helpers/import_req.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.getRelativeImportReq", + "type": "Function", + "tags": [], + "label": "getRelativeImportReq", + "description": [], + "signature": [ + "(options: RelativeImportReqOptions) => string" + ], + "path": "packages/kbn-import-resolver/src/helpers/import_req.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.getRelativeImportReq.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "RelativeImportReqOptions" + ], + "path": "packages/kbn-import-resolver/src/helpers/import_req.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.reduceImportRequest", + "type": "Function", + "tags": [], + "label": "reduceImportRequest", + "description": [], + "signature": [ + "(req: string, type: ", + { + "pluginId": "@kbn/import-resolver", + "scope": "server", + "docId": "kibKbnImportResolverPluginApi", + "section": "def-server.ImportType", + "text": "ImportType" + }, + ", original: string | undefined) => string" + ], + "path": "packages/kbn-import-resolver/src/helpers/import_req.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.reduceImportRequest.$1", + "type": "string", + "tags": [], + "label": "req", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-import-resolver/src/helpers/import_req.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.reduceImportRequest.$2", + "type": "CompoundType", + "tags": [], + "label": "type", + "description": [], + "signature": [ + { + "pluginId": "@kbn/import-resolver", + "scope": "server", + "docId": "kibKbnImportResolverPluginApi", + "section": "def-server.ImportType", + "text": "ImportType" + } + ], + "path": "packages/kbn-import-resolver/src/helpers/import_req.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.reduceImportRequest.$3", + "type": "string", + "tags": [], + "label": "original", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/kbn-import-resolver/src/helpers/import_req.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.BuiltInResult", + "type": "Interface", + "tags": [], + "label": "BuiltInResult", + "description": [ + "\nResolution result indicating that the import request resolves to a built-in node library" + ], + "path": "packages/kbn-import-resolver/src/resolve_result.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.BuiltInResult.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"built-in\"" + ], + "path": "packages/kbn-import-resolver/src/resolve_result.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.FileResult", + "type": "Interface", + "tags": [], + "label": "FileResult", + "description": [ + "\nResolution result indicating that the import resolves to a specific file, possible in a nodeModule, with\nthe path of that file and the name of the nodeModule if applicable" + ], + "path": "packages/kbn-import-resolver/src/resolve_result.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.FileResult.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"file\"" + ], + "path": "packages/kbn-import-resolver/src/resolve_result.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.FileResult.absolute", + "type": "string", + "tags": [], + "label": "absolute", + "description": [], + "path": "packages/kbn-import-resolver/src/resolve_result.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.FileResult.nodeModule", + "type": "string", + "tags": [], + "label": "nodeModule", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/kbn-import-resolver/src/resolve_result.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.FileResult.prefix", + "type": "string", + "tags": [], + "label": "prefix", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/kbn-import-resolver/src/resolve_result.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.FileResult.postfix", + "type": "string", + "tags": [], + "label": "postfix", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/kbn-import-resolver/src/resolve_result.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.IgnoreResult", + "type": "Interface", + "tags": [], + "label": "IgnoreResult", + "description": [ + "\nResolution result indicating that the import request can't be resolved, but it shouldn't need to be\nbecause the file that is imported can't be resolved from the source alone, usually because it is explicitly\nimporting a build asset. Import requests which meet this criteria are manually added to the resolver and\ncan be trusted to exist after the build it complete or in their used location." + ], + "path": "packages/kbn-import-resolver/src/resolve_result.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.IgnoreResult.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"ignore\"" + ], + "path": "packages/kbn-import-resolver/src/resolve_result.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.OptionalDepResult", + "type": "Interface", + "tags": [], + "label": "OptionalDepResult", + "description": [ + "\nResolution result indicating that the import request resolves to an npm dep which isn't\ncurrently installed so assumed to be optional" + ], + "path": "packages/kbn-import-resolver/src/resolve_result.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.OptionalDepResult.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"optional-and-missing\"" + ], + "path": "packages/kbn-import-resolver/src/resolve_result.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.TypesResult", + "type": "Interface", + "tags": [], + "label": "TypesResult", + "description": [ + "\nResolution result indicating that the import only resolves to an @types package, including the name of\nthe @types package. We don't validate the sub-path of these import strings and assume that TS will validate\nthem, we just need to know that they don't map to actual files on the filesystem or modules which will\nend up in the build or running code." + ], + "path": "packages/kbn-import-resolver/src/resolve_result.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.TypesResult.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"@types\"" + ], + "path": "packages/kbn-import-resolver/src/resolve_result.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.TypesResult.module", + "type": "string", + "tags": [], + "label": "module", + "description": [], + "path": "packages/kbn-import-resolver/src/resolve_result.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.ImportType", + "type": "Type", + "tags": [], + "label": "ImportType", + "description": [], + "signature": [ + "\"esm\" | \"require\" | \"require-resolve\" | \"jest\"" + ], + "path": "packages/kbn-import-resolver/src/helpers/import_req.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/import-resolver", + "id": "def-server.ResolveResult", + "type": "Type", + "tags": [], + "label": "ResolveResult", + "description": [ + "\nPossible resolve result types" + ], + "signature": [ + { + "pluginId": "@kbn/import-resolver", + "scope": "server", + "docId": "kibKbnImportResolverPluginApi", + "section": "def-server.BuiltInResult", + "text": "BuiltInResult" + }, + " | ", + { + "pluginId": "@kbn/import-resolver", + "scope": "server", + "docId": "kibKbnImportResolverPluginApi", + "section": "def-server.IgnoreResult", + "text": "IgnoreResult" + }, + " | ", + { + "pluginId": "@kbn/import-resolver", + "scope": "server", + "docId": "kibKbnImportResolverPluginApi", + "section": "def-server.TypesResult", + "text": "TypesResult" + }, + " | ", + { + "pluginId": "@kbn/import-resolver", + "scope": "server", + "docId": "kibKbnImportResolverPluginApi", + "section": "def-server.FileResult", + "text": "FileResult" + }, + " | ", + { + "pluginId": "@kbn/import-resolver", + "scope": "server", + "docId": "kibKbnImportResolverPluginApi", + "section": "def-server.OptionalDepResult", + "text": "OptionalDepResult" + } + ], + "path": "packages/kbn-import-resolver/src/resolve_result.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_import_resolver.mdx b/api_docs/kbn_import_resolver.mdx new file mode 100644 index 0000000000000..ea7b7ff9aba1d --- /dev/null +++ b/api_docs/kbn_import_resolver.mdx @@ -0,0 +1,36 @@ +--- +id: kibKbnImportResolverPluginApi +slug: /kibana-dev-docs/api/kbn-import-resolver +title: "@kbn/import-resolver" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/import-resolver plugin +date: 2022-04-26 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/import-resolver'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnImportResolverObj from './kbn_import_resolver.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 43 | 0 | 36 | 0 | + +## Server + +### Functions + + +### Classes + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/kbn_interpreter.mdx b/api_docs/kbn_interpreter.mdx index d07e5a0a44859..7a6b18efd63c5 100644 --- a/api_docs/kbn_interpreter.mdx +++ b/api_docs/kbn_interpreter.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-interpreter title: "@kbn/interpreter" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/interpreter plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/interpreter'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_io_ts_utils.devdocs.json b/api_docs/kbn_io_ts_utils.devdocs.json index 6a4ae05e82231..0eac86c5269a4 100644 --- a/api_docs/kbn_io_ts_utils.devdocs.json +++ b/api_docs/kbn_io_ts_utils.devdocs.json @@ -59,10 +59,10 @@ " | ", "StringType", " | ", - "NumberType", - " | ", "BooleanType", " | ", + "NumberType", + " | ", "RecordC", "<", "Mixed", diff --git a/api_docs/kbn_io_ts_utils.mdx b/api_docs/kbn_io_ts_utils.mdx index 2e6530549dee3..0890c33d45907 100644 --- a/api_docs/kbn_io_ts_utils.mdx +++ b/api_docs/kbn_io_ts_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-io-ts-utils title: "@kbn/io-ts-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/io-ts-utils plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/io-ts-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_jest_serializers.devdocs.json b/api_docs/kbn_jest_serializers.devdocs.json new file mode 100644 index 0000000000000..f4595b16f9025 --- /dev/null +++ b/api_docs/kbn_jest_serializers.devdocs.json @@ -0,0 +1,224 @@ +{ + "id": "@kbn/jest-serializers", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/jest-serializers", + "id": "def-server.createAbsolutePathSerializer", + "type": "Function", + "tags": [], + "label": "createAbsolutePathSerializer", + "description": [], + "signature": [ + "(rootPath: string, replacement: string) => { test: (value: any) => boolean; serialize: (value: string) => string; }" + ], + "path": "packages/kbn-jest-serializers/src/absolute_path_serializer.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/jest-serializers", + "id": "def-server.createAbsolutePathSerializer.$1", + "type": "string", + "tags": [], + "label": "rootPath", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-jest-serializers/src/absolute_path_serializer.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/jest-serializers", + "id": "def-server.createAbsolutePathSerializer.$2", + "type": "string", + "tags": [], + "label": "replacement", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-jest-serializers/src/absolute_path_serializer.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/jest-serializers", + "id": "def-server.createAnyInstanceSerializer", + "type": "Function", + "tags": [], + "label": "createAnyInstanceSerializer", + "description": [], + "signature": [ + "(Class: Function, name: string | ((instance: any) => string) | undefined) => { test: (v: any) => boolean; serialize: (v: any) => string; }" + ], + "path": "packages/kbn-jest-serializers/src/any_instance_serizlizer.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/jest-serializers", + "id": "def-server.createAnyInstanceSerializer.$1", + "type": "Object", + "tags": [], + "label": "Class", + "description": [], + "signature": [ + "Function" + ], + "path": "packages/kbn-jest-serializers/src/any_instance_serizlizer.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/jest-serializers", + "id": "def-server.createAnyInstanceSerializer.$2", + "type": "CompoundType", + "tags": [], + "label": "name", + "description": [], + "signature": [ + "string | ((instance: any) => string) | undefined" + ], + "path": "packages/kbn-jest-serializers/src/any_instance_serizlizer.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/jest-serializers", + "id": "def-server.createRecursiveSerializer", + "type": "Function", + "tags": [], + "label": "createRecursiveSerializer", + "description": [], + "signature": [ + "(test: (v: any) => boolean, print: (v: any, printRaw: (v: string) => RawPrint) => string | RawPrint) => { test: (v: any) => boolean; serialize: (v: any, ...rest: any[]) => any; }" + ], + "path": "packages/kbn-jest-serializers/src/recursive_serializer.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/jest-serializers", + "id": "def-server.createRecursiveSerializer.$1", + "type": "Function", + "tags": [], + "label": "test", + "description": [], + "signature": [ + "(v: any) => boolean" + ], + "path": "packages/kbn-jest-serializers/src/recursive_serializer.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/jest-serializers", + "id": "def-server.createRecursiveSerializer.$2", + "type": "Function", + "tags": [], + "label": "print", + "description": [], + "signature": [ + "(v: any, printRaw: (v: string) => RawPrint) => string | RawPrint" + ], + "path": "packages/kbn-jest-serializers/src/recursive_serializer.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/jest-serializers", + "id": "def-server.createReplaceSerializer", + "type": "Function", + "tags": [], + "label": "createReplaceSerializer", + "description": [], + "signature": [ + "(toReplace: string | RegExp, replaceWith: string | Replacer) => { test: (v: any) => boolean; serialize: (v: any, ...rest: any[]) => any; }" + ], + "path": "packages/kbn-jest-serializers/src/replace_serializer.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/jest-serializers", + "id": "def-server.createReplaceSerializer.$1", + "type": "CompoundType", + "tags": [], + "label": "toReplace", + "description": [], + "signature": [ + "string | RegExp" + ], + "path": "packages/kbn-jest-serializers/src/replace_serializer.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/jest-serializers", + "id": "def-server.createReplaceSerializer.$2", + "type": "CompoundType", + "tags": [], + "label": "replaceWith", + "description": [], + "signature": [ + "string | Replacer" + ], + "path": "packages/kbn-jest-serializers/src/replace_serializer.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/jest-serializers", + "id": "def-server.createStripAnsiSerializer", + "type": "Function", + "tags": [], + "label": "createStripAnsiSerializer", + "description": [], + "signature": [ + "() => { test: (v: any) => boolean; serialize: (v: any, ...rest: any[]) => any; }" + ], + "path": "packages/kbn-jest-serializers/src/strip_ansi_serializer.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_jest_serializers.mdx b/api_docs/kbn_jest_serializers.mdx new file mode 100644 index 0000000000000..f9e1f71dc7804 --- /dev/null +++ b/api_docs/kbn_jest_serializers.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnJestSerializersPluginApi +slug: /kibana-dev-docs/api/kbn-jest-serializers +title: "@kbn/jest-serializers" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/jest-serializers plugin +date: 2022-04-26 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/jest-serializers'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnJestSerializersObj from './kbn_jest_serializers.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 13 | 0 | 13 | 0 | + +## Server + +### Functions + + diff --git a/api_docs/kbn_kibana_json_schema.devdocs.json b/api_docs/kbn_kibana_json_schema.devdocs.json new file mode 100644 index 0000000000000..0cc8a1e25feb5 --- /dev/null +++ b/api_docs/kbn_kibana_json_schema.devdocs.json @@ -0,0 +1,844 @@ +{ + "id": "@kbn/kibana-json-schema", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [ + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema", + "type": "Object", + "tags": [], + "label": "KibanaJsonSchema", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"object\"" + ], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.required", + "type": "Array", + "tags": [], + "label": "required", + "description": [], + "signature": [ + "string[]" + ], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties", + "type": "Object", + "tags": [], + "label": "properties", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.id", + "type": "Object", + "tags": [], + "label": "id", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.id.description", + "type": "string", + "tags": [], + "label": "description", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.id.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"string\"" + ], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.id.pattern", + "type": "string", + "tags": [], + "label": "pattern", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.version", + "type": "Object", + "tags": [], + "label": "version", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.version.description", + "type": "string", + "tags": [], + "label": "description", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.version.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"string\"" + ], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.version.pattern", + "type": "string", + "tags": [], + "label": "pattern", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.kibanaVersion", + "type": "Object", + "tags": [], + "label": "kibanaVersion", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.kibanaVersion.description", + "type": "string", + "tags": [], + "label": "description", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.kibanaVersion.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"string\"" + ], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.kibanaVersion.pattern", + "type": "string", + "tags": [], + "label": "pattern", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.type", + "type": "Object", + "tags": [], + "label": "type", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.type.description", + "type": "string", + "tags": [], + "label": "description", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.type.enum", + "type": "Array", + "tags": [], + "label": "enum", + "description": [], + "signature": [ + "string[]" + ], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.configPath", + "type": "Object", + "tags": [], + "label": "configPath", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.configPath.description", + "type": "string", + "tags": [], + "label": "description", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.configPath.oneOf", + "type": "Array", + "tags": [], + "label": "oneOf", + "description": [], + "signature": [ + "({ type: \"string\"; } | { type: \"array\"; items: { type: \"string\"; }; })[]" + ], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.requiredPlugins", + "type": "Object", + "tags": [], + "label": "requiredPlugins", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.requiredPlugins.description", + "type": "string", + "tags": [], + "label": "description", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.requiredPlugins.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"array\"" + ], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.requiredPlugins.items", + "type": "Object", + "tags": [], + "label": "items", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.requiredPlugins.items.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"string\"" + ], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + } + ] + } + ] + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.optionalPlugins", + "type": "Object", + "tags": [], + "label": "optionalPlugins", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.optionalPlugins.description", + "type": "string", + "tags": [], + "label": "description", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.optionalPlugins.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"array\"" + ], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.optionalPlugins.items", + "type": "Object", + "tags": [], + "label": "items", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.optionalPlugins.items.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"string\"" + ], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + } + ] + } + ] + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.requiredBundles", + "type": "Object", + "tags": [], + "label": "requiredBundles", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.requiredBundles.description", + "type": "string", + "tags": [], + "label": "description", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.requiredBundles.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"array\"" + ], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.requiredBundles.items", + "type": "Object", + "tags": [], + "label": "items", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.requiredBundles.items.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"string\"" + ], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + } + ] + } + ] + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.ui", + "type": "Object", + "tags": [], + "label": "ui", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.ui.description", + "type": "string", + "tags": [], + "label": "description", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.ui.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"boolean\"" + ], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.server", + "type": "Object", + "tags": [], + "label": "server", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.server.description", + "type": "string", + "tags": [], + "label": "description", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.server.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"boolean\"" + ], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.extraPublicDirs", + "type": "Object", + "tags": [], + "label": "extraPublicDirs", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.extraPublicDirs.description", + "type": "string", + "tags": [], + "label": "description", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.extraPublicDirs.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"array\"" + ], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.extraPublicDirs.items", + "type": "Object", + "tags": [], + "label": "items", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.extraPublicDirs.items.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"string\"" + ], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + } + ] + } + ] + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.serviceFolders", + "type": "Object", + "tags": [], + "label": "serviceFolders", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.serviceFolders.description", + "type": "string", + "tags": [], + "label": "description", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.serviceFolders.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"array\"" + ], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.serviceFolders.items", + "type": "Object", + "tags": [], + "label": "items", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.serviceFolders.items.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"string\"" + ], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + } + ] + } + ] + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.owner", + "type": "Object", + "tags": [], + "label": "owner", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.owner.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"object\"" + ], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.owner.required", + "type": "Array", + "tags": [], + "label": "required", + "description": [], + "signature": [ + "string[]" + ], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.owner.properties", + "type": "Object", + "tags": [], + "label": "properties", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.owner.properties.name", + "type": "Object", + "tags": [], + "label": "name", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.owner.properties.name.description", + "type": "string", + "tags": [], + "label": "description", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.owner.properties.name.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"string\"" + ], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.owner.properties.githubTeam", + "type": "Object", + "tags": [], + "label": "githubTeam", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.owner.properties.githubTeam.description", + "type": "string", + "tags": [], + "label": "description", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.owner.properties.githubTeam.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"string\"" + ], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + } + ] + } + ] + } + ] + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.description", + "type": "Object", + "tags": [], + "label": "description", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.description.description", + "type": "string", + "tags": [], + "label": "description", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.description.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"string\"" + ], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.enabledOnAnonymousPages", + "type": "Object", + "tags": [], + "label": "enabledOnAnonymousPages", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.enabledOnAnonymousPages.description", + "type": "string", + "tags": [], + "label": "description", + "description": [], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/kibana-json-schema", + "id": "def-server.KibanaJsonSchema.properties.enabledOnAnonymousPages.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"boolean\"" + ], + "path": "packages/kbn-kibana-json-schema/src/kibana_json_schema.ts", + "deprecated": false + } + ] + } + ] + } + ], + "initialIsOpen": false + } + ] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_kibana_json_schema.mdx b/api_docs/kbn_kibana_json_schema.mdx new file mode 100644 index 0000000000000..16776b0a20e55 --- /dev/null +++ b/api_docs/kbn_kibana_json_schema.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnKibanaJsonSchemaPluginApi +slug: /kibana-dev-docs/api/kbn-kibana-json-schema +title: "@kbn/kibana-json-schema" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/kibana-json-schema plugin +date: 2022-04-26 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/kibana-json-schema'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnKibanaJsonSchemaObj from './kbn_kibana_json_schema.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 69 | 0 | 69 | 0 | + +## Server + +### Objects + + diff --git a/api_docs/kbn_logging.devdocs.json b/api_docs/kbn_logging.devdocs.json index f9bca4daaf11f..00bfe3a5f742b 100644 --- a/api_docs/kbn_logging.devdocs.json +++ b/api_docs/kbn_logging.devdocs.json @@ -644,7 +644,7 @@ "label": "EcsEventOutcome", "description": [], "signature": [ - "\"unknown\" | \"success\" | \"failure\"" + "\"success\" | \"unknown\" | \"failure\"" ], "path": "packages/kbn-logging/src/ecs/event.ts", "deprecated": false, @@ -658,7 +658,7 @@ "label": "EcsEventType", "description": [], "signature": [ - "\"start\" | \"user\" | \"error\" | \"info\" | \"group\" | \"end\" | \"protocol\" | \"connection\" | \"access\" | \"admin\" | \"allowed\" | \"change\" | \"creation\" | \"deletion\" | \"denied\" | \"installation\"" + "\"start\" | \"error\" | \"user\" | \"info\" | \"group\" | \"end\" | \"admin\" | \"protocol\" | \"connection\" | \"access\" | \"allowed\" | \"change\" | \"creation\" | \"deletion\" | \"denied\" | \"installation\"" ], "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 071f96e712bb7..d1bd851ab5758 100644 --- a/api_docs/kbn_logging.mdx +++ b/api_docs/kbn_logging.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-logging title: "@kbn/logging" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/logging plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/logging'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_logging_mocks.mdx b/api_docs/kbn_logging_mocks.mdx index 3eee38ebb640b..490414113832e 100644 --- a/api_docs/kbn_logging_mocks.mdx +++ b/api_docs/kbn_logging_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-logging-mocks title: "@kbn/logging-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/logging-mocks plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/logging-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_mapbox_gl.devdocs.json b/api_docs/kbn_mapbox_gl.devdocs.json index e7df5d6118ad9..845de56441c91 100644 --- a/api_docs/kbn_mapbox_gl.devdocs.json +++ b/api_docs/kbn_mapbox_gl.devdocs.json @@ -12,77 +12,276 @@ "classes": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLat", + "id": "def-server.GeoJSONSource", "type": "Class", "tags": [], - "label": "LngLat", - "description": [ - "\nLngLat" - ], + "label": "GeoJSONSource", + "description": [], "signature": [ - "maplibregl.LngLat" + "maplibregl.GeoJSONSource extends maplibregl.Evented implements maplibregl.Source" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLat.lng", + "id": "def-server.GeoJSONSource.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"geojson\"" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.GeoJSONSource.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.GeoJSONSource.minzoom", "type": "number", "tags": [], - "label": "lng", + "label": "minzoom", "description": [], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLat.lat", + "id": "def-server.GeoJSONSource.maxzoom", "type": "number", "tags": [], - "label": "lat", + "label": "maxzoom", "description": [], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLat.Unnamed", - "type": "Function", + "id": "def-server.GeoJSONSource.tileSize", + "type": "number", + "tags": [], + "label": "tileSize", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.GeoJSONSource.attribution", + "type": "string", + "tags": [], + "label": "attribution", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.GeoJSONSource.promoteId", + "type": "CompoundType", + "tags": [], + "label": "promoteId", + "description": [], + "signature": [ + "string | { [_: string]: string; }" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.GeoJSONSource.isTileClipped", + "type": "boolean", + "tags": [], + "label": "isTileClipped", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.GeoJSONSource.reparseOverscaled", + "type": "boolean", + "tags": [], + "label": "reparseOverscaled", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.GeoJSONSource._data", + "type": "CompoundType", + "tags": [], + "label": "_data", + "description": [], + "signature": [ + "string | GeoJSON.GeoJSON" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.GeoJSONSource._options", + "type": "Any", + "tags": [], + "label": "_options", + "description": [], + "signature": [ + "any" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.GeoJSONSource.workerOptions", + "type": "Any", + "tags": [], + "label": "workerOptions", + "description": [], + "signature": [ + "any" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.GeoJSONSource.map", + "type": "Object", + "tags": [], + "label": "map", + "description": [], + "signature": [ + "maplibregl.Map" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.GeoJSONSource.actor", + "type": "Object", + "tags": [], + "label": "actor", + "description": [], + "signature": [ + "maplibregl.Actor" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.GeoJSONSource._pendingLoads", + "type": "number", + "tags": [], + "label": "_pendingLoads", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.GeoJSONSource._collectResourceTiming", + "type": "boolean", + "tags": [], + "label": "_collectResourceTiming", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.GeoJSONSource._removed", + "type": "boolean", "tags": [], + "label": "_removed", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.GeoJSONSource.Unnamed", + "type": "Function", + "tags": [ + "private" + ], "label": "Constructor", "description": [], "signature": [ "any" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLat.Unnamed.$1", - "type": "number", + "id": "def-server.GeoJSONSource.Unnamed.$1", + "type": "string", "tags": [], - "label": "lng", + "label": "id", "description": [], "signature": [ - "number" + "string" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLat.Unnamed.$2", - "type": "number", + "id": "def-server.GeoJSONSource.Unnamed.$2", + "type": "CompoundType", "tags": [], - "label": "lat", + "label": "options", "description": [], "signature": [ - "number" + "maplibregl.GeoJSONSourceOptions" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.GeoJSONSource.Unnamed.$3", + "type": "Object", + "tags": [], + "label": "dispatcher", + "description": [], + "signature": [ + "maplibregl.Dispatcher" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.GeoJSONSource.Unnamed.$4", + "type": "Object", + "tags": [], + "label": "eventedParent", + "description": [], + "signature": [ + "maplibregl.Evented" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true } @@ -91,81 +290,43 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLat.wrap", - "type": "Function", - "tags": [], - "label": "wrap", - "description": [ - "Return a new LngLat object whose longitude is wrapped to the range (-180, 180)." - ], - "signature": [ - "() => maplibregl.LngLat" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLat.toArray", - "type": "Function", - "tags": [], - "label": "toArray", - "description": [ - "Return a LngLat as an array" - ], - "signature": [ - "() => number[]" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLat.toString", + "id": "def-server.GeoJSONSource.load", "type": "Function", "tags": [], - "label": "toString", - "description": [ - "Return a LngLat as a string" - ], + "label": "load", + "description": [], "signature": [ - "() => string" + "() => void" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLat.distanceTo", + "id": "def-server.GeoJSONSource.onAdd", "type": "Function", "tags": [], - "label": "distanceTo", - "description": [ - "Returns the approximate distance between a pair of coordinates in meters\nUses the Haversine Formula (from R.W. Sinnott, \"Virtues of the Haversine\", Sky and Telescope, vol. 68, no. 2, 1984, p. 159)" - ], + "label": "onAdd", + "description": [], "signature": [ - "(lngLat: maplibregl.LngLat) => number" + "(map: maplibregl.Map) => void" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLat.distanceTo.$1", + "id": "def-server.GeoJSONSource.onAdd.$1", "type": "Object", "tags": [], - "label": "lngLat", + "label": "map", "description": [], "signature": [ - "maplibregl.LngLat" + "maplibregl.Map" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true } @@ -174,206 +335,252 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLat.toBounds", + "id": "def-server.GeoJSONSource.setData", "type": "Function", "tags": [], - "label": "toBounds", - "description": [], + "label": "setData", + "description": [ + "\nSets the GeoJSON data and re-renders the map.\n" + ], "signature": [ - "(radius: number) => maplibregl.LngLatBounds" + "(data: string | GeoJSON.GeoJSON) => this" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLat.toBounds.$1", - "type": "number", + "id": "def-server.GeoJSONSource.setData.$1", + "type": "CompoundType", "tags": [], - "label": "radius", - "description": [], + "label": "data", + "description": [ + "A GeoJSON data object or a URL to one. The latter is preferable in the case of large GeoJSON files." + ], "signature": [ - "number" + "string | GeoJSON.GeoJSON" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "this" + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLat.convert", + "id": "def-server.GeoJSONSource.getClusterExpansionZoom", "type": "Function", "tags": [], - "label": "convert", - "description": [], + "label": "getClusterExpansionZoom", + "description": [ + "\nFor clustered sources, fetches the zoom at which the given cluster expands.\n" + ], "signature": [ - "(input: maplibregl.LngLatLike) => maplibregl.LngLat" + "(clusterId: number, callback: maplibregl.Callback) => this" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLat.convert.$1", - "type": "CompoundType", + "id": "def-server.GeoJSONSource.getClusterExpansionZoom.$1", + "type": "number", "tags": [], - "label": "input", - "description": [], + "label": "clusterId", + "description": [ + "The value of the cluster's `cluster_id` property." + ], "signature": [ - "maplibregl.LngLatLike" + "number" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.GeoJSONSource.getClusterExpansionZoom.$2", + "type": "Function", + "tags": [], + "label": "callback", + "description": [ + "A callback to be called when the zoom value is retrieved (`(error, zoom) => { ... }`)." + ], + "signature": [ + "maplibregl.Callback" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true } ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds", - "type": "Class", - "tags": [], - "label": "LngLatBounds", - "description": [ - "\nLngLatBounds" - ], - "signature": [ - "maplibregl.LngLatBounds" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.sw", - "type": "CompoundType", - "tags": [], - "label": "sw", - "description": [], - "signature": [ - "[number, number] | maplibregl.LngLat | { lng: number; lat: number; } | { lon: number; lat: number; }" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.ne", - "type": "CompoundType", - "tags": [], - "label": "ne", - "description": [], - "signature": [ - "[number, number] | maplibregl.LngLat | { lng: number; lat: number; } | { lon: number; lat: number; }" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false + "returnComment": [ + "this" + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.Unnamed", + "id": "def-server.GeoJSONSource.getClusterChildren", "type": "Function", "tags": [], - "label": "Constructor", - "description": [], + "label": "getClusterChildren", + "description": [ + "\nFor clustered sources, fetches the children of the given cluster on the next zoom level (as an array of GeoJSON features).\n" + ], "signature": [ - "any" + "(clusterId: number, callback: maplibregl.Callback[]>) => this" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.Unnamed.$1", - "type": "CompoundType", + "id": "def-server.GeoJSONSource.getClusterChildren.$1", + "type": "number", "tags": [], - "label": "boundsLike", - "description": [], + "label": "clusterId", + "description": [ + "The value of the cluster's `cluster_id` property." + ], "signature": [ - "[number, number, number, number] | [maplibregl.LngLatLike, maplibregl.LngLatLike] | undefined" + "number" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "isRequired": false + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.GeoJSONSource.getClusterChildren.$2", + "type": "Function", + "tags": [], + "label": "callback", + "description": [ + "A callback to be called when the features are retrieved (`(error, features) => { ... }`)." + ], + "signature": [ + "maplibregl.Callback[]>" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "this" + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.Unnamed", + "id": "def-server.GeoJSONSource.getClusterLeaves", "type": "Function", "tags": [], - "label": "Constructor", - "description": [], + "label": "getClusterLeaves", + "description": [ + "\nFor clustered sources, fetches the original points that belong to the cluster (as an array of GeoJSON features).\n" + ], "signature": [ - "any" + "(clusterId: number, limit: number, offset: number, callback: maplibregl.Callback[]>) => this" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.Unnamed.$1", - "type": "CompoundType", + "id": "def-server.GeoJSONSource.getClusterLeaves.$1", + "type": "number", "tags": [], - "label": "sw", - "description": [], + "label": "clusterId", + "description": [ + "The value of the cluster's `cluster_id` property." + ], "signature": [ - "maplibregl.LngLatLike" + "number" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.Unnamed.$2", - "type": "CompoundType", + "id": "def-server.GeoJSONSource.getClusterLeaves.$2", + "type": "number", "tags": [], - "label": "ne", - "description": [], + "label": "limit", + "description": [ + "The maximum number of features to return." + ], "signature": [ - "maplibregl.LngLatLike" + "number" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.GeoJSONSource.getClusterLeaves.$3", + "type": "number", + "tags": [], + "label": "offset", + "description": [ + "The number of features to skip (e.g. for pagination)." + ], + "signature": [ + "number" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.GeoJSONSource.getClusterLeaves.$4", + "type": "Function", + "tags": [], + "label": "callback", + "description": [ + "A callback to be called when the features are retrieved (`(error, features) => { ... }`)." + ], + "signature": [ + "maplibregl.Callback[]>" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "this" + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.setNorthEast", + "id": "def-server.GeoJSONSource._updateWorkerData", "type": "Function", "tags": [], - "label": "setNorthEast", + "label": "_updateWorkerData", "description": [], "signature": [ - "(ne: maplibregl.LngLatLike) => this" + "(sourceDataType: maplibregl.MapSourceDataType) => void" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.setNorthEast.$1", + "id": "def-server.GeoJSONSource._updateWorkerData.$1", "type": "CompoundType", "tags": [], - "label": "ne", + "label": "sourceDataType", "description": [], "signature": [ - "maplibregl.LngLatLike" + "maplibregl.MapSourceDataType" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true } @@ -382,28 +589,57 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.setSouthWest", + "id": "def-server.GeoJSONSource.loaded", "type": "Function", "tags": [], - "label": "setSouthWest", + "label": "loaded", "description": [], "signature": [ - "(sw: maplibregl.LngLatLike) => this" + "() => boolean" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.GeoJSONSource.loadTile", + "type": "Function", + "tags": [], + "label": "loadTile", + "description": [], + "signature": [ + "(tile: maplibregl.Tile, callback: maplibregl.Callback) => void" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.setSouthWest.$1", - "type": "CompoundType", + "id": "def-server.GeoJSONSource.loadTile.$1", + "type": "Object", "tags": [], - "label": "sw", + "label": "tile", "description": [], "signature": [ - "maplibregl.LngLatLike" + "maplibregl.Tile" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.GeoJSONSource.loadTile.$2", + "type": "Function", + "tags": [], + "label": "callback", + "description": [], + "signature": [ + "maplibregl.Callback" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true } @@ -412,30 +648,28 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.contains", + "id": "def-server.GeoJSONSource.abortTile", "type": "Function", "tags": [], - "label": "contains", - "description": [ - "Check if the point is within the bounding box." - ], + "label": "abortTile", + "description": [], "signature": [ - "(lnglat: maplibregl.LngLatLike) => boolean" + "(tile: maplibregl.Tile) => void" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.contains.$1", - "type": "CompoundType", + "id": "def-server.GeoJSONSource.abortTile.$1", + "type": "Object", "tags": [], - "label": "lnglat", + "label": "tile", "description": [], "signature": [ - "maplibregl.LngLatLike" + "maplibregl.Tile" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true } @@ -444,30 +678,28 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.extend", + "id": "def-server.GeoJSONSource.unloadTile", "type": "Function", "tags": [], - "label": "extend", - "description": [ - "Extend the bounds to include a given LngLat or LngLatBounds." - ], + "label": "unloadTile", + "description": [], "signature": [ - "(obj: [number, number] | [number, number, number, number] | maplibregl.LngLatBounds | [maplibregl.LngLatLike, maplibregl.LngLatLike] | maplibregl.LngLat | { lng: number; lat: number; } | { lon: number; lat: number; }) => this" + "(tile: maplibregl.Tile) => void" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.extend.$1", - "type": "CompoundType", + "id": "def-server.GeoJSONSource.unloadTile.$1", + "type": "Object", "tags": [], - "label": "obj", + "label": "tile", "description": [], "signature": [ - "[number, number] | [number, number, number, number] | maplibregl.LngLatBounds | [maplibregl.LngLatLike, maplibregl.LngLatLike] | maplibregl.LngLat | { lng: number; lat: number; } | { lon: number; lat: number; }" + "maplibregl.Tile" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true } @@ -476,1942 +708,2184 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.getCenter", + "id": "def-server.GeoJSONSource.onRemove", "type": "Function", "tags": [], - "label": "getCenter", - "description": [ - "Get the point equidistant from this box's corners" - ], + "label": "onRemove", + "description": [], "signature": [ - "() => maplibregl.LngLat" + "() => void" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.getSouthWest", + "id": "def-server.GeoJSONSource.serialize", "type": "Function", "tags": [], - "label": "getSouthWest", - "description": [ - "Get southwest corner" - ], + "label": "serialize", + "description": [], "signature": [ - "() => maplibregl.LngLat" + "() => any" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.getNorthEast", + "id": "def-server.GeoJSONSource.hasTransition", "type": "Function", "tags": [], - "label": "getNorthEast", - "description": [ - "Get northeast corner" - ], + "label": "hasTransition", + "description": [], "signature": [ - "() => maplibregl.LngLat" + "() => boolean" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [], "returnComment": [] - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.LngLat", + "type": "Class", + "tags": [], + "label": "LngLat", + "description": [], + "signature": [ + "maplibregl.LngLat" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.getNorthWest", - "type": "Function", + "id": "def-server.LngLat.lng", + "type": "number", "tags": [], - "label": "getNorthWest", - "description": [ - "Get northwest corner" - ], - "signature": [ - "() => maplibregl.LngLat" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "label": "lng", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.getSouthEast", - "type": "Function", + "id": "def-server.LngLat.lat", + "type": "number", "tags": [], - "label": "getSouthEast", - "description": [ - "Get southeast corner" - ], - "signature": [ - "() => maplibregl.LngLat" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "label": "lat", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.getWest", + "id": "def-server.LngLat.Unnamed", "type": "Function", "tags": [], - "label": "getWest", - "description": [ - "Get west edge longitude" - ], + "label": "Constructor", + "description": [], "signature": [ - "() => number" + "any" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.getSouth", - "type": "Function", - "tags": [], - "label": "getSouth", - "description": [ - "Get south edge latitude" - ], - "signature": [ - "() => number" + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.LngLat.Unnamed.$1", + "type": "number", + "tags": [], + "label": "lng", + "description": [], + "signature": [ + "number" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.LngLat.Unnamed.$2", + "type": "number", + "tags": [], + "label": "lat", + "description": [], + "signature": [ + "number" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [], "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.getEast", + "id": "def-server.LngLat.wrap", "type": "Function", "tags": [], - "label": "getEast", + "label": "wrap", "description": [ - "Get east edge longitude" + "\nReturns a new `LngLat` object whose longitude is wrapped to the range (-180, 180).\n" ], "signature": [ - "() => number" + "() => maplibregl.LngLat" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [], - "returnComment": [] + "returnComment": [ + "The wrapped `LngLat` object." + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.getNorth", + "id": "def-server.LngLat.toArray", "type": "Function", "tags": [], - "label": "getNorth", + "label": "toArray", "description": [ - "Get north edge latitude" + "\nReturns the coordinates represented as an array of two numbers.\n" ], "signature": [ - "() => number" + "() => number[]" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [], - "returnComment": [] + "returnComment": [ + "The coordinates represeted as an array of longitude and latitude." + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.toArray", + "id": "def-server.LngLat.toString", "type": "Function", "tags": [], - "label": "toArray", + "label": "toString", "description": [ - "Returns a LngLatBounds as an array" + "\nReturns the coordinates represent as a string.\n" ], "signature": [ - "() => number[][]" + "() => string" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [], - "returnComment": [] + "returnComment": [ + "The coordinates represented as a string of the format `'LngLat(lng, lat)'`." + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.toString", + "id": "def-server.LngLat.distanceTo", "type": "Function", "tags": [], - "label": "toString", + "label": "distanceTo", "description": [ - "Return a LngLatBounds as a string" + "\nReturns the approximate distance between a pair of coordinates in meters\nUses the Haversine Formula (from R.W. Sinnott, \"Virtues of the Haversine\", Sky and Telescope, vol. 68, no. 2, 1984, p. 159)\n" ], "signature": [ - "() => string" + "(lngLat: maplibregl.LngLat) => number" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "children": [], - "returnComment": [] + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.LngLat.distanceTo.$1", + "type": "Object", + "tags": [], + "label": "lngLat", + "description": [ + "coordinates to compute the distance to" + ], + "signature": [ + "maplibregl.LngLat" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "Distance in meters between the two coordinates." + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.isEmpty", + "id": "def-server.LngLat.toBounds", "type": "Function", "tags": [], - "label": "isEmpty", + "label": "toBounds", "description": [ - "Returns a boolean" + "\nReturns a `LngLatBounds` from the coordinates extended by a given `radius`. The returned `LngLatBounds` completely contains the `radius`.\n" ], "signature": [ - "() => boolean" + "(radius?: number | undefined) => maplibregl.LngLatBounds" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "children": [], - "returnComment": [] + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.LngLat.toBounds.$1", + "type": "number", + "tags": [], + "label": "radius", + "description": [ + "Distance in meters from the coordinates to extend the bounds." + ], + "signature": [ + "number | undefined" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "A new `LngLatBounds` object representing the coordinates extended by the `radius`." + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.convert", + "id": "def-server.LngLat.convert", "type": "Function", "tags": [], "label": "convert", "description": [ - "Convert an array to a LngLatBounds object, or return an existing LngLatBounds object unchanged." + "\nConverts an array of two numbers or an object with `lng` and `lat` or `lon` and `lat` properties\nto a `LngLat` object.\n\nIf a `LngLat` object is passed in, the function returns it unchanged.\n" ], "signature": [ - "(input: maplibregl.LngLatBoundsLike) => maplibregl.LngLatBounds" + "(input: maplibregl.LngLatLike) => maplibregl.LngLat" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.convert.$1", + "id": "def-server.LngLat.convert.$1", "type": "CompoundType", "tags": [], "label": "input", - "description": [], + "description": [ + "An array of two numbers or object to convert, or a `LngLat` object to return." + ], "signature": [ - "maplibregl.LngLatBoundsLike" + "maplibregl.LngLatLike" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "A new `LngLat` object, if a conversion occurred, or the original `LngLat` object." + ] } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map", + "id": "def-server.LngLatBounds", "type": "Class", "tags": [], - "label": "Map", - "description": [ - "\nMap" - ], + "label": "LngLatBounds", + "description": [], "signature": [ - "maplibregl.Map extends maplibregl.Evented" + "maplibregl.LngLatBounds" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.Unnamed", - "type": "Function", + "id": "def-server.LngLatBounds._ne", + "type": "Object", "tags": [], - "label": "Constructor", + "label": "_ne", "description": [], "signature": [ - "any" + "maplibregl.LngLat" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.Unnamed.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "maplibregl.MapboxOptions | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": false - } + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.LngLatBounds._sw", + "type": "Object", + "tags": [], + "label": "_sw", + "description": [], + "signature": [ + "maplibregl.LngLat" ], - "returnComment": [] + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.addControl", + "id": "def-server.LngLatBounds.Unnamed", "type": "Function", "tags": [], - "label": "addControl", + "label": "Constructor", "description": [], "signature": [ - "(control: maplibregl.Control | maplibregl.IControl, position?: \"top-right\" | \"top-left\" | \"bottom-right\" | \"bottom-left\" | undefined) => this" + "any" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.addControl.$1", - "type": "CompoundType", + "id": "def-server.LngLatBounds.Unnamed.$1", + "type": "Any", "tags": [], - "label": "control", + "label": "sw", "description": [], "signature": [ - "maplibregl.Control | maplibregl.IControl" + "any" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.addControl.$2", - "type": "CompoundType", + "id": "def-server.LngLatBounds.Unnamed.$2", + "type": "Any", "tags": [], - "label": "position", + "label": "ne", "description": [], "signature": [ - "\"top-right\" | \"top-left\" | \"bottom-right\" | \"bottom-left\" | undefined" + "any" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.removeControl", + "id": "def-server.LngLatBounds.setNorthEast", "type": "Function", "tags": [], - "label": "removeControl", - "description": [], + "label": "setNorthEast", + "description": [ + "\nSet the northeast corner of the bounding box\n" + ], "signature": [ - "(control: maplibregl.Control | maplibregl.IControl) => this" + "(ne: maplibregl.LngLatLike) => this" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.removeControl.$1", + "id": "def-server.LngLatBounds.setNorthEast.$1", "type": "CompoundType", "tags": [], - "label": "control", - "description": [], + "label": "ne", + "description": [ + "a {@link LngLatLike } object describing the northeast corner of the bounding box." + ], "signature": [ - "maplibregl.Control | maplibregl.IControl" + "maplibregl.LngLatLike" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "`this`" + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.hasControl", + "id": "def-server.LngLatBounds.setSouthWest", "type": "Function", "tags": [], - "label": "hasControl", + "label": "setSouthWest", "description": [ - "\nChecks if a control exists on the map.\n" + "\nSet the southwest corner of the bounding box\n" ], "signature": [ - "(control: maplibregl.IControl) => boolean" + "(sw: maplibregl.LngLatLike) => this" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.hasControl.$1", - "type": "Object", + "id": "def-server.LngLatBounds.setSouthWest.$1", + "type": "CompoundType", "tags": [], - "label": "control", + "label": "sw", "description": [ - "The {@link IControl } to check." + "a {@link LngLatLike } object describing the southwest corner of the bounding box." ], "signature": [ - "maplibregl.IControl" + "maplibregl.LngLatLike" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true } ], "returnComment": [ - "True if map contains control." + "`this`" ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.resize", + "id": "def-server.LngLatBounds.extend", "type": "Function", "tags": [], - "label": "resize", - "description": [], + "label": "extend", + "description": [ + "\nExtend the bounds to include a given LngLatLike or LngLatBoundsLike.\n" + ], "signature": [ - "(eventData?: maplibregl.EventData | undefined) => this" + "(obj: maplibregl.LngLatBoundsLike | maplibregl.LngLatLike) => any" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.resize.$1", - "type": "Object", + "id": "def-server.LngLatBounds.extend.$1", + "type": "CompoundType", "tags": [], - "label": "eventData", - "description": [], + "label": "obj", + "description": [ + "object to extend to" + ], "signature": [ - "maplibregl.EventData | undefined" + "maplibregl.LngLatBoundsLike | maplibregl.LngLatLike" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "`this`" + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getBounds", + "id": "def-server.LngLatBounds.getCenter", "type": "Function", "tags": [], - "label": "getBounds", - "description": [], + "label": "getCenter", + "description": [ + "\nReturns the geographical coordinate equidistant from the bounding box's corners.\n" + ], "signature": [ - "() => maplibregl.LngLatBounds" + "() => maplibregl.LngLat" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [], - "returnComment": [] + "returnComment": [ + "The bounding box's center." + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getMaxBounds", + "id": "def-server.LngLatBounds.getSouthWest", "type": "Function", "tags": [], - "label": "getMaxBounds", - "description": [], + "label": "getSouthWest", + "description": [ + "\nReturns the southwest corner of the bounding box.\n" + ], "signature": [ - "() => maplibregl.LngLatBounds | null" + "() => maplibregl.LngLat" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [], - "returnComment": [] + "returnComment": [ + "The southwest corner of the bounding box." + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setMaxBounds", + "id": "def-server.LngLatBounds.getNorthEast", "type": "Function", "tags": [], - "label": "setMaxBounds", - "description": [], + "label": "getNorthEast", + "description": [ + "\nReturns the northeast corner of the bounding box.\n" + ], "signature": [ - "(lnglatbounds?: maplibregl.LngLatBoundsLike | undefined) => this" + "() => maplibregl.LngLat" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setMaxBounds.$1", - "type": "CompoundType", - "tags": [], - "label": "lnglatbounds", - "description": [], - "signature": [ - "maplibregl.LngLatBoundsLike | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] + "children": [], + "returnComment": [ + "The northeast corner of the bounding box." + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setMinZoom", + "id": "def-server.LngLatBounds.getNorthWest", "type": "Function", "tags": [], - "label": "setMinZoom", - "description": [], + "label": "getNorthWest", + "description": [ + "\nReturns the northwest corner of the bounding box.\n" + ], "signature": [ - "(minZoom?: number | null | undefined) => this" + "() => maplibregl.LngLat" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setMinZoom.$1", - "type": "CompoundType", - "tags": [], - "label": "minZoom", - "description": [], - "signature": [ - "number | null | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] + "children": [], + "returnComment": [ + "The northwest corner of the bounding box." + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getMinZoom", + "id": "def-server.LngLatBounds.getSouthEast", "type": "Function", "tags": [], - "label": "getMinZoom", - "description": [], + "label": "getSouthEast", + "description": [ + "\nReturns the southeast corner of the bounding box.\n" + ], "signature": [ - "() => number" + "() => maplibregl.LngLat" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [], - "returnComment": [] + "returnComment": [ + "The southeast corner of the bounding box." + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setMaxZoom", + "id": "def-server.LngLatBounds.getWest", "type": "Function", "tags": [], - "label": "setMaxZoom", - "description": [], + "label": "getWest", + "description": [ + "\nReturns the west edge of the bounding box.\n" + ], "signature": [ - "(maxZoom?: number | null | undefined) => this" + "() => number" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setMaxZoom.$1", - "type": "CompoundType", - "tags": [], - "label": "maxZoom", - "description": [], - "signature": [ - "number | null | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] + "children": [], + "returnComment": [ + "The west edge of the bounding box." + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getMaxZoom", + "id": "def-server.LngLatBounds.getSouth", "type": "Function", "tags": [], - "label": "getMaxZoom", - "description": [], + "label": "getSouth", + "description": [ + "\nReturns the south edge of the bounding box.\n" + ], "signature": [ "() => number" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [], - "returnComment": [] + "returnComment": [ + "The south edge of the bounding box." + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setMinPitch", + "id": "def-server.LngLatBounds.getEast", "type": "Function", "tags": [], - "label": "setMinPitch", - "description": [], + "label": "getEast", + "description": [ + "\nReturns the east edge of the bounding box.\n" + ], "signature": [ - "(minPitch?: number | null | undefined) => this" + "() => number" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setMinPitch.$1", - "type": "CompoundType", - "tags": [], - "label": "minPitch", - "description": [], - "signature": [ - "number | null | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] + "children": [], + "returnComment": [ + "The east edge of the bounding box." + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getMinPitch", + "id": "def-server.LngLatBounds.getNorth", "type": "Function", "tags": [], - "label": "getMinPitch", - "description": [], + "label": "getNorth", + "description": [ + "\nReturns the north edge of the bounding box.\n" + ], "signature": [ "() => number" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [], - "returnComment": [] + "returnComment": [ + "The north edge of the bounding box." + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setMaxPitch", + "id": "def-server.LngLatBounds.toArray", "type": "Function", "tags": [], - "label": "setMaxPitch", - "description": [], + "label": "toArray", + "description": [ + "\nReturns the bounding box represented as an array.\n" + ], "signature": [ - "(maxPitch?: number | null | undefined) => this" + "() => number[][]" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setMaxPitch.$1", - "type": "CompoundType", - "tags": [], - "label": "maxPitch", - "description": [], - "signature": [ - "number | null | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] + "children": [], + "returnComment": [ + "The bounding box represented as an array, consisting of the\nsouthwest and northeast coordinates of the bounding represented as arrays of numbers." + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getMaxPitch", + "id": "def-server.LngLatBounds.toString", "type": "Function", "tags": [], - "label": "getMaxPitch", - "description": [], + "label": "toString", + "description": [ + "\nReturn the bounding box represented as a string.\n" + ], "signature": [ - "() => number" + "() => string" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [], - "returnComment": [] + "returnComment": [ + "The bounding box represents as a string of the format\n`'LngLatBounds(LngLat(lng, lat), LngLat(lng, lat))'`." + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getRenderWorldCopies", + "id": "def-server.LngLatBounds.isEmpty", "type": "Function", "tags": [], - "label": "getRenderWorldCopies", - "description": [], + "label": "isEmpty", + "description": [ + "\nCheck if the bounding box is an empty/`null`-type box.\n" + ], "signature": [ "() => boolean" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [], - "returnComment": [] + "returnComment": [ + "True if bounds have been defined, otherwise false." + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setRenderWorldCopies", + "id": "def-server.LngLatBounds.contains", "type": "Function", "tags": [], - "label": "setRenderWorldCopies", - "description": [], + "label": "contains", + "description": [ + "\nCheck if the point is within the bounding box.\n" + ], "signature": [ - "(renderWorldCopies?: boolean | undefined) => this" + "(lnglat: maplibregl.LngLatLike) => boolean" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setRenderWorldCopies.$1", + "id": "def-server.LngLatBounds.contains.$1", "type": "CompoundType", "tags": [], - "label": "renderWorldCopies", - "description": [], + "label": "lnglat", + "description": [ + "geographic point to check against." + ], "signature": [ - "boolean | undefined" + "maplibregl.LngLatLike" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "True if the point is within the bounding box." + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.project", + "id": "def-server.LngLatBounds.convert", "type": "Function", "tags": [], - "label": "project", - "description": [], + "label": "convert", + "description": [ + "\nConverts an array to a `LngLatBounds` object.\n\nIf a `LngLatBounds` object is passed in, the function returns it unchanged.\n\nInternally, the function calls `LngLat#convert` to convert arrays to `LngLat` values.\n" + ], "signature": [ - "(lnglat: maplibregl.LngLatLike) => maplibregl.Point" + "(input: maplibregl.LngLatBoundsLike | null) => maplibregl.LngLatBounds" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.project.$1", + "id": "def-server.LngLatBounds.convert.$1", "type": "CompoundType", "tags": [], - "label": "lnglat", - "description": [], + "label": "input", + "description": [ + "An array of two coordinates to convert, or a `LngLatBounds` object to return." + ], "signature": [ - "maplibregl.LngLatLike" + "maplibregl.LngLatBoundsLike | null" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "isRequired": true + "isRequired": false } ], - "returnComment": [] - }, + "returnComment": [ + "A new `LngLatBounds` object, if a conversion occurred, or the original `LngLatBounds` object." + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map", + "type": "Class", + "tags": [], + "label": "Map", + "description": [], + "signature": [ + "maplibregl.Map extends Camera" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.unproject", - "type": "Function", + "id": "def-server.Map.style", + "type": "Object", "tags": [], - "label": "unproject", + "label": "style", "description": [], "signature": [ - "(point: maplibregl.PointLike) => maplibregl.LngLat" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.unproject.$1", - "type": "CompoundType", - "tags": [], - "label": "point", - "description": [], - "signature": [ - "maplibregl.PointLike" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - } + "maplibregl.Style" ], - "returnComment": [] + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.isMoving", - "type": "Function", + "id": "def-server.Map.painter", + "type": "Object", "tags": [], - "label": "isMoving", + "label": "painter", "description": [], "signature": [ - "() => boolean" + "maplibregl.Painter" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.isZooming", - "type": "Function", + "id": "def-server.Map.handlers", + "type": "Object", "tags": [], - "label": "isZooming", + "label": "handlers", "description": [], "signature": [ - "() => boolean" + "maplibregl.HandlerManager" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.isRotating", - "type": "Function", + "id": "def-server.Map._container", + "type": "Object", "tags": [], - "label": "isRotating", + "label": "_container", "description": [], "signature": [ - "() => boolean" + "HTMLElement" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.queryRenderedFeatures", - "type": "Function", + "id": "def-server.Map._canvasContainer", + "type": "Object", "tags": [], - "label": "queryRenderedFeatures", - "description": [ - "\nReturns an array of GeoJSON Feature objects representing visible features that satisfy the query parameters.\n\nThe properties value of each returned feature object contains the properties of its source feature. For GeoJSON sources, only string and numeric property values are supported (i.e. null, Array, and Object values are not supported).\n\nEach feature includes top-level layer, source, and sourceLayer properties. The layer property is an object representing the style layer to which the feature belongs. Layout and paint properties in this object contain values which are fully evaluated for the given zoom level and feature.\n\nOnly features that are currently rendered are included. Some features will not be included, like:\n\n- Features from layers whose visibility property is \"none\".\n- Features from layers whose zoom range excludes the current zoom level.\n- Symbol features that have been hidden due to text or icon collision.\n\nFeatures from all other layers are included, including features that may have no visible contribution to the rendered result; for example, because the layer's opacity or color alpha component is set to 0.\n\nThe topmost rendered feature appears first in the returned array, and subsequent features are sorted by descending z-order. Features that are rendered multiple times (due to wrapping across the antimeridian at low zoom levels) are returned only once (though subject to the following caveat).\n\nBecause features come from tiled vector data or GeoJSON data that is converted to tiles internally, feature geometries may be split or duplicated across tile boundaries and, as a result, features may appear multiple times in query results. For example, suppose there is a highway running through the bounding rectangle of a query. The results of the query will be those parts of the highway that lie within the map tiles covering the bounding rectangle, even if the highway extends into other tiles, and the portion of the highway within each map tile will be returned as a separate feature. Similarly, a point feature near a tile boundary may appear in multiple tiles due to tile buffering.\n" - ], + "label": "_canvasContainer", + "description": [], "signature": [ - "(pointOrBox?: maplibregl.PointLike | [maplibregl.PointLike, maplibregl.PointLike] | undefined, options?: ({ layers?: string[] | undefined; filter?: any[] | undefined; } & maplibregl.FilterOptions) | undefined) => maplibregl.MapboxGeoJSONFeature[]" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.queryRenderedFeatures.$1", - "type": "CompoundType", - "tags": [], - "label": "pointOrBox", - "description": [ - "The geometry of the query region: either a single point or southwest and northeast points describing a bounding box. Omitting this parameter (i.e. calling Map#queryRenderedFeatures with zero arguments, or with only a options argument) is equivalent to passing a bounding box encompassing the entire map viewport." - ], - "signature": [ - "maplibregl.PointLike | [maplibregl.PointLike, maplibregl.PointLike] | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.queryRenderedFeatures.$2", - "type": "CompoundType", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "({ layers?: string[] | undefined; filter?: any[] | undefined; } & maplibregl.FilterOptions) | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": false - } + "HTMLElement" ], - "returnComment": [] + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.querySourceFeatures", - "type": "Function", + "id": "def-server.Map._controlContainer", + "type": "Object", "tags": [], - "label": "querySourceFeatures", - "description": [ - "\nReturns an array of GeoJSON Feature objects representing features within the specified vector tile or GeoJSON source that satisfy the query parameters.\n\nIn contrast to Map#queryRenderedFeatures, this function returns all features matching the query parameters, whether or not they are rendered by the current style (i.e. visible). The domain of the query includes all currently-loaded vector tiles and GeoJSON source tiles: this function does not check tiles outside the currently visible viewport.\n\nBecause features come from tiled vector data or GeoJSON data that is converted to tiles internally, feature geometries may be split or duplicated across tile boundaries and, as a result, features may appear multiple times in query results. For example, suppose there is a highway running through the bounding rectangle of a query. The results of the query will be those parts of the highway that lie within the map tiles covering the bounding rectangle, even if the highway extends into other tiles, and the portion of the highway within each map tile will be returned as a separate feature. Similarly, a point feature near a tile boundary may appear in multiple tiles due to tile buffering.\n" - ], + "label": "_controlContainer", + "description": [], "signature": [ - "(sourceID: string, parameters?: ({ sourceLayer?: string | undefined; filter?: any[] | undefined; } & maplibregl.FilterOptions) | undefined) => maplibregl.MapboxGeoJSONFeature[]" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.querySourceFeatures.$1", - "type": "string", - "tags": [], - "label": "sourceID", - "description": [ - "The ID of the vector tile or GeoJSON source to query." - ], - "signature": [ - "string" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.querySourceFeatures.$2", - "type": "CompoundType", - "tags": [], - "label": "parameters", - "description": [], - "signature": [ - "({ sourceLayer?: string | undefined; filter?: any[] | undefined; } & maplibregl.FilterOptions) | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": false - } + "HTMLElement" ], - "returnComment": [] + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setStyle", - "type": "Function", + "id": "def-server.Map._controlPositions", + "type": "Object", "tags": [], - "label": "setStyle", + "label": "_controlPositions", "description": [], "signature": [ - "(style: string | maplibregl.Style, options?: { diff?: boolean | undefined; localIdeographFontFamily?: string | undefined; } | undefined) => this" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setStyle.$1", - "type": "CompoundType", - "tags": [], - "label": "style", - "description": [], - "signature": [ - "string | maplibregl.Style" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setStyle.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setStyle.$2.diff", - "type": "CompoundType", - "tags": [], - "label": "diff", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setStyle.$2.localIdeographFontFamily", - "type": "string", - "tags": [], - "label": "localIdeographFontFamily", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false - } - ] - } + "{ [_: string]: HTMLElement; }" ], - "returnComment": [] + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setTransformRequest", - "type": "Function", + "id": "def-server.Map._interactive", + "type": "boolean", "tags": [], - "label": "setTransformRequest", + "label": "_interactive", "description": [], - "signature": [ - "(transformRequest: maplibregl.TransformRequestFunction) => void" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setTransformRequest.$1", - "type": "Function", - "tags": [], - "label": "transformRequest", - "description": [], - "signature": [ - "maplibregl.TransformRequestFunction" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getStyle", - "type": "Function", + "id": "def-server.Map._showTileBoundaries", + "type": "boolean", "tags": [], - "label": "getStyle", + "label": "_showTileBoundaries", "description": [], - "signature": [ - "() => maplibregl.Style" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.isStyleLoaded", - "type": "Function", + "id": "def-server.Map._showCollisionBoxes", + "type": "boolean", "tags": [], - "label": "isStyleLoaded", + "label": "_showCollisionBoxes", "description": [], - "signature": [ - "() => boolean" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.addSource", - "type": "Function", + "id": "def-server.Map._showPadding", + "type": "boolean", "tags": [], - "label": "addSource", + "label": "_showPadding", "description": [], - "signature": [ - "(id: string, source: maplibregl.AnySourceData) => this" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.addSource.$1", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.addSource.$2", - "type": "CompoundType", - "tags": [], - "label": "source", - "description": [], - "signature": [ - "maplibregl.AnySourceData" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.isSourceLoaded", - "type": "Function", + "id": "def-server.Map._showOverdrawInspector", + "type": "boolean", "tags": [], - "label": "isSourceLoaded", + "label": "_showOverdrawInspector", "description": [], - "signature": [ - "(id: string) => boolean" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.isSourceLoaded.$1", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.areTilesLoaded", - "type": "Function", + "id": "def-server.Map._repaint", + "type": "boolean", "tags": [], - "label": "areTilesLoaded", + "label": "_repaint", "description": [], - "signature": [ - "() => boolean" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.removeSource", - "type": "Function", + "id": "def-server.Map._vertices", + "type": "boolean", "tags": [], - "label": "removeSource", + "label": "_vertices", "description": [], - "signature": [ - "(id: string) => this" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.removeSource.$1", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getSource", - "type": "Function", + "id": "def-server.Map._canvas", + "type": "Object", "tags": [], - "label": "getSource", + "label": "_canvas", "description": [], "signature": [ - "(id: string) => maplibregl.AnySourceImpl" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getSource.$1", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - } + "HTMLCanvasElement" ], - "returnComment": [] + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.addImage", - "type": "Function", + "id": "def-server.Map._maxTileCacheSize", + "type": "number", "tags": [], - "label": "addImage", + "label": "_maxTileCacheSize", "description": [], - "signature": [ - "(name: string, image: ArrayBufferView | HTMLImageElement | { width: number; height: number; data: Uint8Array | Uint8ClampedArray; } | ImageData | ImageBitmap, options?: { pixelRatio?: number | undefined; sdf?: boolean | undefined; } | undefined) => this" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.addImage.$1", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "signature": [ - "string" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.addImage.$2", - "type": "CompoundType", - "tags": [], - "label": "image", - "description": [], - "signature": [ - "ArrayBufferView | HTMLImageElement | { width: number; height: number; data: Uint8Array | Uint8ClampedArray; } | ImageData | ImageBitmap" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.addImage.$3", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.addImage.$3.pixelRatio", - "type": "number", - "tags": [], - "label": "pixelRatio", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.addImage.$3.sdf", - "type": "CompoundType", - "tags": [], - "label": "sdf", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false - } - ] - } - ], - "returnComment": [] + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.hasImage", - "type": "Function", + "id": "def-server.Map._frame", + "type": "Object", "tags": [], - "label": "hasImage", + "label": "_frame", "description": [], "signature": [ - "(name: string) => boolean" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.hasImage.$1", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "signature": [ - "string" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - } + "{ cancel: () => void; }" ], - "returnComment": [] + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.removeImage", - "type": "Function", + "id": "def-server.Map._styleDirty", + "type": "boolean", "tags": [], - "label": "removeImage", + "label": "_styleDirty", "description": [], - "signature": [ - "(name: string) => this" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.removeImage.$1", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "signature": [ - "string" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.loadImage", - "type": "Function", + "id": "def-server.Map._sourcesDirty", + "type": "boolean", "tags": [], - "label": "loadImage", + "label": "_sourcesDirty", "description": [], - "signature": [ - "(url: string, callback: Function) => this" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.loadImage.$1", - "type": "string", - "tags": [], - "label": "url", - "description": [], - "signature": [ - "string" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.loadImage.$2", - "type": "Object", - "tags": [], - "label": "callback", - "description": [], - "signature": [ - "Function" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.listImages", - "type": "Function", + "id": "def-server.Map._placementDirty", + "type": "boolean", "tags": [], - "label": "listImages", + "label": "_placementDirty", "description": [], - "signature": [ - "() => string[]" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.addLayer", - "type": "Function", + "id": "def-server.Map._loaded", + "type": "boolean", "tags": [], - "label": "addLayer", + "label": "_loaded", "description": [], - "signature": [ - "(layer: maplibregl.AnyLayer, before?: string | undefined) => this" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [ + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map._fullyLoaded", + "type": "boolean", + "tags": [], + "label": "_fullyLoaded", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map._trackResize", + "type": "boolean", + "tags": [], + "label": "_trackResize", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map._preserveDrawingBuffer", + "type": "boolean", + "tags": [], + "label": "_preserveDrawingBuffer", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map._failIfMajorPerformanceCaveat", + "type": "boolean", + "tags": [], + "label": "_failIfMajorPerformanceCaveat", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map._antialias", + "type": "boolean", + "tags": [], + "label": "_antialias", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map._refreshExpiredTiles", + "type": "boolean", + "tags": [], + "label": "_refreshExpiredTiles", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map._hash", + "type": "Object", + "tags": [], + "label": "_hash", + "description": [], + "signature": [ + "maplibregl.Hash" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map._delegatedListeners", + "type": "Any", + "tags": [], + "label": "_delegatedListeners", + "description": [], + "signature": [ + "any" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map._fadeDuration", + "type": "number", + "tags": [], + "label": "_fadeDuration", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map._crossSourceCollisions", + "type": "boolean", + "tags": [], + "label": "_crossSourceCollisions", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map._crossFadingFactor", + "type": "number", + "tags": [], + "label": "_crossFadingFactor", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map._collectResourceTiming", + "type": "boolean", + "tags": [], + "label": "_collectResourceTiming", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map._renderTaskQueue", + "type": "Object", + "tags": [], + "label": "_renderTaskQueue", + "description": [], + "signature": [ + "maplibregl.TaskQueue" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map._controls", + "type": "Array", + "tags": [], + "label": "_controls", + "description": [], + "signature": [ + "maplibregl.IControl[]" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map._mapId", + "type": "number", + "tags": [], + "label": "_mapId", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map._localIdeographFontFamily", + "type": "string", + "tags": [], + "label": "_localIdeographFontFamily", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map._requestManager", + "type": "Object", + "tags": [], + "label": "_requestManager", + "description": [], + "signature": [ + "maplibregl.RequestManager" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map._locale", + "type": "Any", + "tags": [], + "label": "_locale", + "description": [], + "signature": [ + "any" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map._removed", + "type": "boolean", + "tags": [], + "label": "_removed", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map._clickTolerance", + "type": "number", + "tags": [], + "label": "_clickTolerance", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map._pixelRatio", + "type": "number", + "tags": [], + "label": "_pixelRatio", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.scrollZoom", + "type": "Object", + "tags": [], + "label": "scrollZoom", + "description": [ + "\nThe map's {@link ScrollZoomHandler}, which implements zooming in and out with a scroll wheel or trackpad.\nFind more details and examples using `scrollZoom` in the {@link ScrollZoomHandler} section." + ], + "signature": [ + "maplibregl.ScrollZoomHandler" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.boxZoom", + "type": "Object", + "tags": [], + "label": "boxZoom", + "description": [ + "\nThe map's {@link BoxZoomHandler}, which implements zooming using a drag gesture with the Shift key pressed.\nFind more details and examples using `boxZoom` in the {@link BoxZoomHandler} section." + ], + "signature": [ + "maplibregl.BoxZoomHandler" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.dragRotate", + "type": "Object", + "tags": [], + "label": "dragRotate", + "description": [ + "\nThe map's {@link DragRotateHandler}, which implements rotating the map while dragging with the right\nmouse button or with the Control key pressed. Find more details and examples using `dragRotate`\nin the {@link DragRotateHandler} section." + ], + "signature": [ + "maplibregl.DragRotateHandler" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.dragPan", + "type": "Object", + "tags": [], + "label": "dragPan", + "description": [ + "\nThe map's {@link DragPanHandler}, which implements dragging the map with a mouse or touch gesture.\nFind more details and examples using `dragPan` in the {@link DragPanHandler} section." + ], + "signature": [ + "maplibregl.DragPanHandler" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.keyboard", + "type": "Object", + "tags": [], + "label": "keyboard", + "description": [ + "\nThe map's {@link KeyboardHandler}, which allows the user to zoom, rotate, and pan the map using keyboard\nshortcuts. Find more details and examples using `keyboard` in the {@link KeyboardHandler} section." + ], + "signature": [ + "maplibregl.KeyboardHandler" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.doubleClickZoom", + "type": "Object", + "tags": [], + "label": "doubleClickZoom", + "description": [ + "\nThe map's {@link DoubleClickZoomHandler}, which allows the user to zoom by double clicking.\nFind more details and examples using `doubleClickZoom` in the {@link DoubleClickZoomHandler} section." + ], + "signature": [ + "maplibregl.DoubleClickZoomHandler" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.touchZoomRotate", + "type": "Object", + "tags": [], + "label": "touchZoomRotate", + "description": [ + "\nThe map's {@link TouchZoomRotateHandler}, which allows the user to zoom or rotate the map with touch gestures.\nFind more details and examples using `touchZoomRotate` in the {@link TouchZoomRotateHandler} section." + ], + "signature": [ + "maplibregl.TouchZoomRotateHandler" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.touchPitch", + "type": "Object", + "tags": [], + "label": "touchPitch", + "description": [ + "\nThe map's {@link TouchPitchHandler}, which allows the user to pitch the map with touch gestures.\nFind more details and examples using `touchPitch` in the {@link TouchPitchHandler} section." + ], + "signature": [ + "maplibregl.TouchPitchHandler" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "maplibregl.MapOptions" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map._getMapId", + "type": "Function", + "tags": [], + "label": "_getMapId", + "description": [], + "signature": [ + "() => number" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.addControl", + "type": "Function", + "tags": [ + "see" + ], + "label": "addControl", + "description": [ + "\nAdds an {@link IControl} to the map, calling `control.onAdd(this)`.\n" + ], + "signature": [ + "(control: maplibregl.IControl, position?: maplibregl.ControlPosition | undefined) => this" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.addControl.$1", + "type": "Object", + "tags": [], + "label": "control", + "description": [ + "The {@link IControl } to add." + ], + "signature": [ + "maplibregl.IControl" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.addControl.$2", + "type": "CompoundType", + "tags": [], + "label": "position", + "description": [ + "position on the map to which the control will be added.\nValid values are `'top-left'`, `'top-right'`, `'bottom-left'`, and `'bottom-right'`. Defaults to `'top-right'`." + ], + "signature": [ + "maplibregl.ControlPosition | undefined" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "`this`" + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.removeControl", + "type": "Function", + "tags": [], + "label": "removeControl", + "description": [ + "\nRemoves the control from the map.\n" + ], + "signature": [ + "(control: maplibregl.IControl) => this" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.removeControl.$1", + "type": "Object", + "tags": [], + "label": "control", + "description": [ + "The {@link IControl } to remove." + ], + "signature": [ + "maplibregl.IControl" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "`this`" + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.hasControl", + "type": "Function", + "tags": [], + "label": "hasControl", + "description": [ + "\nChecks if a control exists on the map.\n" + ], + "signature": [ + "(control: maplibregl.IControl) => boolean" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.hasControl.$1", + "type": "Object", + "tags": [], + "label": "control", + "description": [ + "The {@link IControl } to check." + ], + "signature": [ + "maplibregl.IControl" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "True if map contains control." + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.resize", + "type": "Function", + "tags": [], + "label": "resize", + "description": [ + "\nResizes the map according to the dimensions of its\n`container` element.\n\nChecks if the map container size changed and updates the map if it has changed.\nThis method must be called after the map's `container` is resized programmatically\nor when the map is shown after being initially hidden with CSS.\n" + ], + "signature": [ + "(eventData?: any) => this" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.resize.$1", + "type": "Any", + "tags": [], + "label": "eventData", + "description": [ + "Additional properties to be passed to `movestart`, `move`, `resize`, and `moveend`\nevents that get triggered as a result of resize. This can be useful for differentiating the\nsource of an event (for example, user-initiated or programmatically-triggered events)." + ], + "signature": [ + "any" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "`this`" + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.getPixelRatio", + "type": "Function", + "tags": [], + "label": "getPixelRatio", + "description": [ + "\nReturns the map's pixel ratio." + ], + "signature": [ + "() => number" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [], + "returnComment": [ + "The pixel ratio." + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.setPixelRatio", + "type": "Function", + "tags": [], + "label": "setPixelRatio", + "description": [ + "\nSets the map's pixel ratio. This allows to override `devicePixelRatio`.\nAfter this call, the canvas' `width` attribute will be `container.clientWidth * pixelRatio`\nand its height attribute will be `container.clientHeight * pixelRatio`." + ], + "signature": [ + "(pixelRatio: number) => void" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.setPixelRatio.$1", + "type": "number", + "tags": [], + "label": "pixelRatio", + "description": [ + "The pixel ratio." + ], + "signature": [ + "number" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.getBounds", + "type": "Function", + "tags": [], + "label": "getBounds", + "description": [ + "\nReturns the map's geographical bounds. When the bearing or pitch is non-zero, the visible region is not\nan axis-aligned rectangle, and the result is the smallest bounds that encompasses the visible region." + ], + "signature": [ + "() => maplibregl.LngLatBounds" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [], + "returnComment": [ + "The geographical bounds of the map as {@link LngLatBounds }." + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.getMaxBounds", + "type": "Function", + "tags": [], + "label": "getMaxBounds", + "description": [ + "\nReturns the maximum geographical bounds the map is constrained to, or `null` if none set." + ], + "signature": [ + "() => maplibregl.LngLatBounds | null" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [], + "returnComment": [ + "The map object." + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.setMaxBounds", + "type": "Function", + "tags": [], + "label": "setMaxBounds", + "description": [ + "\nSets or clears the map's geographical bounds.\n\nPan and zoom operations are constrained within these bounds.\nIf a pan or zoom is performed that would\ndisplay regions outside these bounds, the map will\ninstead display a position and zoom level\nas close as possible to the operation's request while still\nremaining within the bounds.\n" + ], + "signature": [ + "(bounds?: maplibregl.LngLatBoundsLike | null | undefined) => this" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.addLayer.$1", + "id": "def-server.Map.setMaxBounds.$1", "type": "CompoundType", "tags": [], - "label": "layer", - "description": [], - "signature": [ - "maplibregl.AnyLayer" + "label": "bounds", + "description": [ + "The maximum bounds to set. If `null` or `undefined` is provided, the function removes the map's maximum bounds." ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.addLayer.$2", - "type": "string", - "tags": [], - "label": "before", - "description": [], "signature": [ - "string | undefined" + "maplibregl.LngLatBoundsLike | null | undefined" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": false } ], - "returnComment": [] + "returnComment": [ + "`this`" + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.moveLayer", + "id": "def-server.Map.setMinZoom", "type": "Function", "tags": [], - "label": "moveLayer", - "description": [], + "label": "setMinZoom", + "description": [ + "\nSets or clears the map's minimum zoom level.\nIf the map's current zoom level is lower than the new minimum,\nthe map will zoom to the new minimum.\n\nIt is not always possible to zoom out and reach the set `minZoom`.\nOther factors such as map height may restrict zooming. For example,\nif the map is 512px tall it will not be possible to zoom below zoom 0\nno matter what the `minZoom` is set to.\n" + ], "signature": [ - "(id: string, beforeId?: string | undefined) => this" + "(minZoom?: number | null | undefined) => this" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.moveLayer.$1", - "type": "string", + "id": "def-server.Map.setMinZoom.$1", + "type": "CompoundType", "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" + "label": "minZoom", + "description": [ + "The minimum zoom level to set (-2 - 24).\nIf `null` or `undefined` is provided, the function removes the current minimum zoom (i.e. sets it to -2)." ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.moveLayer.$2", - "type": "string", - "tags": [], - "label": "beforeId", - "description": [], "signature": [ - "string | undefined" + "number | null | undefined" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": false } ], - "returnComment": [] + "returnComment": [ + "`this`" + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.removeLayer", + "id": "def-server.Map.getMinZoom", "type": "Function", "tags": [], - "label": "removeLayer", - "description": [], + "label": "getMinZoom", + "description": [ + "\nReturns the map's minimum allowable zoom level.\n" + ], "signature": [ - "(id: string) => this" + "() => number" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.removeLayer.$1", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "children": [], + "returnComment": [ + "minZoom" + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getLayer", + "id": "def-server.Map.setMaxZoom", "type": "Function", "tags": [], - "label": "getLayer", - "description": [], + "label": "setMaxZoom", + "description": [ + "\nSets or clears the map's maximum zoom level.\nIf the map's current zoom level is higher than the new maximum,\nthe map will zoom to the new maximum.\n" + ], "signature": [ - "(id: string) => maplibregl.AnyLayer" + "(maxZoom?: number | null | undefined) => this" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getLayer.$1", - "type": "string", + "id": "def-server.Map.setMaxZoom.$1", + "type": "CompoundType", "tags": [], - "label": "id", - "description": [], + "label": "maxZoom", + "description": [ + "The maximum zoom level to set.\nIf `null` or `undefined` is provided, the function removes the current maximum zoom (sets it to 22)." + ], "signature": [ - "string" + "number | null | undefined" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "isRequired": true + "isRequired": false } ], - "returnComment": [] + "returnComment": [ + "`this`" + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setFilter", + "id": "def-server.Map.getMaxZoom", "type": "Function", "tags": [], - "label": "setFilter", - "description": [], + "label": "getMaxZoom", + "description": [ + "\nReturns the map's maximum allowable zoom level.\n" + ], + "signature": [ + "() => number" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [], + "returnComment": [ + "maxZoom" + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.setMinPitch", + "type": "Function", + "tags": [], + "label": "setMinPitch", + "description": [ + "\nSets or clears the map's minimum pitch.\nIf the map's current pitch is lower than the new minimum,\nthe map will pitch to the new minimum.\n" + ], "signature": [ - "(layer: string, filter?: boolean | any[] | null | undefined, options?: maplibregl.FilterOptions | null | undefined) => this" + "(minPitch?: number | null | undefined) => this" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setFilter.$1", - "type": "string", - "tags": [], - "label": "layer", - "description": [], - "signature": [ - "string" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setFilter.$2", + "id": "def-server.Map.setMinPitch.$1", "type": "CompoundType", "tags": [], - "label": "filter", - "description": [], - "signature": [ - "boolean | any[] | null | undefined" + "label": "minPitch", + "description": [ + "The minimum pitch to set (0-85). Values greater than 60 degrees are experimental and may result in rendering issues. If you encounter any, please raise an issue with details in the MapLibre project.\nIf `null` or `undefined` is provided, the function removes the current minimum pitch (i.e. sets it to 0)." ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setFilter.$3", - "type": "CompoundType", - "tags": [], - "label": "options", - "description": [], "signature": [ - "maplibregl.FilterOptions | null | undefined" + "number | null | undefined" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": false } ], - "returnComment": [] + "returnComment": [ + "`this`" + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setLayerZoomRange", + "id": "def-server.Map.getMinPitch", "type": "Function", "tags": [], - "label": "setLayerZoomRange", - "description": [], + "label": "getMinPitch", + "description": [ + "\nReturns the map's minimum allowable pitch.\n" + ], "signature": [ - "(layerId: string, minzoom: number, maxzoom: number) => this" + "() => number" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [], + "returnComment": [ + "minPitch" + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.setMaxPitch", + "type": "Function", + "tags": [], + "label": "setMaxPitch", + "description": [ + "\nSets or clears the map's maximum pitch.\nIf the map's current pitch is higher than the new maximum,\nthe map will pitch to the new maximum.\n" + ], + "signature": [ + "(maxPitch?: number | null | undefined) => this" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setLayerZoomRange.$1", - "type": "string", - "tags": [], - "label": "layerId", - "description": [], - "signature": [ - "string" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setLayerZoomRange.$2", - "type": "number", + "id": "def-server.Map.setMaxPitch.$1", + "type": "CompoundType", "tags": [], - "label": "minzoom", - "description": [], - "signature": [ - "number" + "label": "maxPitch", + "description": [ + "The maximum pitch to set (0-85). Values greater than 60 degrees are experimental and may result in rendering issues. If you encounter any, please raise an issue with details in the MapLibre project.\nIf `null` or `undefined` is provided, the function removes the current maximum pitch (sets it to 60)." ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setLayerZoomRange.$3", - "type": "number", - "tags": [], - "label": "maxzoom", - "description": [], "signature": [ - "number" + "number | null | undefined" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "isRequired": true + "isRequired": false } ], - "returnComment": [] + "returnComment": [ + "`this`" + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.getMaxPitch", + "type": "Function", + "tags": [], + "label": "getMaxPitch", + "description": [ + "\nReturns the map's maximum allowable pitch.\n" + ], + "signature": [ + "() => number" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [], + "returnComment": [ + "maxPitch" + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getFilter", + "id": "def-server.Map.getRenderWorldCopies", "type": "Function", - "tags": [], - "label": "getFilter", - "description": [], + "tags": [ + "see" + ], + "label": "getRenderWorldCopies", + "description": [ + "\nReturns the state of `renderWorldCopies`. If `true`, multiple copies of the world will be rendered side by side beyond -180 and 180 degrees longitude. If set to `false`:\n- When the map is zoomed out far enough that a single representation of the world does not fill the map's entire\ncontainer, there will be blank space beyond 180 and -180 degrees longitude.\n- Features that cross 180 and -180 degrees longitude will be cut in two (with one portion on the right edge of the\nmap and the other on the left edge of the map) at every zoom level." + ], "signature": [ - "(layer: string) => any[]" + "() => boolean" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getFilter.$1", - "type": "string", - "tags": [], - "label": "layer", - "description": [], - "signature": [ - "string" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "children": [], + "returnComment": [ + "renderWorldCopies" + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setPaintProperty", + "id": "def-server.Map.setRenderWorldCopies", "type": "Function", - "tags": [], - "label": "setPaintProperty", - "description": [], + "tags": [ + "see" + ], + "label": "setRenderWorldCopies", + "description": [ + "\nSets the state of `renderWorldCopies`.\n" + ], "signature": [ - "(layer: string, name: string, value: any, klass?: string | undefined) => this" + "(renderWorldCopies?: boolean | null | undefined) => this" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setPaintProperty.$1", - "type": "string", - "tags": [], - "label": "layer", - "description": [], - "signature": [ - "string" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setPaintProperty.$2", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "signature": [ - "string" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setPaintProperty.$3", - "type": "Any", + "id": "def-server.Map.setRenderWorldCopies.$1", + "type": "CompoundType", "tags": [], - "label": "value", - "description": [], - "signature": [ - "any" + "label": "renderWorldCopies", + "description": [ + "If `true`, multiple copies of the world will be rendered side by side beyond -180 and 180 degrees longitude. If set to `false`:\n- When the map is zoomed out far enough that a single representation of the world does not fill the map's entire\ncontainer, there will be blank space beyond 180 and -180 degrees longitude.\n- Features that cross 180 and -180 degrees longitude will be cut in two (with one portion on the right edge of the\nmap and the other on the left edge of the map) at every zoom level.\n\n`undefined` is treated as `true`, `null` is treated as `false`." ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setPaintProperty.$4", - "type": "string", - "tags": [], - "label": "klass", - "description": [], "signature": [ - "string | undefined" + "boolean | null | undefined" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": false } ], - "returnComment": [] + "returnComment": [ + "`this`" + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getPaintProperty", + "id": "def-server.Map.project", "type": "Function", "tags": [], - "label": "getPaintProperty", - "description": [], + "label": "project", + "description": [ + "\nReturns a [Point](https://github.com/mapbox/point-geometry) representing pixel coordinates, relative to the map's `container`,\nthat correspond to the specified geographical location.\n" + ], "signature": [ - "(layer: string, name: string) => any" + "(lnglat: maplibregl.LngLatLike) => ", + "node_modules/@types/mapbox__point-geometry/index" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getPaintProperty.$1", - "type": "string", + "id": "def-server.Map.project.$1", + "type": "CompoundType", "tags": [], - "label": "layer", - "description": [], - "signature": [ - "string" + "label": "lnglat", + "description": [ + "The geographical location to project." ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getPaintProperty.$2", - "type": "string", - "tags": [], - "label": "name", - "description": [], "signature": [ - "string" + "maplibregl.LngLatLike" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "The [Point](https://github.com/mapbox/point-geometry) corresponding to `lnglat`, relative to the map's `container`." + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setLayoutProperty", + "id": "def-server.Map.unproject", "type": "Function", "tags": [], - "label": "setLayoutProperty", - "description": [], + "label": "unproject", + "description": [ + "\nReturns a {@link LngLat} representing geographical coordinates that correspond\nto the specified pixel coordinates.\n" + ], "signature": [ - "(layer: string, name: string, value: any) => this" + "(point: maplibregl.PointLike) => maplibregl.LngLat" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setLayoutProperty.$1", - "type": "string", - "tags": [], - "label": "layer", - "description": [], - "signature": [ - "string" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setLayoutProperty.$2", - "type": "string", + "id": "def-server.Map.unproject.$1", + "type": "CompoundType", "tags": [], - "label": "name", - "description": [], - "signature": [ - "string" + "label": "point", + "description": [ + "The pixel coordinates to unproject." ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setLayoutProperty.$3", - "type": "Any", - "tags": [], - "label": "value", - "description": [], "signature": [ - "any" + "maplibregl.PointLike" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "The {@link LngLat } corresponding to `point`." + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getLayoutProperty", + "id": "def-server.Map.isMoving", "type": "Function", "tags": [], - "label": "getLayoutProperty", - "description": [], + "label": "isMoving", + "description": [ + "\nReturns true if the map is panning, zooming, rotating, or pitching due to a camera animation or user gesture." + ], "signature": [ - "(layer: string, name: string) => any" + "() => boolean" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getLayoutProperty.$1", - "type": "string", - "tags": [], - "label": "layer", - "description": [], - "signature": [ - "string" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getLayoutProperty.$2", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "signature": [ - "string" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - } + "children": [], + "returnComment": [ + "True if the map is moving." + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.isZooming", + "type": "Function", + "tags": [], + "label": "isZooming", + "description": [ + "\nReturns true if the map is zooming due to a camera animation or user gesture." ], - "returnComment": [] + "signature": [ + "() => boolean" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [], + "returnComment": [ + "True if the map is zooming." + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setLight", + "id": "def-server.Map.isRotating", "type": "Function", "tags": [], - "label": "setLight", + "label": "isRotating", + "description": [ + "\nReturns true if the map is rotating due to a camera animation or user gesture." + ], + "signature": [ + "() => boolean" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [], + "returnComment": [ + "True if the map is rotating." + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map._createDelegatedListener", + "type": "Function", + "tags": [], + "label": "_createDelegatedListener", "description": [], "signature": [ - "(options: maplibregl.Light, lightOptions?: any) => this" + "(type: string, layerId: string, listener: maplibregl.Listener) => { layer: string; listener: maplibregl.Listener; delegates: { error?: ((e: any) => void) | undefined; load?: ((e: any) => void) | undefined; idle?: ((e: any) => void) | undefined; remove?: ((e: any) => void) | undefined; render?: ((e: any) => void) | undefined; resize?: ((e: any) => void) | undefined; webglcontextlost?: ((e: any) => void) | undefined; webglcontextrestored?: ((e: any) => void) | undefined; dataloading?: ((e: any) => void) | undefined; data?: ((e: any) => void) | undefined; tiledataloading?: ((e: any) => void) | undefined; sourcedataloading?: ((e: any) => void) | undefined; styledataloading?: ((e: any) => void) | undefined; sourcedata?: ((e: any) => void) | undefined; styledata?: ((e: any) => void) | undefined; styleimagemissing?: ((e: any) => void) | undefined; dataabort?: ((e: any) => void) | undefined; sourcedataabort?: ((e: any) => void) | undefined; boxzoomcancel?: ((e: any) => void) | undefined; boxzoomstart?: ((e: any) => void) | undefined; boxzoomend?: ((e: any) => void) | undefined; touchcancel?: ((e: any) => void) | undefined; touchmove?: ((e: any) => void) | undefined; touchend?: ((e: any) => void) | undefined; touchstart?: ((e: any) => void) | undefined; click?: ((e: any) => void) | undefined; contextmenu?: ((e: any) => void) | undefined; dblclick?: ((e: any) => void) | undefined; mousemove?: ((e: any) => void) | undefined; mouseup?: ((e: any) => void) | undefined; mousedown?: ((e: any) => void) | undefined; mouseout?: ((e: any) => void) | undefined; mouseover?: ((e: any) => void) | undefined; movestart?: ((e: any) => void) | undefined; move?: ((e: any) => void) | undefined; moveend?: ((e: any) => void) | undefined; zoomstart?: ((e: any) => void) | undefined; zoom?: ((e: any) => void) | undefined; zoomend?: ((e: any) => void) | undefined; rotatestart?: ((e: any) => void) | undefined; rotate?: ((e: any) => void) | undefined; rotateend?: ((e: any) => void) | undefined; dragstart?: ((e: any) => void) | undefined; drag?: ((e: any) => void) | undefined; dragend?: ((e: any) => void) | undefined; pitchstart?: ((e: any) => void) | undefined; pitch?: ((e: any) => void) | undefined; pitchend?: ((e: any) => void) | undefined; wheel?: ((e: any) => void) | undefined; }; }" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setLight.$1", - "type": "Object", + "id": "def-server.Map._createDelegatedListener.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map._createDelegatedListener.$2", + "type": "string", "tags": [], - "label": "options", + "label": "layerId", "description": [], "signature": [ - "maplibregl.Light" + "string" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setLight.$2", - "type": "Any", + "id": "def-server.Map._createDelegatedListener.$3", + "type": "Function", "tags": [], - "label": "lightOptions", + "label": "listener", "description": [], "signature": [ - "any" + "maplibregl.Listener" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true } @@ -2420,98 +2894,113 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getLight", + "id": "def-server.Map.on", "type": "Function", - "tags": [], - "label": "getLight", - "description": [], - "signature": [ - "() => maplibregl.Light" + "tags": [ + "see", + "see", + "see", + "see" + ], + "label": "on", + "description": [ + "\nAdds a listener for events of a specified type, optionally limited to features in a specified style layer.\n" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setFeatureState", - "type": "Function", - "tags": [], - "label": "setFeatureState", - "description": [], "signature": [ - "(feature: maplibregl.MapboxGeoJSONFeature | maplibregl.FeatureIdentifier, state: { [key: string]: any; }) => void" + "{ (type: T, layer: string, listener: (ev: maplibregl.MapLayerEventType[T] & Object) => void): this; (type: T, listener: (ev: maplibregl.MapEventType[T] & Object) => void): this; (type: string, listener: maplibregl.Listener): this; }" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setFeatureState.$1", - "type": "CompoundType", + "id": "def-server.Map.on.$1", + "type": "Uncategorized", "tags": [], - "label": "feature", - "description": [], + "label": "type", + "description": [ + "The event type to listen for. Events compatible with the optional `layerId` parameter are triggered\nwhen the cursor enters a visible portion of the specified layer from outside that layer or outside the map canvas.\n\n| Event | Compatible with `layerId` |\n|-----------------------------------------------------------|---------------------------|\n| [`mousedown`](#map.event:mousedown) | yes |\n| [`mouseup`](#map.event:mouseup) | yes |\n| [`mouseover`](#map.event:mouseover) | yes |\n| [`mouseout`](#map.event:mouseout) | yes |\n| [`mousemove`](#map.event:mousemove) | yes |\n| [`mouseenter`](#map.event:mouseenter) | yes (required) |\n| [`mouseleave`](#map.event:mouseleave) | yes (required) |\n| [`click`](#map.event:click) | yes |\n| [`dblclick`](#map.event:dblclick) | yes |\n| [`contextmenu`](#map.event:contextmenu) | yes |\n| [`touchstart`](#map.event:touchstart) | yes |\n| [`touchend`](#map.event:touchend) | yes |\n| [`touchcancel`](#map.event:touchcancel) | yes |\n| [`wheel`](#map.event:wheel) | |\n| [`resize`](#map.event:resize) | |\n| [`remove`](#map.event:remove) | |\n| [`touchmove`](#map.event:touchmove) | |\n| [`movestart`](#map.event:movestart) | |\n| [`move`](#map.event:move) | |\n| [`moveend`](#map.event:moveend) | |\n| [`dragstart`](#map.event:dragstart) | |\n| [`drag`](#map.event:drag) | |\n| [`dragend`](#map.event:dragend) | |\n| [`zoomstart`](#map.event:zoomstart) | |\n| [`zoom`](#map.event:zoom) | |\n| [`zoomend`](#map.event:zoomend) | |\n| [`rotatestart`](#map.event:rotatestart) | |\n| [`rotate`](#map.event:rotate) | |\n| [`rotateend`](#map.event:rotateend) | |\n| [`pitchstart`](#map.event:pitchstart) | |\n| [`pitch`](#map.event:pitch) | |\n| [`pitchend`](#map.event:pitchend) | |\n| [`boxzoomstart`](#map.event:boxzoomstart) | |\n| [`boxzoomend`](#map.event:boxzoomend) | |\n| [`boxzoomcancel`](#map.event:boxzoomcancel) | |\n| [`webglcontextlost`](#map.event:webglcontextlost) | |\n| [`webglcontextrestored`](#map.event:webglcontextrestored) | |\n| [`load`](#map.event:load) | |\n| [`render`](#map.event:render) | |\n| [`idle`](#map.event:idle) | |\n| [`error`](#map.event:error) | |\n| [`data`](#map.event:data) | |\n| [`styledata`](#map.event:styledata) | |\n| [`sourcedata`](#map.event:sourcedata) | |\n| [`dataloading`](#map.event:dataloading) | |\n| [`styledataloading`](#map.event:styledataloading) | |\n| [`sourcedataloading`](#map.event:sourcedataloading) | |\n| [`styleimagemissing`](#map.event:styleimagemissing) | |\n| [`dataabort`](#map.event:dataabort) | |\n| [`sourcedataabort`](#map.event:sourcedataabort) | |" + ], "signature": [ - "maplibregl.MapboxGeoJSONFeature | maplibregl.FeatureIdentifier" + "T" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setFeatureState.$2", - "type": "Object", + "id": "def-server.Map.on.$2", + "type": "string", "tags": [], - "label": "state", + "label": "layer", "description": [], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setFeatureState.$2.Unnamed", - "type": "IndexSignature", - "tags": [], - "label": "[key: string]: any", - "description": [], - "signature": [ - "[key: string]: any" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false - } - ] + "signature": [ + "string" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.on.$3", + "type": "Function", + "tags": [], + "label": "listener", + "description": [ + "The function to be called when the event is fired." + ], + "signature": [ + "(ev: maplibregl.MapLayerEventType[T] & Object) => void" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "`this`" + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getFeatureState", + "id": "def-server.Map.on", "type": "Function", "tags": [], - "label": "getFeatureState", + "label": "on", "description": [], "signature": [ - "(feature: maplibregl.MapboxGeoJSONFeature | maplibregl.FeatureIdentifier) => { [key: string]: any; }" + "{ (type: T, layer: string, listener: (ev: maplibregl.MapLayerEventType[T] & Object) => void): this; (type: T, listener: (ev: maplibregl.MapEventType[T] & Object) => void): this; (type: string, listener: maplibregl.Listener): this; }" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getFeatureState.$1", - "type": "CompoundType", + "id": "def-server.Map.on.$1", + "type": "Uncategorized", "tags": [], - "label": "feature", + "label": "type", + "description": [], + "signature": [ + "T" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.on.$2", + "type": "Function", + "tags": [], + "label": "listener", "description": [], "signature": [ - "maplibregl.MapboxGeoJSONFeature | maplibregl.FeatureIdentifier" + "(ev: maplibregl.MapEventType[T] & Object) => void" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true } @@ -2520,618 +3009,628 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.removeFeatureState", + "id": "def-server.Map.on", "type": "Function", "tags": [], - "label": "removeFeatureState", + "label": "on", "description": [], "signature": [ - "(target: maplibregl.MapboxGeoJSONFeature | maplibregl.FeatureIdentifier, key?: string | undefined) => void" + "{ (type: T, layer: string, listener: (ev: maplibregl.MapLayerEventType[T] & Object) => void): this; (type: T, listener: (ev: maplibregl.MapEventType[T] & Object) => void): this; (type: string, listener: maplibregl.Listener): this; }" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.removeFeatureState.$1", - "type": "CompoundType", + "id": "def-server.Map.on.$1", + "type": "string", "tags": [], - "label": "target", + "label": "type", "description": [], "signature": [ - "maplibregl.MapboxGeoJSONFeature | maplibregl.FeatureIdentifier" + "string" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.removeFeatureState.$2", - "type": "string", + "id": "def-server.Map.on.$2", + "type": "Function", "tags": [], - "label": "key", + "label": "listener", "description": [], "signature": [ - "string | undefined" + "maplibregl.Listener" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getContainer", - "type": "Function", - "tags": [], - "label": "getContainer", - "description": [], - "signature": [ - "() => HTMLElement" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getCanvasContainer", - "type": "Function", - "tags": [], - "label": "getCanvasContainer", - "description": [], - "signature": [ - "() => HTMLElement" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getCanvas", - "type": "Function", - "tags": [], - "label": "getCanvas", - "description": [], - "signature": [ - "() => HTMLCanvasElement" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.loaded", - "type": "Function", - "tags": [], - "label": "loaded", - "description": [], - "signature": [ - "() => boolean" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.remove", - "type": "Function", - "tags": [], - "label": "remove", - "description": [], - "signature": [ - "() => void" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.triggerRepaint", + "id": "def-server.Map.once", "type": "Function", - "tags": [], - "label": "triggerRepaint", - "description": [], - "signature": [ - "() => void" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.showTileBoundaries", - "type": "boolean", - "tags": [], - "label": "showTileBoundaries", - "description": [], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.showCollisionBoxes", - "type": "boolean", - "tags": [], - "label": "showCollisionBoxes", - "description": [], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.showPadding", - "type": "boolean", "tags": [ + "method", "name", - "type", - "instance", - "memberof" + "memberof", + "instance" ], - "label": "showPadding", + "label": "once", "description": [ - "\nGets and sets a Boolean indicating whether the map will visualize\nthe padding offsets.\n" + "\nAdds a listener that will be called only once to a specified event type.\n\n\nAdds a listener that will be called only once to a specified event type occurring on features in a specified style layer.\n" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.repaint", - "type": "boolean", - "tags": [], - "label": "repaint", - "description": [], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getCenter", - "type": "Function", - "tags": [], - "label": "getCenter", - "description": [], "signature": [ - "() => maplibregl.LngLat" + "{ (type: T, layer: string, listener: (ev: maplibregl.MapLayerEventType[T] & Object) => void): this; (type: T, listener: (ev: maplibregl.MapEventType[T] & Object) => void): this; (type: string, listener: maplibregl.Listener): this; }" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.once.$1", + "type": "Uncategorized", + "tags": [], + "label": "type", + "description": [ + "The event type to add a listener for." + ], + "signature": [ + "T" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.once.$2", + "type": "string", + "tags": [], + "label": "layer", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.once.$3", + "type": "Function", + "tags": [], + "label": "listener", + "description": [ + "The function to be called when the event is fired.\nThe listener function is called with the data object passed to `fire`,\nextended with `target` and `type` properties." + ], + "signature": [ + "(ev: maplibregl.MapLayerEventType[T] & Object) => void" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "returnComment": [ + "`this`" + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setCenter", + "id": "def-server.Map.once", "type": "Function", "tags": [], - "label": "setCenter", + "label": "once", "description": [], "signature": [ - "(center: maplibregl.LngLatLike, eventData?: maplibregl.EventData | undefined) => this" + "{ (type: T, layer: string, listener: (ev: maplibregl.MapLayerEventType[T] & Object) => void): this; (type: T, listener: (ev: maplibregl.MapEventType[T] & Object) => void): this; (type: string, listener: maplibregl.Listener): this; }" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setCenter.$1", - "type": "CompoundType", + "id": "def-server.Map.once.$1", + "type": "Uncategorized", "tags": [], - "label": "center", + "label": "type", "description": [], "signature": [ - "maplibregl.LngLatLike" + "T" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setCenter.$2", - "type": "Object", + "id": "def-server.Map.once.$2", + "type": "Function", "tags": [], - "label": "eventData", + "label": "listener", "description": [], "signature": [ - "maplibregl.EventData | undefined" + "(ev: maplibregl.MapEventType[T] & Object) => void" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.panBy", + "id": "def-server.Map.once", "type": "Function", "tags": [], - "label": "panBy", + "label": "once", "description": [], "signature": [ - "(offset: maplibregl.PointLike, options?: maplibregl.AnimationOptions | undefined, eventData?: maplibregl.EventData | undefined) => this" + "{ (type: T, layer: string, listener: (ev: maplibregl.MapLayerEventType[T] & Object) => void): this; (type: T, listener: (ev: maplibregl.MapEventType[T] & Object) => void): this; (type: string, listener: maplibregl.Listener): this; }" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.panBy.$1", - "type": "CompoundType", + "id": "def-server.Map.once.$1", + "type": "string", "tags": [], - "label": "offset", + "label": "type", "description": [], "signature": [ - "maplibregl.PointLike" + "string" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.panBy.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "maplibregl.AnimationOptions | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.panBy.$3", - "type": "Object", + "id": "def-server.Map.once.$2", + "type": "Function", "tags": [], - "label": "eventData", + "label": "listener", "description": [], "signature": [ - "maplibregl.EventData | undefined" + "maplibregl.Listener" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.panTo", + "id": "def-server.Map.off", "type": "Function", - "tags": [], - "label": "panTo", - "description": [], + "tags": [ + "method", + "name", + "memberof", + "instance" + ], + "label": "off", + "description": [ + "\nRemoves an event listener previously added with `Map#on`.\n\n\nRemoves an event listener for layer-specific events previously added with `Map#on`.\n" + ], "signature": [ - "(lnglat: maplibregl.LngLatLike, options?: maplibregl.AnimationOptions | undefined, eventdata?: maplibregl.EventData | undefined) => this" + "{ (type: T, layer: string, listener: (ev: maplibregl.MapLayerEventType[T] & Object) => void): this; (type: T, listener: (ev: maplibregl.MapEventType[T] & Object) => void): this; (type: string, listener: maplibregl.Listener): this; }" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.panTo.$1", - "type": "CompoundType", + "id": "def-server.Map.off.$1", + "type": "Uncategorized", "tags": [], - "label": "lnglat", - "description": [], + "label": "type", + "description": [ + "The event type previously used to install the listener." + ], "signature": [ - "maplibregl.LngLatLike" + "T" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.panTo.$2", - "type": "Object", + "id": "def-server.Map.off.$2", + "type": "string", "tags": [], - "label": "options", + "label": "layer", "description": [], "signature": [ - "maplibregl.AnimationOptions | undefined" + "string" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "isRequired": false + "isRequired": true }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.panTo.$3", - "type": "Object", + "id": "def-server.Map.off.$3", + "type": "Function", "tags": [], - "label": "eventdata", - "description": [], + "label": "listener", + "description": [ + "The function previously installed as a listener." + ], "signature": [ - "maplibregl.EventData | undefined" + "(ev: maplibregl.MapLayerEventType[T] & Object) => void" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "`this`" + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getZoom", + "id": "def-server.Map.off", "type": "Function", "tags": [], - "label": "getZoom", + "label": "off", "description": [], "signature": [ - "() => number" + "{ (type: T, layer: string, listener: (ev: maplibregl.MapLayerEventType[T] & Object) => void): this; (type: T, listener: (ev: maplibregl.MapEventType[T] & Object) => void): this; (type: string, listener: maplibregl.Listener): this; }" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "children": [], + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.off.$1", + "type": "Uncategorized", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "T" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.off.$2", + "type": "Function", + "tags": [], + "label": "listener", + "description": [], + "signature": [ + "(ev: maplibregl.MapEventType[T] & Object) => void" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setZoom", + "id": "def-server.Map.off", "type": "Function", "tags": [], - "label": "setZoom", + "label": "off", "description": [], "signature": [ - "(zoom: number, eventData?: maplibregl.EventData | undefined) => this" + "{ (type: T, layer: string, listener: (ev: maplibregl.MapLayerEventType[T] & Object) => void): this; (type: T, listener: (ev: maplibregl.MapEventType[T] & Object) => void): this; (type: string, listener: maplibregl.Listener): this; }" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setZoom.$1", - "type": "number", + "id": "def-server.Map.off.$1", + "type": "string", "tags": [], - "label": "zoom", + "label": "type", "description": [], "signature": [ - "number" + "string" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setZoom.$2", - "type": "Object", + "id": "def-server.Map.off.$2", + "type": "Function", "tags": [], - "label": "eventData", + "label": "listener", "description": [], "signature": [ - "maplibregl.EventData | undefined" + "maplibregl.Listener" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.zoomTo", + "id": "def-server.Map.queryRenderedFeatures", "type": "Function", - "tags": [], - "label": "zoomTo", - "description": [], + "tags": [ + "see" + ], + "label": "queryRenderedFeatures", + "description": [ + "\nReturns an array of MapGeoJSONFeature objects\nrepresenting visible features that satisfy the query parameters.\n" + ], "signature": [ - "(zoom: number, options?: maplibregl.AnimationOptions | undefined, eventData?: maplibregl.EventData | undefined) => this" + "(geometry?: maplibregl.PointLike | [maplibregl.PointLike, maplibregl.PointLike] | undefined, options?: any) => maplibregl.MapGeoJSONFeature[]" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.zoomTo.$1", - "type": "number", + "id": "def-server.Map.queryRenderedFeatures.$1", + "type": "CompoundType", "tags": [], - "label": "zoom", - "description": [], + "label": "geometry", + "description": [ + "- The geometry of the query region:\neither a single point or southwest and northeast points describing a bounding box.\nOmitting this parameter (i.e. calling {@link MapqueryRenderedFeatures } with zero arguments,\nor with only a `options` argument) is equivalent to passing a bounding box encompassing the entire\nmap viewport." + ], "signature": [ - "number" + "maplibregl.PointLike | [maplibregl.PointLike, maplibregl.PointLike] | undefined" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "isRequired": true + "isRequired": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.zoomTo.$2", - "type": "Object", + "id": "def-server.Map.queryRenderedFeatures.$2", + "type": "Any", "tags": [], "label": "options", - "description": [], + "description": [ + "Options object." + ], "signature": [ - "maplibregl.AnimationOptions | undefined" + "any" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "isRequired": false + "isRequired": true + } + ], + "returnComment": [ + "An array of MapGeoJSONFeature objects.\n\nThe `properties` value of each returned feature object contains the properties of its source feature. For GeoJSON sources, only\nstring and numeric property values are supported (i.e. `null`, `Array`, and `Object` values are not supported).\n\nEach feature includes top-level `layer`, `source`, and `sourceLayer` properties. The `layer` property is an object\nrepresenting the style layer to which the feature belongs. Layout and paint properties in this object contain values\nwhich are fully evaluated for the given zoom level and feature.\n\nOnly features that are currently rendered are included. Some features will **not** be included, like:\n\n- Features from layers whose `visibility` property is `\"none\"`.\n- Features from layers whose zoom range excludes the current zoom level.\n- Symbol features that have been hidden due to text or icon collision.\n\nFeatures from all other layers are included, including features that may have no visible\ncontribution to the rendered result; for example, because the layer's opacity or color alpha component is set to\n0.\n\nThe topmost rendered feature appears first in the returned array, and subsequent features are sorted by\ndescending z-order. Features that are rendered multiple times (due to wrapping across the antimeridian at low\nzoom levels) are returned only once (though subject to the following caveat).\n\nBecause features come from tiled vector data or GeoJSON data that is converted to tiles internally, feature\ngeometries may be split or duplicated across tile boundaries and, as a result, features may appear multiple\ntimes in query results. For example, suppose there is a highway running through the bounding rectangle of a query.\nThe results of the query will be those parts of the highway that lie within the map tiles covering the bounding\nrectangle, even if the highway extends into other tiles, and the portion of the highway within each map tile\nwill be returned as a separate feature. Similarly, a point feature near a tile boundary may appear in multiple\ntiles due to tile buffering." + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.querySourceFeatures", + "type": "Function", + "tags": [], + "label": "querySourceFeatures", + "description": [ + "\nReturns an array of MapGeoJSONFeature objects\nrepresenting features within the specified vector tile or GeoJSON source that satisfy the query parameters.\n" + ], + "signature": [ + "(sourceId: string, parameters?: { sourceLayer: string; filter: any[]; validate?: boolean | undefined; } | null | undefined) => maplibregl.MapGeoJSONFeature[]" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.querySourceFeatures.$1", + "type": "string", + "tags": [], + "label": "sourceId", + "description": [ + "The ID of the vector tile or GeoJSON source to query." + ], + "signature": [ + "string" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.zoomTo.$3", - "type": "Object", + "id": "def-server.Map.querySourceFeatures.$2", + "type": "CompoundType", "tags": [], - "label": "eventData", - "description": [], + "label": "parameters", + "description": [ + "Options object." + ], "signature": [ - "maplibregl.EventData | undefined" + "{ sourceLayer: string; filter: any[]; validate?: boolean | undefined; } | null | undefined" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": false } ], - "returnComment": [] + "returnComment": [ + "An array of MapGeoJSONFeature objects.\n\nIn contrast to {@link MapqueryRenderedFeatures }, this function returns all features matching the query parameters,\nwhether or not they are rendered by the current style (i.e. visible). The domain of the query includes all currently-loaded\nvector tiles and GeoJSON source tiles: this function does not check tiles outside the currently\nvisible viewport.\n\nBecause features come from tiled vector data or GeoJSON data that is converted to tiles internally, feature\ngeometries may be split or duplicated across tile boundaries and, as a result, features may appear multiple\ntimes in query results. For example, suppose there is a highway running through the bounding rectangle of a query.\nThe results of the query will be those parts of the highway that lie within the map tiles covering the bounding\nrectangle, even if the highway extends into other tiles, and the portion of the highway within each map tile\nwill be returned as a separate feature. Similarly, a point feature near a tile boundary may appear in multiple\ntiles due to tile buffering." + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.zoomIn", + "id": "def-server.Map.setStyle", "type": "Function", "tags": [], - "label": "zoomIn", - "description": [], + "label": "setStyle", + "description": [ + "\nUpdates the map's MapLibre style object with a new value.\n\nIf a style is already set when this is used and options.diff is set to true, the map renderer will attempt to compare the given style\nagainst the map's current state and perform only the changes necessary to make the map style match the desired state. Changes in sprites\n(images used for icons and patterns) and glyphs (fonts for label text) **cannot** be diffed. If the sprites or fonts used in the current\nstyle and the given style are different in any way, the map renderer will force a full update, removing the current style and building\nthe given one from scratch.\n\n" + ], "signature": [ - "(options?: maplibregl.AnimationOptions | undefined, eventData?: maplibregl.EventData | undefined) => this" + "(style: string | maplibregl.StyleSpecification | null, options?: ({ diff?: boolean | undefined; } & maplibregl.StyleOptions) | undefined) => this" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.zoomIn.$1", - "type": "Object", + "id": "def-server.Map.setStyle.$1", + "type": "CompoundType", "tags": [], - "label": "options", - "description": [], + "label": "style", + "description": [ + "A JSON object conforming to the schema described in the\n[MapLibre Style Specification](https://maplibre.org/maplibre-gl-js-docs/style-spec/), or a URL to such JSON." + ], "signature": [ - "maplibregl.AnimationOptions | undefined" + "string | maplibregl.StyleSpecification | null" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.zoomIn.$2", - "type": "Object", - "tags": [], - "label": "eventData", - "description": [], + "id": "def-server.Map.setStyle.$2", + "type": "CompoundType", + "tags": [], + "label": "options", + "description": [ + "Options object." + ], "signature": [ - "maplibregl.EventData | undefined" + "({ diff?: boolean | undefined; } & maplibregl.StyleOptions) | undefined" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": false } ], - "returnComment": [] + "returnComment": [ + "`this`" + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.zoomOut", + "id": "def-server.Map.setTransformRequest", "type": "Function", "tags": [], - "label": "zoomOut", - "description": [], + "label": "setTransformRequest", + "description": [ + "\n Updates the requestManager's transform request with a new function\n" + ], "signature": [ - "(options?: maplibregl.AnimationOptions | undefined, eventData?: maplibregl.EventData | undefined) => this" + "(transformRequest: maplibregl.RequestTransformFunction) => this" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.zoomOut.$1", - "type": "Object", + "id": "def-server.Map.setTransformRequest.$1", + "type": "Function", "tags": [], - "label": "options", - "description": [], - "signature": [ - "maplibregl.AnimationOptions | undefined" + "label": "transformRequest", + "description": [ + "A callback run before the Map makes a request for an external URL. The callback can be used to modify the url, set headers, or set the credentials property for cross-origin requests.\nExpected to return an object with a `url` property and optionally `headers` and `credentials` properties" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.zoomOut.$2", - "type": "Object", - "tags": [], - "label": "eventData", - "description": [], "signature": [ - "maplibregl.EventData | undefined" + "maplibregl.RequestTransformFunction" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "`this`" + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getBearing", + "id": "def-server.Map._getUIString", "type": "Function", "tags": [], - "label": "getBearing", + "label": "_getUIString", "description": [], "signature": [ - "() => number" + "(key: string) => any" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "children": [], + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map._getUIString.$1", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setBearing", + "id": "def-server.Map._updateStyle", "type": "Function", "tags": [], - "label": "setBearing", + "label": "_updateStyle", "description": [], "signature": [ - "(bearing: number, eventData?: maplibregl.EventData | undefined) => this" + "(style: string | maplibregl.StyleSpecification | null, options?: ({ diff?: boolean | undefined; } & maplibregl.StyleOptions) | undefined) => this" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setBearing.$1", - "type": "number", + "id": "def-server.Map._updateStyle.$1", + "type": "CompoundType", "tags": [], - "label": "bearing", + "label": "style", "description": [], "signature": [ - "number" + "string | maplibregl.StyleSpecification | null" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "isRequired": true + "isRequired": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setBearing.$2", - "type": "Object", + "id": "def-server.Map._updateStyle.$2", + "type": "CompoundType", "tags": [], - "label": "eventData", + "label": "options", "description": [], "signature": [ - "maplibregl.EventData | undefined" + "({ diff?: boolean | undefined; } & maplibregl.StyleOptions) | undefined" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": false } @@ -3140,133 +3639,101 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getPadding", + "id": "def-server.Map._lazyInitEmptyStyle", "type": "Function", - "tags": [ - "memberof" - ], - "label": "getPadding", - "description": [ - "\nReturns the current padding applied around the map viewport.\n" - ], + "tags": [], + "label": "_lazyInitEmptyStyle", + "description": [], "signature": [ - "() => maplibregl.PaddingOptions" + "() => void" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [], - "returnComment": [ - "The current padding around the map viewport." - ] + "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setPadding", + "id": "def-server.Map._diffStyle", "type": "Function", - "tags": [ - "memberof", - "fires", - "fires" - ], - "label": "setPadding", - "description": [ - "\nSets the padding in pixels around the viewport.\n\nEquivalent to `jumpTo({padding: padding})`.\n" - ], + "tags": [], + "label": "_diffStyle", + "description": [], "signature": [ - "(padding: maplibregl.RequireAtLeastOne, eventData?: maplibregl.EventData | undefined) => this" + "(style: string | maplibregl.StyleSpecification, options?: ({ diff?: boolean | undefined; } & maplibregl.StyleOptions) | undefined) => void" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setPadding.$1", + "id": "def-server.Map._diffStyle.$1", "type": "CompoundType", "tags": [], - "label": "padding", - "description": [ - "The desired padding. Format: { left: number, right: number, top: number, bottom: number }" - ], + "label": "style", + "description": [], "signature": [ - "maplibregl.RequireAtLeastOne" + "string | maplibregl.StyleSpecification" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setPadding.$2", - "type": "Object", + "id": "def-server.Map._diffStyle.$2", + "type": "CompoundType", "tags": [], - "label": "eventData", - "description": [ - "Additional properties to be added to event objects of events triggered by this method." - ], + "label": "options", + "description": [], "signature": [ - "maplibregl.EventData | undefined" + "({ diff?: boolean | undefined; } & maplibregl.StyleOptions) | undefined" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": false } ], - "returnComment": [ - "`this`" - ] + "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.rotateTo", + "id": "def-server.Map._updateDiff", "type": "Function", "tags": [], - "label": "rotateTo", + "label": "_updateDiff", "description": [], "signature": [ - "(bearing: number, options?: maplibregl.AnimationOptions | undefined, eventData?: maplibregl.EventData | undefined) => this" + "(style: maplibregl.StyleSpecification, options?: ({ diff?: boolean | undefined; } & maplibregl.StyleOptions) | undefined) => void" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.rotateTo.$1", - "type": "number", + "id": "def-server.Map._updateDiff.$1", + "type": "Object", "tags": [], - "label": "bearing", + "label": "style", "description": [], "signature": [ - "number" + "maplibregl.StyleSpecification" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.rotateTo.$2", - "type": "Object", + "id": "def-server.Map._updateDiff.$2", + "type": "CompoundType", "tags": [], "label": "options", "description": [], "signature": [ - "maplibregl.AnimationOptions | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.rotateTo.$3", - "type": "Object", - "tags": [], - "label": "eventData", - "description": [], - "signature": [ - "maplibregl.EventData | undefined" + "({ diff?: boolean | undefined; } & maplibregl.StyleOptions) | undefined" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": false } @@ -3275,377 +3742,357 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.resetNorth", + "id": "def-server.Map.getStyle", "type": "Function", "tags": [], - "label": "resetNorth", - "description": [], + "label": "getStyle", + "description": [ + "\nReturns the map's MapLibre style object, a JSON object which can be used to recreate the map's style.\n" + ], "signature": [ - "(options?: maplibregl.AnimationOptions | undefined, eventData?: maplibregl.EventData | undefined) => this" + "() => maplibregl.StyleSpecification" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.resetNorth.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "maplibregl.AnimationOptions | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.resetNorth.$2", - "type": "Object", - "tags": [], - "label": "eventData", - "description": [], - "signature": [ - "maplibregl.EventData | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] + "children": [], + "returnComment": [ + "The map's style JSON object." + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.resetNorthPitch", + "id": "def-server.Map.isStyleLoaded", "type": "Function", "tags": [], - "label": "resetNorthPitch", - "description": [], + "label": "isStyleLoaded", + "description": [ + "\nReturns a Boolean indicating whether the map's style is fully loaded.\n" + ], + "signature": [ + "() => boolean | void" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [], + "returnComment": [ + "A Boolean indicating whether the style is fully loaded." + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.addSource", + "type": "Function", + "tags": [ + "fires", + "see" + ], + "label": "addSource", + "description": [ + "\nAdds a source to the map's style.\n" + ], "signature": [ - "(options?: maplibregl.AnimationOptions | null | undefined, eventData?: maplibregl.EventData | null | undefined) => this" + "(id: string, source: maplibregl.SourceSpecification) => this" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.resetNorthPitch.$1", - "type": "CompoundType", + "id": "def-server.Map.addSource.$1", + "type": "string", "tags": [], - "label": "options", - "description": [], + "label": "id", + "description": [ + "The ID of the source to add. Must not conflict with existing sources." + ], "signature": [ - "maplibregl.AnimationOptions | null | undefined" + "string" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "isRequired": false + "isRequired": true }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.resetNorthPitch.$2", + "id": "def-server.Map.addSource.$2", "type": "CompoundType", "tags": [], - "label": "eventData", - "description": [], + "label": "source", + "description": [ + "The source object, conforming to the\nMapLibre Style Specification's [source definition](https://maplibre.org/maplibre-gl-js-docs/style-spec/#sources) or\n{@link CanvasSourceOptions }." + ], "signature": [ - "maplibregl.EventData | null | undefined" + "maplibregl.SourceSpecification" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "`this`" + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.snapToNorth", + "id": "def-server.Map.isSourceLoaded", "type": "Function", "tags": [], - "label": "snapToNorth", - "description": [], + "label": "isSourceLoaded", + "description": [ + "\nReturns a Boolean indicating whether the source is loaded. Returns `true` if the source with\nthe given ID in the map's style has no outstanding network requests, otherwise `false`.\n" + ], "signature": [ - "(options?: maplibregl.AnimationOptions | undefined, eventData?: maplibregl.EventData | undefined) => this" + "(id: string) => boolean" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.snapToNorth.$1", - "type": "Object", + "id": "def-server.Map.isSourceLoaded.$1", + "type": "string", "tags": [], - "label": "options", - "description": [], - "signature": [ - "maplibregl.AnimationOptions | undefined" + "label": "id", + "description": [ + "The ID of the source to be checked." ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.snapToNorth.$2", - "type": "Object", - "tags": [], - "label": "eventData", - "description": [], "signature": [ - "maplibregl.EventData | undefined" + "string" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "A Boolean indicating whether the source is loaded." + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getPitch", + "id": "def-server.Map.areTilesLoaded", "type": "Function", "tags": [], - "label": "getPitch", - "description": [], + "label": "areTilesLoaded", + "description": [ + "\nReturns a Boolean indicating whether all tiles in the viewport from all sources on\nthe style are loaded.\n" + ], "signature": [ - "() => number" + "() => boolean" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [], - "returnComment": [] + "returnComment": [ + "A Boolean indicating whether all tiles are loaded." + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setPitch", + "id": "def-server.Map.addSourceType", "type": "Function", - "tags": [], - "label": "setPitch", - "description": [], + "tags": [ + "private" + ], + "label": "addSourceType", + "description": [ + "\nAdds a [custom source type](#Custom Sources), making it available for use with\n{@link Map#addSource}." + ], "signature": [ - "(pitch: number, eventData?: maplibregl.EventData | undefined) => this" + "(name: string, SourceType: any, callback: maplibregl.Callback) => void" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setPitch.$1", - "type": "number", + "id": "def-server.Map.addSourceType.$1", + "type": "string", "tags": [], - "label": "pitch", - "description": [], + "label": "name", + "description": [ + "The name of the source type; source definition objects use this name in the `{type: ...}` field." + ], "signature": [ - "number" + "string" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.addSourceType.$2", + "type": "Any", + "tags": [], + "label": "SourceType", + "description": [ + "A {@link Source } constructor." + ], + "signature": [ + "any" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setPitch.$2", - "type": "Object", + "id": "def-server.Map.addSourceType.$3", + "type": "Function", "tags": [], - "label": "eventData", - "description": [], + "label": "callback", + "description": [ + "Called when the source type is ready or with an error argument if there is an error." + ], "signature": [ - "maplibregl.EventData | undefined" + "maplibregl.Callback" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.cameraForBounds", + "id": "def-server.Map.removeSource", "type": "Function", "tags": [], - "label": "cameraForBounds", - "description": [], + "label": "removeSource", + "description": [ + "\nRemoves a source from the map's style.\n" + ], "signature": [ - "(bounds: maplibregl.LngLatBoundsLike, options?: maplibregl.CameraForBoundsOptions | undefined) => maplibregl.CameraForBoundsResult | undefined" + "(id: string) => this" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.cameraForBounds.$1", - "type": "CompoundType", + "id": "def-server.Map.removeSource.$1", + "type": "string", "tags": [], - "label": "bounds", - "description": [], - "signature": [ - "maplibregl.LngLatBoundsLike" + "label": "id", + "description": [ + "The ID of the source to remove." ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.cameraForBounds.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [], "signature": [ - "maplibregl.CameraForBoundsOptions | undefined" + "string" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "`this`" + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.fitBounds", + "id": "def-server.Map.getSource", "type": "Function", - "tags": [], - "label": "fitBounds", - "description": [], + "tags": [ + "see", + "see", + "see" + ], + "label": "getSource", + "description": [ + "\nReturns the source with the specified ID in the map's style.\n\nThis method is often used to update a source using the instance members for the relevant\nsource type as defined in [Sources](#sources).\nFor example, setting the `data` for a GeoJSON source or updating the `url` and `coordinates`\nof an image source.\n" + ], "signature": [ - "(bounds: maplibregl.LngLatBoundsLike, options?: maplibregl.FitBoundsOptions | undefined, eventData?: maplibregl.EventData | undefined) => this" + "(id: string) => maplibregl.Source | undefined" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.fitBounds.$1", - "type": "CompoundType", - "tags": [], - "label": "bounds", - "description": [], - "signature": [ - "maplibregl.LngLatBoundsLike" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.fitBounds.$2", - "type": "Object", + "id": "def-server.Map.getSource.$1", + "type": "string", "tags": [], - "label": "options", - "description": [], - "signature": [ - "maplibregl.FitBoundsOptions | undefined" + "label": "id", + "description": [ + "The ID of the source to get." ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.fitBounds.$3", - "type": "Object", - "tags": [], - "label": "eventData", - "description": [], "signature": [ - "maplibregl.EventData | undefined" + "string" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "The style source with the specified ID or `undefined` if the ID\ncorresponds to no existing sources.\nThe shape of the object varies by source type.\nA list of options for each source type is available on the MapLibre Style Specification's\n[Sources](https://maplibre.org/maplibre-gl-js-docs/style-spec/sources/) page." + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.fitScreenCoordinates", + "id": "def-server.Map.addImage", "type": "Function", - "tags": [], - "label": "fitScreenCoordinates", - "description": [], + "tags": [ + "see", + "see" + ], + "label": "addImage", + "description": [ + "\nAdd an image to the style. This image can be displayed on the map like any other icon in the style's\nsprite using the image's ID with\n[`icon-image`](https://maplibre.org/maplibre-gl-js-docs/style-spec/#layout-symbol-icon-image),\n[`background-pattern`](https://maplibre.org/maplibre-gl-js-docs/style-spec/#paint-background-background-pattern),\n[`fill-pattern`](https://maplibre.org/maplibre-gl-js-docs/style-spec/#paint-fill-fill-pattern),\nor [`line-pattern`](https://maplibre.org/maplibre-gl-js-docs/style-spec/#paint-line-line-pattern).\nA {@link Map.event:error} event will be fired if there is not enough space in the sprite to add this image.\n" + ], "signature": [ - "(p0: maplibregl.PointLike, p1: maplibregl.PointLike, bearing: number, options?: (maplibregl.AnimationOptions & maplibregl.CameraOptions) | undefined, eventData?: maplibregl.EventData | undefined) => this" + "(id: string, image: HTMLImageElement | ImageBitmap | ImageData | { width: number; height: number; data: Uint8Array | Uint8ClampedArray; } | maplibregl.StyleImageInterface, { pixelRatio, sdf, stretchX, stretchY, content }?: Partial | undefined) => this" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.fitScreenCoordinates.$1", - "type": "CompoundType", + "id": "def-server.Map.addImage.$1", + "type": "string", "tags": [], - "label": "p0", - "description": [], + "label": "id", + "description": [ + "The ID of the image." + ], "signature": [ - "maplibregl.PointLike" + "string" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.fitScreenCoordinates.$2", + "id": "def-server.Map.addImage.$2", "type": "CompoundType", "tags": [], - "label": "p1", - "description": [], - "signature": [ - "maplibregl.PointLike" + "label": "image", + "description": [ + "The image as an `HTMLImageElement`, `ImageData`, `ImageBitmap` or object with `width`, `height`, and `data`\nproperties with the same format as `ImageData`." ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.fitScreenCoordinates.$3", - "type": "number", - "tags": [], - "label": "bearing", - "description": [], "signature": [ - "number" + "HTMLImageElement | ImageBitmap | ImageData | { width: number; height: number; data: Uint8Array | Uint8ClampedArray; } | maplibregl.StyleImageInterface" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.fitScreenCoordinates.$4", - "type": "CompoundType", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "(maplibregl.AnimationOptions & maplibregl.CameraOptions) | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.fitScreenCoordinates.$5", + "id": "def-server.Map.addImage.$3", "type": "Object", "tags": [], - "label": "eventData", + "label": "{ pixelRatio, sdf, stretchX, stretchY, content }", "description": [], "signature": [ - "maplibregl.EventData | undefined" + "Partial | undefined" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": false } @@ -3654,218 +4101,170 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.jumpTo", + "id": "def-server.Map.updateImage", "type": "Function", "tags": [], - "label": "jumpTo", - "description": [], + "label": "updateImage", + "description": [ + "\nUpdate an existing image in a style. This image can be displayed on the map like any other icon in the style's\nsprite using the image's ID with\n[`icon-image`](https://maplibre.org/maplibre-gl-js-docs/style-spec/#layout-symbol-icon-image),\n[`background-pattern`](https://maplibre.org/maplibre-gl-js-docs/style-spec/#paint-background-background-pattern),\n[`fill-pattern`](https://maplibre.org/maplibre-gl-js-docs/style-spec/#paint-fill-fill-pattern),\nor [`line-pattern`](https://maplibre.org/maplibre-gl-js-docs/style-spec/#paint-line-line-pattern).\n" + ], "signature": [ - "(options: maplibregl.CameraOptions, eventData?: maplibregl.EventData | undefined) => this" + "(id: string, image: HTMLImageElement | ImageBitmap | ImageData | maplibregl.StyleImageInterface | { width: number; height: number; data: Uint8Array | Uint8ClampedArray; }) => this" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.jumpTo.$1", - "type": "Object", + "id": "def-server.Map.updateImage.$1", + "type": "string", "tags": [], - "label": "options", - "description": [], + "label": "id", + "description": [ + "The ID of the image." + ], "signature": [ - "maplibregl.CameraOptions" + "string" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.jumpTo.$2", - "type": "Object", + "id": "def-server.Map.updateImage.$2", + "type": "CompoundType", "tags": [], - "label": "eventData", - "description": [], + "label": "image", + "description": [ + "The image as an `HTMLImageElement`, `ImageData`, `ImageBitmap` or object with `width`, `height`, and `data`\nproperties with the same format as `ImageData`." + ], "signature": [ - "maplibregl.EventData | undefined" + "HTMLImageElement | ImageBitmap | ImageData | maplibregl.StyleImageInterface | { width: number; height: number; data: Uint8Array | Uint8ClampedArray; }" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.easeTo", + "id": "def-server.Map.hasImage", "type": "Function", "tags": [], - "label": "easeTo", - "description": [], + "label": "hasImage", + "description": [ + "\nCheck whether or not an image with a specific ID exists in the style. This checks both images\nin the style's original sprite and any images\nthat have been added at runtime using {@link Map#addImage}.\n" + ], "signature": [ - "(options: maplibregl.EaseToOptions, eventData?: maplibregl.EventData | undefined) => this" + "(id: string) => boolean" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.easeTo.$1", - "type": "Object", + "id": "def-server.Map.hasImage.$1", + "type": "string", "tags": [], - "label": "options", - "description": [], - "signature": [ - "maplibregl.EaseToOptions" + "label": "id", + "description": [ + "The ID of the image." ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.easeTo.$2", - "type": "Object", - "tags": [], - "label": "eventData", - "description": [], "signature": [ - "maplibregl.EventData | undefined" + "string" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "A Boolean indicating whether the image exists." + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.flyTo", + "id": "def-server.Map.removeImage", "type": "Function", "tags": [], - "label": "flyTo", - "description": [], + "label": "removeImage", + "description": [ + "\nRemove an image from a style. This can be an image from the style's original\nsprite or any images\nthat have been added at runtime using {@link Map#addImage}.\n" + ], "signature": [ - "(options: maplibregl.FlyToOptions, eventData?: maplibregl.EventData | undefined) => this" + "(id: string) => void" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.flyTo.$1", - "type": "Object", + "id": "def-server.Map.removeImage.$1", + "type": "string", "tags": [], - "label": "options", - "description": [], - "signature": [ - "maplibregl.FlyToOptions" + "label": "id", + "description": [ + "The ID of the image." ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.flyTo.$2", - "type": "Object", - "tags": [], - "label": "eventData", - "description": [], "signature": [ - "maplibregl.EventData | undefined" + "string" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.isEasing", + "id": "def-server.Map.loadImage", "type": "Function", - "tags": [], - "label": "isEasing", - "description": [], - "signature": [ - "() => boolean" + "tags": [ + "see" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.stop", - "type": "Function", - "tags": [], - "label": "stop", - "description": [], - "signature": [ - "() => this" + "label": "loadImage", + "description": [ + "\nLoad an image from an external URL to be used with {@link Map#addImage}. External\ndomains must support [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS).\n" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.on", - "type": "Function", - "tags": [], - "label": "on", - "description": [], "signature": [ - "{ (type: T, layer: string, listener: (ev: maplibregl.MapLayerEventType[T] & maplibregl.EventData) => void): this; (type: T, listener: (ev: maplibregl.MapEventType[T] & maplibregl.EventData) => void): this; (type: string, listener: (ev: any) => void): this; }" + "(url: string, callback: maplibregl.GetImageCallback) => void" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.on.$1", - "type": "Uncategorized", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "T" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.on.$2", + "id": "def-server.Map.loadImage.$1", "type": "string", "tags": [], - "label": "layer", - "description": [], + "label": "url", + "description": [ + "The URL of the image file. Image file must be in png, webp, or jpg format." + ], "signature": [ "string" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.on.$3", + "id": "def-server.Map.loadImage.$2", "type": "Function", "tags": [], - "label": "listener", - "description": [], + "label": "callback", + "description": [ + "Expecting `callback(error, data)`. Called when the image has loaded or with an error argument if there is an error." + ], "signature": [ - "(ev: maplibregl.MapLayerEventType[T] & maplibregl.EventData) => void" + "maplibregl.GetImageCallback" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true } @@ -3874,144 +4273,161 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.on", + "id": "def-server.Map.listImages", "type": "Function", "tags": [], - "label": "on", - "description": [], + "label": "listImages", + "description": [ + "\nReturns an Array of strings containing the IDs of all images currently available in the map.\nThis includes both images from the style's original sprite\nand any images that have been added at runtime using {@link Map#addImage}.\n" + ], + "signature": [ + "() => string[]" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [], + "returnComment": [ + "An Array of strings containing the names of all sprites/images currently available in the map." + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.addLayer", + "type": "Function", + "tags": [ + "see", + "see", + "see" + ], + "label": "addLayer", + "description": [ + "\nAdds a [MapLibre style layer](https://maplibre.org/maplibre-gl-js-docs/style-spec/#layers)\nto the map's style.\n\nA layer defines how data from a specified source will be styled. Read more about layer types\nand available paint and layout properties in the [MapLibre Style Specification](https://maplibre.org/maplibre-gl-js-docs/style-spec/#layers).\n" + ], "signature": [ - "{ (type: T, layer: string, listener: (ev: maplibregl.MapLayerEventType[T] & maplibregl.EventData) => void): this; (type: T, listener: (ev: maplibregl.MapEventType[T] & maplibregl.EventData) => void): this; (type: string, listener: (ev: any) => void): this; }" + "(layer: maplibregl.LayerSpecification | maplibregl.CustomLayerInterface, beforeId?: string | undefined) => this" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.on.$1", - "type": "Uncategorized", + "id": "def-server.Map.addLayer.$1", + "type": "CompoundType", "tags": [], - "label": "type", - "description": [], + "label": "layer", + "description": [ + "The layer to add, conforming to either the MapLibre Style Specification's [layer definition](https://maplibre.org/maplibre-gl-js-docs/style-spec/#layers) or, less commonly, the {@link CustomLayerInterface } specification.\nThe MapLibre Style Specification's layer definition is appropriate for most layers." + ], "signature": [ - "T" + "maplibregl.LayerSpecification | maplibregl.CustomLayerInterface" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.on.$2", - "type": "Function", + "id": "def-server.Map.addLayer.$2", + "type": "string", "tags": [], - "label": "listener", - "description": [], + "label": "beforeId", + "description": [ + "The ID of an existing layer to insert the new layer before,\nresulting in the new layer appearing visually beneath the existing layer.\nIf this argument is not specified, the layer will be appended to the end of the layers array\nand appear visually above all other layers." + ], "signature": [ - "(ev: maplibregl.MapEventType[T] & maplibregl.EventData) => void" + "string | undefined" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "isRequired": true + "isRequired": false } ], - "returnComment": [] + "returnComment": [ + "`this`" + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.on", + "id": "def-server.Map.moveLayer", "type": "Function", "tags": [], - "label": "on", - "description": [], + "label": "moveLayer", + "description": [ + "\nMoves a layer to a different z-position.\n" + ], "signature": [ - "{ (type: T, layer: string, listener: (ev: maplibregl.MapLayerEventType[T] & maplibregl.EventData) => void): this; (type: T, listener: (ev: maplibregl.MapEventType[T] & maplibregl.EventData) => void): this; (type: string, listener: (ev: any) => void): this; }" + "(id: string, beforeId?: string | undefined) => this" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.on.$1", + "id": "def-server.Map.moveLayer.$1", "type": "string", "tags": [], - "label": "type", - "description": [], + "label": "id", + "description": [ + "The ID of the layer to move." + ], "signature": [ "string" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.on.$2", - "type": "Function", + "id": "def-server.Map.moveLayer.$2", + "type": "string", "tags": [], - "label": "listener", - "description": [], + "label": "beforeId", + "description": [ + "The ID of an existing layer to insert the new layer before. When viewing the map, the `id` layer will appear beneath the `beforeId` layer. If `beforeId` is omitted, the layer will be appended to the end of the layers array and appear above all other layers on the map." + ], "signature": [ - "(ev: any) => void" + "string | undefined" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "isRequired": true + "isRequired": false } ], - "returnComment": [] + "returnComment": [ + "`this`" + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.once", + "id": "def-server.Map.removeLayer", "type": "Function", - "tags": [], - "label": "once", - "description": [], + "tags": [ + "fires" + ], + "label": "removeLayer", + "description": [ + "\nRemoves the layer with the given ID from the map's style.\n\nIf no such layer exists, an `error` event is fired.\n" + ], "signature": [ - "{ (type: T, layer: string, listener: (ev: maplibregl.MapLayerEventType[T] & maplibregl.EventData) => void): this; (type: T, listener: (ev: maplibregl.MapEventType[T] & maplibregl.EventData) => void): this; (type: string, listener: (ev: any) => void): this; }" + "(id: string) => this" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.once.$1", - "type": "Uncategorized", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "T" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.once.$2", + "id": "def-server.Map.removeLayer.$1", "type": "string", "tags": [], - "label": "layer", - "description": [], - "signature": [ - "string" + "label": "id", + "description": [ + "id of the layer to remove" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.once.$3", - "type": "Function", - "tags": [], - "label": "listener", - "description": [], "signature": [ - "(ev: maplibregl.MapLayerEventType[T] & maplibregl.EventData) => void" + "string" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true } @@ -4020,633 +4436,609 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.once", + "id": "def-server.Map.getLayer", "type": "Function", - "tags": [], - "label": "once", - "description": [], + "tags": [ + "see", + "see" + ], + "label": "getLayer", + "description": [ + "\nReturns the layer with the specified ID in the map's style.\n" + ], "signature": [ - "{ (type: T, layer: string, listener: (ev: maplibregl.MapLayerEventType[T] & maplibregl.EventData) => void): this; (type: T, listener: (ev: maplibregl.MapEventType[T] & maplibregl.EventData) => void): this; (type: string, listener: (ev: any) => void): this; }" + "(id: string) => StyleLayer" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.once.$1", - "type": "Uncategorized", + "id": "def-server.Map.getLayer.$1", + "type": "string", "tags": [], - "label": "type", - "description": [], - "signature": [ - "T" + "label": "id", + "description": [ + "The ID of the layer to get." ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.once.$2", - "type": "Function", - "tags": [], - "label": "listener", - "description": [], "signature": [ - "(ev: maplibregl.MapEventType[T] & maplibregl.EventData) => void" + "string" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "The layer with the specified ID, or `undefined`\nif the ID corresponds to no existing layers." + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.once", + "id": "def-server.Map.setLayerZoomRange", "type": "Function", "tags": [], - "label": "once", - "description": [], + "label": "setLayerZoomRange", + "description": [ + "\nSets the zoom extent for the specified style layer. The zoom extent includes the\n[minimum zoom level](https://maplibre.org/maplibre-gl-js-docs/style-spec/#layer-minzoom)\nand [maximum zoom level](https://maplibre.org/maplibre-gl-js-docs/style-spec/#layer-maxzoom))\nat which the layer will be rendered.\n\nNote: For style layers using vector sources, style layers cannot be rendered at zoom levels lower than the\nminimum zoom level of the _source layer_ because the data does not exist at those zoom levels. If the minimum\nzoom level of the source layer is higher than the minimum zoom level defined in the style layer, the style\nlayer will not be rendered at all zoom levels in the zoom range.\n" + ], "signature": [ - "{ (type: T, layer: string, listener: (ev: maplibregl.MapLayerEventType[T] & maplibregl.EventData) => void): this; (type: T, listener: (ev: maplibregl.MapEventType[T] & maplibregl.EventData) => void): this; (type: string, listener: (ev: any) => void): this; }" + "(layerId: string, minzoom: number, maxzoom: number) => this" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.once.$1", + "id": "def-server.Map.setLayerZoomRange.$1", "type": "string", "tags": [], - "label": "type", - "description": [], + "label": "layerId", + "description": [ + "The ID of the layer to which the zoom extent will be applied." + ], "signature": [ "string" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.once.$2", - "type": "Function", + "id": "def-server.Map.setLayerZoomRange.$2", + "type": "number", "tags": [], - "label": "listener", - "description": [], + "label": "minzoom", + "description": [ + "The minimum zoom to set (0-24)." + ], + "signature": [ + "number" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.setLayerZoomRange.$3", + "type": "number", + "tags": [], + "label": "maxzoom", + "description": [ + "The maximum zoom to set (0-24)." + ], "signature": [ - "(ev: any) => void" + "number" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "`this`" + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.off", + "id": "def-server.Map.setFilter", "type": "Function", - "tags": [], - "label": "off", - "description": [], + "tags": [ + "see" + ], + "label": "setFilter", + "description": [ + "\nSets the filter for the specified style layer.\n\nFilters control which features a style layer renders from its source.\nAny feature for which the filter expression evaluates to `true` will be\nrendered on the map. Those that are false will be hidden.\n\nUse `setFilter` to show a subset of your source data.\n\nTo clear the filter, pass `null` or `undefined` as the second parameter.\n" + ], "signature": [ - "{ (type: T, layer: string, listener: (ev: maplibregl.MapLayerEventType[T] & maplibregl.EventData) => void): this; (type: T, listener: (ev: maplibregl.MapEventType[T] & maplibregl.EventData) => void): this; (type: string, listener: (ev: any) => void): this; }" + "(layerId: string, filter?: maplibregl.FilterSpecification | null | undefined, options?: maplibregl.StyleSetterOptions | undefined) => this" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.off.$1", - "type": "Uncategorized", + "id": "def-server.Map.setFilter.$1", + "type": "string", "tags": [], - "label": "type", - "description": [], + "label": "layerId", + "description": [ + "The ID of the layer to which the filter will be applied." + ], "signature": [ - "T" + "string" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.off.$2", - "type": "string", + "id": "def-server.Map.setFilter.$2", + "type": "CompoundType", "tags": [], - "label": "layer", - "description": [], + "label": "filter", + "description": [ + "The filter, conforming to the MapLibre Style Specification's\n[filter definition](https://maplibre.org/maplibre-gl-js-docs/style-spec/layers/#filter). If `null` or `undefined` is provided, the function removes any existing filter from the layer." + ], "signature": [ - "string" + "maplibregl.FilterSpecification | null | undefined" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "isRequired": true + "isRequired": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.off.$3", - "type": "Function", + "id": "def-server.Map.setFilter.$3", + "type": "Object", "tags": [], - "label": "listener", - "description": [], + "label": "options", + "description": [ + "Options object." + ], "signature": [ - "(ev: maplibregl.MapLayerEventType[T] & maplibregl.EventData) => void" + "maplibregl.StyleSetterOptions | undefined" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "isRequired": true + "isRequired": false } ], - "returnComment": [] + "returnComment": [ + "`this`" + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.off", + "id": "def-server.Map.getFilter", "type": "Function", - "tags": [], - "label": "off", - "description": [], + "tags": [], + "label": "getFilter", + "description": [ + "\nReturns the filter applied to the specified style layer.\n" + ], "signature": [ - "{ (type: T, layer: string, listener: (ev: maplibregl.MapLayerEventType[T] & maplibregl.EventData) => void): this; (type: T, listener: (ev: maplibregl.MapEventType[T] & maplibregl.EventData) => void): this; (type: string, listener: (ev: any) => void): this; }" + "(layerId: string) => void | maplibregl.FilterSpecification" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.off.$1", - "type": "Uncategorized", + "id": "def-server.Map.getFilter.$1", + "type": "string", "tags": [], - "label": "type", - "description": [], - "signature": [ - "T" + "label": "layerId", + "description": [ + "The ID of the style layer whose filter to get." ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.off.$2", - "type": "Function", - "tags": [], - "label": "listener", - "description": [], "signature": [ - "(ev: maplibregl.MapEventType[T] & maplibregl.EventData) => void" + "string" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "The layer's filter." + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.off", + "id": "def-server.Map.setPaintProperty", "type": "Function", - "tags": [], - "label": "off", - "description": [], + "tags": [ + "see", + "see" + ], + "label": "setPaintProperty", + "description": [ + "\nSets the value of a paint property in the specified style layer.\n" + ], "signature": [ - "{ (type: T, layer: string, listener: (ev: maplibregl.MapLayerEventType[T] & maplibregl.EventData) => void): this; (type: T, listener: (ev: maplibregl.MapEventType[T] & maplibregl.EventData) => void): this; (type: string, listener: (ev: any) => void): this; }" + "(layerId: string, name: string, value: any, options?: maplibregl.StyleSetterOptions | undefined) => this" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.off.$1", + "id": "def-server.Map.setPaintProperty.$1", "type": "string", "tags": [], - "label": "type", - "description": [], + "label": "layerId", + "description": [ + "The ID of the layer to set the paint property in." + ], "signature": [ "string" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.off.$2", - "type": "Function", + "id": "def-server.Map.setPaintProperty.$2", + "type": "string", "tags": [], - "label": "listener", - "description": [], + "label": "name", + "description": [ + "The name of the paint property to set." + ], "signature": [ - "(ev: any) => void" + "string" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.scrollZoom", - "type": "Object", - "tags": [], - "label": "scrollZoom", - "description": [], - "signature": [ - "maplibregl.ScrollZoomHandler" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.boxZoom", - "type": "Object", - "tags": [], - "label": "boxZoom", - "description": [], - "signature": [ - "maplibregl.BoxZoomHandler" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.dragRotate", - "type": "Object", - "tags": [], - "label": "dragRotate", - "description": [], - "signature": [ - "maplibregl.DragRotateHandler" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.dragPan", - "type": "Object", - "tags": [], - "label": "dragPan", - "description": [], - "signature": [ - "maplibregl.DragPanHandler" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.keyboard", - "type": "Object", - "tags": [], - "label": "keyboard", - "description": [], - "signature": [ - "maplibregl.KeyboardHandler" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.doubleClickZoom", - "type": "Object", - "tags": [], - "label": "doubleClickZoom", - "description": [], - "signature": [ - "maplibregl.DoubleClickZoomHandler" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.touchZoomRotate", - "type": "Object", - "tags": [], - "label": "touchZoomRotate", - "description": [], - "signature": [ - "maplibregl.TouchZoomRotateHandler" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.touchPitch", - "type": "Object", - "tags": [], - "label": "touchPitch", - "description": [], - "signature": [ - "maplibregl.TouchPitchHandler" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapMouseEvent", - "type": "Class", - "tags": [], - "label": "MapMouseEvent", - "description": [], - "signature": [ - "maplibregl.MapMouseEvent extends maplibregl.MapboxEvent" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapMouseEvent.type", - "type": "CompoundType", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"click\" | \"dblclick\" | \"mousedown\" | \"mouseup\" | \"mousemove\" | \"mouseenter\" | \"mouseleave\" | \"mouseover\" | \"mouseout\" | \"contextmenu\"" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapMouseEvent.point", - "type": "Object", - "tags": [], - "label": "point", - "description": [], - "signature": [ - "maplibregl.Point" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapMouseEvent.lngLat", - "type": "Object", - "tags": [], - "label": "lngLat", - "description": [], - "signature": [ - "maplibregl.LngLat" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapMouseEvent.preventDefault", - "type": "Function", - "tags": [], - "label": "preventDefault", - "description": [], - "signature": [ - "() => void" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapMouseEvent.defaultPrevented", - "type": "boolean", - "tags": [], - "label": "defaultPrevented", - "description": [], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point", - "type": "Class", - "tags": [], - "label": "Point", - "description": [ - "\nPoint" - ], - "signature": [ - "maplibregl.Point" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.x", - "type": "number", - "tags": [], - "label": "x", - "description": [], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.y", - "type": "number", - "tags": [], - "label": "y", - "description": [], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.setPaintProperty.$3", + "type": "Any", + "tags": [], + "label": "value", + "description": [ + "The value of the paint property to set.\nMust be of a type appropriate for the property, as defined in the [MapLibre Style Specification](https://maplibre.org/maplibre-gl-js-docs/style-spec/)." + ], + "signature": [ + "any" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.setPaintProperty.$4", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "Options object." + ], + "signature": [ + "maplibregl.StyleSetterOptions | undefined" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "`this`" + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.Unnamed", + "id": "def-server.Map.getPaintProperty", "type": "Function", "tags": [], - "label": "Constructor", - "description": [], + "label": "getPaintProperty", + "description": [ + "\nReturns the value of a paint property in the specified style layer.\n" + ], "signature": [ - "any" + "(layerId: string, name: string) => unknown" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.Unnamed.$1", - "type": "number", + "id": "def-server.Map.getPaintProperty.$1", + "type": "string", "tags": [], - "label": "x", - "description": [], + "label": "layerId", + "description": [ + "The ID of the layer to get the paint property from." + ], "signature": [ - "number" + "string" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.Unnamed.$2", - "type": "number", + "id": "def-server.Map.getPaintProperty.$2", + "type": "string", "tags": [], - "label": "y", - "description": [], + "label": "name", + "description": [ + "The name of a paint property to get." + ], "signature": [ - "number" + "string" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "The value of the specified paint property." + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.clone", + "id": "def-server.Map.setLayoutProperty", "type": "Function", "tags": [], - "label": "clone", - "description": [], - "signature": [ - "() => maplibregl.Point" + "label": "setLayoutProperty", + "description": [ + "\nSets the value of a layout property in the specified style layer.\n" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.add", - "type": "Function", - "tags": [], - "label": "add", - "description": [], "signature": [ - "(p: maplibregl.Point) => maplibregl.Point" + "(layerId: string, name: string, value: any, options?: maplibregl.StyleSetterOptions | undefined) => this" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.add.$1", - "type": "Object", + "id": "def-server.Map.setLayoutProperty.$1", + "type": "string", "tags": [], - "label": "p", - "description": [], + "label": "layerId", + "description": [ + "The ID of the layer to set the layout property in." + ], + "signature": [ + "string" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.setLayoutProperty.$2", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "The name of the layout property to set." + ], + "signature": [ + "string" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.setLayoutProperty.$3", + "type": "Any", + "tags": [], + "label": "value", + "description": [ + "The value of the layout property. Must be of a type appropriate for the property, as defined in the [MapLibre Style Specification](https://maplibre.org/maplibre-gl-js-docs/style-spec/)." + ], "signature": [ - "maplibregl.Point" + "any" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.setLayoutProperty.$4", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "Options object." + ], + "signature": [ + "maplibregl.StyleSetterOptions | undefined" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": false } ], - "returnComment": [] + "returnComment": [ + "`this`" + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.sub", + "id": "def-server.Map.getLayoutProperty", "type": "Function", "tags": [], - "label": "sub", - "description": [], + "label": "getLayoutProperty", + "description": [ + "\nReturns the value of a layout property in the specified style layer.\n" + ], "signature": [ - "(p: maplibregl.Point) => maplibregl.Point" + "(layerId: string, name: string) => any" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.sub.$1", - "type": "Object", + "id": "def-server.Map.getLayoutProperty.$1", + "type": "string", "tags": [], - "label": "p", - "description": [], + "label": "layerId", + "description": [ + "The ID of the layer to get the layout property from." + ], + "signature": [ + "string" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.getLayoutProperty.$2", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "The name of the layout property to get." + ], "signature": [ - "maplibregl.Point" + "string" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "The value of the specified layout property." + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.mult", + "id": "def-server.Map.setLight", "type": "Function", "tags": [], - "label": "mult", - "description": [], + "label": "setLight", + "description": [ + "\nSets the any combination of light values.\n" + ], "signature": [ - "(k: number) => maplibregl.Point" + "(light: maplibregl.LightSpecification, options?: maplibregl.StyleSetterOptions | undefined) => this" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.mult.$1", - "type": "number", + "id": "def-server.Map.setLight.$1", + "type": "Object", "tags": [], - "label": "k", - "description": [], + "label": "light", + "description": [ + "Light properties to set. Must conform to the [MapLibre Style Specification](https://maplibre.org/maplibre-gl-js-docs/style-spec/#light)." + ], "signature": [ - "number" + "maplibregl.LightSpecification" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.setLight.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "Options object." + ], + "signature": [ + "maplibregl.StyleSetterOptions | undefined" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": false } ], - "returnComment": [] + "returnComment": [ + "`this`" + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.div", + "id": "def-server.Map.getLight", "type": "Function", "tags": [], - "label": "div", - "description": [], + "label": "getLight", + "description": [ + "\nReturns the value of the light object.\n" + ], + "signature": [ + "() => any" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [], + "returnComment": [ + "light Light properties of the style." + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.setFeatureState", + "type": "Function", + "tags": [ + "see" + ], + "label": "setFeatureState", + "description": [ + "\nSets the `state` of a feature.\nA feature's `state` is a set of user-defined key-value pairs that are assigned to a feature at runtime.\nWhen using this method, the `state` object is merged with any existing key-value pairs in the feature's state.\nFeatures are identified by their `feature.id` attribute, which can be any number or string.\n\nThis method can only be used with sources that have a `feature.id` attribute. The `feature.id` attribute can be defined in three ways:\n- For vector or GeoJSON sources, including an `id` attribute in the original data file.\n- For vector or GeoJSON sources, using the [`promoteId`](https://maplibre.org/maplibre-gl-js-docs/style-spec/sources/#vector-promoteId) option at the time the source is defined.\n- For GeoJSON sources, using the [`generateId`](https://maplibre.org/maplibre-gl-js-docs/style-spec/sources/#geojson-generateId) option to auto-assign an `id` based on the feature's index in the source data. If you change feature data using `map.getSource('some id').setData(..)`, you may need to re-apply state taking into account updated `id` values.\n\n_Note: You can use the [`feature-state` expression](https://maplibre.org/maplibre-gl-js-docs/style-spec/expressions/#feature-state) to access the values in a feature's state object for the purposes of styling._\n" + ], "signature": [ - "(k: number) => maplibregl.Point" + "(feature: maplibregl.FeatureIdentifier, state: any) => this" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.div.$1", - "type": "number", + "id": "def-server.Map.setFeatureState.$1", + "type": "Object", "tags": [], - "label": "k", - "description": [], + "label": "feature", + "description": [ + "Feature identifier. Feature objects returned from\n{@link MapqueryRenderedFeatures } or event handlers can be used as feature identifiers." + ], "signature": [ - "number" + "maplibregl.FeatureIdentifier" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.setFeatureState.$2", + "type": "Any", + "tags": [], + "label": "state", + "description": [ + "A set of key-value pairs. The values should be valid JSON types." + ], + "signature": [ + "any" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true } @@ -4655,208 +5047,235 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.rotate", + "id": "def-server.Map.removeFeatureState", "type": "Function", "tags": [], - "label": "rotate", - "description": [], + "label": "removeFeatureState", + "description": [ + "\nRemoves the `state` of a feature, setting it back to the default behavior.\nIf only a `target.source` is specified, it will remove the state for all features from that source.\nIf `target.id` is also specified, it will remove all keys for that feature's state.\nIf `key` is also specified, it removes only that key from that feature's state.\nFeatures are identified by their `feature.id` attribute, which can be any number or string.\n" + ], "signature": [ - "(a: number) => maplibregl.Point" + "(target: maplibregl.FeatureIdentifier, key?: string | undefined) => this" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.rotate.$1", - "type": "number", + "id": "def-server.Map.removeFeatureState.$1", + "type": "Object", "tags": [], - "label": "a", - "description": [], + "label": "target", + "description": [ + "Identifier of where to remove state. It can be a source, a feature, or a specific key of feature.\nFeature objects returned from {@link MapqueryRenderedFeatures } or event handlers can be used as feature identifiers." + ], "signature": [ - "number" + "maplibregl.FeatureIdentifier" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.removeFeatureState.$2", + "type": "string", + "tags": [], + "label": "key", + "description": [ + "(optional) The key in the feature state to reset." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.matMult", + "id": "def-server.Map.getFeatureState", "type": "Function", "tags": [], - "label": "matMult", - "description": [], + "label": "getFeatureState", + "description": [ + "\nGets the `state` of a feature.\nA feature's `state` is a set of user-defined key-value pairs that are assigned to a feature at runtime.\nFeatures are identified by their `feature.id` attribute, which can be any number or string.\n\n_Note: To access the values in a feature's state object for the purposes of styling the feature, use the [`feature-state` expression](https://maplibre.org/maplibre-gl-js-docs/style-spec/expressions/#feature-state)._\n" + ], "signature": [ - "(m: number) => maplibregl.Point" + "(feature: maplibregl.FeatureIdentifier) => any" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.matMult.$1", - "type": "number", + "id": "def-server.Map.getFeatureState.$1", + "type": "Object", "tags": [], - "label": "m", - "description": [], + "label": "feature", + "description": [ + "Feature identifier. Feature objects returned from\n{@link MapqueryRenderedFeatures } or event handlers can be used as feature identifiers." + ], "signature": [ - "number" + "maplibregl.FeatureIdentifier" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "The state of the feature: a set of key-value pairs that was assigned to the feature at runtime." + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.unit", + "id": "def-server.Map.getContainer", "type": "Function", "tags": [], - "label": "unit", - "description": [], + "label": "getContainer", + "description": [ + "\nReturns the map's containing HTML element.\n" + ], "signature": [ - "() => maplibregl.Point" + "() => HTMLElement" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [], - "returnComment": [] + "returnComment": [ + "The map's container." + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.perp", + "id": "def-server.Map.getCanvasContainer", "type": "Function", - "tags": [], - "label": "perp", - "description": [], + "tags": [ + "see" + ], + "label": "getCanvasContainer", + "description": [ + "\nReturns the HTML element containing the map's `` element.\n\nIf you want to add non-GL overlays to the map, you should append them to this element.\n\nThis is the element to which event bindings for map interactivity (such as panning and zooming) are\nattached. It will receive bubbled events from child elements such as the ``, but not from\nmap controls.\n" + ], "signature": [ - "() => maplibregl.Point" + "() => HTMLElement" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [], - "returnComment": [] + "returnComment": [ + "The container of the map's ``." + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.round", + "id": "def-server.Map.getCanvas", + "type": "Function", + "tags": [ + "see", + "see", + "see" + ], + "label": "getCanvas", + "description": [ + "\nReturns the map's `` element.\n" + ], + "signature": [ + "() => HTMLCanvasElement" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [], + "returnComment": [ + "The map's `` element." + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map._containerDimensions", "type": "Function", "tags": [], - "label": "round", + "label": "_containerDimensions", "description": [], "signature": [ - "() => maplibregl.Point" + "() => number[]" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.mag", + "id": "def-server.Map._setupContainer", "type": "Function", "tags": [], - "label": "mag", + "label": "_setupContainer", "description": [], "signature": [ - "() => number" + "() => void" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.equals", + "id": "def-server.Map._resizeCanvas", "type": "Function", "tags": [], - "label": "equals", + "label": "_resizeCanvas", "description": [], "signature": [ - "(p: maplibregl.Point) => boolean" + "(width: number, height: number, pixelRatio: number) => void" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.equals.$1", - "type": "Object", + "id": "def-server.Map._resizeCanvas.$1", + "type": "number", "tags": [], - "label": "p", + "label": "width", "description": [], "signature": [ - "maplibregl.Point" + "number" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.dist", - "type": "Function", - "tags": [], - "label": "dist", - "description": [], - "signature": [ - "(p: maplibregl.Point) => number" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.dist.$1", - "type": "Object", + "id": "def-server.Map._resizeCanvas.$2", + "type": "number", "tags": [], - "label": "p", + "label": "height", "description": [], "signature": [ - "maplibregl.Point" + "number" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.distSqr", - "type": "Function", - "tags": [], - "label": "distSqr", - "description": [], - "signature": [ - "(p: maplibregl.Point) => number" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.distSqr.$1", - "type": "Object", + "id": "def-server.Map._resizeCanvas.$3", + "type": "number", "tags": [], - "label": "p", + "label": "pixelRatio", "description": [], "signature": [ - "maplibregl.Point" + "number" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true } @@ -4865,73 +5284,43 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.angle", + "id": "def-server.Map._setupPainter", "type": "Function", "tags": [], - "label": "angle", + "label": "_setupPainter", "description": [], "signature": [ - "() => number" + "() => void" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.angleTo", - "type": "Function", - "tags": [], - "label": "angleTo", - "description": [], - "signature": [ - "(p: maplibregl.Point) => number" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.angleTo.$1", - "type": "Object", - "tags": [], - "label": "p", - "description": [], - "signature": [ - "maplibregl.Point" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.angleWidth", + "id": "def-server.Map._contextLost", "type": "Function", "tags": [], - "label": "angleWidth", + "label": "_contextLost", "description": [], "signature": [ - "(p: maplibregl.Point) => number" + "(event: any) => void" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.angleWidth.$1", - "type": "Object", + "id": "def-server.Map._contextLost.$1", + "type": "Any", "tags": [], - "label": "p", + "label": "event", "description": [], "signature": [ - "maplibregl.Point" + "any" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true } @@ -4940,42 +5329,28 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.angleWithSep", + "id": "def-server.Map._contextRestored", "type": "Function", "tags": [], - "label": "angleWithSep", + "label": "_contextRestored", "description": [], "signature": [ - "(x: number, y: number) => number" + "(event: any) => void" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.angleWithSep.$1", - "type": "number", - "tags": [], - "label": "x", - "description": [], - "signature": [ - "number" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.angleWithSep.$2", - "type": "number", + "id": "def-server.Map._contextRestored.$1", + "type": "Any", "tags": [], - "label": "y", + "label": "event", "description": [], "signature": [ - "number" + "any" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true } @@ -4984,235 +5359,151 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.convert", + "id": "def-server.Map._onMapScroll", "type": "Function", "tags": [], - "label": "convert", + "label": "_onMapScroll", "description": [], "signature": [ - "(a: maplibregl.PointLike) => maplibregl.Point" + "(event: any) => boolean" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point.convert.$1", - "type": "CompoundType", + "id": "def-server.Map._onMapScroll.$1", + "type": "Any", "tags": [], - "label": "a", + "label": "event", "description": [], "signature": [ - "maplibregl.PointLike" + "any" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] - } - ], - "initialIsOpen": false - } - ], - "functions": [], - "interfaces": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.CustomLayerInterface", - "type": "Interface", - "tags": [], - "label": "CustomLayerInterface", - "description": [], - "signature": [ - "maplibregl.CustomLayerInterface" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.CustomLayerInterface.id", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "A unique layer id." - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.CustomLayerInterface.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"custom\"" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.CustomLayerInterface.renderingMode", - "type": "CompoundType", - "tags": [], - "label": "renderingMode", - "description": [], - "signature": [ - "\"2d\" | \"3d\" | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.CustomLayerInterface.onRemove", + "id": "def-server.Map.loaded", "type": "Function", "tags": [], - "label": "onRemove", + "label": "loaded", "description": [ - "\nOptional method called when the layer has been removed from the Map with Map#removeLayer.\nThis gives the layer a chance to clean up gl resources and event listeners." + "\nReturns a Boolean indicating whether the map is fully loaded.\n\nReturns `false` if the style is not yet fully loaded,\nor if there has been a change to the sources or style that\nhas not yet fully loaded.\n" ], "signature": [ - "((map: maplibregl.Map, gl: WebGLRenderingContext) => void) | undefined" + "() => boolean" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.CustomLayerInterface.onRemove.$1", - "type": "Object", - "tags": [], - "label": "map", - "description": [ - "The Map this custom layer was just added to." - ], - "signature": [ - "maplibregl.Map" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.CustomLayerInterface.onRemove.$2", - "type": "Object", - "tags": [], - "label": "gl", - "description": [ - "The gl context for the map." - ], - "signature": [ - "WebGLRenderingContext" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "children": [], + "returnComment": [ + "A Boolean indicating whether the map is fully loaded." + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.CustomLayerInterface.onAdd", + "id": "def-server.Map._update", "type": "Function", - "tags": [], - "label": "onAdd", + "tags": [ + "private" + ], + "label": "_update", "description": [ - "\nOptional method called when the layer has been added to the Map with Map#addLayer.\nThis gives the layer a chance to initialize gl resources and register event listeners." + "\nUpdate this map's style and sources, and re-render the map.\n" ], "signature": [ - "((map: maplibregl.Map, gl: WebGLRenderingContext) => void) | undefined" + "(updateStyle?: boolean | undefined) => this" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.CustomLayerInterface.onAdd.$1", - "type": "Object", - "tags": [], - "label": "map", - "description": [ - "The Map this custom layer was just added to." - ], - "signature": [ - "maplibregl.Map" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.CustomLayerInterface.onAdd.$2", - "type": "Object", + "id": "def-server.Map._update.$1", + "type": "CompoundType", "tags": [], - "label": "gl", + "label": "updateStyle", "description": [ - "The gl context for the map." + "mark the map's style for reprocessing as\nwell as its sources" ], "signature": [ - "WebGLRenderingContext" + "boolean | undefined" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, - "isRequired": true + "isRequired": false } ], - "returnComment": [] + "returnComment": [ + "this" + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.CustomLayerInterface.prerender", + "id": "def-server.Map._requestRenderFrame", "type": "Function", - "tags": [], - "label": "prerender", + "tags": [ + "private" + ], + "label": "_requestRenderFrame", "description": [ - "\nOptional method called during a render frame to allow a layer to prepare resources\nor render into a texture.\n\nThe layer cannot make any assumptions about the current GL state and must bind a framebuffer\nbefore rendering." + "\nRequest that the given callback be executed during the next render\nframe. Schedule a render frame if one is not already scheduled." ], "signature": [ - "((gl: WebGLRenderingContext, matrix: number[]) => void) | undefined" + "(callback: () => void) => number" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.CustomLayerInterface.prerender.$1", - "type": "Object", + "id": "def-server.Map._requestRenderFrame.$1", + "type": "Function", "tags": [], - "label": "gl", - "description": [ - "The map's gl context." - ], + "label": "callback", + "description": [], "signature": [ - "WebGLRenderingContext" + "() => void" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true - }, + } + ], + "returnComment": [ + "An id that can be used to cancel the callback" + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map._cancelRenderFrame", + "type": "Function", + "tags": [], + "label": "_cancelRenderFrame", + "description": [], + "signature": [ + "(id: number) => void" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.CustomLayerInterface.prerender.$2", - "type": "Array", + "id": "def-server.Map._cancelRenderFrame.$1", + "type": "number", "tags": [], - "label": "matrix", - "description": [ - "The map's camera matrix. It projects spherical mercator coordinates to gl\ncoordinates. The mercator coordinate [0, 0] represents the top left corner of\nthe mercator world and [1, 1] represents the bottom right corner. When the\nrenderingMode is \"3d\" , the z coordinate is conformal. A box with identical\nx, y, and z lengths in mercator units would be rendered as a cube.\nMercatorCoordinate .fromLatLng can be used to project a LngLat to a mercator\ncoordinate." - ], + "label": "id", + "description": [], "signature": [ - "number[]" + "number" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true } @@ -5221,283 +5512,307 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.CustomLayerInterface.render", + "id": "def-server.Map._render", "type": "Function", - "tags": [], - "label": "render", + "tags": [ + "private" + ], + "label": "_render", "description": [ - "\nCalled during a render frame allowing the layer to draw into the GL context.\n\nThe layer can assume blending and depth state is set to allow the layer to properly blend\nand clip other layers. The layer cannot make any other assumptions about the current GL state.\n\nIf the layer needs to render to a texture, it should implement the prerender method to do this\nand only use the render method for drawing directly into the main framebuffer.\n\nThe blend function is set to gl.blendFunc(gl.ONE, gl.ONE_MINUS_SRC_ALPHA). This expects\ncolors to be provided in premultiplied alpha form where the r, g and b values are already\nmultiplied by the a value. If you are unable to provide colors in premultiplied form you may\nwant to change the blend function to\ngl.blendFuncSeparate(gl.SRC_ALPHA, gl.ONE_MINUS_SRC_ALPHA, gl.ONE, gl.ONE_MINUS_SRC_ALPHA).\n" + "\nCall when a (re-)render of the map is required:\n- The style has changed (`setPaintProperty()`, etc.)\n- Source data has changed (e.g. tiles have finished loading)\n- The map has is moving (or just finished moving)\n- A transition is in progress\n" ], "signature": [ - "(gl: WebGLRenderingContext, matrix: number[]) => void" + "(paintStartTimeStamp: number) => this" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.CustomLayerInterface.render.$1", - "type": "Object", + "id": "def-server.Map._render.$1", + "type": "number", "tags": [], - "label": "gl", + "label": "paintStartTimeStamp", "description": [ - "The map's gl context." + "The time when the animation frame began executing." ], "signature": [ - "WebGLRenderingContext" + "number" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true - }, + } + ], + "returnComment": [ + "this" + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.redraw", + "type": "Function", + "tags": [], + "label": "redraw", + "description": [ + "\nForce a synchronous redraw of the map." + ], + "signature": [ + "() => maplibregl.Map" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [], + "returnComment": [ + "`this`" + ] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.remove", + "type": "Function", + "tags": [], + "label": "remove", + "description": [ + "\nClean up and release all internal resources associated with this map.\n\nThis includes DOM elements, event bindings, web workers, and WebGL resources.\n\nUse this method when you are done using the map and wish to ensure that it no\nlonger consumes browser resources. Afterwards, you must not call any other\nmethods on the map." + ], + "signature": [ + "() => void" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.triggerRepaint", + "type": "Function", + "tags": [ + "see", + "see" + ], + "label": "triggerRepaint", + "description": [ + "\nTrigger the rendering of a single frame. Use this method with custom layers to\nrepaint the map when the layer changes. Calling this multiple times before the\nnext frame is rendered will still result in only a single frame being rendered." + ], + "signature": [ + "() => void" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map._onWindowOnline", + "type": "Function", + "tags": [], + "label": "_onWindowOnline", + "description": [], + "signature": [ + "() => void" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map._onWindowResize", + "type": "Function", + "tags": [], + "label": "_onWindowResize", + "description": [], + "signature": [ + "(event: maplibregl.Event) => void" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.CustomLayerInterface.render.$2", - "type": "Array", + "id": "def-server.Map._onWindowResize.$1", + "type": "Object", "tags": [], - "label": "matrix", - "description": [ - "The map's camera matrix. It projects spherical mercator coordinates to gl\ncoordinates. The mercator coordinate [0, 0] represents the top left corner of\nthe mercator world and [1, 1] represents the bottom right corner. When the\nrenderingMode is \"3d\" , the z coordinate is conformal. A box with identical\nx, y, and z lengths in mercator units would be rendered as a cube.\nMercatorCoordinate .fromLatLng can be used to project a LngLat to a mercator\ncoordinate." - ], + "label": "event", + "description": [], "signature": [ - "number[]" + "maplibregl.Event" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.FeatureIdentifier", - "type": "Interface", - "tags": [], - "label": "FeatureIdentifier", - "description": [], - "signature": [ - "maplibregl.FeatureIdentifier" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.FeatureIdentifier.id", - "type": "CompoundType", + "id": "def-server.Map.showTileBoundaries", + "type": "boolean", + "tags": [ + "name", + "type", + "instance", + "memberof" + ], + "label": "showTileBoundaries", + "description": [ + "\nGets and sets a Boolean indicating whether the map will render an outline\naround each tile and the tile ID. These tile boundaries are useful for\ndebugging.\n\nThe uncompressed file size of the first vector source is drawn in the top left\ncorner of each tile, next to the tile ID.\n" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.showTileBoundaries", + "type": "boolean", "tags": [], - "label": "id", + "label": "showTileBoundaries", "description": [], - "signature": [ - "string | number | undefined" + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.showPadding", + "type": "boolean", + "tags": [ + "name", + "type", + "instance", + "memberof" + ], + "label": "showPadding", + "description": [ + "\nGets and sets a Boolean indicating whether the map will visualize\nthe padding offsets.\n" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.FeatureIdentifier.source", - "type": "string", + "id": "def-server.Map.showPadding", + "type": "boolean", "tags": [], - "label": "source", + "label": "showPadding", "description": [], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.FeatureIdentifier.sourceLayer", - "type": "string", + "id": "def-server.Map.showCollisionBoxes", + "type": "boolean", + "tags": [ + "name", + "type", + "instance", + "memberof" + ], + "label": "showCollisionBoxes", + "description": [ + "\nGets and sets a Boolean indicating whether the map will render boxes\naround all symbols in the data source, revealing which symbols\nwere rendered or which were hidden due to collisions.\nThis information is useful for debugging.\n" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.showCollisionBoxes", + "type": "boolean", "tags": [], - "label": "sourceLayer", + "label": "showCollisionBoxes", "description": [], - "signature": [ - "string | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource", - "type": "Interface", - "tags": [], - "label": "GeoJSONSource", - "description": [], - "signature": [ - "maplibregl.GeoJSONSource extends maplibregl.GeoJSONSourceRaw" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.type", - "type": "string", + "id": "def-server.Map.showOverdrawInspector", + "type": "boolean", "tags": [], - "label": "type", + "label": "showOverdrawInspector", "description": [], - "signature": [ - "\"geojson\"" + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.showOverdrawInspector", + "type": "boolean", + "tags": [], + "label": "showOverdrawInspector", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Map.repaint", + "type": "boolean", + "tags": [ + "name", + "type", + "instance", + "memberof" + ], + "label": "repaint", + "description": [ + "\nGets and sets a Boolean indicating whether the map will\ncontinuously repaint. This information is useful for analyzing performance.\n" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.setData", - "type": "Function", + "id": "def-server.Map.repaint", + "type": "boolean", "tags": [], - "label": "setData", + "label": "repaint", "description": [], - "signature": [ - "(data: String | GeoJSON.FeatureCollection | GeoJSON.Feature) => this" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.setData.$1", - "type": "CompoundType", - "tags": [], - "label": "data", - "description": [], - "signature": [ - "String | GeoJSON.FeatureCollection | GeoJSON.Feature" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.getClusterExpansionZoom", - "type": "Function", + "id": "def-server.Map.vertices", + "type": "boolean", "tags": [], - "label": "getClusterExpansionZoom", + "label": "vertices", "description": [], - "signature": [ - "(clusterId: number, callback: (error: any, zoom: number) => void) => this" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.getClusterExpansionZoom.$1", - "type": "number", - "tags": [], - "label": "clusterId", - "description": [], - "signature": [ - "number" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.getClusterExpansionZoom.$2", - "type": "Function", - "tags": [], - "label": "callback", - "description": [], - "signature": [ - "(error: any, zoom: number) => void" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.getClusterChildren", - "type": "Function", + "id": "def-server.Map.vertices", + "type": "boolean", "tags": [], - "label": "getClusterChildren", + "label": "vertices", "description": [], - "signature": [ - "(clusterId: number, callback: (error: any, features: GeoJSON.Feature[]) => void) => this" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.getClusterChildren.$1", - "type": "number", - "tags": [], - "label": "clusterId", - "description": [], - "signature": [ - "number" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.getClusterChildren.$2", - "type": "Function", - "tags": [], - "label": "callback", - "description": [], - "signature": [ - "(error: any, features: GeoJSON.Feature[]) => void" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.getClusterLeaves", + "id": "def-server.Map._setCacheLimits", "type": "Function", "tags": [], - "label": "getClusterLeaves", + "label": "_setCacheLimits", "description": [], "signature": [ - "(cluserId: number, limit: number, offset: number, callback: (error: any, features: GeoJSON.Feature[]) => void) => this" + "(limit: number, checkThreshold: number) => void" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.getClusterLeaves.$1", - "type": "number", - "tags": [], - "label": "cluserId", - "description": [], - "signature": [ - "number" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.getClusterLeaves.$2", + "id": "def-server.Map._setCacheLimits.$1", "type": "number", "tags": [], "label": "limit", @@ -5505,35 +5820,21 @@ "signature": [ "number" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.getClusterLeaves.$3", + "id": "def-server.Map._setCacheLimits.$2", "type": "number", "tags": [], - "label": "offset", + "label": "checkThreshold", "description": [], "signature": [ "number" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.getClusterLeaves.$4", - "type": "Function", - "tags": [], - "label": "callback", - "description": [], - "signature": [ - "(error: any, features: GeoJSON.Feature[]) => void" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "isRequired": true } @@ -5545,851 +5846,1102 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Layer", - "type": "Interface", + "id": "def-server.MapMouseEvent", + "type": "Class", "tags": [], - "label": "Layer", + "label": "MapMouseEvent", "description": [], "signature": [ - "maplibregl.Layer" + "maplibregl.MapMouseEvent extends maplibregl.Event implements maplibregl.MapLibreEvent" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Layer.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Layer.type", - "type": "string", + "id": "def-server.MapMouseEvent.type", + "type": "CompoundType", "tags": [], "label": "type", - "description": [], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Layer.metadata", - "type": "Any", - "tags": [], - "label": "metadata", - "description": [], - "signature": [ - "any" + "description": [ + "\nThe event type (one of {@link Map.event:mousedown},\n{@link Map.event:mouseup},\n{@link Map.event:click},\n{@link Map.event:dblclick},\n{@link Map.event:mousemove},\n{@link Map.event:mouseover},\n{@link Map.event:mouseenter},\n{@link Map.event:mouseleave},\n{@link Map.event:mouseout},\n{@link Map.event:contextmenu})." ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Layer.ref", - "type": "string", - "tags": [], - "label": "ref", - "description": [], "signature": [ - "string | undefined" + "\"mousedown\" | \"mouseup\" | \"mouseover\" | \"mousemove\" | \"click\" | \"dblclick\" | \"mouseenter\" | \"mouseleave\" | \"mouseout\" | \"contextmenu\"" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Layer.source", - "type": "CompoundType", + "id": "def-server.MapMouseEvent.target", + "type": "Object", "tags": [], - "label": "source", - "description": [], + "label": "target", + "description": [ + "\nThe `Map` object that fired the event." + ], "signature": [ - "string | maplibregl.AnySourceData | undefined" + "maplibregl.Map" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Layer.sourcelayer", - "type": "string", + "id": "def-server.MapMouseEvent.originalEvent", + "type": "Object", "tags": [], - "label": "'source-layer'", - "description": [], + "label": "originalEvent", + "description": [ + "\nThe DOM event which caused the map event." + ], "signature": [ - "string | undefined" + "MouseEvent" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Layer.minzoom", - "type": "number", + "id": "def-server.MapMouseEvent.point", + "type": "Object", "tags": [], - "label": "minzoom", - "description": [], + "label": "point", + "description": [ + "\nThe pixel coordinates of the mouse cursor, relative to the map and measured from the top left corner." + ], "signature": [ - "number | undefined" + "node_modules/@types/mapbox__point-geometry/index" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Layer.maxzoom", - "type": "number", + "id": "def-server.MapMouseEvent.lngLat", + "type": "Object", "tags": [], - "label": "maxzoom", - "description": [], + "label": "lngLat", + "description": [ + "\nThe geographic location on the map of the mouse cursor." + ], "signature": [ - "number | undefined" + "maplibregl.LngLat" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Layer.interactive", - "type": "CompoundType", + "id": "def-server.MapMouseEvent.preventDefault", + "type": "Function", "tags": [], - "label": "interactive", - "description": [], + "label": "preventDefault", + "description": [ + "\nPrevents subsequent default processing of the event by the map.\n\nCalling this method will prevent the following default map behaviors:\n\n * On `mousedown` events, the behavior of {@link DragPanHandler}\n * On `mousedown` events, the behavior of {@link DragRotateHandler}\n * On `mousedown` events, the behavior of {@link BoxZoomHandler}\n * On `dblclick` events, the behavior of {@link DoubleClickZoomHandler}\n" + ], "signature": [ - "boolean | undefined" + "() => void" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Layer.filter", - "type": "Array", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "any[] | undefined" + "id": "def-server.MapMouseEvent.defaultPrevented", + "type": "boolean", + "tags": [ + "private" + ], + "label": "defaultPrevented", + "description": [ + "\n`true` if `preventDefault` has been called." ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Layer.layout", - "type": "Object", + "id": "def-server.MapMouseEvent._defaultPrevented", + "type": "boolean", "tags": [], - "label": "layout", + "label": "_defaultPrevented", "description": [], - "signature": [ - "maplibregl.Layout | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Layer.paint", - "type": "Uncategorized", - "tags": [], - "label": "paint", + "id": "def-server.MapMouseEvent.Unnamed", + "type": "Function", + "tags": [ + "private" + ], + "label": "Constructor", "description": [], "signature": [ - "object | undefined" + "any" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.MapMouseEvent.Unnamed.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.MapMouseEvent.Unnamed.$2", + "type": "Object", + "tags": [], + "label": "map", + "description": [], + "signature": [ + "maplibregl.Map" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.MapMouseEvent.Unnamed.$3", + "type": "Object", + "tags": [], + "label": "originalEvent", + "description": [], + "signature": [ + "MouseEvent" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.MapMouseEvent.Unnamed.$4", + "type": "Any", + "tags": [], + "label": "data", + "description": [], + "signature": [ + "any" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions", - "type": "Interface", + "id": "def-server.VectorTileSource", + "type": "Class", "tags": [], - "label": "MapboxOptions", + "label": "VectorTileSource", "description": [], "signature": [ - "maplibregl.MapboxOptions" + "maplibregl.VectorTileSource extends maplibregl.Evented implements maplibregl.Source" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.antialias", - "type": "CompoundType", + "id": "def-server.VectorTileSource.type", + "type": "string", "tags": [], - "label": "antialias", - "description": [ - "\nIf true, the gl context will be created with MSA antialiasing, which can be useful for antialiasing custom layers.\nThis is false by default as a performance optimization." - ], + "label": "type", + "description": [], "signature": [ - "boolean | undefined" + "\"vector\"" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.attributionControl", - "type": "CompoundType", + "id": "def-server.VectorTileSource.id", + "type": "string", "tags": [], - "label": "attributionControl", - "description": [ - "If true, an attribution control will be added to the map." - ], - "signature": [ - "boolean | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "label": "id", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.bearing", + "id": "def-server.VectorTileSource.minzoom", "type": "number", "tags": [], - "label": "bearing", + "label": "minzoom", "description": [], - "signature": [ - "number | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.bearingSnap", + "id": "def-server.VectorTileSource.maxzoom", "type": "number", "tags": [], - "label": "bearingSnap", - "description": [ - "Snap to north threshold in degrees." - ], - "signature": [ - "number | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.bounds", - "type": "CompoundType", - "tags": [], - "label": "bounds", - "description": [ - "The initial bounds of the map. If bounds is specified, it overrides center and zoom constructor options." - ], - "signature": [ - "maplibregl.LngLatBoundsLike | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "label": "maxzoom", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.boxZoom", - "type": "CompoundType", + "id": "def-server.VectorTileSource.url", + "type": "string", "tags": [], - "label": "boxZoom", - "description": [ - "If true, enable the \"box zoom\" interaction (see BoxZoomHandler)" - ], - "signature": [ - "boolean | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "label": "url", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.center", - "type": "CompoundType", + "id": "def-server.VectorTileSource.scheme", + "type": "string", "tags": [], - "label": "center", - "description": [ - "initial map center" - ], - "signature": [ - "maplibregl.LngLatLike | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "label": "scheme", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.clickTolerance", + "id": "def-server.VectorTileSource.tileSize", "type": "number", - "tags": [ - "default" - ], - "label": "clickTolerance", - "description": [ - "\nThe max number of pixels a user can shift the mouse pointer during a click for it to be\nconsidered a valid click (as opposed to a mouse drag).\n" - ], - "signature": [ - "number | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.collectResourceTiming", - "type": "CompoundType", - "tags": [ - "default" - ], - "label": "collectResourceTiming", - "description": [ - "\nIf `true`, Resource Timing API information will be collected for requests made by GeoJSON\nand Vector Tile web workers (this information is normally inaccessible from the main\nJavascript thread). Information will be returned in a `resourceTiming` property of\nrelevant `data` events.\n" - ], - "signature": [ - "boolean | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "tags": [], + "label": "tileSize", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.crossSourceCollisions", + "id": "def-server.VectorTileSource.promoteId", "type": "CompoundType", - "tags": [ - "default" - ], - "label": "crossSourceCollisions", - "description": [ - "\nIf `true`, symbols from multiple sources can collide with each other during collision\ndetection. If `false`, collision detection is run separately for the symbols in each source.\n" - ], + "tags": [], + "label": "promoteId", + "description": [], "signature": [ - "boolean | undefined" + "string | { [_: string]: string; }" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.container", - "type": "CompoundType", + "id": "def-server.VectorTileSource._options", + "type": "Object", "tags": [], - "label": "container", - "description": [ - "ID of the container element" - ], + "label": "_options", + "description": [], "signature": [ - "string | HTMLElement" + "{ type: \"vector\"; url?: string | undefined; tiles?: string[] | undefined; bounds?: [number, number, number, number] | undefined; scheme?: \"xyz\" | \"tms\" | undefined; minzoom?: number | undefined; maxzoom?: number | undefined; attribution?: string | undefined; promoteId?: maplibregl.PromoteIdSpecification | undefined; volatile?: boolean | undefined; }" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.customAttribution", - "type": "CompoundType", + "id": "def-server.VectorTileSource._collectResourceTiming", + "type": "boolean", "tags": [], - "label": "customAttribution", - "description": [ - "String or strings to show in an AttributionControl.\nOnly applicable if options.attributionControl is `true`." - ], - "signature": [ - "string | string[] | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "label": "_collectResourceTiming", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.dragPan", - "type": "CompoundType", + "id": "def-server.VectorTileSource.dispatcher", + "type": "Object", "tags": [], - "label": "dragPan", - "description": [ - "If true, enable the \"drag to pan\" interaction (see DragPanHandler)." - ], + "label": "dispatcher", + "description": [], "signature": [ - "boolean | undefined" + "maplibregl.Dispatcher" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.dragRotate", - "type": "CompoundType", + "id": "def-server.VectorTileSource.map", + "type": "Object", "tags": [], - "label": "dragRotate", - "description": [ - "If true, enable the \"drag to rotate\" interaction (see DragRotateHandler)." - ], + "label": "map", + "description": [], "signature": [ - "boolean | undefined" + "maplibregl.Map" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.doubleClickZoom", - "type": "CompoundType", + "id": "def-server.VectorTileSource.bounds", + "type": "Object", "tags": [], - "label": "doubleClickZoom", - "description": [ - "If true, enable the \"double click to zoom\" interaction (see DoubleClickZoomHandler)." - ], + "label": "bounds", + "description": [], "signature": [ - "boolean | undefined" + "[number, number, number, number]" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.hash", - "type": "CompoundType", + "id": "def-server.VectorTileSource.tiles", + "type": "Array", "tags": [], - "label": "hash", - "description": [ - "If `true`, the map's position (zoom, center latitude, center longitude, bearing, and pitch) will be synced with the hash fragment of the page's URL.\nFor example, `http://path/to/my/page.html#2.59/39.26/53.07/-24.1/60`.\nAn additional string may optionally be provided to indicate a parameter-styled hash,\ne.g. http://path/to/my/page.html#map=2.59/39.26/53.07/-24.1/60&foo=bar, where foo\nis a custom parameter and bar is an arbitrary hash distinct from the map hash." - ], + "label": "tiles", + "description": [], "signature": [ - "string | boolean | undefined" + "string[]" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.fadeDuration", - "type": "number", - "tags": [ - "default" - ], - "label": "fadeDuration", - "description": [ - "\nControls the duration of the fade-in/fade-out animation for label collisions, in milliseconds.\nThis setting affects all symbol layers. This setting does not affect the duration of runtime\nstyling transitions or raster tile cross-fading.\n" - ], + "id": "def-server.VectorTileSource.tileBounds", + "type": "Object", + "tags": [], + "label": "tileBounds", + "description": [], "signature": [ - "number | undefined" + "maplibregl.TileBounds" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.failIfMajorPerformanceCaveat", - "type": "CompoundType", + "id": "def-server.VectorTileSource.reparseOverscaled", + "type": "boolean", "tags": [], - "label": "failIfMajorPerformanceCaveat", - "description": [ - "If true, map creation will fail if the implementation determines that the performance of the created WebGL context would be dramatically lower than expected." - ], - "signature": [ - "boolean | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "label": "reparseOverscaled", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.fitBoundsOptions", - "type": "Object", + "id": "def-server.VectorTileSource.isTileClipped", + "type": "boolean", "tags": [], - "label": "fitBoundsOptions", - "description": [ - "A fitBounds options object to use only when setting the bounds option." - ], - "signature": [ - "maplibregl.FitBoundsOptions | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "label": "isTileClipped", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.interactive", - "type": "CompoundType", + "id": "def-server.VectorTileSource._tileJSONRequest", + "type": "Object", "tags": [], - "label": "interactive", - "description": [ - "If false, no mouse, touch, or keyboard listeners are attached to the map, so it will not respond to input" - ], + "label": "_tileJSONRequest", + "description": [], "signature": [ - "boolean | undefined" + "{ cancel: () => void; }" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.keyboard", - "type": "CompoundType", + "id": "def-server.VectorTileSource._loaded", + "type": "boolean", "tags": [], - "label": "keyboard", - "description": [ - "If true, enable keyboard shortcuts (see KeyboardHandler)." - ], - "signature": [ - "boolean | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "label": "_loaded", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.locale", - "type": "Object", + "id": "def-server.VectorTileSource.Unnamed", + "type": "Function", "tags": [], - "label": "locale", - "description": [ - "A patch to apply to the default localization table for UI strings, e.g. control tooltips.\nThe `locale` object maps namespaced UI string IDs to translated strings in the target language;\nsee `src/ui/default_locale.js` for an example with all supported string IDs.\nThe object may specify all UI strings (thereby adding support for a new translation) or\nonly a subset of strings (thereby patching the default translation table)." - ], + "label": "Constructor", + "description": [], "signature": [ - "{ [key: string]: string; } | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.localIdeographFontFamily", - "type": "string", - "tags": [ - "default" - ], - "label": "localIdeographFontFamily", - "description": [ - "\nIf specified, defines a CSS font-family for locally overriding generation of glyphs in the\n'CJK Unified Ideographs' and 'Hangul Syllables' ranges. In these ranges, font settings from\nthe map's style will be ignored, except for font-weight keywords (light/regular/medium/bold).\nThe purpose of this option is to avoid bandwidth-intensive glyph server requests.\n" + "any" ], - "signature": [ - "string | undefined" + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.VectorTileSource.Unnamed.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.VectorTileSource.Unnamed.$2", + "type": "CompoundType", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "maplibregl.VectorSourceSpecification & { collectResourceTiming: boolean; }" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.VectorTileSource.Unnamed.$3", + "type": "Object", + "tags": [], + "label": "dispatcher", + "description": [], + "signature": [ + "maplibregl.Dispatcher" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.VectorTileSource.Unnamed.$4", + "type": "Object", + "tags": [], + "label": "eventedParent", + "description": [], + "signature": [ + "maplibregl.Evented" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.logoPosition", - "type": "CompoundType", - "tags": [ - "default" - ], - "label": "logoPosition", - "description": [ - "\nA string representing the position of the Mapbox wordmark on the map.\n" - ], + "id": "def-server.VectorTileSource.load", + "type": "Function", + "tags": [], + "label": "load", + "description": [], "signature": [ - "\"top-right\" | \"top-left\" | \"bottom-right\" | \"bottom-left\" | undefined" + "() => void" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.maxBounds", - "type": "CompoundType", + "id": "def-server.VectorTileSource.loaded", + "type": "Function", "tags": [], - "label": "maxBounds", - "description": [ - "If set, the map is constrained to the given bounds." - ], + "label": "loaded", + "description": [], "signature": [ - "maplibregl.LngLatBoundsLike | undefined" + "() => boolean" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.maxPitch", - "type": "number", + "id": "def-server.VectorTileSource.hasTile", + "type": "Function", "tags": [], - "label": "maxPitch", - "description": [ - "Maximum pitch of the map." - ], + "label": "hasTile", + "description": [], "signature": [ - "number | undefined" + "(tileID: maplibregl.OverscaledTileID) => boolean" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.VectorTileSource.hasTile.$1", + "type": "Object", + "tags": [], + "label": "tileID", + "description": [], + "signature": [ + "maplibregl.OverscaledTileID" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.maxZoom", - "type": "number", + "id": "def-server.VectorTileSource.onAdd", + "type": "Function", "tags": [], - "label": "maxZoom", - "description": [ - "Maximum zoom of the map." - ], + "label": "onAdd", + "description": [], "signature": [ - "number | undefined" + "(map: maplibregl.Map) => void" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.VectorTileSource.onAdd.$1", + "type": "Object", + "tags": [], + "label": "map", + "description": [], + "signature": [ + "maplibregl.Map" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.minPitch", - "type": "number", + "id": "def-server.VectorTileSource.setSourceProperty", + "type": "Function", "tags": [], - "label": "minPitch", - "description": [ - "Minimum pitch of the map." - ], + "label": "setSourceProperty", + "description": [], "signature": [ - "number | undefined" + "(callback: Function) => void" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.VectorTileSource.setSourceProperty.$1", + "type": "Object", + "tags": [], + "label": "callback", + "description": [], + "signature": [ + "Function" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.minZoom", - "type": "number", + "id": "def-server.VectorTileSource.setTiles", + "type": "Function", "tags": [], - "label": "minZoom", + "label": "setTiles", "description": [ - "Minimum zoom of the map." + "\nSets the source `tiles` property and re-renders the map.\n" ], "signature": [ - "number | undefined" + "(tiles: string[]) => this" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.VectorTileSource.setTiles.$1", + "type": "Array", + "tags": [], + "label": "tiles", + "description": [ + "An array of one or more tile source URLs, as in the TileJSON spec." + ], + "signature": [ + "string[]" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "this" + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.preserveDrawingBuffer", - "type": "CompoundType", + "id": "def-server.VectorTileSource.setUrl", + "type": "Function", "tags": [], - "label": "preserveDrawingBuffer", + "label": "setUrl", "description": [ - "If true, The maps canvas can be exported to a PNG using map.getCanvas().toDataURL();. This is false by default as a performance optimization." + "\nSets the source `url` property and re-renders the map.\n" ], "signature": [ - "boolean | undefined" + "(url: string) => this" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.VectorTileSource.setUrl.$1", + "type": "string", + "tags": [], + "label": "url", + "description": [ + "A URL to a TileJSON resource. Supported protocols are `http:` and `https:`." + ], + "signature": [ + "string" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "this" + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.pitch", - "type": "number", - "tags": [ - "default" - ], - "label": "pitch", - "description": [ - "\nThe initial pitch (tilt) of the map, measured in degrees away from the plane of the\nscreen (0-60).\n" - ], + "id": "def-server.VectorTileSource.onRemove", + "type": "Function", + "tags": [], + "label": "onRemove", + "description": [], "signature": [ - "number | undefined" + "() => void" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.pitchWithRotate", - "type": "CompoundType", - "tags": [ - "default" - ], - "label": "pitchWithRotate", - "description": [ - "\nIf `false`, the map's pitch (tilt) control with \"drag to rotate\" interaction will be disabled.\n" - ], + "id": "def-server.VectorTileSource.serialize", + "type": "Function", + "tags": [], + "label": "serialize", + "description": [], "signature": [ - "boolean | undefined" + "() => any" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.refreshExpiredTiles", - "type": "CompoundType", - "tags": [ - "default" - ], - "label": "refreshExpiredTiles", - "description": [ - "\nIf `false`, the map won't attempt to re-request tiles once they expire per their HTTP\n`cacheControl`/`expires` headers.\n" - ], + "id": "def-server.VectorTileSource.loadTile", + "type": "Function", + "tags": [], + "label": "loadTile", + "description": [], "signature": [ - "boolean | undefined" + "(tile: maplibregl.Tile, callback: maplibregl.Callback) => void" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.VectorTileSource.loadTile.$1", + "type": "Object", + "tags": [], + "label": "tile", + "description": [], + "signature": [ + "maplibregl.Tile" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.VectorTileSource.loadTile.$2", + "type": "Function", + "tags": [], + "label": "callback", + "description": [], + "signature": [ + "maplibregl.Callback" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.renderWorldCopies", - "type": "CompoundType", - "tags": [ - "default" + "id": "def-server.VectorTileSource.abortTile", + "type": "Function", + "tags": [], + "label": "abortTile", + "description": [], + "signature": [ + "(tile: maplibregl.Tile) => void" ], - "label": "renderWorldCopies", - "description": [ - "\nIf `true`, multiple copies of the world will be rendered, when zoomed out.\n" + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.VectorTileSource.abortTile.$1", + "type": "Object", + "tags": [], + "label": "tile", + "description": [], + "signature": [ + "maplibregl.Tile" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + } ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.VectorTileSource.unloadTile", + "type": "Function", + "tags": [], + "label": "unloadTile", + "description": [], "signature": [ - "boolean | undefined" + "(tile: maplibregl.Tile) => void" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.VectorTileSource.unloadTile.$1", + "type": "Object", + "tags": [], + "label": "tile", + "description": [], + "signature": [ + "maplibregl.Tile" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.scrollZoom", - "type": "CompoundType", + "id": "def-server.VectorTileSource.hasTransition", + "type": "Function", "tags": [], - "label": "scrollZoom", - "description": [ - "If true, enable the \"scroll to zoom\" interaction" - ], + "label": "hasTransition", + "description": [], "signature": [ - "boolean | undefined" + "() => boolean" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.CustomLayerInterface", + "type": "Interface", + "tags": [ + "interface" + ], + "label": "CustomLayerInterface", + "description": [ + "\nInterface for custom style layers. This is a specification for\nimplementers to model: it is not an exported method or class.\n\nCustom layers allow a user to render directly into the map's GL context using the map's camera.\nThese layers can be added between any regular layers using {@link Map#addLayer}.\n\nCustom layers must have a unique `id` and must have the `type` of `\"custom\"`.\nThey must implement `render` and may implement `prerender`, `onAdd` and `onRemove`.\nThey can trigger rendering using {@link Map#triggerRepaint}\nand they should appropriately handle {@link Map.event:webglcontextlost} and\n{@link Map.event:webglcontextrestored}.\n\nThe `renderingMode` property controls whether the layer is treated as a `\"2d\"` or `\"3d\"` map layer. Use:\n- `\"renderingMode\": \"3d\"` to use the depth buffer and share it with other layers\n- `\"renderingMode\": \"2d\"` to add a layer with no depth. If you need to use the depth buffer for a `\"2d\"` layer you must use an offscreen\n framebuffer and {@link CustomLayerInterface#prerender}\n" + ], + "signature": [ + "maplibregl.CustomLayerInterface" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.CustomLayerInterface.id", + "type": "string", + "tags": [ + "property" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "label": "id", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.style", - "type": "CompoundType", - "tags": [], - "label": "style", - "description": [ - "stylesheet location" + "id": "def-server.CustomLayerInterface.type", + "type": "string", + "tags": [ + "property" ], + "label": "type", + "description": [], "signature": [ - "string | maplibregl.Style | undefined" + "\"custom\"" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.trackResize", + "id": "def-server.CustomLayerInterface.renderingMode", "type": "CompoundType", - "tags": [], - "label": "trackResize", - "description": [ - "If true, the map will automatically resize when the browser window resizes" + "tags": [ + "property" ], + "label": "renderingMode", + "description": [], "signature": [ - "boolean | undefined" + "\"2d\" | \"3d\" | undefined" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.transformRequest", + "id": "def-server.CustomLayerInterface.render", "type": "Function", "tags": [ - "default" - ], - "label": "transformRequest", - "description": [ - "\nA callback run before the Map makes a request for an external URL. The callback can be\nused to modify the url, set headers, or set the credentials property for cross-origin requests.\n" - ], - "signature": [ - "maplibregl.TransformRequestFunction | undefined" + "function", + "memberof", + "instance", + "name" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.touchZoomRotate", - "type": "CompoundType", - "tags": [], - "label": "touchZoomRotate", + "label": "render", "description": [ - "If true, enable the \"pinch to rotate and zoom\" interaction (see TouchZoomRotateHandler)." + "\nCalled during a render frame allowing the layer to draw into the GL context.\n\nThe layer can assume blending and depth state is set to allow the layer to properly\nblend and clip other layers. The layer cannot make any other assumptions about the\ncurrent GL state.\n\nIf the layer needs to render to a texture, it should implement the `prerender` method\nto do this and only use the `render` method for drawing directly into the main framebuffer.\n\nThe blend function is set to `gl.blendFunc(gl.ONE, gl.ONE_MINUS_SRC_ALPHA)`. This expects\ncolors to be provided in premultiplied alpha form where the `r`, `g` and `b` values are already\nmultiplied by the `a` value. If you are unable to provide colors in premultiplied form you\nmay want to change the blend function to\n`gl.blendFuncSeparate(gl.SRC_ALPHA, gl.ONE_MINUS_SRC_ALPHA, gl.ONE, gl.ONE_MINUS_SRC_ALPHA)`.\n" ], "signature": [ - "boolean | undefined" + "(gl: WebGLRenderingContext, matrix: ", + "mat4", + ") => void" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.CustomLayerInterface.render.$1", + "type": "Object", + "tags": [], + "label": "gl", + "description": [ + "The map's gl context." + ], + "signature": [ + "WebGLRenderingContext" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.CustomLayerInterface.render.$2", + "type": "CompoundType", + "tags": [], + "label": "matrix", + "description": [ + "The map's camera matrix. It projects spherical mercator\ncoordinates to gl coordinates. The spherical mercator coordinate `[0, 0]` represents the\ntop left corner of the mercator world and `[1, 1]` represents the bottom right corner. When\nthe `renderingMode` is `\"3d\"`, the z coordinate is conformal. A box with identical x, y, and z\nlengths in mercator units would be rendered as a cube. {@link MercatorCoordinate }.fromLngLat\ncan be used to project a `LngLat` to a mercator coordinate." + ], + "signature": [ + "Float32Array | [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number]" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + } + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.touchPitch", - "type": "CompoundType", - "tags": [], - "label": "touchPitch", - "description": [ - "If true, the \"drag to pitch\" interaction is enabled" - ], - "signature": [ - "boolean | undefined" + "id": "def-server.CustomLayerInterface.prerender", + "type": "Function", + "tags": [ + "function", + "memberof", + "instance", + "name" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.zoom", - "type": "number", - "tags": [], - "label": "zoom", + "label": "prerender", "description": [ - "Initial zoom level" + "\nOptional method called during a render frame to allow a layer to prepare resources or render into a texture.\n\nThe layer cannot make any assumptions about the current GL state and must bind a framebuffer before rendering.\n" ], "signature": [ - "number | undefined" + "maplibregl.CustomRenderMethod | undefined" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.maxTileCacheSize", - "type": "number", + "id": "def-server.CustomLayerInterface.onAdd", + "type": "Function", "tags": [ - "default" + "function", + "memberof", + "instance", + "name" ], - "label": "maxTileCacheSize", + "label": "onAdd", "description": [ - "\nThe maximum number of tiles stored in the tile cache for a given source. If omitted, the\ncache will be dynamically sized based on the current viewport.\n" + "\nOptional method called when the layer has been added to the Map with {@link Map#addLayer}. This\ngives the layer a chance to initialize gl resources and register event listeners.\n" ], "signature": [ - "number | undefined" + "((map: maplibregl.Map, gl: WebGLRenderingContext) => void) | undefined" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.CustomLayerInterface.onAdd.$1", + "type": "Object", + "tags": [], + "label": "map", + "description": [ + "The Map this custom layer was just added to." + ], + "signature": [ + "maplibregl.Map" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.CustomLayerInterface.onAdd.$2", + "type": "Object", + "tags": [], + "label": "gl", + "description": [ + "The gl context for the map." + ], + "signature": [ + "WebGLRenderingContext" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxOptions.accessToken", - "type": "string", + "id": "def-server.CustomLayerInterface.onRemove", + "type": "Function", "tags": [ - "default" + "function", + "memberof", + "instance", + "name" ], - "label": "accessToken", + "label": "onRemove", "description": [ - "\nIf specified, map will use this token instead of the one defined in maplibregl.accessToken.\n" + "\nOptional method called when the layer has been removed from the Map with {@link Map#removeLayer}. This\ngives the layer a chance to clean up gl resources and event listeners.\n" ], "signature": [ - "string | undefined" + "((map: maplibregl.Map, gl: WebGLRenderingContext) => void) | undefined" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.CustomLayerInterface.onRemove.$1", + "type": "Object", + "tags": [], + "label": "map", + "description": [ + "The Map this custom layer was just added to." + ], + "signature": [ + "maplibregl.Map" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.CustomLayerInterface.onRemove.$2", + "type": "Object", + "tags": [], + "label": "gl", + "description": [ + "The gl context for the map." + ], + "signature": [ + "WebGLRenderingContext" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -6402,9 +6954,9 @@ "label": "MapSourceDataEvent", "description": [], "signature": [ - "maplibregl.MapSourceDataEvent extends maplibregl.MapboxEvent" + "maplibregl.MapSourceDataEvent extends maplibregl.MapLibreEvent" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { @@ -6417,7 +6969,7 @@ "signature": [ "\"source\"" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { @@ -6427,20 +6979,20 @@ "tags": [], "label": "isSourceLoaded", "description": [], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", "id": "def-server.MapSourceDataEvent.source", - "type": "Object", + "type": "CompoundType", "tags": [], "label": "source", "description": [], "signature": [ - "maplibregl.Source" + "maplibregl.VectorSourceSpecification | maplibregl.RasterSourceSpecification | maplibregl.RasterDEMSourceSpecification | maplibregl.GeoJSONSourceSpecification | maplibregl.VideoSourceSpecification | maplibregl.ImageSourceSpecification" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { @@ -6450,7 +7002,7 @@ "tags": [], "label": "sourceId", "description": [], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { @@ -6463,7 +7015,7 @@ "signature": [ "\"metadata\" | \"content\"" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { @@ -6476,20 +7028,7 @@ "signature": [ "any" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapSourceDataEvent.coord", - "type": "Object", - "tags": [], - "label": "coord", - "description": [], - "signature": [ - "maplibregl.Coordinate" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false } ], @@ -6497,315 +7036,471 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Style", + "id": "def-server.Source", "type": "Interface", - "tags": [], - "label": "Style", - "description": [], + "tags": [ + "private", + "fires", + "property", + "property", + "property", + "property", + "property", + "property" + ], + "label": "Source", + "description": [ + "\nThe `Source` interface must be implemented by each source type, including \"core\" types (`vector`, `raster`,\n`video`, etc.) and all custom, third-party types.\n" + ], "signature": [ - "maplibregl.Style" + "maplibregl.Source" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Style.bearing", - "type": "number", + "id": "def-server.Source.type", + "type": "string", "tags": [], - "label": "bearing", + "label": "type", "description": [], - "signature": [ - "number | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Style.center", - "type": "Array", + "id": "def-server.Source.id", + "type": "string", "tags": [], - "label": "center", + "label": "id", "description": [], - "signature": [ - "number[] | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Style.glyphs", - "type": "string", + "id": "def-server.Source.minzoom", + "type": "number", "tags": [], - "label": "glyphs", + "label": "minzoom", "description": [], - "signature": [ - "string | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Style.layers", - "type": "Array", + "id": "def-server.Source.maxzoom", + "type": "number", "tags": [], - "label": "layers", + "label": "maxzoom", "description": [], - "signature": [ - "maplibregl.AnyLayer[] | undefined" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Style.metadata", - "type": "Any", + "id": "def-server.Source.tileSize", + "type": "number", "tags": [], - "label": "metadata", + "label": "tileSize", "description": [], - "signature": [ - "any" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Style.name", + "id": "def-server.Source.attribution", "type": "string", "tags": [], - "label": "name", + "label": "attribution", "description": [], "signature": [ "string | undefined" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Style.pitch", - "type": "number", + "id": "def-server.Source.roundZoom", + "type": "CompoundType", "tags": [], - "label": "pitch", + "label": "roundZoom", "description": [], "signature": [ - "number | undefined" + "boolean | undefined" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Style.light", - "type": "Object", + "id": "def-server.Source.isTileClipped", + "type": "CompoundType", "tags": [], - "label": "light", + "label": "isTileClipped", "description": [], "signature": [ - "maplibregl.Light | undefined" + "boolean | undefined" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Style.sources", + "id": "def-server.Source.tileID", "type": "Object", "tags": [], - "label": "sources", + "label": "tileID", "description": [], "signature": [ - "maplibregl.Sources | undefined" + "maplibregl.CanonicalTileID | undefined" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Style.sprite", - "type": "string", + "id": "def-server.Source.reparseOverscaled", + "type": "CompoundType", "tags": [], - "label": "sprite", + "label": "reparseOverscaled", "description": [], "signature": [ - "string | undefined" + "boolean | undefined" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Style.transition", - "type": "Object", + "id": "def-server.Source.vectorLayerIds", + "type": "Array", "tags": [], - "label": "transition", + "label": "vectorLayerIds", "description": [], "signature": [ - "maplibregl.Transition | undefined" + "string[] | undefined" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Style.version", - "type": "number", + "id": "def-server.Source.hasTransition", + "type": "Function", "tags": [], - "label": "version", + "label": "hasTransition", "description": [], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false + "signature": [ + "() => boolean" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Style.zoom", - "type": "number", + "id": "def-server.Source.loaded", + "type": "Function", "tags": [], - "label": "zoom", + "label": "loaded", "description": [], "signature": [ - "number | undefined" + "() => boolean" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorSource", - "type": "Interface", - "tags": [], - "label": "VectorSource", - "description": [], - "signature": [ - "maplibregl.VectorSource extends maplibregl.Source" - ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false, - "children": [ + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorSource.type", - "type": "string", + "id": "def-server.Source.fire", + "type": "Function", "tags": [], - "label": "type", + "label": "fire", "description": [], "signature": [ - "\"vector\"" + "(event: maplibregl.Event) => unknown" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Source.fire.$1", + "type": "Object", + "tags": [], + "label": "event", + "description": [], + "signature": [ + "maplibregl.Event" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorSource.url", - "type": "string", + "id": "def-server.Source.onAdd", + "type": "Function", "tags": [], - "label": "url", + "label": "onAdd", "description": [], "signature": [ - "string | undefined" + "((map: maplibregl.Map) => void) | undefined" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Source.onAdd.$1", + "type": "Object", + "tags": [], + "label": "map", + "description": [], + "signature": [ + "maplibregl.Map" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorSource.tiles", - "type": "Array", + "id": "def-server.Source.onRemove", + "type": "Function", "tags": [], - "label": "tiles", + "label": "onRemove", "description": [], "signature": [ - "string[] | undefined" + "((map: maplibregl.Map) => void) | undefined" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Source.onRemove.$1", + "type": "Object", + "tags": [], + "label": "map", + "description": [], + "signature": [ + "maplibregl.Map" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorSource.bounds", - "type": "Array", + "id": "def-server.Source.loadTile", + "type": "Function", "tags": [], - "label": "bounds", + "label": "loadTile", "description": [], "signature": [ - "number[] | undefined" + "(tile: maplibregl.Tile, callback: maplibregl.Callback) => void" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Source.loadTile.$1", + "type": "Object", + "tags": [], + "label": "tile", + "description": [], + "signature": [ + "maplibregl.Tile" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Source.loadTile.$2", + "type": "Function", + "tags": [], + "label": "callback", + "description": [], + "signature": [ + "maplibregl.Callback" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorSource.scheme", - "type": "CompoundType", + "id": "def-server.Source.hasTile", + "type": "Function", "tags": [], - "label": "scheme", + "label": "hasTile", "description": [], "signature": [ - "\"xyz\" | \"tms\" | undefined" + "((tileID: maplibregl.OverscaledTileID) => boolean) | undefined" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Source.hasTile.$1", + "type": "Object", + "tags": [], + "label": "tileID", + "description": [], + "signature": [ + "maplibregl.OverscaledTileID" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorSource.minzoom", - "type": "number", + "id": "def-server.Source.abortTile", + "type": "Function", "tags": [], - "label": "minzoom", + "label": "abortTile", "description": [], "signature": [ - "number | undefined" + "((tile: maplibregl.Tile, callback: maplibregl.Callback) => void) | undefined" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Source.abortTile.$1", + "type": "Object", + "tags": [], + "label": "tile", + "description": [], + "signature": [ + "maplibregl.Tile" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Source.abortTile.$2", + "type": "Function", + "tags": [], + "label": "callback", + "description": [], + "signature": [ + "maplibregl.Callback" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorSource.maxzoom", - "type": "number", + "id": "def-server.Source.unloadTile", + "type": "Function", "tags": [], - "label": "maxzoom", + "label": "unloadTile", "description": [], "signature": [ - "number | undefined" + "((tile: maplibregl.Tile, callback: maplibregl.Callback) => void) | undefined" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Source.unloadTile.$1", + "type": "Object", + "tags": [], + "label": "tile", + "description": [], + "signature": [ + "maplibregl.Tile" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Source.unloadTile.$2", + "type": "Function", + "tags": [], + "label": "callback", + "description": [], + "signature": [ + "maplibregl.Callback" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorSource.attribution", - "type": "string", - "tags": [], - "label": "attribution", + "id": "def-server.Source.serialize", + "type": "Function", + "tags": [ + "private" + ], + "label": "serialize", "description": [], "signature": [ - "string | undefined" + "() => any" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [], + "returnComment": [ + "A plain (stringifiable) JS object representing the current state of the source.\nCreating a source using the returned object as the `options` should result in a Source that is\nequivalent to this one." + ] }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorSource.promoteId", - "type": "CompoundType", + "id": "def-server.Source.prepare", + "type": "Function", "tags": [], - "label": "promoteId", + "label": "prepare", "description": [], "signature": [ - "maplibregl.PromoteIdSpecification | undefined" + "(() => void) | undefined" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", - "deprecated": false + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -6815,38 +7510,80 @@ "misc": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.AnyLayer", + "id": "def-server.FeatureIdentifier", + "type": "Type", + "tags": [], + "label": "FeatureIdentifier", + "description": [], + "signature": [ + "{ id?: string | number | undefined; source: string; sourceLayer?: string | undefined; }" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.FilterSpecification", + "type": "Type", + "tags": [], + "label": "FilterSpecification", + "description": [], + "signature": [ + "[\"at\", number, (string | number)[]] | [\"get\", string, (Record | undefined)?] | [\"has\", string, (Record | undefined)?] | [\"in\", ...maplibregl.FilterSpecificationInputType[], maplibregl.FilterSpecificationInputType | maplibregl.FilterSpecificationInputType[]] | [\"index-of\", maplibregl.FilterSpecificationInputType, maplibregl.FilterSpecificationInputType | maplibregl.FilterSpecificationInputType[]] | [\"length\", string | string[]] | [\"slice\", string | string[], number] | [\"!\", maplibregl.FilterSpecification] | [\"!=\", string | maplibregl.FilterSpecification, maplibregl.FilterSpecificationInputType] | [\"<\", string | maplibregl.FilterSpecification, maplibregl.FilterSpecificationInputType] | [\"<=\", string | maplibregl.FilterSpecification, maplibregl.FilterSpecificationInputType] | [\"==\", string | maplibregl.FilterSpecification, maplibregl.FilterSpecificationInputType] | [\">\", string | maplibregl.FilterSpecification, maplibregl.FilterSpecificationInputType] | [\">=\", string | maplibregl.FilterSpecification, maplibregl.FilterSpecificationInputType] | [\"all\", ...maplibregl.FilterSpecification[], maplibregl.FilterSpecificationInputType] | [\"any\", ...maplibregl.FilterSpecification[], maplibregl.FilterSpecificationInputType] | [\"case\", ...maplibregl.FilterSpecification[], maplibregl.FilterSpecificationInputType] | [\"coalesce\", ...maplibregl.FilterSpecification[], maplibregl.FilterSpecificationInputType] | [\"match\", ...maplibregl.FilterSpecification[], maplibregl.FilterSpecificationInputType] | [\"within\", ...maplibregl.FilterSpecification[], maplibregl.FilterSpecificationInputType] | [\"!in\", ...maplibregl.FilterSpecification[], maplibregl.FilterSpecificationInputType] | [\"!has\", ...maplibregl.FilterSpecification[], maplibregl.FilterSpecificationInputType] | [\"none\", ...maplibregl.FilterSpecification[], maplibregl.FilterSpecificationInputType] | (string | maplibregl.FilterSpecification)[]" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.LayerSpecification", + "type": "Type", + "tags": [], + "label": "LayerSpecification", + "description": [], + "signature": [ + "maplibregl.FillLayerSpecification | maplibregl.LineLayerSpecification | maplibregl.SymbolLayerSpecification | maplibregl.CircleLayerSpecification | maplibregl.HeatmapLayerSpecification | maplibregl.FillExtrusionLayerSpecification | maplibregl.RasterLayerSpecification | maplibregl.HillshadeLayerSpecification | maplibregl.BackgroundLayerSpecification" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.MapEvent", "type": "Type", "tags": [], - "label": "AnyLayer", + "label": "MapEvent", "description": [], "signature": [ - "maplibregl.BackgroundLayer | maplibregl.CircleLayer | maplibregl.FillExtrusionLayer | maplibregl.FillLayer | maplibregl.HeatmapLayer | maplibregl.HillshadeLayer | maplibregl.LineLayer | maplibregl.RasterLayer | maplibregl.SymbolLayer | maplibregl.CustomLayerInterface" + "\"remove\" | \"error\" | \"data\" | \"render\" | \"move\" | \"rotate\" | \"idle\" | \"resize\" | \"zoom\" | \"mousedown\" | \"mouseup\" | \"mouseover\" | \"mousemove\" | \"click\" | \"dblclick\" | \"mouseenter\" | \"mouseleave\" | \"mouseout\" | \"contextmenu\" | \"wheel\" | \"touchstart\" | \"touchend\" | \"touchmove\" | \"touchcancel\" | \"movestart\" | \"moveend\" | \"dragstart\" | \"drag\" | \"dragend\" | \"zoomstart\" | \"zoomend\" | \"rotatestart\" | \"rotateend\" | \"pitchstart\" | \"pitch\" | \"pitchend\" | \"boxzoomstart\" | \"boxzoomend\" | \"boxzoomcancel\" | \"webglcontextlost\" | \"webglcontextrestored\" | \"load\" | \"styledata\" | \"sourcedata\" | \"dataloading\" | \"styledataloading\" | \"sourcedataloading\" | \"styleimagemissing\" | \"style.load\" | \"dataabort\" | \"sourcedataabort\"" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapboxGeoJSONFeature", + "id": "def-server.MapGeoJSONFeature", "type": "Type", "tags": [], - "label": "MapboxGeoJSONFeature", + "label": "MapGeoJSONFeature", "description": [], "signature": [ - "GeoJSON.Feature & { layer: maplibregl.Layer; source: string; sourceLayer: string; state: { [key: string]: any; }; }" + "maplibregl.GeoJSONFeature & { layer: Omit & { source: string; }; source: string; sourceLayer?: string | undefined; state: { [key: string]: any; }; }" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.mapboxgl", + "id": "def-server.maplibregl", "type": "Any", "tags": [], - "label": "mapboxgl", + "label": "maplibregl", "description": [], "signature": [ "any" @@ -6857,15 +7594,62 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.PointLike", + "id": "def-server.MapOptions", "type": "Type", "tags": [], + "label": "MapOptions", + "description": [], + "signature": [ + "{ hash?: string | boolean | undefined; interactive?: boolean | undefined; container: string | HTMLElement; bearingSnap?: number | undefined; attributionControl?: boolean | undefined; customAttribution?: string | string[] | undefined; maplibreLogo?: boolean | undefined; logoPosition?: maplibregl.ControlPosition | undefined; failIfMajorPerformanceCaveat?: boolean | undefined; preserveDrawingBuffer?: boolean | undefined; antialias?: boolean | undefined; refreshExpiredTiles?: boolean | undefined; maxBounds?: maplibregl.LngLatBoundsLike | undefined; scrollZoom?: boolean | undefined; minZoom?: number | null | undefined; maxZoom?: number | null | undefined; minPitch?: number | null | undefined; maxPitch?: number | null | undefined; boxZoom?: boolean | undefined; dragRotate?: boolean | undefined; dragPan?: boolean | maplibregl.DragPanOptions | undefined; keyboard?: boolean | undefined; doubleClickZoom?: boolean | undefined; touchZoomRotate?: boolean | undefined; touchPitch?: boolean | undefined; trackResize?: boolean | undefined; center?: maplibregl.LngLatLike | undefined; zoom?: number | undefined; bearing?: number | undefined; pitch?: number | undefined; renderWorldCopies?: boolean | undefined; maxTileCacheSize?: number | undefined; transformRequest?: maplibregl.RequestTransformFunction | undefined; locale?: any; fadeDuration?: number | undefined; crossSourceCollisions?: boolean | undefined; collectResourceTiming?: boolean | undefined; clickTolerance?: number | undefined; bounds?: maplibregl.LngLatBoundsLike | undefined; fitBoundsOptions?: Object | undefined; localIdeographFontFamily?: string | undefined; style: string | maplibregl.StyleSpecification; pitchWithRotate?: boolean | undefined; pixelRatio?: number | undefined; }" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.Point2D", + "type": "Type", + "tags": [], + "label": "Point2D", + "description": [], + "signature": [ + "{ x: number; y: number; }" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.PointLike", + "type": "Type", + "tags": [ + "typedef" + ], "label": "PointLike", + "description": [ + "\nA [Point](https://github.com/mapbox/point-geometry) or an array of two numbers representing `x` and `y` screen coordinates in pixels.\n" + ], + "signature": [ + "[number, number] | ", + "node_modules/@types/mapbox__point-geometry/index" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-server.StyleSpecification", + "type": "Type", + "tags": [], + "label": "StyleSpecification", "description": [], "signature": [ - "[number, number] | maplibregl.Point" + "{ version: 8; name?: string | undefined; metadata?: unknown; center?: number[] | undefined; zoom?: number | undefined; bearing?: number | undefined; pitch?: number | undefined; light?: maplibregl.LightSpecification | undefined; sources: { [_: string]: maplibregl.SourceSpecification; }; sprite?: string | undefined; glyphs?: string | undefined; transition?: maplibregl.TransitionSpecification | undefined; layers: maplibregl.LayerSpecification[]; }" ], - "path": "node_modules/maplibre-gl/src/index.d.ts", + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, "initialIsOpen": false } diff --git a/api_docs/kbn_mapbox_gl.mdx b/api_docs/kbn_mapbox_gl.mdx index 53aa377e5c7a7..98e67f9b8208e 100644 --- a/api_docs/kbn_mapbox_gl.mdx +++ b/api_docs/kbn_mapbox_gl.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-mapbox-gl title: "@kbn/mapbox-gl" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/mapbox-gl plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/mapbox-gl'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 466 | 1 | 1 | 0 | +| 494 | 1 | 1 | 0 | ## Server diff --git a/api_docs/kbn_monaco.mdx b/api_docs/kbn_monaco.mdx index 71a68c280f4c4..e0dbc611af5a0 100644 --- a/api_docs/kbn_monaco.mdx +++ b/api_docs/kbn_monaco.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-monaco title: "@kbn/monaco" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/monaco plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/monaco'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_optimizer.mdx b/api_docs/kbn_optimizer.mdx index 2a473e955b4f0..589a60a957724 100644 --- a/api_docs/kbn_optimizer.mdx +++ b/api_docs/kbn_optimizer.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-optimizer title: "@kbn/optimizer" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/optimizer plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/optimizer'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_plugin_discovery.devdocs.json b/api_docs/kbn_plugin_discovery.devdocs.json index f3e8e676b568f..331ea07e1db83 100644 --- a/api_docs/kbn_plugin_discovery.devdocs.json +++ b/api_docs/kbn_plugin_discovery.devdocs.json @@ -19,7 +19,7 @@ "label": "getPluginSearchPaths", "description": [], "signature": [ - "({ rootDir, oss, examples }: ", + "({ rootDir, oss, examples, testPlugins }: ", { "pluginId": "@kbn/plugin-discovery", "scope": "server", @@ -37,7 +37,7 @@ "id": "def-server.getPluginSearchPaths.$1", "type": "Object", "tags": [], - "label": "{ rootDir, oss, examples }", + "label": "{ rootDir, oss, examples, testPlugins }", "description": [], "signature": [ { @@ -289,6 +289,19 @@ "path": "packages/kbn-plugin-discovery/src/parse_kibana_platform_plugin.ts", "deprecated": false }, + { + "parentPluginId": "@kbn/plugin-discovery", + "id": "def-server.KibanaPlatformPluginManifest.enabledOnAnonymousPages", + "type": "CompoundType", + "tags": [], + "label": "enabledOnAnonymousPages", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "packages/kbn-plugin-discovery/src/parse_kibana_platform_plugin.ts", + "deprecated": false + }, { "parentPluginId": "@kbn/plugin-discovery", "id": "def-server.KibanaPlatformPluginManifest.serviceFolders", @@ -396,6 +409,19 @@ "description": [], "path": "packages/kbn-plugin-discovery/src/plugin_search_paths.ts", "deprecated": false + }, + { + "parentPluginId": "@kbn/plugin-discovery", + "id": "def-server.SearchOptions.testPlugins", + "type": "CompoundType", + "tags": [], + "label": "testPlugins", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "packages/kbn-plugin-discovery/src/plugin_search_paths.ts", + "deprecated": false } ], "initialIsOpen": false diff --git a/api_docs/kbn_plugin_discovery.mdx b/api_docs/kbn_plugin_discovery.mdx index 0bdfc493aa7d4..1e30d398d906c 100644 --- a/api_docs/kbn_plugin_discovery.mdx +++ b/api_docs/kbn_plugin_discovery.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-plugin-discovery title: "@kbn/plugin-discovery" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/plugin-discovery plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-discovery'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 28 | 0 | 27 | 0 | +| 30 | 0 | 29 | 0 | ## Server diff --git a/api_docs/kbn_plugin_generator.mdx b/api_docs/kbn_plugin_generator.mdx index 6803a60cd1d81..85a2f9ace93de 100644 --- a/api_docs/kbn_plugin_generator.mdx +++ b/api_docs/kbn_plugin_generator.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-plugin-generator title: "@kbn/plugin-generator" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/plugin-generator plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-generator'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_plugin_helpers.mdx b/api_docs/kbn_plugin_helpers.mdx index b549f24fa74fa..abcb0613f1d31 100644 --- a/api_docs/kbn_plugin_helpers.mdx +++ b/api_docs/kbn_plugin_helpers.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-plugin-helpers title: "@kbn/plugin-helpers" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/plugin-helpers plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-helpers'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_pm.devdocs.json b/api_docs/kbn_pm.devdocs.json index ec66a824a63a3..d43dd55273e42 100644 --- a/api_docs/kbn_pm.devdocs.json +++ b/api_docs/kbn_pm.devdocs.json @@ -328,23 +328,6 @@ "children": [], "returnComment": [] }, - { - "parentPluginId": "@kbn/pm", - "id": "def-server.Project.getIntermediateBuildDirectory", - "type": "Function", - "tags": [], - "label": "getIntermediateBuildDirectory", - "description": [ - "\nReturns the directory that should be copied into the Kibana build artifact.\nThis config can be specified to only include the project's build artifacts\ninstead of everything located in the project directory." - ], - "signature": [ - "() => string" - ], - "path": "packages/kbn-pm/src/utils/project.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, { "parentPluginId": "@kbn/pm", "id": "def-server.Project.getCleanConfig", @@ -578,177 +561,12 @@ "deprecated": false, "children": [], "returnComment": [] - }, - { - "parentPluginId": "@kbn/pm", - "id": "def-server.Project.installDependencies", - "type": "Function", - "tags": [], - "label": "installDependencies", - "description": [], - "signature": [ - "(options?: { extraArgs?: string[] | undefined; }) => Promise" - ], - "path": "packages/kbn-pm/src/utils/project.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/pm", - "id": "def-server.Project.installDependencies.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "path": "packages/kbn-pm/src/utils/project.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/pm", - "id": "def-server.Project.installDependencies.$1.extraArgs", - "type": "Array", - "tags": [], - "label": "extraArgs", - "description": [], - "signature": [ - "string[] | undefined" - ], - "path": "packages/kbn-pm/src/utils/project.ts", - "deprecated": false - } - ] - } - ], - "returnComment": [] } ], "initialIsOpen": false } ], "functions": [ - { - "parentPluginId": "@kbn/pm", - "id": "def-server.buildBazelProductionProjects", - "type": "Function", - "tags": [], - "label": "buildBazelProductionProjects", - "description": [], - "signature": [ - "({\n kibanaRoot,\n buildRoot,\n onlyOSS,\n}: { kibanaRoot: string; buildRoot: string; onlyOSS?: boolean | undefined; }) => Promise" - ], - "path": "packages/kbn-pm/src/production/build_bazel_production_projects.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/pm", - "id": "def-server.buildBazelProductionProjects.$1", - "type": "Object", - "tags": [], - "label": "{\n kibanaRoot,\n buildRoot,\n onlyOSS,\n}", - "description": [], - "path": "packages/kbn-pm/src/production/build_bazel_production_projects.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/pm", - "id": "def-server.buildBazelProductionProjects.$1.kibanaRoot", - "type": "string", - "tags": [], - "label": "kibanaRoot", - "description": [], - "path": "packages/kbn-pm/src/production/build_bazel_production_projects.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/pm", - "id": "def-server.buildBazelProductionProjects.$1.buildRoot", - "type": "string", - "tags": [], - "label": "buildRoot", - "description": [], - "path": "packages/kbn-pm/src/production/build_bazel_production_projects.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/pm", - "id": "def-server.buildBazelProductionProjects.$1.onlyOSS", - "type": "CompoundType", - "tags": [], - "label": "onlyOSS", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "packages/kbn-pm/src/production/build_bazel_production_projects.ts", - "deprecated": false - } - ] - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/pm", - "id": "def-server.buildNonBazelProductionProjects", - "type": "Function", - "tags": [], - "label": "buildNonBazelProductionProjects", - "description": [], - "signature": [ - "({\n kibanaRoot,\n buildRoot,\n onlyOSS,\n}: { kibanaRoot: string; buildRoot: string; onlyOSS?: boolean | undefined; }) => Promise" - ], - "path": "packages/kbn-pm/src/production/build_non_bazel_production_projects.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/pm", - "id": "def-server.buildNonBazelProductionProjects.$1", - "type": "Object", - "tags": [], - "label": "{\n kibanaRoot,\n buildRoot,\n onlyOSS,\n}", - "description": [], - "path": "packages/kbn-pm/src/production/build_non_bazel_production_projects.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/pm", - "id": "def-server.buildNonBazelProductionProjects.$1.kibanaRoot", - "type": "string", - "tags": [], - "label": "kibanaRoot", - "description": [], - "path": "packages/kbn-pm/src/production/build_non_bazel_production_projects.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/pm", - "id": "def-server.buildNonBazelProductionProjects.$1.buildRoot", - "type": "string", - "tags": [], - "label": "buildRoot", - "description": [], - "path": "packages/kbn-pm/src/production/build_non_bazel_production_projects.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/pm", - "id": "def-server.buildNonBazelProductionProjects.$1.onlyOSS", - "type": "CompoundType", - "tags": [], - "label": "onlyOSS", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "packages/kbn-pm/src/production/build_non_bazel_production_projects.ts", - "deprecated": false - } - ] - } - ], - "returnComment": [], - "initialIsOpen": false - }, { "parentPluginId": "@kbn/pm", "id": "def-server.getProjectPaths", @@ -889,42 +707,6 @@ ], "returnComment": [], "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/pm", - "id": "def-server.transformDependencies", - "type": "Function", - "tags": [], - "label": "transformDependencies", - "description": [ - "\nReplaces `link:` dependencies with `file:` dependencies. When installing\ndependencies, these `file:` dependencies will be copied into `node_modules`\ninstead of being symlinked.\n\nThis will allow us to copy packages into the build and run `yarn`, which\nwill then _copy_ the `file:` dependencies into `node_modules` instead of\nsymlinking like we do in development.\n\nAdditionally it also taken care of replacing `link:bazel-bin/` with\n`file:` so we can also support the copy of the Bazel packages dist already into\nbuild/packages to be copied into the node_modules" - ], - "signature": [ - "(dependencies: ", - "IPackageDependencies", - ") => ", - "IPackageDependencies" - ], - "path": "packages/kbn-pm/src/utils/package_json.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/pm", - "id": "def-server.transformDependencies.$1", - "type": "Object", - "tags": [], - "label": "dependencies", - "description": [], - "signature": [ - "IPackageDependencies" - ], - "path": "packages/kbn-pm/src/utils/package_json.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false } ], "interfaces": [], diff --git a/api_docs/kbn_pm.mdx b/api_docs/kbn_pm.mdx index c71a8c2a1e351..b720c9ac68580 100644 --- a/api_docs/kbn_pm.mdx +++ b/api_docs/kbn_pm.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-pm title: "@kbn/pm" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/pm plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/pm'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 63 | 0 | 49 | 5 | +| 47 | 0 | 35 | 5 | ## Server diff --git a/api_docs/kbn_react_field.mdx b/api_docs/kbn_react_field.mdx index 5ada92c6138c5..6253496021689 100644 --- a/api_docs/kbn_react_field.mdx +++ b/api_docs/kbn_react_field.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-react-field title: "@kbn/react-field" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/react-field plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/react-field'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_rule_data_utils.mdx b/api_docs/kbn_rule_data_utils.mdx index 13068a7957a81..94645ec075d4d 100644 --- a/api_docs/kbn_rule_data_utils.mdx +++ b/api_docs/kbn_rule_data_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-rule-data-utils title: "@kbn/rule-data-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/rule-data-utils plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/rule-data-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_autocomplete.devdocs.json b/api_docs/kbn_securitysolution_autocomplete.devdocs.json index ee08de8665996..3c23bf9f43822 100644 --- a/api_docs/kbn_securitysolution_autocomplete.devdocs.json +++ b/api_docs/kbn_securitysolution_autocomplete.devdocs.json @@ -305,9 +305,9 @@ "\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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }[], field?: (", + "(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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }[], 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }[]" + " & { 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }[]" ], "path": "packages/kbn-securitysolution-autocomplete/src/filter_field_to_list/index.ts", "deprecated": false, @@ -322,7 +322,7 @@ "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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }[]" + "{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }[]" ], "path": "packages/kbn-securitysolution-autocomplete/src/filter_field_to_list/index.ts", "deprecated": false, diff --git a/api_docs/kbn_securitysolution_autocomplete.mdx b/api_docs/kbn_securitysolution_autocomplete.mdx index c2866fcd43b3f..e007783b67ee3 100644 --- a/api_docs/kbn_securitysolution_autocomplete.mdx +++ b/api_docs/kbn_securitysolution_autocomplete.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-autocomplete title: "@kbn/securitysolution-autocomplete" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-autocomplete plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-autocomplete'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_es_utils.mdx b/api_docs/kbn_securitysolution_es_utils.mdx index ed7d867290493..4662dfc9e1a4e 100644 --- a/api_docs/kbn_securitysolution_es_utils.mdx +++ b/api_docs/kbn_securitysolution_es_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-es-utils title: "@kbn/securitysolution-es-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-es-utils plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-es-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_hook_utils.mdx b/api_docs/kbn_securitysolution_hook_utils.mdx index 41a05b8d05265..4894eb915413e 100644 --- a/api_docs/kbn_securitysolution_hook_utils.mdx +++ b/api_docs/kbn_securitysolution_hook_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-hook-utils title: "@kbn/securitysolution-hook-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-hook-utils plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-hook-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx b/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx index bb61fa2b22770..f0e0356561dd8 100644 --- a/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx +++ b/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-alerting-types title: "@kbn/securitysolution-io-ts-alerting-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-io-ts-alerting-types plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-alerting-types'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_io_ts_list_types.devdocs.json b/api_docs/kbn_securitysolution_io_ts_list_types.devdocs.json index f3b10dd30d340..333ab73f958fc 100644 --- a/api_docs/kbn_securitysolution_io_ts_list_types.devdocs.json +++ b/api_docs/kbn_securitysolution_io_ts_list_types.devdocs.json @@ -27,7 +27,7 @@ "label": "updateExceptionListItemValidate", "description": [], "signature": [ - "(schema: { 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) => string[]" + "(schema: { 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) => string[]" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/update_exception_list_item_validation/index.ts", "deprecated": false, @@ -40,7 +40,7 @@ "label": "schema", "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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" + "{ 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: 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-io-ts-list-types/src/request/update_exception_list_item_validation/index.ts", "deprecated": false, @@ -58,7 +58,7 @@ "label": "validateComments", "description": [], "signature": [ - "(item: { 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) => string[]" + "(item: { 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) => string[]" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/update_exception_list_item_validation/index.ts", "deprecated": false, @@ -71,7 +71,7 @@ "label": "item", "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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" + "{ 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: 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-io-ts-list-types/src/request/update_exception_list_item_validation/index.ts", "deprecated": false, @@ -153,7 +153,7 @@ "label": "listItem", "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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }" + "{ 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/typescript_types/index.ts", "deprecated": false @@ -1216,7 +1216,7 @@ "label": "listItem", "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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" + "{ 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: 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-io-ts-list-types/src/typescript_types/index.ts", "deprecated": false @@ -1307,7 +1307,7 @@ "label": "exceptions", "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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }[]" + "{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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 @@ -1897,7 +1897,7 @@ "label": "CreateEndpointListItemSchemaDecoded", "description": [], "signature": [ - "Omit<{ description: string; entries: ({ field: string; operator: \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; comments: { comment: string; }[] | undefined; item_id: string | undefined; meta: object | undefined; os_types: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags: string[] | undefined; }, \"tags\" | \"entries\" | \"comments\" | \"item_id\" | \"os_types\"> & { comments: { comment: string; }[]; tags: string[]; item_id: 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; os_types: (\"windows\" | \"linux\" | \"macos\")[]; }" + "Omit<{ description: string; entries: ({ field: string; operator: \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"included\"; type: \"match_any\"; value: string[]; } | { field: string; operator: \"included\"; type: \"wildcard\"; value: string; } | { entries: ({ field: string; operator: \"included\"; type: \"match\"; value: string; } | { field: string; operator: \"included\"; type: \"match_any\"; value: string[]; })[]; field: string; type: \"nested\"; })[]; name: string; type: \"simple\"; comments: { comment: string; }[] | undefined; item_id: string | undefined; meta: object | undefined; os_types: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags: string[] | undefined; }, \"tags\" | \"entries\" | \"comments\" | \"item_id\" | \"os_types\"> & { comments: { comment: string; }[]; tags: string[]; item_id: 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; os_types: (\"windows\" | \"linux\" | \"macos\")[]; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/create_endpoint_list_item_schema/index.ts", "deprecated": false, @@ -1925,7 +1925,7 @@ "label": "CreateExceptionListItemSchema", "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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }" + "{ 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/create_exception_list_item_schema/index.ts", "deprecated": false, @@ -1939,7 +1939,7 @@ "label": "CreateExceptionListItemSchemaDecoded", "description": [], "signature": [ - "Omit<{ 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }, \"tags\" | \"entries\" | \"comments\" | \"item_id\" | \"namespace_type\"> & { comments: { comment: string; }[]; tags: string[]; item_id: 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; }" + "Omit<{ 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }, \"tags\" | \"entries\" | \"comments\" | \"item_id\" | \"namespace_type\"> & { comments: { comment: string; }[]; tags: string[]; item_id: 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/create_exception_list_item_schema/index.ts", "deprecated": false, @@ -2009,7 +2009,7 @@ "label": "CreateListSchema", "description": [], "signature": [ - "{ description: string; name: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; } & { deserializer?: string | undefined; id?: string | undefined; meta?: object | undefined; serializer?: string | undefined; version?: number | undefined; }" + "{ description: string; name: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; } & { deserializer?: string | undefined; id?: string | undefined; meta?: object | undefined; serializer?: string | undefined; version?: number | undefined; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/create_list_schema/index.ts", "deprecated": false, @@ -2023,7 +2023,7 @@ "label": "CreateListSchemaDecoded", "description": [], "signature": [ - "{ type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; id: string | undefined; description: string; name: string; meta: object | undefined; serializer: string | undefined; deserializer: string | undefined; } & { version: number; }" + "{ id: string | undefined; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; description: string; name: string; 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, @@ -2317,7 +2317,7 @@ "label": "EntriesArray", "description": [], "signature": [ - "({ 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/common/entries/index.ts", "deprecated": false, @@ -2331,7 +2331,7 @@ "label": "EntriesArrayOrUndefined", "description": [], "signature": [ - "({ 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[] | undefined" + "({ 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[] | undefined" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/common/entries/index.ts", "deprecated": false, @@ -2345,7 +2345,7 @@ "label": "Entry", "description": [], "signature": [ - "{ 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; }" + "{ 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/common/entries/index.ts", "deprecated": false, @@ -2373,7 +2373,7 @@ "label": "EntryList", "description": [], "signature": [ - "{ field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; }" + "{ field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/common/entries_list/index.ts", "deprecated": false, @@ -2443,7 +2443,7 @@ "label": "ExceptionListItemSchema", "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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }" + "{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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/response/exception_list_item_schema/index.ts", "deprecated": false, @@ -2765,7 +2765,7 @@ "label": "FoundExceptionListItemSchema", "description": [], "signature": [ - "{ data: { _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }[]; page: number; per_page: number; total: number; } & { pit?: string | undefined; }" + "{ data: { _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }[]; page: number; per_page: number; total: number; } & { pit?: string | undefined; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/found_exception_list_item_schema/index.ts", "deprecated": false, @@ -2793,7 +2793,7 @@ "label": "FoundListItemSchema", "description": [], "signature": [ - "{ cursor: string; 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }[]; page: number; per_page: number; total: number; }" + "{ cursor: string; 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }[]; page: number; per_page: number; total: number; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/found_list_item_schema/index.ts", "deprecated": false, @@ -2807,7 +2807,7 @@ "label": "FoundListSchema", "description": [], "signature": [ - "{ cursor: string; data: { _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }" + "{ cursor: string; data: { _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/found_list_schema/index.ts", "deprecated": false, @@ -2919,7 +2919,7 @@ "label": "ImportExceptionListItemSchema", "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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; item_id: string; list_id: string; name: string; type: \"simple\"; } & { id?: string | undefined; comments?: (({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; }) | { comment: string; })[] | undefined; created_at?: string | undefined; updated_at?: string | undefined; created_by?: string | undefined; updated_by?: string | undefined; _version?: string | undefined; tie_breaker_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" + "{ 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; item_id: string; list_id: string; name: string; type: \"simple\"; } & { id?: string | undefined; comments?: (({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; }) | { comment: string; })[] | undefined; created_at?: string | undefined; updated_at?: string | undefined; created_by?: string | undefined; updated_by?: string | undefined; _version?: string | undefined; tie_breaker_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/import_exception_item_schema/index.ts", "deprecated": false, @@ -2933,7 +2933,7 @@ "label": "ImportExceptionListItemSchemaDecoded", "description": [], "signature": [ - "Omit<{ 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; item_id: string; list_id: string; name: string; type: \"simple\"; } & { id?: string | undefined; comments?: (({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; }) | { comment: string; })[] | undefined; created_at?: string | undefined; updated_at?: string | undefined; created_by?: string | undefined; updated_by?: string | undefined; _version?: string | undefined; tie_breaker_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }, \"tags\" | \"entries\" | \"comments\" | \"item_id\" | \"namespace_type\"> & { comments: (({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; }) | { comment: string; })[]; tags: string[]; item_id: 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; }" + "Omit<{ 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; item_id: string; list_id: string; name: string; type: \"simple\"; } & { id?: string | undefined; comments?: (({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; }) | { comment: string; })[] | undefined; created_at?: string | undefined; updated_at?: string | undefined; created_by?: string | undefined; updated_by?: string | undefined; _version?: string | undefined; tie_breaker_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }, \"tags\" | \"entries\" | \"comments\" | \"item_id\" | \"namespace_type\"> & { comments: (({ comment: string; created_at: string; created_by: string; id: string; } & { updated_at?: string | undefined; updated_by?: string | undefined; }) | { comment: string; })[]; tags: string[]; item_id: 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/import_exception_item_schema/index.ts", "deprecated": false, @@ -2989,7 +2989,7 @@ "label": "ImportListItemQuerySchema", "description": [], "signature": [ - "{ deserializer: string | undefined; list_id: string | undefined; serializer: string | undefined; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\" | undefined; }" + "{ deserializer: string | undefined; list_id: string | undefined; serializer: string | undefined; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\" | undefined; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/import_list_item_query_schema/index.ts", "deprecated": false, @@ -3003,7 +3003,7 @@ "label": "ImportListItemQuerySchemaEncoded", "description": [], "signature": [ - "{ deserializer?: string | undefined; list_id?: string | undefined; serializer?: string | undefined; type?: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\" | undefined; }" + "{ deserializer?: string | undefined; list_id?: string | undefined; serializer?: string | undefined; type?: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\" | undefined; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/import_list_item_query_schema/index.ts", "deprecated": false, @@ -3115,7 +3115,7 @@ "label": "ListArraySchema", "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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }[]" + "{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }[]" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/list_schema/index.ts", "deprecated": false, @@ -3157,7 +3157,7 @@ "label": "ListItemArraySchema", "description": [], "signature": [ - "{ _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }[]" + "{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }[]" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/list_item_schema/index.ts", "deprecated": false, @@ -3185,7 +3185,7 @@ "label": "ListItemSchema", "description": [], "signature": [ - "{ _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }" + "{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/list_item_schema/index.ts", "deprecated": false, @@ -3213,7 +3213,7 @@ "label": "ListSchema", "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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }" + "{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/list_schema/index.ts", "deprecated": false, @@ -3423,7 +3423,7 @@ "label": "NonEmptyEntriesArray", "description": [], "signature": [ - "({ 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/common/non_empty_entries_array/index.ts", "deprecated": false, @@ -3437,7 +3437,7 @@ "label": "NonEmptyEntriesArrayDecoded", "description": [], "signature": [ - "({ 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/common/non_empty_entries_array/index.ts", "deprecated": false, @@ -3829,7 +3829,7 @@ "label": "SearchListItemArraySchema", "description": [], "signature": [ - "{ items: { _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }[]; value: unknown; }[]" + "{ items: { _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }[]; value: unknown; }[]" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/search_list_item_schema/index.ts", "deprecated": false, @@ -3843,7 +3843,7 @@ "label": "SearchListItemSchema", "description": [], "signature": [ - "{ items: { _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }[]; value: unknown; }" + "{ items: { _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }[]; value: unknown; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/response/search_list_item_schema/index.ts", "deprecated": false, @@ -3983,7 +3983,7 @@ "label": "Type", "description": [], "signature": [ - "\"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"" + "\"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/common/type/index.ts", "deprecated": false, @@ -3997,7 +3997,7 @@ "label": "TypeOrUndefined", "description": [], "signature": [ - "\"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\" | undefined" + "\"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\" | undefined" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/common/type/index.ts", "deprecated": false, @@ -4053,7 +4053,7 @@ "label": "UpdateEndpointListItemSchema", "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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" + "{ 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/update_endpoint_list_item_schema/index.ts", "deprecated": false, @@ -4067,7 +4067,7 @@ "label": "UpdateEndpointListItemSchemaDecoded", "description": [], "signature": [ - "Omit<{ 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; name: string; type: \"simple\"; _version: string | undefined; comments: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id: string | undefined; item_id: string | undefined; meta: object | undefined; os_types: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags: string[] | undefined; }, \"tags\" | \"entries\" | \"comments\"> & { comments: ({ comment: string; } & { id?: string | undefined; })[]; tags: 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; os_types: (\"windows\" | \"linux\" | \"macos\")[]; }" + "Omit<{ 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; name: string; type: \"simple\"; _version: string | undefined; comments: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id: string | undefined; item_id: string | undefined; meta: object | undefined; os_types: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags: string[] | undefined; }, \"tags\" | \"entries\" | \"comments\"> & { comments: ({ comment: string; } & { id?: string | undefined; })[]; tags: 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; os_types: (\"windows\" | \"linux\" | \"macos\")[]; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/update_endpoint_list_item_schema/index.ts", "deprecated": false, @@ -4081,7 +4081,7 @@ "label": "UpdateExceptionListItemSchema", "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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" + "{ 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: 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-io-ts-list-types/src/request/update_exception_list_item_schema/index.ts", "deprecated": false, @@ -4095,7 +4095,7 @@ "label": "UpdateExceptionListItemSchemaDecoded", "description": [], "signature": [ - "Omit<{ 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; name: string; type: \"simple\"; _version: string | undefined; comments: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id: string | undefined; item_id: string | undefined; meta: object | undefined; namespace_type: \"single\" | \"agnostic\" | undefined; os_types: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags: string[] | undefined; }, \"tags\" | \"entries\" | \"comments\" | \"namespace_type\" | \"os_types\"> & { comments: ({ comment: string; } & { id?: string | undefined; })[]; tags: 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; }" + "Omit<{ 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; name: string; type: \"simple\"; _version: string | undefined; comments: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id: string | undefined; item_id: string | undefined; meta: object | undefined; namespace_type: \"single\" | \"agnostic\" | undefined; os_types: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags: string[] | undefined; }, \"tags\" | \"entries\" | \"comments\" | \"namespace_type\" | \"os_types\"> & { comments: ({ comment: string; } & { id?: string | undefined; })[]; tags: 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; namespace_type: \"single\" | \"agnostic\"; os_types: (\"windows\" | \"linux\" | \"macos\")[]; }" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/request/update_exception_list_item_schema/index.ts", "deprecated": false, @@ -4628,7 +4628,7 @@ "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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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: ", + "<({ 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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", @@ -6914,7 +6914,7 @@ "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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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>; item_id: ", + "<({ 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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>; item_id: ", "Type", "; list_id: ", "Type", @@ -7847,7 +7847,7 @@ ], "signature": [ "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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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>" + "<({ 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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>" ], "path": "packages/kbn-securitysolution-io-ts-list-types/src/common/non_empty_entries_array/index.ts", "deprecated": false, @@ -8780,7 +8780,7 @@ "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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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>; name: ", + "<({ 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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>; name: ", "StringC", "; type: ", "KeyofC", @@ -8833,7 +8833,7 @@ "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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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>; name: ", + "<({ 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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>; name: ", "StringC", "; type: ", "KeyofC", diff --git a/api_docs/kbn_securitysolution_io_ts_list_types.mdx b/api_docs/kbn_securitysolution_io_ts_list_types.mdx index dd8f1bf8648d9..22b0760147191 100644 --- a/api_docs/kbn_securitysolution_io_ts_list_types.mdx +++ b/api_docs/kbn_securitysolution_io_ts_list_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-list-types title: "@kbn/securitysolution-io-ts-list-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-io-ts-list-types plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-list-types'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_io_ts_types.mdx b/api_docs/kbn_securitysolution_io_ts_types.mdx index 65d532fec19e4..40ecac1736349 100644 --- a/api_docs/kbn_securitysolution_io_ts_types.mdx +++ b/api_docs/kbn_securitysolution_io_ts_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-types title: "@kbn/securitysolution-io-ts-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-io-ts-types plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-types'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_io_ts_utils.mdx b/api_docs/kbn_securitysolution_io_ts_utils.mdx index a5c39ba338990..04e891298a380 100644 --- a/api_docs/kbn_securitysolution_io_ts_utils.mdx +++ b/api_docs/kbn_securitysolution_io_ts_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-utils title: "@kbn/securitysolution-io-ts-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-io-ts-utils plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_list_api.devdocs.json b/api_docs/kbn_securitysolution_list_api.devdocs.json index 816e93b590a41..8c92d4257224a 100644 --- a/api_docs/kbn_securitysolution_list_api.devdocs.json +++ b/api_docs/kbn_securitysolution_list_api.devdocs.json @@ -62,7 +62,7 @@ "signature": [ "({ http, listItem, signal, }: ", "AddExceptionListItemProps", - ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }>" + ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }>" ], "path": "packages/kbn-securitysolution-list-api/src/api/index.ts", "deprecated": false, @@ -206,7 +206,7 @@ "signature": [ "({ http, id, namespaceType, signal, }: ", "ApiCallByIdProps", - ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }>" + ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }>" ], "path": "packages/kbn-securitysolution-list-api/src/api/index.ts", "deprecated": false, @@ -245,7 +245,7 @@ "section": "def-common.DeleteListParams", "text": "DeleteListParams" }, - ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }>" + ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }>" ], "path": "packages/kbn-securitysolution-list-api/src/list_api/index.ts", "deprecated": false, @@ -399,7 +399,7 @@ "signature": [ "({ http, id, namespaceType, signal, }: ", "ApiCallByIdProps", - ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }>" + ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }>" ], "path": "packages/kbn-securitysolution-list-api/src/api/index.ts", "deprecated": false, @@ -432,7 +432,7 @@ "signature": [ "({ filterOptions, http, listIds, namespaceTypes, pagination, signal, }: ", "ApiCallByListIdProps", - ") => Promise<{ data: { _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }[]; page: number; per_page: number; total: number; } & { pit?: string | undefined; }>" + ") => Promise<{ data: { _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }[]; page: number; per_page: number; total: number; } & { pit?: string | undefined; }>" ], "path": "packages/kbn-securitysolution-list-api/src/api/index.ts", "deprecated": false, @@ -504,7 +504,7 @@ "section": "def-common.FindListsParams", "text": "FindListsParams" }, - ") => Promise<{ cursor: string; data: { _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }>" + ") => Promise<{ cursor: string; data: { _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }>" ], "path": "packages/kbn-securitysolution-list-api/src/list_api/index.ts", "deprecated": false, @@ -549,7 +549,7 @@ "section": "def-common.ImportListParams", "text": "ImportListParams" }, - ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }>" + ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }>" ], "path": "packages/kbn-securitysolution-list-api/src/list_api/index.ts", "deprecated": false, @@ -743,7 +743,7 @@ "signature": [ "({ http, listItem, signal, }: ", "UpdateExceptionListItemProps", - ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }>" + ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }>" ], "path": "packages/kbn-securitysolution-list-api/src/api/index.ts", "deprecated": false, @@ -1076,7 +1076,7 @@ "label": "type", "description": [], "signature": [ - "\"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\" | undefined" + "\"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\" | undefined" ], "path": "packages/kbn-securitysolution-list-api/src/list_api/types.ts", "deprecated": false diff --git a/api_docs/kbn_securitysolution_list_api.mdx b/api_docs/kbn_securitysolution_list_api.mdx index 0f81fc34f3478..8b6b8cf07c15a 100644 --- a/api_docs/kbn_securitysolution_list_api.mdx +++ b/api_docs/kbn_securitysolution_list_api.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-api title: "@kbn/securitysolution-list-api" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-list-api plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-api'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_list_constants.mdx b/api_docs/kbn_securitysolution_list_constants.mdx index 698ac13af76d0..6615bac9efb38 100644 --- a/api_docs/kbn_securitysolution_list_constants.mdx +++ b/api_docs/kbn_securitysolution_list_constants.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-constants title: "@kbn/securitysolution-list-constants" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-list-constants plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-constants'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_list_hooks.devdocs.json b/api_docs/kbn_securitysolution_list_hooks.devdocs.json index 248881607be2d..48a866f37b9f3 100644 --- a/api_docs/kbn_securitysolution_list_hooks.devdocs.json +++ b/api_docs/kbn_securitysolution_list_hooks.devdocs.json @@ -29,7 +29,7 @@ "\nThis adds an id to the incoming exception item entries as ReactJS prefers to have\nan id added to them for use as a stable id. Later if we decide to change the data\nmodel to have id's within the array then this code should be removed. If not, then\nthis code should stay as an adapter for ReactJS.\n\nThis does break the type system slightly as we are lying a bit to the type system as we return\nthe same exceptionItem as we have previously but are augmenting the arrays with an id which TypeScript\ndoesn't mind us doing here. However, downstream you will notice that you have an id when the type\ndoes not indicate it. In that case use (ExceptionItem & { id: string }) temporarily if you're using the id. If you're not,\nyou can ignore the id and just use the normal TypeScript with ReactJS.\n" ], "signature": [ - "(exceptionItem: { _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }) => { _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }" + "(exceptionItem: { _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }) => { _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }" ], "path": "packages/kbn-securitysolution-list-hooks/src/transforms/index.ts", "deprecated": false, @@ -44,7 +44,7 @@ "The exceptionItem to add an id to the threat matches." ], "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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }" + "{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }" ], "path": "packages/kbn-securitysolution-list-hooks/src/transforms/index.ts", "deprecated": false, @@ -66,7 +66,7 @@ "\nThis removes an id from the exceptionItem entries as ReactJS prefers to have\nan id added to them for use as a stable id. Later if we decide to change the data\nmodel to have id's within the array then this code should be removed. If not, then\nthis code should stay as an adapter for ReactJS.\n" ], "signature": [ - "(exceptionItem: T) => T" + "(exceptionItem: T) => T" ], "path": "packages/kbn-securitysolution-list-hooks/src/transforms/index.ts", "deprecated": false, @@ -103,7 +103,7 @@ "\nTransforms the output of rules to compensate for technical debt or UI concerns such as\nReactJS preferences for having ids within arrays if the data is not modeled that way.\n\nIf you add a new transform of the input called \"myNewTransform\" do it\nin the form of:\nflow(addIdToExceptionItemEntries, myNewTransform)(exceptionItem)\n" ], "signature": [ - "(exceptionItem: { _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }) => { _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }" + "(exceptionItem: { _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }) => { _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }" ], "path": "packages/kbn-securitysolution-list-hooks/src/transforms/index.ts", "deprecated": false, @@ -118,7 +118,7 @@ "The exceptionItem to transform the output of" ], "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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }" + "{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }" ], "path": "packages/kbn-securitysolution-list-hooks/src/transforms/index.ts", "deprecated": false, @@ -138,7 +138,7 @@ "label": "transformNewItemOutput", "description": [], "signature": [ - "(exceptionItem: { description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }) => { description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }" + "(exceptionItem: { description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }) => { description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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-hooks/src/transforms/index.ts", "deprecated": false, @@ -151,7 +151,7 @@ "label": "exceptionItem", "description": [], "signature": [ - "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }" + "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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-hooks/src/transforms/index.ts", "deprecated": false, @@ -171,7 +171,7 @@ "\nTransforms the output of exception items to compensate for technical debt or UI concerns such as\nReactJS preferences for having ids within arrays if the data is not modeled that way.\n\nIf you add a new transform of the output called \"myNewTransform\" do it\nin the form of:\nflow(removeIdFromExceptionItemsEntries, myNewTransform)(exceptionItem)\n" ], "signature": [ - "(exceptionItem: { _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; })" + "(exceptionItem: { _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: 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-hooks/src/transforms/index.ts", "deprecated": false, @@ -186,7 +186,7 @@ "The exceptionItem to transform the output of" ], "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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: 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-hooks/src/transforms/index.ts", "deprecated": false, @@ -317,7 +317,7 @@ "OptionalSignalArgs", "<", "DeleteListParams", - ">], { _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }>" + ">], { _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }>" ], "path": "packages/kbn-securitysolution-list-hooks/src/use_delete_list/index.ts", "deprecated": false, @@ -445,7 +445,7 @@ "OptionalSignalArgs", "<", "FindListsParams", - ">], { cursor: string; data: { _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }>" + ">], { cursor: string; data: { _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }>" ], "path": "packages/kbn-securitysolution-list-hooks/src/use_find_lists/index.ts", "deprecated": false, @@ -467,7 +467,7 @@ "OptionalSignalArgs", "<", "ImportListParams", - ">], { _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }>" + ">], { _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }>" ], "path": "packages/kbn-securitysolution-list-hooks/src/use_import_list/index.ts", "deprecated": false, @@ -623,7 +623,7 @@ "label": "addExceptionListItem", "description": [], "signature": [ - "(arg: { listItem: { description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }; }) => Promise<{ _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }>" + "(arg: { listItem: { description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }; }) => Promise<{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }>" ], "path": "packages/kbn-securitysolution-list-hooks/src/use_api/index.ts", "deprecated": false, @@ -646,7 +646,7 @@ "label": "listItem", "description": [], "signature": [ - "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }" + "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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-hooks/src/use_api/index.ts", "deprecated": false @@ -664,7 +664,7 @@ "label": "updateExceptionListItem", "description": [], "signature": [ - "(arg: { listItem: { description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }; }) => Promise<{ _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }>" + "(arg: { listItem: { description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }; }) => Promise<{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }>" ], "path": "packages/kbn-securitysolution-list-hooks/src/use_api/index.ts", "deprecated": false, @@ -687,7 +687,7 @@ "label": "listItem", "description": [], "signature": [ - "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }" + "{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: 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-hooks/src/use_api/index.ts", "deprecated": false @@ -771,7 +771,7 @@ "signature": [ "(arg: ", "ApiCallMemoProps", - " & { onSuccess: (arg: { _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }) => void; }) => Promise" + " & { onSuccess: (arg: { _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }) => void; }) => Promise" ], "path": "packages/kbn-securitysolution-list-hooks/src/use_api/index.ts", "deprecated": false, @@ -785,7 +785,7 @@ "description": [], "signature": [ "ApiCallMemoProps", - " & { onSuccess: (arg: { _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }) => void; }" + " & { onSuccess: (arg: { _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }) => void; }" ], "path": "packages/kbn-securitysolution-list-hooks/src/use_api/index.ts", "deprecated": false, @@ -954,7 +954,7 @@ "label": "ReturnExceptionListAndItems", "description": [], "signature": [ - "[boolean, { _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }[], ", + "[boolean, { _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }[], ", "Pagination", ", Func | null]" ], @@ -996,7 +996,7 @@ "label": "ReturnPersistExceptionItem", "description": [], "signature": [ - "[PersistReturnExceptionItem, React.Dispatch<({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }) | ({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) | null>]" + "[PersistReturnExceptionItem, React.Dispatch<({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }) | ({ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\"; })[]; name: string; type: \"simple\"; } & { _version?: string | undefined; comments?: ({ comment: string; } & { id?: string | undefined; })[] | undefined; id?: string | undefined; item_id?: string | undefined; meta?: object | undefined; namespace_type?: \"single\" | \"agnostic\" | undefined; os_types?: (\"windows\" | \"linux\" | \"macos\")[] | undefined; tags?: string[] | undefined; }) | null>]" ], "path": "packages/kbn-securitysolution-list-hooks/src/use_persist_exception_item/index.ts", "deprecated": false, diff --git a/api_docs/kbn_securitysolution_list_hooks.mdx b/api_docs/kbn_securitysolution_list_hooks.mdx index db34eab6092e6..70e03cbfed95c 100644 --- a/api_docs/kbn_securitysolution_list_hooks.mdx +++ b/api_docs/kbn_securitysolution_list_hooks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-hooks title: "@kbn/securitysolution-list-hooks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-list-hooks plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-hooks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_list_utils.devdocs.json b/api_docs/kbn_securitysolution_list_utils.devdocs.json index e10ed1097e954..89f36219cbe6b 100644 --- a/api_docs/kbn_securitysolution_list_utils.devdocs.json +++ b/api_docs/kbn_securitysolution_list_utils.devdocs.json @@ -27,7 +27,7 @@ "label": "addIdToEntries", "description": [], "signature": [ - "(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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; })[]) => ({ 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; })[]" + "(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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; })[]) => ({ 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; })[]" ], "path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts", "deprecated": false, @@ -40,7 +40,7 @@ "label": "entries", "description": [], "signature": [ - "({ 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; })[]" + "({ 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; })[]" ], "path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts", "deprecated": false, @@ -58,7 +58,7 @@ "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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }) => ", + "({ 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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" ], @@ -83,7 +83,7 @@ "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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }))[]" + "({ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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 @@ -703,7 +703,7 @@ "section": "def-common.ExceptionsBuilderExceptionItem", "text": "ExceptionsBuilderExceptionItem" }, - "[]) => ({ _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }))[]" + "[]) => ({ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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/helpers/index.ts", "deprecated": false, @@ -957,7 +957,7 @@ "section": "def-common.FormattedBuilderEntry", "text": "FormattedBuilderEntry" }, - ") => ({ 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; }) & { id?: string | undefined; }" + ") => ({ 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; }) & { id?: string | undefined; }" ], "path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts", "deprecated": false, @@ -1099,7 +1099,7 @@ "section": "def-common.FormattedBuilderEntry", "text": "FormattedBuilderEntry" }, - ", newField: { _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }) => { index: number; updatedEntry: ", + ", newField: { _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }) => { index: number; updatedEntry: ", { "pluginId": "@kbn/securitysolution-list-utils", "scope": "common", @@ -1144,7 +1144,7 @@ "- newly selected list" ], "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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }" + "{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }" ], "path": "packages/kbn-securitysolution-list-utils/src/helpers/index.ts", "deprecated": false, @@ -2529,7 +2529,7 @@ "label": "hasLargeValueList", "description": [], "signature": [ - "(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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; })[]) => boolean" + "(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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; })[]) => boolean" ], "path": "packages/kbn-securitysolution-list-utils/src/has_large_value_list/index.ts", "deprecated": false, @@ -2542,7 +2542,7 @@ "label": "entries", "description": [], "signature": [ - "({ 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; })[]" + "({ 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; })[]" ], "path": "packages/kbn-securitysolution-list-utils/src/has_large_value_list/index.ts", "deprecated": false, @@ -3170,7 +3170,7 @@ "label": "BuilderEntry", "description": [], "signature": [ - "(({ 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; }) & { id?: string | undefined; }) | ", + "(({ 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; operator: \"excluded\" | \"included\"; type: \"list\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; operator: \"excluded\" | \"included\"; type: \"wildcard\"; value: string; }) & { id?: string | undefined; }) | ", { "pluginId": "@kbn/securitysolution-list-utils", "scope": "common", @@ -3229,7 +3229,7 @@ "label": "CreateExceptionListItemBuilderSchema", "description": [], "signature": [ - "Omit<{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }, \"meta\" | \"entries\"> & { meta: { temporaryUuid: string; }; entries: ", + "Omit<{ description: string; entries: ({ field: string; operator: \"excluded\" | \"included\"; type: \"exists\"; } | { field: string; list: { id: string; type: \"boolean\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }, \"meta\" | \"entries\"> & { meta: { temporaryUuid: string; }; entries: ", { "pluginId": "@kbn/securitysolution-list-utils", "scope": "common", @@ -3363,7 +3363,7 @@ "label": "ExceptionListItemBuilderSchema", "description": [], "signature": [ - "Omit<{ _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }, \"entries\"> & { entries: ", + "Omit<{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }, \"entries\"> & { entries: ", { "pluginId": "@kbn/securitysolution-list-utils", "scope": "common", diff --git a/api_docs/kbn_securitysolution_list_utils.mdx b/api_docs/kbn_securitysolution_list_utils.mdx index 935139d5e2871..39b7d58043270 100644 --- a/api_docs/kbn_securitysolution_list_utils.mdx +++ b/api_docs/kbn_securitysolution_list_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-utils title: "@kbn/securitysolution-list-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-list-utils plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_rules.mdx b/api_docs/kbn_securitysolution_rules.mdx index 8063a4d5dd5fa..e0a298ed33ecc 100644 --- a/api_docs/kbn_securitysolution_rules.mdx +++ b/api_docs/kbn_securitysolution_rules.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-rules title: "@kbn/securitysolution-rules" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-rules plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-rules'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_t_grid.mdx b/api_docs/kbn_securitysolution_t_grid.mdx index 6b5ef155d35b4..269196aeeda43 100644 --- a/api_docs/kbn_securitysolution_t_grid.mdx +++ b/api_docs/kbn_securitysolution_t_grid.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-t-grid title: "@kbn/securitysolution-t-grid" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-t-grid plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-t-grid'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_utils.mdx b/api_docs/kbn_securitysolution_utils.mdx index d9c6d570aa91b..f89634ac45a1b 100644 --- a/api_docs/kbn_securitysolution_utils.mdx +++ b/api_docs/kbn_securitysolution_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-utils title: "@kbn/securitysolution-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-utils plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_server_http_tools.mdx b/api_docs/kbn_server_http_tools.mdx index 5947022a02051..b7177420222a4 100644 --- a/api_docs/kbn_server_http_tools.mdx +++ b/api_docs/kbn_server_http_tools.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-server-http-tools title: "@kbn/server-http-tools" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/server-http-tools plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/server-http-tools'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_server_route_repository.mdx b/api_docs/kbn_server_route_repository.mdx index 59f1273b9499f..b4ded054b09ea 100644 --- a/api_docs/kbn_server_route_repository.mdx +++ b/api_docs/kbn_server_route_repository.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-server-route-repository title: "@kbn/server-route-repository" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/server-route-repository plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/server-route-repository'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_button_exit_full_screen.devdocs.json b/api_docs/kbn_shared_ux_button_exit_full_screen.devdocs.json new file mode 100644 index 0000000000000..bec75a657ccc1 --- /dev/null +++ b/api_docs/kbn_shared_ux_button_exit_full_screen.devdocs.json @@ -0,0 +1,242 @@ +{ + "id": "@kbn/shared-ux-button-exit-full-screen", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/shared-ux-button-exit-full-screen", + "id": "def-common.ExitFullScreenButton", + "type": "Function", + "tags": [], + "label": "ExitFullScreenButton", + "description": [ + "\nA component that can be used to exit full screen mode in Kibana. Requires a Provider for\nrelevant services." + ], + "signature": [ + "React.ForwardRefExoticComponent<", + "Props", + " & React.RefAttributes<{}>>" + ], + "path": "packages/shared-ux/button/exit_full_screen/src/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-button-exit-full-screen", + "id": "def-common.ExitFullScreenButton.$1", + "type": "Uncategorized", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-button-exit-full-screen", + "id": "def-common.ExitFullScreenButtonComponent", + "type": "Function", + "tags": [], + "label": "ExitFullScreenButtonComponent", + "description": [ + "\nA pure component that resembles a button to exit full screen mode." + ], + "signature": [ + "React.ForwardRefExoticComponent<", + "Props", + " & React.RefAttributes<{}>>" + ], + "path": "packages/shared-ux/button/exit_full_screen/src/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-button-exit-full-screen", + "id": "def-common.ExitFullScreenButtonComponent.$1", + "type": "Uncategorized", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-button-exit-full-screen", + "id": "def-common.ExitFullScreenButtonKibanaProvider", + "type": "Function", + "tags": [], + "label": "ExitFullScreenButtonKibanaProvider", + "description": [ + "\nKibana-specific Provider that maps to known dependency types." + ], + "signature": [ + "({ children, ...services }: React.PropsWithChildren<", + "KibanaServices", + ">) => JSX.Element" + ], + "path": "packages/shared-ux/button/exit_full_screen/src/services.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-button-exit-full-screen", + "id": "def-common.ExitFullScreenButtonKibanaProvider.$1", + "type": "CompoundType", + "tags": [], + "label": "{\n children,\n ...services\n}", + "description": [], + "signature": [ + "React.PropsWithChildren<", + "KibanaServices", + ">" + ], + "path": "packages/shared-ux/button/exit_full_screen/src/services.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-button-exit-full-screen", + "id": "def-common.ExitFullScreenButtonProvider", + "type": "Function", + "tags": [], + "label": "ExitFullScreenButtonProvider", + "description": [ + "\nAbstract external service Provider." + ], + "signature": [ + "({ children, ...services }: React.PropsWithChildren<", + "Services", + ">) => JSX.Element" + ], + "path": "packages/shared-ux/button/exit_full_screen/src/services.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-button-exit-full-screen", + "id": "def-common.ExitFullScreenButtonProvider.$1", + "type": "CompoundType", + "tags": [], + "label": "{ children, ...services }", + "description": [], + "signature": [ + "React.PropsWithChildren<", + "Services", + ">" + ], + "path": "packages/shared-ux/button/exit_full_screen/src/services.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-button-exit-full-screen", + "id": "def-common.LazyExitFullScreenButton", + "type": "Function", + "tags": [], + "label": "LazyExitFullScreenButton", + "description": [ + "\nLazy-loaded connected component. Must be wrapped in `React.Suspense` and a Provider." + ], + "signature": [ + "React.ExoticComponent<", + "Props", + "> & { readonly _result: ({ onExit, toggleChrome }: ", + "Props", + ") => JSX.Element; }" + ], + "path": "packages/shared-ux/button/exit_full_screen/src/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-button-exit-full-screen", + "id": "def-common.LazyExitFullScreenButton.$1", + "type": "Uncategorized", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-button-exit-full-screen", + "id": "def-common.LazyExitFullScreenButtonComponent", + "type": "Function", + "tags": [], + "label": "LazyExitFullScreenButtonComponent", + "description": [ + "\nLazy-loaded pure component. Must be wrapped in `React.Suspense`." + ], + "signature": [ + "React.ExoticComponent<", + "Props", + "> & { readonly _result: ({ onClick, className }: ", + "Props", + ") => JSX.Element; }" + ], + "path": "packages/shared-ux/button/exit_full_screen/src/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-button-exit-full-screen", + "id": "def-common.LazyExitFullScreenButtonComponent.$1", + "type": "Uncategorized", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_shared_ux_button_exit_full_screen.mdx b/api_docs/kbn_shared_ux_button_exit_full_screen.mdx new file mode 100644 index 0000000000000..16c76cd894f90 --- /dev/null +++ b/api_docs/kbn_shared_ux_button_exit_full_screen.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnSharedUxButtonExitFullScreenPluginApi +slug: /kibana-dev-docs/api/kbn-shared-ux-button-exit-full-screen +title: "@kbn/shared-ux-button-exit-full-screen" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/shared-ux-button-exit-full-screen plugin +date: 2022-04-26 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-button-exit-full-screen'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnSharedUxButtonExitFullScreenObj from './kbn_shared_ux_button_exit_full_screen.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 | 2 | 3 | + +## Common + +### Functions + + diff --git a/api_docs/kbn_shared_ux_components.devdocs.json b/api_docs/kbn_shared_ux_components.devdocs.json index 77f778bb3f118..fd3d022aeaef2 100644 --- a/api_docs/kbn_shared_ux_components.devdocs.json +++ b/api_docs/kbn_shared_ux_components.devdocs.json @@ -54,12 +54,12 @@ }, { "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.ExitFullScreenButton", + "id": "def-common.IconButtonGroup", "type": "Function", "tags": [], - "label": "ExitFullScreenButton", + "label": "IconButtonGroup", "description": [ - "\nA `ExitFullScreenButton` component that is wrapped by the `withSuspense` HOC. This component can\nbe used directly by consumers and will load the `LazyExitFullScreenButton` component lazily with\na predefined fallback and error boundary." + "\nThe IconButtonGroup component that is wrapped by the `withSuspence` HOC." ], "signature": [ "React.ForwardRefExoticComponent<", @@ -72,7 +72,7 @@ "children": [ { "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.ExitFullScreenButton.$1", + "id": "def-common.IconButtonGroup.$1", "type": "Uncategorized", "tags": [], "label": "props", @@ -88,17 +88,35 @@ }, { "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.IconButtonGroup", + "id": "def-common.KibanaPageTemplate", "type": "Function", "tags": [], - "label": "IconButtonGroup", + "label": "KibanaPageTemplate", "description": [ - "\nThe IconButtonGroup component that is wrapped by the `withSuspence` HOC." + "\nA `KibanaPageTemplate` component that is wrapped by the `withSuspense` HOC. This component can\nbe used directly by consumers and will load the `KibanaPageTemplateLazy` component lazily with\na predefined fallback and error boundary." ], "signature": [ - "React.ForwardRefExoticComponent<", - "Props", - " & React.RefAttributes<{}>>" + "React.ForwardRefExoticComponent & { template?: \"default\" | \"empty\" | \"centeredBody\" | \"centeredContent\" | undefined; paddingSize?: \"none\" | \"m\" | \"s\" | \"l\" | undefined; pageSideBar?: React.ReactNode; pageSideBarProps?: ", + "EuiPageSideBarProps", + " | undefined; pageHeader?: ", + "EuiPageHeaderProps", + " | undefined; pageBodyProps?: ", + "EuiPageBodyProps", + "<\"main\"> | undefined; pageContentProps?: ", + "EuiPageContentProps", + " | undefined; pageContentBodyProps?: ", + "EuiPageContentBodyProps", + " | undefined; bottomBar?: React.ReactNode; bottomBarProps?: ", + "EuiBottomBarProps", + " | undefined; fullHeight?: boolean | \"noscroll\" | undefined; minHeight?: ", + "MinHeightProperty", + " | undefined; } & { isEmptyState?: boolean | undefined; solutionNav?: ", + "KibanaPageTemplateSolutionNavProps", + " | undefined; noDataConfig?: ", + "NoDataPageProps", + " | undefined; } & React.RefAttributes<{}>>" ], "path": "packages/kbn-shared-ux-components/src/index.ts", "deprecated": false, @@ -106,7 +124,61 @@ "children": [ { "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.IconButtonGroup.$1", + "id": "def-common.KibanaPageTemplate.$1", + "type": "Uncategorized", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-components", + "id": "def-common.KibanaPageTemplateLazy", + "type": "Function", + "tags": [], + "label": "KibanaPageTemplateLazy", + "description": [ + "\nThe lazily loaded `KibanaPageTemplate` component that is wrapped by the `withSuspense` HOC. Consumers should use\n`React.Suspense` or `withSuspense` HOC to load this component." + ], + "signature": [ + "React.ExoticComponent & { template?: \"default\" | \"empty\" | \"centeredBody\" | \"centeredContent\" | undefined; paddingSize?: \"none\" | \"m\" | \"s\" | \"l\" | undefined; pageSideBar?: React.ReactNode; pageSideBarProps?: ", + "EuiPageSideBarProps", + " | undefined; pageHeader?: ", + "EuiPageHeaderProps", + " | undefined; pageBodyProps?: ", + "EuiPageBodyProps", + "<\"main\"> | undefined; pageContentProps?: ", + "EuiPageContentProps", + " | undefined; pageContentBodyProps?: ", + "EuiPageContentBodyProps", + " | undefined; bottomBar?: React.ReactNode; bottomBarProps?: ", + "EuiBottomBarProps", + " | undefined; fullHeight?: boolean | \"noscroll\" | undefined; minHeight?: ", + "MinHeightProperty", + " | undefined; } & { isEmptyState?: boolean | undefined; solutionNav?: ", + "KibanaPageTemplateSolutionNavProps", + " | undefined; noDataConfig?: ", + "NoDataPageProps", + " | undefined; } & { children?: React.ReactNode; }> & { readonly _result: React.FunctionComponent<", + "KibanaPageTemplateProps", + ">; }" + ], + "path": "packages/kbn-shared-ux-components/src/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-components", + "id": "def-common.KibanaPageTemplateLazy.$1", "type": "Uncategorized", "tags": [], "label": "props", @@ -280,42 +352,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.LazyExitFullScreenButton", - "type": "Function", - "tags": [], - "label": "LazyExitFullScreenButton", - "description": [ - "\nThe Lazily-loaded `ExitFullScreenButton` component. Consumers should use `React.Suspennse` or the\n`withSuspense` HOC to load this component." - ], - "signature": [ - "React.ExoticComponent<", - "Props", - "> & { readonly _result: ({ onExit, toggleChrome }: ", - "Props", - ") => JSX.Element; }" - ], - "path": "packages/kbn-shared-ux-components/src/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.LazyExitFullScreenButton.$1", - "type": "Uncategorized", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "P" - ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "@kbn/shared-ux-components", "id": "def-common.LazyIconButtonGroup", @@ -323,7 +359,7 @@ "tags": [], "label": "LazyIconButtonGroup", "description": [ - "\nThe Lazily-loaded `IconButtonGroup` component. Consumers should use `React.Suspennse` or the\n`withSuspense` HOC to load this component." + "\nThe Lazily-loaded `IconButtonGroup` component. Consumers should use `React.Suspense` or the\n`withSuspense` HOC to load this component." ], "signature": [ "React.ExoticComponent<", @@ -359,7 +395,7 @@ "tags": [], "label": "LazyNoDataViews", "description": [ - "\nThe Lazily-loaded `NoDataViews` component. Consumers should use `React.Suspennse` or the\n`withSuspense` HOC to load this component." + "\nThe Lazily-loaded `NoDataViews` component. Consumers should use `React.Suspense` or the\n`withSuspense` HOC to load this component." ], "signature": [ "React.ExoticComponent<", @@ -395,7 +431,7 @@ "tags": [], "label": "LazyNoDataViewsComponent", "description": [ - "\nA pure `NoDataViews` component, with no services hooks. Consumers should use `React.Suspennse` or the\n`withSuspense` HOC to load this component." + "\nA pure `NoDataViews` component, with no services hooks. Consumers should use `React.Suspense` or the\n`withSuspense` HOC to load this component." ], "signature": [ "React.ExoticComponent<", @@ -434,7 +470,7 @@ "signature": [ "React.ExoticComponent<", "Props", - "> & { readonly _result: ({ label, ...rest }: ", + "> & { readonly _result: ({ label, iconSide, ...rest }: ", "Props", ") => JSX.Element; }" ], @@ -536,7 +572,7 @@ "signature": [ "React.ExoticComponent & { ref?: React.RefObject | ((instance: HTMLDivElement | null) => void) | null | undefined; }> & { readonly _result: React.FC<", + " & { children?: React.ReactNode; }, \"children\" | \"color\" | \"className\" | \"title\" | \"onChange\" | \"onKeyDown\" | \"onClick\" | \"key\" | \"id\" | \"css\" | \"security\" | \"defaultValue\" | \"hidden\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"lang\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"currentAppId$\" | \"navigateToUrl\"> & { ref?: React.RefObject | ((instance: HTMLDivElement | null) => void) | null | undefined; }> & { readonly _result: React.FC<", "RedirectAppLinksProps", ">; }" ], @@ -593,6 +629,39 @@ } ], "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-components", + "id": "def-common.ToolbarPopover", + "type": "Function", + "tags": [], + "label": "ToolbarPopover", + "description": [], + "signature": [ + "({ label, iconType, children, iconSide, ...popover }: ", + "Props", + ") => JSX.Element" + ], + "path": "packages/kbn-shared-ux-components/src/toolbar/popovers/popover.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-components", + "id": "def-common.ToolbarPopover.$1", + "type": "CompoundType", + "tags": [], + "label": "{ label, iconType, children, iconSide, ...popover }", + "description": [], + "signature": [ + "Props" + ], + "path": "packages/kbn-shared-ux-components/src/toolbar/popovers/popover.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false } ], "interfaces": [], diff --git a/api_docs/kbn_shared_ux_components.mdx b/api_docs/kbn_shared_ux_components.mdx index f5b118c1b36d2..41704c6d85694 100644 --- a/api_docs/kbn_shared_ux_components.mdx +++ b/api_docs/kbn_shared_ux_components.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-components title: "@kbn/shared-ux-components" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-components plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-components'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 32 | 0 | 4 | 4 | +| 34 | 0 | 6 | 6 | ## Common diff --git a/api_docs/kbn_shared_ux_services.mdx b/api_docs/kbn_shared_ux_services.mdx index e2cb765ac7161..98fc062b43b0b 100644 --- a/api_docs/kbn_shared_ux_services.mdx +++ b/api_docs/kbn_shared_ux_services.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-services title: "@kbn/shared-ux-services" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-services plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-services'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_storybook.mdx b/api_docs/kbn_shared_ux_storybook.mdx index 7643af3cf9f90..2ce78307c21c8 100644 --- a/api_docs/kbn_shared_ux_storybook.mdx +++ b/api_docs/kbn_shared_ux_storybook.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-storybook title: "@kbn/shared-ux-storybook" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-storybook plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-storybook'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_utility.mdx b/api_docs/kbn_shared_ux_utility.mdx index 31ccc6897e4cb..5d8a6344b7906 100644 --- a/api_docs/kbn_shared_ux_utility.mdx +++ b/api_docs/kbn_shared_ux_utility.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-utility title: "@kbn/shared-ux-utility" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-utility plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-utility'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_sort_package_json.devdocs.json b/api_docs/kbn_sort_package_json.devdocs.json new file mode 100644 index 0000000000000..1c3fb56277e17 --- /dev/null +++ b/api_docs/kbn_sort_package_json.devdocs.json @@ -0,0 +1,59 @@ +{ + "id": "@kbn/sort-package-json", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/sort-package-json", + "id": "def-server.sortPackageJson", + "type": "Function", + "tags": [], + "label": "sortPackageJson", + "description": [], + "signature": [ + "(json: string) => string" + ], + "path": "packages/kbn-sort-package-json/src/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/sort-package-json", + "id": "def-server.sortPackageJson.$1", + "type": "string", + "tags": [], + "label": "json", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-sort-package-json/src/index.ts", + "deprecated": 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_sort_package_json.mdx b/api_docs/kbn_sort_package_json.mdx new file mode 100644 index 0000000000000..de6879b4cef66 --- /dev/null +++ b/api_docs/kbn_sort_package_json.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnSortPackageJsonPluginApi +slug: /kibana-dev-docs/api/kbn-sort-package-json +title: "@kbn/sort-package-json" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/sort-package-json plugin +date: 2022-04-26 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/sort-package-json'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnSortPackageJsonObj from './kbn_sort_package_json.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 | 2 | 0 | + +## Server + +### Functions + + diff --git a/api_docs/kbn_std.devdocs.json b/api_docs/kbn_std.devdocs.json index 3c7b5119d2b21..95993490eec8d 100644 --- a/api_docs/kbn_std.devdocs.json +++ b/api_docs/kbn_std.devdocs.json @@ -55,7 +55,7 @@ ], "signature": [ "(iterable: ", - "IterableInput", + "ObservableInput", ", fn: ", "AsyncMapFn", ") => Promise" @@ -73,7 +73,7 @@ "Items to iterate" ], "signature": [ - "IterableInput", + "ObservableInput", "" ], "path": "packages/kbn-std/src/iteration/for_each.ts", @@ -112,7 +112,7 @@ ], "signature": [ "(iterable: ", - "IterableInput", + "ObservableInput", ", limit: number, fn: ", "AsyncMapFn", ") => Promise" @@ -130,7 +130,7 @@ "Items to iterate" ], "signature": [ - "IterableInput", + "ObservableInput", "" ], "path": "packages/kbn-std/src/iteration/for_each.ts", @@ -185,7 +185,7 @@ ], "signature": [ "(iterable: ", - "IterableInput", + "ObservableInput", ", fn: ", "AsyncMapFn", ") => Promise" @@ -203,7 +203,7 @@ "Items to iterate" ], "signature": [ - "IterableInput", + "ObservableInput", "" ], "path": "packages/kbn-std/src/iteration/map.ts", @@ -242,7 +242,7 @@ ], "signature": [ "(iterable: ", - "IterableInput", + "ObservableInput", ", limit: number, fn: ", "AsyncMapFn", ") => Promise" @@ -260,7 +260,7 @@ "Items to iterate" ], "signature": [ - "IterableInput", + "ObservableInput", "" ], "path": "packages/kbn-std/src/iteration/map.ts", @@ -370,40 +370,6 @@ "returnComment": [], "initialIsOpen": false }, - { - "parentPluginId": "@kbn/std", - "id": "def-server.firstValueFrom", - "type": "Function", - "tags": [], - "label": "firstValueFrom", - "description": [], - "signature": [ - "(source: ", - "Observable", - ") => Promise" - ], - "path": "packages/kbn-std/src/rxjs_7.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/std", - "id": "def-server.firstValueFrom.$1", - "type": "Object", - "tags": [], - "label": "source", - "description": [], - "signature": [ - "Observable", - "" - ], - "path": "packages/kbn-std/src/rxjs_7.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, { "parentPluginId": "@kbn/std", "id": "def-server.get", @@ -806,40 +772,6 @@ "returnComment": [], "initialIsOpen": false }, - { - "parentPluginId": "@kbn/std", - "id": "def-server.lastValueFrom", - "type": "Function", - "tags": [], - "label": "lastValueFrom", - "description": [], - "signature": [ - "(source: ", - "Observable", - ") => Promise" - ], - "path": "packages/kbn-std/src/rxjs_7.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/std", - "id": "def-server.lastValueFrom.$1", - "type": "Object", - "tags": [], - "label": "source", - "description": [], - "signature": [ - "Observable", - "" - ], - "path": "packages/kbn-std/src/rxjs_7.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, { "parentPluginId": "@kbn/std", "id": "def-server.map$", @@ -851,7 +783,7 @@ ], "signature": [ "(iterable: ", - "IterableInput", + "ObservableInput", ", fn: ", "AsyncMapFn", ") => ", @@ -871,7 +803,7 @@ "Items to iterate" ], "signature": [ - "IterableInput", + "ObservableInput", "" ], "path": "packages/kbn-std/src/iteration/observable.ts", @@ -941,7 +873,7 @@ ], "signature": [ "(iterable: ", - "IterableInput", + "ObservableInput", ", limit: number, fn: ", "AsyncMapFn", ") => ", @@ -961,7 +893,7 @@ "Items to iterate" ], "signature": [ - "IterableInput", + "ObservableInput", "" ], "path": "packages/kbn-std/src/iteration/observable.ts", diff --git a/api_docs/kbn_std.mdx b/api_docs/kbn_std.mdx index ad1559fa9ea9d..f998a00c60e83 100644 --- a/api_docs/kbn_std.mdx +++ b/api_docs/kbn_std.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-std title: "@kbn/std" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/std plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/std'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 96 | 1 | 63 | 2 | +| 92 | 1 | 59 | 1 | ## Server diff --git a/api_docs/kbn_stdio_dev_helpers.devdocs.json b/api_docs/kbn_stdio_dev_helpers.devdocs.json new file mode 100644 index 0000000000000..478b3ea7c54e8 --- /dev/null +++ b/api_docs/kbn_stdio_dev_helpers.devdocs.json @@ -0,0 +1,104 @@ +{ + "id": "@kbn/stdio-dev-helpers", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/stdio-dev-helpers", + "id": "def-server.observeLines", + "type": "Function", + "tags": [ + "return" + ], + "label": "observeLines", + "description": [ + "\n Creates an Observable from a Readable Stream that:\n - splits data from `readable` into lines\n - completes when `readable` emits \"end\"\n - fails if `readable` emits \"errors\"\n" + ], + "signature": [ + "(readable: ", + "Readable", + ") => ", + "Observable", + "" + ], + "path": "packages/kbn-stdio-dev-helpers/src/observe_lines.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/stdio-dev-helpers", + "id": "def-server.observeLines.$1", + "type": "Object", + "tags": [], + "label": "readable", + "description": [], + "signature": [ + "Readable" + ], + "path": "packages/kbn-stdio-dev-helpers/src/observe_lines.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/stdio-dev-helpers", + "id": "def-server.observeReadable", + "type": "Function", + "tags": [], + "label": "observeReadable", + "description": [ + "\n Produces an Observable from a ReadableSteam that:\n - completes on the first \"end\" event\n - fails on the first \"error\" event" + ], + "signature": [ + "(readable: ", + "Readable", + ") => ", + "Observable", + "" + ], + "path": "packages/kbn-stdio-dev-helpers/src/observe_readable.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/stdio-dev-helpers", + "id": "def-server.observeReadable.$1", + "type": "Object", + "tags": [], + "label": "readable", + "description": [], + "signature": [ + "Readable" + ], + "path": "packages/kbn-stdio-dev-helpers/src/observe_readable.ts", + "deprecated": 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_stdio_dev_helpers.mdx b/api_docs/kbn_stdio_dev_helpers.mdx new file mode 100644 index 0000000000000..0397b21fa5d78 --- /dev/null +++ b/api_docs/kbn_stdio_dev_helpers.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnStdioDevHelpersPluginApi +slug: /kibana-dev-docs/api/kbn-stdio-dev-helpers +title: "@kbn/stdio-dev-helpers" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/stdio-dev-helpers plugin +date: 2022-04-26 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/stdio-dev-helpers'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnStdioDevHelpersObj from './kbn_stdio_dev_helpers.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 4 | 0 | 2 | 0 | + +## Server + +### Functions + + diff --git a/api_docs/kbn_storybook.mdx b/api_docs/kbn_storybook.mdx index 98453e30ef707..c44717161b692 100644 --- a/api_docs/kbn_storybook.mdx +++ b/api_docs/kbn_storybook.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-storybook title: "@kbn/storybook" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/storybook plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/storybook'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_telemetry_tools.mdx b/api_docs/kbn_telemetry_tools.mdx index 0e9beedb79fde..e925254e723ee 100644 --- a/api_docs/kbn_telemetry_tools.mdx +++ b/api_docs/kbn_telemetry_tools.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-telemetry-tools title: "@kbn/telemetry-tools" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/telemetry-tools plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/telemetry-tools'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_test.mdx b/api_docs/kbn_test.mdx index f44a7d8a0b889..5edb2515010a2 100644 --- a/api_docs/kbn_test.mdx +++ b/api_docs/kbn_test.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-test title: "@kbn/test" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/test plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/test'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_test_jest_helpers.mdx b/api_docs/kbn_test_jest_helpers.mdx index 4c9edbd805851..0f711e998f1c7 100644 --- a/api_docs/kbn_test_jest_helpers.mdx +++ b/api_docs/kbn_test_jest_helpers.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-test-jest-helpers title: "@kbn/test-jest-helpers" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/test-jest-helpers plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/test-jest-helpers'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_tooling_log.devdocs.json b/api_docs/kbn_tooling_log.devdocs.json new file mode 100644 index 0000000000000..6442d3feca9f3 --- /dev/null +++ b/api_docs/kbn_tooling_log.devdocs.json @@ -0,0 +1,1251 @@ +{ + "id": "@kbn/tooling-log", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [ + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLog", + "type": "Class", + "tags": [], + "label": "ToolingLog", + "description": [], + "path": "packages/kbn-tooling-log/src/tooling_log.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLog.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "packages/kbn-tooling-log/src/tooling_log.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLog.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "writerConfig", + "description": [], + "signature": [ + { + "pluginId": "@kbn/tooling-log", + "scope": "server", + "docId": "kibKbnToolingLogPluginApi", + "section": "def-server.ToolingLogTextWriterConfig", + "text": "ToolingLogTextWriterConfig" + }, + " | undefined" + ], + "path": "packages/kbn-tooling-log/src/tooling_log.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLog.Unnamed.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/tooling-log", + "scope": "server", + "docId": "kibKbnToolingLogPluginApi", + "section": "def-server.ToolingLogOptions", + "text": "ToolingLogOptions" + }, + " | undefined" + ], + "path": "packages/kbn-tooling-log/src/tooling_log.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLog.getIndent", + "type": "Function", + "tags": [], + "label": "getIndent", + "description": [ + "\nGet the current indentation level of the ToolingLog" + ], + "signature": [ + "() => number" + ], + "path": "packages/kbn-tooling-log/src/tooling_log.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLog.indent", + "type": "Function", + "tags": [], + "label": "indent", + "description": [], + "signature": [ + "{ (delta: number): void; (delta: number, block: () => Promise): Promise; (delta: number, block: () => T): T; }" + ], + "path": "packages/kbn-tooling-log/src/tooling_log.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLog.indent.$1", + "type": "number", + "tags": [], + "label": "delta", + "description": [], + "signature": [ + "number" + ], + "path": "packages/kbn-tooling-log/src/tooling_log.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLog.indent.$2", + "type": "Function", + "tags": [], + "label": "block", + "description": [], + "signature": [ + "(() => T | Promise) | undefined" + ], + "path": "packages/kbn-tooling-log/src/tooling_log.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLog.verbose", + "type": "Function", + "tags": [], + "label": "verbose", + "description": [], + "signature": [ + "(...args: any[]) => void" + ], + "path": "packages/kbn-tooling-log/src/tooling_log.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLog.verbose.$1", + "type": "Array", + "tags": [], + "label": "args", + "description": [], + "signature": [ + "any[]" + ], + "path": "packages/kbn-tooling-log/src/tooling_log.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLog.debug", + "type": "Function", + "tags": [], + "label": "debug", + "description": [], + "signature": [ + "(...args: any[]) => void" + ], + "path": "packages/kbn-tooling-log/src/tooling_log.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLog.debug.$1", + "type": "Array", + "tags": [], + "label": "args", + "description": [], + "signature": [ + "any[]" + ], + "path": "packages/kbn-tooling-log/src/tooling_log.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLog.info", + "type": "Function", + "tags": [], + "label": "info", + "description": [], + "signature": [ + "(...args: any[]) => void" + ], + "path": "packages/kbn-tooling-log/src/tooling_log.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLog.info.$1", + "type": "Array", + "tags": [], + "label": "args", + "description": [], + "signature": [ + "any[]" + ], + "path": "packages/kbn-tooling-log/src/tooling_log.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLog.success", + "type": "Function", + "tags": [], + "label": "success", + "description": [], + "signature": [ + "(...args: any[]) => void" + ], + "path": "packages/kbn-tooling-log/src/tooling_log.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLog.success.$1", + "type": "Array", + "tags": [], + "label": "args", + "description": [], + "signature": [ + "any[]" + ], + "path": "packages/kbn-tooling-log/src/tooling_log.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLog.warning", + "type": "Function", + "tags": [], + "label": "warning", + "description": [], + "signature": [ + "(...args: any[]) => void" + ], + "path": "packages/kbn-tooling-log/src/tooling_log.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLog.warning.$1", + "type": "Array", + "tags": [], + "label": "args", + "description": [], + "signature": [ + "any[]" + ], + "path": "packages/kbn-tooling-log/src/tooling_log.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLog.error", + "type": "Function", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "(error: string | Error) => void" + ], + "path": "packages/kbn-tooling-log/src/tooling_log.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLog.error.$1", + "type": "CompoundType", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "string | Error" + ], + "path": "packages/kbn-tooling-log/src/tooling_log.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLog.write", + "type": "Function", + "tags": [], + "label": "write", + "description": [], + "signature": [ + "(...args: any[]) => void" + ], + "path": "packages/kbn-tooling-log/src/tooling_log.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLog.write.$1", + "type": "Array", + "tags": [], + "label": "args", + "description": [], + "signature": [ + "any[]" + ], + "path": "packages/kbn-tooling-log/src/tooling_log.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLog.getWriters", + "type": "Function", + "tags": [], + "label": "getWriters", + "description": [], + "signature": [ + "() => ", + { + "pluginId": "@kbn/tooling-log", + "scope": "server", + "docId": "kibKbnToolingLogPluginApi", + "section": "def-server.Writer", + "text": "Writer" + }, + "[]" + ], + "path": "packages/kbn-tooling-log/src/tooling_log.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLog.setWriters", + "type": "Function", + "tags": [], + "label": "setWriters", + "description": [], + "signature": [ + "(writers: ", + { + "pluginId": "@kbn/tooling-log", + "scope": "server", + "docId": "kibKbnToolingLogPluginApi", + "section": "def-server.Writer", + "text": "Writer" + }, + "[]) => void" + ], + "path": "packages/kbn-tooling-log/src/tooling_log.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLog.setWriters.$1", + "type": "Array", + "tags": [], + "label": "writers", + "description": [], + "signature": [ + { + "pluginId": "@kbn/tooling-log", + "scope": "server", + "docId": "kibKbnToolingLogPluginApi", + "section": "def-server.Writer", + "text": "Writer" + }, + "[]" + ], + "path": "packages/kbn-tooling-log/src/tooling_log.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLog.getWritten$", + "type": "Function", + "tags": [], + "label": "getWritten$", + "description": [], + "signature": [ + "() => ", + "Observable", + "<", + { + "pluginId": "@kbn/tooling-log", + "scope": "server", + "docId": "kibKbnToolingLogPluginApi", + "section": "def-server.Message", + "text": "Message" + }, + ">" + ], + "path": "packages/kbn-tooling-log/src/tooling_log.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLog.withType", + "type": "Function", + "tags": [], + "label": "withType", + "description": [ + "\nCreate a new ToolingLog which sets a different \"type\", allowing messages to be filtered out by \"source\"" + ], + "signature": [ + "(type: string) => ", + { + "pluginId": "@kbn/tooling-log", + "scope": "server", + "docId": "kibKbnToolingLogPluginApi", + "section": "def-server.ToolingLog", + "text": "ToolingLog" + } + ], + "path": "packages/kbn-tooling-log/src/tooling_log.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLog.withType.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "A string that will be passed along with messages from this logger which can be used to filter messages with `ignoreSources`" + ], + "signature": [ + "string" + ], + "path": "packages/kbn-tooling-log/src/tooling_log.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLogCollectingWriter", + "type": "Class", + "tags": [], + "label": "ToolingLogCollectingWriter", + "description": [], + "signature": [ + { + "pluginId": "@kbn/tooling-log", + "scope": "server", + "docId": "kibKbnToolingLogPluginApi", + "section": "def-server.ToolingLogCollectingWriter", + "text": "ToolingLogCollectingWriter" + }, + " extends ", + { + "pluginId": "@kbn/tooling-log", + "scope": "server", + "docId": "kibKbnToolingLogPluginApi", + "section": "def-server.ToolingLogTextWriter", + "text": "ToolingLogTextWriter" + } + ], + "path": "packages/kbn-tooling-log/src/tooling_log_collecting_writer.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLogCollectingWriter.messages", + "type": "Array", + "tags": [], + "label": "messages", + "description": [], + "signature": [ + "string[]" + ], + "path": "packages/kbn-tooling-log/src/tooling_log_collecting_writer.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLogCollectingWriter.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "packages/kbn-tooling-log/src/tooling_log_collecting_writer.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLogCollectingWriter.Unnamed.$1", + "type": "CompoundType", + "tags": [], + "label": "level", + "description": [], + "signature": [ + "\"error\" | \"success\" | \"warning\" | \"info\" | \"debug\" | \"silent\" | \"verbose\"" + ], + "path": "packages/kbn-tooling-log/src/tooling_log_collecting_writer.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLogCollectingWriter.write", + "type": "Function", + "tags": [], + "label": "write", + "description": [ + "\nCalled by ToolingLog, extends messages with the source if message includes one." + ], + "signature": [ + "(msg: ", + { + "pluginId": "@kbn/tooling-log", + "scope": "server", + "docId": "kibKbnToolingLogPluginApi", + "section": "def-server.Message", + "text": "Message" + }, + ") => boolean" + ], + "path": "packages/kbn-tooling-log/src/tooling_log_collecting_writer.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLogCollectingWriter.write.$1", + "type": "Object", + "tags": [], + "label": "msg", + "description": [], + "signature": [ + { + "pluginId": "@kbn/tooling-log", + "scope": "server", + "docId": "kibKbnToolingLogPluginApi", + "section": "def-server.Message", + "text": "Message" + } + ], + "path": "packages/kbn-tooling-log/src/tooling_log_collecting_writer.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLogTextWriter", + "type": "Class", + "tags": [], + "label": "ToolingLogTextWriter", + "description": [], + "signature": [ + { + "pluginId": "@kbn/tooling-log", + "scope": "server", + "docId": "kibKbnToolingLogPluginApi", + "section": "def-server.ToolingLogTextWriter", + "text": "ToolingLogTextWriter" + }, + " implements ", + { + "pluginId": "@kbn/tooling-log", + "scope": "server", + "docId": "kibKbnToolingLogPluginApi", + "section": "def-server.Writer", + "text": "Writer" + } + ], + "path": "packages/kbn-tooling-log/src/tooling_log_text_writer.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLogTextWriter.level", + "type": "Object", + "tags": [], + "label": "level", + "description": [], + "signature": [ + "{ name: \"error\" | \"success\" | \"warning\" | \"info\" | \"debug\" | \"silent\" | \"verbose\"; flags: { error: boolean; success: boolean; warning: boolean; info: boolean; debug: boolean; silent: boolean; verbose: boolean; }; }" + ], + "path": "packages/kbn-tooling-log/src/tooling_log_text_writer.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLogTextWriter.writeTo", + "type": "Object", + "tags": [], + "label": "writeTo", + "description": [], + "signature": [ + "{ write(msg: string): void; }" + ], + "path": "packages/kbn-tooling-log/src/tooling_log_text_writer.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLogTextWriter.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "packages/kbn-tooling-log/src/tooling_log_text_writer.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLogTextWriter.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "config", + "description": [], + "signature": [ + { + "pluginId": "@kbn/tooling-log", + "scope": "server", + "docId": "kibKbnToolingLogPluginApi", + "section": "def-server.ToolingLogTextWriterConfig", + "text": "ToolingLogTextWriterConfig" + } + ], + "path": "packages/kbn-tooling-log/src/tooling_log_text_writer.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLogTextWriter.write", + "type": "Function", + "tags": [], + "label": "write", + "description": [], + "signature": [ + "(msg: ", + { + "pluginId": "@kbn/tooling-log", + "scope": "server", + "docId": "kibKbnToolingLogPluginApi", + "section": "def-server.Message", + "text": "Message" + }, + ") => boolean" + ], + "path": "packages/kbn-tooling-log/src/tooling_log_text_writer.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLogTextWriter.write.$1", + "type": "Object", + "tags": [], + "label": "msg", + "description": [], + "signature": [ + { + "pluginId": "@kbn/tooling-log", + "scope": "server", + "docId": "kibKbnToolingLogPluginApi", + "section": "def-server.Message", + "text": "Message" + } + ], + "path": "packages/kbn-tooling-log/src/tooling_log_text_writer.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLogTextWriter.write", + "type": "Function", + "tags": [], + "label": "write", + "description": [], + "signature": [ + "(writeTo: { write(msg: string): void; }, prefix: string, msg: ", + { + "pluginId": "@kbn/tooling-log", + "scope": "server", + "docId": "kibKbnToolingLogPluginApi", + "section": "def-server.Message", + "text": "Message" + }, + ") => void" + ], + "path": "packages/kbn-tooling-log/src/tooling_log_text_writer.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLogTextWriter.write.$1", + "type": "Object", + "tags": [], + "label": "writeTo", + "description": [], + "signature": [ + "{ write(msg: string): void; }" + ], + "path": "packages/kbn-tooling-log/src/tooling_log_text_writer.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLogTextWriter.write.$2", + "type": "string", + "tags": [], + "label": "prefix", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-tooling-log/src/tooling_log_text_writer.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLogTextWriter.write.$3", + "type": "Object", + "tags": [], + "label": "msg", + "description": [], + "signature": [ + { + "pluginId": "@kbn/tooling-log", + "scope": "server", + "docId": "kibKbnToolingLogPluginApi", + "section": "def-server.Message", + "text": "Message" + } + ], + "path": "packages/kbn-tooling-log/src/tooling_log_text_writer.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [ + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.getLogLevelFlagsHelp", + "type": "Function", + "tags": [], + "label": "getLogLevelFlagsHelp", + "description": [], + "signature": [ + "(defaultLogLevel: string) => string" + ], + "path": "packages/kbn-tooling-log/src/log_levels.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.getLogLevelFlagsHelp.$1", + "type": "string", + "tags": [], + "label": "defaultLogLevel", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-tooling-log/src/log_levels.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.parseLogLevel", + "type": "Function", + "tags": [], + "label": "parseLogLevel", + "description": [], + "signature": [ + "(name: \"error\" | \"success\" | \"warning\" | \"info\" | \"debug\" | \"silent\" | \"verbose\") => { name: \"error\" | \"success\" | \"warning\" | \"info\" | \"debug\" | \"silent\" | \"verbose\"; flags: { error: boolean; success: boolean; warning: boolean; info: boolean; debug: boolean; silent: boolean; verbose: boolean; }; }" + ], + "path": "packages/kbn-tooling-log/src/log_levels.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.parseLogLevel.$1", + "type": "CompoundType", + "tags": [], + "label": "name", + "description": [], + "signature": [ + "\"error\" | \"success\" | \"warning\" | \"info\" | \"debug\" | \"silent\" | \"verbose\"" + ], + "path": "packages/kbn-tooling-log/src/log_levels.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.pickLevelFromFlags", + "type": "Function", + "tags": [], + "label": "pickLevelFromFlags", + "description": [], + "signature": [ + "(flags: Record, options: { default?: \"error\" | \"success\" | \"warning\" | \"info\" | \"debug\" | \"silent\" | \"verbose\" | undefined; }) => \"error\" | \"success\" | \"warning\" | \"info\" | \"debug\" | \"silent\" | \"verbose\"" + ], + "path": "packages/kbn-tooling-log/src/log_levels.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.pickLevelFromFlags.$1", + "type": "Object", + "tags": [], + "label": "flags", + "description": [], + "signature": [ + "Record" + ], + "path": "packages/kbn-tooling-log/src/log_levels.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.pickLevelFromFlags.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "path": "packages/kbn-tooling-log/src/log_levels.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.pickLevelFromFlags.$2.default", + "type": "CompoundType", + "tags": [], + "label": "default", + "description": [], + "signature": [ + "\"error\" | \"success\" | \"warning\" | \"info\" | \"debug\" | \"silent\" | \"verbose\" | undefined" + ], + "path": "packages/kbn-tooling-log/src/log_levels.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.Message", + "type": "Interface", + "tags": [], + "label": "Message", + "description": [ + "\nThe object shape passed to ToolingLog writers each time the log is used." + ], + "path": "packages/kbn-tooling-log/src/message.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.Message.type", + "type": "CompoundType", + "tags": [], + "label": "type", + "description": [ + "level/type of message" + ], + "signature": [ + "\"error\" | \"success\" | \"warning\" | \"write\" | \"info\" | \"debug\" | \"verbose\"" + ], + "path": "packages/kbn-tooling-log/src/message.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.Message.indent", + "type": "number", + "tags": [], + "label": "indent", + "description": [ + "indentation intended when message written to a text log" + ], + "path": "packages/kbn-tooling-log/src/message.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.Message.source", + "type": "string", + "tags": [], + "label": "source", + "description": [ + "type of logger this message came from" + ], + "signature": [ + "string | undefined" + ], + "path": "packages/kbn-tooling-log/src/message.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.Message.args", + "type": "Array", + "tags": [], + "label": "args", + "description": [ + "args passed to the logging method" + ], + "signature": [ + "any[]" + ], + "path": "packages/kbn-tooling-log/src/message.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLogOptions", + "type": "Interface", + "tags": [], + "label": "ToolingLogOptions", + "description": [], + "path": "packages/kbn-tooling-log/src/tooling_log.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLogOptions.type", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "\ntype name for this logger, will be assigned to the \"source\"\nproperties of messages produced by this logger" + ], + "signature": [ + "string | undefined" + ], + "path": "packages/kbn-tooling-log/src/tooling_log.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLogOptions.parent", + "type": "Object", + "tags": [], + "label": "parent", + "description": [ + "\nparent ToolingLog. When a ToolingLog has a parent they will both\nshare indent and writers state. Changing the indent width or\nwriters on either log will update the other too." + ], + "signature": [ + { + "pluginId": "@kbn/tooling-log", + "scope": "server", + "docId": "kibKbnToolingLogPluginApi", + "section": "def-server.ToolingLog", + "text": "ToolingLog" + }, + " | undefined" + ], + "path": "packages/kbn-tooling-log/src/tooling_log.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLogTextWriterConfig", + "type": "Interface", + "tags": [], + "label": "ToolingLogTextWriterConfig", + "description": [], + "path": "packages/kbn-tooling-log/src/tooling_log_text_writer.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLogTextWriterConfig.level", + "type": "CompoundType", + "tags": [], + "label": "level", + "description": [ + "\nLog level, messages below this level will be ignored" + ], + "signature": [ + "\"error\" | \"success\" | \"warning\" | \"info\" | \"debug\" | \"silent\" | \"verbose\"" + ], + "path": "packages/kbn-tooling-log/src/tooling_log_text_writer.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLogTextWriterConfig.ignoreSources", + "type": "Array", + "tags": [], + "label": "ignoreSources", + "description": [ + "\nList of message sources/ToolingLog types which will be ignored. Create\na logger with `ToolingLog#withType()` to create messages with a specific\nsource. Ignored messages will be dropped without writing." + ], + "signature": [ + "string[] | undefined" + ], + "path": "packages/kbn-tooling-log/src/tooling_log_text_writer.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ToolingLogTextWriterConfig.writeTo", + "type": "Object", + "tags": [], + "label": "writeTo", + "description": [ + "\nTarget which will receive formatted message lines, a common value for `writeTo`\nis process.stdout" + ], + "signature": [ + "{ write(s: string): void; }" + ], + "path": "packages/kbn-tooling-log/src/tooling_log_text_writer.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.Writer", + "type": "Interface", + "tags": [], + "label": "Writer", + "description": [ + "\nAn object which received ToolingLog `Messages` and sends them to\nsome interface for collecting logs like stdio, or a file" + ], + "path": "packages/kbn-tooling-log/src/writer.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.Writer.write", + "type": "Function", + "tags": [], + "label": "write", + "description": [ + "\nCalled with every log message, should return true if the message\nwas written and false if it was ignored." + ], + "signature": [ + "(msg: ", + { + "pluginId": "@kbn/tooling-log", + "scope": "server", + "docId": "kibKbnToolingLogPluginApi", + "section": "def-server.Message", + "text": "Message" + }, + ") => boolean" + ], + "path": "packages/kbn-tooling-log/src/writer.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.Writer.write.$1", + "type": "Object", + "tags": [], + "label": "msg", + "description": [ + "The log message to write" + ], + "signature": [ + { + "pluginId": "@kbn/tooling-log", + "scope": "server", + "docId": "kibKbnToolingLogPluginApi", + "section": "def-server.Message", + "text": "Message" + } + ], + "path": "packages/kbn-tooling-log/src/writer.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.DEFAULT_LOG_LEVEL", + "type": "string", + "tags": [], + "label": "DEFAULT_LOG_LEVEL", + "description": [], + "signature": [ + "\"info\"" + ], + "path": "packages/kbn-tooling-log/src/log_levels.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.LOG_LEVEL_FLAGS", + "type": "Array", + "tags": [], + "label": "LOG_LEVEL_FLAGS", + "description": [], + "signature": [ + "{ name: string; help: string; }[]" + ], + "path": "packages/kbn-tooling-log/src/log_levels.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.LogLevel", + "type": "Type", + "tags": [], + "label": "LogLevel", + "description": [], + "signature": [ + "\"error\" | \"success\" | \"warning\" | \"info\" | \"debug\" | \"silent\" | \"verbose\"" + ], + "path": "packages/kbn-tooling-log/src/log_levels.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/tooling-log", + "id": "def-server.ParsedLogLevel", + "type": "Type", + "tags": [], + "label": "ParsedLogLevel", + "description": [], + "signature": [ + "{ name: \"error\" | \"success\" | \"warning\" | \"info\" | \"debug\" | \"silent\" | \"verbose\"; flags: { error: boolean; success: boolean; warning: boolean; info: boolean; debug: boolean; silent: boolean; verbose: boolean; }; }" + ], + "path": "packages/kbn-tooling-log/src/log_levels.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_tooling_log.mdx b/api_docs/kbn_tooling_log.mdx new file mode 100644 index 0000000000000..7dcb0b67415cb --- /dev/null +++ b/api_docs/kbn_tooling_log.mdx @@ -0,0 +1,36 @@ +--- +id: kibKbnToolingLogPluginApi +slug: /kibana-dev-docs/api/kbn-tooling-log +title: "@kbn/tooling-log" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/tooling-log plugin +date: 2022-04-26 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/tooling-log'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnToolingLogObj from './kbn_tooling_log.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 72 | 0 | 55 | 0 | + +## Server + +### Functions + + +### Classes + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/kbn_type_summarizer.mdx b/api_docs/kbn_type_summarizer.mdx index 385d3c755dfe2..c715205758b5e 100644 --- a/api_docs/kbn_type_summarizer.mdx +++ b/api_docs/kbn_type_summarizer.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-type-summarizer title: "@kbn/type-summarizer" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/type-summarizer plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/type-summarizer'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_typed_react_router_config.mdx b/api_docs/kbn_typed_react_router_config.mdx index 02f14ac7a325b..66d08cdf52378 100644 --- a/api_docs/kbn_typed_react_router_config.mdx +++ b/api_docs/kbn_typed_react_router_config.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-typed-react-router-config title: "@kbn/typed-react-router-config" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/typed-react-router-config plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/typed-react-router-config'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_ui_theme.devdocs.json b/api_docs/kbn_ui_theme.devdocs.json index c4272d206e8bd..bcfd5d506638a 100644 --- a/api_docs/kbn_ui_theme.devdocs.json +++ b/api_docs/kbn_ui_theme.devdocs.json @@ -52,7 +52,7 @@ "label": "Theme", "description": [], "signature": [ - "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; avatarSizing: { s: { size: string; 'font-size': string; }; m: { size: string; 'font-size': string; }; l: { size: string; 'font-size': string; }; xl: { size: string; 'font-size': string; }; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; success: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; ruleMargins: { marginXSmall: string; marginSmall: string; marginMedium: string; marginLarge: string; marginXLarge: string; marginXXLarge: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiLinkColors: { subdued: string; primary: string; success: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; euiLoadingSpinnerSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; spacerSizes: { xs: string; s: string; m: string; l: string; xl: string; xxl: string; }; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTextColors: { default: string; subdued: string; success: string; accent: string; warning: string; danger: string; ghost: string; inherit: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; subdued: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiShadowColorLarge: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" + "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; success: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; ruleMargins: { marginXSmall: string; marginSmall: string; marginMedium: string; marginLarge: string; marginXLarge: string; marginXXLarge: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiLinkColors: { subdued: string; primary: string; success: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; euiLoadingSpinnerSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; spacerSizes: { xs: string; s: string; m: string; l: string; xl: string; xxl: string; }; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTextColors: { default: string; subdued: string; success: string; accent: string; warning: string; danger: string; ghost: string; inherit: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; subdued: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiShadowColorLarge: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" ], "path": "packages/kbn-ui-theme/src/theme.ts", "deprecated": false, @@ -82,7 +82,7 @@ "label": "euiDarkVars", "description": [], "signature": [ - "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; avatarSizing: { s: { size: string; 'font-size': string; }; m: { size: string; 'font-size': string; }; l: { size: string; 'font-size': string; }; xl: { size: string; 'font-size': string; }; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; success: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; ruleMargins: { marginXSmall: string; marginSmall: string; marginMedium: string; marginLarge: string; marginXLarge: string; marginXXLarge: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiLinkColors: { subdued: string; primary: string; success: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; euiLoadingSpinnerSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; spacerSizes: { xs: string; s: string; m: string; l: string; xl: string; xxl: string; }; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTextColors: { default: string; subdued: string; success: string; accent: string; warning: string; danger: string; ghost: string; inherit: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; subdued: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiShadowColorLarge: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" + "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; success: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; ruleMargins: { marginXSmall: string; marginSmall: string; marginMedium: string; marginLarge: string; marginXLarge: string; marginXXLarge: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiLinkColors: { subdued: string; primary: string; success: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; euiLoadingSpinnerSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; spacerSizes: { xs: string; s: string; m: string; l: string; xl: string; xxl: string; }; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTextColors: { default: string; subdued: string; success: string; accent: string; warning: string; danger: string; ghost: string; inherit: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; subdued: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiShadowColorLarge: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" ], "path": "packages/kbn-ui-theme/src/theme.ts", "deprecated": false, @@ -96,7 +96,7 @@ "label": "euiLightVars", "description": [], "signature": [ - "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; avatarSizing: { s: { size: string; 'font-size': string; }; m: { size: string; 'font-size': string; }; l: { size: string; 'font-size': string; }; xl: { size: string; 'font-size': string; }; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; success: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; ruleMargins: { marginXSmall: string; marginSmall: string; marginMedium: string; marginLarge: string; marginXLarge: string; marginXXLarge: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiLinkColors: { subdued: string; primary: string; success: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; euiLoadingSpinnerSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; spacerSizes: { xs: string; s: string; m: string; l: string; xl: string; xxl: string; }; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTextColors: { default: string; subdued: string; success: string; accent: string; warning: string; danger: string; ghost: string; inherit: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; subdued: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiShadowColorLarge: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" + "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; success: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; ruleMargins: { marginXSmall: string; marginSmall: string; marginMedium: string; marginLarge: string; marginXLarge: string; marginXXLarge: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiLinkColors: { subdued: string; primary: string; success: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; euiLoadingSpinnerSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; spacerSizes: { xs: string; s: string; m: string; l: string; xl: string; xxl: string; }; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTextColors: { default: string; subdued: string; success: string; accent: string; warning: string; danger: string; ghost: string; inherit: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; subdued: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiShadowColorLarge: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" ], "path": "packages/kbn-ui-theme/src/theme.ts", "deprecated": false, @@ -112,7 +112,7 @@ "\nEUI Theme vars that automatically adjust to light/dark theme" ], "signature": [ - "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; avatarSizing: { s: { size: string; 'font-size': string; }; m: { size: string; 'font-size': string; }; l: { size: string; 'font-size': string; }; xl: { size: string; 'font-size': string; }; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; success: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; ruleMargins: { marginXSmall: string; marginSmall: string; marginMedium: string; marginLarge: string; marginXLarge: string; marginXXLarge: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiLinkColors: { subdued: string; primary: string; success: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; euiLoadingSpinnerSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; spacerSizes: { xs: string; s: string; m: string; l: string; xl: string; xxl: string; }; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTextColors: { default: string; subdued: string; success: string; accent: string; warning: string; danger: string; ghost: string; inherit: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; subdued: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiShadowColorLarge: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" + "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; success: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; ruleMargins: { marginXSmall: string; marginSmall: string; marginMedium: string; marginLarge: string; marginXLarge: string; marginXXLarge: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiLinkColors: { subdued: string; primary: string; success: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; euiLoadingSpinnerSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; spacerSizes: { xs: string; s: string; m: string; l: string; xl: string; xxl: string; }; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTextColors: { default: string; subdued: string; success: string; accent: string; warning: string; danger: string; ghost: string; inherit: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; subdued: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiShadowColorLarge: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" ], "path": "packages/kbn-ui-theme/src/theme.ts", "deprecated": false, diff --git a/api_docs/kbn_ui_theme.mdx b/api_docs/kbn_ui_theme.mdx index 48796dd5266f6..bb34a249143f0 100644 --- a/api_docs/kbn_ui_theme.mdx +++ b/api_docs/kbn_ui_theme.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ui-theme title: "@kbn/ui-theme" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ui-theme plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ui-theme'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_utility_types.devdocs.json b/api_docs/kbn_utility_types.devdocs.json index 2734d6eadc135..bb3eb25102399 100644 --- a/api_docs/kbn_utility_types.devdocs.json +++ b/api_docs/kbn_utility_types.devdocs.json @@ -249,6 +249,22 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "@kbn/utility-types", + "id": "def-server.AwaitedProperties", + "type": "Type", + "tags": [], + "label": "AwaitedProperties", + "description": [ + "\nUnwrap all promise attributes of the given type" + ], + "signature": [ + "{ [K in keyof T]: Awaited; }" + ], + "path": "packages/kbn-utility-types/src/index.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "@kbn/utility-types", "id": "def-server.Class", diff --git a/api_docs/kbn_utility_types.mdx b/api_docs/kbn_utility_types.mdx index f000ebff89f1f..5af644c15e127 100644 --- a/api_docs/kbn_utility_types.mdx +++ b/api_docs/kbn_utility_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-utility-types title: "@kbn/utility-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/utility-types plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/utility-types'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 27 | 0 | 10 | 1 | +| 28 | 0 | 10 | 1 | ## Server diff --git a/api_docs/kbn_utils.mdx b/api_docs/kbn_utils.mdx index 5359a84655647..3ada49f8bdb89 100644 --- a/api_docs/kbn_utils.mdx +++ b/api_docs/kbn_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-utils title: "@kbn/utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/utils plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kibana_overview.mdx b/api_docs/kibana_overview.mdx index e61834056f960..155ccdd4f45b8 100644 --- a/api_docs/kibana_overview.mdx +++ b/api_docs/kibana_overview.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kibanaOverview title: "kibanaOverview" image: https://source.unsplash.com/400x175/?github summary: API docs for the kibanaOverview plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaOverview'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kibana_react.devdocs.json b/api_docs/kibana_react.devdocs.json index fa0be3526203f..36fdcb2139cdf 100644 --- a/api_docs/kibana_react.devdocs.json +++ b/api_docs/kibana_react.devdocs.json @@ -885,7 +885,9 @@ "parentPluginId": "kibanaReact", "id": "def-public.KibanaPageTemplate", "type": "Function", - "tags": [], + "tags": [ + "deprecated" + ], "label": "KibanaPageTemplate", "description": [], "signature": [ @@ -900,7 +902,193 @@ ">) => JSX.Element" ], "path": "src/plugins/kibana_react/public/page_template/page_template.tsx", - "deprecated": false, + "deprecated": true, + "references": [ + { + "plugin": "management", + "path": "src/plugins/management/public/components/management_app/management_app.tsx" + }, + { + "plugin": "management", + "path": "src/plugins/management/public/components/management_app/management_app.tsx" + }, + { + "plugin": "management", + "path": "src/plugins/management/public/components/management_app/management_app.tsx" + }, + { + "plugin": "spaces", + "path": "x-pack/plugins/spaces/public/space_selector/space_selector.tsx" + }, + { + "plugin": "spaces", + "path": "x-pack/plugins/spaces/public/space_selector/space_selector.tsx" + }, + { + "plugin": "spaces", + "path": "x-pack/plugins/spaces/public/space_selector/space_selector.tsx" + }, + { + "plugin": "observability", + "path": "x-pack/plugins/observability/public/components/shared/page_template/page_template.tsx" + }, + { + "plugin": "observability", + "path": "x-pack/plugins/observability/public/components/shared/page_template/page_template.tsx" + }, + { + "plugin": "observability", + "path": "x-pack/plugins/observability/public/components/shared/page_template/page_template.tsx" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/public/application/components/ml_page/ml_page.tsx" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/public/application/components/ml_page/ml_page.tsx" + }, + { + "plugin": "ml", + "path": "x-pack/plugins/ml/public/application/components/ml_page/ml_page.tsx" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/public/components/home/home.component.tsx" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/public/components/home/home.component.tsx" + }, + { + "plugin": "canvas", + "path": "x-pack/plugins/canvas/public/components/home/home.component.tsx" + }, + { + "plugin": "cloudSecurityPosture", + "path": "x-pack/plugins/cloud_security_posture/public/components/csp_page_template.tsx" + }, + { + "plugin": "cloudSecurityPosture", + "path": "x-pack/plugins/cloud_security_posture/public/components/csp_page_template.tsx" + }, + { + "plugin": "cloudSecurityPosture", + "path": "x-pack/plugins/cloud_security_posture/public/components/csp_page_template.tsx" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/public/applications/shared/version_mismatch/version_mismatch_page.tsx" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/public/applications/shared/version_mismatch/version_mismatch_page.tsx" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/public/applications/shared/version_mismatch/version_mismatch_page.tsx" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/public/applications/enterprise_search_overview/components/error_connecting/error_connecting.tsx" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/public/applications/enterprise_search_overview/components/error_connecting/error_connecting.tsx" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/public/applications/enterprise_search_overview/components/error_connecting/error_connecting.tsx" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/public/applications/enterprise_search_overview/components/product_selector/product_selector.tsx" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/public/applications/enterprise_search_overview/components/product_selector/product_selector.tsx" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/public/applications/enterprise_search_overview/components/product_selector/product_selector.tsx" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/public/applications/shared/layout/page_template.tsx" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/public/applications/shared/layout/page_template.tsx" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/public/applications/shared/layout/page_template.tsx" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/error_connecting/error_connecting.tsx" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/error_connecting/error_connecting.tsx" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/public/applications/enterprise_search_content/components/error_connecting/error_connecting.tsx" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/public/applications/app_search/components/error_connecting/error_connecting.tsx" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/public/applications/app_search/components/error_connecting/error_connecting.tsx" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/public/applications/app_search/components/error_connecting/error_connecting.tsx" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/public/applications/workplace_search/views/error_state/error_state.tsx" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/public/applications/workplace_search/views/error_state/error_state.tsx" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/public/applications/workplace_search/views/error_state/error_state.tsx" + }, + { + "plugin": "osquery", + "path": "x-pack/plugins/osquery/public/components/empty_state.tsx" + }, + { + "plugin": "osquery", + "path": "x-pack/plugins/osquery/public/components/empty_state.tsx" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/app/home/template_wrapper/index.tsx" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/app/home/template_wrapper/index.tsx" + }, + { + "plugin": "kibanaOverview", + "path": "src/plugins/kibana_overview/public/components/overview/overview.tsx" + }, + { + "plugin": "kibanaOverview", + "path": "src/plugins/kibana_overview/public/components/overview/overview.tsx" + }, + { + "plugin": "kibanaOverview", + "path": "src/plugins/kibana_overview/public/components/overview/overview.tsx" + } + ], "children": [ { "parentPluginId": "kibanaReact", @@ -1689,44 +1877,44 @@ "path": "x-pack/plugins/index_lifecycle_management/public/application/index.tsx" }, { - "plugin": "upgradeAssistant", - "path": "x-pack/plugins/upgrade_assistant/public/shared_imports.ts" + "plugin": "synthetics", + "path": "x-pack/plugins/synthetics/public/lib/alert_types/alert_messages.tsx" }, { - "plugin": "upgradeAssistant", - "path": "x-pack/plugins/upgrade_assistant/public/application/app.tsx" + "plugin": "synthetics", + "path": "x-pack/plugins/synthetics/public/lib/alert_types/alert_messages.tsx" }, { - "plugin": "upgradeAssistant", - "path": "x-pack/plugins/upgrade_assistant/public/application/app.tsx" + "plugin": "synthetics", + "path": "x-pack/plugins/synthetics/public/lib/alert_types/alert_messages.tsx" }, { - "plugin": "upgradeAssistant", - "path": "x-pack/plugins/upgrade_assistant/public/application/app.tsx" + "plugin": "synthetics", + "path": "x-pack/plugins/synthetics/public/apps/uptime_app.tsx" }, { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/lib/alert_types/alert_messages.tsx" + "plugin": "synthetics", + "path": "x-pack/plugins/synthetics/public/apps/uptime_app.tsx" }, { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/lib/alert_types/alert_messages.tsx" + "plugin": "synthetics", + "path": "x-pack/plugins/synthetics/public/apps/uptime_app.tsx" }, { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/lib/alert_types/alert_messages.tsx" + "plugin": "upgradeAssistant", + "path": "x-pack/plugins/upgrade_assistant/public/shared_imports.ts" }, { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/apps/uptime_app.tsx" + "plugin": "upgradeAssistant", + "path": "x-pack/plugins/upgrade_assistant/public/application/app.tsx" }, { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/apps/uptime_app.tsx" + "plugin": "upgradeAssistant", + "path": "x-pack/plugins/upgrade_assistant/public/application/app.tsx" }, { - "plugin": "uptime", - "path": "x-pack/plugins/uptime/public/apps/uptime_app.tsx" + "plugin": "upgradeAssistant", + "path": "x-pack/plugins/upgrade_assistant/public/application/app.tsx" }, { "plugin": "ux", @@ -3370,6 +3558,25 @@ ], "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "deprecated": false + }, + { + "parentPluginId": "kibanaReact", + "id": "def-public.TableListViewProps.application", + "type": "Object", + "tags": [], + "label": "application", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.ApplicationStart", + "text": "ApplicationStart" + } + ], + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "deprecated": false } ], "initialIsOpen": false @@ -3884,7 +4091,9 @@ "parentPluginId": "kibanaReact", "id": "def-public.KibanaPageTemplateProps", "type": "Type", - "tags": [], + "tags": [ + "deprecated" + ], "label": "KibanaPageTemplateProps", "description": [ "\nA thin wrapper around EuiPageTemplate with a few Kibana specific additions" @@ -3919,7 +4128,169 @@ " | undefined; }" ], "path": "src/plugins/kibana_react/public/page_template/page_template.tsx", - "deprecated": false, + "deprecated": true, + "references": [ + { + "plugin": "management", + "path": "src/plugins/management/public/components/management_app/management_app.tsx" + }, + { + "plugin": "management", + "path": "src/plugins/management/public/components/management_app/management_app.tsx" + }, + { + "plugin": "observability", + "path": "x-pack/plugins/observability/public/components/shared/page_template/page_template.tsx" + }, + { + "plugin": "observability", + "path": "x-pack/plugins/observability/public/components/shared/page_template/page_template.tsx" + }, + { + "plugin": "observability", + "path": "x-pack/plugins/observability/public/utils/no_data_config.ts" + }, + { + "plugin": "observability", + "path": "x-pack/plugins/observability/public/utils/no_data_config.ts" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/pages/logs/page_template.tsx" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/pages/logs/page_template.tsx" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/pages/metrics/page_template.tsx" + }, + { + "plugin": "infra", + "path": "x-pack/plugins/infra/public/pages/metrics/page_template.tsx" + }, + { + "plugin": "apm", + "path": "x-pack/plugins/apm/public/components/routing/templates/no_data_config.ts" + }, + { + "plugin": "apm", + "path": "x-pack/plugins/apm/public/components/routing/templates/no_data_config.ts" + }, + { + "plugin": "apm", + "path": "x-pack/plugins/apm/public/components/routing/templates/apm_main_template.tsx" + }, + { + "plugin": "apm", + "path": "x-pack/plugins/apm/public/components/routing/templates/apm_main_template.tsx" + }, + { + "plugin": "apm", + "path": "x-pack/plugins/apm/public/components/routing/templates/service_group_template.tsx" + }, + { + "plugin": "apm", + "path": "x-pack/plugins/apm/public/components/routing/templates/service_group_template.tsx" + }, + { + "plugin": "cloudSecurityPosture", + "path": "x-pack/plugins/cloud_security_posture/public/components/csp_page_template.tsx" + }, + { + "plugin": "cloudSecurityPosture", + "path": "x-pack/plugins/cloud_security_posture/public/components/csp_page_template.tsx" + }, + { + "plugin": "cloudSecurityPosture", + "path": "x-pack/plugins/cloud_security_posture/public/components/csp_page_template.tsx" + }, + { + "plugin": "cloudSecurityPosture", + "path": "x-pack/plugins/cloud_security_posture/public/components/csp_page_template.tsx" + }, + { + "plugin": "cloudSecurityPosture", + "path": "x-pack/plugins/cloud_security_posture/public/components/csp_page_template.tsx" + }, + { + "plugin": "cloudSecurityPosture", + "path": "x-pack/plugins/cloud_security_posture/public/components/csp_page_template.tsx" + }, + { + "plugin": "cloudSecurityPosture", + "path": "x-pack/plugins/cloud_security_posture/public/components/csp_page_template.tsx" + }, + { + "plugin": "cloudSecurityPosture", + "path": "x-pack/plugins/cloud_security_posture/public/components/csp_page_template.tsx" + }, + { + "plugin": "cloudSecurityPosture", + "path": "x-pack/plugins/cloud_security_posture/public/pages/compliance_dashboard/compliance_dashboard.tsx" + }, + { + "plugin": "cloudSecurityPosture", + "path": "x-pack/plugins/cloud_security_posture/public/pages/compliance_dashboard/compliance_dashboard.tsx" + }, + { + "plugin": "cloudSecurityPosture", + "path": "x-pack/plugins/cloud_security_posture/public/pages/rules/index.tsx" + }, + { + "plugin": "cloudSecurityPosture", + "path": "x-pack/plugins/cloud_security_posture/public/pages/rules/index.tsx" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/public/applications/shared/layout/page_template.tsx" + }, + { + "plugin": "enterpriseSearch", + "path": "x-pack/plugins/enterprise_search/public/applications/shared/layout/page_template.tsx" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/components/navigation/use_security_solution_navigation/use_primary_navigation.tsx" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/common/components/navigation/use_security_solution_navigation/use_primary_navigation.tsx" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/app/home/template_wrapper/bottom_bar/index.tsx" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/public/app/home/template_wrapper/bottom_bar/index.tsx" + }, + { + "plugin": "synthetics", + "path": "x-pack/plugins/synthetics/public/apps/use_no_data_config.ts" + }, + { + "plugin": "synthetics", + "path": "x-pack/plugins/synthetics/public/apps/use_no_data_config.ts" + }, + { + "plugin": "ux", + "path": "x-pack/plugins/ux/public/components/app/rum_dashboard/rum_home.tsx" + }, + { + "plugin": "ux", + "path": "x-pack/plugins/ux/public/components/app/rum_dashboard/rum_home.tsx" + }, + { + "plugin": "kibanaOverview", + "path": "src/plugins/kibana_overview/public/components/overview/overview.tsx" + }, + { + "plugin": "kibanaOverview", + "path": "src/plugins/kibana_overview/public/components/overview/overview.tsx" + } + ], "initialIsOpen": false }, { @@ -4333,14 +4704,6 @@ { "plugin": "dashboard", "path": "src/plugins/dashboard/public/plugin.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/connected_components/map_container/map_container.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/connected_components/map_container/map_container.tsx" } ], "initialIsOpen": false @@ -4793,7 +5156,7 @@ "label": "eui", "description": [], "signature": [ - "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; avatarSizing: { s: { size: string; 'font-size': string; }; m: { size: string; 'font-size': string; }; l: { size: string; 'font-size': string; }; xl: { size: string; 'font-size': string; }; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; success: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; ruleMargins: { marginXSmall: string; marginSmall: string; marginMedium: string; marginLarge: string; marginXLarge: string; marginXXLarge: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiLinkColors: { subdued: string; primary: string; success: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; euiLoadingSpinnerSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; spacerSizes: { xs: string; s: string; m: string; l: string; xl: string; xxl: string; }; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTextColors: { default: string; subdued: string; success: string; accent: string; warning: string; danger: string; ghost: string; inherit: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; subdued: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiShadowColorLarge: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" + "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; success: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; ruleMargins: { marginXSmall: string; marginSmall: string; marginMedium: string; marginLarge: string; marginXLarge: string; marginXXLarge: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiLinkColors: { subdued: string; primary: string; success: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; euiLoadingSpinnerSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; spacerSizes: { xs: string; s: string; m: string; l: string; xl: string; xxl: string; }; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTextColors: { default: string; subdued: string; success: string; accent: string; warning: string; danger: string; ghost: string; inherit: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; subdued: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiShadowColorLarge: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" ], "path": "src/plugins/kibana_react/common/eui_styled_components.tsx", "deprecated": false diff --git a/api_docs/kibana_react.mdx b/api_docs/kibana_react.mdx index 60767318538de..3def8e96dfcf8 100644 --- a/api_docs/kibana_react.mdx +++ b/api_docs/kibana_react.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kibanaReact title: "kibanaReact" image: https://source.unsplash.com/400x175/?github summary: API docs for the kibanaReact plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaReact'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 239 | 0 | 203 | 5 | +| 240 | 0 | 204 | 5 | ## Client diff --git a/api_docs/kibana_utils.devdocs.json b/api_docs/kibana_utils.devdocs.json index 18bb3b4a35d4a..ff686632d0f4a 100644 --- a/api_docs/kibana_utils.devdocs.json +++ b/api_docs/kibana_utils.devdocs.json @@ -7606,6 +7606,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -7680,7 +7684,9 @@ "section": "def-server.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; }>" + " | undefined; } | Buffer | ", + "Stream", + ">" ], "path": "src/plugins/kibana_utils/server/report_server_error.ts", "deprecated": false, @@ -7821,6 +7827,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", diff --git a/api_docs/kibana_utils.mdx b/api_docs/kibana_utils.mdx index e049912e4e732..b639f92c9c96c 100644 --- a/api_docs/kibana_utils.mdx +++ b/api_docs/kibana_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kibanaUtils title: "kibanaUtils" image: https://source.unsplash.com/400x175/?github summary: API docs for the kibanaUtils plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaUtils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/lens.devdocs.json b/api_docs/lens.devdocs.json index 53b0ee481dc97..ae98881027a3b 100644 --- a/api_docs/lens.devdocs.json +++ b/api_docs/lens.devdocs.json @@ -335,13 +335,7 @@ "label": "palette", "description": [], "signature": [ - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteOutput", - "text": "PaletteOutput" - }, + "PaletteOutput", "<{ [key: string]: unknown; }>" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", @@ -491,7 +485,7 @@ "section": "def-common.Datatable", "text": "Datatable" }, - "> | undefined) => Record<\"enabled\" | \"disabled\", { kuery: ", + "> | undefined) => Record<\"disabled\" | \"enabled\", { kuery: ", "Query", "[][]; lucene: ", "Query", @@ -1958,13 +1952,7 @@ "label": "palette", "description": [], "signature": [ - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteOutput", - "text": "PaletteOutput" - }, + "PaletteOutput", "<{ [key: string]: unknown; }> | undefined" ], "path": "x-pack/plugins/lens/common/types.ts", @@ -2403,13 +2391,7 @@ "label": "mainPalette", "description": [], "signature": [ - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteOutput", - "text": "PaletteOutput" - }, + "PaletteOutput", "<{ [key: string]: unknown; }> | undefined" ], "path": "x-pack/plugins/lens/public/types.ts", @@ -2615,7 +2597,7 @@ "label": "params", "description": [], "signature": [ - "{ size: number; orderBy: { type: \"alphabetical\"; fallback?: boolean | undefined; } | { type: \"rare\"; maxDocCount: number; } | { type: \"column\"; columnId: string; }; orderDirection: \"asc\" | \"desc\"; otherBucket?: boolean | undefined; missingBucket?: boolean | undefined; secondaryFields?: string[] | undefined; format?: ", + "{ size: number; accuracyMode?: boolean | undefined; orderBy: { type: \"alphabetical\"; fallback?: boolean | undefined; } | { type: \"rare\"; maxDocCount: number; } | { type: \"column\"; columnId: string; }; orderDirection: \"asc\" | \"desc\"; otherBucket?: boolean | undefined; missingBucket?: boolean | undefined; secondaryFields?: string[] | undefined; format?: ", "ValueFormatConfig", " | undefined; parentFormat?: { id: string; } | undefined; }" ], @@ -2708,13 +2690,7 @@ ], "signature": [ "(addNewLayer: () => string, state?: T | undefined, mainPalette?: ", - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteOutput", - "text": "PaletteOutput" - }, + "PaletteOutput", "<{ [key: string]: unknown; }> | undefined) => T" ], "path": "x-pack/plugins/lens/public/types.ts", @@ -2756,13 +2732,7 @@ "label": "mainPalette", "description": [], "signature": [ - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteOutput", - "text": "PaletteOutput" - }, + "PaletteOutput", "<{ [key: string]: unknown; }> | undefined" ], "path": "x-pack/plugins/lens/public/types.ts", @@ -2781,13 +2751,7 @@ "description": [], "signature": [ "((state: T) => ", - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteOutput", - "text": "PaletteOutput" - }, + "PaletteOutput", "<{ [key: string]: unknown; }> | undefined) | undefined" ], "path": "x-pack/plugins/lens/public/types.ts", @@ -3805,15 +3769,9 @@ "label": "toExpression", "description": [], "signature": [ - "(state: T, datasourceLayers: Record, attributes?: Partial<{ title: string; description: string; }> | undefined) => string | ", + "(state: T, datasourceLayers: ", + "DatasourceLayers", + ", attributes?: Partial<{ title: string; description: string; }> | undefined) => string | ", { "pluginId": "expressions", "scope": "common", @@ -3848,15 +3806,7 @@ "label": "datasourceLayers", "description": [], "signature": [ - "Record" + "DatasourceLayers" ], "path": "x-pack/plugins/lens/public/types.ts", "deprecated": false, @@ -3889,15 +3839,9 @@ "\nExpression to render a preview version of the chart in very constrained space.\nIf there is no expression provided, the preview icon is used." ], "signature": [ - "((state: T, datasourceLayers: Record) => string | ", + "((state: T, datasourceLayers: ", + "DatasourceLayers", + ") => string | ", { "pluginId": "expressions", "scope": "common", @@ -3932,15 +3876,7 @@ "label": "datasourceLayers", "description": [], "signature": [ - "Record" + "DatasourceLayers" ], "path": "x-pack/plugins/lens/public/types.ts", "deprecated": false, @@ -3959,15 +3895,9 @@ "\nThe frame will call this function on all visualizations at few stages (pre-build/build error) in order\nto provide more context to the error and show it to the user" ], "signature": [ - "(state: T, datasourceLayers?: Record | undefined) => { shortMessage: string; longMessage: React.ReactNode; }[] | undefined" + "(state: T, datasourceLayers?: ", + "DatasourceLayers", + " | undefined) => { shortMessage: string; longMessage: React.ReactNode; }[] | undefined" ], "path": "x-pack/plugins/lens/public/types.ts", "deprecated": false, @@ -3994,15 +3924,8 @@ "label": "datasourceLayers", "description": [], "signature": [ - "Record | undefined" + "DatasourceLayers", + " | undefined" ], "path": "x-pack/plugins/lens/public/types.ts", "deprecated": false, @@ -4822,13 +4745,7 @@ "label": "palette", "description": [], "signature": [ - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteOutput", - "text": "PaletteOutput" - }, + "PaletteOutput", "<{ [key: string]: unknown; }> | undefined" ], "path": "x-pack/plugins/lens/public/xy_visualization/types.ts", @@ -7445,37 +7362,13 @@ "description": [], "signature": [ "{ columns: { palette?: ", - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteOutput", - "text": "PaletteOutput" - }, + "PaletteOutput", "<", - { - "pluginId": "lens", - "scope": "common", - "docId": "kibLensPluginApi", - "section": "def-common.CustomPaletteParams", - "text": "CustomPaletteParams" - }, + "CustomPaletteParams", "> | undefined; colorMode?: \"none\" | \"text\" | \"cell\" | undefined; }[]; } | { palette?: ", - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteOutput", - "text": "PaletteOutput" - }, + "PaletteOutput", "<", - { - "pluginId": "lens", - "scope": "common", - "docId": "kibLensPluginApi", - "section": "def-common.CustomPaletteParams", - "text": "CustomPaletteParams" - }, + "CustomPaletteParams", "> | undefined; }" ], "path": "x-pack/plugins/lens/server/migrations/types.ts", @@ -7769,203 +7662,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "lens", - "id": "def-common.ColorStop", - "type": "Interface", - "tags": [], - "label": "ColorStop", - "description": [], - "path": "x-pack/plugins/lens/common/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "lens", - "id": "def-common.ColorStop.color", - "type": "string", - "tags": [], - "label": "color", - "description": [], - "path": "x-pack/plugins/lens/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "lens", - "id": "def-common.ColorStop.stop", - "type": "number", - "tags": [], - "label": "stop", - "description": [], - "path": "x-pack/plugins/lens/common/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "lens", - "id": "def-common.CustomPaletteParams", - "type": "Interface", - "tags": [], - "label": "CustomPaletteParams", - "description": [], - "path": "x-pack/plugins/lens/common/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "lens", - "id": "def-common.CustomPaletteParams.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/lens/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "lens", - "id": "def-common.CustomPaletteParams.reverse", - "type": "CompoundType", - "tags": [], - "label": "reverse", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "x-pack/plugins/lens/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "lens", - "id": "def-common.CustomPaletteParams.rangeType", - "type": "CompoundType", - "tags": [], - "label": "rangeType", - "description": [], - "signature": [ - "\"number\" | \"percent\" | undefined" - ], - "path": "x-pack/plugins/lens/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "lens", - "id": "def-common.CustomPaletteParams.continuity", - "type": "CompoundType", - "tags": [], - "label": "continuity", - "description": [], - "signature": [ - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteContinuity", - "text": "PaletteContinuity" - }, - " | undefined" - ], - "path": "x-pack/plugins/lens/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "lens", - "id": "def-common.CustomPaletteParams.progression", - "type": "string", - "tags": [], - "label": "progression", - "description": [], - "signature": [ - "\"fixed\" | undefined" - ], - "path": "x-pack/plugins/lens/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "lens", - "id": "def-common.CustomPaletteParams.rangeMin", - "type": "number", - "tags": [], - "label": "rangeMin", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "x-pack/plugins/lens/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "lens", - "id": "def-common.CustomPaletteParams.rangeMax", - "type": "number", - "tags": [], - "label": "rangeMax", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "x-pack/plugins/lens/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "lens", - "id": "def-common.CustomPaletteParams.stops", - "type": "Array", - "tags": [], - "label": "stops", - "description": [], - "signature": [ - { - "pluginId": "lens", - "scope": "common", - "docId": "kibLensPluginApi", - "section": "def-common.ColorStop", - "text": "ColorStop" - }, - "[] | undefined" - ], - "path": "x-pack/plugins/lens/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "lens", - "id": "def-common.CustomPaletteParams.colorStops", - "type": "Array", - "tags": [], - "label": "colorStops", - "description": [], - "signature": [ - { - "pluginId": "lens", - "scope": "common", - "docId": "kibLensPluginApi", - "section": "def-common.ColorStop", - "text": "ColorStop" - }, - "[] | undefined" - ], - "path": "x-pack/plugins/lens/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "lens", - "id": "def-common.CustomPaletteParams.steps", - "type": "number", - "tags": [], - "label": "steps", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "x-pack/plugins/lens/common/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "lens", "id": "def-common.DateRange", @@ -8271,21 +7967,9 @@ "label": "palette", "description": [], "signature": [ - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteOutput", - "text": "PaletteOutput" - }, + "PaletteOutput", "<", - { - "pluginId": "lens", - "scope": "common", - "docId": "kibLensPluginApi", - "section": "def-common.CustomPaletteParams", - "text": "CustomPaletteParams" - }, + "CustomPaletteParams", "> | undefined" ], "path": "x-pack/plugins/lens/common/types.ts", @@ -8527,13 +8211,7 @@ "label": "palette", "description": [], "signature": [ - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteOutput", - "text": "PaletteOutput" - }, + "PaletteOutput", "<{ [key: string]: unknown; }> | undefined" ], "path": "x-pack/plugins/lens/common/types.ts", @@ -8833,13 +8511,7 @@ "label": "CustomPaletteParamsConfig", "description": [], "signature": [ - { - "pluginId": "lens", - "scope": "common", - "docId": "kibLensPluginApi", - "section": "def-common.CustomPaletteParams", - "text": "CustomPaletteParams" - }, + "CustomPaletteParams", " & { maxSteps?: number | undefined; }" ], "path": "x-pack/plugins/lens/common/types.ts", @@ -9083,28 +8755,6 @@ "deprecated": false, "initialIsOpen": false }, - { - "parentPluginId": "lens", - "id": "def-common.RequiredPaletteParamTypes", - "type": "Type", - "tags": [], - "label": "RequiredPaletteParamTypes", - "description": [], - "signature": [ - "Required<", - { - "pluginId": "lens", - "scope": "common", - "docId": "kibLensPluginApi", - "section": "def-common.CustomPaletteParams", - "text": "CustomPaletteParams" - }, - "> & { maxSteps?: number | undefined; }" - ], - "path": "x-pack/plugins/lens/common/types.ts", - "deprecated": false, - "initialIsOpen": false - }, { "parentPluginId": "lens", "id": "def-common.SortingHint", diff --git a/api_docs/lens.mdx b/api_docs/lens.mdx index 2974c7140ed53..13b19ffe60e56 100644 --- a/api_docs/lens.mdx +++ b/api_docs/lens.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/lens title: "lens" image: https://source.unsplash.com/400x175/?github summary: API docs for the lens plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'lens'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 542 | 0 | 467 | 29 | +| 527 | 0 | 452 | 30 | ## Client diff --git a/api_docs/license_api_guard.devdocs.json b/api_docs/license_api_guard.devdocs.json index 3cb1dbcca2a83..06339738fe611 100644 --- a/api_docs/license_api_guard.devdocs.json +++ b/api_docs/license_api_guard.devdocs.json @@ -230,6 +230,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -420,6 +424,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -638,6 +646,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", diff --git a/api_docs/license_api_guard.mdx b/api_docs/license_api_guard.mdx index ff9b643e9d694..875d654c0267b 100644 --- a/api_docs/license_api_guard.mdx +++ b/api_docs/license_api_guard.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/licenseApiGuard title: "licenseApiGuard" image: https://source.unsplash.com/400x175/?github summary: API docs for the licenseApiGuard plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licenseApiGuard'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/license_management.mdx b/api_docs/license_management.mdx index f2ad339d8c0d8..d81ae2975260d 100644 --- a/api_docs/license_management.mdx +++ b/api_docs/license_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/licenseManagement title: "licenseManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the licenseManagement plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licenseManagement'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/licensing.devdocs.json b/api_docs/licensing.devdocs.json index 7d63612c554c2..264859dfa2e6a 100644 --- a/api_docs/licensing.devdocs.json +++ b/api_docs/licensing.devdocs.json @@ -1037,6 +1037,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -1227,6 +1231,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -1449,6 +1457,8 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, + " | Buffer | ", + "Stream", ">) => ", "KibanaResponse", "; redirected: (options: ", + " | undefined; } | Buffer | ", + "Stream", + ">; redirected: (options: ", { "pluginId": "core", "scope": "server", diff --git a/api_docs/licensing.mdx b/api_docs/licensing.mdx index e9208ee1f9f8e..cb395af82c70a 100644 --- a/api_docs/licensing.mdx +++ b/api_docs/licensing.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/licensing title: "licensing" image: https://source.unsplash.com/400x175/?github summary: API docs for the licensing plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licensing'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/lists.devdocs.json b/api_docs/lists.devdocs.json index 950e244c88b49..a2134a2c8ffb3 100644 --- a/api_docs/lists.devdocs.json +++ b/api_docs/lists.devdocs.json @@ -311,7 +311,7 @@ "label": "exceptionItems", "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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }))[]" + "({ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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": "x-pack/plugins/lists/public/exceptions/components/builder/exception_items_renderer.tsx", "deprecated": false @@ -324,7 +324,7 @@ "label": "exceptionsToDelete", "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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }[]" + "{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }[]" ], "path": "x-pack/plugins/lists/public/exceptions/components/builder/exception_items_renderer.tsx", "deprecated": false @@ -463,7 +463,9 @@ "type": "Class", "tags": [], "label": "ExceptionListClient", - "description": [], + "description": [ + "\nClass for use for exceptions that are with trusted applications or\nwith rules." + ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "deprecated": false, "children": [ @@ -473,7 +475,9 @@ "type": "Function", "tags": [], "label": "Constructor", - "description": [], + "description": [ + "\nConstructs the exception list" + ], "signature": [ "any" ], @@ -501,12 +505,7 @@ "parentPluginId": "lists", "id": "def-server.ExceptionListClient.getExceptionList", "type": "Function", - "tags": [ - "params", - "params", - "params", - "return" - ], + "tags": [], "label": "getExceptionList", "description": [ "\nFetch an exception list parent container" @@ -535,20 +534,14 @@ } ], "returnComment": [ - "the found exception list or null if none exists" + "The found exception list or null if none exists" ] }, { "parentPluginId": "lists", "id": "def-server.ExceptionListClient.getExceptionListSummary", "type": "Function", - "tags": [ - "params", - "params", - "params", - "params", - "return" - ], + "tags": [], "label": "getExceptionListSummary", "description": [ "\nFetch an exception list parent container" @@ -577,19 +570,14 @@ } ], "returnComment": [ - "summary of exception list item os types" + "Summary of exception list item os types" ] }, { "parentPluginId": "lists", "id": "def-server.ExceptionListClient.getExceptionListItem", "type": "Function", - "tags": [ - "params", - "params", - "params", - "return" - ], + "tags": [], "label": "getExceptionListItem", "description": [ "\nFetch an exception list item container" @@ -597,7 +585,7 @@ "signature": [ "({ itemId, id, namespaceType, }: ", "GetExceptionListItemOptions", - ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; } | null>" + ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; } | null>" ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "deprecated": false, @@ -655,7 +643,9 @@ "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "deprecated": false, "children": [], - "returnComment": [] + "returnComment": [ + "The exception list schema or null if it does not exist" + ] }, { "parentPluginId": "lists", @@ -669,7 +659,7 @@ "signature": [ "({ comments, description, entries, itemId, meta, name, osTypes, tags, type, }: ", "CreateEndpointListItemOptions", - ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }>" + ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }>" ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "deprecated": false, @@ -689,7 +679,9 @@ "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "The exception list item created, otherwise null if not created" + ] }, { "parentPluginId": "lists", @@ -703,7 +695,7 @@ "signature": [ "({ _version, comments, description, entries, id, itemId, meta, name, osTypes, tags, type, }: ", "UpdateEndpointListItemOptions", - ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; } | null>" + ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; } | null>" ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "deprecated": false, @@ -723,7 +715,9 @@ "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "The exception list item updated, otherwise null if not updated" + ] }, { "parentPluginId": "lists", @@ -737,7 +731,7 @@ "signature": [ "({ itemId, id, }: ", "GetEndpointListItemOptions", - ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; } | null>" + ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; } | null>" ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "deprecated": false, @@ -757,24 +751,15 @@ "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "The exception list item found, otherwise null" + ] }, { "parentPluginId": "lists", "id": "def-server.ExceptionListClient.createExceptionList", "type": "Function", - "tags": [ - "params", - "params", - "params", - "params", - "params", - "params", - "params", - "params", - "params", - "return" - ], + "tags": [], "label": "createExceptionList", "description": [ "\nCreate an exception list container" @@ -810,19 +795,7 @@ "parentPluginId": "lists", "id": "def-server.ExceptionListClient.updateExceptionList", "type": "Function", - "tags": [ - "params", - "params", - "params", - "params", - "params", - "params", - "params", - "params", - "params", - "params", - "return" - ], + "tags": [], "label": "updateExceptionList", "description": [ "\nUpdate an existing exception list container" @@ -858,12 +831,7 @@ "parentPluginId": "lists", "id": "def-server.ExceptionListClient.deleteExceptionList", "type": "Function", - "tags": [ - "params", - "params", - "params", - "return" - ], + "tags": [], "label": "deleteExceptionList", "description": [ "\nDelete an exception list container by either id or list_id" @@ -899,19 +867,7 @@ "parentPluginId": "lists", "id": "def-server.ExceptionListClient.createExceptionListItem", "type": "Function", - "tags": [ - "params", - "params", - "params", - "params", - "params", - "params", - "params", - "params", - "params", - "params", - "return" - ], + "tags": [], "label": "createExceptionListItem", "description": [ "\nCreate an exception list item container" @@ -925,7 +881,7 @@ "section": "def-server.CreateExceptionListItemOptions", "text": "CreateExceptionListItemOptions" }, - ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }>" + ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }>" ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "deprecated": false, @@ -959,21 +915,7 @@ "parentPluginId": "lists", "id": "def-server.ExceptionListClient.updateExceptionListItem", "type": "Function", - "tags": [ - "params", - "params", - "params", - "params", - "params", - "params", - "params", - "params", - "params", - "params", - "params", - "params", - "return" - ], + "tags": [], "label": "updateExceptionListItem", "description": [ "\nUpdate an existing exception list item" @@ -987,7 +929,7 @@ "section": "def-server.UpdateExceptionListItemOptions", "text": "UpdateExceptionListItemOptions" }, - ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; } | null>" + ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; } | null>" ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "deprecated": false, @@ -1021,12 +963,7 @@ "parentPluginId": "lists", "id": "def-server.ExceptionListClient.deleteExceptionListItem", "type": "Function", - "tags": [ - "params", - "params", - "params", - "return" - ], + "tags": [], "label": "deleteExceptionListItem", "description": [ "\nDelete an exception list item by either id or item_id" @@ -1034,7 +971,7 @@ "signature": [ "({ id, itemId, namespaceType, }: ", "DeleteExceptionListItemOptions", - ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; } | null>" + ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; } | null>" ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "deprecated": false, @@ -1062,11 +999,7 @@ "parentPluginId": "lists", "id": "def-server.ExceptionListClient.deleteExceptionListItemById", "type": "Function", - "tags": [ - "params", - "params", - "return" - ], + "tags": [], "label": "deleteExceptionListItemById", "description": [ "\nDelete an exception list item by id" @@ -1103,12 +1036,12 @@ "tags": [], "label": "deleteEndpointListItem", "description": [ - "\nThis is the same as \"deleteExceptionListItem\" except it applies specifically to the endpoint list." + "\nThis is the same as \"deleteExceptionListItem\" except it applies specifically to the endpoint list.\nEither id or itemId has to be defined to delete but not both is required. If both are provided, the id\nis preferred." ], "signature": [ "({ id, itemId, }: ", "DeleteEndpointListItemOptions", - ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; } | null>" + ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; } | null>" ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "deprecated": false, @@ -1136,11 +1069,13 @@ "type": "Function", "tags": [], "label": "findExceptionListItem", - "description": [], + "description": [ + "\nFinds an exception list item given a set of criteria." + ], "signature": [ "({ listId, filter, perPage, pit, page, searchAfter, sortField, sortOrder, namespaceType, }: ", "FindExceptionListItemOptions", - ") => Promise<({ data: { _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }[]; page: number; per_page: number; total: number; } & { pit?: string | undefined; }) | null>" + ") => Promise<({ data: { _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }[]; page: number; per_page: number; total: number; } & { pit?: string | undefined; }) | null>" ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "deprecated": false, @@ -1160,7 +1095,9 @@ "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "The found exception list items or null if nothing is found" + ] }, { "parentPluginId": "lists", @@ -1168,11 +1105,13 @@ "type": "Function", "tags": [], "label": "findExceptionListsItem", - "description": [], + "description": [ + "\nFinds exception lists items given a set of criteria." + ], "signature": [ "({ listId, filter, perPage, pit, page, searchAfter, sortField, sortOrder, namespaceType, }: ", "FindExceptionListsItemOptions", - ") => Promise<({ data: { _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }[]; page: number; per_page: number; total: number; } & { pit?: string | undefined; }) | null>" + ") => Promise<({ data: { _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }[]; page: number; per_page: number; total: number; } & { pit?: string | undefined; }) | null>" ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "deprecated": false, @@ -1192,7 +1131,9 @@ "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "The found exception lists items or null if nothing is found" + ] }, { "parentPluginId": "lists", @@ -1200,11 +1141,13 @@ "type": "Function", "tags": [], "label": "findValueListExceptionListItems", - "description": [], + "description": [ + "\nFinds value list exception items given a set of criteria." + ], "signature": [ "({ perPage, pit, page, searchAfter, sortField, sortOrder, valueListId, }: ", "FindValueListExceptionListsItems", - ") => Promise<({ data: { _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }[]; page: number; per_page: number; total: number; } & { pit?: string | undefined; }) | null>" + ") => Promise<({ data: { _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }[]; page: number; per_page: number; total: number; } & { pit?: string | undefined; }) | null>" ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "deprecated": false, @@ -1224,7 +1167,9 @@ "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "The found value list exception list item or null if nothing is found" + ] }, { "parentPluginId": "lists", @@ -1232,7 +1177,9 @@ "type": "Function", "tags": [], "label": "findExceptionList", - "description": [], + "description": [ + "\nFinds exception lists given a set of criteria." + ], "signature": [ "({ filter, perPage, page, pit, searchAfter, sortField, sortOrder, namespaceType, }: ", "FindExceptionListOptions", @@ -1256,7 +1203,9 @@ "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "The found exception lists or null if nothing is found" + ] }, { "parentPluginId": "lists", @@ -1270,7 +1219,7 @@ "signature": [ "({ filter, perPage, page, pit, searchAfter, sortField, sortOrder, }: ", "FindEndpointListItemOptions", - ") => Promise<({ data: { _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }[]; page: number; per_page: number; total: number; } & { pit?: string | undefined; }) | null>" + ") => Promise<({ data: { _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; }[]; page: number; per_page: number; total: number; } & { pit?: string | undefined; }) | null>" ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", "deprecated": false, @@ -1290,18 +1239,15 @@ "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "The found exception list items or null if nothing is found" + ] }, { "parentPluginId": "lists", "id": "def-server.ExceptionListClient.exportExceptionListAndItems", "type": "Function", - "tags": [ - "params", - "params", - "params", - "return" - ], + "tags": [], "label": "exportExceptionListAndItems", "description": [ "\nExport an exception list parent container and it's items" @@ -1345,12 +1291,7 @@ "parentPluginId": "lists", "id": "def-server.ExceptionListClient.importExceptionListAndItems", "type": "Function", - "tags": [ - "params", - "params", - "params", - "return" - ], + "tags": [], "label": "importExceptionListAndItems", "description": [ "\nImport exception lists parent containers and items as stream" @@ -1386,12 +1327,7 @@ "parentPluginId": "lists", "id": "def-server.ExceptionListClient.importExceptionListAndItemsAsArray", "type": "Function", - "tags": [ - "params", - "params", - "params", - "return" - ], + "tags": [], "label": "importExceptionListAndItemsAsArray", "description": [ "\nImport exception lists parent containers and items as array" @@ -1427,11 +1363,7 @@ "parentPluginId": "lists", "id": "def-server.ExceptionListClient.openPointInTime", "type": "Function", - "tags": [ - "params", - "params", - "return" - ], + "tags": [], "label": "openPointInTime", "description": [ "\nOpens a point in time (PIT) for either exception lists or exception list items.\nSee: https://www.elastic.co/guide/en/elasticsearch/reference/current/point-in-time-api.html" @@ -1475,10 +1407,7 @@ "parentPluginId": "lists", "id": "def-server.ExceptionListClient.closePointInTime", "type": "Function", - "tags": [ - "params", - "return" - ], + "tags": [], "label": "closePointInTime", "description": [ "\nCloses a point in time (PIT) for either exception lists or exception list items.\nSee: https://www.elastic.co/guide/en/elasticsearch/reference/current/point-in-time-api.html" @@ -1663,7 +1592,9 @@ "type": "Class", "tags": [], "label": "ListClient", - "description": [], + "description": [ + "\nClass for use for value lists are are associated with exception lists.\nSee {@link https://www.elastic.co/guide/en/security/current/lists-api-create-container.html}" + ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, "children": [ @@ -1673,7 +1604,9 @@ "type": "Function", "tags": [], "label": "Constructor", - "description": [], + "description": [ + "\nConstructs the value list" + ], "signature": [ "any" ], @@ -1703,14 +1636,18 @@ "type": "Function", "tags": [], "label": "getListIndex", - "description": [], + "description": [ + "\nReturns the list index name" + ], "signature": [ "() => string" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, "children": [], - "returnComment": [] + "returnComment": [ + "The list index name" + ] }, { "parentPluginId": "lists", @@ -1718,14 +1655,18 @@ "type": "Function", "tags": [], "label": "getListItemIndex", - "description": [], + "description": [ + "\nReturns the list item index name" + ], "signature": [ "() => string" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, "children": [], - "returnComment": [] + "returnComment": [ + "The list item index name" + ] }, { "parentPluginId": "lists", @@ -1733,11 +1674,13 @@ "type": "Function", "tags": [], "label": "getList", - "description": [], + "description": [ + "\nGiven a list id, this will return the list container" + ], "signature": [ "({ id }: ", "GetListOptions", - ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; } | null>" + ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; } | null>" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, @@ -1757,7 +1700,9 @@ "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "The List container if found, otherwise null" + ] }, { "parentPluginId": "lists", @@ -1765,11 +1710,13 @@ "type": "Function", "tags": [], "label": "createList", - "description": [], + "description": [ + "\nCreates a list, if given at least the \"name\", \"description\", \"type\", and \"version\"\nSee {@link https://www.elastic.co/guide/en/security/current/lists-api-create-container.html}\nfor more information around formats of the deserializer and serializer" + ], "signature": [ "({ id, deserializer, immutable, serializer, name, description, type, meta, version, }: ", "CreateListOptions", - ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }>" + ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }>" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, @@ -1789,7 +1736,9 @@ "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "The list created" + ] }, { "parentPluginId": "lists", @@ -1797,11 +1746,13 @@ "type": "Function", "tags": [], "label": "createListIfItDoesNotExist", - "description": [], + "description": [ + "\nCreates a list, if given at least the \"name\", \"description\", \"type\", and \"version\"\nSee {@link https://www.elastic.co/guide/en/security/current/lists-api-create-container.html}\nfor more information around formats of the deserializer and serializer.\nThis will create the list if it does not exist. If the list exists, this will ignore creating\nanything and just return the existing list." + ], "signature": [ "({ id, deserializer, serializer, name, description, immutable, type, meta, version, }: ", "CreateListIfItDoesNotExistOptions", - ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }>" + ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }>" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, @@ -1821,7 +1772,9 @@ "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "The list created" + ] }, { "parentPluginId": "lists", @@ -1829,14 +1782,18 @@ "type": "Function", "tags": [], "label": "getListIndexExists", - "description": [], + "description": [ + "\nTrue if the list index exists, otherwise false" + ], "signature": [ "() => Promise" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, "children": [], - "returnComment": [] + "returnComment": [ + "True if the list index exists, otherwise false" + ] }, { "parentPluginId": "lists", @@ -1844,14 +1801,18 @@ "type": "Function", "tags": [], "label": "getListItemIndexExists", - "description": [], + "description": [ + "\nTrue if the list index item exists, otherwise false" + ], "signature": [ "() => Promise" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, "children": [], - "returnComment": [] + "returnComment": [ + "True if the list item index exists, otherwise false" + ] }, { "parentPluginId": "lists", @@ -1859,14 +1820,18 @@ "type": "Function", "tags": [], "label": "createListBootStrapIndex", - "description": [], + "description": [ + "\nCreates the list boot strap index for ILM policies." + ], "signature": [ "() => Promise" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, "children": [], - "returnComment": [] + "returnComment": [ + "The contents of the bootstrap response from Elasticsearch" + ] }, { "parentPluginId": "lists", @@ -1874,14 +1839,18 @@ "type": "Function", "tags": [], "label": "createListItemBootStrapIndex", - "description": [], + "description": [ + "\nCreates the list item boot strap index for ILM policies." + ], "signature": [ "() => Promise" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, "children": [], - "returnComment": [] + "returnComment": [ + "The contents of the bootstrap response from Elasticsearch" + ] }, { "parentPluginId": "lists", @@ -1889,14 +1858,18 @@ "type": "Function", "tags": [], "label": "getListPolicyExists", - "description": [], + "description": [ + "\nReturns true if the list policy for ILM exists, otherwise false" + ], "signature": [ "() => Promise" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, "children": [], - "returnComment": [] + "returnComment": [ + "True if the list policy for ILM exists, otherwise false." + ] }, { "parentPluginId": "lists", @@ -1904,14 +1877,18 @@ "type": "Function", "tags": [], "label": "getListItemPolicyExists", - "description": [], + "description": [ + "\nReturns true if the list item policy for ILM exists, otherwise false" + ], "signature": [ "() => Promise" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, "children": [], - "returnComment": [] + "returnComment": [ + "True if the list item policy for ILM exists, otherwise false." + ] }, { "parentPluginId": "lists", @@ -1919,14 +1896,18 @@ "type": "Function", "tags": [], "label": "getListTemplateExists", - "description": [], + "description": [ + "\nReturns true if the list template for ILM exists, otherwise false" + ], "signature": [ "() => Promise" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, "children": [], - "returnComment": [] + "returnComment": [ + "True if the list template for ILM exists, otherwise false." + ] }, { "parentPluginId": "lists", @@ -1934,14 +1915,18 @@ "type": "Function", "tags": [], "label": "getListItemTemplateExists", - "description": [], + "description": [ + "\nReturns true if the list item template for ILM exists, otherwise false" + ], "signature": [ "() => Promise" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, "children": [], - "returnComment": [] + "returnComment": [ + "True if the list item template for ILM exists, otherwise false." + ] }, { "parentPluginId": "lists", @@ -1949,14 +1934,18 @@ "type": "Function", "tags": [], "label": "getListTemplate", - "description": [], + "description": [ + "\nReturns the list template for ILM." + ], "signature": [ "() => Record" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, "children": [], - "returnComment": [] + "returnComment": [ + "The contents of the list template for ILM." + ] }, { "parentPluginId": "lists", @@ -1964,14 +1953,18 @@ "type": "Function", "tags": [], "label": "getListItemTemplate", - "description": [], + "description": [ + "\nReturns the list item template for ILM." + ], "signature": [ "() => Record" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, "children": [], - "returnComment": [] + "returnComment": [ + "The contents of the list item template for ILM." + ] }, { "parentPluginId": "lists", @@ -1979,14 +1972,18 @@ "type": "Function", "tags": [], "label": "setListTemplate", - "description": [], + "description": [ + "\nSets the list template for ILM." + ], "signature": [ "() => Promise" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, "children": [], - "returnComment": [] + "returnComment": [ + "The contents of the list template for ILM." + ] }, { "parentPluginId": "lists", @@ -1994,14 +1991,18 @@ "type": "Function", "tags": [], "label": "setListItemTemplate", - "description": [], + "description": [ + "\nSets the list item template for ILM." + ], "signature": [ "() => Promise" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, "children": [], - "returnComment": [] + "returnComment": [ + "The contents of the list item template for ILM." + ] }, { "parentPluginId": "lists", @@ -2009,14 +2010,18 @@ "type": "Function", "tags": [], "label": "setListPolicy", - "description": [], + "description": [ + "\nSets the list policy" + ], "signature": [ "() => Promise" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, "children": [], - "returnComment": [] + "returnComment": [ + "The contents of the list policy set" + ] }, { "parentPluginId": "lists", @@ -2024,14 +2029,18 @@ "type": "Function", "tags": [], "label": "setListItemPolicy", - "description": [], + "description": [ + "\nSets the list item policy" + ], "signature": [ "() => Promise" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, "children": [], - "returnComment": [] + "returnComment": [ + "The contents of the list policy set" + ] }, { "parentPluginId": "lists", @@ -2039,14 +2048,18 @@ "type": "Function", "tags": [], "label": "deleteListIndex", - "description": [], + "description": [ + "\nDeletes the list index" + ], "signature": [ "() => Promise" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, "children": [], - "returnComment": [] + "returnComment": [ + "True if the list index was deleted, otherwise false" + ] }, { "parentPluginId": "lists", @@ -2054,14 +2067,18 @@ "type": "Function", "tags": [], "label": "deleteListItemIndex", - "description": [], + "description": [ + "\nDeletes the list item index" + ], "signature": [ "() => Promise" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, "children": [], - "returnComment": [] + "returnComment": [ + "True if the list item index was deleted, otherwise false" + ] }, { "parentPluginId": "lists", @@ -2069,14 +2086,18 @@ "type": "Function", "tags": [], "label": "deleteListPolicy", - "description": [], + "description": [ + "\nDeletes the list policy" + ], "signature": [ "() => Promise" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, "children": [], - "returnComment": [] + "returnComment": [ + "The contents of the list policy" + ] }, { "parentPluginId": "lists", @@ -2084,14 +2105,18 @@ "type": "Function", "tags": [], "label": "deleteListItemPolicy", - "description": [], + "description": [ + "\nDeletes the list item policy" + ], "signature": [ "() => Promise" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, "children": [], - "returnComment": [] + "returnComment": [ + "The contents of the list item policy" + ] }, { "parentPluginId": "lists", @@ -2099,14 +2124,18 @@ "type": "Function", "tags": [], "label": "deleteListTemplate", - "description": [], + "description": [ + "\nDeletes the list template" + ], "signature": [ "() => Promise" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, "children": [], - "returnComment": [] + "returnComment": [ + "The contents of the list template" + ] }, { "parentPluginId": "lists", @@ -2114,14 +2143,18 @@ "type": "Function", "tags": [], "label": "deleteListItemTemplate", - "description": [], + "description": [ + "\nDeletes the list item template" + ], "signature": [ "() => Promise" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, "children": [], - "returnComment": [] + "returnComment": [ + "The contents of the list item template" + ] }, { "parentPluginId": "lists", @@ -2129,11 +2162,13 @@ "type": "Function", "tags": [], "label": "deleteListItem", - "description": [], + "description": [ + "\nGiven a list item id, this will delete the single list item" + ], "signature": [ "({ id }: ", "DeleteListItemOptions", - ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; } | null>" + ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; } | null>" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, @@ -2153,7 +2188,9 @@ "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "The list item if found, otherwise null" + ] }, { "parentPluginId": "lists", @@ -2161,11 +2198,13 @@ "type": "Function", "tags": [], "label": "deleteListItemByValue", - "description": [], + "description": [ + "\nGiven a list value, this will delete all list items that have that value" + ], "signature": [ "({ listId, value, type, }: ", "DeleteListItemByValueOptions", - ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }[]>" + ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }[]>" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, @@ -2185,7 +2224,9 @@ "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "The list items deleted." + ] }, { "parentPluginId": "lists", @@ -2193,11 +2234,13 @@ "type": "Function", "tags": [], "label": "deleteList", - "description": [], + "description": [ + "\nGiven a list id, this will delete the list from the id" + ], "signature": [ "({ id }: ", "DeleteListOptions", - ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; } | null>" + ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; } | null>" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, @@ -2217,7 +2260,9 @@ "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "The list deleted if found, otherwise null" + ] }, { "parentPluginId": "lists", @@ -2225,7 +2270,9 @@ "type": "Function", "tags": [], "label": "exportListItemsToStream", - "description": [], + "description": [ + "\nExports list items to a stream" + ], "signature": [ "({ stringToAppend, listId, stream, }: ", "ExportListItemsToStreamOptions", @@ -2257,11 +2304,13 @@ "type": "Function", "tags": [], "label": "importListItemsToStream", - "description": [], + "description": [ + "\nImports list items to a stream. If the list already exists, this will append the list items to the existing list.\nIf the list does not exist, this will auto-create the list and then add the items to that list.\nSee {@link https://www.elastic.co/guide/en/security/current/lists-api-create-container.html}\nfor more information around formats of the deserializer and serializer." + ], "signature": [ "({ deserializer, serializer, type, listId, stream, meta, version, }: ", "ImportListItemsToStreamOptions", - ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; } | null>" + ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; } | null>" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, @@ -2289,11 +2338,13 @@ "type": "Function", "tags": [], "label": "getListItemByValue", - "description": [], + "description": [ + "\nReturns all list items found by value." + ], "signature": [ "({ listId, value, type, }: ", "GetListItemByValueOptions", - ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }[]>" + ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }[]>" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, @@ -2313,7 +2364,9 @@ "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "The list items by value found." + ] }, { "parentPluginId": "lists", @@ -2321,11 +2374,13 @@ "type": "Function", "tags": [], "label": "createListItem", - "description": [], + "description": [ + "\nCreates a list item given at least \"value\", \"type\", and a \"listId\" where \"listId\" is the parent container that this list\nitem belongs to.\nSee {@link https://www.elastic.co/guide/en/security/current/lists-api-create-container.html}\nfor more information around formats of the deserializer and serializer." + ], "signature": [ "({ id, deserializer, serializer, listId, value, type, meta, }: ", "CreateListItemOptions", - ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; } | null>" + ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; } | null>" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, @@ -2353,11 +2408,13 @@ "type": "Function", "tags": [], "label": "updateListItem", - "description": [], + "description": [ + "\nUpdates a list item's value given the id of the list item.\nSee {@link https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html}\nfor more information around optimistic concurrency control." + ], "signature": [ "({ _version, id, value, meta, }: ", "UpdateListItemOptions", - ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; } | null>" + ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; } | null>" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, @@ -2385,11 +2442,13 @@ "type": "Function", "tags": [], "label": "updateList", - "description": [], + "description": [ + "\nUpdates a list container's value given the id of the list.\nSee {@link https://www.elastic.co/guide/en/elasticsearch/reference/current/optimistic-concurrency-control.html}\nfor more information around optimistic concurrency control." + ], "signature": [ "({ _version, id, name, description, meta, version, }: ", "UpdateListOptions", - ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; } | null>" + ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; } | null>" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, @@ -2417,11 +2476,13 @@ "type": "Function", "tags": [], "label": "getListItem", - "description": [], + "description": [ + "\nGiven a list item id, this returns the list item if it exists, otherwise \"null\"." + ], "signature": [ "({ id }: ", "GetListItemOptions", - ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; } | null>" + ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; } | null>" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, @@ -2441,7 +2502,9 @@ "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "The list item found if it exists, otherwise \"null\"." + ] }, { "parentPluginId": "lists", @@ -2449,11 +2512,13 @@ "type": "Function", "tags": [], "label": "getListItemByValues", - "description": [], + "description": [ + "\nGiven a list item value, this returns all list items found with that value." + ], "signature": [ "({ type, listId, value, }: ", "GetListItemsByValueOptions", - ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }[]>" + ") => Promise<{ _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }[]>" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, @@ -2473,7 +2538,9 @@ "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "All list items that match the value sent in." + ] }, { "parentPluginId": "lists", @@ -2481,11 +2548,13 @@ "type": "Function", "tags": [], "label": "searchListItemByValues", - "description": [], + "description": [ + "\nGiven a list item value, this search for all list items found with that value." + ], "signature": [ "({ type, listId, value, }: ", "SearchListItemByValuesOptions", - ") => Promise<{ items: { _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }[]; value: unknown; }[]>" + ") => Promise<{ items: { _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }[]; value: unknown; }[]>" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, @@ -2505,7 +2574,9 @@ "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "All list items that match the value sent in." + ] }, { "parentPluginId": "lists", @@ -2513,11 +2584,13 @@ "type": "Function", "tags": [], "label": "findList", - "description": [], + "description": [ + "\nFinds lists based on a filter passed in. This is a bit complicated as it existed before\nPIT (Point in Time) and other mechanisms. This uses an older way of doing \"hops\" and\naccepting a \"currentIndexPosition\" which acts like a pointer to where the search should continue." + ], "signature": [ "({ filter, currentIndexPosition, perPage, page, sortField, sortOrder, searchAfter, }: ", "FindListOptions", - ") => Promise<{ cursor: string; data: { _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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }>" + ") => Promise<{ cursor: string; data: { _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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; version: number; }[]; page: number; per_page: number; total: number; }>" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, @@ -2537,7 +2610,9 @@ "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "All lists found based on the passed in filter." + ] }, { "parentPluginId": "lists", @@ -2545,11 +2620,13 @@ "type": "Function", "tags": [], "label": "findListItem", - "description": [], + "description": [ + "\nFinds list items based on a filter passed in. This is a bit complicated as it existed before\nPIT (Point in Time) and other mechanisms. This uses an older way of doing \"hops\" and\naccepting a \"currentIndexPosition\" which acts like a pointer to where the search should continue." + ], "signature": [ "({ listId, filter, currentIndexPosition, perPage, page, sortField, sortOrder, searchAfter, }: ", "FindListItemOptions", - ") => Promise<{ cursor: string; 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }[]; page: number; per_page: number; total: number; } | null>" + ") => Promise<{ cursor: string; 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; updated_at: string; updated_by: string; value: string; }[]; page: number; per_page: number; total: number; } | null>" ], "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", "deprecated": false, @@ -2569,7 +2646,9 @@ "isRequired": true } ], - "returnComment": [] + "returnComment": [ + "All list items found based on the passed in filter." + ] } ], "initialIsOpen": false @@ -2583,7 +2662,9 @@ "type": "Interface", "tags": [], "label": "CreateExceptionListItemOptions", - "description": [], + "description": [ + "\nExceptionListClient.createExceptionListItem\n{@link ExceptionListClient.createExceptionListItem}" + ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts", "deprecated": false, "children": [ @@ -2593,7 +2674,9 @@ "type": "Array", "tags": [], "label": "comments", - "description": [], + "description": [ + "User comments for the exception list item" + ], "signature": [ "{ comment: string; }[]" ], @@ -2606,9 +2689,11 @@ "type": "Array", "tags": [], "label": "entries", - "description": [], + "description": [ + "an array with the exception list item entries" + ], "signature": [ - "({ 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; })[]" + "({ 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; })[]" ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts", "deprecated": false @@ -2619,7 +2704,9 @@ "type": "string", "tags": [], "label": "itemId", - "description": [], + "description": [ + "the \"item_id\" of the exception list item" + ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts", "deprecated": false }, @@ -2629,7 +2716,9 @@ "type": "string", "tags": [], "label": "listId", - "description": [], + "description": [ + "the \"list_id\" of the parent exception list" + ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts", "deprecated": false }, @@ -2639,7 +2728,9 @@ "type": "CompoundType", "tags": [], "label": "namespaceType", - "description": [], + "description": [ + "saved object namespace (single | agnostic)" + ], "signature": [ "\"single\" | \"agnostic\"" ], @@ -2652,7 +2743,9 @@ "type": "string", "tags": [], "label": "name", - "description": [], + "description": [ + "the \"name\" of the exception list" + ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts", "deprecated": false }, @@ -2662,7 +2755,9 @@ "type": "Array", "tags": [], "label": "osTypes", - "description": [], + "description": [ + "item os types to apply" + ], "signature": [ "(\"windows\" | \"linux\" | \"macos\")[]" ], @@ -2675,7 +2770,9 @@ "type": "string", "tags": [], "label": "description", - "description": [], + "description": [ + "a description of the exception list" + ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts", "deprecated": false }, @@ -2685,7 +2782,9 @@ "type": "Uncategorized", "tags": [], "label": "meta", - "description": [], + "description": [ + "Optional meta data about the list item" + ], "signature": [ "object | undefined" ], @@ -2698,7 +2797,9 @@ "type": "Array", "tags": [], "label": "tags", - "description": [], + "description": [ + "user assigned tags of exception list" + ], "signature": [ "string[]" ], @@ -2711,7 +2812,9 @@ "type": "string", "tags": [], "label": "type", - "description": [], + "description": [ + "container type" + ], "signature": [ "\"simple\"" ], @@ -2836,7 +2939,9 @@ "type": "Interface", "tags": [], "label": "UpdateExceptionListItemOptions", - "description": [], + "description": [ + "\nExceptionListClient.updateExceptionListItem\n{@link ExceptionListClient.updateExceptionListItem}" + ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts", "deprecated": false, "children": [ @@ -2846,7 +2951,9 @@ "type": "string", "tags": [], "label": "_version", - "description": [], + "description": [ + "document version" + ], "signature": [ "string | undefined" ], @@ -2859,7 +2966,9 @@ "type": "Array", "tags": [], "label": "comments", - "description": [], + "description": [ + "user comments attached to item" + ], "signature": [ "({ comment: string; } & { id?: string | undefined; })[]" ], @@ -2872,9 +2981,11 @@ "type": "Array", "tags": [], "label": "entries", - "description": [], + "description": [ + "item exception entries logic" + ], "signature": [ - "({ 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\" | \"keyword\" | \"ip\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"text\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; })[]" + "({ 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\" | \"keyword\" | \"ip\" | \"text\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"binary\" | \"date_nanos\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"half_float\" | \"double\" | \"integer_range\" | \"float_range\" | \"long_range\" | \"double_range\" | \"date_range\" | \"ip_range\" | \"shape\"; }; 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; })[]" ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client_types.ts", "deprecated": false @@ -2885,7 +2996,9 @@ "type": "string", "tags": [], "label": "id", - "description": [], + "description": [ + "the \"id\" of the exception list item" + ], "signature": [ "string | undefined" ], @@ -2898,7 +3011,9 @@ "type": "string", "tags": [], "label": "itemId", - "description": [], + "description": [ + "the \"item_id\" of the exception list item" + ], "signature": [ "string | undefined" ], @@ -2911,7 +3026,9 @@ "type": "CompoundType", "tags": [], "label": "namespaceType", - "description": [], + "description": [ + "saved object namespace (single | agnostic)" + ], "signature": [ "\"single\" | \"agnostic\"" ], @@ -2924,7 +3041,9 @@ "type": "string", "tags": [], "label": "name", - "description": [], + "description": [ + "the \"name\" of the exception list" + ], "signature": [ "string | undefined" ], @@ -2937,7 +3056,9 @@ "type": "Array", "tags": [], "label": "osTypes", - "description": [], + "description": [ + "item os types to apply" + ], "signature": [ "(\"windows\" | \"linux\" | \"macos\")[]" ], @@ -2950,7 +3071,9 @@ "type": "string", "tags": [], "label": "description", - "description": [], + "description": [ + "a description of the exception list" + ], "signature": [ "string | undefined" ], @@ -2963,7 +3086,9 @@ "type": "Uncategorized", "tags": [], "label": "meta", - "description": [], + "description": [ + "Optional meta data about the exception list item" + ], "signature": [ "object | undefined" ], @@ -2976,7 +3101,9 @@ "type": "Array", "tags": [], "label": "tags", - "description": [], + "description": [ + "user assigned tags of exception list" + ], "signature": [ "string[] | undefined" ], @@ -2989,7 +3116,9 @@ "type": "string", "tags": [], "label": "type", - "description": [], + "description": [ + "container type" + ], "signature": [ "\"simple\" | undefined" ], diff --git a/api_docs/lists.mdx b/api_docs/lists.mdx index 4be9824f833d2..d41261a0cd841 100644 --- a/api_docs/lists.mdx +++ b/api_docs/lists.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/lists title: "lists" image: https://source.unsplash.com/400x175/?github summary: API docs for the lists plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'lists'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Security detections response](https://github.com/orgs/elastic/teams/sec | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 198 | 0 | 162 | 49 | +| 198 | 0 | 90 | 49 | ## Client diff --git a/api_docs/management.mdx b/api_docs/management.mdx index 3f6a113909a8b..30294c621c92c 100644 --- a/api_docs/management.mdx +++ b/api_docs/management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/management title: "management" image: https://source.unsplash.com/400x175/?github summary: API docs for the management plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'management'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/maps.devdocs.json b/api_docs/maps.devdocs.json index 7b25903f0b349..63493ac786c58 100644 --- a/api_docs/maps.devdocs.json +++ b/api_docs/maps.devdocs.json @@ -80,29 +80,8 @@ "label": "getMeta", "description": [], "signature": [ - "() => Partial<", - "DataFilters", - " & { applyGlobalQuery: boolean; applyGlobalTime: boolean; applyForceRefresh: boolean; fieldNames: string[]; geogridPrecision?: number | undefined; timesliceMaskField?: string | undefined; sourceQuery?: ", - "Query", - " | undefined; sourceMeta: object | null; isForceRefresh: boolean; } & ", - "VectorJoinSourceRequestMeta", - " & { dynamicStyleFields: string[]; isTimeAware: boolean; sourceQuery: ", - "Query", - "; timeFilters: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, - "; } & ", - "ESSearchSourceResponseMeta", - " & ", - "ESGeoLineSourceResponseMeta", - " & ", - "VectorTileLayerMeta", - ">" + "() => ", + "DataRequestMeta" ], "path": "x-pack/plugins/maps/public/classes/util/data_request.ts", "deprecated": false, @@ -1188,6 +1167,20 @@ ], "path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx", "deprecated": false + }, + { + "parentPluginId": "maps", + "id": "def-public.BoundsRequestMeta.joinKeyFilter", + "type": "Object", + "tags": [], + "label": "joinKeyFilter", + "description": [], + "signature": [ + "Filter", + " | undefined" + ], + "path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx", + "deprecated": false } ], "initialIsOpen": false @@ -3051,7 +3044,7 @@ "label": "SourceEditorArgs", "description": [], "signature": [ - "{ clearJoins: () => void; currentLayerType: string; hasJoins: boolean; onChange: (...args: ", + "{ currentLayerType: string; numberOfJoins: number; onChange: (...args: ", "OnSourceChangeArgs", "[]) => Promise; }" ], diff --git a/api_docs/maps.mdx b/api_docs/maps.mdx index ae9babe656796..980ecd53f8ee9 100644 --- a/api_docs/maps.mdx +++ b/api_docs/maps.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/maps title: "maps" image: https://source.unsplash.com/400x175/?github summary: API docs for the maps plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'maps'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [GIS](https://github.com/orgs/elastic/teams/kibana-gis) for questions re | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 223 | 0 | 222 | 27 | +| 224 | 0 | 223 | 25 | ## Client diff --git a/api_docs/maps_ems.devdocs.json b/api_docs/maps_ems.devdocs.json index 18ef0a3cf340b..0649ee441acdf 100644 --- a/api_docs/maps_ems.devdocs.json +++ b/api_docs/maps_ems.devdocs.json @@ -88,7 +88,7 @@ "label": "MapConfig", "description": [], "signature": [ - "{ readonly tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; readonly includeElasticMapsService: boolean; readonly emsUrl: string; readonly emsFileApiUrl: string; readonly emsTileApiUrl: string; readonly emsLandingPageUrl: string; readonly emsFontLibraryUrl: string; readonly emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }" + "{ readonly tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; readonly includeElasticMapsService: boolean; readonly emsUrl: string; readonly emsFileApiUrl: string; readonly emsTileApiUrl: string; readonly emsLandingPageUrl: string; readonly emsFontLibraryUrl: string; readonly emsTileLayerId: Readonly<{} & { dark: string; bright: string; desaturated: string; }>; }" ], "path": "src/plugins/maps_ems/config.ts", "deprecated": false, @@ -141,7 +141,7 @@ "label": "config", "description": [], "signature": [ - "{ readonly tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; readonly includeElasticMapsService: boolean; readonly emsUrl: string; readonly emsFileApiUrl: string; readonly emsTileApiUrl: string; readonly emsLandingPageUrl: string; readonly emsFontLibraryUrl: string; readonly emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }" + "{ readonly tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; readonly includeElasticMapsService: boolean; readonly emsUrl: string; readonly emsFileApiUrl: string; readonly emsTileApiUrl: string; readonly emsLandingPageUrl: string; readonly emsFontLibraryUrl: string; readonly emsTileLayerId: Readonly<{} & { dark: string; bright: string; desaturated: string; }>; }" ], "path": "src/plugins/maps_ems/public/index.ts", "deprecated": false @@ -441,7 +441,7 @@ "section": "def-server.PluginInitializerContext", "text": "PluginInitializerContext" }, - "; }>; includeElasticMapsService: boolean; emsUrl: string; emsFileApiUrl: string; emsTileApiUrl: string; emsLandingPageUrl: string; emsFontLibraryUrl: string; emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }>>" + "; }>; includeElasticMapsService: boolean; emsUrl: string; emsFileApiUrl: string; emsTileApiUrl: string; emsLandingPageUrl: string; emsFontLibraryUrl: string; emsTileLayerId: Readonly<{} & { dark: string; bright: string; desaturated: string; }>; }>>" ], "path": "src/plugins/maps_ems/server/index.ts", "deprecated": false @@ -474,7 +474,7 @@ "section": "def-server.PluginInitializerContext", "text": "PluginInitializerContext" }, - "; }>; includeElasticMapsService: boolean; emsUrl: string; emsFileApiUrl: string; emsTileApiUrl: string; emsLandingPageUrl: string; emsFontLibraryUrl: string; emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }>>" + "; }>; includeElasticMapsService: boolean; emsUrl: string; emsFileApiUrl: string; emsTileApiUrl: string; emsLandingPageUrl: string; emsFontLibraryUrl: string; emsTileLayerId: Readonly<{} & { dark: string; bright: string; desaturated: string; }>; }>>" ], "path": "src/plugins/maps_ems/server/index.ts", "deprecated": false, @@ -499,7 +499,7 @@ "section": "def-server.CoreSetup", "text": "CoreSetup" }, - ", plugins: MapsEmsSetupServerDependencies) => { config: Readonly<{} & { tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; includeElasticMapsService: boolean; emsUrl: string; emsFileApiUrl: string; emsTileApiUrl: string; emsLandingPageUrl: string; emsFontLibraryUrl: string; emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }>; createEMSSettings: () => ", + ", plugins: MapsEmsSetupServerDependencies) => { config: Readonly<{} & { tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; includeElasticMapsService: boolean; emsUrl: string; emsFileApiUrl: string; emsTileApiUrl: string; emsLandingPageUrl: string; emsFontLibraryUrl: string; emsTileLayerId: Readonly<{} & { dark: string; bright: string; desaturated: string; }>; }>; createEMSSettings: () => ", { "pluginId": "mapsEms", "scope": "common", @@ -589,7 +589,7 @@ "label": "config", "description": [], "signature": [ - "{ readonly tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; readonly includeElasticMapsService: boolean; readonly emsUrl: string; readonly emsFileApiUrl: string; readonly emsTileApiUrl: string; readonly emsLandingPageUrl: string; readonly emsFontLibraryUrl: string; readonly emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }" + "{ readonly tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; readonly includeElasticMapsService: boolean; readonly emsUrl: string; readonly emsFileApiUrl: string; readonly emsTileApiUrl: string; readonly emsLandingPageUrl: string; readonly emsFontLibraryUrl: string; readonly emsTileLayerId: Readonly<{} & { dark: string; bright: string; desaturated: string; }>; }" ], "path": "src/plugins/maps_ems/server/index.ts", "deprecated": false diff --git a/api_docs/maps_ems.mdx b/api_docs/maps_ems.mdx index 4fa7850a0e9c9..5fc5483e9d64c 100644 --- a/api_docs/maps_ems.mdx +++ b/api_docs/maps_ems.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/mapsEms title: "mapsEms" image: https://source.unsplash.com/400x175/?github summary: API docs for the mapsEms plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'mapsEms'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/metrics_entities.devdocs.json b/api_docs/metrics_entities.devdocs.json deleted file mode 100644 index 8a4c69fc1e824..0000000000000 --- a/api_docs/metrics_entities.devdocs.json +++ /dev/null @@ -1,1282 +0,0 @@ -{ - "id": "metricsEntities", - "client": { - "classes": [], - "functions": [], - "interfaces": [], - "enums": [], - "misc": [], - "objects": [] - }, - "server": { - "classes": [], - "functions": [], - "interfaces": [], - "enums": [], - "misc": [], - "objects": [], - "setup": { - "parentPluginId": "metricsEntities", - "id": "def-server.MetricsEntitiesPluginSetup", - "type": "Interface", - "tags": [], - "label": "MetricsEntitiesPluginSetup", - "description": [], - "path": "x-pack/plugins/metrics_entities/server/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "metricsEntities", - "id": "def-server.MetricsEntitiesPluginSetup.getMetricsEntitiesClient", - "type": "Function", - "tags": [], - "label": "getMetricsEntitiesClient", - "description": [], - "signature": [ - "(esClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ElasticsearchClient", - "text": "ElasticsearchClient" - }, - ") => ", - "MetricsEntitiesClient" - ], - "path": "x-pack/plugins/metrics_entities/server/types.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "metricsEntities", - "id": "def-server.MetricsEntitiesPluginSetup.getMetricsEntitiesClient.$1", - "type": "Object", - "tags": [], - "label": "esClient", - "description": [], - "signature": [ - "{ eql: ", - "default", - "; search: { >(this: That, params?: ", - "SearchRequest", - " | ", - "SearchRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "SearchResponse", - ">; >(this: That, params?: ", - "SearchRequest", - " | ", - "SearchRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "SearchResponse", - ", unknown>>; >(this: That, params?: ", - "SearchRequest", - " | ", - "SearchRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "SearchResponse", - ">; }; create: { (this: That, params: ", - "CreateRequest", - " | ", - "CreateRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "WriteResponseBase", - ">; (this: That, params: ", - "CreateRequest", - " | ", - "CreateRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "WriteResponseBase", - ", unknown>>; (this: That, params: ", - "CreateRequest", - " | ", - "CreateRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "WriteResponseBase", - ">; }; monitoring: ", - "default", - "; security: ", - "default", - "; name: string | symbol; index: { (this: That, params: ", - "IndexRequest", - " | ", - "IndexRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "WriteResponseBase", - ">; (this: That, params: ", - "IndexRequest", - " | ", - "IndexRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "WriteResponseBase", - ", unknown>>; (this: That, params: ", - "IndexRequest", - " | ", - "IndexRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "WriteResponseBase", - ">; }; delete: { (this: That, params: ", - "DeleteRequest", - " | ", - "DeleteRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "WriteResponseBase", - ">; (this: That, params: ", - "DeleteRequest", - " | ", - "DeleteRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "WriteResponseBase", - ", unknown>>; (this: That, params: ", - "DeleteRequest", - " | ", - "DeleteRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "WriteResponseBase", - ">; }; get: { (this: That, params: ", - "GetRequest", - " | ", - "GetRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "GetResponse", - ">; (this: That, params: ", - "GetRequest", - " | ", - "GetRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "GetResponse", - ", unknown>>; (this: That, params: ", - "GetRequest", - " | ", - "GetRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "GetResponse", - ">; }; update: { (this: That, params: ", - "UpdateRequest", - " | ", - "UpdateRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "UpdateResponse", - ">; (this: That, params: ", - "UpdateRequest", - " | ", - "UpdateRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "UpdateResponse", - ", unknown>>; (this: That, params: ", - "UpdateRequest", - " | ", - "UpdateRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "UpdateResponse", - ">; }; closePointInTime: { (this: That, params: ", - "ClosePointInTimeRequest", - " | ", - "ClosePointInTimeRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "ClosePointInTimeResponse", - ">; (this: That, params: ", - "ClosePointInTimeRequest", - " | ", - "ClosePointInTimeRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "ClosePointInTimeResponse", - ", unknown>>; (this: That, params: ", - "ClosePointInTimeRequest", - " | ", - "ClosePointInTimeRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "ClosePointInTimeResponse", - ">; }; helpers: ", - "default", - "; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", - "default", - "; child: (opts: ", - "ClientOptions", - ") => ", - "default", - "; Internal: ", - "default", - "; asyncSearch: ", - "default", - "; autoscaling: ", - "default", - "; bulk: { (this: That, params: ", - "BulkRequest", - " | ", - "BulkRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "BulkResponse", - ">; (this: That, params: ", - "BulkRequest", - " | ", - "BulkRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "BulkResponse", - ", unknown>>; (this: That, params: ", - "BulkRequest", - " | ", - "BulkRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "BulkResponse", - ">; }; cat: ", - "default", - "; ccr: ", - "default", - "; clearScroll: { (this: That, params?: ", - "ClearScrollRequest", - " | ", - "ClearScrollRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "ClearScrollResponse", - ">; (this: That, params?: ", - "ClearScrollRequest", - " | ", - "ClearScrollRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "ClearScrollResponse", - ", unknown>>; (this: That, params?: ", - "ClearScrollRequest", - " | ", - "ClearScrollRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "ClearScrollResponse", - ">; }; cluster: ", - "default", - "; count: { (this: That, params?: ", - "CountRequest", - " | ", - "CountRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "CountResponse", - ">; (this: That, params?: ", - "CountRequest", - " | ", - "CountRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "CountResponse", - ", unknown>>; (this: That, params?: ", - "CountRequest", - " | ", - "CountRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "CountResponse", - ">; }; danglingIndices: ", - "default", - "; deleteByQuery: { (this: That, params: ", - "DeleteByQueryRequest", - " | ", - "DeleteByQueryRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "DeleteByQueryResponse", - ">; (this: That, params: ", - "DeleteByQueryRequest", - " | ", - "DeleteByQueryRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "DeleteByQueryResponse", - ", unknown>>; (this: That, params: ", - "DeleteByQueryRequest", - " | ", - "DeleteByQueryRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "DeleteByQueryResponse", - ">; }; deleteByQueryRethrottle: { (this: That, params: ", - "DeleteByQueryRethrottleRequest", - " | ", - "DeleteByQueryRethrottleRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "TasksTaskListResponseBase", - ">; (this: That, params: ", - "DeleteByQueryRethrottleRequest", - " | ", - "DeleteByQueryRethrottleRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "TasksTaskListResponseBase", - ", unknown>>; (this: That, params: ", - "DeleteByQueryRethrottleRequest", - " | ", - "DeleteByQueryRethrottleRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "TasksTaskListResponseBase", - ">; }; deleteScript: { (this: That, params: ", - "DeleteScriptRequest", - " | ", - "DeleteScriptRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "AcknowledgedResponseBase", - ">; (this: That, params: ", - "DeleteScriptRequest", - " | ", - "DeleteScriptRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "AcknowledgedResponseBase", - ", unknown>>; (this: That, params: ", - "DeleteScriptRequest", - " | ", - "DeleteScriptRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "AcknowledgedResponseBase", - ">; }; enrich: ", - "default", - "; exists: { (this: That, params: ", - "ExistsRequest", - " | ", - "ExistsRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params: ", - "ExistsRequest", - " | ", - "ExistsRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params: ", - "ExistsRequest", - " | ", - "ExistsRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; existsSource: { (this: That, params: ", - "ExistsSourceRequest", - " | ", - "ExistsSourceRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params: ", - "ExistsSourceRequest", - " | ", - "ExistsSourceRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params: ", - "ExistsSourceRequest", - " | ", - "ExistsSourceRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; explain: { (this: That, params: ", - "ExplainRequest", - " | ", - "ExplainRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "ExplainResponse", - ">; (this: That, params: ", - "ExplainRequest", - " | ", - "ExplainRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "ExplainResponse", - ", unknown>>; (this: That, params: ", - "ExplainRequest", - " | ", - "ExplainRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "ExplainResponse", - ">; }; features: ", - "default", - "; fieldCaps: { (this: That, params: ", - "FieldCapsRequest", - " | ", - "FieldCapsRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "FieldCapsResponse", - ">; (this: That, params: ", - "FieldCapsRequest", - " | ", - "FieldCapsRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "FieldCapsResponse", - ", unknown>>; (this: That, params: ", - "FieldCapsRequest", - " | ", - "FieldCapsRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "FieldCapsResponse", - ">; }; fleet: ", - "default", - "; getScript: { (this: That, params: ", - "GetScriptRequest", - " | ", - "GetScriptRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "GetScriptResponse", - ">; (this: That, params: ", - "GetScriptRequest", - " | ", - "GetScriptRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "GetScriptResponse", - ", unknown>>; (this: That, params: ", - "GetScriptRequest", - " | ", - "GetScriptRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "GetScriptResponse", - ">; }; getScriptContext: { (this: That, params?: ", - "GetScriptContextRequest", - " | ", - "GetScriptContextRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "GetScriptContextResponse", - ">; (this: That, params?: ", - "GetScriptContextRequest", - " | ", - "GetScriptContextRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "GetScriptContextResponse", - ", unknown>>; (this: That, params?: ", - "GetScriptContextRequest", - " | ", - "GetScriptContextRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "GetScriptContextResponse", - ">; }; getScriptLanguages: { (this: That, params?: ", - "GetScriptLanguagesRequest", - " | ", - "GetScriptLanguagesRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "GetScriptLanguagesResponse", - ">; (this: That, params?: ", - "GetScriptLanguagesRequest", - " | ", - "GetScriptLanguagesRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "GetScriptLanguagesResponse", - ", unknown>>; (this: That, params?: ", - "GetScriptLanguagesRequest", - " | ", - "GetScriptLanguagesRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "GetScriptLanguagesResponse", - ">; }; getSource: { (this: That, params: ", - "GetSourceRequest", - " | ", - "GetSourceRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params: ", - "GetSourceRequest", - " | ", - "GetSourceRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params: ", - "GetSourceRequest", - " | ", - "GetSourceRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; graph: ", - "default", - "; ilm: ", - "default", - "; indices: ", - "default", - "; info: { (this: That, params?: ", - "InfoRequest", - " | ", - "InfoRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "InfoResponse", - ">; (this: That, params?: ", - "InfoRequest", - " | ", - "InfoRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "InfoResponse", - ", unknown>>; (this: That, params?: ", - "InfoRequest", - " | ", - "InfoRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "InfoResponse", - ">; }; ingest: ", - "default", - "; knnSearch: { (this: That, params: ", - "KnnSearchRequest", - " | ", - "KnnSearchRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "KnnSearchResponse", - ">; (this: That, params: ", - "KnnSearchRequest", - " | ", - "KnnSearchRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "KnnSearchResponse", - ", unknown>>; (this: That, params: ", - "KnnSearchRequest", - " | ", - "KnnSearchRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "KnnSearchResponse", - ">; }; license: ", - "default", - "; logstash: ", - "default", - "; mget: { (this: That, params?: ", - "MgetRequest", - " | ", - "MgetRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "MgetResponse", - ">; (this: That, params?: ", - "MgetRequest", - " | ", - "MgetRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "MgetResponse", - ", unknown>>; (this: That, params?: ", - "MgetRequest", - " | ", - "MgetRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "MgetResponse", - ">; }; migration: ", - "default", - "; ml: ", - "default", - "; msearch: { >(this: That, params: ", - "MsearchRequest", - " | ", - "MsearchRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "MsearchResponse", - ">; >(this: That, params: ", - "MsearchRequest", - " | ", - "MsearchRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "MsearchResponse", - ", unknown>>; >(this: That, params: ", - "MsearchRequest", - " | ", - "MsearchRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "MsearchResponse", - ">; }; msearchTemplate: { >(this: That, params: ", - "MsearchTemplateRequest", - " | ", - "MsearchTemplateRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "MsearchTemplateResponse", - ">; >(this: That, params: ", - "MsearchTemplateRequest", - " | ", - "MsearchTemplateRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "MsearchTemplateResponse", - ", unknown>>; >(this: That, params: ", - "MsearchTemplateRequest", - " | ", - "MsearchTemplateRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "MsearchTemplateResponse", - ">; }; mtermvectors: { (this: That, params?: ", - "MtermvectorsRequest", - " | ", - "MtermvectorsRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "MtermvectorsResponse", - ">; (this: That, params?: ", - "MtermvectorsRequest", - " | ", - "MtermvectorsRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "MtermvectorsResponse", - ", unknown>>; (this: That, params?: ", - "MtermvectorsRequest", - " | ", - "MtermvectorsRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "MtermvectorsResponse", - ">; }; nodes: ", - "default", - "; openPointInTime: { (this: That, params: ", - "OpenPointInTimeRequest", - " | ", - "OpenPointInTimeRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "OpenPointInTimeResponse", - ">; (this: That, params: ", - "OpenPointInTimeRequest", - " | ", - "OpenPointInTimeRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "OpenPointInTimeResponse", - ", unknown>>; (this: That, params: ", - "OpenPointInTimeRequest", - " | ", - "OpenPointInTimeRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "OpenPointInTimeResponse", - ">; }; ping: { (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params?: ", - "PingRequest", - " | ", - "PingRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; putScript: { (this: That, params: ", - "PutScriptRequest", - " | ", - "PutScriptRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "AcknowledgedResponseBase", - ">; (this: That, params: ", - "PutScriptRequest", - " | ", - "PutScriptRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "AcknowledgedResponseBase", - ", unknown>>; (this: That, params: ", - "PutScriptRequest", - " | ", - "PutScriptRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "AcknowledgedResponseBase", - ">; }; rankEval: { (this: That, params: ", - "RankEvalRequest", - " | ", - "RankEvalRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "RankEvalResponse", - ">; (this: That, params: ", - "RankEvalRequest", - " | ", - "RankEvalRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "RankEvalResponse", - ", unknown>>; (this: That, params: ", - "RankEvalRequest", - " | ", - "RankEvalRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "RankEvalResponse", - ">; }; reindex: { (this: That, params: ", - "ReindexRequest", - " | ", - "ReindexRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "ReindexResponse", - ">; (this: That, params: ", - "ReindexRequest", - " | ", - "ReindexRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "ReindexResponse", - ", unknown>>; (this: That, params: ", - "ReindexRequest", - " | ", - "ReindexRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "ReindexResponse", - ">; }; reindexRethrottle: { (this: That, params: ", - "ReindexRethrottleRequest", - " | ", - "ReindexRethrottleRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "ReindexRethrottleResponse", - ">; (this: That, params: ", - "ReindexRethrottleRequest", - " | ", - "ReindexRethrottleRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "ReindexRethrottleResponse", - ", unknown>>; (this: That, params: ", - "ReindexRethrottleRequest", - " | ", - "ReindexRethrottleRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "ReindexRethrottleResponse", - ">; }; renderSearchTemplate: { (this: That, params?: ", - "RenderSearchTemplateRequest", - " | ", - "RenderSearchTemplateRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "RenderSearchTemplateResponse", - ">; (this: That, params?: ", - "RenderSearchTemplateRequest", - " | ", - "RenderSearchTemplateRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "RenderSearchTemplateResponse", - ", unknown>>; (this: That, params?: ", - "RenderSearchTemplateRequest", - " | ", - "RenderSearchTemplateRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "RenderSearchTemplateResponse", - ">; }; rollup: ", - "default", - "; scriptsPainlessExecute: { (this: That, params?: ", - "ScriptsPainlessExecuteRequest", - " | ", - "ScriptsPainlessExecuteRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "ScriptsPainlessExecuteResponse", - ">; (this: That, params?: ", - "ScriptsPainlessExecuteRequest", - " | ", - "ScriptsPainlessExecuteRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "ScriptsPainlessExecuteResponse", - ", unknown>>; (this: That, params?: ", - "ScriptsPainlessExecuteRequest", - " | ", - "ScriptsPainlessExecuteRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "ScriptsPainlessExecuteResponse", - ">; }; scroll: { >(this: That, params: ", - "ScrollRequest", - " | ", - "ScrollRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "ScrollResponse", - ">; >(this: That, params: ", - "ScrollRequest", - " | ", - "ScrollRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "ScrollResponse", - ", unknown>>; >(this: That, params: ", - "ScrollRequest", - " | ", - "ScrollRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "ScrollResponse", - ">; }; searchMvt: { (this: That, params: ", - "SearchMvtRequest", - " | ", - "SearchMvtRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise; (this: That, params: ", - "SearchMvtRequest", - " | ", - "SearchMvtRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - ">; (this: That, params: ", - "SearchMvtRequest", - " | ", - "SearchMvtRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise; }; searchShards: { (this: That, params?: ", - "SearchShardsRequest", - " | ", - "SearchShardsRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "SearchShardsResponse", - ">; (this: That, params?: ", - "SearchShardsRequest", - " | ", - "SearchShardsRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "SearchShardsResponse", - ", unknown>>; (this: That, params?: ", - "SearchShardsRequest", - " | ", - "SearchShardsRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "SearchShardsResponse", - ">; }; searchTemplate: { (this: That, params?: ", - "SearchTemplateRequest", - " | ", - "SearchTemplateRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "SearchTemplateResponse", - ">; (this: That, params?: ", - "SearchTemplateRequest", - " | ", - "SearchTemplateRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "SearchTemplateResponse", - ", unknown>>; (this: That, params?: ", - "SearchTemplateRequest", - " | ", - "SearchTemplateRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "SearchTemplateResponse", - ">; }; searchableSnapshots: ", - "default", - "; shutdown: ", - "default", - "; slm: ", - "default", - "; snapshot: ", - "default", - "; sql: ", - "default", - "; ssl: ", - "default", - "; tasks: ", - "default", - "; termsEnum: { (this: That, params: ", - "TermsEnumRequest", - " | ", - "TermsEnumRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "TermsEnumResponse", - ">; (this: That, params: ", - "TermsEnumRequest", - " | ", - "TermsEnumRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "TermsEnumResponse", - ", unknown>>; (this: That, params: ", - "TermsEnumRequest", - " | ", - "TermsEnumRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "TermsEnumResponse", - ">; }; termvectors: { (this: That, params: ", - "TermvectorsRequest", - " | ", - "TermvectorsRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "TermvectorsResponse", - ">; (this: That, params: ", - "TermvectorsRequest", - " | ", - "TermvectorsRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "TermvectorsResponse", - ", unknown>>; (this: That, params: ", - "TermvectorsRequest", - " | ", - "TermvectorsRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "TermvectorsResponse", - ">; }; textStructure: ", - "default", - "; transform: ", - "default", - "; updateByQuery: { (this: That, params: ", - "UpdateByQueryRequest", - " | ", - "UpdateByQueryRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "UpdateByQueryResponse", - ">; (this: That, params: ", - "UpdateByQueryRequest", - " | ", - "UpdateByQueryRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "UpdateByQueryResponse", - ", unknown>>; (this: That, params: ", - "UpdateByQueryRequest", - " | ", - "UpdateByQueryRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "UpdateByQueryResponse", - ">; }; updateByQueryRethrottle: { (this: That, params: ", - "UpdateByQueryRethrottleRequest", - " | ", - "UpdateByQueryRethrottleRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "UpdateByQueryRethrottleResponse", - ">; (this: That, params: ", - "UpdateByQueryRethrottleRequest", - " | ", - "UpdateByQueryRethrottleRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "UpdateByQueryRethrottleResponse", - ", unknown>>; (this: That, params: ", - "UpdateByQueryRethrottleRequest", - " | ", - "UpdateByQueryRethrottleRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "UpdateByQueryRethrottleResponse", - ">; }; watcher: ", - "default", - "; xpack: ", - "default", - "; }" - ], - "path": "x-pack/plugins/metrics_entities/server/types.ts", - "deprecated": false - } - ] - } - ], - "lifecycle": "setup", - "initialIsOpen": true - }, - "start": { - "parentPluginId": "metricsEntities", - "id": "def-server.MetricsEntitiesPluginStart", - "type": "Type", - "tags": [], - "label": "MetricsEntitiesPluginStart", - "description": [], - "signature": [ - "void" - ], - "path": "x-pack/plugins/metrics_entities/server/types.ts", - "deprecated": false, - "lifecycle": "start", - "initialIsOpen": true - } - }, - "common": { - "classes": [], - "functions": [], - "interfaces": [], - "enums": [], - "misc": [], - "objects": [] - } -} \ No newline at end of file diff --git a/api_docs/metrics_entities.mdx b/api_docs/metrics_entities.mdx deleted file mode 100644 index cbe21f8f4da51..0000000000000 --- a/api_docs/metrics_entities.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: kibMetricsEntitiesPluginApi -slug: /kibana-dev-docs/api/metricsEntities -title: "metricsEntities" -image: https://source.unsplash.com/400x175/?github -summary: API docs for the metricsEntities plugin -date: 2022-04-05 -tags: ['contributor', 'dev', 'apidocs', 'kibana', 'metricsEntities'] -warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. ---- -import metricsEntitiesObj from './metrics_entities.devdocs.json'; - - - -Contact [Security solution](https://github.com/orgs/elastic/teams/security-solution) for questions regarding this plugin. - -**Code health stats** - -| Public API count | Any count | Items lacking comments | Missing exports | -|-------------------|-----------|------------------------|-----------------| -| 4 | 0 | 4 | 1 | - -## Server - -### Setup - - -### Start - - diff --git a/api_docs/ml.mdx b/api_docs/ml.mdx index f78b0773ab8b7..c53f258b23ce2 100644 --- a/api_docs/ml.mdx +++ b/api_docs/ml.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/ml title: "ml" image: https://source.unsplash.com/400x175/?github summary: API docs for the ml plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ml'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/monitoring.mdx b/api_docs/monitoring.mdx index 9d4656621ad0b..f4ccaa0afb22f 100644 --- a/api_docs/monitoring.mdx +++ b/api_docs/monitoring.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/monitoring title: "monitoring" image: https://source.unsplash.com/400x175/?github summary: API docs for the monitoring plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'monitoring'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/monitoring_collection.mdx b/api_docs/monitoring_collection.mdx index fd085531e49d8..6862c66127338 100644 --- a/api_docs/monitoring_collection.mdx +++ b/api_docs/monitoring_collection.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/monitoringCollection title: "monitoringCollection" image: https://source.unsplash.com/400x175/?github summary: API docs for the monitoringCollection plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'monitoringCollection'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/navigation.devdocs.json b/api_docs/navigation.devdocs.json index 7512f5d4cd86e..8c183c4b321ad 100644 --- a/api_docs/navigation.devdocs.json +++ b/api_docs/navigation.devdocs.json @@ -143,7 +143,7 @@ "label": "start", "description": [], "signature": [ - "({ i18n }: ", + "(core: ", { "pluginId": "core", "scope": "public", @@ -170,7 +170,7 @@ "id": "def-public.NavigationPublicPlugin.start.$1", "type": "Object", "tags": [], - "label": "{ i18n }", + "label": "core", "description": [], "signature": [ { @@ -410,9 +410,9 @@ "DisambiguateSet", "<(", "DisambiguateSet", - " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"onClick\" | \"color\" | \"href\">) | (", + " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"color\" | \"onClick\" | \"href\">) | (", "DisambiguateSet", - " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"onClick\" | \"color\">), WithSpanProps> & WithSpanProps & { iconType?: ", + " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"color\" | \"onClick\">), WithSpanProps> & WithSpanProps & { iconType?: ", "IconType", " | undefined; label: React.ReactNode; tooltipContent?: React.ReactNode; tooltipPosition?: ", "ToolTipPositions", @@ -426,9 +426,9 @@ "DisambiguateSet", "<(", "DisambiguateSet", - " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"onClick\" | \"color\" | \"href\">) | (", + " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"color\" | \"onClick\" | \"href\">) | (", "DisambiguateSet", - " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"onClick\" | \"color\">), WithSpanProps> & WithSpanProps & { iconType?: ", + " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"color\" | \"onClick\">), WithSpanProps> & WithSpanProps & { iconType?: ", "IconType", " | undefined; label: React.ReactNode; tooltipContent?: React.ReactNode; tooltipPosition?: ", "ToolTipPositions", @@ -444,11 +444,11 @@ "DisambiguateSet", " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"onClick\" | \"color\" | \"href\">) | (", + " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"color\" | \"onClick\" | \"href\">) | (", "DisambiguateSet", - " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"onClick\" | \"color\">)> & ", + " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"color\" | \"onClick\">)> & ", "DisambiguateSet", - " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"onClick\" | \"color\" | \"href\"> & { iconType?: ", + " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"color\" | \"onClick\" | \"href\"> & { iconType?: ", "IconType", " | undefined; label: React.ReactNode; tooltipContent?: React.ReactNode; tooltipPosition?: ", "ToolTipPositions", @@ -462,11 +462,11 @@ "DisambiguateSet", " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"onClick\" | \"color\" | \"href\">) | (", + " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"color\" | \"onClick\" | \"href\">) | (", "DisambiguateSet", - " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"onClick\" | \"color\">)> & ", + " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"color\" | \"onClick\">)> & ", "DisambiguateSet", - " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"onClick\" | \"color\" | \"href\"> & { iconType?: ", + " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"color\" | \"onClick\" | \"href\"> & { iconType?: ", "IconType", " | undefined; label: React.ReactNode; tooltipContent?: React.ReactNode; tooltipPosition?: ", "ToolTipPositions", @@ -482,11 +482,11 @@ "DisambiguateSet", " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"onClick\" | \"color\" | \"href\">) | (", + " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"color\" | \"onClick\" | \"href\">) | (", "DisambiguateSet", - " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"onClick\" | \"color\">)> & ", + " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"color\" | \"onClick\">)> & ", "DisambiguateSet", - " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"onClick\" | \"color\" | \"href\"> & { iconType?: ", + " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"color\" | \"onClick\" | \"href\"> & { iconType?: ", "IconType", " | undefined; label: React.ReactNode; tooltipContent?: React.ReactNode; tooltipPosition?: ", "ToolTipPositions", @@ -502,11 +502,11 @@ "DisambiguateSet", " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"onClick\" | \"color\" | \"href\">) | (", + " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"color\" | \"onClick\" | \"href\">) | (", "DisambiguateSet", - " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"onClick\" | \"color\">)> & ", + " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"color\" | \"onClick\">)> & ", "DisambiguateSet", - " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"onClick\" | \"color\"> & { iconType?: ", + " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"color\" | \"onClick\"> & { iconType?: ", "IconType", " | undefined; label: React.ReactNode; tooltipContent?: React.ReactNode; tooltipPosition?: ", "ToolTipPositions", @@ -520,11 +520,11 @@ "DisambiguateSet", " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"onClick\" | \"color\" | \"href\">) | (", + " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"color\" | \"onClick\" | \"href\">) | (", "DisambiguateSet", - " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"onClick\" | \"color\">)> & ", + " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"color\" | \"onClick\">)> & ", "DisambiguateSet", - " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"onClick\" | \"color\"> & { iconType?: ", + " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"color\" | \"onClick\"> & { iconType?: ", "IconType", " | undefined; label: React.ReactNode; tooltipContent?: React.ReactNode; tooltipPosition?: ", "ToolTipPositions", @@ -540,11 +540,11 @@ "DisambiguateSet", " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"onClick\" | \"color\" | \"href\">) | (", + " & { href: string; target?: string | undefined; rel?: string | undefined; } & Omit, \"color\" | \"onClick\" | \"href\">) | (", "DisambiguateSet", - " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"onClick\" | \"color\">)> & ", + " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"color\" | \"onClick\">)> & ", "DisambiguateSet", - " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"onClick\" | \"color\"> & { iconType?: ", + " & { onClick?: React.MouseEventHandler | undefined; onClickAriaLabel?: string | undefined; } & Omit, \"color\" | \"onClick\"> & { iconType?: ", "IconType", " | undefined; label: React.ReactNode; tooltipContent?: React.ReactNode; tooltipPosition?: ", "ToolTipPositions", diff --git a/api_docs/navigation.mdx b/api_docs/navigation.mdx index 5c0088964dbc6..a7aee0a91e834 100644 --- a/api_docs/navigation.mdx +++ b/api_docs/navigation.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/navigation title: "navigation" image: https://source.unsplash.com/400x175/?github summary: API docs for the navigation plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'navigation'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/newsfeed.mdx b/api_docs/newsfeed.mdx index 1e3cfb7a6fa96..9dc6262d29612 100644 --- a/api_docs/newsfeed.mdx +++ b/api_docs/newsfeed.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/newsfeed title: "newsfeed" image: https://source.unsplash.com/400x175/?github summary: API docs for the newsfeed plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'newsfeed'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/observability.devdocs.json b/api_docs/observability.devdocs.json index 6dde3e0820d9a..1167181e14f56 100644 --- a/api_docs/observability.devdocs.json +++ b/api_docs/observability.devdocs.json @@ -678,9 +678,9 @@ }, " | undefined; }; selectedAlertId?: string | undefined; } & ", "CommonProps", - " & { as?: \"div\" | undefined; } & _EuiFlyoutProps & Omit, HTMLDivElement>, keyof _EuiFlyoutProps> & Omit, HTMLDivElement>, \"key\" | \"css\" | keyof React.HTMLAttributes> & { ref?: React.RefObject | ((instance: HTMLDivElement | null) => void) | null | undefined; }, \"children\" | \"onClick\" | \"onChange\" | \"color\" | \"onKeyDown\" | \"title\" | \"id\" | \"security\" | \"defaultValue\" | \"hidden\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"lang\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"as\" | keyof ", + " & { as?: \"div\" | undefined; } & _EuiFlyoutProps & Omit, HTMLDivElement>, keyof _EuiFlyoutProps> & Omit, HTMLDivElement>, \"key\" | \"css\" | keyof React.HTMLAttributes> & { ref?: React.RefObject | ((instance: HTMLDivElement | null) => void) | null | undefined; }, \"children\" | \"color\" | \"title\" | \"onChange\" | \"onKeyDown\" | \"onClick\" | \"id\" | \"security\" | \"defaultValue\" | \"hidden\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"lang\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"as\" | keyof ", "CommonProps", - " | keyof React.ClassAttributes | keyof _EuiFlyoutProps>, \"children\" | \"onClick\" | \"onChange\" | \"color\" | \"onKeyDown\" | \"alert\" | \"key\" | \"title\" | \"id\" | \"css\" | \"security\" | \"defaultValue\" | \"hidden\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"lang\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"as\" | keyof ", + " | keyof React.ClassAttributes | keyof _EuiFlyoutProps>, \"children\" | \"alert\" | \"color\" | \"title\" | \"onChange\" | \"onKeyDown\" | \"onClick\" | \"key\" | \"id\" | \"css\" | \"security\" | \"defaultValue\" | \"hidden\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"lang\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"as\" | keyof ", "CommonProps", " | \"alerts\" | keyof _EuiFlyoutProps | \"isInApp\" | \"observabilityRuleTypeRegistry\" | \"selectedAlertId\"> & { ref?: React.RefObject | ((instance: HTMLDivElement | null) => void) | null | undefined; }> & { readonly _result: ({ alert, alerts, isInApp, observabilityRuleTypeRegistry, onClose, selectedAlertId, }: AlertsFlyoutProps) => JSX.Element | null; }" ], @@ -3683,13 +3683,7 @@ "label": "palette", "description": [], "signature": [ - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteOutput", - "text": "PaletteOutput" - }, + "PaletteOutput", "<{ [key: string]: unknown; }> | undefined" ], "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts", @@ -4798,7 +4792,7 @@ "DisambiguateSet", ", Omit, \"href\">> & Omit, \"href\">) | (", "DisambiguateSet", - ", \"href\">, React.ButtonHTMLAttributes> & React.ButtonHTMLAttributes))), \"onClick\" | \"color\" | \"rel\" | \"target\"> & { size?: ItemSize | undefined; color?: Color | undefined; label: React.ReactNode; isActive?: boolean | undefined; isDisabled?: boolean | undefined; href?: string | undefined; target?: string | undefined; rel?: string | undefined; iconType?: ", + ", \"href\">, React.ButtonHTMLAttributes> & React.ButtonHTMLAttributes))), \"color\" | \"onClick\" | \"rel\" | \"target\"> & { size?: ItemSize | undefined; color?: Color | undefined; label: React.ReactNode; isActive?: boolean | undefined; isDisabled?: boolean | undefined; href?: string | undefined; target?: string | undefined; rel?: string | undefined; iconType?: ", "IconType", " | undefined; iconProps?: Omit<", "EuiIconProps", @@ -6859,12 +6853,35 @@ { "parentPluginId": "observability", "id": "def-server.ObservabilityRouteHandlerResources.context", - "type": "Object", + "type": "CompoundType", "tags": [], "label": "context", "description": [], "signature": [ - "ObservabilityRequestHandlerContext" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.RequestHandlerContext", + "text": "RequestHandlerContext" + }, + " & { licensing: Promise<", + { + "pluginId": "licensing", + "scope": "server", + "docId": "kibLicensingPluginApi", + "section": "def-server.LicensingApiRequestHandlerContext", + "text": "LicensingApiRequestHandlerContext" + }, + ">; alerting: Promise<", + { + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.AlertingApiRequestHandlerContext", + "text": "AlertingApiRequestHandlerContext" + }, + ">; }" ], "path": "x-pack/plugins/observability/server/routes/types.ts", "deprecated": false @@ -7077,7 +7094,7 @@ "section": "def-server.RequestHandlerContext", "text": "RequestHandlerContext" }, - " & { licensing: ", + " & { licensing: Promise<", { "pluginId": "licensing", "scope": "server", @@ -7085,7 +7102,7 @@ "section": "def-server.LicensingApiRequestHandlerContext", "text": "LicensingApiRequestHandlerContext" }, - "; }, request: ", + ">; }, request: ", { "pluginId": "core", "scope": "server", @@ -7168,11 +7185,82 @@ ], "returnComment": [], "initialIsOpen": false + }, + { + "parentPluginId": "observability", + "id": "def-common.getProbabilityFromProgressiveLoadingQuality", + "type": "Function", + "tags": [], + "label": "getProbabilityFromProgressiveLoadingQuality", + "description": [], + "signature": [ + "(quality: ", + { + "pluginId": "observability", + "scope": "common", + "docId": "kibObservabilityPluginApi", + "section": "def-common.ProgressiveLoadingQuality", + "text": "ProgressiveLoadingQuality" + }, + ") => number" + ], + "path": "x-pack/plugins/observability/common/progressive_loading.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "observability", + "id": "def-common.getProbabilityFromProgressiveLoadingQuality.$1", + "type": "Enum", + "tags": [], + "label": "quality", + "description": [], + "signature": [ + { + "pluginId": "observability", + "scope": "common", + "docId": "kibObservabilityPluginApi", + "section": "def-common.ProgressiveLoadingQuality", + "text": "ProgressiveLoadingQuality" + } + ], + "path": "x-pack/plugins/observability/common/progressive_loading.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false } ], "interfaces": [], - "enums": [], + "enums": [ + { + "parentPluginId": "observability", + "id": "def-common.ProgressiveLoadingQuality", + "type": "Enum", + "tags": [], + "label": "ProgressiveLoadingQuality", + "description": [], + "path": "x-pack/plugins/observability/common/progressive_loading.ts", + "deprecated": false, + "initialIsOpen": false + } + ], "misc": [ + { + "parentPluginId": "observability", + "id": "def-common.apmProgressiveLoading", + "type": "string", + "tags": [], + "label": "apmProgressiveLoading", + "description": [], + "signature": [ + "\"observability:apmProgressiveLoading\"" + ], + "path": "x-pack/plugins/observability/common/ui_settings_keys.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "observability", "id": "def-common.apmServiceInventoryOptimizedSorting", diff --git a/api_docs/observability.mdx b/api_docs/observability.mdx index 9675c6927423c..958f5d5f0f061 100644 --- a/api_docs/observability.mdx +++ b/api_docs/observability.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/observability title: "observability" image: https://source.unsplash.com/400x175/?github summary: API docs for the observability plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'observability'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Observability UI](https://github.com/orgs/elastic/teams/observability-u | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 369 | 2 | 366 | 31 | +| 373 | 2 | 370 | 30 | ## Client @@ -62,6 +62,9 @@ Contact [Observability UI](https://github.com/orgs/elastic/teams/observability-u ### Functions +### Enums + + ### Consts, variables and types diff --git a/api_docs/osquery.mdx b/api_docs/osquery.mdx index 7c84da2e6ca7a..e5785b58293ea 100644 --- a/api_docs/osquery.mdx +++ b/api_docs/osquery.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/osquery title: "osquery" image: https://source.unsplash.com/400x175/?github summary: API docs for the osquery plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'osquery'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/plugin_directory.mdx b/api_docs/plugin_directory.mdx index 84e92c68c5944..f43ac68f5f298 100644 --- a/api_docs/plugin_directory.mdx +++ b/api_docs/plugin_directory.mdx @@ -3,7 +3,7 @@ id: kibDevDocsPluginDirectory slug: /kibana-dev-docs/api-meta/plugin-api-directory title: Directory summary: Directory of public APIs available through plugins or packages. -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -12,37 +12,37 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Count | Plugins or Packages with a
public API | Number of teams | |--------------|----------|------------------------| -| 231 | 188 | 35 | +| 247 | 201 | 35 | ### Public API health stats | API Count | Any Count | Missing comments | Missing exports | |--------------|----------|-----------------|--------| -| 25613 | 171 | 19521 | 1128 | +| 25958 | 170 | 19687 | 1153 | ## Plugin Directory | Plugin name           | Maintaining team | Description | API Cnt | Any Cnt | Missing
comments | Missing
exports | |--------------|----------------|-----------|--------------|----------|---------------|--------| -| | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 127 | 0 | 127 | 10 | +| | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 195 | 0 | 191 | 11 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 23 | 0 | 19 | 1 | -| | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 334 | 0 | 325 | 20 | +| | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 325 | 0 | 316 | 19 | | | [APM UI](https://github.com/orgs/elastic/teams/apm-ui) | The user interface for Elastic APM | 40 | 0 | 40 | 50 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 9 | 0 | 9 | 0 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Considering using bfetch capabilities when fetching large amounts of data. This services supports batching HTTP requests and streaming responses back. | 78 | 1 | 69 | 2 | | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds Canvas application to Kibana | 9 | 0 | 8 | 3 | -| | [ResponseOps](https://github.com/orgs/elastic/teams/response-ops) | The Case management system in Kibana | 71 | 0 | 58 | 19 | -| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | - | 322 | 2 | 289 | 4 | +| | [ResponseOps](https://github.com/orgs/elastic/teams/response-ops) | The Case management system in Kibana | 71 | 0 | 57 | 19 | +| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | - | 272 | 2 | 253 | 9 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 28 | 0 | 23 | 0 | | | [Cloud Security Posture](https://github.com/orgs/elastic/teams/cloud-posture-security) | The cloud security posture plugin | 14 | 0 | 14 | 0 | | | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 13 | 0 | 13 | 1 | -| | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | The Controls Plugin contains embeddable components intended to create a simple query interface for end users, and a powerful editing suite that allows dashboard authors to build controls | 188 | 0 | 182 | 4 | -| | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 2497 | 15 | 971 | 33 | +| | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | The Controls Plugin contains embeddable components intended to create a simple query interface for end users, and a powerful editing suite that allows dashboard authors to build controls | 203 | 0 | 197 | 6 | +| | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 2524 | 15 | 977 | 33 | | crossClusterReplication | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 | | | [Fleet](https://github.com/orgs/elastic/teams/fleet) | Add custom data integrations so they can be displayed in the Fleet integrations app | 98 | 0 | 79 | 1 | -| | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds the Dashboard app to Kibana | 151 | 0 | 149 | 14 | +| | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds the Dashboard app to Kibana | 142 | 0 | 140 | 12 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 52 | 0 | 51 | 0 | -| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters. | 3426 | 40 | 2816 | 20 | +| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters. | 3414 | 38 | 2802 | 18 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Enhanced data plugin. (See src/plugins/data.) Enhances the main data plugin with a search session management UI. Includes a reusable search session indicator component to use in other applications. Exposes routes for managing search sessions. Includes a service that monitors, updates, and cleans up search session saved objects. | 16 | 0 | 16 | 2 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | This plugin provides the ability to create data views via a modal flyout from any kibana app | 13 | 0 | 7 | 0 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Reusable data view field editor across Kibana | 42 | 0 | 37 | 3 | @@ -50,7 +50,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters. | 862 | 3 | 710 | 15 | | | [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) | The Data Visualizer tools help you understand your data, by analyzing the metrics and fields in a log file or an existing Elasticsearch index. | 23 | 2 | 19 | 1 | | | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 10 | 0 | 8 | 2 | -| | [Data Discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | This plugin contains the Discover application and the saved search embeddable. | 77 | 0 | 61 | 7 | +| | [Data Discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | This plugin contains the Discover application and the saved search embeddable. | 76 | 0 | 60 | 7 | | | [Data Discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | - | 37 | 0 | 35 | 2 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds embeddables service to Kibana | 476 | 0 | 386 | 4 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Extends embeddable plugin with more functionality | 14 | 0 | 14 | 0 | @@ -60,8 +60,8 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | The Event Annotation service contains expressions for event annotations | 49 | 0 | 49 | 3 | | | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 91 | 0 | 91 | 9 | | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds 'error' renderer to expressions | 17 | 0 | 15 | 2 | -| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Expression Gauge plugin adds a `gauge` renderer and function to the expression plugin. The renderer will display the `gauge` chart. | 76 | 0 | 76 | 2 | -| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Expression Heatmap plugin adds a `heatmap` renderer and function to the expression plugin. The renderer will display the `heatmap` chart. | 119 | 0 | 115 | 3 | +| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Expression Gauge plugin adds a `gauge` renderer and function to the expression plugin. The renderer will display the `gauge` chart. | 61 | 0 | 61 | 2 | +| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Expression Heatmap plugin adds a `heatmap` renderer and function to the expression plugin. The renderer will display the `heatmap` chart. | 104 | 0 | 100 | 3 | | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds 'image' function and renderer to expressions | 26 | 0 | 26 | 0 | | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds 'metric' function and renderer to expressions | 32 | 0 | 27 | 0 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Expression MetricVis plugin adds a `metric` renderer and function to the expression plugin. The renderer will display the `metric` chart. | 46 | 0 | 46 | 1 | @@ -71,11 +71,11 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds 'shape' function and renderer to expressions | 148 | 0 | 146 | 0 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Expression Tagcloud plugin adds a `tagcloud` renderer and function to the expression plugin. The renderer will display the `Wordcloud` chart. | 7 | 0 | 7 | 0 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Expression XY plugin adds a `xy` renderer and function to the expression plugin. The renderer will display the `xy` chart. | 473 | 0 | 463 | 0 | -| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds expression runtime to Kibana | 2145 | 17 | 1701 | 6 | +| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds expression runtime to Kibana | 2158 | 17 | 1713 | 5 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 222 | 0 | 95 | 2 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Index pattern fields and ambiguous values formatters | 286 | 6 | 247 | 3 | | | [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) | The file upload plugin contains components and services for uploading a file, analyzing its data, and then importing the data into an Elasticsearch index. Supported file types include CSV, TSV, newline-delimited JSON and GeoJSON. | 62 | 0 | 62 | 2 | -| | [Fleet](https://github.com/orgs/elastic/teams/fleet) | - | 1379 | 8 | 1262 | 9 | +| | [Fleet](https://github.com/orgs/elastic/teams/fleet) | - | 1385 | 8 | 1268 | 10 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 68 | 0 | 14 | 5 | | globalSearchBar | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 0 | 0 | 0 | 0 | | globalSearchProviders | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 0 | 0 | 0 | 0 | @@ -90,25 +90,24 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 123 | 2 | 96 | 4 | | | [Platform Security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides UI and APIs for the interactive setup mode. | 28 | 0 | 18 | 0 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 6 | 0 | 6 | 0 | -| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 239 | 0 | 203 | 5 | +| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 240 | 0 | 204 | 5 | | kibanaUsageCollection | [Kibana Telemetry](https://github.com/orgs/elastic/teams/kibana-telemetry) | - | 0 | 0 | 0 | 0 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 615 | 3 | 420 | 9 | -| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Visualization editor allowing to quickly and easily configure compelling visualizations to use on dashboards and canvas workpads. Exposes components to embed visualizations and link into the Lens editor from within other apps in Kibana. | 542 | 0 | 467 | 29 | +| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Visualization editor allowing to quickly and easily configure compelling visualizations to use on dashboards and canvas workpads. Exposes components to embed visualizations and link into the Lens editor from within other apps in Kibana. | 527 | 0 | 452 | 30 | | | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 8 | 0 | 8 | 0 | | | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 3 | 0 | 3 | 0 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 117 | 0 | 42 | 10 | -| | [Security detections response](https://github.com/orgs/elastic/teams/security-detections-response) | - | 198 | 0 | 162 | 49 | +| | [Security detections response](https://github.com/orgs/elastic/teams/security-detections-response) | - | 198 | 0 | 90 | 49 | | logstash | [Logstash](https://github.com/orgs/elastic/teams/logstash) | - | 0 | 0 | 0 | 0 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | - | 41 | 0 | 41 | 6 | -| | [GIS](https://github.com/orgs/elastic/teams/kibana-gis) | - | 223 | 0 | 222 | 27 | +| | [GIS](https://github.com/orgs/elastic/teams/kibana-gis) | - | 224 | 0 | 223 | 25 | | | [GIS](https://github.com/orgs/elastic/teams/kibana-gis) | - | 67 | 0 | 67 | 0 | -| | [Security solution](https://github.com/orgs/elastic/teams/security-solution) | - | 4 | 0 | 4 | 1 | | | [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) | This plugin provides access to the machine learning features provided by Elastic. | 196 | 8 | 79 | 30 | | | [Stack Monitoring](https://github.com/orgs/elastic/teams/stack-monitoring-ui) | - | 11 | 0 | 9 | 1 | | | [Stack Monitoring](https://github.com/orgs/elastic/teams/stack-monitoring-ui) | - | 9 | 0 | 9 | 0 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 34 | 0 | 34 | 2 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 17 | 0 | 17 | 0 | -| | [Observability UI](https://github.com/orgs/elastic/teams/observability-ui) | - | 369 | 2 | 366 | 31 | +| | [Observability UI](https://github.com/orgs/elastic/teams/observability-ui) | - | 373 | 2 | 370 | 30 | | | [Security asset management](https://github.com/orgs/elastic/teams/security-asset-management) | - | 13 | 0 | 13 | 0 | | painlessLab | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 | | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | The Presentation Utility Plugin is a set of common, shared components and toolkits for solutions within the Presentation space, (e.g. Dashboards, Canvas). | 228 | 2 | 177 | 11 | @@ -121,31 +120,31 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 110 | 0 | 97 | 0 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 54 | 0 | 50 | 0 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 90 | 0 | 45 | 0 | -| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 33 | 0 | 14 | 0 | -| | [Kibana Reporting Services](https://github.com/orgs/elastic/teams/kibana-reporting-services) | Kibana Screenshotting Plugin | 24 | 0 | 12 | 5 | +| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 32 | 0 | 13 | 0 | +| | [Kibana Reporting Services](https://github.com/orgs/elastic/teams/kibana-reporting-services) | Kibana Screenshotting Plugin | 27 | 0 | 7 | 4 | | searchprofiler | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 | | | [Platform Security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides authentication and authorization features, and exposes functionality to understand the capabilities of the currently authenticated user. | 183 | 0 | 103 | 0 | -| | [Security solution](https://github.com/orgs/elastic/teams/security-solution) | - | 45 | 0 | 45 | 18 | +| | [Security solution](https://github.com/orgs/elastic/teams/security-solution) | - | 46 | 0 | 46 | 19 | | | [Security Team](https://github.com/orgs/elastic/teams/security-team) | - | 3 | 0 | 3 | 1 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds URL Service and sharing capabilities to Kibana | 113 | 0 | 54 | 10 | | | [Shared UX](https://github.com/orgs/elastic/teams/shared-ux) | A plugin providing components and services for shared user experiences in Kibana. | 4 | 0 | 0 | 0 | | | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 21 | 1 | 21 | 1 | | | [Platform Security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides the Spaces feature, which allows saved objects to be organized into meaningful categories. | 260 | 0 | 64 | 0 | | | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 4 | 0 | 4 | 0 | +| synthetics | [Uptime](https://github.com/orgs/elastic/teams/uptime) | This plugin visualizes data from Synthetics and Heartbeat, and integrates with other Observability solutions. | 0 | 0 | 0 | 0 | | | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 77 | 0 | 39 | 7 | -| | [Kibana Telemetry](https://github.com/orgs/elastic/teams/kibana-telemetry) | - | 43 | 0 | 1 | 0 | +| | [Kibana Telemetry](https://github.com/orgs/elastic/teams/kibana-telemetry) | - | 44 | 0 | 1 | 0 | | | [Kibana Telemetry](https://github.com/orgs/elastic/teams/kibana-telemetry) | - | 32 | 0 | 32 | 6 | | | [Kibana Telemetry](https://github.com/orgs/elastic/teams/kibana-telemetry) | - | 1 | 0 | 1 | 0 | | | [Kibana Telemetry](https://github.com/orgs/elastic/teams/kibana-telemetry) | - | 11 | 0 | 10 | 0 | -| | [Security solution](https://github.com/orgs/elastic/teams/security-solution) | - | 435 | 1 | 331 | 35 | +| | [Security solution](https://github.com/orgs/elastic/teams/security-solution) | - | 434 | 1 | 330 | 35 | | | [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) | This plugin provides access to the transforms features provided by Elastic. Transforms enable you to convert existing Elasticsearch indices into summarized indices, which provide opportunities for new insights and analytics. | 4 | 0 | 4 | 1 | | translations | [Kibana Localization](https://github.com/orgs/elastic/teams/kibana-localization) | - | 0 | 0 | 0 | 0 | -| | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 304 | 0 | 290 | 23 | +| | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 321 | 0 | 307 | 25 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds UI Actions service to Kibana | 130 | 0 | 91 | 11 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Extends UI Actions plugin with more functionality | 203 | 0 | 141 | 9 | -| | [Unified Search](https://github.com/orgs/elastic/teams/kibana-app-services) | Contains all the key functionality of Kibana's unified search experience.Contains all the key functionality of Kibana's unified search experience. | 48 | 1 | 45 | 6 | +| | [Unified Search](https://github.com/orgs/elastic/teams/kibana-app-services) | Contains all the key functionality of Kibana's unified search experience.Contains all the key functionality of Kibana's unified search experience. | 79 | 2 | 75 | 11 | | upgradeAssistant | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 | -| uptime | [Uptime](https://github.com/orgs/elastic/teams/uptime) | This plugin visualizes data from Synthetics and Heartbeat, and integrates with other Observability solutions. | 0 | 0 | 0 | 0 | | urlDrilldown | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds drilldown implementations to Kibana | 0 | 0 | 0 | 0 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | - | 12 | 0 | 12 | 0 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 58 | 0 | 15 | 1 | @@ -163,47 +162,57 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Registers the vega visualization. Is the elastic version of vega and vega-lite libraries. | 2 | 0 | 2 | 0 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Contains the vislib visualizations. These are the classical area/line/bar, pie, gauge/goal and heatmap charts. We want to replace them with elastic-charts. | 26 | 0 | 25 | 1 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Contains the new xy-axis chart using the elastic-charts library, which will eventually replace the vislib xy-axis charts including bar, area, and line. | 57 | 0 | 51 | 5 | -| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Contains the shared architecture among all the legacy visualizations, e.g. the visualization type registry or the visualization embeddable. | 363 | 12 | 342 | 14 | +| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Contains the shared architecture among all the legacy visualizations, e.g. the visualization type registry or the visualization embeddable. | 365 | 12 | 344 | 14 | | watcher | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 | ## Package Directory | Package name           | Maintaining team | Description | API Cnt | Any Cnt | Missing
comments | Missing
exports | |--------------|----------------|-----------|--------------|----------|---------------|--------| -| | [Owner missing] | - | 82 | 1 | 11 | 0 | -| | [Owner missing] | Elastic APM trace data generator | 62 | 0 | 62 | 9 | -| | [Owner missing] | elasticsearch datemath parser, used in kibana | 44 | 0 | 43 | 0 | +| | [Owner missing] | Elastic APM trace data generator | 70 | 0 | 70 | 10 | | | [Owner missing] | - | 11 | 5 | 11 | 0 | | | [Owner missing] | Alerts components and hooks | 9 | 1 | 9 | 0 | | | Ahmad Bamieh ahmadbamieh@gmail.com | Kibana Analytics tool | 69 | 0 | 69 | 2 | +| | [Owner missing] | - | 88 | 1 | 10 | 0 | +| | [Owner missing] | - | 18 | 0 | 13 | 0 | | | [Owner missing] | - | 16 | 0 | 16 | 0 | | | [Owner missing] | - | 11 | 0 | 11 | 0 | | | [Owner missing] | - | 10 | 0 | 10 | 0 | -| | [Owner missing] | - | 12 | 0 | 5 | 1 | +| | [Owner missing] | - | 18 | 0 | 9 | 1 | +| | [Owner missing] | - | 4 | 0 | 4 | 0 | +| | [Owner missing] | - | 8 | 0 | 7 | 0 | +| | [Owner missing] | - | 7 | 0 | 2 | 0 | +| | [Owner missing] | - | 59 | 0 | 15 | 0 | | | [Owner missing] | - | 2 | 0 | 2 | 0 | -| | [Owner missing] | - | 66 | 0 | 46 | 2 | -| | [Owner missing] | - | 125 | 3 | 123 | 17 | +| | [Owner missing] | - | 106 | 0 | 80 | 1 | +| | [Owner missing] | - | 64 | 0 | 44 | 2 | +| | [Owner missing] | - | 129 | 3 | 127 | 17 | | | [Owner missing] | - | 13 | 0 | 7 | 0 | -| | [Owner missing] | - | 277 | 3 | 199 | 1 | -| | [Owner missing] | - | 63 | 0 | 63 | 2 | +| | [Owner missing] | elasticsearch datemath parser, used in kibana | 44 | 0 | 43 | 0 | +| | [Owner missing] | - | 120 | 3 | 109 | 0 | +| | [Owner missing] | - | 64 | 0 | 64 | 2 | | | [Owner missing] | - | 1 | 0 | 1 | 0 | | | [Owner missing] | - | 27 | 0 | 14 | 1 | | | [Owner missing] | - | 213 | 1 | 159 | 11 | -| | [Owner missing] | - | 13 | 0 | 6 | 0 | +| | [Owner missing] | - | 2 | 0 | 1 | 0 | | | [Owner missing] | - | 20 | 0 | 16 | 0 | +| | [Owner missing] | - | 2 | 0 | 0 | 0 | | | [Owner missing] | - | 1 | 0 | 0 | 0 | | | [Owner missing] | - | 51 | 0 | 48 | 0 | +| | [Owner missing] | - | 43 | 0 | 36 | 0 | | | App Services | - | 35 | 4 | 35 | 0 | | | [Owner missing] | - | 20 | 0 | 20 | 2 | +| | [Owner missing] | - | 13 | 0 | 13 | 0 | +| | [Owner missing] | - | 69 | 0 | 69 | 0 | | | [Owner missing] | - | 30 | 0 | 5 | 36 | | | [Owner missing] | - | 8 | 0 | 8 | 0 | -| | [Owner missing] | - | 466 | 1 | 1 | 0 | +| | [Owner missing] | - | 494 | 1 | 1 | 0 | | | [Owner missing] | - | 55 | 0 | 55 | 2 | | | [Owner missing] | - | 45 | 0 | 45 | 10 | -| | [Owner missing] | - | 28 | 0 | 27 | 0 | +| | [Owner missing] | - | 30 | 0 | 29 | 0 | | | [Owner missing] | - | 1 | 0 | 1 | 0 | | | [Owner missing] | Just some helpers for kibana plugin devs. | 1 | 0 | 1 | 0 | -| | [Owner missing] | - | 63 | 0 | 49 | 5 | +| | [Owner missing] | - | 47 | 0 | 35 | 5 | | | [Owner missing] | - | 21 | 0 | 10 | 0 | | | [Owner missing] | - | 74 | 0 | 71 | 0 | | | [Owner missing] | Security Solution auto complete | 50 | 1 | 35 | 0 | @@ -222,18 +231,22 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Owner missing] | security solution utilities to use across plugins such lists, security_solution, cases, etc... | 31 | 0 | 29 | 0 | | | [Owner missing] | - | 53 | 0 | 50 | 1 | | | [Owner missing] | - | 25 | 0 | 24 | 1 | -| | [Owner missing] | - | 32 | 0 | 4 | 4 | +| | [Owner missing] | - | 12 | 0 | 2 | 3 | +| | [Owner missing] | - | 34 | 0 | 6 | 6 | | | [Owner missing] | - | 67 | 0 | 43 | 0 | | | [Owner missing] | - | 10 | 0 | 2 | 0 | | | [Owner missing] | - | 9 | 0 | 3 | 0 | -| | [Owner missing] | - | 96 | 1 | 63 | 2 | +| | [Owner missing] | - | 2 | 0 | 2 | 0 | +| | [Owner missing] | - | 92 | 1 | 59 | 1 | +| | [Owner missing] | - | 4 | 0 | 2 | 0 | | | Operations | - | 22 | 2 | 21 | 0 | | | [Owner missing] | - | 2 | 0 | 2 | 0 | | | Operations | - | 252 | 6 | 214 | 9 | | | [Owner missing] | - | 132 | 8 | 103 | 2 | +| | [Owner missing] | - | 72 | 0 | 55 | 0 | | | [Owner missing] | - | 29 | 0 | 2 | 0 | | | [Owner missing] | - | 83 | 0 | 83 | 1 | | | [Owner missing] | - | 7 | 0 | 6 | 0 | -| | [Owner missing] | - | 27 | 0 | 10 | 1 | +| | [Owner missing] | - | 28 | 0 | 10 | 1 | | | [Owner missing] | - | 31 | 1 | 21 | 0 | diff --git a/api_docs/presentation_util.mdx b/api_docs/presentation_util.mdx index ad2ac1542b0e2..edceb320dace9 100644 --- a/api_docs/presentation_util.mdx +++ b/api_docs/presentation_util.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/presentationUtil title: "presentationUtil" image: https://source.unsplash.com/400x175/?github summary: API docs for the presentationUtil plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'presentationUtil'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/remote_clusters.mdx b/api_docs/remote_clusters.mdx index b4d4cc4459eb6..a05a7407d5658 100644 --- a/api_docs/remote_clusters.mdx +++ b/api_docs/remote_clusters.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/remoteClusters title: "remoteClusters" image: https://source.unsplash.com/400x175/?github summary: API docs for the remoteClusters plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'remoteClusters'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/reporting.mdx b/api_docs/reporting.mdx index 976c1fc50da8d..185a48b5d4218 100644 --- a/api_docs/reporting.mdx +++ b/api_docs/reporting.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/reporting title: "reporting" image: https://source.unsplash.com/400x175/?github summary: API docs for the reporting plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'reporting'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/rollup.mdx b/api_docs/rollup.mdx index febdb7ef3b9de..b9e0c8be22113 100644 --- a/api_docs/rollup.mdx +++ b/api_docs/rollup.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/rollup title: "rollup" image: https://source.unsplash.com/400x175/?github summary: API docs for the rollup plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'rollup'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/rule_registry.devdocs.json b/api_docs/rule_registry.devdocs.json index 7bf4b15d0ef30..194d13b78917a 100644 --- a/api_docs/rule_registry.devdocs.json +++ b/api_docs/rule_registry.devdocs.json @@ -1376,9 +1376,7 @@ }, ">) => Promise; id: string; name: string; validate?: { params?: ", "RuleTypeParamsValidator", - " | undefined; } | undefined; cancelAlertsOnRuleTimeout?: boolean | undefined; config?: ", - "RuleTypeConfig", - " | undefined; actionGroups: ", + " | undefined; } | undefined; cancelAlertsOnRuleTimeout?: boolean | undefined; actionGroups: ", { "pluginId": "alerting", "scope": "common", diff --git a/api_docs/rule_registry.mdx b/api_docs/rule_registry.mdx index 854a6a476ec5a..e9a4921bf6d5a 100644 --- a/api_docs/rule_registry.mdx +++ b/api_docs/rule_registry.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/ruleRegistry title: "ruleRegistry" image: https://source.unsplash.com/400x175/?github summary: API docs for the ruleRegistry plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ruleRegistry'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/runtime_fields.mdx b/api_docs/runtime_fields.mdx index 8a045ddd337d6..f582632ea2d18 100644 --- a/api_docs/runtime_fields.mdx +++ b/api_docs/runtime_fields.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/runtimeFields title: "runtimeFields" image: https://source.unsplash.com/400x175/?github summary: API docs for the runtimeFields plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'runtimeFields'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/saved_objects.devdocs.json b/api_docs/saved_objects.devdocs.json index c8dbdfc152759..fe5794ec8c9ef 100644 --- a/api_docs/saved_objects.devdocs.json +++ b/api_docs/saved_objects.devdocs.json @@ -587,14 +587,6 @@ "plugin": "embeddable", "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx" }, - { - "plugin": "presentationUtil", - "path": "src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx" - }, - { - "plugin": "presentationUtil", - "path": "src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx" - }, { "plugin": "discover", "path": "src/plugins/discover/public/application/main/components/top_nav/on_save_search.tsx" @@ -603,6 +595,14 @@ "plugin": "discover", "path": "src/plugins/discover/public/application/main/components/top_nav/on_save_search.tsx" }, + { + "plugin": "presentationUtil", + "path": "src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx" + }, + { + "plugin": "presentationUtil", + "path": "src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx" + }, { "plugin": "dashboard", "path": "src/plugins/dashboard/public/services/saved_objects.ts" @@ -1607,22 +1607,6 @@ "plugin": "savedObjectsTaggingOss", "path": "src/plugins/saved_objects_tagging_oss/public/api.ts" }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/utils/saved_objects_utils/display_duplicate_title_confirm_modal.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/utils/saved_objects_utils/display_duplicate_title_confirm_modal.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/utils/saved_objects_utils/check_for_duplicate_title.ts" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/utils/saved_objects_utils/check_for_duplicate_title.ts" - }, { "plugin": "savedObjectsTaggingOss", "path": "src/plugins/saved_objects_tagging_oss/public/decorator/types.ts" @@ -1639,6 +1623,22 @@ "plugin": "savedObjectsTaggingOss", "path": "src/plugins/saved_objects_tagging_oss/public/api.ts" }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/utils/saved_objects_utils/display_duplicate_title_confirm_modal.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/utils/saved_objects_utils/display_duplicate_title_confirm_modal.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/utils/saved_objects_utils/check_for_duplicate_title.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/utils/saved_objects_utils/check_for_duplicate_title.ts" + }, { "plugin": "dashboard", "path": "src/plugins/dashboard/public/services/saved_object_loader.ts" @@ -3191,44 +3191,7 @@ "path": "src/plugins/saved_objects/public/plugin.ts", "deprecated": true, "removeBy": "8.8.0", - "references": [ - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/visualize_app/components/visualize_listing.tsx" - }, - { - "plugin": "visualizations", - "path": "src/plugins/visualizations/public/visualize_app/components/visualize_listing.tsx" - }, - { - "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/list_page/maps_list_view.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/routes/list_page/maps_list_view.tsx" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/routes/list_page/maps_list_view.tsx" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/apps/listing_route.tsx" - }, - { - "plugin": "graph", - "path": "x-pack/plugins/graph/public/apps/listing_route.tsx" - } - ] + "references": [] } ], "lifecycle": "start", diff --git a/api_docs/saved_objects.mdx b/api_docs/saved_objects.mdx index 977cd0b83c007..204b0f19f5d68 100644 --- a/api_docs/saved_objects.mdx +++ b/api_docs/saved_objects.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/savedObjects title: "savedObjects" image: https://source.unsplash.com/400x175/?github summary: API docs for the savedObjects plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjects'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/saved_objects_management.devdocs.json b/api_docs/saved_objects_management.devdocs.json index a7fe1019e0858..baa484f82f10d 100644 --- a/api_docs/saved_objects_management.devdocs.json +++ b/api_docs/saved_objects_management.devdocs.json @@ -278,7 +278,7 @@ "label": "euiColumn", "description": [], "signature": [ - "{ children?: React.ReactNode; onClick?: React.MouseEventHandler | undefined; onChange?: React.FormEventHandler | undefined; color?: string | undefined; onKeyDown?: React.KeyboardEventHandler | undefined; className?: string | undefined; title?: string | undefined; id?: string | undefined; description?: string | undefined; security?: string | undefined; name: React.ReactNode; field: (string & {}) | keyof ", + "{ children?: React.ReactNode; color?: string | undefined; className?: string | undefined; title?: string | undefined; onChange?: React.FormEventHandler | undefined; onKeyDown?: React.KeyboardEventHandler | undefined; onClick?: React.MouseEventHandler | undefined; id?: string | undefined; description?: string | undefined; security?: string | undefined; name: React.ReactNode; field: (string & {}) | keyof ", { "pluginId": "savedObjectsManagement", "scope": "public", @@ -501,7 +501,7 @@ "label": "obj", "description": [], "signature": [ - "{ type: string; id: string; meta: { title?: string | undefined; icon?: string | undefined; }; overwrite?: boolean | undefined; }" + "{ id: string; type: string; meta: { title?: string | undefined; icon?: string | undefined; }; overwrite?: boolean | undefined; }" ], "path": "src/plugins/saved_objects_management/public/lib/process_import_response.ts", "deprecated": false diff --git a/api_docs/saved_objects_management.mdx b/api_docs/saved_objects_management.mdx index 19d9efeb08286..0f610adb83a73 100644 --- a/api_docs/saved_objects_management.mdx +++ b/api_docs/saved_objects_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/savedObjectsManagement title: "savedObjectsManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the savedObjectsManagement plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsManagement'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/saved_objects_tagging.mdx b/api_docs/saved_objects_tagging.mdx index 10b3bdaa00b3f..e8b5d1d6a8d6b 100644 --- a/api_docs/saved_objects_tagging.mdx +++ b/api_docs/saved_objects_tagging.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/savedObjectsTagging title: "savedObjectsTagging" image: https://source.unsplash.com/400x175/?github summary: API docs for the savedObjectsTagging plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsTagging'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/saved_objects_tagging_oss.mdx b/api_docs/saved_objects_tagging_oss.mdx index 9d5079950e171..ed29900a22d7a 100644 --- a/api_docs/saved_objects_tagging_oss.mdx +++ b/api_docs/saved_objects_tagging_oss.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/savedObjectsTaggingOss title: "savedObjectsTaggingOss" image: https://source.unsplash.com/400x175/?github summary: API docs for the savedObjectsTaggingOss plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsTaggingOss'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/screenshot_mode.devdocs.json b/api_docs/screenshot_mode.devdocs.json index 65ac948800747..fead68be2cb62 100644 --- a/api_docs/screenshot_mode.devdocs.json +++ b/api_docs/screenshot_mode.devdocs.json @@ -96,51 +96,7 @@ "initialIsOpen": false } ], - "interfaces": [ - { - "parentPluginId": "screenshotMode", - "id": "def-server.ScreenshotModeRequestHandlerContext", - "type": "Interface", - "tags": [], - "label": "ScreenshotModeRequestHandlerContext", - "description": [], - "signature": [ - { - "pluginId": "screenshotMode", - "scope": "server", - "docId": "kibScreenshotModePluginApi", - "section": "def-server.ScreenshotModeRequestHandlerContext", - "text": "ScreenshotModeRequestHandlerContext" - }, - " extends ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.RequestHandlerContext", - "text": "RequestHandlerContext" - } - ], - "path": "src/plugins/screenshot_mode/server/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "screenshotMode", - "id": "def-server.ScreenshotModeRequestHandlerContext.screenshotMode", - "type": "Object", - "tags": [], - "label": "screenshotMode", - "description": [], - "signature": [ - "{ isScreenshot: boolean; }" - ], - "path": "src/plugins/screenshot_mode/server/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - } - ], + "interfaces": [], "enums": [], "misc": [ { @@ -167,6 +123,27 @@ "path": "src/plugins/screenshot_mode/common/constants.ts", "deprecated": false, "initialIsOpen": false + }, + { + "parentPluginId": "screenshotMode", + "id": "def-server.ScreenshotModeRequestHandlerContext", + "type": "Type", + "tags": [], + "label": "ScreenshotModeRequestHandlerContext", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.RequestHandlerContext", + "text": "RequestHandlerContext" + }, + " & { screenshotMode: Promise<{ isScreenshot: boolean; }>; }" + ], + "path": "src/plugins/screenshot_mode/server/types.ts", + "deprecated": false, + "initialIsOpen": false } ], "objects": [], diff --git a/api_docs/screenshot_mode.mdx b/api_docs/screenshot_mode.mdx index ad29af1bd007a..5782e32098b7f 100644 --- a/api_docs/screenshot_mode.mdx +++ b/api_docs/screenshot_mode.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/screenshotMode title: "screenshotMode" image: https://source.unsplash.com/400x175/?github summary: API docs for the screenshotMode plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'screenshotMode'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 33 | 0 | 14 | 0 | +| 32 | 0 | 13 | 0 | ## Client @@ -42,9 +42,6 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services ### Functions -### Interfaces - - ### Consts, variables and types diff --git a/api_docs/screenshotting.devdocs.json b/api_docs/screenshotting.devdocs.json index fe79cd45375c2..7b1a506b3accb 100644 --- a/api_docs/screenshotting.devdocs.json +++ b/api_docs/screenshotting.devdocs.json @@ -4,8 +4,47 @@ "classes": [], "functions": [], "interfaces": [], - "enums": [], - "misc": [], + "enums": [ + { + "parentPluginId": "screenshotting", + "id": "def-public.LayoutTypes", + "type": "Enum", + "tags": [], + "label": "LayoutTypes", + "description": [ + "\nSupported layout types." + ], + "path": "x-pack/plugins/screenshotting/common/layout.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "misc": [ + { + "parentPluginId": "screenshotting", + "id": "def-public.LayoutParams", + "type": "Type", + "tags": [], + "label": "LayoutParams", + "description": [ + "\nScreenshot layout parameters." + ], + "signature": [ + "{ id?: Id | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<", + "LayoutSelectorDictionary", + "> | undefined; zoom?: number | undefined; } extends ", + "SerializableRecord", + " ? ", + "SerializableRecord", + " & { id?: Id | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<", + "LayoutSelectorDictionary", + "> | undefined; zoom?: number | undefined; } : never" + ], + "path": "x-pack/plugins/screenshotting/common/layout.ts", + "deprecated": false, + "initialIsOpen": false + } + ], "objects": [] }, "server": { @@ -30,19 +69,35 @@ "text": "PdfScreenshotOptions" }, " extends ", - "ScreenshotOptions", - "<\"pdf\">" + "CaptureOptions" ], "path": "x-pack/plugins/screenshotting/server/formats/pdf/index.ts", "deprecated": false, "children": [ + { + "parentPluginId": "screenshotting", + "id": "def-server.PdfScreenshotOptions.format", + "type": "string", + "tags": [], + "label": "format", + "description": [ + "\nWhether to format the output as a PDF." + ], + "signature": [ + "\"pdf\"" + ], + "path": "x-pack/plugins/screenshotting/server/formats/pdf/index.ts", + "deprecated": false + }, { "parentPluginId": "screenshotting", "id": "def-server.PdfScreenshotOptions.title", "type": "string", "tags": [], "label": "title", - "description": [], + "description": [ + "\nDocument title." + ], "signature": [ "string | undefined" ], @@ -55,7 +110,9 @@ "type": "string", "tags": [], "label": "logo", - "description": [], + "description": [ + "\nLogo at the footer." + ], "signature": [ "string | undefined" ], @@ -72,9 +129,17 @@ "\nWe default to the \"print\" layout if no ID is specified for the layout" ], "signature": [ - "{ id?: \"canvas\" | \"print\" | \"preserve_layout\" | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<", + "{ id?: ", + { + "pluginId": "screenshotting", + "scope": "common", + "docId": "kibScreenshottingPluginApi", + "section": "def-common.LayoutTypes", + "text": "LayoutTypes" + }, + " | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<", "LayoutSelectorDictionary", - "> | undefined; zoom?: number | undefined; }" + "> | undefined; zoom?: number | undefined; } | undefined" ], "path": "x-pack/plugins/screenshotting/server/formats/pdf/index.ts", "deprecated": false @@ -91,50 +156,65 @@ "description": [ "\nFinal, formatted PDF result" ], - "signature": [ - { - "pluginId": "screenshotting", - "scope": "server", - "docId": "kibScreenshottingPluginApi", - "section": "def-server.PdfScreenshotResult", - "text": "PdfScreenshotResult" - }, - " extends Omit<", - { - "pluginId": "screenshotting", - "scope": "server", - "docId": "kibScreenshottingPluginApi", - "section": "def-server.FormattedScreenshotResult", - "text": "FormattedScreenshotResult" - }, - ", \"results\">" - ], "path": "x-pack/plugins/screenshotting/server/formats/pdf/index.ts", "deprecated": false, "children": [ { "parentPluginId": "screenshotting", "id": "def-server.PdfScreenshotResult.metrics", - "type": "CompoundType", + "type": "Object", "tags": [], "label": "metrics", - "description": [], + "description": [ + "\nCollected performance metrics during the screenshotting session along with the PDF generation ones." + ], "signature": [ - "PerformanceMetrics", - " & { pageCount: number; }" + "PdfScreenshotMetrics" ], "path": "x-pack/plugins/screenshotting/server/formats/pdf/index.ts", "deprecated": false }, { "parentPluginId": "screenshotting", - "id": "def-server.PdfScreenshotResult.result", + "id": "def-server.PdfScreenshotResult.data", "type": "Object", "tags": [], - "label": "result", - "description": [], + "label": "data", + "description": [ + "\nPDF document data buffer." + ], "signature": [ - "{ data: Buffer; errors: Error[]; renderErrors: string[]; }" + "Buffer" + ], + "path": "x-pack/plugins/screenshotting/server/formats/pdf/index.ts", + "deprecated": false + }, + { + "parentPluginId": "screenshotting", + "id": "def-server.PdfScreenshotResult.errors", + "type": "Array", + "tags": [], + "label": "errors", + "description": [ + "\nAny errors that were encountered while create the PDF and navigating between pages" + ], + "signature": [ + "Error[]" + ], + "path": "x-pack/plugins/screenshotting/server/formats/pdf/index.ts", + "deprecated": false + }, + { + "parentPluginId": "screenshotting", + "id": "def-server.PdfScreenshotResult.renderErrors", + "type": "Array", + "tags": [], + "label": "renderErrors", + "description": [ + "\nAny render errors that could mean some visualizations are missing from the end result." + ], + "signature": [ + "string[]" ], "path": "x-pack/plugins/screenshotting/server/formats/pdf/index.ts", "deprecated": false @@ -160,68 +240,47 @@ "text": "PngScreenshotOptions" }, " extends ", - "ScreenshotOptions", - "<\"png\">" + "CaptureOptions" ], "path": "x-pack/plugins/screenshotting/server/formats/png.ts", "deprecated": false, "children": [ { "parentPluginId": "screenshotting", - "id": "def-server.PngScreenshotOptions.layout", - "type": "Object", - "tags": [], - "label": "layout", - "description": [], + "id": "def-server.PngScreenshotOptions.format", + "type": "string", + "tags": [ + "default" + ], + "label": "format", + "description": [ + "\nWhether to format the output as a PNG." + ], "signature": [ - "{ id?: \"preserve_layout\" | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<", - "LayoutSelectorDictionary", - "> | undefined; zoom?: number | undefined; }" + "\"png\" | undefined" ], "path": "x-pack/plugins/screenshotting/server/formats/png.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "screenshotting", - "id": "def-server.PngScreenshotResult", - "type": "Interface", - "tags": [], - "label": "PngScreenshotResult", - "description": [ - "\nThe final output of a PNG screenshot" - ], - "signature": [ - { - "pluginId": "screenshotting", - "scope": "server", - "docId": "kibScreenshottingPluginApi", - "section": "def-server.PngScreenshotResult", - "text": "PngScreenshotResult" }, - " extends ", - { - "pluginId": "screenshotting", - "scope": "server", - "docId": "kibScreenshottingPluginApi", - "section": "def-server.FormattedScreenshotResult", - "text": "FormattedScreenshotResult" - } - ], - "path": "x-pack/plugins/screenshotting/server/formats/png.ts", - "deprecated": false, - "children": [ { "parentPluginId": "screenshotting", - "id": "def-server.PngScreenshotResult.metadata", - "type": "Uncategorized", + "id": "def-server.PngScreenshotOptions.layout", + "type": "Object", "tags": [], - "label": "metadata", + "label": "layout", "description": [], "signature": [ - "undefined" + "{ id?: ", + { + "pluginId": "screenshotting", + "scope": "common", + "docId": "kibScreenshottingPluginApi", + "section": "def-common.LayoutTypes", + "text": "LayoutTypes" + }, + ".PRESERVE_LAYOUT | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<", + "LayoutSelectorDictionary", + "> | undefined; zoom?: number | undefined; } | undefined" ], "path": "x-pack/plugins/screenshotting/server/formats/png.ts", "deprecated": false @@ -234,50 +293,67 @@ "misc": [ { "parentPluginId": "screenshotting", - "id": "def-server.FormattedScreenshotResult", + "id": "def-server.PngScreenshotResult", "type": "Type", "tags": [], - "label": "FormattedScreenshotResult", + "label": "PngScreenshotResult", "description": [ - "\nA general, overridable type of screenshot result\n\nPDF or PNG screenshots should extend this and convert the output to a type\nthat best suits their use cases.\n\nThis type documents what might appear on any given output type" + "\nThe final output of a PNG screenshot" ], "signature": [ - "{ metrics?: ", - "PerformanceMetrics", - " | undefined; results: ", - "ScreenshotObservableResult", - "[]; }" + "CaptureResult" ], - "path": "x-pack/plugins/screenshotting/server/formats/types.ts", + "path": "x-pack/plugins/screenshotting/server/formats/png.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "screenshotting", - "id": "def-server.Layout", + "id": "def-server.ScreenshotOptions", "type": "Type", "tags": [], - "label": "Layout", + "label": "ScreenshotOptions", "description": [], "signature": [ - "BaseLayout", - " & LayoutSelectors & Partial<{ width: number; height: number; }>" + { + "pluginId": "screenshotting", + "scope": "server", + "docId": "kibScreenshottingPluginApi", + "section": "def-server.PdfScreenshotOptions", + "text": "PdfScreenshotOptions" + }, + " | ", + { + "pluginId": "screenshotting", + "scope": "server", + "docId": "kibScreenshottingPluginApi", + "section": "def-server.PngScreenshotOptions", + "text": "PngScreenshotOptions" + } ], - "path": "x-pack/plugins/screenshotting/server/layouts/index.ts", + "path": "x-pack/plugins/screenshotting/server/screenshots/index.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "screenshotting", - "id": "def-server.UrlOrUrlWithContext", + "id": "def-server.ScreenshotResult", "type": "Type", "tags": [], - "label": "UrlOrUrlWithContext", + "label": "ScreenshotResult", "description": [], "signature": [ - "string | UrlWithContext" + { + "pluginId": "screenshotting", + "scope": "server", + "docId": "kibScreenshottingPluginApi", + "section": "def-server.PdfScreenshotResult", + "text": "PdfScreenshotResult" + }, + " | ", + "CaptureResult" ], - "path": "x-pack/plugins/screenshotting/server/screenshots/observable.ts", + "path": "x-pack/plugins/screenshotting/server/screenshots/index.ts", "deprecated": false, "initialIsOpen": false } @@ -340,25 +416,29 @@ "\nTakes screenshots of multiple pages." ], "signature": [ - "; (options: ", { "pluginId": "screenshotting", "scope": "server", "docId": "kibScreenshottingPluginApi", - "section": "def-server.PngScreenshotOptions", - "text": "PngScreenshotOptions" + "section": "def-server.PdfScreenshotOptions", + "text": "PdfScreenshotOptions" }, - ">(options: O) => ", + "): ", "Observable", - "; (options: ", { "pluginId": "screenshotting", "scope": "server", "docId": "kibScreenshottingPluginApi", - "section": "def-server.PngScreenshotResult", - "text": "PngScreenshotResult" + "section": "def-server.ScreenshotOptions", + "text": "ScreenshotOptions" }, - ">" - ], - "path": "x-pack/plugins/screenshotting/server/plugin.ts", - "deprecated": false, - "children": [ + "): ", + "Observable", + "<", { - "parentPluginId": "screenshotting", - "id": "def-server.ScreenshottingStart.getScreenshots.$1", - "type": "Uncategorized", - "tags": [], - "label": "options", - "description": [ - "Screenshots session options." - ], - "signature": [ - "O" - ], - "path": "x-pack/plugins/screenshotting/server/plugin.ts", - "deprecated": false, - "isRequired": true - } + "pluginId": "screenshotting", + "scope": "server", + "docId": "kibScreenshottingPluginApi", + "section": "def-server.ScreenshotResult", + "text": "ScreenshotResult" + }, + ">; }" ], - "returnComment": [ - "Observable with screenshotting results." - ] + "path": "x-pack/plugins/screenshotting/server/plugin.ts", + "deprecated": false } ], "lifecycle": "start", @@ -409,7 +478,21 @@ "classes": [], "functions": [], "interfaces": [], - "enums": [], + "enums": [ + { + "parentPluginId": "screenshotting", + "id": "def-common.LayoutTypes", + "type": "Enum", + "tags": [], + "label": "LayoutTypes", + "description": [ + "\nSupported layout types." + ], + "path": "x-pack/plugins/screenshotting/common/layout.ts", + "deprecated": false, + "initialIsOpen": false + } + ], "misc": [ { "parentPluginId": "screenshotting", @@ -421,76 +504,63 @@ "\nScreenshot layout parameters." ], "signature": [ - "{ id?: ID | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<", + "{ id?: Id | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<", "LayoutSelectorDictionary", "> | undefined; zoom?: number | undefined; } extends ", "SerializableRecord", " ? ", "SerializableRecord", - " & { id?: ID | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<", + " & { id?: Id | undefined; dimensions?: { width: number; height: number; } | undefined; selectors?: Partial<", "LayoutSelectorDictionary", "> | undefined; zoom?: number | undefined; } : never" ], "path": "x-pack/plugins/screenshotting/common/layout.ts", "deprecated": false, "initialIsOpen": false - } - ], - "objects": [ + }, { "parentPluginId": "screenshotting", - "id": "def-common.LayoutTypes", - "type": "Object", + "id": "def-common.SCREENSHOTTING_APP_ID", + "type": "string", "tags": [], - "label": "LayoutTypes", - "description": [ - "\nSupported layout types." + "label": "SCREENSHOTTING_APP_ID", + "description": [], + "signature": [ + "\"screenshotting\"" ], - "path": "x-pack/plugins/screenshotting/common/layout.ts", + "path": "x-pack/plugins/screenshotting/common/expression.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "screenshotting", - "id": "def-common.LayoutTypes.PRESERVE_LAYOUT", - "type": "string", - "tags": [], - "label": "PRESERVE_LAYOUT", - "description": [], - "signature": [ - "\"preserve_layout\"" - ], - "path": "x-pack/plugins/screenshotting/common/layout.ts", - "deprecated": false - }, - { - "parentPluginId": "screenshotting", - "id": "def-common.LayoutTypes.PRINT", - "type": "string", - "tags": [], - "label": "PRINT", - "description": [], - "signature": [ - "\"print\"" - ], - "path": "x-pack/plugins/screenshotting/common/layout.ts", - "deprecated": false - }, - { - "parentPluginId": "screenshotting", - "id": "def-common.LayoutTypes.CANVAS", - "type": "string", - "tags": [], - "label": "CANVAS", - "description": [], - "signature": [ - "\"canvas\"" - ], - "path": "x-pack/plugins/screenshotting/common/layout.ts", - "deprecated": false - } + "initialIsOpen": false + }, + { + "parentPluginId": "screenshotting", + "id": "def-common.SCREENSHOTTING_EXPRESSION", + "type": "string", + "tags": [], + "label": "SCREENSHOTTING_EXPRESSION", + "description": [], + "signature": [ + "\"expression\"" + ], + "path": "x-pack/plugins/screenshotting/common/expression.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "screenshotting", + "id": "def-common.SCREENSHOTTING_EXPRESSION_INPUT", + "type": "string", + "tags": [], + "label": "SCREENSHOTTING_EXPRESSION_INPUT", + "description": [], + "signature": [ + "\"input\"" ], + "path": "x-pack/plugins/screenshotting/common/expression.ts", + "deprecated": false, "initialIsOpen": false } - ] + ], + "objects": [] } } \ No newline at end of file diff --git a/api_docs/screenshotting.mdx b/api_docs/screenshotting.mdx index fb6bac64aa793..c61700bd608f0 100644 --- a/api_docs/screenshotting.mdx +++ b/api_docs/screenshotting.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/screenshotting title: "screenshotting" image: https://source.unsplash.com/400x175/?github summary: API docs for the screenshotting plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'screenshotting'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,15 @@ Contact [Kibana Reporting Services](https://github.com/orgs/elastic/teams/kibana | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 24 | 0 | 12 | 5 | +| 27 | 0 | 7 | 4 | + +## Client + +### Enums + + +### Consts, variables and types + ## Server @@ -33,8 +41,8 @@ Contact [Kibana Reporting Services](https://github.com/orgs/elastic/teams/kibana ## Common -### Objects - +### Enums + ### Consts, variables and types diff --git a/api_docs/security.mdx b/api_docs/security.mdx index c2ca4891fb327..bcb2ef6b82133 100644 --- a/api_docs/security.mdx +++ b/api_docs/security.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/security title: "security" image: https://source.unsplash.com/400x175/?github summary: API docs for the security plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'security'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/security_solution.devdocs.json b/api_docs/security_solution.devdocs.json index b8e6e83318a0b..07770d1883ef0 100644 --- a/api_docs/security_solution.devdocs.json +++ b/api_docs/security_solution.devdocs.json @@ -62,7 +62,7 @@ "label": "experimentalFeatures", "description": [], "signature": [ - "{ readonly metricsEntitiesEnabled: boolean; readonly ruleRegistryEnabled: boolean; readonly tGridEnabled: boolean; readonly tGridEventRenderedViewEnabled: boolean; readonly excludePoliciesInFilterEnabled: boolean; readonly usersEnabled: boolean; readonly detectionResponseEnabled: boolean; readonly disableIsolationUIPendingStatuses: boolean; readonly riskyHostsEnabled: boolean; readonly riskyUsersEnabled: boolean; readonly securityRulesCancelEnabled: boolean; readonly pendingActionResponsesWithAck: boolean; readonly policyListEnabled: boolean; readonly previewTelemetryUrlEnabled: boolean; readonly responseActionsConsoleEnabled: boolean; }" + "{ readonly tGridEnabled: boolean; readonly tGridEventRenderedViewEnabled: boolean; readonly excludePoliciesInFilterEnabled: boolean; readonly usersEnabled: boolean; readonly detectionResponseEnabled: boolean; readonly disableIsolationUIPendingStatuses: boolean; readonly riskyHostsEnabled: boolean; readonly riskyUsersEnabled: boolean; readonly pendingActionResponsesWithAck: boolean; readonly policyListEnabled: boolean; readonly previewTelemetryUrlEnabled: boolean; readonly responseActionsConsoleEnabled: boolean; }" ], "path": "x-pack/plugins/security_solution/public/plugin.tsx", "deprecated": false @@ -302,7 +302,9 @@ "PinnedEvent", ">; resolveTimelineConfig?: ", "ResolveTimelineConfig", - " | undefined; showSaveModal?: boolean | undefined; savedQueryId?: string | null | undefined; sessionViewId: string | null; show: boolean; status: ", + " | undefined; showSaveModal?: boolean | undefined; savedQueryId?: string | null | undefined; sessionViewConfig: ", + "SessionViewConfig", + " | null; show: boolean; status: ", "TimelineStatus", "; updated?: number | undefined; updatedBy?: string | null | undefined; isSaving: boolean; version: string | null; initialized?: boolean | undefined; }" ], @@ -704,26 +706,28 @@ "tags": [], "label": "SecuritySolutionApiRequestHandlerContext", "description": [], - "signature": [ - { - "pluginId": "securitySolution", - "scope": "server", - "docId": "kibSecuritySolutionPluginApi", - "section": "def-server.SecuritySolutionApiRequestHandlerContext", - "text": "SecuritySolutionApiRequestHandlerContext" - }, - " extends ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.RequestHandlerContext", - "text": "RequestHandlerContext" - } - ], "path": "x-pack/plugins/security_solution/server/types.ts", "deprecated": false, "children": [ + { + "parentPluginId": "securitySolution", + "id": "def-server.SecuritySolutionApiRequestHandlerContext.core", + "type": "Object", + "tags": [], + "label": "core", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreRequestHandlerContext", + "text": "CoreRequestHandlerContext" + } + ], + "path": "x-pack/plugins/security_solution/server/types.ts", + "deprecated": false + }, { "parentPluginId": "securitySolution", "id": "def-server.SecuritySolutionApiRequestHandlerContext.endpointAuthz", @@ -887,7 +891,7 @@ "label": "ConfigType", "description": [], "signature": [ - "Readonly<{} & { signalsIndex: string; maxRuleImportExportSize: number; maxRuleImportPayloadBytes: number; maxTimelineImportExportSize: number; maxTimelineImportPayloadBytes: number; alertMergeStrategy: \"allFields\" | \"missingFields\" | \"noFields\"; alertIgnoreFields: string[]; enableExperimental: string[]; packagerTaskInterval: string; prebuiltRulesFromFileSystem: boolean; prebuiltRulesFromSavedObjects: boolean; }> & { experimentalFeatures: Readonly<{ metricsEntitiesEnabled: boolean; ruleRegistryEnabled: boolean; tGridEnabled: boolean; tGridEventRenderedViewEnabled: boolean; excludePoliciesInFilterEnabled: boolean; usersEnabled: boolean; detectionResponseEnabled: boolean; disableIsolationUIPendingStatuses: boolean; riskyHostsEnabled: boolean; riskyUsersEnabled: boolean; securityRulesCancelEnabled: boolean; pendingActionResponsesWithAck: boolean; policyListEnabled: boolean; previewTelemetryUrlEnabled: boolean; responseActionsConsoleEnabled: boolean; }>; }" + "Readonly<{} & { signalsIndex: string; maxRuleImportExportSize: number; maxRuleImportPayloadBytes: number; maxTimelineImportExportSize: number; maxTimelineImportPayloadBytes: number; alertMergeStrategy: \"allFields\" | \"missingFields\" | \"noFields\"; alertIgnoreFields: string[]; enableExperimental: string[]; packagerTaskInterval: string; prebuiltRulesFromFileSystem: boolean; prebuiltRulesFromSavedObjects: boolean; }> & { experimentalFeatures: Readonly<{ tGridEnabled: boolean; tGridEventRenderedViewEnabled: boolean; excludePoliciesInFilterEnabled: boolean; usersEnabled: boolean; detectionResponseEnabled: boolean; disableIsolationUIPendingStatuses: boolean; riskyHostsEnabled: boolean; riskyUsersEnabled: boolean; pendingActionResponsesWithAck: boolean; policyListEnabled: boolean; previewTelemetryUrlEnabled: boolean; responseActionsConsoleEnabled: boolean; }>; }" ], "path": "x-pack/plugins/security_solution/server/config.ts", "deprecated": false, diff --git a/api_docs/security_solution.mdx b/api_docs/security_solution.mdx index 52564d9c3f7ad..12032a091582a 100644 --- a/api_docs/security_solution.mdx +++ b/api_docs/security_solution.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/securitySolution title: "securitySolution" image: https://source.unsplash.com/400x175/?github summary: API docs for the securitySolution plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'securitySolution'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Security solution](https://github.com/orgs/elastic/teams/security-solut | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 45 | 0 | 45 | 18 | +| 46 | 0 | 46 | 19 | ## Client diff --git a/api_docs/session_view.mdx b/api_docs/session_view.mdx index 8d8ff594c127f..86ade737ae827 100644 --- a/api_docs/session_view.mdx +++ b/api_docs/session_view.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/sessionView title: "sessionView" image: https://source.unsplash.com/400x175/?github summary: API docs for the sessionView plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'sessionView'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/share.mdx b/api_docs/share.mdx index 04dfc6ca76d26..571fa5d590783 100644 --- a/api_docs/share.mdx +++ b/api_docs/share.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/share title: "share" image: https://source.unsplash.com/400x175/?github summary: API docs for the share plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'share'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/shared_u_x.mdx b/api_docs/shared_u_x.mdx index 555c0c3a3c255..d255d87e8bd8e 100644 --- a/api_docs/shared_u_x.mdx +++ b/api_docs/shared_u_x.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/sharedUX title: "sharedUX" image: https://source.unsplash.com/400x175/?github summary: API docs for the sharedUX plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'sharedUX'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/snapshot_restore.mdx b/api_docs/snapshot_restore.mdx index de02f4b4b2387..ee9d6cb524f39 100644 --- a/api_docs/snapshot_restore.mdx +++ b/api_docs/snapshot_restore.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/snapshotRestore title: "snapshotRestore" image: https://source.unsplash.com/400x175/?github summary: API docs for the snapshotRestore plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'snapshotRestore'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/spaces.mdx b/api_docs/spaces.mdx index cd2fa16dd5876..6c7d81d1ad99c 100644 --- a/api_docs/spaces.mdx +++ b/api_docs/spaces.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/spaces title: "spaces" image: https://source.unsplash.com/400x175/?github summary: API docs for the spaces plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'spaces'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/stack_alerts.mdx b/api_docs/stack_alerts.mdx index c48f110748511..dedfaf95ecd53 100644 --- a/api_docs/stack_alerts.mdx +++ b/api_docs/stack_alerts.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/stackAlerts title: "stackAlerts" image: https://source.unsplash.com/400x175/?github summary: API docs for the stackAlerts plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'stackAlerts'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/task_manager.mdx b/api_docs/task_manager.mdx index cade7c0b9b88e..87ff82d41875d 100644 --- a/api_docs/task_manager.mdx +++ b/api_docs/task_manager.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/taskManager title: "taskManager" image: https://source.unsplash.com/400x175/?github summary: API docs for the taskManager plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'taskManager'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/telemetry.devdocs.json b/api_docs/telemetry.devdocs.json index c95f1325348d3..c1b9f1acae9fa 100644 --- a/api_docs/telemetry.devdocs.json +++ b/api_docs/telemetry.devdocs.json @@ -158,6 +158,21 @@ ], "path": "src/plugins/telemetry/public/plugin.ts", "deprecated": false + }, + { + "parentPluginId": "telemetry", + "id": "def-public.TelemetryPluginConfig.hidePrivacyStatement", + "type": "CompoundType", + "tags": [], + "label": "hidePrivacyStatement", + "description": [ + "Should we hide the privacy statement notice? Useful on some environments, e.g. Cloud" + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/telemetry/public/plugin.ts", + "deprecated": false } ], "initialIsOpen": false diff --git a/api_docs/telemetry.mdx b/api_docs/telemetry.mdx index 94652e3525420..29c538adcdd73 100644 --- a/api_docs/telemetry.mdx +++ b/api_docs/telemetry.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/telemetry title: "telemetry" image: https://source.unsplash.com/400x175/?github summary: API docs for the telemetry plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetry'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Telemetry](https://github.com/orgs/elastic/teams/kibana-telemetr | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 43 | 0 | 1 | 0 | +| 44 | 0 | 1 | 0 | ## Client diff --git a/api_docs/telemetry_collection_manager.mdx b/api_docs/telemetry_collection_manager.mdx index af2ea6cc6e530..2b4bb32e9071a 100644 --- a/api_docs/telemetry_collection_manager.mdx +++ b/api_docs/telemetry_collection_manager.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/telemetryCollectionManager title: "telemetryCollectionManager" image: https://source.unsplash.com/400x175/?github summary: API docs for the telemetryCollectionManager plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryCollectionManager'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/telemetry_collection_xpack.mdx b/api_docs/telemetry_collection_xpack.mdx index 1034c582fe31a..dae291cc27ca0 100644 --- a/api_docs/telemetry_collection_xpack.mdx +++ b/api_docs/telemetry_collection_xpack.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/telemetryCollectionXpack title: "telemetryCollectionXpack" image: https://source.unsplash.com/400x175/?github summary: API docs for the telemetryCollectionXpack plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryCollectionXpack'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/telemetry_management_section.mdx b/api_docs/telemetry_management_section.mdx index 7067c7e1d3ae6..0d8f8313d1651 100644 --- a/api_docs/telemetry_management_section.mdx +++ b/api_docs/telemetry_management_section.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/telemetryManagementSection title: "telemetryManagementSection" image: https://source.unsplash.com/400x175/?github summary: API docs for the telemetryManagementSection plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryManagementSection'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/timelines.devdocs.json b/api_docs/timelines.devdocs.json index 4853c844a07fe..aa0ca4894966c 100644 --- a/api_docs/timelines.devdocs.json +++ b/api_docs/timelines.devdocs.json @@ -2594,7 +2594,7 @@ "label": "TGridModelForTimeline", "description": [], "signature": [ - "{ columns: (Pick<", + "{ title: string; columns: (Pick<", "EuiDataGridColumn", ", \"id\" | \"display\" | \"displayAsText\" | \"initialWidth\"> & Pick<", "EuiDataGridColumn", @@ -2610,7 +2610,7 @@ }, "; description?: string | null | undefined; example?: string | number | null | undefined; format?: string | undefined; linkField?: string | undefined; placeholder?: string | undefined; subType?: ", "IFieldSubType", - " | undefined; type?: string | undefined; })[]; title: string; id: string; filters?: ", + " | undefined; type?: string | undefined; })[]; id: string; filters?: ", "Filter", "[] | undefined; dataViewId: string | null; sort: ", "SortColumnTimeline", @@ -4927,15 +4927,7 @@ "label": "renderRow", "description": [], "signature": [ - "({ browserFields, data, isDraggable, timelineId, }: { browserFields: Readonly>>; data: ", + "({ data, isDraggable, timelineId, }: { data: ", "Ecs", "; isDraggable: boolean; timelineId: string; }) => React.ReactNode" ], @@ -4947,32 +4939,11 @@ "id": "def-common.RowRenderer.renderRow.$1", "type": "Object", "tags": [], - "label": "{\n browserFields,\n data,\n isDraggable,\n timelineId,\n }", + "label": "{\n data,\n isDraggable,\n timelineId,\n }", "description": [], "path": "x-pack/plugins/timelines/common/types/timeline/rows/index.ts", "deprecated": false, "children": [ - { - "parentPluginId": "timelines", - "id": "def-common.RowRenderer.renderRow.$1.browserFields", - "type": "Object", - "tags": [], - "label": "browserFields", - "description": [], - "signature": [ - "{ readonly [x: string]: Partial<", - { - "pluginId": "timelines", - "scope": "common", - "docId": "kibTimelinesPluginApi", - "section": "def-common.BrowserField", - "text": "BrowserField" - }, - ">; }" - ], - "path": "x-pack/plugins/timelines/common/types/timeline/rows/index.ts", - "deprecated": false - }, { "parentPluginId": "timelines", "id": "def-common.RowRenderer.renderRow.$1.data", @@ -6439,7 +6410,7 @@ "label": "DataProvidersAnd", "description": [], "signature": [ - "{ type?: ", + "{ id: string; type?: ", { "pluginId": "timelines", "scope": "common", @@ -6447,7 +6418,7 @@ "section": "def-common.DataProviderType", "text": "DataProviderType" }, - " | undefined; id: string; name: string; enabled: boolean; excluded: boolean; kqlQuery: string; queryMatch: ", + " | undefined; name: string; enabled: boolean; excluded: boolean; kqlQuery: string; queryMatch: ", { "pluginId": "timelines", "scope": "common", diff --git a/api_docs/timelines.mdx b/api_docs/timelines.mdx index 1c5a341eabe9a..c0002d87729aa 100644 --- a/api_docs/timelines.mdx +++ b/api_docs/timelines.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/timelines title: "timelines" image: https://source.unsplash.com/400x175/?github summary: API docs for the timelines plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'timelines'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Security solution](https://github.com/orgs/elastic/teams/security-solut | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 435 | 1 | 331 | 35 | +| 434 | 1 | 330 | 35 | ## Client diff --git a/api_docs/transform.mdx b/api_docs/transform.mdx index ea19c16ba59fe..fe76107b5c7af 100644 --- a/api_docs/transform.mdx +++ b/api_docs/transform.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/transform title: "transform" image: https://source.unsplash.com/400x175/?github summary: API docs for the transform plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'transform'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/triggers_actions_ui.devdocs.json b/api_docs/triggers_actions_ui.devdocs.json index 16508005f0572..5c5963cb8c7bd 100644 --- a/api_docs/triggers_actions_ui.devdocs.json +++ b/api_docs/triggers_actions_ui.devdocs.json @@ -54,7 +54,7 @@ "label": "experimentalFeatures", "description": [], "signature": [ - "{ readonly rulesListDatagrid: boolean; readonly internalAlertsTable: boolean; readonly rulesDetailLogs: boolean; }" + "{ readonly rulesListDatagrid: boolean; readonly internalAlertsTable: boolean; readonly internalShareableComponentsSandbox: boolean; readonly rulesDetailLogs: boolean; }" ], "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "deprecated": false @@ -1323,6 +1323,85 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.snoozeRule", + "type": "Function", + "tags": [], + "label": "snoozeRule", + "description": [], + "signature": [ + "({\n id,\n snoozeEndTime,\n http,\n}: { id: string; snoozeEndTime: string | -1; http: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpSetup", + "text": "HttpSetup" + }, + "; }) => Promise" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/snooze.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.snoozeRule.$1", + "type": "Object", + "tags": [], + "label": "{\n id,\n snoozeEndTime,\n http,\n}", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/snooze.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.snoozeRule.$1.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/snooze.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.snoozeRule.$1.snoozeEndTime", + "type": "CompoundType", + "tags": [], + "label": "snoozeEndTime", + "description": [], + "signature": [ + "string | -1" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/snooze.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.snoozeRule.$1.http", + "type": "Object", + "tags": [], + "label": "http", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpSetup", + "text": "HttpSetup" + } + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/snooze.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "triggersActionsUi", "id": "def-public.ThresholdExpression", @@ -1421,6 +1500,72 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.unsnoozeRule", + "type": "Function", + "tags": [], + "label": "unsnoozeRule", + "description": [], + "signature": [ + "({ id, http }: { id: string; http: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpSetup", + "text": "HttpSetup" + }, + "; }) => Promise" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unsnooze.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.unsnoozeRule.$1", + "type": "Object", + "tags": [], + "label": "{ id, http }", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unsnooze.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.unsnoozeRule.$1.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unsnooze.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.unsnoozeRule.$1.http", + "type": "Object", + "tags": [], + "label": "http", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpSetup", + "text": "HttpSetup" + } + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unsnooze.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "triggersActionsUi", "id": "def-public.useLoadRuleTypes", @@ -2487,6 +2632,19 @@ "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "deprecated": false }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.RuleTypeParamsExpressionProps.dataViews", + "type": "Object", + "tags": [], + "label": "dataViews", + "description": [], + "signature": [ + "DataViewsServicePublic" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", + "deprecated": false + }, { "parentPluginId": "triggersActionsUi", "id": "def-public.RuleTypeParamsExpressionProps.unifiedSearch", @@ -2555,6 +2713,19 @@ "path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx", "deprecated": false }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.TriggersAndActionsUiServices.dataViews", + "type": "Object", + "tags": [], + "label": "dataViews", + "description": [], + "signature": [ + "DataViewsServicePublic" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx", + "deprecated": false + }, { "parentPluginId": "triggersActionsUi", "id": "def-public.TriggersAndActionsUiServices.charts", @@ -2760,6 +2931,25 @@ "path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx", "deprecated": false }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.TriggersAndActionsUiServices.alertsTableConfigurationRegistry", + "type": "Object", + "tags": [], + "label": "alertsTableConfigurationRegistry", + "description": [], + "signature": [ + "{ list: () => ", + "AlertsTableConfigurationRegistry", + "[]; get: (id: string) => ", + "AlertsTableConfigurationRegistry", + "; register: (objectType: ", + "AlertsTableConfigurationRegistry", + ") => void; has: (id: string) => boolean; }" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx", + "deprecated": false + }, { "parentPluginId": "triggersActionsUi", "id": "def-public.TriggersAndActionsUiServices.history", @@ -3031,6 +3221,20 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.PLUGIN_ID", + "type": "string", + "tags": [], + "label": "PLUGIN_ID", + "description": [], + "signature": [ + "\"triggersActions\"" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/index.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "triggersActionsUi", "id": "def-public.Rule", @@ -3993,6 +4197,22 @@ ], "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.TriggersAndActionsUIPublicPluginSetup.alertsTableConfigurationRegistry", + "type": "Object", + "tags": [], + "label": "alertsTableConfigurationRegistry", + "description": [], + "signature": [ + "TypeRegistry", + "<", + "AlertsTableConfigurationRegistry", + ">" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", + "deprecated": false } ], "lifecycle": "setup", @@ -4046,6 +4266,22 @@ "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "deprecated": false }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.TriggersAndActionsUIPublicPluginStart.alertsTableConfigurationRegistry", + "type": "Object", + "tags": [], + "label": "alertsTableConfigurationRegistry", + "description": [], + "signature": [ + "TypeRegistry", + "<", + "AlertsTableConfigurationRegistry", + ">" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", + "deprecated": false + }, { "parentPluginId": "triggersActionsUi", "id": "def-public.TriggersAndActionsUIPublicPluginStart.getAddConnectorFlyout", @@ -4223,6 +4459,40 @@ } ], "returnComment": [] + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.TriggersAndActionsUIPublicPluginStart.getRuleStatusDropdown", + "type": "Function", + "tags": [], + "label": "getRuleStatusDropdown", + "description": [], + "signature": [ + "(props: ", + "ComponentOpts", + ") => React.ReactElement<", + "ComponentOpts", + ", string | React.JSXElementConstructor>" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.TriggersAndActionsUIPublicPluginStart.getRuleStatusDropdown.$1", + "type": "Object", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "ComponentOpts" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "lifecycle": "start", @@ -4625,10 +4895,10 @@ ], "label": "parseExperimentalConfigValue", "description": [ - "\nParses the string value used in `xpack.triggersActionsUi.enableExperimental` kibana configuration,\nwhich should be a string of values delimited by a comma (`,`)\n" + "\nParses the string value used in `xpack.trigger_actions_ui.enableExperimental` kibana configuration,\nwhich should be a string of values delimited by a comma (`,`)\n" ], "signature": [ - "(configValue: string[]) => Readonly<{ rulesListDatagrid: boolean; internalAlertsTable: boolean; rulesDetailLogs: boolean; }>" + "(configValue: string[]) => Readonly<{ rulesListDatagrid: boolean; internalAlertsTable: boolean; internalShareableComponentsSandbox: boolean; rulesDetailLogs: boolean; }>" ], "path": "x-pack/plugins/triggers_actions_ui/common/experimental_features.ts", "deprecated": false, @@ -4785,7 +5055,7 @@ "label": "ExperimentalFeatures", "description": [], "signature": [ - "{ readonly rulesListDatagrid: boolean; readonly internalAlertsTable: boolean; readonly rulesDetailLogs: boolean; }" + "{ readonly rulesListDatagrid: boolean; readonly internalAlertsTable: boolean; readonly internalShareableComponentsSandbox: boolean; readonly rulesDetailLogs: boolean; }" ], "path": "x-pack/plugins/triggers_actions_ui/common/experimental_features.ts", "deprecated": false, @@ -4814,10 +5084,10 @@ "tags": [], "label": "allowedExperimentalValues", "description": [ - "\nA list of allowed values that can be used in `xpack.triggersActionsUi.enableExperimental`.\nThis object is then used to validate and parse the value entered." + "\nA list of allowed values that can be used in `xpack.trigger_actions_ui.enableExperimental`.\nThis object is then used to validate and parse the value entered." ], "signature": [ - "{ readonly rulesListDatagrid: boolean; readonly internalAlertsTable: boolean; readonly rulesDetailLogs: boolean; }" + "{ readonly rulesListDatagrid: boolean; readonly internalAlertsTable: boolean; readonly internalShareableComponentsSandbox: boolean; readonly rulesDetailLogs: boolean; }" ], "path": "x-pack/plugins/triggers_actions_ui/common/experimental_features.ts", "deprecated": false, diff --git a/api_docs/triggers_actions_ui.mdx b/api_docs/triggers_actions_ui.mdx index 88c76bf1729fd..20c5152aa8df3 100644 --- a/api_docs/triggers_actions_ui.mdx +++ b/api_docs/triggers_actions_ui.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/triggersActionsUi title: "triggersActionsUi" image: https://source.unsplash.com/400x175/?github summary: API docs for the triggersActionsUi plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'triggersActionsUi'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Response Ops](https://github.com/orgs/elastic/teams/response-ops) for q | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 304 | 0 | 290 | 23 | +| 321 | 0 | 307 | 25 | ## Client diff --git a/api_docs/ui_actions.mdx b/api_docs/ui_actions.mdx index 4bd49250ad905..5038ea2fa6daa 100644 --- a/api_docs/ui_actions.mdx +++ b/api_docs/ui_actions.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/uiActions title: "uiActions" image: https://source.unsplash.com/400x175/?github summary: API docs for the uiActions plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'uiActions'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/ui_actions_enhanced.mdx b/api_docs/ui_actions_enhanced.mdx index 51e13512c54de..7aeea3d866aad 100644 --- a/api_docs/ui_actions_enhanced.mdx +++ b/api_docs/ui_actions_enhanced.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/uiActionsEnhanced title: "uiActionsEnhanced" image: https://source.unsplash.com/400x175/?github summary: API docs for the uiActionsEnhanced plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'uiActionsEnhanced'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/unified_search.devdocs.json b/api_docs/unified_search.devdocs.json index 5d2e50e061270..28d29d8e5f2db 100644 --- a/api_docs/unified_search.devdocs.json +++ b/api_docs/unified_search.devdocs.json @@ -205,8 +205,8 @@ "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" + "section": "def-common.DataView", + "text": "DataView" }, ")[]" ], @@ -547,7 +547,7 @@ "label": "nonKqlMode", "description": [], "signature": [ - "\"lucene\" | \"text\" | undefined" + "\"text\" | \"lucene\" | undefined" ], "path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx", "deprecated": false @@ -714,6 +714,31 @@ "path": "src/plugins/unified_search/public/types.ts", "deprecated": false, "children": [ + { + "parentPluginId": "unifiedSearch", + "id": "def-public.UnifiedSearchPublicPluginStart.autocomplete", + "type": "Object", + "tags": [], + "label": "autocomplete", + "description": [ + "\nautocomplete service\n{@link AutocompleteStart}" + ], + "signature": [ + "{ getQuerySuggestions: ", + { + "pluginId": "unifiedSearch", + "scope": "public", + "docId": "kibUnifiedSearchAutocompletePluginApi", + "section": "def-public.QuerySuggestionGetFn", + "text": "QuerySuggestionGetFn" + }, + "; hasQuerySuggestions: (language: string) => boolean; getValueSuggestions: ", + "ValueSuggestionsGetFn", + "; }" + ], + "path": "src/plugins/unified_search/public/types.ts", + "deprecated": false + }, { "parentPluginId": "unifiedSearch", "id": "def-public.UnifiedSearchPublicPluginStart.ui", @@ -732,15 +757,323 @@ ], "lifecycle": "start", "initialIsOpen": true + }, + "setup": { + "parentPluginId": "unifiedSearch", + "id": "def-public.UnifiedSearchPluginSetup", + "type": "Interface", + "tags": [], + "label": "UnifiedSearchPluginSetup", + "description": [], + "path": "src/plugins/unified_search/public/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "unifiedSearch", + "id": "def-public.UnifiedSearchPluginSetup.autocomplete", + "type": "Object", + "tags": [], + "label": "autocomplete", + "description": [], + "signature": [ + "{ getQuerySuggestions: ", + { + "pluginId": "unifiedSearch", + "scope": "public", + "docId": "kibUnifiedSearchAutocompletePluginApi", + "section": "def-public.QuerySuggestionGetFn", + "text": "QuerySuggestionGetFn" + }, + "; getAutocompleteSettings: () => { terminateAfter: number; timeout: number; }; }" + ], + "path": "src/plugins/unified_search/public/types.ts", + "deprecated": false + } + ], + "lifecycle": "setup", + "initialIsOpen": true } }, "server": { - "classes": [], + "classes": [ + { + "parentPluginId": "unifiedSearch", + "id": "def-server.UnifiedSearchServerPlugin", + "type": "Class", + "tags": [], + "label": "UnifiedSearchServerPlugin", + "description": [], + "signature": [ + { + "pluginId": "unifiedSearch", + "scope": "server", + "docId": "kibUnifiedSearchPluginApi", + "section": "def-server.UnifiedSearchServerPlugin", + "text": "UnifiedSearchServerPlugin" + }, + " implements ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.Plugin", + "text": "Plugin" + }, + "<", + { + "pluginId": "unifiedSearch", + "scope": "server", + "docId": "kibUnifiedSearchPluginApi", + "section": "def-server.UnifiedSearchServerPluginSetup", + "text": "UnifiedSearchServerPluginSetup" + }, + ", void, object, object>" + ], + "path": "src/plugins/unified_search/server/plugin.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "unifiedSearch", + "id": "def-server.UnifiedSearchServerPlugin.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/unified_search/server/plugin.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "unifiedSearch", + "id": "def-server.UnifiedSearchServerPlugin.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "initializerContext", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.PluginInitializerContext", + "text": "PluginInitializerContext" + }, + "; valueSuggestions: Readonly<{} & { timeout: moment.Duration; enabled: boolean; tiers: string[]; terminateAfter: moment.Duration; }>; }>; }>>" + ], + "path": "src/plugins/unified_search/server/plugin.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "unifiedSearch", + "id": "def-server.UnifiedSearchServerPlugin.setup", + "type": "Function", + "tags": [], + "label": "setup", + "description": [], + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + "<", + "UnifiedSearchServerPluginStartDependencies", + ", ", + { + "pluginId": "unifiedSearch", + "scope": "server", + "docId": "kibUnifiedSearchPluginApi", + "section": "def-server.UnifiedSearchServerPluginStart", + "text": "UnifiedSearchServerPluginStart" + }, + ">, {}: ", + "UnifiedSearchServerPluginSetupDependencies", + ") => { autocomplete: { getAutocompleteSettings: () => { terminateAfter: number; timeout: number; }; }; }" + ], + "path": "src/plugins/unified_search/server/plugin.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "unifiedSearch", + "id": "def-server.UnifiedSearchServerPlugin.setup.$1", + "type": "Object", + "tags": [], + "label": "core", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + "<", + "UnifiedSearchServerPluginStartDependencies", + ", ", + { + "pluginId": "unifiedSearch", + "scope": "server", + "docId": "kibUnifiedSearchPluginApi", + "section": "def-server.UnifiedSearchServerPluginStart", + "text": "UnifiedSearchServerPluginStart" + }, + ">" + ], + "path": "src/plugins/unified_search/server/plugin.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "unifiedSearch", + "id": "def-server.UnifiedSearchServerPlugin.setup.$2", + "type": "Object", + "tags": [], + "label": "{}", + "description": [], + "signature": [ + "UnifiedSearchServerPluginSetupDependencies" + ], + "path": "src/plugins/unified_search/server/plugin.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "unifiedSearch", + "id": "def-server.UnifiedSearchServerPlugin.start", + "type": "Function", + "tags": [], + "label": "start", + "description": [], + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + }, + ", {}: ", + "UnifiedSearchServerPluginStartDependencies", + ") => {}" + ], + "path": "src/plugins/unified_search/server/plugin.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "unifiedSearch", + "id": "def-server.UnifiedSearchServerPlugin.start.$1", + "type": "Object", + "tags": [], + "label": "core", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + } + ], + "path": "src/plugins/unified_search/server/plugin.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "unifiedSearch", + "id": "def-server.UnifiedSearchServerPlugin.start.$2", + "type": "Object", + "tags": [], + "label": "{}", + "description": [], + "signature": [ + "UnifiedSearchServerPluginStartDependencies" + ], + "path": "src/plugins/unified_search/server/plugin.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "unifiedSearch", + "id": "def-server.UnifiedSearchServerPlugin.stop", + "type": "Function", + "tags": [], + "label": "stop", + "description": [], + "signature": [ + "() => void" + ], + "path": "src/plugins/unified_search/server/plugin.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], "functions": [], - "interfaces": [], + "interfaces": [ + { + "parentPluginId": "unifiedSearch", + "id": "def-server.UnifiedSearchServerPluginStart", + "type": "Interface", + "tags": [], + "label": "UnifiedSearchServerPluginStart", + "description": [], + "path": "src/plugins/unified_search/server/plugin.ts", + "deprecated": false, + "children": [], + "initialIsOpen": false + } + ], "enums": [], "misc": [], - "objects": [] + "objects": [], + "setup": { + "parentPluginId": "unifiedSearch", + "id": "def-server.UnifiedSearchServerPluginSetup", + "type": "Interface", + "tags": [], + "label": "UnifiedSearchServerPluginSetup", + "description": [], + "path": "src/plugins/unified_search/server/plugin.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "unifiedSearch", + "id": "def-server.UnifiedSearchServerPluginSetup.autocomplete", + "type": "Object", + "tags": [], + "label": "autocomplete", + "description": [], + "signature": [ + "{ getAutocompleteSettings: () => { terminateAfter: number; timeout: number; }; }" + ], + "path": "src/plugins/unified_search/server/plugin.ts", + "deprecated": false + } + ], + "lifecycle": "setup", + "initialIsOpen": true + } }, "common": { "classes": [], diff --git a/api_docs/unified_search.mdx b/api_docs/unified_search.mdx index 5090a1f15bee8..285d17efcba81 100644 --- a/api_docs/unified_search.mdx +++ b/api_docs/unified_search.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/unifiedSearch title: "unifiedSearch" image: https://source.unsplash.com/400x175/?github summary: API docs for the unifiedSearch plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedSearch'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,10 +18,13 @@ Contact [Unified Search](https://github.com/orgs/elastic/teams/kibana-app-servic | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 48 | 1 | 45 | 6 | +| 79 | 2 | 75 | 11 | ## Client +### Setup + + ### Start @@ -34,3 +37,14 @@ Contact [Unified Search](https://github.com/orgs/elastic/teams/kibana-app-servic ### Consts, variables and types +## Server + +### Setup + + +### Classes + + +### Interfaces + + diff --git a/api_docs/unified_search_autocomplete.devdocs.json b/api_docs/unified_search_autocomplete.devdocs.json new file mode 100644 index 0000000000000..c3f2543a9c9cb --- /dev/null +++ b/api_docs/unified_search_autocomplete.devdocs.json @@ -0,0 +1,265 @@ +{ + "id": "unifiedSearch.autocomplete", + "client": { + "classes": [], + "functions": [], + "interfaces": [ + { + "parentPluginId": "unifiedSearch", + "id": "def-public.QuerySuggestionGetFnArgs", + "type": "Interface", + "tags": [], + "label": "QuerySuggestionGetFnArgs", + "description": [], + "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "unifiedSearch", + "id": "def-public.QuerySuggestionGetFnArgs.language", + "type": "string", + "tags": [], + "label": "language", + "description": [], + "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts", + "deprecated": false + }, + { + "parentPluginId": "unifiedSearch", + "id": "def-public.QuerySuggestionGetFnArgs.indexPatterns", + "type": "Array", + "tags": [], + "label": "indexPatterns", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.IIndexPattern", + "text": "IIndexPattern" + }, + "[]" + ], + "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts", + "deprecated": false + }, + { + "parentPluginId": "unifiedSearch", + "id": "def-public.QuerySuggestionGetFnArgs.query", + "type": "string", + "tags": [], + "label": "query", + "description": [], + "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts", + "deprecated": false + }, + { + "parentPluginId": "unifiedSearch", + "id": "def-public.QuerySuggestionGetFnArgs.selectionStart", + "type": "number", + "tags": [], + "label": "selectionStart", + "description": [], + "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts", + "deprecated": false + }, + { + "parentPluginId": "unifiedSearch", + "id": "def-public.QuerySuggestionGetFnArgs.selectionEnd", + "type": "number", + "tags": [], + "label": "selectionEnd", + "description": [], + "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts", + "deprecated": false + }, + { + "parentPluginId": "unifiedSearch", + "id": "def-public.QuerySuggestionGetFnArgs.signal", + "type": "Object", + "tags": [], + "label": "signal", + "description": [], + "signature": [ + "AbortSignal | undefined" + ], + "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts", + "deprecated": false + }, + { + "parentPluginId": "unifiedSearch", + "id": "def-public.QuerySuggestionGetFnArgs.useTimeRange", + "type": "CompoundType", + "tags": [], + "label": "useTimeRange", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts", + "deprecated": false + }, + { + "parentPluginId": "unifiedSearch", + "id": "def-public.QuerySuggestionGetFnArgs.boolFilter", + "type": "Any", + "tags": [], + "label": "boolFilter", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts", + "deprecated": false + }, + { + "parentPluginId": "unifiedSearch", + "id": "def-public.QuerySuggestionGetFnArgs.method", + "type": "CompoundType", + "tags": [], + "label": "method", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataPluginApi", + "section": "def-common.ValueSuggestionsMethod", + "text": "ValueSuggestionsMethod" + }, + " | undefined" + ], + "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "enums": [ + { + "parentPluginId": "unifiedSearch", + "id": "def-public.QuerySuggestionTypes", + "type": "Enum", + "tags": [], + "label": "QuerySuggestionTypes", + "description": [], + "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "misc": [ + { + "parentPluginId": "unifiedSearch", + "id": "def-public.AutocompleteStart", + "type": "Type", + "tags": [], + "label": "AutocompleteStart", + "description": [], + "signature": [ + "{ getQuerySuggestions: ", + { + "pluginId": "unifiedSearch", + "scope": "public", + "docId": "kibUnifiedSearchAutocompletePluginApi", + "section": "def-public.QuerySuggestionGetFn", + "text": "QuerySuggestionGetFn" + }, + "; hasQuerySuggestions: (language: string) => boolean; getValueSuggestions: ", + "ValueSuggestionsGetFn", + "; }" + ], + "path": "src/plugins/unified_search/public/autocomplete/autocomplete_service.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "unifiedSearch", + "id": "def-public.QuerySuggestion", + "type": "Type", + "tags": [], + "label": "QuerySuggestion", + "description": [], + "signature": [ + "QuerySuggestionBasic", + " | ", + "QuerySuggestionField" + ], + "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "unifiedSearch", + "id": "def-public.QuerySuggestionGetFn", + "type": "Type", + "tags": [], + "label": "QuerySuggestionGetFn", + "description": [], + "signature": [ + "(args: ", + { + "pluginId": "unifiedSearch", + "scope": "public", + "docId": "kibUnifiedSearchAutocompletePluginApi", + "section": "def-public.QuerySuggestionGetFnArgs", + "text": "QuerySuggestionGetFnArgs" + }, + ") => Promise<", + { + "pluginId": "unifiedSearch", + "scope": "public", + "docId": "kibUnifiedSearchAutocompletePluginApi", + "section": "def-public.QuerySuggestion", + "text": "QuerySuggestion" + }, + "[]> | undefined" + ], + "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "unifiedSearch", + "id": "def-public.QuerySuggestionGetFn.$1", + "type": "Object", + "tags": [], + "label": "args", + "description": [], + "signature": [ + { + "pluginId": "unifiedSearch", + "scope": "public", + "docId": "kibUnifiedSearchAutocompletePluginApi", + "section": "def-public.QuerySuggestionGetFnArgs", + "text": "QuerySuggestionGetFnArgs" + } + ], + "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/unified_search_autocomplete.mdx b/api_docs/unified_search_autocomplete.mdx new file mode 100644 index 0000000000000..f6c59fdec600f --- /dev/null +++ b/api_docs/unified_search_autocomplete.mdx @@ -0,0 +1,33 @@ +--- +id: kibUnifiedSearchAutocompletePluginApi +slug: /kibana-dev-docs/api/unifiedSearch-autocomplete +title: "unifiedSearch.autocomplete" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the unifiedSearch.autocomplete plugin +date: 2022-04-26 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedSearch.autocomplete'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import unifiedSearchAutocompleteObj from './unified_search_autocomplete.devdocs.json'; + +Contains all the key functionality of Kibana's unified search experience.Contains all the key functionality of Kibana's unified search experience. + +Contact [Unified Search](https://github.com/orgs/elastic/teams/kibana-app-services) for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 79 | 2 | 75 | 11 | + +## Client + +### Interfaces + + +### Enums + + +### Consts, variables and types + + diff --git a/api_docs/url_forwarding.mdx b/api_docs/url_forwarding.mdx index 49e61cb0452fe..3ba684cb1b7fe 100644 --- a/api_docs/url_forwarding.mdx +++ b/api_docs/url_forwarding.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/urlForwarding title: "urlForwarding" image: https://source.unsplash.com/400x175/?github summary: API docs for the urlForwarding plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'urlForwarding'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/usage_collection.devdocs.json b/api_docs/usage_collection.devdocs.json index 46559368d5450..8978c71dc262e 100644 --- a/api_docs/usage_collection.devdocs.json +++ b/api_docs/usage_collection.devdocs.json @@ -2190,9 +2190,9 @@ "\r\nPossible type values in the schema" ], "signature": [ - "\"boolean\" | \"keyword\" | \"date\" | \"text\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"double\"" + "\"boolean\" | \"keyword\" | \"text\" | \"date\" | \"integer\" | \"long\" | \"short\" | \"byte\" | \"float\" | \"double\"" ], - "path": "node_modules/@types/elastic__analytics/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "initialIsOpen": false }, diff --git a/api_docs/usage_collection.mdx b/api_docs/usage_collection.mdx index 362ddd4e39eb8..121a877b20b16 100644 --- a/api_docs/usage_collection.mdx +++ b/api_docs/usage_collection.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/usageCollection title: "usageCollection" image: https://source.unsplash.com/400x175/?github summary: API docs for the usageCollection plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'usageCollection'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/ux.mdx b/api_docs/ux.mdx index 6ccc23ba38612..ef94504e31dc9 100644 --- a/api_docs/ux.mdx +++ b/api_docs/ux.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/ux title: "ux" image: https://source.unsplash.com/400x175/?github summary: API docs for the ux plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ux'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_default_editor.mdx b/api_docs/vis_default_editor.mdx index c335a368d7b71..42f51f6f9501c 100644 --- a/api_docs/vis_default_editor.mdx +++ b/api_docs/vis_default_editor.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visDefaultEditor title: "visDefaultEditor" image: https://source.unsplash.com/400x175/?github summary: API docs for the visDefaultEditor plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visDefaultEditor'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_gauge.mdx b/api_docs/vis_type_gauge.mdx index f1504dbc739ba..15770aeb62c3d 100644 --- a/api_docs/vis_type_gauge.mdx +++ b/api_docs/vis_type_gauge.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeGauge title: "visTypeGauge" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeGauge plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeGauge'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_heatmap.mdx b/api_docs/vis_type_heatmap.mdx index e36cb3c375d3c..6460ab30cde48 100644 --- a/api_docs/vis_type_heatmap.mdx +++ b/api_docs/vis_type_heatmap.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeHeatmap title: "visTypeHeatmap" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeHeatmap plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeHeatmap'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_pie.mdx b/api_docs/vis_type_pie.mdx index 6fd8b8f633d78..1e97d6977d0df 100644 --- a/api_docs/vis_type_pie.mdx +++ b/api_docs/vis_type_pie.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypePie title: "visTypePie" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypePie plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypePie'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_table.mdx b/api_docs/vis_type_table.mdx index 9fb56a55bd2d9..0bdbae2ed0092 100644 --- a/api_docs/vis_type_table.mdx +++ b/api_docs/vis_type_table.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeTable title: "visTypeTable" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeTable plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeTable'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_timelion.mdx b/api_docs/vis_type_timelion.mdx index 91e5141ff9cfd..962bbd0c90c3f 100644 --- a/api_docs/vis_type_timelion.mdx +++ b/api_docs/vis_type_timelion.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeTimelion title: "visTypeTimelion" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeTimelion plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeTimelion'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_timeseries.devdocs.json b/api_docs/vis_type_timeseries.devdocs.json index 77a7ac1e67ce5..afd54c07290ff 100644 --- a/api_docs/vis_type_timeseries.devdocs.json +++ b/api_docs/vis_type_timeseries.devdocs.json @@ -145,7 +145,7 @@ { "parentPluginId": "visTypeTimeseries", "id": "def-server.VisTypeTimeseriesSetup.getVisData.$1", - "type": "Object", + "type": "CompoundType", "tags": [], "label": "requestContext", "description": [], diff --git a/api_docs/vis_type_timeseries.mdx b/api_docs/vis_type_timeseries.mdx index ba5ac71899536..b26a90a93f8f0 100644 --- a/api_docs/vis_type_timeseries.mdx +++ b/api_docs/vis_type_timeseries.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeTimeseries title: "visTypeTimeseries" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeTimeseries plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeTimeseries'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_vega.mdx b/api_docs/vis_type_vega.mdx index c978eed560309..e65deb3cea8a9 100644 --- a/api_docs/vis_type_vega.mdx +++ b/api_docs/vis_type_vega.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeVega title: "visTypeVega" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeVega plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeVega'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_vislib.mdx b/api_docs/vis_type_vislib.mdx index 9638ab6b1db54..aba082b0dfb43 100644 --- a/api_docs/vis_type_vislib.mdx +++ b/api_docs/vis_type_vislib.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeVislib title: "visTypeVislib" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeVislib plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeVislib'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_xy.mdx b/api_docs/vis_type_xy.mdx index 6728cabe0e78c..8b80289230ed5 100644 --- a/api_docs/vis_type_xy.mdx +++ b/api_docs/vis_type_xy.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeXy title: "visTypeXy" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeXy plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeXy'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/visualizations.devdocs.json b/api_docs/visualizations.devdocs.json index 9cd950856997f..500393546b819 100644 --- a/api_docs/visualizations.devdocs.json +++ b/api_docs/visualizations.devdocs.json @@ -3162,9 +3162,9 @@ "Observable", "; getTimeUpdate$: () => ", "Observable", - "; getRefreshIntervalUpdate$: () => ", + "; getRefreshIntervalUpdate$: () => ", "Observable", - "; getAutoRefreshFetch$: () => ", + "; getAutoRefreshFetch$: () => ", "Observable", "<", { @@ -3176,7 +3176,7 @@ }, ">; getFetch$: () => ", "Observable", - "; getTime: () => ", + "; getTime: () => ", { "pluginId": "data", "scope": "common", @@ -4496,13 +4496,7 @@ "label": "palette", "description": [], "signature": [ - { - "pluginId": "charts", - "scope": "common", - "docId": "kibChartsPluginApi", - "section": "def-common.PaletteOutput", - "text": "PaletteOutput" - }, + "PaletteOutput", "<{ [key: string]: unknown; }> | undefined" ], "path": "src/plugins/visualizations/public/vis_types/types.ts", @@ -4850,6 +4844,34 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "visualizations", + "id": "def-public.SAVED_OBJECTS_LIMIT_SETTING", + "type": "string", + "tags": [], + "label": "SAVED_OBJECTS_LIMIT_SETTING", + "description": [], + "signature": [ + "\"savedObjects:listingLimit\"" + ], + "path": "src/plugins/visualizations/common/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "visualizations", + "id": "def-public.SAVED_OBJECTS_PER_PAGE_SETTING", + "type": "string", + "tags": [], + "label": "SAVED_OBJECTS_PER_PAGE_SETTING", + "description": [], + "signature": [ + "\"savedObjects:perPage\"" + ], + "path": "src/plugins/visualizations/common/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "visualizations", "id": "def-public.SavedVisState", @@ -5018,7 +5040,7 @@ "label": "VisualizeEmbeddableContract", "description": [], "signature": [ - "{ readonly type: \"visualization\"; readonly id: string; getExplicitInput: () => ", + "{ readonly id: string; readonly type: \"visualization\"; getExplicitInput: () => ", { "pluginId": "visualizations", "scope": "public", @@ -5234,7 +5256,7 @@ "label": "VisualizeEmbeddableFactoryContract", "description": [], "signature": [ - "{ readonly type: \"visualization\"; create: (input: ", + "{ create: (input: ", { "pluginId": "visualizations", "scope": "public", @@ -5294,7 +5316,7 @@ "VisualizeEmbeddable", " | ", "DisabledLabEmbeddable", - " | undefined>; isEditable: () => Promise; getDisplayName: () => string; createFromSavedObject: (savedObjectId: string, input: Partial<", + " | undefined>; readonly type: \"visualization\"; isEditable: () => Promise; getDisplayName: () => string; createFromSavedObject: (savedObjectId: string, input: Partial<", { "pluginId": "visualizations", "scope": "public", diff --git a/api_docs/visualizations.mdx b/api_docs/visualizations.mdx index abd99851677e0..992f0475d6f4f 100644 --- a/api_docs/visualizations.mdx +++ b/api_docs/visualizations.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visualizations title: "visualizations" image: https://source.unsplash.com/400x175/?github summary: API docs for the visualizations plugin -date: 2022-04-05 +date: 2022-04-26 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visualizations'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 363 | 12 | 342 | 14 | +| 365 | 12 | 344 | 14 | ## Client diff --git a/dev_docs/getting_started/hello_world_plugin.mdx b/dev_docs/getting_started/hello_world_plugin.mdx index be4fcf5671a42..8fa4ea4316129 100644 --- a/dev_docs/getting_started/hello_world_plugin.mdx +++ b/dev_docs/getting_started/hello_world_plugin.mdx @@ -40,6 +40,10 @@ and add the following: "id": "helloWorld", "version": "1.0.0", "kibanaVersion": "kibana", + "owner": { + "name": "Kibana Core", + "githubTeam": "kibana-core" + }, "ui": true } ``` @@ -77,6 +81,7 @@ And add the following to it: ``` $ mkdir public +$ cd public $ touch plugin.tsx ``` diff --git a/dev_docs/getting_started/setting_up_a_development_env.mdx b/dev_docs/getting_started/setting_up_a_development_env.mdx index ae994d6a018de..570dcb57a56b8 100644 --- a/dev_docs/getting_started/setting_up_a_development_env.mdx +++ b/dev_docs/getting_started/setting_up_a_development_env.mdx @@ -72,7 +72,7 @@ In another terminal tab/window you can start Kibana. yarn start ``` -If you include the `--run-examples` flag then all of the [developer examples](https://github.com/elastic/kibana/tree/{branch}/examples). Read more about the advanced options for [Running Kibana](https://www.elastic.co/guide/en/kibana/current/running-kibana-advanced.html). +Include developer examples](https://github.com/elastic/kibana/tree/main/examples) by adding an optional `--run-examples` flag. Read more about the advanced options for [Running Kibana](https://www.elastic.co/guide/en/kibana/current/running-kibana-advanced.html). ## Code away! diff --git a/dev_docs/tutorials/data/search.mdx b/dev_docs/tutorials/data/search.mdx index 0787c44b632ec..ab5c3f29ea1be 100644 --- a/dev_docs/tutorials/data/search.mdx +++ b/dev_docs/tutorials/data/search.mdx @@ -259,7 +259,7 @@ export const myEnhancedSearchStrategyProvider = ( await ese.cancel(id, options, deps); }, extend: async (id, keepAlive, options, deps) => { - // async search results are not stored indefinitely. By default, they expire after 7 days (or as defined by xpack.data_enhanced.search.sessions.defaultExpiration setting in kibana.yml). + // async search results are not stored indefinitely. By default, they expire after 7 days (or as defined by data.search.sessions.defaultExpiration setting in kibana.yml). // call the extend method of the async strategy you are using or implement your own extend function. await ese.extend(id, options, deps); }, diff --git a/docs/developer/plugin-list.asciidoc b/docs/developer/plugin-list.asciidoc index 90bf3d3c29b41..63e104c44b173 100644 --- a/docs/developer/plugin-list.asciidoc +++ b/docs/developer/plugin-list.asciidoc @@ -412,10 +412,6 @@ The plugin exposes the static DefaultEditorController class to consume. |Adds drilldown capabilities to dashboard. Owned by the Kibana App team. -|{kib-repo}blob/{branch}/x-pack/plugins/data_enhanced/README.md[dataEnhanced] -|The data_enhanced plugin is the x-pack counterpart to the src/plguins/data plugin. - - |{kib-repo}blob/{branch}/x-pack/plugins/data_visualizer/README.md[dataVisualizer] |The data_visualizer plugin enables you to explore the fields in your data. diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporter.import.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporter.import.md index 1ca6058e7d742..f30ddeddba92d 100644 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporter.import.md +++ b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporter.import.md @@ -9,14 +9,14 @@ Import saved objects from given stream. See the [options](./kibana-plugin-core-s Signature: ```typescript -import({ readStream, createNewCopies, namespace, overwrite, }: SavedObjectsImportOptions): Promise; +import({ readStream, createNewCopies, namespace, overwrite, refresh, }: SavedObjectsImportOptions): Promise; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| { readStream, createNewCopies, namespace, overwrite, } | SavedObjectsImportOptions | | +| { readStream, createNewCopies, namespace, overwrite, refresh, } | SavedObjectsImportOptions | | Returns: diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporter.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporter.md index 18ce27ca2c0dc..b1035bc247ad1 100644 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporter.md +++ b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimporter.md @@ -21,6 +21,6 @@ export declare class SavedObjectsImporter | Method | Modifiers | Description | | --- | --- | --- | -| [import({ readStream, createNewCopies, namespace, overwrite, })](./kibana-plugin-core-server.savedobjectsimporter.import.md) | | Import saved objects from given stream. See the [options](./kibana-plugin-core-server.savedobjectsimportoptions.md) for more detailed information. | +| [import({ readStream, createNewCopies, namespace, overwrite, refresh, })](./kibana-plugin-core-server.savedobjectsimporter.import.md) | | Import saved objects from given stream. See the [options](./kibana-plugin-core-server.savedobjectsimportoptions.md) for more detailed information. | | [resolveImportErrors({ readStream, createNewCopies, namespace, retries, })](./kibana-plugin-core-server.savedobjectsimporter.resolveimporterrors.md) | | Resolve and return saved object import errors. See the [options](./kibana-plugin-core-server.savedobjectsresolveimporterrorsoptions.md) for more detailed information. | diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.md index 58d0f4bf982c3..775f3a4c9acb3 100644 --- a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.md +++ b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.md @@ -20,4 +20,5 @@ export interface SavedObjectsImportOptions | [namespace?](./kibana-plugin-core-server.savedobjectsimportoptions.namespace.md) | string | (Optional) if specified, will import in given namespace, else will import as global object | | [overwrite](./kibana-plugin-core-server.savedobjectsimportoptions.overwrite.md) | boolean | If true, will override existing object if present. Note: this has no effect when used with the createNewCopies option. | | [readStream](./kibana-plugin-core-server.savedobjectsimportoptions.readstream.md) | Readable | The stream of [saved objects](./kibana-plugin-core-server.savedobject.md) to import | +| [refresh?](./kibana-plugin-core-server.savedobjectsimportoptions.refresh.md) | boolean \| 'wait\_for' | (Optional) Refresh setting, defaults to wait_for | diff --git a/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.refresh.md b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.refresh.md new file mode 100644 index 0000000000000..cc7e36354647a --- /dev/null +++ b/docs/development/core/server/kibana-plugin-core-server.savedobjectsimportoptions.refresh.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [SavedObjectsImportOptions](./kibana-plugin-core-server.savedobjectsimportoptions.md) > [refresh](./kibana-plugin-core-server.savedobjectsimportoptions.refresh.md) + +## SavedObjectsImportOptions.refresh property + +Refresh setting, defaults to `wait_for` + +Signature: + +```typescript +refresh?: boolean | 'wait_for'; +``` diff --git a/docs/maps/import-geospatial-data.asciidoc b/docs/maps/import-geospatial-data.asciidoc index f58077fa38f92..8ee54e5dba638 100644 --- a/docs/maps/import-geospatial-data.asciidoc +++ b/docs/maps/import-geospatial-data.asciidoc @@ -96,12 +96,6 @@ To open an existing index for drawing: . Click *Add layer*. -. Set *Scaling* to *Limit results to 10,000*. - -. In **Filtering**: -** Clear the *Apply global search to layer data* checkbox. -** If your data view contains a default time field, clear the *Apply global time to layer data* checkbox. - . Click *Save & close*. . In the legend, click the layer name and select *Edit features*. diff --git a/nav-kibana-dev.docnav.json b/nav-kibana-dev.docnav.json index 517d42c8f72d0..43b23fd084673 100644 --- a/nav-kibana-dev.docnav.json +++ b/nav-kibana-dev.docnav.json @@ -69,6 +69,7 @@ { "label": "Contributors Newsletters", "items": [ + { "id": "kibApril2022ContributorNewsletter" }, { "id": "kibMarch2022ContributorNewsletter" }, { "id": "kibFebruary2022ContributorNewsletter" }, { "id": "kibJanuary2022ContributorNewsletter" }, diff --git a/package.json b/package.json index 89c36118479ca..1b785b1fcaaab 100644 --- a/package.json +++ b/package.json @@ -249,7 +249,7 @@ "deep-freeze-strict": "^1.1.1", "deepmerge": "^4.2.2", "del": "^5.1.0", - "elastic-apm-node": "^3.31.0", + "elastic-apm-node": "^3.32.0", "email-addresses": "^5.0.0", "execa": "^4.0.2", "exit-hook": "^2.2.0", @@ -271,7 +271,6 @@ "handlebars": "4.7.7", "he": "^1.2.0", "history": "^4.9.0", - "history-extra": "^5.0.1", "hjson": "3.2.1", "http-proxy-agent": "^2.1.0", "https-proxy-agent": "^5.0.0", diff --git a/packages/analytics/client/src/analytics_client/analytics_client.test.ts b/packages/analytics/client/src/analytics_client/analytics_client.test.ts index 08515ecae8d1e..1e8d5aa5445c0 100644 --- a/packages/analytics/client/src/analytics_client/analytics_client.test.ts +++ b/packages/analytics/client/src/analytics_client/analytics_client.test.ts @@ -19,7 +19,8 @@ import { TelemetryCounterType } from '../events'; const delay = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms)); -describe('AnalyticsClient', () => { +// FLAKY: https://github.com/elastic/kibana/issues/131369 +describe.skip('AnalyticsClient', () => { let analyticsClient: AnalyticsClient; let logger: MockedLogger; diff --git a/packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts b/packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts index 73eecbda2ff3e..5d3f17a76f687 100644 --- a/packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts +++ b/packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts @@ -22,6 +22,8 @@ import { parseConfig, Config, CiStatsMetadata } from '@kbn/ci-stats-core'; import type { CiStatsTestGroupInfo, CiStatsTestRun } from './ci_stats_test_group_types'; const BASE_URL = 'https://ci-stats.kibana.dev'; +const SECOND = 1000; +const MINUTE = 60 * SECOND; function limitMetaStrings(meta: CiStatsMetadata) { return Object.fromEntries( @@ -107,6 +109,7 @@ interface ReqOptions { body: any; bodyDesc: string; query?: AxiosRequestConfig['params']; + timeout?: number; } /** Object that helps report data to the ci-stats service */ @@ -282,6 +285,7 @@ export class CiStatsReporter { }, bodyDesc: `[${group.name}/${group.type}] Chunk of ${bufferBytes} bytes`, body: buffer.join('\n'), + timeout: 5 * MINUTE, }); buffer.length = 0; bufferBytes = 0; @@ -336,7 +340,7 @@ export class CiStatsReporter { } } - private async req({ auth, body, bodyDesc, path, query }: ReqOptions) { + private async req({ auth, body, bodyDesc, path, query, timeout = 60 * SECOND }: ReqOptions) { let attempt = 0; const maxAttempts = 5; @@ -365,6 +369,7 @@ export class CiStatsReporter { // if it can be serialized into a string, send it maxBodyLength: Infinity, maxContentLength: Infinity, + timeout, }); return resp.data; diff --git a/packages/kbn-docs-utils/src/api_docs/build_api_declarations/buid_api_declaration.test.ts b/packages/kbn-docs-utils/src/api_docs/build_api_declarations/buid_api_declaration.test.ts index 9b86db445c225..527ce59011a8b 100644 --- a/packages/kbn-docs-utils/src/api_docs/build_api_declarations/buid_api_declaration.test.ts +++ b/packages/kbn-docs-utils/src/api_docs/build_api_declarations/buid_api_declaration.test.ts @@ -53,6 +53,24 @@ it('Test number primitive doc def', () => { expect(def.type).toBe(TypeKind.NumberKind); }); +it('Test a constructor type declaration inside an interface', () => { + const node = nodes.find((n) => getNodeName(n) === 'ClassConstructorWithStaticProperties'); + expect(node).toBeDefined(); + const def = buildApiDeclarationTopNode(node!, { + plugins, + log, + currentPluginId: plugins[0].manifest.id, + scope: ApiScope.CLIENT, + captureReferences: false, + }); + + expect(def.type).toBe(TypeKind.InterfaceKind); + expect(def.children).toHaveLength(2); + expect(def.children![1].type).toBe(TypeKind.FunctionKind); + expect(def.children![1].label).toBe('new'); + expect(def.children![1].id).toBe('def-public.ClassConstructorWithStaticProperties.new'); +}); + it('Function type is exported as type with signature', () => { const node = nodes.find((n) => getNodeName(n) === 'FnWithGeneric'); expect(node).toBeDefined(); diff --git a/packages/kbn-docs-utils/src/api_docs/build_api_declarations/build_api_declaration.ts b/packages/kbn-docs-utils/src/api_docs/build_api_declarations/build_api_declaration.ts index 809097ee73818..2e167c7a0a783 100644 --- a/packages/kbn-docs-utils/src/api_docs/build_api_declarations/build_api_declaration.ts +++ b/packages/kbn-docs-utils/src/api_docs/build_api_declarations/build_api_declaration.ts @@ -65,12 +65,17 @@ export function buildApiDeclaration(node: Node, opts: BuildApiDecOpts): ApiDecla Node.isMethodSignature(node) || Node.isFunctionDeclaration(node) || Node.isMethodDeclaration(node) || + Node.isConstructSignatureDeclaration(node) || Node.isConstructorDeclaration(node) ) { return buildFunctionDec(node, { ...opts, // Use "Constructor" if applicable, instead of the default "Unnamed" - name: Node.isConstructorDeclaration(node) ? 'Constructor' : node.getName() || 'Unnamed', + name: Node.isConstructSignatureDeclaration(node) + ? 'new' + : Node.isConstructorDeclaration(node) + ? 'Constructor' + : node.getName() || 'Unnamed', }); } else if ( Node.isPropertySignature(node) || diff --git a/packages/kbn-docs-utils/src/api_docs/build_api_declarations/build_function_dec.ts b/packages/kbn-docs-utils/src/api_docs/build_api_declarations/build_function_dec.ts index 3ba688f1ee284..020ffd402366a 100644 --- a/packages/kbn-docs-utils/src/api_docs/build_api_declarations/build_function_dec.ts +++ b/packages/kbn-docs-utils/src/api_docs/build_api_declarations/build_function_dec.ts @@ -11,6 +11,7 @@ import { MethodDeclaration, ConstructorDeclaration, MethodSignature, + ConstructSignatureDeclaration, } from 'ts-morph'; import { buildApiDecsForParameters } from './build_parameter_decs'; @@ -23,7 +24,12 @@ import { BuildApiDecOpts } from './types'; * Takes the various function-like node declaration types and converts them into an ApiDeclaration. */ export function buildFunctionDec( - node: FunctionDeclaration | MethodDeclaration | ConstructorDeclaration | MethodSignature, + node: + | ConstructSignatureDeclaration + | FunctionDeclaration + | MethodDeclaration + | ConstructorDeclaration + | MethodSignature, opts: BuildApiDecOpts ): ApiDeclaration { const fn = { diff --git a/packages/kbn-docs-utils/src/api_docs/build_api_declarations/utils.ts b/packages/kbn-docs-utils/src/api_docs/build_api_declarations/utils.ts index a57b1790b27a8..76328a314b066 100644 --- a/packages/kbn-docs-utils/src/api_docs/build_api_declarations/utils.ts +++ b/packages/kbn-docs-utils/src/api_docs/build_api_declarations/utils.ts @@ -46,7 +46,11 @@ export function buildParentApiId(parentName: string, parentsParentApiId?: string } export function getOptsForChild(node: Node, parentOpts: BuildApiDecOpts): BuildApiDecOpts { - const name = isNamedNode(node) ? node.getName() : 'Unnamed'; + const name = Node.isConstructSignatureDeclaration(node) + ? 'new' + : isNamedNode(node) + ? node.getName() + : 'Unnamed'; return getOptsForChildWithName(name, parentOpts); } diff --git a/packages/kbn-docs-utils/src/api_docs/build_api_docs_cli.ts b/packages/kbn-docs-utils/src/api_docs/build_api_docs_cli.ts index 0617e35a88615..41bb6400b92ab 100644 --- a/packages/kbn-docs-utils/src/api_docs/build_api_docs_cli.ts +++ b/packages/kbn-docs-utils/src/api_docs/build_api_docs_cli.ts @@ -65,11 +65,16 @@ export function runBuildApiDocsCli() { // Delete all files except the README that warns about the auto-generated nature of // the folder. const files = Fs.readdirSync(outputFolder); - files.forEach((file) => { - if (file.indexOf('README.md') < 0) { - Fs.rmSync(Path.resolve(outputFolder, file)); - } - }); + await Promise.all( + files + .filter((file) => file.indexOf('README.md') < 0) + .map( + (file) => + new Promise((resolve, reject) => + Fs.rm(Path.resolve(outputFolder, file), (err) => (err ? reject(err) : resolve())) + ) + ) + ); } const collectReferences = flags.references as boolean; diff --git a/packages/kbn-docs-utils/src/api_docs/mdx/split_apis_by_folder.test.ts b/packages/kbn-docs-utils/src/api_docs/mdx/split_apis_by_folder.test.ts index b1862f9bc2165..1a1ecb8ec3e67 100644 --- a/packages/kbn-docs-utils/src/api_docs/mdx/split_apis_by_folder.test.ts +++ b/packages/kbn-docs-utils/src/api_docs/mdx/split_apis_by_folder.test.ts @@ -38,7 +38,7 @@ beforeAll(() => { }); test('foo service has all exports', () => { - expect(doc?.client.length).toBe(37); + expect(doc?.client.length).toBe(38); const split = splitApisByFolder(doc); expect(split.length).toBe(2); @@ -47,5 +47,5 @@ test('foo service has all exports', () => { expect(fooDoc?.common.length).toBe(1); expect(fooDoc?.client.length).toBe(2); - expect(mainDoc?.client.length).toBe(35); + expect(mainDoc?.client.length).toBe(36); }); diff --git a/packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/index.ts b/packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/index.ts index 345e85bc044b7..ad3d1204aeda9 100644 --- a/packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/index.ts +++ b/packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/index.ts @@ -24,6 +24,11 @@ export interface InterfaceWithIndexSignature { [key: string]: { foo: string }; } +export interface ClassConstructorWithStaticProperties { + staticProperty1: string; + new (config: { foo: string }): InterfaceWithIndexSignature; +} + export function plugin() { return new PluginA(); } diff --git a/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_a.devdocs.json b/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_a.devdocs.json index ff977517cb5a7..88e4043442e88 100644 --- a/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_a.devdocs.json +++ b/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_a.devdocs.json @@ -712,6 +712,67 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "pluginA", + "id": "def-public.ClassConstructorWithStaticProperties", + "type": "Interface", + "tags": [], + "label": "ClassConstructorWithStaticProperties", + "description": [], + "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "pluginA", + "id": "def-public.ClassConstructorWithStaticProperties.staticProperty1", + "type": "string", + "tags": [], + "label": "staticProperty1", + "description": [], + "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/index.ts", + "deprecated": false + }, + { + "parentPluginId": "pluginA", + "id": "def-public.ClassConstructorWithStaticProperties.new", + "type": "Function", + "tags": [], + "label": "new", + "description": [], + "signature": [ + "any" + ], + "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "pluginA", + "id": "def-public.ClassConstructorWithStaticProperties.new.$1", + "type": "Object", + "tags": [], + "label": "config", + "description": [], + "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "pluginA", + "id": "def-public.ClassConstructorWithStaticProperties.new.$1.foo", + "type": "string", + "tags": [], + "label": "foo", + "description": [], + "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/index.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, { "parentPluginId": "pluginA", "id": "def-public.ExampleInterface", diff --git a/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_a.mdx b/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_a.mdx index ab80f1f02d0ac..6a66fa74f7c01 100644 --- a/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_a.mdx +++ b/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_a.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/pluginA title: "pluginA" image: https://source.unsplash.com/400x175/?github summary: API docs for the pluginA plugin -date: 2022-02-14 +date: 2022-04-30 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'pluginA'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact Kibana Core for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 131 | 1 | 71 | 2 | +| 136 | 1 | 76 | 2 | ## Client diff --git a/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_a_foo.mdx b/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_a_foo.mdx index e9873f8223017..4082de6306895 100644 --- a/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_a_foo.mdx +++ b/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_a_foo.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/pluginA-foo title: "pluginA.foo" image: https://source.unsplash.com/400x175/?github summary: API docs for the pluginA.foo plugin -date: 2022-02-14 +date: 2022-04-30 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'pluginA.foo'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact Kibana Core for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 131 | 1 | 71 | 2 | +| 136 | 1 | 76 | 2 | ## Client diff --git a/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_b.mdx b/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_b.mdx index 1671cd7a529d3..d69da971f7e3e 100644 --- a/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_b.mdx +++ b/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_b.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/pluginB title: "pluginB" image: https://source.unsplash.com/400x175/?github summary: API docs for the pluginB plugin -date: 2022-02-14 +date: 2022-04-30 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'pluginB'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/packages/kbn-optimizer/limits.yml b/packages/kbn-optimizer/limits.yml index dc16c080306ad..9f73dcd620d30 100644 --- a/packages/kbn-optimizer/limits.yml +++ b/packages/kbn-optimizer/limits.yml @@ -104,8 +104,7 @@ pageLoadAssetSize: fieldFormats: 65209 kibanaReact: 74422 share: 71239 - uiActions: 35121 - dataEnhanced: 24980 + uiActions: 35121 embeddable: 87309 embeddableEnhanced: 22107 uiActionsEnhanced: 38494 @@ -123,9 +122,9 @@ pageLoadAssetSize: sessionView: 77750 cloudSecurityPosture: 19109 visTypeGauge: 24113 - unifiedSearch: 104869 + unifiedSearch: 71059 data: 454087 - expressionXY: 26500 eventAnnotation: 19334 screenshotting: 22870 synthetics: 40958 + expressionXY: 29000 diff --git a/packages/kbn-pm/dist/index.js b/packages/kbn-pm/dist/index.js index b0aabefb1b0f2..6638acfef5ef4 100644 --- a/packages/kbn-pm/dist/index.js +++ b/packages/kbn-pm/dist/index.js @@ -1580,6 +1580,8 @@ var _ciStatsCore = __webpack_require__("../../node_modules/@kbn/ci-stats-core/ta */ // @ts-expect-error not "public", but necessary to prevent Jest shimming from breaking things const BASE_URL = 'https://ci-stats.kibana.dev'; +const SECOND = 1000; +const MINUTE = 60 * SECOND; function limitMetaStrings(meta) { return Object.fromEntries(Object.entries(meta).map(([key, value]) => { @@ -1782,7 +1784,8 @@ class CiStatsReporter { groupType: group.type }, bodyDesc: `[${group.name}/${group.type}] Chunk of ${bufferBytes} bytes`, - body: buffer.join('\n') + body: buffer.join('\n'), + timeout: 5 * MINUTE }); buffer.length = 0; bufferBytes = 0; @@ -1851,7 +1854,8 @@ class CiStatsReporter { body, bodyDesc, path, - query + query, + timeout = 60 * SECOND }) { let attempt = 0; const maxAttempts = 5; @@ -1879,7 +1883,8 @@ class CiStatsReporter { adapter: _http.default, // if it can be serialized into a string, send it maxBodyLength: Infinity, - maxContentLength: Infinity + maxContentLength: Infinity, + timeout }); return resp.data; } catch (error) { diff --git a/src/core/server/saved_objects/import/import_saved_objects.ts b/src/core/server/saved_objects/import/import_saved_objects.ts index 0631d97b58a72..9e9f5f8b050dc 100644 --- a/src/core/server/saved_objects/import/import_saved_objects.ts +++ b/src/core/server/saved_objects/import/import_saved_objects.ts @@ -35,6 +35,8 @@ export interface ImportSavedObjectsOptions { objectLimit: number; /** If true, will override existing object if present. Note: this has no effect when used with the `createNewCopies` option. */ overwrite: boolean; + /** Refresh setting, defaults to `wait_for` */ + refresh?: boolean | 'wait_for'; /** {@link SavedObjectsClientContract | client} to use to perform the import operation */ savedObjectsClient: SavedObjectsClientContract; /** The registry of all known saved object types */ @@ -62,6 +64,7 @@ export async function importSavedObjectsFromStream({ typeRegistry, importHooks, namespace, + refresh, }: ImportSavedObjectsOptions): Promise { let errorAccumulator: SavedObjectsImportFailure[] = []; const supportedTypes = typeRegistry.getImportableAndExportableTypes().map((type) => type.name); @@ -141,6 +144,7 @@ export async function importSavedObjectsFromStream({ importStateMap, overwrite, namespace, + refresh, }; const createSavedObjectsResult = await createSavedObjects(createSavedObjectsParams); errorAccumulator = [...errorAccumulator, ...createSavedObjectsResult.errors]; diff --git a/src/core/server/saved_objects/import/lib/create_saved_objects.ts b/src/core/server/saved_objects/import/lib/create_saved_objects.ts index bf58b2bb4b00e..d6c7cbe934b51 100644 --- a/src/core/server/saved_objects/import/lib/create_saved_objects.ts +++ b/src/core/server/saved_objects/import/lib/create_saved_objects.ts @@ -18,6 +18,7 @@ export interface CreateSavedObjectsParams { importStateMap: ImportStateMap; namespace?: string; overwrite?: boolean; + refresh?: boolean | 'wait_for'; } export interface CreateSavedObjectsResult { createdObjects: Array>; @@ -35,6 +36,7 @@ export const createSavedObjects = async ({ importStateMap, namespace, overwrite, + refresh, }: CreateSavedObjectsParams): Promise> => { // filter out any objects that resulted in errors const errorSet = accumulatedErrors.reduce( @@ -87,6 +89,7 @@ export const createSavedObjects = async ({ const bulkCreateResponse = await savedObjectsClient.bulkCreate(objectsToCreate, { namespace, overwrite, + refresh, }); expectedResults = bulkCreateResponse.saved_objects; } diff --git a/src/core/server/saved_objects/import/saved_objects_importer.ts b/src/core/server/saved_objects/import/saved_objects_importer.ts index f4572e58d6fad..e9c54f7b44deb 100644 --- a/src/core/server/saved_objects/import/saved_objects_importer.ts +++ b/src/core/server/saved_objects/import/saved_objects_importer.ts @@ -66,12 +66,14 @@ export class SavedObjectsImporter { createNewCopies, namespace, overwrite, + refresh, }: SavedObjectsImportOptions): Promise { return importSavedObjectsFromStream({ readStream, createNewCopies, namespace, overwrite, + refresh, objectLimit: this.#importSizeLimit, savedObjectsClient: this.#savedObjectsClient, typeRegistry: this.#typeRegistry, diff --git a/src/core/server/saved_objects/import/types.ts b/src/core/server/saved_objects/import/types.ts index ccf58c99f1ad8..d3a38b48e92cb 100644 --- a/src/core/server/saved_objects/import/types.ts +++ b/src/core/server/saved_objects/import/types.ts @@ -155,6 +155,8 @@ export interface SavedObjectsImportOptions { namespace?: string; /** If true, will create new copies of import objects, each with a random `id` and undefined `originId`. */ createNewCopies: boolean; + /** Refresh setting, defaults to `wait_for` */ + refresh?: boolean | 'wait_for'; } /** diff --git a/src/core/server/server.api.md b/src/core/server/server.api.md index 2228c8fee8794..ea83e210cc4e1 100644 --- a/src/core/server/server.api.md +++ b/src/core/server/server.api.md @@ -2541,7 +2541,7 @@ export class SavedObjectsImporter { typeRegistry: ISavedObjectTypeRegistry; importSizeLimit: number; }); - import({ readStream, createNewCopies, namespace, overwrite, }: SavedObjectsImportOptions): Promise; + import({ readStream, createNewCopies, namespace, overwrite, refresh, }: SavedObjectsImportOptions): Promise; resolveImportErrors({ readStream, createNewCopies, namespace, retries, }: SavedObjectsResolveImportErrorsOptions): Promise; } @@ -2604,6 +2604,7 @@ export interface SavedObjectsImportOptions { namespace?: string; overwrite: boolean; readStream: Readable; + refresh?: boolean | 'wait_for'; } // @public diff --git a/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker b/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker index 7b569f8d02068..77e8e5d63bbdf 100755 --- a/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker +++ b/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker @@ -40,6 +40,13 @@ kibana_vars=( csp.report_to data.autocomplete.valueSuggestions.terminateAfter data.autocomplete.valueSuggestions.timeout + data.search.sessions.defaultExpiration + data.search.sessions.enabled + data.search.sessions.maxUpdateRetries + data.search.sessions.notTouchedInProgressTimeout + data.search.sessions.notTouchedTimeout + data.search.sessions.pageSize + data.search.sessions.trackingInterval unifiedSearch.autocomplete.valueSuggestions.terminateAfter unifiedSearch.autocomplete.valueSuggestions.timeout unifiedSearch.autocomplete.querySuggestions.enabled diff --git a/src/dev/storybook/aliases.ts b/src/dev/storybook/aliases.ts index 8075abcdcf79b..4167719d3bb31 100644 --- a/src/dev/storybook/aliases.ts +++ b/src/dev/storybook/aliases.ts @@ -17,7 +17,7 @@ export const storybookAliases = { custom_integrations: 'src/plugins/custom_integrations/storybook', dashboard_enhanced: 'x-pack/plugins/dashboard_enhanced/.storybook', dashboard: 'src/plugins/dashboard/.storybook', - data_enhanced: 'x-pack/plugins/data_enhanced/.storybook', + data: 'src/plugins/data/.storybook', discover: 'src/plugins/discover/.storybook', embeddable: 'src/plugins/embeddable/.storybook', expression_error: 'src/plugins/expression_error/.storybook', diff --git a/src/plugins/chart_expressions/expression_partition_vis/public/components/partition_vis_component.test.tsx b/src/plugins/chart_expressions/expression_partition_vis/public/components/partition_vis_component.test.tsx index 1281fb17bd990..648df546b2992 100644 --- a/src/plugins/chart_expressions/expression_partition_vis/public/components/partition_vis_component.test.tsx +++ b/src/plugins/chart_expressions/expression_partition_vis/public/components/partition_vis_component.test.tsx @@ -12,7 +12,8 @@ import { chartPluginMock } from '@kbn/charts-plugin/public/mocks'; import { dataPluginMock } from '@kbn/data-plugin/public/mocks'; import { fieldFormatsServiceMock } from '@kbn/field-formats-plugin/public/mocks'; import type { Datatable } from '@kbn/expressions-plugin/public'; -import { shallow, mount } from 'enzyme'; +import { shallow } from 'enzyme'; +import { mountWithIntl } from '@kbn/test-jest-helpers'; import { findTestSubject } from '@elastic/eui/lib/test'; import { act } from 'react-dom/test-utils'; import PartitionVisComponent, { PartitionVisComponentProps } from './partition_vis_component'; @@ -143,7 +144,7 @@ describe('PartitionVisComponent', function () { }); it('renders the legend toggle component', async () => { - const component = mount(); + const component = mountWithIntl(); await actWithTimeout(async () => { await component.update(); }); @@ -154,7 +155,7 @@ describe('PartitionVisComponent', function () { }); it('hides the legend if the legend toggle is clicked', async () => { - const component = mount(); + const component = mountWithIntl(); await actWithTimeout(async () => { await component.update(); }); @@ -233,7 +234,7 @@ describe('PartitionVisComponent', function () { ], } as unknown as Datatable; const newProps = { ...wrapperProps, visData: newVisData }; - const component = mount(); + const component = mountWithIntl(); expect(findTestSubject(component, 'partitionVisEmptyValues').text()).toEqual( 'No results found' ); @@ -264,7 +265,7 @@ describe('PartitionVisComponent', function () { ], } as unknown as Datatable; const newProps = { ...wrapperProps, visData: newVisData }; - const component = mount(); + const component = mountWithIntl(); expect(findTestSubject(component, 'partitionVisNegativeValues').text()).toEqual( "Pie chart can't render with negative values." ); diff --git a/src/plugins/chart_expressions/expression_xy/common/__mocks__/index.ts b/src/plugins/chart_expressions/expression_xy/common/__mocks__/index.ts index f225846687e14..3a4a1fdb813fc 100644 --- a/src/plugins/chart_expressions/expression_xy/common/__mocks__/index.ts +++ b/src/plugins/chart_expressions/expression_xy/common/__mocks__/index.ts @@ -10,7 +10,7 @@ import { Position } from '@elastic/charts'; import type { PaletteOutput } from '@kbn/coloring'; import { Datatable, DatatableRow } from '@kbn/expressions-plugin'; import { LayerTypes } from '../constants'; -import { DataLayerConfigResult, LensMultiTable, XYArgs } from '../types'; +import { DataLayerConfig, XYProps } from '../types'; export const mockPaletteOutput: PaletteOutput = { type: 'palette', @@ -46,9 +46,9 @@ export const createSampleDatatableWithRows = (rows: DatatableRow[]): Datatable = rows, }); -export const sampleLayer: DataLayerConfigResult = { - type: 'dataLayer', +export const sampleLayer: DataLayerConfig = { layerId: 'first', + type: 'dataLayer', layerType: LayerTypes.DATA, seriesType: 'line', xAccessor: 'c', @@ -59,9 +59,12 @@ export const sampleLayer: DataLayerConfigResult = { yScaleType: 'linear', isHistogram: false, palette: mockPaletteOutput, + table: createSampleDatatableWithRows([]), }; -export const createArgsWithLayers = (layers: DataLayerConfigResult[] = [sampleLayer]): XYArgs => ({ +export const createArgsWithLayers = ( + layers: DataLayerConfig | DataLayerConfig[] = sampleLayer +): XYProps => ({ xTitle: '', yTitle: '', yRightTitle: '', @@ -104,25 +107,17 @@ export const createArgsWithLayers = (layers: DataLayerConfigResult[] = [sampleLa mode: 'full', type: 'axisExtentConfig', }, - layers, + layers: Array.isArray(layers) ? layers : [layers], }); export function sampleArgs() { - const data: LensMultiTable = { - type: 'lens_multitable', - tables: { - first: createSampleDatatableWithRows([ - { a: 1, b: 2, c: 'I', d: 'Foo' }, - { a: 1, b: 5, c: 'J', d: 'Bar' }, - ]), - }, - dateRange: { - fromDate: new Date('2019-01-02T05:00:00.000Z'), - toDate: new Date('2019-01-03T05:00:00.000Z'), - }, - }; - - const args: XYArgs = createArgsWithLayers(); + const data = createSampleDatatableWithRows([ + { a: 1, b: 2, c: 'I', d: 'Foo' }, + { a: 1, b: 5, c: 'J', d: 'Bar' }, + ]); - return { data, args }; + return { + data, + args: createArgsWithLayers({ ...sampleLayer, table: data }), + }; } diff --git a/src/plugins/chart_expressions/expression_xy/common/constants.ts b/src/plugins/chart_expressions/expression_xy/common/constants.ts index bf1e43b205843..931ece6ef8a78 100644 --- a/src/plugins/chart_expressions/expression_xy/common/constants.ts +++ b/src/plugins/chart_expressions/expression_xy/common/constants.ts @@ -7,16 +7,21 @@ */ export const XY_VIS = 'xyVis'; +export const LAYERED_XY_VIS = 'layeredXyVis'; export const Y_CONFIG = 'yConfig'; +export const EXTENDED_Y_CONFIG = 'extendedYConfig'; export const MULTITABLE = 'lens_multitable'; export const DATA_LAYER = 'dataLayer'; +export const EXTENDED_DATA_LAYER = 'extendedDataLayer'; export const LEGEND_CONFIG = 'legendConfig'; export const XY_VIS_RENDERER = 'xyVis'; export const GRID_LINES_CONFIG = 'gridlinesConfig'; export const ANNOTATION_LAYER = 'annotationLayer'; +export const EXTENDED_ANNOTATION_LAYER = 'extendedAnnotationLayer'; export const TICK_LABELS_CONFIG = 'tickLabelsConfig'; export const AXIS_EXTENT_CONFIG = 'axisExtentConfig'; export const REFERENCE_LINE_LAYER = 'referenceLineLayer'; +export const EXTENDED_REFERENCE_LINE_LAYER = 'extendedReferenceLineLayer'; export const LABELS_ORIENTATION_CONFIG = 'labelsOrientationConfig'; export const AXIS_TITLES_VISIBILITY_CONFIG = 'axisTitlesVisibilityConfig'; @@ -106,6 +111,23 @@ export const XYCurveTypes = { export const ValueLabelModes = { HIDE: 'hide', - INSIDE: 'inside', - OUTSIDE: 'outside', + SHOW: 'show', +} as const; + +export const AvailableReferenceLineIcons = { + EMPTY: 'empty', + ASTERISK: 'asterisk', + ALERT: 'alert', + BELL: 'bell', + BOLT: 'bolt', + BUG: 'bug', + CIRCLE: 'circle', + EDITOR_COMMENT: 'editorComment', + FLAG: 'flag', + HEART: 'heart', + MAP_MARKER: 'mapMarker', + PIN_FILLED: 'pinFilled', + STAR_EMPTY: 'starEmpty', + TAG: 'tag', + TRIANGLE: 'triangle', } as const; diff --git a/src/plugins/chart_expressions/expression_xy/common/expression_functions/annotation_layer_config.ts b/src/plugins/chart_expressions/expression_xy/common/expression_functions/annotation_layer.ts similarity index 64% rename from src/plugins/chart_expressions/expression_xy/common/expression_functions/annotation_layer_config.ts rename to src/plugins/chart_expressions/expression_xy/common/expression_functions/annotation_layer.ts index 9ec3a43e1d710..6174b9d40e452 100644 --- a/src/plugins/chart_expressions/expression_xy/common/expression_functions/annotation_layer_config.ts +++ b/src/plugins/chart_expressions/expression_xy/common/expression_functions/annotation_layer.ts @@ -6,13 +6,14 @@ * Side Public License, v 1. */ -import type { ExpressionFunctionDefinition } from '@kbn/expressions-plugin/common'; +import type { Datatable, ExpressionFunctionDefinition } from '@kbn/expressions-plugin/common'; import { LayerTypes, ANNOTATION_LAYER } from '../constants'; import { AnnotationLayerArgs, AnnotationLayerConfigResult } from '../types'; +import { strings } from '../i18n'; -export function annotationLayerConfigFunction(): ExpressionFunctionDefinition< +export function annotationLayerFunction(): ExpressionFunctionDefinition< typeof ANNOTATION_LAYER, - null, + Datatable, AnnotationLayerArgs, AnnotationLayerConfigResult > { @@ -20,21 +21,17 @@ export function annotationLayerConfigFunction(): ExpressionFunctionDefinition< name: ANNOTATION_LAYER, aliases: [], type: ANNOTATION_LAYER, - inputTypes: ['null'], - help: 'Annotation layer in lens', + inputTypes: ['datatable'], + help: strings.getAnnotationLayerFnHelp(), args: { - layerId: { - types: ['string'], - help: '', - }, hide: { types: ['boolean'], default: false, - help: 'Show details', + help: strings.getAnnotationLayerHideHelp(), }, annotations: { - types: ['manual_event_annotation'], - help: '', + types: ['manual_point_event_annotation', 'manual_range_event_annotation'], + help: strings.getAnnotationLayerAnnotationsHelp(), multi: true, }, }, @@ -42,6 +39,7 @@ export function annotationLayerConfigFunction(): ExpressionFunctionDefinition< return { type: ANNOTATION_LAYER, ...args, + annotations: args.annotations ?? [], layerType: LayerTypes.ANNOTATIONS, }; }, diff --git a/src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_extent_config.ts b/src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_extent_config.ts index e65550c7aeeef..c1a4070225a64 100644 --- a/src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_extent_config.ts +++ b/src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_extent_config.ts @@ -11,6 +11,13 @@ import type { ExpressionFunctionDefinition } from '@kbn/expressions-plugin/commo import { AxisExtentConfig, AxisExtentConfigResult } from '../types'; import { AxisExtentModes, AXIS_EXTENT_CONFIG } from '../constants'; +const errors = { + upperBoundLowerOrEqualToLowerBoundError: () => + i18n.translate('expressionXY.reusable.function.axisExtentConfig.errors.emptyUpperBound', { + defaultMessage: 'Upper bound should be greater than lower bound, if custom mode is enabled.', + }), +}; + export const axisExtentConfigFunction: ExpressionFunctionDefinition< typeof AXIS_EXTENT_CONFIG, null, @@ -27,10 +34,12 @@ export const axisExtentConfigFunction: ExpressionFunctionDefinition< args: { mode: { types: ['string'], - options: [...Object.values(AxisExtentModes)], help: i18n.translate('expressionXY.axisExtentConfig.extentMode.help', { defaultMessage: 'The extent mode', }), + options: [...Object.values(AxisExtentModes)], + strict: true, + default: AxisExtentModes.FULL, }, lowerBound: { types: ['number'], @@ -46,6 +55,16 @@ export const axisExtentConfigFunction: ExpressionFunctionDefinition< }, }, fn(input, args) { + if (args.mode === AxisExtentModes.CUSTOM) { + if ( + args.lowerBound !== undefined && + args.upperBound !== undefined && + args.lowerBound >= args.upperBound + ) { + throw new Error(errors.upperBoundLowerOrEqualToLowerBoundError()); + } + } + return { type: AXIS_EXTENT_CONFIG, ...args, diff --git a/src/plugins/chart_expressions/expression_xy/common/expression_functions/common_data_layer_args.ts b/src/plugins/chart_expressions/expression_xy/common/expression_functions/common_data_layer_args.ts new file mode 100644 index 0000000000000..49446310a894b --- /dev/null +++ b/src/plugins/chart_expressions/expression_xy/common/expression_functions/common_data_layer_args.ts @@ -0,0 +1,72 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { SeriesTypes, XScaleTypes, YScaleTypes, Y_CONFIG } from '../constants'; +import { strings } from '../i18n'; +import { DataLayerFn, ExtendedDataLayerFn } from '../types'; + +type CommonDataLayerFn = DataLayerFn | ExtendedDataLayerFn; + +export const commonDataLayerArgs: CommonDataLayerFn['args'] = { + hide: { + types: ['boolean'], + default: false, + help: strings.getHideHelp(), + }, + xAccessor: { + types: ['string'], + help: strings.getXAccessorHelp(), + }, + seriesType: { + types: ['string'], + options: [...Object.values(SeriesTypes)], + help: strings.getSeriesTypeHelp(), + required: true, + strict: true, + }, + xScaleType: { + options: [...Object.values(XScaleTypes)], + help: strings.getXScaleTypeHelp(), + default: XScaleTypes.ORDINAL, + strict: true, + }, + isHistogram: { + types: ['boolean'], + default: false, + help: strings.getIsHistogramHelp(), + }, + yScaleType: { + options: [...Object.values(YScaleTypes)], + help: strings.getYScaleTypeHelp(), + default: YScaleTypes.LINEAR, + strict: true, + }, + splitAccessor: { + types: ['string'], + help: strings.getSplitAccessorHelp(), + }, + accessors: { + types: ['string'], + help: strings.getAccessorsHelp(), + multi: true, + }, + yConfig: { + types: [Y_CONFIG], + help: strings.getYConfigHelp(), + multi: true, + }, + columnToLabel: { + types: ['string'], + help: strings.getColumnToLabelHelp(), + }, + palette: { + types: ['palette', 'system_palette'], + help: strings.getPaletteHelp(), + default: '{palette}', + }, +}; diff --git a/src/plugins/chart_expressions/expression_xy/common/expression_functions/common_reference_line_layer_args.ts b/src/plugins/chart_expressions/expression_xy/common/expression_functions/common_reference_line_layer_args.ts new file mode 100644 index 0000000000000..f338e08a88940 --- /dev/null +++ b/src/plugins/chart_expressions/expression_xy/common/expression_functions/common_reference_line_layer_args.ts @@ -0,0 +1,30 @@ +/* + * Copyright 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 { EXTENDED_Y_CONFIG } from '../constants'; +import { strings } from '../i18n'; +import { ReferenceLineLayerFn, ExtendedReferenceLineLayerFn } from '../types'; + +type CommonReferenceLineLayerFn = ReferenceLineLayerFn | ExtendedReferenceLineLayerFn; + +export const commonReferenceLineLayerArgs: CommonReferenceLineLayerFn['args'] = { + accessors: { + types: ['string'], + help: strings.getRLAccessorsHelp(), + multi: true, + }, + yConfig: { + types: [EXTENDED_Y_CONFIG], + help: strings.getRLYConfigHelp(), + multi: true, + }, + columnToLabel: { + types: ['string'], + help: strings.getColumnToLabelHelp(), + }, +}; diff --git a/src/plugins/chart_expressions/expression_xy/common/expression_functions/common_xy_args.ts b/src/plugins/chart_expressions/expression_xy/common/expression_functions/common_xy_args.ts new file mode 100644 index 0000000000000..f80d814571076 --- /dev/null +++ b/src/plugins/chart_expressions/expression_xy/common/expression_functions/common_xy_args.ts @@ -0,0 +1,118 @@ +/* + * Copyright 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 { + AXIS_EXTENT_CONFIG, + AXIS_TITLES_VISIBILITY_CONFIG, + EndValues, + FittingFunctions, + GRID_LINES_CONFIG, + LABELS_ORIENTATION_CONFIG, + LEGEND_CONFIG, + TICK_LABELS_CONFIG, + ValueLabelModes, + XYCurveTypes, +} from '../constants'; +import { strings } from '../i18n'; +import { LayeredXyVisFn, XyVisFn } from '../types'; + +type CommonXYFn = XyVisFn | LayeredXyVisFn; + +export const commonXYArgs: CommonXYFn['args'] = { + xTitle: { + types: ['string'], + help: strings.getXTitleHelp(), + }, + yTitle: { + types: ['string'], + help: strings.getYTitleHelp(), + }, + yRightTitle: { + types: ['string'], + help: strings.getYRightTitleHelp(), + }, + yLeftExtent: { + types: [AXIS_EXTENT_CONFIG], + help: strings.getYLeftExtentHelp(), + default: `{${AXIS_EXTENT_CONFIG}}`, + }, + yRightExtent: { + types: [AXIS_EXTENT_CONFIG], + help: strings.getYRightExtentHelp(), + default: `{${AXIS_EXTENT_CONFIG}}`, + }, + legend: { + types: [LEGEND_CONFIG], + help: strings.getLegendHelp(), + default: `{${LEGEND_CONFIG}}`, + }, + fittingFunction: { + types: ['string'], + options: [...Object.values(FittingFunctions)], + help: strings.getFittingFunctionHelp(), + strict: true, + }, + endValue: { + types: ['string'], + options: [...Object.values(EndValues)], + help: strings.getEndValueHelp(), + strict: true, + }, + emphasizeFitting: { + types: ['boolean'], + default: false, + help: '', + }, + valueLabels: { + types: ['string'], + options: [...Object.values(ValueLabelModes)], + help: strings.getValueLabelsHelp(), + strict: true, + default: ValueLabelModes.HIDE, + }, + tickLabelsVisibilitySettings: { + types: [TICK_LABELS_CONFIG], + help: strings.getTickLabelsVisibilitySettingsHelp(), + }, + labelsOrientation: { + types: [LABELS_ORIENTATION_CONFIG], + help: strings.getLabelsOrientationHelp(), + }, + gridlinesVisibilitySettings: { + types: [GRID_LINES_CONFIG], + help: strings.getGridlinesVisibilitySettingsHelp(), + }, + axisTitlesVisibilitySettings: { + types: [AXIS_TITLES_VISIBILITY_CONFIG], + help: strings.getAxisTitlesVisibilitySettingsHelp(), + }, + curveType: { + types: ['string'], + options: [...Object.values(XYCurveTypes)], + help: strings.getCurveTypeHelp(), + strict: true, + }, + fillOpacity: { + types: ['number'], + help: strings.getFillOpacityHelp(), + }, + hideEndzones: { + types: ['boolean'], + default: false, + help: strings.getHideEndzonesHelp(), + }, + valuesInLegend: { + types: ['boolean'], + default: false, + help: strings.getValuesInLegendHelp(), + }, + ariaLabel: { + types: ['string'], + help: strings.getAriaLabelHelp(), + }, +}; diff --git a/src/plugins/chart_expressions/expression_xy/common/expression_functions/common_y_config_args.ts b/src/plugins/chart_expressions/expression_xy/common/expression_functions/common_y_config_args.ts new file mode 100644 index 0000000000000..76ac6ba2a1a97 --- /dev/null +++ b/src/plugins/chart_expressions/expression_xy/common/expression_functions/common_y_config_args.ts @@ -0,0 +1,30 @@ +/* + * Copyright 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 { YAxisModes } from '../constants'; +import { strings } from '../i18n'; +import { YConfigFn, ExtendedYConfigFn } from '../types'; + +type CommonYConfigFn = YConfigFn | ExtendedYConfigFn; + +export const commonYConfigArgs: CommonYConfigFn['args'] = { + forAccessor: { + types: ['string'], + help: strings.getForAccessorHelp(), + }, + axisMode: { + types: ['string'], + options: [...Object.values(YAxisModes)], + help: strings.getAxisModeHelp(), + strict: true, + }, + color: { + types: ['string'], + help: strings.getColorHelp(), + }, +}; diff --git a/src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.test.ts b/src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer.test.ts similarity index 70% rename from src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.test.ts rename to src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer.test.ts index 7f8bf30d956ff..518690d47bfcb 100644 --- a/src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.test.ts +++ b/src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer.test.ts @@ -7,15 +7,15 @@ */ import { DataLayerArgs } from '../types'; -import { dataLayerConfigFunction } from '.'; import { createMockExecutionContext } from '@kbn/expressions-plugin/common/mocks'; -import { mockPaletteOutput } from '../__mocks__'; +import { mockPaletteOutput, sampleArgs } from '../__mocks__'; import { LayerTypes } from '../constants'; +import { dataLayerFunction } from './data_layer'; describe('dataLayerConfig', () => { test('produces the correct arguments', () => { + const { data } = sampleArgs(); const args: DataLayerArgs = { - layerId: 'first', seriesType: 'line', xAccessor: 'c', accessors: ['a', 'b'], @@ -26,8 +26,13 @@ describe('dataLayerConfig', () => { palette: mockPaletteOutput, }; - const result = dataLayerConfigFunction.fn(null, args, createMockExecutionContext()); + const result = dataLayerFunction.fn(data, args, createMockExecutionContext()); - expect(result).toEqual({ type: 'dataLayer', layerType: LayerTypes.DATA, ...args }); + expect(result).toEqual({ + type: 'dataLayer', + layerType: LayerTypes.DATA, + ...args, + table: data, + }); }); }); diff --git a/src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer.ts b/src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer.ts new file mode 100644 index 0000000000000..f36a0ea4c101f --- /dev/null +++ b/src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer.ts @@ -0,0 +1,30 @@ +/* + * Copyright 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 { DataLayerFn } from '../types'; +import { DATA_LAYER, LayerTypes } from '../constants'; +import { strings } from '../i18n'; +import { commonDataLayerArgs } from './common_data_layer_args'; + +export const dataLayerFunction: DataLayerFn = { + name: DATA_LAYER, + aliases: [], + type: DATA_LAYER, + help: strings.getDataLayerFnHelp(), + inputTypes: ['datatable'], + args: { ...commonDataLayerArgs }, + fn(table, args) { + return { + type: DATA_LAYER, + ...args, + accessors: args.accessors ?? [], + layerType: LayerTypes.DATA, + table, + }; + }, +}; diff --git a/src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts b/src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts deleted file mode 100644 index d09b8481a6842..0000000000000 --- a/src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts +++ /dev/null @@ -1,123 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import { i18n } from '@kbn/i18n'; -import type { ExpressionFunctionDefinition } from '@kbn/expressions-plugin/common'; -import { DataLayerArgs, DataLayerConfigResult } from '../types'; -import { - DATA_LAYER, - LayerTypes, - SeriesTypes, - XScaleTypes, - YScaleTypes, - Y_CONFIG, -} from '../constants'; - -export const dataLayerConfigFunction: ExpressionFunctionDefinition< - typeof DATA_LAYER, - null, - DataLayerArgs, - DataLayerConfigResult -> = { - name: DATA_LAYER, - aliases: [], - type: DATA_LAYER, - help: i18n.translate('expressionXY.dataLayer.help', { - defaultMessage: `Configure a layer in the xy chart`, - }), - inputTypes: ['null'], - args: { - hide: { - types: ['boolean'], - default: false, - help: i18n.translate('expressionXY.dataLayer.hide.help', { - defaultMessage: 'Show / hide axis', - }), - }, - layerId: { - types: ['string'], - help: i18n.translate('expressionXY.dataLayer.layerId.help', { - defaultMessage: 'Layer ID', - }), - }, - xAccessor: { - types: ['string'], - help: i18n.translate('expressionXY.dataLayer.xAccessor.help', { - defaultMessage: 'X-axis', - }), - }, - seriesType: { - types: ['string'], - options: [...Object.values(SeriesTypes)], - help: i18n.translate('expressionXY.dataLayer.seriesType.help', { - defaultMessage: 'The type of chart to display.', - }), - }, - xScaleType: { - options: [...Object.values(XScaleTypes)], - help: i18n.translate('expressionXY.dataLayer.xScaleType.help', { - defaultMessage: 'The scale type of the x axis', - }), - default: XScaleTypes.ORDINAL, - }, - isHistogram: { - types: ['boolean'], - default: false, - help: i18n.translate('expressionXY.dataLayer.isHistogram.help', { - defaultMessage: 'Whether to layout the chart as a histogram', - }), - }, - yScaleType: { - options: [...Object.values(YScaleTypes)], - help: i18n.translate('expressionXY.dataLayer.yScaleType.help', { - defaultMessage: 'The scale type of the y axes', - }), - default: YScaleTypes.LINEAR, - }, - splitAccessor: { - types: ['string'], - help: i18n.translate('expressionXY.dataLayer.splitAccessor.help', { - defaultMessage: 'The column to split by', - }), - }, - accessors: { - types: ['string'], - help: i18n.translate('expressionXY.dataLayer.accessors.help', { - defaultMessage: 'The columns to display on the y axis.', - }), - multi: true, - }, - yConfig: { - types: [Y_CONFIG], - help: i18n.translate('expressionXY.dataLayer.yConfig.help', { - defaultMessage: 'Additional configuration for y axes', - }), - multi: true, - }, - columnToLabel: { - types: ['string'], - help: i18n.translate('expressionXY.dataLayer.columnToLabel.help', { - defaultMessage: 'JSON key-value pairs of column ID to label', - }), - }, - palette: { - types: ['palette', 'system_palette'], - help: i18n.translate('expressionXY.dataLayer.palette.help', { - defaultMessage: 'Palette', - }), - default: '{palette}', - }, - }, - fn(input, args) { - return { - type: DATA_LAYER, - ...args, - layerType: LayerTypes.DATA, - }; - }, -}; diff --git a/src/plugins/chart_expressions/expression_xy/common/expression_functions/extended_annotation_layer.ts b/src/plugins/chart_expressions/expression_xy/common/expression_functions/extended_annotation_layer.ts new file mode 100644 index 0000000000000..539c11854355c --- /dev/null +++ b/src/plugins/chart_expressions/expression_xy/common/expression_functions/extended_annotation_layer.ts @@ -0,0 +1,51 @@ +/* + * Copyright 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 { Datatable, ExpressionFunctionDefinition } from '@kbn/expressions-plugin/common'; +import { LayerTypes, EXTENDED_ANNOTATION_LAYER } from '../constants'; +import { ExtendedAnnotationLayerConfigResult, ExtendedAnnotationLayerArgs } from '../types'; +import { strings } from '../i18n'; + +export function extendedAnnotationLayerFunction(): ExpressionFunctionDefinition< + typeof EXTENDED_ANNOTATION_LAYER, + Datatable, + ExtendedAnnotationLayerArgs, + ExtendedAnnotationLayerConfigResult +> { + return { + name: EXTENDED_ANNOTATION_LAYER, + aliases: [], + type: EXTENDED_ANNOTATION_LAYER, + inputTypes: ['datatable'], + help: strings.getAnnotationLayerFnHelp(), + args: { + hide: { + types: ['boolean'], + default: false, + help: strings.getAnnotationLayerHideHelp(), + }, + annotations: { + types: ['manual_point_event_annotation', 'manual_range_event_annotation'], + help: strings.getAnnotationLayerAnnotationsHelp(), + multi: true, + }, + layerId: { + types: ['string'], + help: strings.getLayerIdHelp(), + }, + }, + fn: (input, args) => { + return { + type: EXTENDED_ANNOTATION_LAYER, + ...args, + annotations: args.annotations ?? [], + layerType: LayerTypes.ANNOTATIONS, + }; + }, + }; +} diff --git a/src/plugins/chart_expressions/expression_xy/common/expression_functions/extended_data_layer.ts b/src/plugins/chart_expressions/expression_xy/common/expression_functions/extended_data_layer.ts new file mode 100644 index 0000000000000..84c1213fc069d --- /dev/null +++ b/src/plugins/chart_expressions/expression_xy/common/expression_functions/extended_data_layer.ts @@ -0,0 +1,40 @@ +/* + * Copyright 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 { ExtendedDataLayerFn } from '../types'; +import { EXTENDED_DATA_LAYER, LayerTypes } from '../constants'; +import { strings } from '../i18n'; +import { commonDataLayerArgs } from './common_data_layer_args'; + +export const extendedDataLayerFunction: ExtendedDataLayerFn = { + name: EXTENDED_DATA_LAYER, + aliases: [], + type: EXTENDED_DATA_LAYER, + help: strings.getDataLayerFnHelp(), + inputTypes: ['datatable'], + args: { + ...commonDataLayerArgs, + table: { + types: ['datatable'], + help: strings.getTableHelp(), + }, + layerId: { + types: ['string'], + help: strings.getLayerIdHelp(), + }, + }, + fn(input, args) { + return { + type: EXTENDED_DATA_LAYER, + ...args, + accessors: args.accessors ?? [], + layerType: LayerTypes.DATA, + table: args.table ?? input, + }; + }, +}; diff --git a/src/plugins/chart_expressions/expression_xy/common/expression_functions/extended_reference_line_layer.ts b/src/plugins/chart_expressions/expression_xy/common/expression_functions/extended_reference_line_layer.ts new file mode 100644 index 0000000000000..4f75838bea114 --- /dev/null +++ b/src/plugins/chart_expressions/expression_xy/common/expression_functions/extended_reference_line_layer.ts @@ -0,0 +1,40 @@ +/* + * Copyright 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 { LayerTypes, EXTENDED_REFERENCE_LINE_LAYER } from '../constants'; +import { ExtendedReferenceLineLayerFn } from '../types'; +import { strings } from '../i18n'; +import { commonReferenceLineLayerArgs } from './common_reference_line_layer_args'; + +export const extendedReferenceLineLayerFunction: ExtendedReferenceLineLayerFn = { + name: EXTENDED_REFERENCE_LINE_LAYER, + aliases: [], + type: EXTENDED_REFERENCE_LINE_LAYER, + help: strings.getRLHelp(), + inputTypes: ['datatable'], + args: { + ...commonReferenceLineLayerArgs, + table: { + types: ['datatable'], + help: strings.getTableHelp(), + }, + layerId: { + types: ['string'], + help: strings.getLayerIdHelp(), + }, + }, + fn(input, args) { + return { + type: EXTENDED_REFERENCE_LINE_LAYER, + ...args, + accessors: args.accessors ?? [], + layerType: LayerTypes.REFERENCELINE, + table: args.table ?? input, + }; + }, +}; diff --git a/src/plugins/chart_expressions/expression_xy/common/expression_functions/extended_y_axis_config.ts b/src/plugins/chart_expressions/expression_xy/common/expression_functions/extended_y_axis_config.ts new file mode 100644 index 0000000000000..606cdd84ac710 --- /dev/null +++ b/src/plugins/chart_expressions/expression_xy/common/expression_functions/extended_y_axis_config.ts @@ -0,0 +1,80 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { i18n } from '@kbn/i18n'; +import { + AvailableReferenceLineIcons, + EXTENDED_Y_CONFIG, + FillStyles, + IconPositions, + LineStyles, +} from '../constants'; +import { strings } from '../i18n'; +import { ExtendedYConfigFn } from '../types'; +import { commonYConfigArgs } from './common_y_config_args'; + +export const extendedYAxisConfigFunction: ExtendedYConfigFn = { + name: EXTENDED_Y_CONFIG, + aliases: [], + type: EXTENDED_Y_CONFIG, + help: strings.getYConfigFnHelp(), + inputTypes: ['null'], + args: { + ...commonYConfigArgs, + lineStyle: { + types: ['string'], + options: [...Object.values(LineStyles)], + help: i18n.translate('expressionXY.yConfig.lineStyle.help', { + defaultMessage: 'The style of the reference line', + }), + strict: true, + }, + lineWidth: { + types: ['number'], + help: i18n.translate('expressionXY.yConfig.lineWidth.help', { + defaultMessage: 'The width of the reference line', + }), + }, + icon: { + types: ['string'], + help: i18n.translate('expressionXY.yConfig.icon.help', { + defaultMessage: 'An optional icon used for reference lines', + }), + options: [...Object.values(AvailableReferenceLineIcons)], + strict: true, + }, + iconPosition: { + types: ['string'], + options: [...Object.values(IconPositions)], + help: i18n.translate('expressionXY.yConfig.iconPosition.help', { + defaultMessage: 'The placement of the icon for the reference line', + }), + strict: true, + }, + textVisibility: { + types: ['boolean'], + help: i18n.translate('expressionXY.yConfig.textVisibility.help', { + defaultMessage: 'Visibility of the label on the reference line', + }), + }, + fill: { + types: ['string'], + options: [...Object.values(FillStyles)], + help: i18n.translate('expressionXY.yConfig.fill.help', { + defaultMessage: 'Fill', + }), + strict: true, + }, + }, + fn(input, args) { + return { + type: EXTENDED_Y_CONFIG, + ...args, + }; + }, +}; diff --git a/src/plugins/chart_expressions/expression_xy/common/expression_functions/index.ts b/src/plugins/chart_expressions/expression_xy/common/expression_functions/index.ts index 5c7e013a91332..ab1d570a07351 100644 --- a/src/plugins/chart_expressions/expression_xy/common/expression_functions/index.ts +++ b/src/plugins/chart_expressions/expression_xy/common/expression_functions/index.ts @@ -7,13 +7,18 @@ */ export * from './xy_vis'; +export * from './layered_xy_vis'; export * from './legend_config'; -export * from './annotation_layer_config'; +export * from './annotation_layer'; +export * from './extended_annotation_layer'; export * from './y_axis_config'; -export * from './data_layer_config'; +export * from './extended_y_axis_config'; +export * from './data_layer'; +export * from './extended_data_layer'; export * from './grid_lines_config'; export * from './axis_extent_config'; export * from './tick_labels_config'; export * from './labels_orientation_config'; -export * from './reference_line_layer_config'; +export * from './reference_line_layer'; +export * from './extended_reference_line_layer'; export * from './axis_titles_visibility_config'; diff --git a/src/plugins/chart_expressions/expression_xy/common/expression_functions/layered_xy_vis.ts b/src/plugins/chart_expressions/expression_xy/common/expression_functions/layered_xy_vis.ts new file mode 100644 index 0000000000000..6b926e1ceff05 --- /dev/null +++ b/src/plugins/chart_expressions/expression_xy/common/expression_functions/layered_xy_vis.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 { i18n } from '@kbn/i18n'; +import { LayeredXyVisFn } from '../types'; +import { + EXTENDED_DATA_LAYER, + EXTENDED_REFERENCE_LINE_LAYER, + LAYERED_XY_VIS, + EXTENDED_ANNOTATION_LAYER, +} from '../constants'; +import { commonXYArgs } from './common_xy_args'; +import { strings } from '../i18n'; + +export const layeredXyVisFunction: LayeredXyVisFn = { + name: LAYERED_XY_VIS, + type: 'render', + inputTypes: ['datatable'], + help: strings.getXYHelp(), + args: { + ...commonXYArgs, + layers: { + types: [EXTENDED_DATA_LAYER, EXTENDED_REFERENCE_LINE_LAYER, EXTENDED_ANNOTATION_LAYER], + help: i18n.translate('expressionXY.layeredXyVis.layers.help', { + defaultMessage: 'Layers of visual series', + }), + multi: true, + }, + }, + async fn(data, args, handlers) { + const { layeredXyVisFn } = await import('./layered_xy_vis_fn'); + return await layeredXyVisFn(data, args, handlers); + }, +}; diff --git a/src/plugins/chart_expressions/expression_xy/common/expression_functions/layered_xy_vis_fn.ts b/src/plugins/chart_expressions/expression_xy/common/expression_functions/layered_xy_vis_fn.ts new file mode 100644 index 0000000000000..4b7de0eba3166 --- /dev/null +++ b/src/plugins/chart_expressions/expression_xy/common/expression_functions/layered_xy_vis_fn.ts @@ -0,0 +1,33 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { XY_VIS_RENDERER } from '../constants'; +import { appendLayerIds } from '../helpers'; +import { LayeredXyVisFn } from '../types'; +import { logDatatables } from '../utils'; + +export const layeredXyVisFn: LayeredXyVisFn['fn'] = async (data, args, handlers) => { + const layers = appendLayerIds(args.layers ?? [], 'layers'); + + logDatatables(layers, handlers); + + return { + type: 'render', + as: XY_VIS_RENDERER, + value: { + args: { + ...args, + layers, + ariaLabel: + args.ariaLabel ?? + (handlers.variables?.embeddableTitle as string) ?? + handlers.getExecutionContext?.()?.description, + }, + }, + }; +}; diff --git a/src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.test.ts b/src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.test.ts index 9d58903e93c62..48e6d1c956acb 100644 --- a/src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.test.ts +++ b/src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.test.ts @@ -12,9 +12,9 @@ import { LegendConfig } from '../types'; import { legendConfigFunction } from './legend_config'; describe('legendConfigFunction', () => { - test('produces the correct arguments', () => { + test('produces the correct arguments', async () => { const args: LegendConfig = { isVisible: true, position: Position.Left }; - const result = legendConfigFunction.fn(null, args, createMockExecutionContext()); + const result = await legendConfigFunction.fn(null, args, createMockExecutionContext()); expect(result).toEqual({ type: 'legendConfig', ...args }); }); diff --git a/src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts b/src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts index 65f8a725518a3..2b383f1899d44 100644 --- a/src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts +++ b/src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts @@ -8,16 +8,10 @@ import { HorizontalAlignment, Position, VerticalAlignment } from '@elastic/charts'; import { i18n } from '@kbn/i18n'; -import type { ExpressionFunctionDefinition } from '@kbn/expressions-plugin/common'; import { LEGEND_CONFIG } from '../constants'; -import { LegendConfig, LegendConfigResult } from '../types'; +import { LegendConfigFn } from '../types'; -export const legendConfigFunction: ExpressionFunctionDefinition< - typeof LEGEND_CONFIG, - null, - LegendConfig, - LegendConfigResult -> = { +export const legendConfigFunction: LegendConfigFn = { name: LEGEND_CONFIG, aliases: [], type: LEGEND_CONFIG, @@ -31,6 +25,7 @@ export const legendConfigFunction: ExpressionFunctionDefinition< help: i18n.translate('expressionXY.legendConfig.isVisible.help', { defaultMessage: 'Specifies whether or not the legend is visible.', }), + default: true, }, position: { types: ['string'], @@ -38,6 +33,7 @@ export const legendConfigFunction: ExpressionFunctionDefinition< help: i18n.translate('expressionXY.legendConfig.position.help', { defaultMessage: 'Specifies the legend position.', }), + strict: true, }, showSingleSeries: { types: ['boolean'], @@ -58,6 +54,7 @@ export const legendConfigFunction: ExpressionFunctionDefinition< defaultMessage: 'Specifies the horizontal alignment of the legend when it is displayed inside chart.', }), + strict: true, }, verticalAlignment: { types: ['string'], @@ -66,6 +63,7 @@ export const legendConfigFunction: ExpressionFunctionDefinition< defaultMessage: 'Specifies the vertical alignment of the legend when it is displayed inside chart.', }), + strict: true, }, floatingColumns: { types: ['number'], @@ -93,10 +91,8 @@ export const legendConfigFunction: ExpressionFunctionDefinition< }), }, }, - fn(input, args) { - return { - type: LEGEND_CONFIG, - ...args, - }; + async fn(input, args, handlers) { + const { legendConfigFn } = await import('./legend_config_fn'); + return await legendConfigFn(input, args, handlers); }, }; diff --git a/src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config_fn.ts b/src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config_fn.ts new file mode 100644 index 0000000000000..35df125ae230f --- /dev/null +++ b/src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config_fn.ts @@ -0,0 +1,68 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { i18n } from '@kbn/i18n'; +import { LEGEND_CONFIG } from '../constants'; +import { LegendConfigFn } from '../types'; + +const errors = { + positionUsageWithIsInsideError: () => + i18n.translate( + 'expressionXY.reusable.function.legendConfig.errors.positionUsageWithIsInsideError', + { + defaultMessage: + '`position` argument is not applied if `isInside = true`. Please, use `horizontalAlignment` and `verticalAlignment` arguments instead.', + } + ), + alignmentUsageWithFalsyIsInsideError: () => + i18n.translate( + 'expressionXY.reusable.function.legendConfig.errors.alignmentUsageWithFalsyIsInsideError', + { + defaultMessage: + '`horizontalAlignment` and `verticalAlignment` arguments are not applied if `isInside = false`. Please, use the `position` argument instead.', + } + ), + floatingColumnsWithFalsyIsInsideError: () => + i18n.translate( + 'expressionXY.reusable.function.legendConfig.errors.floatingColumnsWithFalsyIsInsideError', + { + defaultMessage: '`floatingColumns` arguments are not applied if `isInside = false`.', + } + ), + legendSizeWithFalsyIsInsideError: () => + i18n.translate( + 'expressionXY.reusable.function.legendConfig.errors.legendSizeWithFalsyIsInsideError', + { + defaultMessage: '`legendSize` argument is not applied if `isInside = false`.', + } + ), +}; + +export const legendConfigFn: LegendConfigFn['fn'] = async (data, args) => { + if (args.isInside) { + if (args.position) { + throw new Error(errors.positionUsageWithIsInsideError()); + } + + if (args.legendSize !== undefined) { + throw new Error(errors.legendSizeWithFalsyIsInsideError()); + } + } + + if (!args.isInside) { + if (args.verticalAlignment || args.horizontalAlignment) { + throw new Error(errors.alignmentUsageWithFalsyIsInsideError()); + } + + if (args.floatingColumns !== undefined) { + throw new Error(errors.floatingColumnsWithFalsyIsInsideError()); + } + } + + return { type: LEGEND_CONFIG, ...args }; +}; diff --git a/src/plugins/chart_expressions/expression_xy/common/expression_functions/reference_line_layer.ts b/src/plugins/chart_expressions/expression_xy/common/expression_functions/reference_line_layer.ts new file mode 100644 index 0000000000000..9c6e27c958530 --- /dev/null +++ b/src/plugins/chart_expressions/expression_xy/common/expression_functions/reference_line_layer.ts @@ -0,0 +1,30 @@ +/* + * Copyright 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 { LayerTypes, REFERENCE_LINE_LAYER } from '../constants'; +import { ReferenceLineLayerFn } from '../types'; +import { strings } from '../i18n'; +import { commonReferenceLineLayerArgs } from './common_reference_line_layer_args'; + +export const referenceLineLayerFunction: ReferenceLineLayerFn = { + name: REFERENCE_LINE_LAYER, + aliases: [], + type: REFERENCE_LINE_LAYER, + help: strings.getRLHelp(), + inputTypes: ['datatable'], + args: { ...commonReferenceLineLayerArgs }, + fn(table, args) { + return { + type: REFERENCE_LINE_LAYER, + ...args, + accessors: args.accessors ?? [], + layerType: LayerTypes.REFERENCELINE, + table, + }; + }, +}; diff --git a/src/plugins/chart_expressions/expression_xy/common/expression_functions/reference_line_layer_config.ts b/src/plugins/chart_expressions/expression_xy/common/expression_functions/reference_line_layer_config.ts deleted file mode 100644 index 46f6e7671c0ab..0000000000000 --- a/src/plugins/chart_expressions/expression_xy/common/expression_functions/reference_line_layer_config.ts +++ /dev/null @@ -1,62 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import { i18n } from '@kbn/i18n'; -import type { ExpressionFunctionDefinition } from '@kbn/expressions-plugin/common'; -import { LayerTypes, REFERENCE_LINE_LAYER, Y_CONFIG } from '../constants'; -import { ReferenceLineLayerArgs, ReferenceLineLayerConfigResult } from '../types'; - -export const referenceLineLayerConfigFunction: ExpressionFunctionDefinition< - typeof REFERENCE_LINE_LAYER, - null, - ReferenceLineLayerArgs, - ReferenceLineLayerConfigResult -> = { - name: REFERENCE_LINE_LAYER, - aliases: [], - type: REFERENCE_LINE_LAYER, - help: i18n.translate('expressionXY.referenceLineLayer.help', { - defaultMessage: `Configure a reference line in the xy chart`, - }), - inputTypes: ['null'], - args: { - layerId: { - types: ['string'], - help: i18n.translate('expressionXY.referenceLineLayer.layerId.help', { - defaultMessage: `Layer ID`, - }), - }, - accessors: { - types: ['string'], - help: i18n.translate('expressionXY.referenceLineLayer.accessors.help', { - defaultMessage: 'The columns to display on the y axis.', - }), - multi: true, - }, - yConfig: { - types: [Y_CONFIG], - help: i18n.translate('expressionXY.referenceLineLayer.yConfig.help', { - defaultMessage: 'Additional configuration for y axes', - }), - multi: true, - }, - columnToLabel: { - types: ['string'], - help: i18n.translate('expressionXY.referenceLineLayer.columnToLabel.help', { - defaultMessage: 'JSON key-value pairs of column ID to label', - }), - }, - }, - fn(input, args) { - return { - type: REFERENCE_LINE_LAYER, - ...args, - layerType: LayerTypes.REFERENCELINE, - }; - }, -}; diff --git a/src/plugins/chart_expressions/expression_xy/common/expression_functions/validate.ts b/src/plugins/chart_expressions/expression_xy/common/expression_functions/validate.ts new file mode 100644 index 0000000000000..55d7cb12382c0 --- /dev/null +++ b/src/plugins/chart_expressions/expression_xy/common/expression_functions/validate.ts @@ -0,0 +1,103 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { i18n } from '@kbn/i18n'; +import { AxisExtentModes, ValueLabelModes } from '../constants'; +import { + AxisExtentConfigResult, + DataLayerConfigResult, + ValueLabelMode, + CommonXYDataLayerConfig, +} from '../types'; + +const errors = { + extendBoundsAreInvalidError: () => + i18n.translate('expressionXY.reusable.function.xyVis.errors.extendBoundsAreInvalidError', { + defaultMessage: + 'For area and bar modes, and custom extent mode, the lower bound should be less or greater than 0 and the upper bound - be greater or equal than 0', + }), + notUsedFillOpacityError: () => + i18n.translate('expressionXY.reusable.function.xyVis.errors.notUsedFillOpacityError', { + defaultMessage: '`fillOpacity` argument is applicable only for area charts.', + }), + valueLabelsForNotBarsOrHistogramBarsChartsError: () => + i18n.translate( + 'expressionXY.reusable.function.xyVis.errors.valueLabelsForNotBarsOrHistogramBarsChartsError', + { + defaultMessage: + '`valueLabels` argument is applicable only for bar charts, which are not histograms.', + } + ), + dataBoundsForNotLineChartError: () => + i18n.translate('expressionXY.reusable.function.xyVis.errors.dataBoundsForNotLineChartError', { + defaultMessage: 'Only line charts can be fit to the data bounds', + }), +}; + +export const hasBarLayer = (layers: Array) => + layers.filter(({ seriesType }) => seriesType.includes('bar')).length > 0; + +export const hasAreaLayer = (layers: Array) => + layers.filter(({ seriesType }) => seriesType.includes('area')).length > 0; + +export const hasHistogramBarLayer = ( + layers: Array +) => + layers.filter(({ seriesType, isHistogram }) => seriesType.includes('bar') && isHistogram).length > + 0; + +export const isValidExtentWithCustomMode = (extent: AxisExtentConfigResult) => { + const isValidLowerBound = + extent.lowerBound === undefined || (extent.lowerBound !== undefined && extent.lowerBound <= 0); + const isValidUpperBound = + extent.upperBound === undefined || (extent.upperBound !== undefined && extent.upperBound >= 0); + + return isValidLowerBound && isValidUpperBound; +}; + +export const validateExtentForDataBounds = ( + extent: AxisExtentConfigResult, + layers: Array +) => { + const lineSeries = layers.filter(({ seriesType }) => seriesType.includes('line')); + if (!lineSeries.length && extent.mode === AxisExtentModes.DATA_BOUNDS) { + throw new Error(errors.dataBoundsForNotLineChartError()); + } +}; + +export const validateExtent = ( + extent: AxisExtentConfigResult, + hasBarOrArea: boolean, + dataLayers: Array +) => { + if ( + extent.mode === AxisExtentModes.CUSTOM && + hasBarOrArea && + !isValidExtentWithCustomMode(extent) + ) { + throw new Error(errors.extendBoundsAreInvalidError()); + } + + validateExtentForDataBounds(extent, dataLayers); +}; + +export const validateFillOpacity = (fillOpacity: number | undefined, hasArea: boolean) => { + if (fillOpacity !== undefined && !hasArea) { + throw new Error(errors.notUsedFillOpacityError()); + } +}; + +export const validateValueLabels = ( + valueLabels: ValueLabelMode, + hasBar: boolean, + hasNotHistogramBars: boolean +) => { + if ((!hasBar || !hasNotHistogramBars) && valueLabels !== ValueLabelModes.HIDE) { + throw new Error(errors.valueLabelsForNotBarsOrHistogramBarsChartsError()); + } +}; diff --git a/src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.test.ts b/src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.test.ts index 27e68f0a49891..688efbe122f3e 100644 --- a/src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.test.ts +++ b/src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.test.ts @@ -8,14 +8,23 @@ import { xyVisFunction } from '.'; import { createMockExecutionContext } from '@kbn/expressions-plugin/common/mocks'; -import { sampleArgs } from '../__mocks__'; +import { sampleArgs, sampleLayer } from '../__mocks__'; import { XY_VIS } from '../constants'; describe('xyVis', () => { - test('it renders with the specified data and args', () => { + test('it renders with the specified data and args', async () => { const { data, args } = sampleArgs(); - const result = xyVisFunction.fn(data, args, createMockExecutionContext()); + const { layers, ...rest } = args; + const result = await xyVisFunction.fn( + data, + { ...rest, dataLayers: [sampleLayer], referenceLineLayers: [], annotationLayers: [] }, + createMockExecutionContext() + ); - expect(result).toEqual({ type: 'render', as: XY_VIS, value: { data, args } }); + expect(result).toEqual({ + type: 'render', + as: XY_VIS, + value: { args: { ...rest, layers: [sampleLayer] } }, + }); }); }); diff --git a/src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts b/src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts index 227b7553d6414..2e97cb00b3e55 100644 --- a/src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts +++ b/src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts @@ -6,243 +6,36 @@ * Side Public License, v 1. */ -import { i18n } from '@kbn/i18n'; -import type { ExpressionFunctionDefinition } from '@kbn/expressions-plugin'; -import { prepareLogTable } from '@kbn/visualizations-plugin/common/utils'; -import { LensMultiTable, XYArgs, XYRender } from '../types'; -import { - XY_VIS, - DATA_LAYER, - MULTITABLE, - XYCurveTypes, - LEGEND_CONFIG, - ValueLabelModes, - FittingFunctions, - GRID_LINES_CONFIG, - XY_VIS_RENDERER, - AXIS_EXTENT_CONFIG, - TICK_LABELS_CONFIG, - REFERENCE_LINE_LAYER, - LABELS_ORIENTATION_CONFIG, - AXIS_TITLES_VISIBILITY_CONFIG, - EndValues, - ANNOTATION_LAYER, - LayerTypes, -} from '../constants'; +import { XyVisFn } from '../types'; +import { XY_VIS, DATA_LAYER, REFERENCE_LINE_LAYER, ANNOTATION_LAYER } from '../constants'; +import { strings } from '../i18n'; +import { commonXYArgs } from './common_xy_args'; -const strings = { - getMetricHelp: () => - i18n.translate('expressionXY.xyVis.logDatatable.metric', { - defaultMessage: 'Vertical axis', - }), - getXAxisHelp: () => - i18n.translate('expressionXY.xyVis.logDatatable.x', { - defaultMessage: 'Horizontal axis', - }), - getBreakdownHelp: () => - i18n.translate('expressionXY.xyVis.logDatatable.breakDown', { - defaultMessage: 'Break down by', - }), - getReferenceLineHelp: () => - i18n.translate('expressionXY.xyVis.logDatatable.breakDown', { - defaultMessage: 'Break down by', - }), -}; - -export const xyVisFunction: ExpressionFunctionDefinition< - typeof XY_VIS, - LensMultiTable, - XYArgs, - XYRender -> = { +export const xyVisFunction: XyVisFn = { name: XY_VIS, type: 'render', - inputTypes: [MULTITABLE], - help: i18n.translate('expressionXY.xyVis.help', { - defaultMessage: 'An X/Y chart', - }), + inputTypes: ['datatable'], + help: strings.getXYHelp(), args: { - title: { - types: ['string'], - help: 'The chart title.', - }, - description: { - types: ['string'], - help: '', - }, - xTitle: { - types: ['string'], - help: i18n.translate('expressionXY.xyVis.xTitle.help', { - defaultMessage: 'X axis title', - }), - }, - yTitle: { - types: ['string'], - help: i18n.translate('expressionXY.xyVis.yLeftTitle.help', { - defaultMessage: 'Y left axis title', - }), - }, - yRightTitle: { - types: ['string'], - help: i18n.translate('expressionXY.xyVis.yRightTitle.help', { - defaultMessage: 'Y right axis title', - }), - }, - yLeftExtent: { - types: [AXIS_EXTENT_CONFIG], - help: i18n.translate('expressionXY.xyVis.yLeftExtent.help', { - defaultMessage: 'Y left axis extents', - }), - }, - yRightExtent: { - types: [AXIS_EXTENT_CONFIG], - help: i18n.translate('expressionXY.xyVis.yRightExtent.help', { - defaultMessage: 'Y right axis extents', - }), - }, - legend: { - types: [LEGEND_CONFIG], - help: i18n.translate('expressionXY.xyVis.legend.help', { - defaultMessage: 'Configure the chart legend.', - }), - }, - fittingFunction: { - types: ['string'], - options: [...Object.values(FittingFunctions)], - help: i18n.translate('expressionXY.xyVis.fittingFunction.help', { - defaultMessage: 'Define how missing values are treated', - }), - }, - endValue: { - types: ['string'], - options: [...Object.values(EndValues)], - help: i18n.translate('expressionXY.xyVis.endValue.help', { - defaultMessage: 'End value', - }), - }, - emphasizeFitting: { - types: ['boolean'], - default: false, - help: '', - }, - valueLabels: { - types: ['string'], - options: [...Object.values(ValueLabelModes)], - help: i18n.translate('expressionXY.xyVis.valueLabels.help', { - defaultMessage: 'Value labels mode', - }), - }, - tickLabelsVisibilitySettings: { - types: [TICK_LABELS_CONFIG], - help: i18n.translate('expressionXY.xyVis.tickLabelsVisibilitySettings.help', { - defaultMessage: 'Show x and y axes tick labels', - }), - }, - labelsOrientation: { - types: [LABELS_ORIENTATION_CONFIG], - help: i18n.translate('expressionXY.xyVis.labelsOrientation.help', { - defaultMessage: 'Defines the rotation of the axis labels', - }), - }, - gridlinesVisibilitySettings: { - types: [GRID_LINES_CONFIG], - help: i18n.translate('expressionXY.xyVis.gridlinesVisibilitySettings.help', { - defaultMessage: 'Show x and y axes gridlines', - }), - }, - axisTitlesVisibilitySettings: { - types: [AXIS_TITLES_VISIBILITY_CONFIG], - help: i18n.translate('expressionXY.xyVis.axisTitlesVisibilitySettings.help', { - defaultMessage: 'Show x and y axes titles', - }), - }, - layers: { - types: [DATA_LAYER, REFERENCE_LINE_LAYER, ANNOTATION_LAYER], - help: i18n.translate('expressionXY.xyVis.layers.help', { - defaultMessage: 'Layers of visual series', - }), + ...commonXYArgs, + dataLayers: { + types: [DATA_LAYER], + help: strings.getDataLayerHelp(), multi: true, }, - curveType: { - types: ['string'], - options: [...Object.values(XYCurveTypes)], - help: i18n.translate('expressionXY.xyVis.curveType.help', { - defaultMessage: 'Define how curve type is rendered for a line chart', - }), - }, - fillOpacity: { - types: ['number'], - help: i18n.translate('expressionXY.xyVis.fillOpacity.help', { - defaultMessage: 'Define the area chart fill opacity', - }), - }, - hideEndzones: { - types: ['boolean'], - default: false, - help: i18n.translate('expressionXY.xyVis.hideEndzones.help', { - defaultMessage: 'Hide endzone markers for partial data', - }), - }, - valuesInLegend: { - types: ['boolean'], - default: false, - help: i18n.translate('expressionXY.xyVis.valuesInLegend.help', { - defaultMessage: 'Show values in legend', - }), + referenceLineLayers: { + types: [REFERENCE_LINE_LAYER], + help: strings.getReferenceLineLayerHelp(), + multi: true, }, - ariaLabel: { - types: ['string'], - help: i18n.translate('expressionXY.xyVis.ariaLabel.help', { - defaultMessage: 'Specifies the aria label of the xy chart', - }), - required: false, + annotationLayers: { + types: [ANNOTATION_LAYER], + help: strings.getAnnotationLayerHelp(), + multi: true, }, }, - fn(data, args, handlers) { - if (handlers?.inspectorAdapters?.tables) { - args.layers.forEach((layer) => { - if (layer.layerType === LayerTypes.ANNOTATIONS) { - return; - } - - let xAccessor; - let splitAccessor; - if (layer.layerType === LayerTypes.DATA) { - xAccessor = layer.xAccessor; - splitAccessor = layer.splitAccessor; - } - - const { layerId, accessors, layerType } = layer; - const logTable = prepareLogTable( - data.tables[layerId], - [ - [ - accessors ? accessors : undefined, - layerType === 'data' ? strings.getMetricHelp() : strings.getReferenceLineHelp(), - ], - [xAccessor ? [xAccessor] : undefined, strings.getXAxisHelp()], - [splitAccessor ? [splitAccessor] : undefined, strings.getBreakdownHelp()], - ], - true - ); - - handlers.inspectorAdapters.tables.logDatatable(layerId, logTable); - }); - } - - return { - type: 'render', - as: XY_VIS_RENDERER, - value: { - data, - args: { - ...args, - ariaLabel: - args.ariaLabel ?? - (handlers.variables?.embeddableTitle as string) ?? - handlers.getExecutionContext?.()?.description, - }, - }, - }; + async fn(data, args, handlers) { + const { xyVisFn } = await import('./xy_vis_fn'); + return await xyVisFn(data, args, handlers); }, }; diff --git a/src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis_fn.ts b/src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis_fn.ts new file mode 100644 index 0000000000000..1bd75e1296c6c --- /dev/null +++ b/src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis_fn.ts @@ -0,0 +1,69 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { Dimension, prepareLogTable } from '@kbn/visualizations-plugin/common/utils'; +import { LayerTypes, XY_VIS_RENDERER } from '../constants'; +import { appendLayerIds } from '../helpers'; +import { XYLayerConfig, XyVisFn } from '../types'; +import { getLayerDimensions } from '../utils'; +import { + hasAreaLayer, + hasBarLayer, + hasHistogramBarLayer, + validateExtent, + validateFillOpacity, + validateValueLabels, +} from './validate'; + +export const xyVisFn: XyVisFn['fn'] = async (data, args, handlers) => { + const { dataLayers = [], referenceLineLayers = [], annotationLayers = [], ...restArgs } = args; + const layers: XYLayerConfig[] = [ + ...appendLayerIds(dataLayers, 'dataLayers'), + ...appendLayerIds(referenceLineLayers, 'referenceLineLayers'), + ...appendLayerIds(annotationLayers, 'annotationLayers'), + ]; + + if (handlers.inspectorAdapters.tables) { + const layerDimensions = layers.reduce((dimensions, layer) => { + if (layer.layerType === LayerTypes.ANNOTATIONS) { + return dimensions; + } + + return [...dimensions, ...getLayerDimensions(layer)]; + }, []); + + const logTable = prepareLogTable(data, layerDimensions, true); + handlers.inspectorAdapters.tables.logDatatable('default', logTable); + } + + const hasBar = hasBarLayer(dataLayers); + const hasArea = hasAreaLayer(dataLayers); + + validateExtent(args.yLeftExtent, hasBar || hasArea, dataLayers); + validateExtent(args.yRightExtent, hasBar || hasArea, dataLayers); + validateFillOpacity(args.fillOpacity, hasArea); + + const hasNotHistogramBars = !hasHistogramBarLayer(dataLayers); + + validateValueLabels(args.valueLabels, hasBar, hasNotHistogramBars); + + return { + type: 'render', + as: XY_VIS_RENDERER, + value: { + args: { + ...restArgs, + layers, + ariaLabel: + args.ariaLabel ?? + (handlers.variables?.embeddableTitle as string) ?? + handlers.getExecutionContext?.()?.description, + }, + }, + }; +}; diff --git a/src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts b/src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts index 943c6910952a0..882a3231148f5 100644 --- a/src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts +++ b/src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts @@ -6,84 +6,18 @@ * Side Public License, v 1. */ -import { i18n } from '@kbn/i18n'; -import type { ExpressionFunctionDefinition } from '@kbn/expressions-plugin/common'; -import { FillStyles, IconPositions, LineStyles, YAxisModes, Y_CONFIG } from '../constants'; -import { YConfig, YConfigResult } from '../types'; +import { Y_CONFIG } from '../constants'; +import { YConfigFn } from '../types'; +import { strings } from '../i18n'; +import { commonYConfigArgs } from './common_y_config_args'; -export const yAxisConfigFunction: ExpressionFunctionDefinition< - typeof Y_CONFIG, - null, - YConfig, - YConfigResult -> = { +export const yAxisConfigFunction: YConfigFn = { name: Y_CONFIG, aliases: [], type: Y_CONFIG, - help: i18n.translate('expressionXY.yConfig.help', { - defaultMessage: `Configure the behavior of a xy chart's y axis metric`, - }), + help: strings.getYConfigFnHelp(), inputTypes: ['null'], - args: { - forAccessor: { - types: ['string'], - help: i18n.translate('expressionXY.yConfig.forAccessor.help', { - defaultMessage: 'The accessor this configuration is for', - }), - }, - axisMode: { - types: ['string'], - options: [...Object.values(YAxisModes)], - help: i18n.translate('expressionXY.yConfig.axisMode.help', { - defaultMessage: 'The axis mode of the metric', - }), - }, - color: { - types: ['string'], - help: i18n.translate('expressionXY.yConfig.color.help', { - defaultMessage: 'The color of the series', - }), - }, - lineStyle: { - types: ['string'], - options: [...Object.values(LineStyles)], - help: i18n.translate('expressionXY.yConfig.lineStyle.help', { - defaultMessage: 'The style of the reference line', - }), - }, - lineWidth: { - types: ['number'], - help: i18n.translate('expressionXY.yConfig.lineWidth.help', { - defaultMessage: 'The width of the reference line', - }), - }, - icon: { - types: ['string'], - help: i18n.translate('expressionXY.yConfig.icon.help', { - defaultMessage: 'An optional icon used for reference lines', - }), - }, - iconPosition: { - types: ['string'], - options: [...Object.values(IconPositions)], - help: i18n.translate('expressionXY.yConfig.iconPosition.help', { - defaultMessage: 'The placement of the icon for the reference line', - }), - }, - textVisibility: { - types: ['boolean'], - help: i18n.translate('expressionXY.yConfig.textVisibility.help', { - defaultMessage: 'Visibility of the label on the reference line', - }), - }, - fill: { - types: ['string'], - options: [...Object.values(FillStyles)], - help: i18n.translate('expressionXY.yConfig.fill.help', { - defaultMessage: 'Fill', - }), - }, - }, + args: { ...commonYConfigArgs }, fn(input, args) { return { type: Y_CONFIG, diff --git a/src/plugins/chart_expressions/expression_xy/common/helpers/index.ts b/src/plugins/chart_expressions/expression_xy/common/helpers/index.ts new file mode 100644 index 0000000000000..55c4136e0c00d --- /dev/null +++ b/src/plugins/chart_expressions/expression_xy/common/helpers/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 { appendLayerIds } from './layers'; diff --git a/src/plugins/chart_expressions/expression_xy/common/helpers/layers.test.ts b/src/plugins/chart_expressions/expression_xy/common/helpers/layers.test.ts new file mode 100644 index 0000000000000..ac44ef18fc505 --- /dev/null +++ b/src/plugins/chart_expressions/expression_xy/common/helpers/layers.test.ts @@ -0,0 +1,49 @@ +/* + * Copyright 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 { generateLayerId, appendLayerIds } from './layers'; + +describe('#generateLayerId', () => { + it('should return the combination of keyword and index', () => { + const key = 'some-key'; + const index = 10; + const id = generateLayerId(key, index); + expect(id).toBe(`${key}-${index}`); + }); +}); + +describe('#appendLayerIds', () => { + it('should add layerId to each layer', () => { + const layers = [{ name: 'someName' }, { name: 'someName2' }, { name: 'someName3' }]; + const keyword = 'keyword'; + const expectedLayerIds = [ + { ...layers[0], layerId: `${keyword}-0` }, + { ...layers[1], layerId: `${keyword}-1` }, + { ...layers[2], layerId: `${keyword}-2` }, + ]; + + const layersWithIds = appendLayerIds(layers, keyword); + expect(layersWithIds).toStrictEqual(expectedLayerIds); + }); + + it('should filter out undefined layers', () => { + const layers = [undefined, undefined, undefined]; + const result = appendLayerIds(layers, 'some-key'); + expect(result).toStrictEqual([]); + + const layers2 = [{ name: 'someName' }, undefined, { name: 'someName3' }]; + const keyword = 'keyword'; + const expectedLayerIds = [ + { ...layers2[0], layerId: `${keyword}-0` }, + { ...layers2[2], layerId: `${keyword}-1` }, + ]; + + const layersWithIds = appendLayerIds(layers2, keyword); + expect(layersWithIds).toStrictEqual(expectedLayerIds); + }); +}); diff --git a/src/plugins/chart_expressions/expression_xy/common/helpers/layers.ts b/src/plugins/chart_expressions/expression_xy/common/helpers/layers.ts new file mode 100644 index 0000000000000..d62ea264acb1a --- /dev/null +++ b/src/plugins/chart_expressions/expression_xy/common/helpers/layers.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 { WithLayerId } from '../types'; + +function isWithLayerId(layer: T): layer is T & WithLayerId { + return (layer as T & WithLayerId).layerId ? true : false; +} + +export const generateLayerId = (keyword: string, index: number) => `${keyword}-${index}`; + +export function appendLayerIds( + layers: Array, + keyword: string +): Array { + return layers + .filter((l): l is T => l !== undefined) + .map((l, index) => ({ + ...l, + layerId: isWithLayerId(l) ? l.layerId : generateLayerId(keyword, index), + })); +} diff --git a/src/plugins/chart_expressions/expression_xy/common/i18n/index.tsx b/src/plugins/chart_expressions/expression_xy/common/i18n/index.tsx new file mode 100644 index 0000000000000..225f9de0d6a7c --- /dev/null +++ b/src/plugins/chart_expressions/expression_xy/common/i18n/index.tsx @@ -0,0 +1,212 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { i18n } from '@kbn/i18n'; + +export const strings = { + getXYHelp: () => + i18n.translate('expressionXY.xyVis.help', { + defaultMessage: 'An X/Y chart', + }), + getMetricHelp: () => + i18n.translate('expressionXY.xyVis.logDatatable.metric', { + defaultMessage: 'Vertical axis', + }), + getXAxisHelp: () => + i18n.translate('expressionXY.xyVis.logDatatable.x', { + defaultMessage: 'Horizontal axis', + }), + getBreakdownHelp: () => + i18n.translate('expressionXY.xyVis.logDatatable.breakDown', { + defaultMessage: 'Break down by', + }), + getReferenceLineHelp: () => + i18n.translate('expressionXY.xyVis.logDatatable.breakDown', { + defaultMessage: 'Break down by', + }), + getXTitleHelp: () => + i18n.translate('expressionXY.xyVis.xTitle.help', { + defaultMessage: 'X axis title', + }), + getYTitleHelp: () => + i18n.translate('expressionXY.xyVis.yLeftTitle.help', { + defaultMessage: 'Y left axis title', + }), + getYRightTitleHelp: () => + i18n.translate('expressionXY.xyVis.yRightTitle.help', { + defaultMessage: 'Y right axis title', + }), + getYLeftExtentHelp: () => + i18n.translate('expressionXY.xyVis.yLeftExtent.help', { + defaultMessage: 'Y left axis extents', + }), + getYRightExtentHelp: () => + i18n.translate('expressionXY.xyVis.yRightExtent.help', { + defaultMessage: 'Y right axis extents', + }), + getLegendHelp: () => + i18n.translate('expressionXY.xyVis.legend.help', { + defaultMessage: 'Configure the chart legend.', + }), + getFittingFunctionHelp: () => + i18n.translate('expressionXY.xyVis.fittingFunction.help', { + defaultMessage: 'Define how missing values are treated', + }), + getEndValueHelp: () => + i18n.translate('expressionXY.xyVis.endValue.help', { + defaultMessage: 'End value', + }), + getValueLabelsHelp: () => + i18n.translate('expressionXY.xyVis.valueLabels.help', { + defaultMessage: 'Value labels mode', + }), + getTickLabelsVisibilitySettingsHelp: () => + i18n.translate('expressionXY.xyVis.tickLabelsVisibilitySettings.help', { + defaultMessage: 'Show x and y axes tick labels', + }), + getLabelsOrientationHelp: () => + i18n.translate('expressionXY.xyVis.labelsOrientation.help', { + defaultMessage: 'Defines the rotation of the axis labels', + }), + getGridlinesVisibilitySettingsHelp: () => + i18n.translate('expressionXY.xyVis.gridlinesVisibilitySettings.help', { + defaultMessage: 'Show x and y axes gridlines', + }), + getAxisTitlesVisibilitySettingsHelp: () => + i18n.translate('expressionXY.xyVis.axisTitlesVisibilitySettings.help', { + defaultMessage: 'Show x and y axes titles', + }), + getDataLayerHelp: () => + i18n.translate('expressionXY.xyVis.dataLayer.help', { + defaultMessage: 'Data layer of visual series', + }), + getReferenceLineLayerHelp: () => + i18n.translate('expressionXY.xyVis.referenceLineLayer.help', { + defaultMessage: 'Reference line layer', + }), + getAnnotationLayerHelp: () => + i18n.translate('expressionXY.xyVis.annotationLayer.help', { + defaultMessage: 'Annotation layer', + }), + getCurveTypeHelp: () => + i18n.translate('expressionXY.xyVis.curveType.help', { + defaultMessage: 'Define how curve type is rendered for a line chart', + }), + getFillOpacityHelp: () => + i18n.translate('expressionXY.xyVis.fillOpacity.help', { + defaultMessage: 'Define the area chart fill opacity', + }), + getHideEndzonesHelp: () => + i18n.translate('expressionXY.xyVis.hideEndzones.help', { + defaultMessage: 'Hide endzone markers for partial data', + }), + getValuesInLegendHelp: () => + i18n.translate('expressionXY.xyVis.valuesInLegend.help', { + defaultMessage: 'Show values in legend', + }), + getAriaLabelHelp: () => + i18n.translate('expressionXY.xyVis.ariaLabel.help', { + defaultMessage: 'Specifies the aria label of the xy chart', + }), + getDataLayerFnHelp: () => + i18n.translate('expressionXY.dataLayer.help', { + defaultMessage: `Configure a layer in the xy chart`, + }), + getHideHelp: () => + i18n.translate('expressionXY.dataLayer.hide.help', { + defaultMessage: 'Show / hide axis', + }), + getXAccessorHelp: () => + i18n.translate('expressionXY.dataLayer.xAccessor.help', { + defaultMessage: 'X-axis', + }), + getSeriesTypeHelp: () => + i18n.translate('expressionXY.dataLayer.seriesType.help', { + defaultMessage: 'The type of chart to display.', + }), + getXScaleTypeHelp: () => + i18n.translate('expressionXY.dataLayer.xScaleType.help', { + defaultMessage: 'The scale type of the x axis', + }), + getIsHistogramHelp: () => + i18n.translate('expressionXY.dataLayer.isHistogram.help', { + defaultMessage: 'Whether to layout the chart as a histogram', + }), + getYScaleTypeHelp: () => + i18n.translate('expressionXY.dataLayer.yScaleType.help', { + defaultMessage: 'The scale type of the y axes', + }), + getSplitAccessorHelp: () => + i18n.translate('expressionXY.dataLayer.splitAccessor.help', { + defaultMessage: 'The column to split by', + }), + getAccessorsHelp: () => + i18n.translate('expressionXY.dataLayer.accessors.help', { + defaultMessage: 'The columns to display on the y axis.', + }), + getYConfigHelp: () => + i18n.translate('expressionXY.dataLayer.yConfig.help', { + defaultMessage: 'Additional configuration for y axes', + }), + getColumnToLabelHelp: () => + i18n.translate('expressionXY.layer.columnToLabel.help', { + defaultMessage: 'JSON key-value pairs of column ID to label', + }), + getPaletteHelp: () => + i18n.translate('expressionXY.dataLayer.palette.help', { + defaultMessage: 'Palette', + }), + getTableHelp: () => + i18n.translate('expressionXY.layers.table.help', { + defaultMessage: 'Table', + }), + getLayerIdHelp: () => + i18n.translate('expressionXY.layers.layerId.help', { + defaultMessage: 'Layer ID', + }), + getRLAccessorsHelp: () => + i18n.translate('expressionXY.referenceLineLayer.accessors.help', { + defaultMessage: 'The columns to display on the y axis.', + }), + getRLYConfigHelp: () => + i18n.translate('expressionXY.referenceLineLayer.yConfig.help', { + defaultMessage: 'Additional configuration for y axes', + }), + getRLHelp: () => + i18n.translate('expressionXY.referenceLineLayer.help', { + defaultMessage: `Configure a reference line in the xy chart`, + }), + getYConfigFnHelp: () => + i18n.translate('expressionXY.yConfig.help', { + defaultMessage: `Configure the behavior of a xy chart's y axis metric`, + }), + getForAccessorHelp: () => + i18n.translate('expressionXY.yConfig.forAccessor.help', { + defaultMessage: 'The accessor this configuration is for', + }), + getAxisModeHelp: () => + i18n.translate('expressionXY.yConfig.axisMode.help', { + defaultMessage: 'The axis mode of the metric', + }), + getColorHelp: () => + i18n.translate('expressionXY.yConfig.color.help', { + defaultMessage: 'The color of the series', + }), + getAnnotationLayerFnHelp: () => + i18n.translate('expressionXY.annotationLayer.help', { + defaultMessage: `Configure an annotation layer in the xy chart`, + }), + getAnnotationLayerHideHelp: () => + i18n.translate('expressionXY.annotationLayer.hide.help', { + defaultMessage: 'Show / hide details', + }), + getAnnotationLayerAnnotationsHelp: () => + i18n.translate('expressionXY.annotationLayer.annotations.help', { + defaultMessage: 'Annotations', + }), +}; diff --git a/src/plugins/chart_expressions/expression_xy/common/index.ts b/src/plugins/chart_expressions/expression_xy/common/index.ts index 68f9f946baeb0..4bee4a3e7f2b6 100755 --- a/src/plugins/chart_expressions/expression_xy/common/index.ts +++ b/src/plugins/chart_expressions/expression_xy/common/index.ts @@ -9,20 +9,6 @@ export const PLUGIN_ID = 'expressionXy'; export const PLUGIN_NAME = 'expressionXy'; -export { - xyVisFunction, - yAxisConfigFunction, - legendConfigFunction, - gridlinesConfigFunction, - dataLayerConfigFunction, - axisExtentConfigFunction, - tickLabelsConfigFunction, - annotationLayerConfigFunction, - labelsOrientationConfigFunction, - referenceLineLayerConfigFunction, - axisTitlesVisibilityConfigFunction, -} from './expression_functions'; - export type { XYArgs, YConfig, @@ -42,25 +28,37 @@ export type { XYChartProps, LegendConfig, IconPosition, - YConfigResult, DataLayerArgs, LensMultiTable, ValueLabelMode, AxisExtentMode, + DataLayerConfig, FittingFunction, + ExtendedYConfig, AxisExtentConfig, + CollectiveConfig, LegendConfigResult, AxesSettingsConfig, + CommonXYLayerConfig, AnnotationLayerArgs, - XYLayerConfigResult, + ExtendedYConfigResult, GridlinesConfigResult, DataLayerConfigResult, TickLabelsConfigResult, AxisExtentConfigResult, ReferenceLineLayerArgs, + CommonXYDataLayerConfig, LabelsOrientationConfig, - AnnotationLayerConfigResult, + ReferenceLineLayerConfig, + AvailableReferenceLineIcon, + XYExtendedLayerConfigResult, + CommonXYAnnotationLayerConfig, + ExtendedDataLayerConfigResult, LabelsOrientationConfigResult, + CommonXYDataLayerConfigResult, ReferenceLineLayerConfigResult, + CommonXYReferenceLineLayerConfig, AxisTitlesVisibilityConfigResult, + ExtendedReferenceLineLayerConfigResult, + CommonXYReferenceLineLayerConfigResult, } from './types'; diff --git a/src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts b/src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts index a1984c78fe0ac..b3c7bca93ca29 100644 --- a/src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts +++ b/src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts @@ -9,7 +9,7 @@ import { HorizontalAlignment, Position, VerticalAlignment } from '@elastic/charts'; import { $Values } from '@kbn/utility-types'; import type { PaletteOutput } from '@kbn/coloring'; -import { Datatable } from '@kbn/expressions-plugin'; +import { Datatable, ExpressionFunctionDefinition } from '@kbn/expressions-plugin'; import { EventAnnotationOutput } from '@kbn/event-annotation-plugin/common'; import { AxisExtentModes, @@ -34,9 +34,17 @@ import { LEGEND_CONFIG, DATA_LAYER, AXIS_EXTENT_CONFIG, + EXTENDED_DATA_LAYER, + EXTENDED_REFERENCE_LINE_LAYER, ANNOTATION_LAYER, EndValues, + EXTENDED_Y_CONFIG, + AvailableReferenceLineIcons, + XY_VIS, + LAYERED_XY_VIS, + EXTENDED_ANNOTATION_LAYER, } from '../constants'; +import { XYRender } from './expression_renderers'; export type EndValue = $Values; export type LayerType = $Values; @@ -51,6 +59,7 @@ export type IconPosition = $Values; export type ValueLabelMode = $Values; export type AxisExtentMode = $Values; export type FittingFunction = $Values; +export type AvailableReferenceLineIcon = $Values; export interface AxesSettingsConfig { x: boolean; @@ -69,11 +78,8 @@ export interface AxisConfig { hide?: boolean; } -export interface YConfig { - forAccessor: string; - axisMode?: YAxisMode; - color?: string; - icon?: string; +export interface ExtendedYConfig extends YConfig { + icon?: AvailableReferenceLineIcon; lineWidth?: number; lineStyle?: LineStyle; fill?: FillStyle; @@ -81,12 +87,32 @@ export interface YConfig { textVisibility?: boolean; } +export interface YConfig { + forAccessor: string; + axisMode?: YAxisMode; + color?: string; +} + +export interface DataLayerArgs { + accessors: string[]; + seriesType: SeriesType; + xAccessor?: string; + hide?: boolean; + splitAccessor?: string; + columnToLabel?: string; // Actually a JSON key-value pair + yScaleType: YScaleType; + xScaleType: XScaleType; + isHistogram: boolean; + palette: PaletteOutput; + yConfig?: YConfigResult[]; +} + export interface ValidLayer extends DataLayerConfigResult { xAccessor: NonNullable; } -export interface DataLayerArgs { - layerId: string; +export interface ExtendedDataLayerArgs { + layerId?: string; accessors: string[]; seriesType: SeriesType; xAccessor?: string; @@ -96,9 +122,9 @@ export interface DataLayerArgs { yScaleType: YScaleType; xScaleType: XScaleType; isHistogram: boolean; - // palette will always be set on the expression palette: PaletteOutput; yConfig?: YConfigResult[]; + table?: Datatable; } export interface LegendConfig { @@ -121,11 +147,11 @@ export interface LegendConfig { /** * Horizontal Alignment of the legend when it is set inside chart */ - horizontalAlignment?: HorizontalAlignment; + horizontalAlignment?: typeof HorizontalAlignment.Right | typeof HorizontalAlignment.Left; /** * Vertical Alignment of the legend when it is set inside chart */ - verticalAlignment?: VerticalAlignment; + verticalAlignment?: typeof VerticalAlignment.Top | typeof VerticalAlignment.Bottom; /** * Number of columns when legend is set inside chart */ @@ -155,16 +181,62 @@ export interface LabelsOrientationConfig { // Arguments to XY chart expression, with computed properties export interface XYArgs { - title?: string; - description?: string; xTitle: string; yTitle: string; yRightTitle: string; yLeftExtent: AxisExtentConfigResult; yRightExtent: AxisExtentConfigResult; legend: LegendConfigResult; + endValue?: EndValue; + emphasizeFitting?: boolean; valueLabels: ValueLabelMode; - layers: XYLayerConfigResult[]; + dataLayers: DataLayerConfigResult[]; + referenceLineLayers: ReferenceLineLayerConfigResult[]; + annotationLayers: AnnotationLayerConfigResult[]; + fittingFunction?: FittingFunction; + axisTitlesVisibilitySettings?: AxisTitlesVisibilityConfigResult; + tickLabelsVisibilitySettings?: TickLabelsConfigResult; + gridlinesVisibilitySettings?: GridlinesConfigResult; + labelsOrientation?: LabelsOrientationConfigResult; + curveType?: XYCurveType; + fillOpacity?: number; + hideEndzones?: boolean; + valuesInLegend?: boolean; + ariaLabel?: string; +} + +export interface LayeredXYArgs { + xTitle: string; + yTitle: string; + yRightTitle: string; + yLeftExtent: AxisExtentConfigResult; + yRightExtent: AxisExtentConfigResult; + legend: LegendConfigResult; + endValue?: EndValue; + emphasizeFitting?: boolean; + valueLabels: ValueLabelMode; + layers?: XYExtendedLayerConfigResult[]; + fittingFunction?: FittingFunction; + axisTitlesVisibilitySettings?: AxisTitlesVisibilityConfigResult; + tickLabelsVisibilitySettings?: TickLabelsConfigResult; + gridlinesVisibilitySettings?: GridlinesConfigResult; + labelsOrientation?: LabelsOrientationConfigResult; + curveType?: XYCurveType; + fillOpacity?: number; + hideEndzones?: boolean; + valuesInLegend?: boolean; + ariaLabel?: string; +} + +export interface XYProps { + xTitle: string; + yTitle: string; + yRightTitle: string; + yLeftExtent: AxisExtentConfigResult; + yRightExtent: AxisExtentConfigResult; + legend: LegendConfigResult; + valueLabels: ValueLabelMode; + layers: CommonXYLayerConfig[]; endValue?: EndValue; emphasizeFitting?: boolean; fittingFunction?: FittingFunction; @@ -181,28 +253,48 @@ export interface XYArgs { export interface AnnotationLayerArgs { annotations: EventAnnotationOutput[]; - layerId: string; hide?: boolean; } +export type ExtendedAnnotationLayerArgs = AnnotationLayerArgs & { + layerId?: string; +}; + export type AnnotationLayerConfigResult = AnnotationLayerArgs & { type: typeof ANNOTATION_LAYER; layerType: typeof LayerTypes.ANNOTATIONS; }; +export type ExtendedAnnotationLayerConfigResult = ExtendedAnnotationLayerArgs & { + type: typeof EXTENDED_ANNOTATION_LAYER; + layerType: typeof LayerTypes.ANNOTATIONS; +}; + export interface ReferenceLineLayerArgs { - layerId: string; accessors: string[]; columnToLabel?: string; - yConfig?: YConfigResult[]; + yConfig?: ExtendedYConfigResult[]; +} + +export interface ExtendedReferenceLineLayerArgs { + layerId?: string; + accessors: string[]; + columnToLabel?: string; + yConfig?: ExtendedYConfigResult[]; + table?: Datatable; } export type XYLayerArgs = DataLayerArgs | ReferenceLineLayerArgs | AnnotationLayerArgs; +export type XYLayerConfig = DataLayerConfig | ReferenceLineLayerConfig | AnnotationLayerConfig; +export type XYExtendedLayerConfig = + | ExtendedDataLayerConfig + | ExtendedReferenceLineLayerConfig + | ExtendedAnnotationLayerConfig; -export type XYLayerConfigResult = - | DataLayerConfigResult - | ReferenceLineLayerConfigResult - | AnnotationLayerConfigResult; +export type XYExtendedLayerConfigResult = + | ExtendedDataLayerConfigResult + | ExtendedReferenceLineLayerConfigResult + | ExtendedAnnotationLayerConfigResult; export interface LensMultiTable { type: typeof MULTITABLE; @@ -216,14 +308,43 @@ export interface LensMultiTable { export type ReferenceLineLayerConfigResult = ReferenceLineLayerArgs & { type: typeof REFERENCE_LINE_LAYER; layerType: typeof LayerTypes.REFERENCELINE; + table: Datatable; }; -export type DataLayerConfigResult = DataLayerArgs & { +export type ExtendedReferenceLineLayerConfigResult = ExtendedReferenceLineLayerArgs & { + type: typeof EXTENDED_REFERENCE_LINE_LAYER; + layerType: typeof LayerTypes.REFERENCELINE; + table: Datatable; +}; + +export type DataLayerConfigResult = Omit & { type: typeof DATA_LAYER; layerType: typeof LayerTypes.DATA; + palette: PaletteOutput; + table: Datatable; +}; + +export interface WithLayerId { + layerId: string; +} + +export type DataLayerConfig = DataLayerConfigResult & WithLayerId; +export type ReferenceLineLayerConfig = ReferenceLineLayerConfigResult & WithLayerId; +export type AnnotationLayerConfig = AnnotationLayerConfigResult & WithLayerId; + +export type ExtendedDataLayerConfig = ExtendedDataLayerConfigResult & WithLayerId; +export type ExtendedReferenceLineLayerConfig = ExtendedReferenceLineLayerConfigResult & WithLayerId; +export type ExtendedAnnotationLayerConfig = ExtendedAnnotationLayerConfigResult & WithLayerId; + +export type ExtendedDataLayerConfigResult = Omit & { + type: typeof EXTENDED_DATA_LAYER; + layerType: typeof LayerTypes.DATA; + palette: PaletteOutput; + table: Datatable; }; export type YConfigResult = YConfig & { type: typeof Y_CONFIG }; +export type ExtendedYConfigResult = ExtendedYConfig & { type: typeof EXTENDED_Y_CONFIG }; export type AxisTitlesVisibilityConfigResult = AxesSettingsConfig & { type: typeof AXIS_TITLES_VISIBILITY_CONFIG; @@ -237,3 +358,70 @@ export type LegendConfigResult = LegendConfig & { type: typeof LEGEND_CONFIG }; export type AxisExtentConfigResult = AxisExtentConfig & { type: typeof AXIS_EXTENT_CONFIG }; export type GridlinesConfigResult = AxesSettingsConfig & { type: typeof GRID_LINES_CONFIG }; export type TickLabelsConfigResult = AxesSettingsConfig & { type: typeof TICK_LABELS_CONFIG }; + +export type CommonXYLayerConfig = XYLayerConfig | XYExtendedLayerConfig; +export type CommonXYDataLayerConfigResult = DataLayerConfigResult | ExtendedDataLayerConfigResult; +export type CommonXYReferenceLineLayerConfigResult = + | ReferenceLineLayerConfigResult + | ExtendedReferenceLineLayerConfigResult; + +export type CommonXYDataLayerConfig = DataLayerConfig | ExtendedDataLayerConfig; +export type CommonXYReferenceLineLayerConfig = + | ReferenceLineLayerConfig + | ExtendedReferenceLineLayerConfig; + +export type CommonXYAnnotationLayerConfig = AnnotationLayerConfig | ExtendedAnnotationLayerConfig; + +export type XyVisFn = ExpressionFunctionDefinition< + typeof XY_VIS, + Datatable, + XYArgs, + Promise +>; +export type LayeredXyVisFn = ExpressionFunctionDefinition< + typeof LAYERED_XY_VIS, + Datatable, + LayeredXYArgs, + Promise +>; + +export type DataLayerFn = ExpressionFunctionDefinition< + typeof DATA_LAYER, + Datatable, + DataLayerArgs, + DataLayerConfigResult +>; +export type ExtendedDataLayerFn = ExpressionFunctionDefinition< + typeof EXTENDED_DATA_LAYER, + Datatable, + ExtendedDataLayerArgs, + ExtendedDataLayerConfigResult +>; + +export type ReferenceLineLayerFn = ExpressionFunctionDefinition< + typeof REFERENCE_LINE_LAYER, + Datatable, + ReferenceLineLayerArgs, + ReferenceLineLayerConfigResult +>; +export type ExtendedReferenceLineLayerFn = ExpressionFunctionDefinition< + typeof EXTENDED_REFERENCE_LINE_LAYER, + Datatable, + ExtendedReferenceLineLayerArgs, + ExtendedReferenceLineLayerConfigResult +>; + +export type YConfigFn = ExpressionFunctionDefinition; +export type ExtendedYConfigFn = ExpressionFunctionDefinition< + typeof EXTENDED_Y_CONFIG, + null, + ExtendedYConfig, + ExtendedYConfigResult +>; + +export type LegendConfigFn = ExpressionFunctionDefinition< + typeof LEGEND_CONFIG, + null, + LegendConfig, + Promise +>; diff --git a/src/plugins/chart_expressions/expression_xy/common/types/expression_renderers.ts b/src/plugins/chart_expressions/expression_xy/common/types/expression_renderers.ts index 1acb98903d06b..b03ea975b0143 100644 --- a/src/plugins/chart_expressions/expression_xy/common/types/expression_renderers.ts +++ b/src/plugins/chart_expressions/expression_xy/common/types/expression_renderers.ts @@ -6,12 +6,16 @@ * Side Public License, v 1. */ +import { AnnotationTooltipFormatter } from '@elastic/charts'; +import { + AvailableAnnotationIcon, + ManualPointEventAnnotationArgs, +} from '@kbn/event-annotation-plugin/common'; import { XY_VIS_RENDERER } from '../constants'; -import { LensMultiTable, XYArgs } from './expression_functions'; +import { XYProps } from './expression_functions'; export interface XYChartProps { - data: LensMultiTable; - args: XYArgs; + args: XYProps; } export interface XYRender { @@ -19,3 +23,10 @@ export interface XYRender { as: typeof XY_VIS_RENDERER; value: XYChartProps; } + +export interface CollectiveConfig extends Omit { + roundedTimestamp: number; + axisMode: 'bottom'; + icon?: AvailableAnnotationIcon | string; + customTooltipDetails?: AnnotationTooltipFormatter | undefined; +} diff --git a/src/plugins/chart_expressions/expression_xy/common/utils/index.tsx b/src/plugins/chart_expressions/expression_xy/common/utils/index.tsx new file mode 100644 index 0000000000000..ba40d5768f50c --- /dev/null +++ b/src/plugins/chart_expressions/expression_xy/common/utils/index.tsx @@ -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 { logDatatables, getLayerDimensions } from './log_datatables'; diff --git a/src/plugins/chart_expressions/expression_xy/common/utils/log_datatables.ts b/src/plugins/chart_expressions/expression_xy/common/utils/log_datatables.ts new file mode 100644 index 0000000000000..79a3cbd2eef19 --- /dev/null +++ b/src/plugins/chart_expressions/expression_xy/common/utils/log_datatables.ts @@ -0,0 +1,55 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { ExecutionContext } from '@kbn/expressions-plugin'; +import { Dimension, prepareLogTable } from '@kbn/visualizations-plugin/common/utils'; +import { LayerTypes } from '../constants'; +import { strings } from '../i18n'; +import { + CommonXYDataLayerConfig, + CommonXYLayerConfig, + CommonXYReferenceLineLayerConfig, +} from '../types'; + +export const logDatatables = (layers: CommonXYLayerConfig[], handlers: ExecutionContext) => { + if (!handlers?.inspectorAdapters?.tables) { + return; + } + + handlers.inspectorAdapters.tables.reset(); + handlers.inspectorAdapters.tables.allowCsvExport = true; + + layers.forEach((layer) => { + if (layer.layerType === LayerTypes.ANNOTATIONS) { + return; + } + const logTable = prepareLogTable(layer.table, getLayerDimensions(layer), true); + handlers.inspectorAdapters.tables.logDatatable(layer.layerId, logTable); + }); +}; + +export const getLayerDimensions = ( + layer: CommonXYDataLayerConfig | CommonXYReferenceLineLayerConfig +): Dimension[] => { + let xAccessor; + let splitAccessor; + if (layer.layerType === LayerTypes.DATA) { + xAccessor = layer.xAccessor; + splitAccessor = layer.splitAccessor; + } + + const { accessors, layerType } = layer; + return [ + [ + accessors ? accessors : undefined, + layerType === LayerTypes.DATA ? strings.getMetricHelp() : strings.getReferenceLineHelp(), + ], + [xAccessor ? [xAccessor] : undefined, strings.getXAxisHelp()], + [splitAccessor ? [splitAccessor] : undefined, strings.getBreakdownHelp()], + ]; +}; diff --git a/src/plugins/chart_expressions/expression_xy/public/__mocks__/index.tsx b/src/plugins/chart_expressions/expression_xy/public/__mocks__/index.tsx index 60b9f6a5788b4..194bfc2bf5c9d 100644 --- a/src/plugins/chart_expressions/expression_xy/public/__mocks__/index.tsx +++ b/src/plugins/chart_expressions/expression_xy/public/__mocks__/index.tsx @@ -6,9 +6,11 @@ * Side Public License, v 1. */ +import { Datatable } from '@kbn/expressions-plugin/common'; import { chartPluginMock } from '@kbn/charts-plugin/public/mocks'; -import { DataLayerConfigResult, LensMultiTable, XYArgs } from '../../common'; +import { LensMultiTable } from '../../common'; import { LayerTypes } from '../../common/constants'; +import { DataLayerConfig, XYProps } from '../../common/types'; import { mockPaletteOutput, sampleArgs } from '../../common/__mocks__'; const chartSetupContract = chartPluginMock.createSetupContract(); @@ -166,9 +168,9 @@ export const dateHistogramData: LensMultiTable = { }, }; -export const dateHistogramLayer: DataLayerConfigResult = { +export const dateHistogramLayer: DataLayerConfig = { + layerId: 'dateHistogramLayer', type: 'dataLayer', - layerId: 'timeLayer', layerType: LayerTypes.DATA, hide: false, xAccessor: 'xAccessorId', @@ -179,46 +181,37 @@ export const dateHistogramLayer: DataLayerConfigResult = { seriesType: 'bar_stacked', accessors: ['yAccessorId'], palette: mockPaletteOutput, + table: dateHistogramData.tables.timeLayer, }; export function sampleArgsWithReferenceLine(value: number = 150) { - const { data, args } = sampleArgs(); + const { args: sArgs } = sampleArgs(); + const data: Datatable = { + type: 'datatable', + columns: [ + { + id: 'referenceLine-a', + meta: { params: { id: 'number' }, type: 'number' }, + name: 'Static value', + }, + ], + rows: [{ 'referenceLine-a': value }], + }; - return { - data: { - ...data, - tables: { - ...data.tables, - referenceLine: { - type: 'datatable', - columns: [ - { - id: 'referenceLine-a', - meta: { params: { id: 'number' }, type: 'number' }, - name: 'Static value', - }, - ], - rows: [{ 'referenceLine-a': value }], - }, + const args: XYProps = { + ...sArgs, + layers: [ + ...sArgs.layers, + { + layerId: 'referenceLine-a', + type: 'referenceLineLayer', + layerType: LayerTypes.REFERENCELINE, + accessors: ['referenceLine-a'], + yConfig: [{ axisMode: 'left', forAccessor: 'referenceLine-a', type: 'extendedYConfig' }], + table: data, }, - } as LensMultiTable, - args: { - ...args, - layers: [ - ...args.layers, - { - layerType: LayerTypes.REFERENCELINE, - accessors: ['referenceLine-a'], - layerId: 'referenceLine', - seriesType: 'line', - xScaleType: 'linear', - yScaleType: 'linear', - palette: mockPaletteOutput, - isHistogram: false, - hide: true, - yConfig: [{ axisMode: 'left', forAccessor: 'referenceLine-a', type: 'yConfig' }], - }, - ], - } as XYArgs, + ], }; + + return { data, args }; } diff --git a/src/plugins/chart_expressions/expression_xy/public/components/__snapshots__/xy_chart.test.tsx.snap b/src/plugins/chart_expressions/expression_xy/public/components/__snapshots__/xy_chart.test.tsx.snap index f534db5a6c4e9..3b11ee812da6f 100644 --- a/src/plugins/chart_expressions/expression_xy/public/components/__snapshots__/xy_chart.test.tsx.snap +++ b/src/plugins/chart_expressions/expression_xy/public/components/__snapshots__/xy_chart.test.tsx.snap @@ -1,6 +1,6 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP -exports[`XYChart component annotations should render basic annotation 1`] = ` +exports[`XYChart component annotations should render basic line annotation 1`] = ` `; -exports[`XYChart component annotations should render grouped annotations preserving the shared styles 1`] = ` +exports[`XYChart component annotations should render basic range annotation 1`] = ` +Array [ + , + , +] +`; + +exports[`XYChart component annotations should render grouped line annotations preserving the shared styles 1`] = ` `; -exports[`XYChart component annotations should render grouped annotations with default styles 1`] = ` +exports[`XYChart component annotations should render grouped line annotations with default styles 1`] = ` `; -exports[`XYChart component annotations should render simplified annotation when hide is true 1`] = ` +exports[`XYChart component annotations should render simplified annotations when hide is true 1`] = ` - } - markerBody={ - - } markerPosition="top" style={ Object { @@ -213,6 +236,50 @@ exports[`XYChart component annotations should render simplified annotation when /> `; +exports[`XYChart component annotations should render simplified annotations when hide is true 2`] = ` +Array [ + , + , +] +`; + exports[`XYChart component it renders area 1`] = ` - - `; @@ -457,6 +830,14 @@ exports[`XYChart component it renders bar 1`] = ` ariaUseDefaultSummary={true} baseTheme={Object {}} debugState={false} + externalPointerEvents={ + Object { + "tooltip": Object { + "placement": "right", + "visible": false, + }, + } + } legendAction={ Object { "$$typeof": Symbol(react.memo), @@ -558,139 +939,425 @@ exports[`XYChart component it renders bar 1`] = ` darkMode={false} histogramMode={false} /> - - `; @@ -704,6 +1371,14 @@ exports[`XYChart component it renders horizontal bar 1`] = ` ariaUseDefaultSummary={true} baseTheme={Object {}} debugState={false} + externalPointerEvents={ + Object { + "tooltip": Object { + "placement": "right", + "visible": false, + }, + } + } legendAction={ Object { "$$typeof": Symbol(react.memo), @@ -805,139 +1480,425 @@ exports[`XYChart component it renders horizontal bar 1`] = ` darkMode={false} histogramMode={false} /> - - `; @@ -951,6 +1912,14 @@ exports[`XYChart component it renders line 1`] = ` ariaUseDefaultSummary={true} baseTheme={Object {}} debugState={false} + externalPointerEvents={ + Object { + "tooltip": Object { + "placement": "right", + "visible": false, + }, + } + } legendAction={ Object { "$$typeof": Symbol(react.memo), @@ -1052,127 +2021,425 @@ exports[`XYChart component it renders line 1`] = ` darkMode={false} histogramMode={false} /> - - `; @@ -1186,6 +2453,14 @@ exports[`XYChart component it renders stacked area 1`] = ` ariaUseDefaultSummary={true} baseTheme={Object {}} debugState={false} + externalPointerEvents={ + Object { + "tooltip": Object { + "placement": "right", + "visible": false, + }, + } + } legendAction={ Object { "$$typeof": Symbol(react.memo), @@ -1287,135 +2562,425 @@ exports[`XYChart component it renders stacked area 1`] = ` darkMode={false} histogramMode={false} /> - - `; @@ -1429,6 +2994,14 @@ exports[`XYChart component it renders stacked bar 1`] = ` ariaUseDefaultSummary={true} baseTheme={Object {}} debugState={false} + externalPointerEvents={ + Object { + "tooltip": Object { + "placement": "right", + "visible": false, + }, + } + } legendAction={ Object { "$$typeof": Symbol(react.memo), @@ -1530,147 +3103,425 @@ exports[`XYChart component it renders stacked bar 1`] = ` darkMode={false} histogramMode={false} /> - - `; @@ -1684,6 +3535,14 @@ exports[`XYChart component it renders stacked horizontal bar 1`] = ` ariaUseDefaultSummary={true} baseTheme={Object {}} debugState={false} + externalPointerEvents={ + Object { + "tooltip": Object { + "placement": "right", + "visible": false, + }, + } + } legendAction={ Object { "$$typeof": Symbol(react.memo), @@ -1785,147 +3644,425 @@ exports[`XYChart component it renders stacked horizontal bar 1`] = ` darkMode={false} histogramMode={false} /> - - `; diff --git a/src/plugins/chart_expressions/expression_xy/public/components/annotations.scss b/src/plugins/chart_expressions/expression_xy/public/components/annotations.scss index 88881ae718925..e1e58252b5de7 100644 --- a/src/plugins/chart_expressions/expression_xy/public/components/annotations.scss +++ b/src/plugins/chart_expressions/expression_xy/public/components/annotations.scss @@ -16,3 +16,7 @@ transform: rotate(45deg); transform-origin: center; } + +.xyAnnotationTooltipDetail { + padding: $euiSizeXS ($euiSizeXS * 2); +} \ No newline at end of file diff --git a/src/plugins/chart_expressions/expression_xy/public/components/annotations.tsx b/src/plugins/chart_expressions/expression_xy/public/components/annotations.tsx index 976bec6678fe5..fa2c081f08700 100644 --- a/src/plugins/chart_expressions/expression_xy/public/components/annotations.tsx +++ b/src/plugins/chart_expressions/expression_xy/public/components/annotations.tsx @@ -16,13 +16,25 @@ import { AnnotationTooltipFormatter, LineAnnotation, Position, + RectAnnotation, } from '@elastic/charts'; import moment from 'moment'; -import { EuiFlexGroup, EuiFlexItem } from '@elastic/eui'; -import type { EventAnnotationArgs } from '@kbn/event-annotation-plugin/common'; +import { EuiFlexGroup, EuiFlexItem, EuiText } from '@elastic/eui'; +import type { + ManualPointEventAnnotationArgs, + ManualRangeEventAnnotationOutput, +} from '@kbn/event-annotation-plugin/common'; import type { FieldFormat } from '@kbn/field-formats-plugin/common'; -import { defaultAnnotationColor } from '@kbn/event-annotation-plugin/public'; -import type { AnnotationLayerArgs, AnnotationLayerConfigResult } from '../../common/types'; +import { + defaultAnnotationColor, + defaultAnnotationRangeColor, +} from '@kbn/event-annotation-plugin/public'; +import type { + AnnotationLayerArgs, + CommonXYAnnotationLayerConfig, + CollectiveConfig, +} from '../../common'; + import { AnnotationIcon, hasIcon, Marker, MarkerBody } from '../helpers'; import { mapVerticalToHorizontalPlacement, LINES_MARKER_SIZE } from '../helpers'; @@ -34,19 +46,15 @@ const getRoundedTimestamp = (timestamp: number, firstTimestamp?: number, minInte }; export interface AnnotationsProps { - groupedAnnotations: CollectiveConfig[]; + groupedLineAnnotations: CollectiveConfig[]; + rangeAnnotations: ManualRangeEventAnnotationOutput[]; formatter?: FieldFormat; isHorizontal: boolean; paddingMap: Partial>; hide?: boolean; minInterval?: number; isBarChart?: boolean; -} - -interface CollectiveConfig extends EventAnnotationArgs { - roundedTimestamp: number; - axisMode: 'bottom'; - customTooltipDetails?: AnnotationTooltipFormatter | undefined; + outsideDimension: number; } const groupVisibleConfigsByInterval = ( @@ -55,9 +63,11 @@ const groupVisibleConfigsByInterval = ( firstTimestamp?: number ) => { return layers - .flatMap(({ annotations }) => annotations.filter((a) => !a.isHidden)) + .flatMap(({ annotations }) => + annotations.filter((a) => !a.isHidden && a.type === 'manual_point_event_annotation') + ) .sort((a, b) => moment(a.time).valueOf() - moment(b.time).valueOf()) - .reduce>((acc, current) => { + .reduce>((acc, current) => { const roundedTimestamp = getRoundedTimestamp( moment(current.time).valueOf(), firstTimestamp, @@ -72,7 +82,7 @@ const groupVisibleConfigsByInterval = ( const createCustomTooltipDetails = ( - config: EventAnnotationArgs[], + config: ManualPointEventAnnotationArgs[], formatter?: FieldFormat ): AnnotationTooltipFormatter | undefined => () => { @@ -95,8 +105,8 @@ const createCustomTooltipDetails = ); }; -function getCommonProperty( - configArr: EventAnnotationArgs[], +function getCommonProperty( + configArr: ManualPointEventAnnotationArgs[], propertyName: K, fallbackValue: T ) { @@ -107,9 +117,9 @@ function getCommonProperty( return fallbackValue; } -const getCommonStyles = (configArr: EventAnnotationArgs[]) => { +const getCommonStyles = (configArr: ManualPointEventAnnotationArgs[]) => { return { - color: getCommonProperty( + color: getCommonProperty( configArr, 'color', defaultAnnotationColor @@ -120,8 +130,22 @@ const getCommonStyles = (configArr: EventAnnotationArgs[]) => { }; }; +export const getRangeAnnotations = (layers: CommonXYAnnotationLayerConfig[]) => { + return layers + .flatMap(({ annotations }) => + annotations.filter( + (a): a is ManualRangeEventAnnotationOutput => + a.type === 'manual_range_event_annotation' && !a.isHidden + ) + ) + .sort((a, b) => moment(a.time).valueOf() - moment(b.time).valueOf()); +}; + +export const OUTSIDE_RECT_ANNOTATION_WIDTH = 8; +export const OUTSIDE_RECT_ANNOTATION_WIDTH_SUGGESTION = 2; + export const getAnnotationsGroupedByInterval = ( - layers: AnnotationLayerConfigResult[], + layers: CommonXYAnnotationLayerConfig[], minInterval?: number, firstTimestamp?: number, formatter?: FieldFormat @@ -147,18 +171,23 @@ export const getAnnotationsGroupedByInterval = ( }); }; +// todo: remove when closed https://github.com/elastic/elastic-charts/issues/1647 +RectAnnotation.displayName = 'RectAnnotation'; + export const Annotations = ({ - groupedAnnotations, + groupedLineAnnotations, + rangeAnnotations, formatter, isHorizontal, paddingMap, hide, minInterval, isBarChart, + outsideDimension, }: AnnotationsProps) => { return ( <> - {groupedAnnotations.map((annotation) => { + {groupedLineAnnotations.map((annotation) => { const markerPositionVertical = Position.Top; const markerPosition = isHorizontal ? mapVerticalToHorizontalPlacement(markerPositionVertical) @@ -229,6 +258,40 @@ export const Annotations = ({ /> ); })} + {rangeAnnotations.map(({ label, time, color, endTime, outside }) => { + const id = snakeCase(label); + + return ( + ( +
+ +

+ {formatter + ? `${formatter.convert(time)} — ${formatter?.convert(endTime)}` + : `${moment(time).toISOString()} — ${moment(endTime).toISOString()}`} +

+ +
{label}
+
+ )} + dataValues={[ + { + coordinates: { + x0: moment(time).valueOf(), + x1: moment(endTime).valueOf(), + }, + details: label, + }, + ]} + style={{ fill: color || defaultAnnotationRangeColor, opacity: 1 }} + outside={Boolean(outside)} + outsideDimension={outsideDimension} + /> + ); + })} ); }; diff --git a/src/plugins/chart_expressions/expression_xy/public/components/data_layers.tsx b/src/plugins/chart_expressions/expression_xy/public/components/data_layers.tsx new file mode 100644 index 0000000000000..1166d41a9e402 --- /dev/null +++ b/src/plugins/chart_expressions/expression_xy/public/components/data_layers.tsx @@ -0,0 +1,166 @@ +/* + * Copyright 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 { + AreaSeries, + BarSeries, + CurveType, + LabelOverflowConstraint, + LineSeries, +} from '@elastic/charts'; +import React, { FC } from 'react'; +import { PaletteRegistry } from '@kbn/coloring'; +import { FormatFactory } from '@kbn/field-formats-plugin/common'; +import { + CommonXYDataLayerConfig, + EndValue, + FittingFunction, + ValueLabelMode, + XYCurveType, +} from '../../common'; +import { SeriesTypes, ValueLabelModes } from '../../common/constants'; +import { + getColorAssignments, + getFitOptions, + GroupsConfiguration, + getSeriesProps, + DatatablesWithFormatInfo, +} from '../helpers'; + +interface Props { + layers: CommonXYDataLayerConfig[]; + formatFactory: FormatFactory; + chartHasMoreThanOneBarSeries?: boolean; + yAxesConfiguration: GroupsConfiguration; + curveType?: XYCurveType; + fittingFunction?: FittingFunction; + endValue?: EndValue | undefined; + paletteService: PaletteRegistry; + formattedDatatables: DatatablesWithFormatInfo; + syncColors?: boolean; + timeZone?: string; + emphasizeFitting?: boolean; + fillOpacity?: number; + shouldShowValueLabels?: boolean; + valueLabels: ValueLabelMode; +} + +export const DataLayers: FC = ({ + layers, + endValue, + timeZone, + curveType, + syncColors, + valueLabels, + fillOpacity, + formatFactory, + paletteService, + fittingFunction, + emphasizeFitting, + yAxesConfiguration, + shouldShowValueLabels, + formattedDatatables, + chartHasMoreThanOneBarSeries, +}) => { + const colorAssignments = getColorAssignments(layers, formatFactory); + return ( + <> + {layers.flatMap((layer) => + layer.accessors.map((accessor, accessorIndex) => { + const { seriesType, columnToLabel, layerId } = layer; + const columnToLabelMap: Record = columnToLabel + ? JSON.parse(columnToLabel) + : {}; + + // what if row values are not primitive? That is the case of, for instance, Ranges + // remaps them to their serialized version with the formatHint metadata + // In order to do it we need to make a copy of the table as the raw one is required for more features (filters, etc...) later on + const formattedDatatableInfo = formattedDatatables[layerId]; + + const isPercentage = seriesType.includes('percentage'); + + const yAxis = yAxesConfiguration.find((axisConfiguration) => + axisConfiguration.series.find((currentSeries) => currentSeries.accessor === accessor) + ); + + const seriesProps = getSeriesProps({ + layer, + accessor, + chartHasMoreThanOneBarSeries, + colorAssignments, + formatFactory, + columnToLabelMap, + paletteService, + formattedDatatableInfo, + syncColors, + yAxis, + timeZone, + emphasizeFitting, + fillOpacity, + }); + + const index = `${layer.layerId}-${accessorIndex}`; + + const curve = curveType ? CurveType[curveType] : undefined; + + switch (seriesType) { + case SeriesTypes.LINE: + return ( + + ); + case SeriesTypes.BAR: + case SeriesTypes.BAR_STACKED: + case SeriesTypes.BAR_PERCENTAGE_STACKED: + case SeriesTypes.BAR_HORIZONTAL: + case SeriesTypes.BAR_HORIZONTAL_STACKED: + case SeriesTypes.BAR_HORIZONTAL_PERCENTAGE_STACKED: + const valueLabelsSettings = { + displayValueSettings: { + // This format double fixes two issues in elastic-chart + // * when rotating the chart, the formatter is not correctly picked + // * in some scenarios value labels are not strings, and this breaks the elastic-chart lib + valueFormatter: (d: unknown) => yAxis?.formatter?.convert(d) || '', + showValueLabel: shouldShowValueLabels && valueLabels !== ValueLabelModes.HIDE, + isValueContainedInElement: false, + isAlternatingValueLabel: false, + overflowConstraints: [ + LabelOverflowConstraint.ChartEdges, + LabelOverflowConstraint.BarGeometry, + ], + }, + }; + return ; + case SeriesTypes.AREA_STACKED: + case SeriesTypes.AREA_PERCENTAGE_STACKED: + return ( + + ); + case SeriesTypes.AREA: + return ( + + ); + } + }) + )} + + ); +}; diff --git a/src/plugins/chart_expressions/expression_xy/public/components/legend_action.test.tsx b/src/plugins/chart_expressions/expression_xy/public/components/legend_action.test.tsx index 0f1cdebc5bf59..7c60a6a3a5769 100644 --- a/src/plugins/chart_expressions/expression_xy/public/components/legend_action.test.tsx +++ b/src/plugins/chart_expressions/expression_xy/public/components/legend_action.test.tsx @@ -11,27 +11,12 @@ import { LegendActionProps, SeriesIdentifier } from '@elastic/charts'; import { EuiPopover } from '@elastic/eui'; import { mountWithIntl } from '@kbn/test-jest-helpers'; import { ComponentType, ReactWrapper } from 'enzyme'; -import type { LensMultiTable } from '../../common'; +import type { DataLayerConfig, LensMultiTable } from '../../common'; import { LayerTypes } from '../../common/constants'; -import type { DataLayerArgs } from '../../common'; import { getLegendAction } from './legend_action'; import { LegendActionPopover } from './legend_action_popover'; import { mockPaletteOutput } from '../../common/__mocks__'; -const sampleLayer = { - layerId: 'first', - layerType: LayerTypes.DATA, - seriesType: 'line', - xAccessor: 'c', - accessors: ['a', 'b'], - splitAccessor: 'splitAccessorId', - columnToLabel: '{"a": "Label A", "b": "Label B", "d": "Label D"}', - xScaleType: 'ordinal', - yScaleType: 'linear', - isHistogram: false, - palette: mockPaletteOutput, -} as DataLayerArgs; - const tables = { first: { type: 'datatable', @@ -168,11 +153,26 @@ const tables = { }, } as LensMultiTable['tables']; +const sampleLayer: DataLayerConfig = { + layerId: 'first', + type: 'dataLayer', + layerType: LayerTypes.DATA, + seriesType: 'line', + xAccessor: 'c', + accessors: ['a', 'b'], + splitAccessor: 'splitAccessorId', + columnToLabel: '{"a": "Label A", "b": "Label B", "d": "Label D"}', + xScaleType: 'ordinal', + yScaleType: 'linear', + isHistogram: false, + palette: mockPaletteOutput, + table: tables.first, +}; + describe('getLegendAction', function () { let wrapperProps: LegendActionProps; const Component: ComponentType = getLegendAction( [sampleLayer], - tables, jest.fn(), jest.fn(), {} diff --git a/src/plugins/chart_expressions/expression_xy/public/components/legend_action.tsx b/src/plugins/chart_expressions/expression_xy/public/components/legend_action.tsx index 9bbdec3635fa8..da1939f223649 100644 --- a/src/plugins/chart_expressions/expression_xy/public/components/legend_action.tsx +++ b/src/plugins/chart_expressions/expression_xy/public/components/legend_action.tsx @@ -9,23 +9,28 @@ import React from 'react'; import type { LegendAction, XYChartSeriesIdentifier } from '@elastic/charts'; import type { FilterEvent } from '../types'; -import type { LensMultiTable, DataLayerArgs } from '../../common'; +import type { CommonXYDataLayerConfig } from '../../common'; import type { FormatFactory } from '../types'; import { LegendActionPopover } from './legend_action_popover'; +import { DatatablesWithFormatInfo } from '../helpers'; export const getLegendAction = ( - filteredLayers: DataLayerArgs[], - tables: LensMultiTable['tables'], + dataLayers: CommonXYDataLayerConfig[], onFilter: (data: FilterEvent['data']) => void, formatFactory: FormatFactory, - layersAlreadyFormatted: Record + formattedDatatables: DatatablesWithFormatInfo ): LegendAction => React.memo(({ series: [xySeries] }) => { const series = xySeries as XYChartSeriesIdentifier; - const layer = filteredLayers.find((l) => + const layerIndex = dataLayers.findIndex((l) => series.seriesKeys.some((key: string | number) => l.accessors.includes(key.toString())) ); + if (layerIndex === -1) { + return null; + } + + const layer = dataLayers[layerIndex]; if (!layer || !layer.splitAccessor) { return null; } @@ -33,12 +38,12 @@ export const getLegendAction = ( const splitLabel = series.seriesKeys[0] as string; const accessor = layer.splitAccessor; - const table = tables[layer.layerId]; + const { table } = layer; const splitColumn = table.columns.find(({ id }) => id === layer.splitAccessor); const formatter = formatFactory(splitColumn && splitColumn.meta?.params); const rowIndex = table.rows.findIndex((row) => { - if (layersAlreadyFormatted[accessor]) { + if (formattedDatatables[layer.layerId]?.formattedColumns[accessor]) { // stringify the value to compare with the chart value return formatter.convert(row[accessor]) === splitLabel; } @@ -63,7 +68,7 @@ export const getLegendAction = ( return ( = { @@ -23,34 +28,28 @@ const row: Record = { yAccessorRightSecondId: 10, }; -const histogramData: LensMultiTable = { - type: 'lens_multitable', - tables: { - firstLayer: { - type: 'datatable', - rows: [row], - columns: Object.keys(row).map((id) => ({ - id, - name: `Static value: ${row[id]}`, - meta: { - type: 'number', - params: { id: 'number' }, - }, - })), +const data: Datatable = { + type: 'datatable', + rows: [row], + columns: Object.keys(row).map((id) => ({ + id, + name: `Static value: ${row[id]}`, + meta: { + type: 'number', + params: { id: 'number' }, }, - }, - dateRange: { - fromDate: new Date('2020-04-01T16:14:16.246Z'), - toDate: new Date('2020-04-01T17:15:41.263Z'), - }, + })), }; -function createLayers(yConfigs: ReferenceLineLayerArgs['yConfig']): ReferenceLineLayerArgs[] { +function createLayers(yConfigs: ReferenceLineLayerArgs['yConfig']): ReferenceLineLayerConfig[] { return [ { - layerId: 'firstLayer', + layerId: 'first', accessors: (yConfigs || []).map(({ forAccessor }) => forAccessor), yConfig: yConfigs, + type: 'referenceLineLayer', + layerType: LayerTypes.REFERENCELINE, + table: data, }, ]; } @@ -64,7 +63,7 @@ interface XCoords { x1: number | undefined; } -function getAxisFromId(layerPrefix: string): YConfig['axisMode'] { +function getAxisFromId(layerPrefix: string): ExtendedYConfig['axisMode'] { return /left/i.test(layerPrefix) ? 'left' : /right/i.test(layerPrefix) ? 'right' : 'bottom'; } @@ -95,21 +94,20 @@ describe('ReferenceLineAnnotations', () => { ['yAccessorLeft', 'below'], ['yAccessorRight', 'above'], ['yAccessorRight', 'below'], - ] as Array<[string, YConfig['fill']]>)( + ] as Array<[string, ExtendedYConfig['fill']]>)( 'should render a RectAnnotation for a reference line with fill set: %s %s', (layerPrefix, fill) => { const axisMode = getAxisFromId(layerPrefix); const wrapper = shallow( @@ -135,19 +133,18 @@ describe('ReferenceLineAnnotations', () => { it.each([ ['xAccessor', 'above'], ['xAccessor', 'below'], - ] as Array<[string, YConfig['fill']]>)( + ] as Array<[string, ExtendedYConfig['fill']]>)( 'should render a RectAnnotation for a reference line with fill set: %s %s', (layerPrefix, fill) => { const wrapper = shallow( { ['yAccessorLeft', 'below', { y0: undefined, y1: 5 }, { y0: 5, y1: 10 }], ['yAccessorRight', 'above', { y0: 5, y1: 10 }, { y0: 10, y1: undefined }], ['yAccessorRight', 'below', { y0: undefined, y1: 5 }, { y0: 5, y1: 10 }], - ] as Array<[string, YConfig['fill'], YCoords, YCoords]>)( + ] as Array<[string, ExtendedYConfig['fill'], YCoords, YCoords]>)( 'should avoid overlap between two reference lines with fill in the same direction: 2 x %s %s', (layerPrefix, fill, coordsA, coordsB) => { const axisMode = getAxisFromId(layerPrefix); const wrapper = shallow( { it.each([ ['xAccessor', 'above', { x0: 1, x1: 2 }, { x0: 2, x1: undefined }], ['xAccessor', 'below', { x0: undefined, x1: 1 }, { x0: 1, x1: 2 }], - ] as Array<[string, YConfig['fill'], XCoords, XCoords]>)( + ] as Array<[string, ExtendedYConfig['fill'], XCoords, XCoords]>)( 'should avoid overlap between two reference lines with fill in the same direction: 2 x %s %s', (layerPrefix, fill, coordsA, coordsB) => { const wrapper = shallow( { const wrapper = shallow( @@ -326,27 +320,26 @@ describe('ReferenceLineAnnotations', () => { it.each([ ['above', { y0: 5, y1: 10 }, { y0: 10, y1: undefined }], ['below', { y0: undefined, y1: 5 }, { y0: 5, y1: 10 }], - ] as Array<[YConfig['fill'], YCoords, YCoords]>)( + ] as Array<[ExtendedYConfig['fill'], YCoords, YCoords]>)( 'should be robust and works also for different axes when on same direction: 1x Left + 1x Right both %s', (fill, coordsA, coordsB) => { const wrapper = shallow( diff --git a/src/plugins/chart_expressions/expression_xy/public/components/reference_lines.tsx b/src/plugins/chart_expressions/expression_xy/public/components/reference_lines.tsx index 6146cc379227d..d17dbf2a70ad1 100644 --- a/src/plugins/chart_expressions/expression_xy/public/components/reference_lines.tsx +++ b/src/plugins/chart_expressions/expression_xy/public/components/reference_lines.tsx @@ -13,8 +13,7 @@ import { groupBy } from 'lodash'; import { RectAnnotation, AnnotationDomainType, LineAnnotation, Position } from '@elastic/charts'; import { euiLightVars } from '@kbn/ui-theme'; import type { FieldFormat } from '@kbn/field-formats-plugin/common'; -import type { IconPosition, ReferenceLineLayerArgs, YAxisMode } from '../../common/types'; -import type { LensMultiTable } from '../../common/types'; +import type { CommonXYReferenceLineLayerConfig, IconPosition, YAxisMode } from '../../common/types'; import { LINES_MARKER_SIZE, mapVerticalToHorizontalPlacement, @@ -89,8 +88,7 @@ export function getBaseIconPlacement( } export interface ReferenceLineAnnotationsProps { - layers: ReferenceLineLayerArgs[]; - data: LensMultiTable; + layers: CommonXYReferenceLineLayerConfig[]; formatters: Record<'left' | 'right' | 'bottom', FieldFormat | undefined>; axesMap: Record<'left' | 'right', boolean>; isHorizontal: boolean; @@ -99,7 +97,6 @@ export interface ReferenceLineAnnotationsProps { export const ReferenceLineAnnotations = ({ layers, - data, formatters, axesMap, isHorizontal, @@ -111,11 +108,10 @@ export const ReferenceLineAnnotations = ({ if (!layer.yConfig) { return []; } - const { columnToLabel, yConfig: yConfigs, layerId } = layer; + const { columnToLabel, yConfig: yConfigs, table } = layer; const columnToLabelMap: Record = columnToLabel ? JSON.parse(columnToLabel) : {}; - const table = data.tables[layerId]; const row = table.rows[0]; @@ -194,8 +190,8 @@ export const ReferenceLineAnnotations = ({ annotations.push( ({ dataValue: row[yConfig.forAccessor], header: columnToLabelMap[yConfig.forAccessor], @@ -225,8 +221,8 @@ export const ReferenceLineAnnotations = ({ annotations.push( { const nextValue = shouldCheckNextReferenceLine ? row[groupedByDirection[yConfig.fill!][indexFromSameType + 1].forAccessor] diff --git a/src/plugins/chart_expressions/expression_xy/public/components/x_domain.tsx b/src/plugins/chart_expressions/expression_xy/public/components/x_domain.tsx index 257d299616946..78b6ef91926a8 100644 --- a/src/plugins/chart_expressions/expression_xy/public/components/x_domain.tsx +++ b/src/plugins/chart_expressions/expression_xy/public/components/x_domain.tsx @@ -11,7 +11,7 @@ import React from 'react'; import moment from 'moment'; import { Endzones } from '@kbn/charts-plugin/public'; import { search } from '@kbn/data-plugin/public'; -import type { LensMultiTable, DataLayerArgs } from '../../common'; +import type { CommonXYDataLayerConfig } from '../../common'; export interface XDomain { min?: number; @@ -19,17 +19,16 @@ export interface XDomain { minInterval?: number; } -export const getAppliedTimeRange = (layers: DataLayerArgs[], data: LensMultiTable) => { - return Object.entries(data.tables) - .map(([tableId, table]) => { - const layer = layers.find((l) => l.layerId === tableId); - const xColumn = table.columns.find((col) => col.id === layer?.xAccessor); +export const getAppliedTimeRange = (layers: CommonXYDataLayerConfig[]) => { + return layers + .map(({ xAccessor, table }) => { + const xColumn = table.columns.find((col) => col.id === xAccessor); const timeRange = xColumn && search.aggs.getDateHistogramMetaDataByDatatableColumn(xColumn)?.timeRange; if (timeRange) { return { timeRange, - field: xColumn.meta.field, + field: xColumn?.meta.field, }; } }) @@ -37,13 +36,12 @@ export const getAppliedTimeRange = (layers: DataLayerArgs[], data: LensMultiTabl }; export const getXDomain = ( - layers: DataLayerArgs[], - data: LensMultiTable, + layers: CommonXYDataLayerConfig[], minInterval: number | undefined, isTimeViz: boolean, isHistogram: boolean ) => { - const appliedTimeRange = getAppliedTimeRange(layers, data)?.timeRange; + const appliedTimeRange = getAppliedTimeRange(layers)?.timeRange; const from = appliedTimeRange?.from; const to = appliedTimeRange?.to; const baseDomain = isTimeViz @@ -59,8 +57,8 @@ export const getXDomain = ( if (isHistogram && isFullyQualified(baseDomain)) { const xValues = uniq( layers - .flatMap((layer) => - data.tables[layer.layerId].rows.map((row) => row[layer.xAccessor!].valueOf() as number) + .flatMap(({ table, xAccessor }) => + table.rows.map((row) => row[xAccessor!].valueOf()) ) .sort() ); diff --git a/src/plugins/chart_expressions/expression_xy/public/components/xy_chart.test.tsx b/src/plugins/chart_expressions/expression_xy/public/components/xy_chart.test.tsx index 6ac39b1c0f941..de67e814d5b78 100644 --- a/src/plugins/chart_expressions/expression_xy/public/components/xy_chart.test.tsx +++ b/src/plugins/chart_expressions/expression_xy/public/components/xy_chart.test.tsx @@ -9,13 +9,6 @@ import React from 'react'; import { mount, shallow } from 'enzyme'; import { mountWithIntl } from '@kbn/test-jest-helpers'; -import { - AnnotationLayerConfigResult, - DataLayerConfigResult, - LensMultiTable, - XYArgs, -} from '../../common'; -import { LayerTypes } from '../../common/constants'; import { AreaSeries, Axis, @@ -27,13 +20,19 @@ import { LineAnnotation, LineSeries, Position, + RectAnnotation, ScaleType, SeriesNameFn, Settings, VerticalAlignment, XYChartSeriesIdentifier, } from '@elastic/charts'; +import { Datatable } from '@kbn/expressions-plugin/common'; import { EmptyPlaceholder } from '@kbn/charts-plugin/public'; +import { eventAnnotationServiceMock } from '@kbn/event-annotation-plugin/public/mocks'; +import { EventAnnotationOutput } from '@kbn/event-annotation-plugin/common'; +import { DataLayerConfig } from '../../common'; +import { LayerTypes } from '../../common/constants'; import { XyEndzones } from './x_domain'; import { chartsActiveCursorService, @@ -51,8 +50,13 @@ import { sampleLayer, } from '../../common/__mocks__'; import { XYChart, XYChartRenderProps } from './xy_chart'; -import { eventAnnotationServiceMock } from '@kbn/event-annotation-plugin/public/mocks'; -import { EventAnnotationOutput } from '@kbn/event-annotation-plugin/common'; +import { + CommonXYAnnotationLayerConfig, + ExtendedDataLayerConfig, + XYProps, +} from '../../common/types'; +import { DataLayers } from './data_layers'; +import { Annotations } from './annotations'; const onClickValue = jest.fn(); const onSelectRange = jest.fn(); @@ -62,45 +66,36 @@ describe('XYChart component', () => { let convertSpy: jest.Mock; let defaultProps: Omit; - const dataWithoutFormats: LensMultiTable = { - type: 'lens_multitable', - tables: { - first: { - type: 'datatable', - columns: [ - { id: 'a', name: 'a', meta: { type: 'number' } }, - { id: 'b', name: 'b', meta: { type: 'number' } }, - { id: 'c', name: 'c', meta: { type: 'string' } }, - { id: 'd', name: 'd', meta: { type: 'string' } }, - ], - rows: [ - { a: 1, b: 2, c: 'I', d: 'Row 1' }, - { a: 1, b: 5, c: 'J', d: 'Row 2' }, - ], - }, - }, + const dataWithoutFormats: Datatable = { + type: 'datatable', + columns: [ + { id: 'a', name: 'a', meta: { type: 'number' } }, + { id: 'b', name: 'b', meta: { type: 'number' } }, + { id: 'c', name: 'c', meta: { type: 'string' } }, + { id: 'd', name: 'd', meta: { type: 'string' } }, + ], + rows: [ + { a: 1, b: 2, c: 'I', d: 'Row 1' }, + { a: 1, b: 5, c: 'J', d: 'Row 2' }, + ], }; - const dataWithFormats: LensMultiTable = { - type: 'lens_multitable', - tables: { - first: { - type: 'datatable', - columns: [ - { id: 'a', name: 'a', meta: { type: 'number' } }, - { id: 'b', name: 'b', meta: { type: 'number' } }, - { id: 'c', name: 'c', meta: { type: 'string' } }, - { id: 'd', name: 'd', meta: { type: 'string', params: { id: 'custom' } } }, - ], - rows: [ - { a: 1, b: 2, c: 'I', d: 'Row 1' }, - { a: 1, b: 5, c: 'J', d: 'Row 2' }, - ], - }, - }, + + const dataWithFormats: Datatable = { + type: 'datatable', + columns: [ + { id: 'a', name: 'a', meta: { type: 'number' } }, + { id: 'b', name: 'b', meta: { type: 'number' } }, + { id: 'c', name: 'c', meta: { type: 'string' } }, + { id: 'd', name: 'd', meta: { type: 'string', params: { id: 'custom' } } }, + ], + rows: [ + { a: 1, b: 2, c: 'I', d: 'Row 1' }, + { a: 1, b: 5, c: 'J', d: 'Row 2' }, + ], }; - const getRenderedComponent = (data: LensMultiTable, args: XYArgs) => { - return shallow(); + const getRenderedComponent = (args: XYProps) => { + return shallow(); }; beforeEach(() => { @@ -119,34 +114,38 @@ describe('XYChart component', () => { onClickValue, onSelectRange, syncColors: false, + syncTooltips: false, useLegacyTimeAxis: false, eventAnnotationService: eventAnnotationServiceMock, }; }); test('it renders line', () => { - const { data, args } = sampleArgs(); + const { args } = sampleArgs(); const component = shallow( ); expect(component).toMatchSnapshot(); - expect(component.find(LineSeries)).toHaveLength(2); - expect(component.find(LineSeries).at(0).prop('yAccessors')).toEqual(['a']); - expect(component.find(LineSeries).at(1).prop('yAccessors')).toEqual(['b']); + + const lineSeries = component.find(DataLayers).dive().find(LineSeries); + expect(lineSeries).toHaveLength(2); + expect(lineSeries.at(0).prop('yAccessors')).toEqual(['a']); + expect(lineSeries.at(1).prop('yAccessors')).toEqual(['b']); }); describe('date range', () => { - const timeSampleLayer: DataLayerConfigResult = { + const { data, args } = sampleArgs(); + + const timeSampleLayer: DataLayerConfig = { + layerId: 'timeLayer', type: 'dataLayer', - layerId: 'first', layerType: LayerTypes.DATA, seriesType: 'line', xAccessor: 'c', @@ -157,56 +156,47 @@ describe('XYChart component', () => { yScaleType: 'linear', isHistogram: false, palette: mockPaletteOutput, + table: { + ...data, + columns: data.columns.map((c) => + c.id !== 'c' + ? c + : { + ...c, + meta: { + type: 'date', + source: 'esaggs', + sourceParams: { + type: 'date_histogram', + params: {}, + appliedTimeRange: { + from: '2019-01-02T05:00:00.000Z', + to: '2019-01-03T05:00:00.000Z', + }, + }, + }, + } + ), + }, }; + const multiLayerArgs = createArgsWithLayers([ timeSampleLayer, - { - ...timeSampleLayer, - layerId: 'second', - seriesType: 'bar', - xScaleType: 'time', - }, + { ...timeSampleLayer, seriesType: 'bar', xScaleType: 'time' }, ]); - test('it uses the full date range', () => { - const { data, args } = sampleArgs(); + test('it uses the full date range', () => { const component = shallow( - c.id !== 'c' - ? c - : { - ...c, - meta: { - type: 'date', - source: 'esaggs', - sourceParams: { - type: 'date_histogram', - params: {}, - appliedTimeRange: { - from: '2019-01-02T05:00:00.000Z', - to: '2019-01-03T05:00:00.000Z', - }, - }, - }, - } - ), - }, - }, - }} args={{ ...args, layers: [ { - ...(args.layers[0] as DataLayerConfigResult), + ...(args.layers[0] as DataLayerConfig), seriesType: 'line', xScaleType: 'time', + table: timeSampleLayer.table, }, ], }} @@ -223,15 +213,21 @@ describe('XYChart component', () => { }); test('it uses passed in minInterval', () => { - const data: LensMultiTable = { - type: 'lens_multitable', - tables: { - first: createSampleDatatableWithRows([{ a: 1, b: 2, c: 'I', d: 'Foo' }]), - second: createSampleDatatableWithRows([]), - }, - }; + const table1 = createSampleDatatableWithRows([{ a: 1, b: 2, c: 'I', d: 'Foo' }]); + const table2 = createSampleDatatableWithRows([]); - const component = shallow(); + const component = shallow( + + ); // real auto interval is 30mins = 1800000 expect(component.find(Settings).prop('xDomain')).toMatchInlineSnapshot(` @@ -244,9 +240,9 @@ describe('XYChart component', () => { }); describe('axis time', () => { - const defaultTimeLayer: DataLayerConfigResult = { + const defaultTimeLayer: DataLayerConfig = { + layerId: 'defaultTimeLayer', type: 'dataLayer', - layerId: 'first', layerType: LayerTypes.DATA, seriesType: 'line', xAccessor: 'c', @@ -257,21 +253,28 @@ describe('XYChart component', () => { yScaleType: 'linear', isHistogram: true, palette: mockPaletteOutput, + table: data, }; - test('it should disable the new time axis for a line time layer when isHistogram is set to false', () => { - const { data } = sampleArgs(); + const newData = { + ...data, + dateRange: { + fromDate: new Date('2019-01-02T05:00:00.000Z'), + toDate: new Date('2019-01-03T05:00:00.000Z'), + }, + }; + + test('it should disable the new time axis for a line time layer when isHistogram is set to false', () => { const instance = shallow( ({ + ...layer, + table: newData, + })), }} - args={multiLayerArgs} /> ); @@ -280,20 +283,18 @@ describe('XYChart component', () => { expect(axisStyle).toBe(0); }); test('it should enable the new time axis for a line time layer when isHistogram is set to true', () => { - const { data } = sampleArgs(); const timeLayerArgs = createArgsWithLayers([defaultTimeLayer]); const instance = shallow( ({ + ...layer, + table: newData, + })), }} - args={timeLayerArgs} /> ); @@ -302,8 +303,7 @@ describe('XYChart component', () => { expect(axisStyle).toBe(3); }); test('it should disable the new time axis for a vertical bar with break down dimension', () => { - const { data } = sampleArgs(); - const timeLayer: DataLayerConfigResult = { + const timeLayer: DataLayerConfig = { ...defaultTimeLayer, seriesType: 'bar', }; @@ -312,14 +312,13 @@ describe('XYChart component', () => { const instance = shallow( ({ + ...layer, + table: newData, + })), }} - args={timeLayerArgs} /> ); @@ -329,8 +328,7 @@ describe('XYChart component', () => { }); test('it should enable the new time axis for a stacked vertical bar with break down dimension', () => { - const { data } = sampleArgs(); - const timeLayer: DataLayerConfigResult = { + const timeLayer: DataLayerConfig = { ...defaultTimeLayer, seriesType: 'bar_stacked', }; @@ -339,14 +337,13 @@ describe('XYChart component', () => { const instance = shallow( ({ + ...layer, + table: newData, + })), }} - args={timeLayerArgs} /> ); @@ -356,65 +353,53 @@ describe('XYChart component', () => { }); }); describe('endzones', () => { - const { args } = sampleArgs(); const table = createSampleDatatableWithRows([ { a: 1, b: 2, c: new Date('2021-04-22').valueOf(), d: 'Foo' }, { a: 1, b: 2, c: new Date('2021-04-23').valueOf(), d: 'Foo' }, { a: 1, b: 2, c: new Date('2021-04-24').valueOf(), d: 'Foo' }, ]); - const data: LensMultiTable = { - type: 'lens_multitable', - tables: { - first: { - ...table, - columns: table.columns.map((c) => - c.id !== 'c' - ? c - : { - ...c, - meta: { - type: 'date', - source: 'esaggs', - sourceParams: { - type: 'date_histogram', - params: {}, - appliedTimeRange: { - from: '2021-04-22T12:00:00.000Z', - to: '2021-04-24T12:00:00.000Z', - }, - }, + const newData = { + ...table, + type: 'datatable', + + columns: table.columns.map((c) => + c.id !== 'c' + ? c + : { + ...c, + meta: { + type: 'date', + source: 'esaggs', + sourceParams: { + type: 'date_histogram', + params: {}, + appliedTimeRange: { + from: '2021-04-22T12:00:00.000Z', + to: '2021-04-24T12:00:00.000Z', }, - } - ), - }, - }, - dateRange: { - // first and last bucket are partial - fromDate: new Date('2021-04-22T12:00:00.000Z'), - toDate: new Date('2021-04-24T12:00:00.000Z'), - }, + }, + }, + } + ), }; - const timeArgs: XYArgs = { + const timeArgs: XYProps = { ...args, layers: [ { - ...(args.layers[0] as DataLayerConfigResult), + ...args.layers[0], + type: 'dataLayer', seriesType: 'line', xScaleType: 'time', isHistogram: true, splitAccessor: undefined, - }, + table: newData, + } as DataLayerConfig, ], }; test('it extends interval if data is exceeding it', () => { const component = shallow( - + ); expect(component.find(Settings).prop('xDomain')).toEqual({ @@ -426,14 +411,17 @@ describe('XYChart component', () => { }); }); + const defaultTimeArgs = { + ...timeArgs, + layers: timeArgs.layers.map((layer) => ({ + ...layer, + table: data, + })), + }; + test('it renders endzone component bridging gap between domain and extended domain', () => { const component = shallow( - + ); expect(component.find(XyEndzones).dive().find('Endzones').props()).toEqual( @@ -448,12 +436,7 @@ describe('XYChart component', () => { test('should pass enabled histogram mode and min interval to endzones component', () => { const component = shallow( - + ); expect(component.find(XyEndzones).dive().find('Endzones').props()).toEqual( @@ -469,12 +452,11 @@ describe('XYChart component', () => { { ); @@ -508,13 +489,12 @@ describe('XYChart component', () => { }); describe('y axis extents', () => { - test('it passes custom y axis extents to elastic-charts axis spec', () => { - const { data, args } = sampleArgs(); + const { args } = sampleArgs(); + test('it passes custom y axis extents to elastic-charts axis spec', () => { const component = shallow( { }); test('it passes fit to bounds y axis extents to elastic-charts axis spec', () => { - const { data, args } = sampleArgs(); - const component = shallow( { }); test('it does not allow fit for area chart', () => { - const { data, args } = sampleArgs(); - const component = shallow( { }, layers: [ { - ...(args.layers[0] as DataLayerConfigResult), + ...(args.layers[0] as DataLayerConfig), seriesType: 'area', }, ], @@ -589,12 +563,9 @@ describe('XYChart component', () => { }); test('it does not allow positive lower bound for bar', () => { - const { data, args } = sampleArgs(); - const component = shallow( { }, layers: [ { - ...(args.layers[0] as DataLayerConfigResult), + ...(args.layers[0] as DataLayerConfig), seriesType: 'bar', }, ], @@ -621,36 +592,29 @@ describe('XYChart component', () => { }); test('it does include referenceLine values when in full extent mode', () => { - const { data, args } = sampleArgsWithReferenceLine(); + const { args: refArgs } = sampleArgsWithReferenceLine(); - const component = shallow(); + const component = shallow(); expect(component.find(Axis).find('[id="left"]').prop('domain')).toEqual({ fit: false, min: NaN, max: NaN, - includeDataFromIds: ['referenceLine-referenceLine-a-rect'], + includeDataFromIds: ['referenceLine-a-referenceLine-a-rect'], }); }); }); test('it has xDomain undefined if the x is not a time scale or a histogram', () => { - const { data, args } = sampleArgs(); + const { args } = sampleArgs(); const component = shallow( { }); test('it uses min interval if interval is passed in and visualization is histogram', () => { - const { data, args } = sampleArgs(); + const { args } = sampleArgs(); const component = shallow( { }); test('disabled legend extra by default', () => { - const { data, args } = sampleArgs(); - const component = shallow(); + const { args } = sampleArgs(); + const component = shallow(); expect(component.find(Settings).at(0).prop('showLegendExtra')).toEqual(false); }); test('ignores legend extra for ordinal chart', () => { - const { data, args } = sampleArgs(); + const { args } = sampleArgs(); const component = shallow( - + ); expect(component.find(Settings).at(0).prop('showLegendExtra')).toEqual(false); }); @@ -709,7 +672,6 @@ describe('XYChart component', () => { const component = shallow( { }); test('it renders bar', () => { - const { data, args } = sampleArgs(); + const { args } = sampleArgs(); const component = shallow( ); expect(component).toMatchSnapshot(); - expect(component.find(BarSeries)).toHaveLength(2); - expect(component.find(BarSeries).at(0).prop('yAccessors')).toEqual(['a']); - expect(component.find(BarSeries).at(1).prop('yAccessors')).toEqual(['b']); + + const barSeries = component.find(DataLayers).dive().find(BarSeries); + expect(barSeries).toHaveLength(2); + expect(barSeries.at(0).prop('yAccessors')).toEqual(['a']); + expect(barSeries.at(1).prop('yAccessors')).toEqual(['b']); }); test('it renders area', () => { - const { data, args } = sampleArgs(); + const { args } = sampleArgs(); const component = shallow( ); expect(component).toMatchSnapshot(); - expect(component.find(AreaSeries)).toHaveLength(2); - expect(component.find(AreaSeries).at(0).prop('yAccessors')).toEqual(['a']); - expect(component.find(AreaSeries).at(1).prop('yAccessors')).toEqual(['b']); + + const areaSeries = component.find(DataLayers).dive().find(AreaSeries); + expect(areaSeries).toHaveLength(2); + expect(areaSeries.at(0).prop('yAccessors')).toEqual(['a']); + expect(areaSeries.at(1).prop('yAccessors')).toEqual(['b']); }); test('it renders horizontal bar', () => { - const { data, args } = sampleArgs(); + const { args } = sampleArgs(); const component = shallow( ); expect(component).toMatchSnapshot(); - expect(component.find(BarSeries)).toHaveLength(2); - expect(component.find(BarSeries).at(0).prop('yAccessors')).toEqual(['a']); - expect(component.find(BarSeries).at(1).prop('yAccessors')).toEqual(['b']); + + const barSeries = component.find(DataLayers).dive().find(BarSeries); + expect(barSeries).toHaveLength(2); + expect(barSeries.at(0).prop('yAccessors')).toEqual(['a']); + expect(barSeries.at(1).prop('yAccessors')).toEqual(['b']); expect(component.find(Settings).prop('rotation')).toEqual(90); }); test('it renders regular bar empty placeholder for no results', () => { const { data, args } = sampleArgs(); - - // send empty data to the chart - data.tables.first.rows = []; - - const component = shallow(); + const component = shallow( + ({ ...layer, table: { ...data, rows: [] } })), + }} + /> + ); expect(component.find(BarSeries)).toHaveLength(0); expect(component.find(EmptyPlaceholder).prop('icon')).toBeDefined(); @@ -793,7 +762,6 @@ describe('XYChart component', () => { const wrapper = mountWithIntl( { test('onBrushEnd returns correct context data for number histogram data', () => { const { args } = sampleArgs(); - const numberLayer: DataLayerConfigResult = { - type: 'dataLayer', + const numberHistogramData: Datatable = { + type: 'datatable', + rows: [ + { + xAccessorId: 5, + yAccessorId: 1, + }, + { + xAccessorId: 7, + yAccessorId: 1, + }, + { + xAccessorId: 8, + yAccessorId: 1, + }, + { + xAccessorId: 10, + yAccessorId: 1, + }, + ], + columns: [ + { + id: 'xAccessorId', + name: 'bytes', + meta: { type: 'number' }, + }, + { + id: 'yAccessorId', + name: 'Count of records', + meta: { type: 'number' }, + }, + ], + }; + + const numberLayer: DataLayerConfig = { layerId: 'numberLayer', + type: 'dataLayer', layerType: LayerTypes.DATA, hide: false, xAccessor: 'xAccessorId', @@ -824,55 +826,12 @@ describe('XYChart component', () => { seriesType: 'bar_stacked', accessors: ['yAccessorId'], palette: mockPaletteOutput, - }; - - const numberHistogramData: LensMultiTable = { - type: 'lens_multitable', - tables: { - numberLayer: { - type: 'datatable', - rows: [ - { - xAccessorId: 5, - yAccessorId: 1, - }, - { - xAccessorId: 7, - yAccessorId: 1, - }, - { - xAccessorId: 8, - yAccessorId: 1, - }, - { - xAccessorId: 10, - yAccessorId: 1, - }, - ], - columns: [ - { - id: 'xAccessorId', - name: 'bytes', - meta: { type: 'number' }, - }, - { - id: 'yAccessorId', - name: 'Count of records', - meta: { type: 'number' }, - }, - ], - }, - }, - dateRange: { - fromDate: new Date('2020-04-01T16:14:16.246Z'), - toDate: new Date('2020-04-01T17:15:41.263Z'), - }, + table: numberHistogramData, }; const wrapper = mountWithIntl( { expect(onSelectRange).toHaveBeenCalledWith({ column: 0, - table: numberHistogramData.tables.numberLayer, + table: numberHistogramData, range: [5, 8], }); }); test('onBrushEnd is not set on non-interactive mode', () => { - const { args, data } = sampleArgs(); + const { args } = sampleArgs(); - const wrapper = mountWithIntl( - - ); + const wrapper = mountWithIntl(); expect(wrapper.find(Settings).first().prop('onBrushEnd')).toBeUndefined(); }); @@ -905,7 +862,6 @@ describe('XYChart component', () => { const wrapper = mountWithIntl( { const wrapper = mountWithIntl( { accessors: ['d'], columnToLabel: '{"a": "Label A", "b": "Label B", "d": "Label D"}', palette: mockPaletteOutput, + table: data, }, ], }} @@ -962,13 +918,13 @@ describe('XYChart component', () => { { column: 1, row: 1, - table: data.tables.first, + table: data, value: 5, }, { column: 1, row: 0, - table: data.tables.first, + table: data, value: 2, }, ], @@ -996,7 +952,6 @@ describe('XYChart component', () => { const wrapper = mountWithIntl( { test('onElementClick returns correct context data for numeric histogram', () => { const { args } = sampleArgs(); - const numberLayer: DataLayerConfigResult = { - type: 'dataLayer', + const numberHistogramData: Datatable = { + type: 'datatable', + rows: [ + { + xAccessorId: 5, + yAccessorId: 1, + }, + { + xAccessorId: 7, + yAccessorId: 1, + }, + { + xAccessorId: 8, + yAccessorId: 1, + }, + { + xAccessorId: 10, + yAccessorId: 1, + }, + ], + columns: [ + { + id: 'xAccessorId', + name: 'bytes', + meta: { type: 'number' }, + }, + { + id: 'yAccessorId', + name: 'Count of records', + meta: { type: 'number' }, + }, + ], + }; + + const numberLayer: DataLayerConfig = { layerId: 'numberLayer', + type: 'dataLayer', layerType: LayerTypes.DATA, hide: false, xAccessor: 'xAccessorId', @@ -1035,50 +1024,9 @@ describe('XYChart component', () => { seriesType: 'bar_stacked', accessors: ['yAccessorId'], palette: mockPaletteOutput, + table: numberHistogramData, }; - const numberHistogramData: LensMultiTable = { - type: 'lens_multitable', - tables: { - numberLayer: { - type: 'datatable', - rows: [ - { - xAccessorId: 5, - yAccessorId: 1, - }, - { - xAccessorId: 7, - yAccessorId: 1, - }, - { - xAccessorId: 8, - yAccessorId: 1, - }, - { - xAccessorId: 10, - yAccessorId: 1, - }, - ], - columns: [ - { - id: 'xAccessorId', - name: 'bytes', - meta: { type: 'number' }, - }, - { - id: 'yAccessorId', - name: 'Count of records', - meta: { type: 'number' }, - }, - ], - }, - }, - dateRange: { - fromDate: new Date('2020-04-01T16:14:16.246Z'), - toDate: new Date('2020-04-01T17:15:41.263Z'), - }, - }; const geometry: GeometryValue = { x: 5, y: 1, @@ -1097,7 +1045,6 @@ describe('XYChart component', () => { const wrapper = mountWithIntl( { { column: 0, row: 0, - table: numberHistogramData.tables.numberLayer, + table: numberHistogramData, value: 5, }, ], @@ -1139,13 +1086,12 @@ describe('XYChart component', () => { const wrapper = mountWithIntl( { yScaleType: 'linear', isHistogram: false, palette: mockPaletteOutput, + table: data, }, ], }} @@ -1170,7 +1117,7 @@ describe('XYChart component', () => { { column: 3, row: 1, - table: data.tables.first, + table: data, value: 'Bar', }, ], @@ -1179,21 +1126,31 @@ describe('XYChart component', () => { test('sets up correct yScaleType equal to binary_linear for bytes formatting', () => { const { args, data } = sampleArgs(); - data.tables.first.columns[0].meta = { - type: 'number', - params: { id: 'bytes', params: { pattern: '0,0.00b' } }, + + const [firstCol, ...rest] = data.columns; + const newData: Datatable = { + ...data, + columns: [ + { + ...firstCol, + meta: { + type: 'number', + params: { id: 'bytes', params: { pattern: '0,0.00b' } }, + }, + }, + ...rest, + ], }; const wrapper = mountWithIntl( { yScaleType: 'linear', isHistogram: false, palette: mockPaletteOutput, + table: newData, }, ], }} @@ -1218,13 +1176,12 @@ describe('XYChart component', () => { const wrapper = mountWithIntl( { yScaleType: 'linear', isHistogram: false, palette: mockPaletteOutput, + table: data, }, ], }} @@ -1244,94 +1202,92 @@ describe('XYChart component', () => { }); test('onElementClick is not triggering event on non-interactive mode', () => { - const { args, data } = sampleArgs(); + const { args } = sampleArgs(); - const wrapper = mountWithIntl( - - ); + const wrapper = mountWithIntl(); expect(wrapper.find(Settings).first().prop('onElementClick')).toBeUndefined(); }); test('legendAction is not triggering event on non-interactive mode', () => { - const { args, data } = sampleArgs(); + const { args } = sampleArgs(); - const wrapper = mountWithIntl( - - ); + const wrapper = mountWithIntl(); expect(wrapper.find(Settings).first().prop('legendAction')).toBeUndefined(); }); test('it renders stacked bar', () => { - const { data, args } = sampleArgs(); + const { args } = sampleArgs(); const component = shallow( ); expect(component).toMatchSnapshot(); - expect(component.find(BarSeries)).toHaveLength(2); - expect(component.find(BarSeries).at(0).prop('stackAccessors')).toHaveLength(1); - expect(component.find(BarSeries).at(1).prop('stackAccessors')).toHaveLength(1); + + const barSeries = component.find(DataLayers).dive().find(BarSeries); + expect(barSeries).toHaveLength(2); + expect(barSeries.at(0).prop('stackAccessors')).toHaveLength(1); + expect(barSeries.at(1).prop('stackAccessors')).toHaveLength(1); }); test('it renders stacked area', () => { - const { data, args } = sampleArgs(); + const { args } = sampleArgs(); const component = shallow( ); expect(component).toMatchSnapshot(); - expect(component.find(AreaSeries)).toHaveLength(2); - expect(component.find(AreaSeries).at(0).prop('stackAccessors')).toHaveLength(1); - expect(component.find(AreaSeries).at(1).prop('stackAccessors')).toHaveLength(1); + + const areaSeries = component.find(DataLayers).dive().find(AreaSeries); + expect(areaSeries).toHaveLength(2); + expect(areaSeries.at(0).prop('stackAccessors')).toHaveLength(1); + expect(areaSeries.at(1).prop('stackAccessors')).toHaveLength(1); }); test('it renders stacked horizontal bar', () => { - const { data, args } = sampleArgs(); + const { args } = sampleArgs(); const component = shallow( ); expect(component).toMatchSnapshot(); - expect(component.find(BarSeries)).toHaveLength(2); - expect(component.find(BarSeries).at(0).prop('stackAccessors')).toHaveLength(1); - expect(component.find(BarSeries).at(1).prop('stackAccessors')).toHaveLength(1); + + const barSeries = component.find(DataLayers).dive().find(BarSeries); + expect(barSeries).toHaveLength(2); + expect(barSeries.at(0).prop('stackAccessors')).toHaveLength(1); + expect(barSeries.at(1).prop('stackAccessors')).toHaveLength(1); expect(component.find(Settings).prop('rotation')).toEqual(90); }); test('it renders stacked bar empty placeholder for no results', () => { - const { data, args } = sampleArgs(); + const { args } = sampleArgs(); const component = shallow( { /> ); - expect(component.find(BarSeries)).toHaveLength(0); + expect(component.find(DataLayers)).toHaveLength(0); expect(component.find(EmptyPlaceholder).prop('icon')).toBeDefined(); }); test('it passes time zone to the series', () => { - const { data, args } = sampleArgs(); - const component = shallow( - - ); - expect(component.find(LineSeries).at(0).prop('timeZone')).toEqual('CEST'); - expect(component.find(LineSeries).at(1).prop('timeZone')).toEqual('CEST'); + const { args } = sampleArgs(); + const component = shallow(); + + const lineSeries = component.find(DataLayers).dive().find(LineSeries); + expect(lineSeries.at(0).prop('timeZone')).toEqual('CEST'); + expect(lineSeries.at(1).prop('timeZone')).toEqual('CEST'); }); test('it applies histogram mode to the series for single series', () => { - const { data, args } = sampleArgs(); - const firstLayer: DataLayerConfigResult = { + const { args } = sampleArgs(); + const firstLayer: DataLayerConfig = { ...args.layers[0], accessors: ['b'], seriesType: 'bar', isHistogram: true, - } as DataLayerConfigResult; + } as DataLayerConfig; delete firstLayer.splitAccessor; const component = shallow( - + ); - expect(component.find(BarSeries).at(0).prop('enableHistogramMode')).toEqual(true); + expect( + component.find(DataLayers).dive().find(BarSeries).at(0).prop('enableHistogramMode') + ).toEqual(true); }); test('it does not apply histogram mode to more than one bar series for unstacked bar chart', () => { - const { data, args } = sampleArgs(); - const firstLayer: DataLayerConfigResult = { + const { args } = sampleArgs(); + const firstLayer: DataLayerConfig = { ...args.layers[0], seriesType: 'bar', isHistogram: true, - } as DataLayerConfigResult; + } as DataLayerConfig; delete firstLayer.splitAccessor; const component = shallow( - + ); - expect(component.find(BarSeries).at(0).prop('enableHistogramMode')).toEqual(false); - expect(component.find(BarSeries).at(1).prop('enableHistogramMode')).toEqual(false); + + const barSeries = component.find(DataLayers).dive().find(BarSeries); + expect(barSeries.at(0).prop('enableHistogramMode')).toEqual(false); + expect(barSeries.at(1).prop('enableHistogramMode')).toEqual(false); }); test('it applies histogram mode to more than one the series for unstacked line/area chart', () => { - const { data, args } = sampleArgs(); - const firstLayer: DataLayerConfigResult = { + const { args } = sampleArgs(); + const firstLayer: DataLayerConfig = { ...args.layers[0], seriesType: 'line', isHistogram: true, - } as DataLayerConfigResult; + } as DataLayerConfig; delete firstLayer.splitAccessor; - const secondLayer: DataLayerConfigResult = { + const secondLayer: DataLayerConfig = { ...args.layers[0], seriesType: 'line', isHistogram: true, - } as DataLayerConfigResult; + } as DataLayerConfig; delete secondLayer.splitAccessor; const component = shallow( - + ); - expect(component.find(LineSeries).at(0).prop('enableHistogramMode')).toEqual(true); - expect(component.find(LineSeries).at(1).prop('enableHistogramMode')).toEqual(true); + + const lineSeries = component.find(DataLayers).dive().find(LineSeries); + expect(lineSeries.at(0).prop('enableHistogramMode')).toEqual(true); + expect(lineSeries.at(1).prop('enableHistogramMode')).toEqual(true); }); test('it applies histogram mode to the series for stacked series', () => { - const { data, args } = sampleArgs(); + const { args } = sampleArgs(); const component = shallow( { }} /> ); - expect(component.find(BarSeries).at(0).prop('enableHistogramMode')).toEqual(true); - expect(component.find(BarSeries).at(1).prop('enableHistogramMode')).toEqual(true); + + const barSeries = component.find(DataLayers).dive().find(BarSeries); + expect(barSeries.at(0).prop('enableHistogramMode')).toEqual(true); + expect(barSeries.at(1).prop('enableHistogramMode')).toEqual(true); }); test('it does not apply histogram mode for splitted series', () => { - const { data, args } = sampleArgs(); + const { args } = sampleArgs(); const component = shallow( ); - expect(component.find(BarSeries).at(0).prop('enableHistogramMode')).toEqual(false); - expect(component.find(BarSeries).at(1).prop('enableHistogramMode')).toEqual(false); + + const barSeries = component.find(DataLayers).dive().find(BarSeries); + expect(barSeries.at(0).prop('enableHistogramMode')).toEqual(false); + expect(barSeries.at(1).prop('enableHistogramMode')).toEqual(false); }); describe('y axes', () => { - test('single axis if possible', () => { - const args = createArgsWithLayers(); + const args = createArgsWithLayers(); + const layer = args.layers[0] as DataLayerConfig; - const component = getRenderedComponent(dataWithoutFormats, args); + test('single axis if possible', () => { + const newArgs = { + ...args, + layers: args.layers.map((l) => ({ + ...layer, + table: dataWithoutFormats, + })), + }; + const component = getRenderedComponent(newArgs); const axes = component.find(Axis); expect(axes).toHaveLength(2); }); test('multiple axes because of config', () => { - const args = createArgsWithLayers(); - const newArgs = { + const newArgs: XYProps = { ...args, layers: [ { - ...args.layers[0], + ...layer, accessors: ['a', 'b'], yConfig: [ { + type: 'yConfig', forAccessor: 'a', axisMode: 'left', }, { + type: 'yConfig', forAccessor: 'b', axisMode: 'right', }, ], + table: dataWithoutFormats, }, ], - } as XYArgs; + }; - const component = getRenderedComponent(dataWithoutFormats, newArgs); + const component = getRenderedComponent(newArgs); const axes = component.find(Axis); expect(axes).toHaveLength(3); - expect(component.find(LineSeries).at(0).prop('groupId')).toEqual(axes.at(1).prop('groupId')); - expect(component.find(LineSeries).at(1).prop('groupId')).toEqual(axes.at(2).prop('groupId')); + + const lineSeries = component.find(DataLayers).dive().find(LineSeries); + expect(lineSeries.at(0).prop('groupId')).toEqual(axes.at(1).prop('groupId')); + expect(lineSeries.at(1).prop('groupId')).toEqual(axes.at(2).prop('groupId')); }); test('multiple axes because of incompatible formatters', () => { - const args = createArgsWithLayers(); - const newArgs = { + const newArgs: XYProps = { ...args, layers: [ { - ...args.layers[0], + ...layer, accessors: ['c', 'd'], + table: dataWithFormats, }, ], - } as XYArgs; + }; - const component = getRenderedComponent(dataWithFormats, newArgs); + const component = getRenderedComponent(newArgs); const axes = component.find(Axis); expect(axes).toHaveLength(3); - expect(component.find(LineSeries).at(0).prop('groupId')).toEqual(axes.at(1).prop('groupId')); - expect(component.find(LineSeries).at(1).prop('groupId')).toEqual(axes.at(2).prop('groupId')); + + const lineSeries = component.find(DataLayers).dive().find(LineSeries); + expect(lineSeries.at(0).prop('groupId')).toEqual(axes.at(1).prop('groupId')); + expect(lineSeries.at(1).prop('groupId')).toEqual(axes.at(2).prop('groupId')); }); test('single axis despite different formatters if enforced', () => { - const args = createArgsWithLayers(); - const newArgs = { + const newArgs: XYProps = { ...args, layers: [ { - ...args.layers[0], + ...layer, accessors: ['c', 'd'], yConfig: [ { + type: 'yConfig', forAccessor: 'c', axisMode: 'left', }, { + type: 'yConfig', forAccessor: 'd', axisMode: 'left', }, ], + table: dataWithoutFormats, }, ], - } as XYArgs; + }; - const component = getRenderedComponent(dataWithoutFormats, newArgs); + const component = getRenderedComponent(newArgs); const axes = component.find(Axis); expect(axes).toHaveLength(2); }); }); describe('y series coloring', () => { + const args = createArgsWithLayers(); + const layer = args.layers[0] as DataLayerConfig; + test('color is applied to chart for multiple series', () => { - const args = createArgsWithLayers(); - const newArgs = { + const newArgs: XYProps = { ...args, layers: [ { - ...args.layers[0], - splitAccessor: undefined, + ...layer, + type: 'extendedDataLayer', accessors: ['a', 'b'], + splitAccessor: undefined, yConfig: [ { + type: 'yConfig', forAccessor: 'a', color: '#550000', }, { + type: 'yConfig', forAccessor: 'b', color: '#FFFF00', }, ], - }, + table: dataWithoutFormats, + } as ExtendedDataLayerConfig, { - ...args.layers[0], - splitAccessor: undefined, + ...layer, + type: 'extendedDataLayer', accessors: ['c'], + splitAccessor: undefined, yConfig: [ { + type: 'yConfig', forAccessor: 'c', color: '#FEECDF', }, ], - }, + table: dataWithoutFormats, + } as ExtendedDataLayerConfig, ], - } as XYArgs; + }; - const component = getRenderedComponent(dataWithoutFormats, newArgs); + const component = getRenderedComponent(newArgs); + const lineSeries = component.find(DataLayers).dive().find(LineSeries); expect( - (component.find(LineSeries).at(0).prop('color') as Function)!({ + (lineSeries.at(0).prop('color') as Function)!({ yAccessor: 'a', seriesKeys: ['a'], }) ).toEqual('#550000'); expect( - (component.find(LineSeries).at(1).prop('color') as Function)!({ + (lineSeries.at(1).prop('color') as Function)!({ yAccessor: 'b', seriesKeys: ['b'], }) ).toEqual('#FFFF00'); expect( - (component.find(LineSeries).at(2).prop('color') as Function)!({ + (lineSeries.at(2).prop('color') as Function)!({ yAccessor: 'c', seriesKeys: ['c'], }) ).toEqual('#FEECDF'); }); test('color is not applied to chart when splitAccessor is defined or when yConfig is not configured', () => { - const args = createArgsWithLayers(); - const newArgs = { + const newArgs: XYProps = { ...args, layers: [ { - ...args.layers[0], + ...layer, accessors: ['a'], yConfig: [ { + type: 'yConfig', forAccessor: 'a', color: '#550000', }, ], + table: dataWithoutFormats, }, { - ...args.layers[0], - splitAccessor: undefined, + ...layer, accessors: ['c'], + table: dataWithoutFormats, }, ], - } as XYArgs; + }; + + const component = getRenderedComponent(newArgs); - const component = getRenderedComponent(dataWithoutFormats, newArgs); + const lineSeries = component.find(DataLayers).dive().find(LineSeries); expect( - (component.find(LineSeries).at(0).prop('color') as Function)!({ + (lineSeries.at(0).prop('color') as Function)!({ yAccessor: 'a', seriesKeys: ['a'], }) ).toEqual('blue'); expect( - (component.find(LineSeries).at(1).prop('color') as Function)!({ + (lineSeries.at(1).prop('color') as Function)!({ yAccessor: 'c', seriesKeys: ['c'], }) @@ -1647,16 +1636,21 @@ describe('XYChart component', () => { accessors: ['a'], splitAccessor: undefined, columnToLabel: '', + table: dataWithoutFormats, }, ], }; - const component = getRenderedComponent(dataWithoutFormats, newArgs); - const nameFn = component.find(LineSeries).prop('name') as SeriesNameFn; + const component = getRenderedComponent(newArgs); + const nameFn = component + .find(DataLayers) + .dive() + .find(LineSeries) + .prop('name') as SeriesNameFn; // In this case, the ID is used as the name. This shouldn't happen in practice - expect(nameFn({ ...nameFnArgs, seriesKeys: ['a'] }, false)).toEqual(''); - expect(nameFn({ ...nameFnArgs, seriesKeys: ['nonsense'] }, false)).toEqual(''); + expect(nameFn({ ...nameFnArgs, seriesKeys: ['a'] }, false)).toEqual(null); + expect(nameFn({ ...nameFnArgs, seriesKeys: ['nonsense'] }, false)).toEqual(null); }); test('simplest xy chart with empty name', () => { @@ -1669,16 +1663,21 @@ describe('XYChart component', () => { accessors: ['a'], splitAccessor: undefined, columnToLabel: '{"a":""}', + table: dataWithoutFormats, }, ], }; - const component = getRenderedComponent(dataWithoutFormats, newArgs); - const nameFn = component.find(LineSeries).prop('name') as SeriesNameFn; + const component = getRenderedComponent(newArgs); + const nameFn = component + .find(DataLayers) + .dive() + .find(LineSeries) + .prop('name') as SeriesNameFn; // In this case, the ID is used as the name. This shouldn't happen in practice expect(nameFn({ ...nameFnArgs, seriesKeys: ['a'] }, false)).toEqual(''); - expect(nameFn({ ...nameFnArgs, seriesKeys: ['nonsense'] }, false)).toEqual(''); + expect(nameFn({ ...nameFnArgs, seriesKeys: ['nonsense'] }, false)).toEqual(null); }); test('simplest xy chart with human-readable name', () => { @@ -1691,12 +1690,17 @@ describe('XYChart component', () => { accessors: ['a'], splitAccessor: undefined, columnToLabel: '{"a":"Column A"}', + table: dataWithoutFormats, }, ], }; - const component = getRenderedComponent(dataWithoutFormats, newArgs); - const nameFn = component.find(LineSeries).prop('name') as SeriesNameFn; + const component = getRenderedComponent(newArgs); + const nameFn = component + .find(DataLayers) + .dive() + .find(LineSeries) + .prop('name') as SeriesNameFn; expect(nameFn({ ...nameFnArgs, seriesKeys: ['a'] }, false)).toEqual('Column A'); }); @@ -1711,19 +1715,22 @@ describe('XYChart component', () => { accessors: ['a', 'b'], splitAccessor: undefined, columnToLabel: '{"a": "Label A"}', + table: dataWithoutFormats, }, ], }; - const component = getRenderedComponent(dataWithoutFormats, newArgs); - const nameFn1 = component.find(LineSeries).at(0).prop('name') as SeriesNameFn; - const nameFn2 = component.find(LineSeries).at(1).prop('name') as SeriesNameFn; + const component = getRenderedComponent(newArgs); + + const lineSeries = component.find(DataLayers).dive().find(LineSeries); + const nameFn1 = lineSeries.at(0).prop('name') as SeriesNameFn; + const nameFn2 = lineSeries.at(1).prop('name') as SeriesNameFn; // This accessor has a human-readable name expect(nameFn1({ ...nameFnArgs, seriesKeys: ['a'] }, false)).toEqual('Label A'); // This accessor does not - expect(nameFn2({ ...nameFnArgs, seriesKeys: ['b'] }, false)).toEqual(''); - expect(nameFn1({ ...nameFnArgs, seriesKeys: ['nonsense'] }, false)).toEqual(''); + expect(nameFn2({ ...nameFnArgs, seriesKeys: ['b'] }, false)).toEqual(null); + expect(nameFn1({ ...nameFnArgs, seriesKeys: ['nonsense'] }, false)).toEqual(null); }); test('split series without formatting and single y accessor', () => { @@ -1736,12 +1743,17 @@ describe('XYChart component', () => { accessors: ['a'], splitAccessor: 'd', columnToLabel: '{"a": "Label A"}', + table: dataWithoutFormats, }, ], }; - const component = getRenderedComponent(dataWithoutFormats, newArgs); - const nameFn = component.find(LineSeries).prop('name') as SeriesNameFn; + const component = getRenderedComponent(newArgs); + const nameFn = component + .find(DataLayers) + .dive() + .find(LineSeries) + .prop('name') as SeriesNameFn; expect(nameFn({ ...nameFnArgs, seriesKeys: ['split1', 'a'] }, false)).toEqual('split1'); }); @@ -1756,12 +1768,17 @@ describe('XYChart component', () => { accessors: ['a'], splitAccessor: 'd', columnToLabel: '{"a": "Label A"}', + table: dataWithFormats, }, ], }; - const component = getRenderedComponent(dataWithFormats, newArgs); - const nameFn = component.find(LineSeries).prop('name') as SeriesNameFn; + const component = getRenderedComponent(newArgs); + const nameFn = component + .find(DataLayers) + .dive() + .find(LineSeries) + .prop('name') as SeriesNameFn; convertSpy.mockReturnValueOnce('formatted'); expect(nameFn({ ...nameFnArgs, seriesKeys: ['split1', 'a'] }, false)).toEqual('formatted'); @@ -1778,13 +1795,16 @@ describe('XYChart component', () => { accessors: ['a', 'b'], splitAccessor: 'd', columnToLabel: '{"a": "Label A","b": "Label B"}', + table: dataWithoutFormats, }, ], }; - const component = getRenderedComponent(dataWithoutFormats, newArgs); - const nameFn1 = component.find(LineSeries).at(0).prop('name') as SeriesNameFn; - const nameFn2 = component.find(LineSeries).at(0).prop('name') as SeriesNameFn; + const component = getRenderedComponent(newArgs); + + const lineSeries = component.find(DataLayers).dive().find(LineSeries); + const nameFn1 = lineSeries.at(0).prop('name') as SeriesNameFn; + const nameFn2 = lineSeries.at(0).prop('name') as SeriesNameFn; expect(nameFn1({ ...nameFnArgs, seriesKeys: ['split1', 'a'] }, false)).toEqual( 'split1 - Label A' @@ -1804,13 +1824,16 @@ describe('XYChart component', () => { accessors: ['a', 'b'], splitAccessor: 'd', columnToLabel: '{"a": "Label A","b": "Label B"}', + table: dataWithFormats, }, ], }; - const component = getRenderedComponent(dataWithFormats, newArgs); - const nameFn1 = component.find(LineSeries).at(0).prop('name') as SeriesNameFn; - const nameFn2 = component.find(LineSeries).at(1).prop('name') as SeriesNameFn; + const component = getRenderedComponent(newArgs); + + const lineSeries = component.find(DataLayers).dive().find(LineSeries); + const nameFn1 = lineSeries.at(0).prop('name') as SeriesNameFn; + const nameFn2 = lineSeries.at(1).prop('name') as SeriesNameFn; convertSpy.mockReturnValueOnce('formatted1').mockReturnValueOnce('formatted2'); expect(nameFn1({ ...nameFnArgs, seriesKeys: ['split1', 'a'] }, false)).toEqual( @@ -1823,57 +1846,58 @@ describe('XYChart component', () => { }); test('it set the scale of the x axis according to the args prop', () => { - const { data, args } = sampleArgs(); + const { args } = sampleArgs(); const component = shallow( ); - expect(component.find(LineSeries).at(0).prop('xScaleType')).toEqual(ScaleType.Ordinal); - expect(component.find(LineSeries).at(1).prop('xScaleType')).toEqual(ScaleType.Ordinal); + + const lineSeries = component.find(DataLayers).dive().find(LineSeries); + expect(lineSeries.at(0).prop('xScaleType')).toEqual(ScaleType.Ordinal); + expect(lineSeries.at(1).prop('xScaleType')).toEqual(ScaleType.Ordinal); }); test('it set the scale of the y axis according to the args prop', () => { - const { data, args } = sampleArgs(); + const { args } = sampleArgs(); const component = shallow( ); - expect(component.find(LineSeries).at(0).prop('yScaleType')).toEqual(ScaleType.Sqrt); - expect(component.find(LineSeries).at(1).prop('yScaleType')).toEqual(ScaleType.Sqrt); + + const lineSeries = component.find(DataLayers).dive().find(LineSeries); + expect(lineSeries.at(0).prop('yScaleType')).toEqual(ScaleType.Sqrt); + expect(lineSeries.at(1).prop('yScaleType')).toEqual(ScaleType.Sqrt); }); test('it gets the formatter for the x axis', () => { - const { data, args } = sampleArgs(); + const { args } = sampleArgs(); - shallow(); + shallow(); expect(getFormatSpy).toHaveBeenCalledWith({ id: 'string' }); }); test('it gets the formatter for the y axis if there is only one accessor', () => { - const { data, args } = sampleArgs(); + const { args } = sampleArgs(); shallow( ); @@ -1884,9 +1908,9 @@ describe('XYChart component', () => { }); test('it should pass the formatter function to the axis', () => { - const { data, args } = sampleArgs(); + const { args } = sampleArgs(); - const instance = shallow(); + const instance = shallow(); const tickFormatter = instance.find(Axis).first().prop('tickFormat'); @@ -1900,7 +1924,7 @@ describe('XYChart component', () => { }); test('it should set the tickLabel visibility on the x axis if the tick labels is hidden', () => { - const { data, args } = sampleArgs(); + const { args } = sampleArgs(); args.tickLabelsVisibilitySettings = { x: false, @@ -1909,7 +1933,7 @@ describe('XYChart component', () => { type: 'tickLabelsConfig', }; - const instance = shallow(); + const instance = shallow(); const axisStyle = instance.find(Axis).first().prop('style'); @@ -1921,7 +1945,7 @@ describe('XYChart component', () => { }); test('it should set the tickLabel visibility on the y axis if the tick labels is hidden', () => { - const { data, args } = sampleArgs(); + const { args } = sampleArgs(); args.tickLabelsVisibilitySettings = { x: true, @@ -1930,7 +1954,7 @@ describe('XYChart component', () => { type: 'tickLabelsConfig', }; - const instance = shallow(); + const instance = shallow(); const axisStyle = instance.find(Axis).at(1).prop('style'); @@ -1942,7 +1966,7 @@ describe('XYChart component', () => { }); test('it should set the tickLabel visibility on the x axis if the tick labels is shown', () => { - const { data, args } = sampleArgs(); + const { args } = sampleArgs(); args.tickLabelsVisibilitySettings = { x: true, @@ -1951,7 +1975,7 @@ describe('XYChart component', () => { type: 'tickLabelsConfig', }; - const instance = shallow(); + const instance = shallow(); const axisStyle = instance.find(Axis).first().prop('style'); @@ -1963,7 +1987,7 @@ describe('XYChart component', () => { }); test('it should set the tickLabel orientation on the x axis', () => { - const { data, args } = sampleArgs(); + const { args } = sampleArgs(); args.labelsOrientation = { x: -45, @@ -1972,7 +1996,7 @@ describe('XYChart component', () => { type: 'labelsOrientationConfig', }; - const instance = shallow(); + const instance = shallow(); const axisStyle = instance.find(Axis).first().prop('style'); @@ -1984,7 +2008,7 @@ describe('XYChart component', () => { }); test('it should set the tickLabel visibility on the y axis if the tick labels is shown', () => { - const { data, args } = sampleArgs(); + const { args } = sampleArgs(); args.tickLabelsVisibilitySettings = { x: false, @@ -1993,7 +2017,7 @@ describe('XYChart component', () => { type: 'tickLabelsConfig', }; - const instance = shallow(); + const instance = shallow(); const axisStyle = instance.find(Axis).at(1).prop('style'); @@ -2005,7 +2029,7 @@ describe('XYChart component', () => { }); test('it should set the tickLabel orientation on the y axis', () => { - const { data, args } = sampleArgs(); + const { args } = sampleArgs(); args.labelsOrientation = { x: -45, @@ -2014,7 +2038,7 @@ describe('XYChart component', () => { type: 'labelsOrientationConfig', }; - const instance = shallow(); + const instance = shallow(); const axisStyle = instance.find(Axis).at(1).prop('style'); @@ -2026,37 +2050,33 @@ describe('XYChart component', () => { }); test('it should remove invalid rows', () => { - const data: LensMultiTable = { - type: 'lens_multitable', - tables: { - first: { - type: 'datatable', - columns: [ - { id: 'a', name: 'a', meta: { type: 'number' } }, - { id: 'b', name: 'b', meta: { type: 'number' } }, - { id: 'c', name: 'c', meta: { type: 'string' } }, - ], - rows: [ - { a: undefined, b: 2, c: 'I', d: 'Row 1' }, - { a: 1, b: 5, c: 'J', d: 'Row 2' }, - ], - }, - second: { - type: 'datatable', - columns: [ - { id: 'a', name: 'a', meta: { type: 'number' } }, - { id: 'b', name: 'b', meta: { type: 'number' } }, - { id: 'c', name: 'c', meta: { type: 'string' } }, - ], - rows: [ - { a: undefined, b: undefined, c: undefined }, - { a: undefined, b: undefined, c: undefined }, - ], - }, - }, + const data1: Datatable = { + type: 'datatable', + columns: [ + { id: 'a', name: 'a', meta: { type: 'number' } }, + { id: 'b', name: 'b', meta: { type: 'number' } }, + { id: 'c', name: 'c', meta: { type: 'string' } }, + ], + rows: [ + { a: undefined, b: 2, c: 'I', d: 'Row 1' }, + { a: 1, b: 5, c: 'J', d: 'Row 2' }, + ], }; - const args: XYArgs = { + const data2: Datatable = { + type: 'datatable', + columns: [ + { id: 'a', name: 'a', meta: { type: 'number' } }, + { id: 'b', name: 'b', meta: { type: 'number' } }, + { id: 'c', name: 'c', meta: { type: 'string' } }, + ], + rows: [ + { a: undefined, b: undefined, c: undefined }, + { a: undefined, b: undefined, c: undefined }, + ], + }; + + const args: XYProps = { xTitle: '', yTitle: '', yRightTitle: '', @@ -2090,8 +2110,8 @@ describe('XYChart component', () => { }, layers: [ { - type: 'dataLayer', layerId: 'first', + type: 'dataLayer', layerType: LayerTypes.DATA, seriesType: 'line', xAccessor: 'a', @@ -2102,10 +2122,11 @@ describe('XYChart component', () => { yScaleType: 'linear', isHistogram: false, palette: mockPaletteOutput, + table: data1, }, { - type: 'dataLayer', layerId: 'second', + type: 'dataLayer', layerType: LayerTypes.DATA, seriesType: 'line', xAccessor: 'a', @@ -2116,13 +2137,14 @@ describe('XYChart component', () => { yScaleType: 'linear', isHistogram: false, palette: mockPaletteOutput, + table: data2, }, ], }; - const component = shallow(); + const component = shallow(); - const series = component.find(LineSeries); + const series = component.find(DataLayers).dive().find(LineSeries); // Only one series should be rendered, even though 2 are configured // This one series should only have one row, even though 2 are sent @@ -2130,25 +2152,20 @@ describe('XYChart component', () => { }); test('it should not remove rows with falsy but non-undefined values', () => { - const data: LensMultiTable = { - type: 'lens_multitable', - tables: { - first: { - type: 'datatable', - columns: [ - { id: 'a', name: 'a', meta: { type: 'number' } }, - { id: 'b', name: 'b', meta: { type: 'number' } }, - { id: 'c', name: 'c', meta: { type: 'number' } }, - ], - rows: [ - { a: 0, b: 2, c: 5 }, - { a: 1, b: 0, c: 7 }, - ], - }, - }, + const data: Datatable = { + type: 'datatable', + columns: [ + { id: 'a', name: 'a', meta: { type: 'number' } }, + { id: 'b', name: 'b', meta: { type: 'number' } }, + { id: 'c', name: 'c', meta: { type: 'number' } }, + ], + rows: [ + { a: 0, b: 2, c: 5 }, + { a: 1, b: 0, c: 7 }, + ], }; - const args: XYArgs = { + const args: XYProps = { xTitle: '', yTitle: '', yRightTitle: '', @@ -2182,8 +2199,8 @@ describe('XYChart component', () => { }, layers: [ { - type: 'dataLayer', layerId: 'first', + type: 'dataLayer', layerType: LayerTypes.DATA, seriesType: 'line', xAccessor: 'a', @@ -2194,13 +2211,14 @@ describe('XYChart component', () => { yScaleType: 'linear', isHistogram: false, palette: mockPaletteOutput, + table: data, }, ], }; - const component = shallow(); + const component = shallow(); - const series = component.find(LineSeries); + const series = component.find(DataLayers).dive().find(LineSeries); expect(series.prop('data')).toEqual([ { a: 0, b: 2, c: 5 }, @@ -2209,22 +2227,17 @@ describe('XYChart component', () => { }); test('it should show legend for split series, even with one row', () => { - const data: LensMultiTable = { - type: 'lens_multitable', - tables: { - first: { - type: 'datatable', - columns: [ - { id: 'a', name: 'a', meta: { type: 'number' } }, - { id: 'b', name: 'b', meta: { type: 'number' } }, - { id: 'c', name: 'c', meta: { type: 'string' } }, - ], - rows: [{ a: 1, b: 5, c: 'J' }], - }, - }, + const data: Datatable = { + type: 'datatable', + columns: [ + { id: 'a', name: 'a', meta: { type: 'number' } }, + { id: 'b', name: 'b', meta: { type: 'number' } }, + { id: 'c', name: 'c', meta: { type: 'string' } }, + ], + rows: [{ a: 1, b: 5, c: 'J' }], }; - const args: XYArgs = { + const args: XYProps = { xTitle: '', yTitle: '', yRightTitle: '', @@ -2258,8 +2271,8 @@ describe('XYChart component', () => { }, layers: [ { - type: 'dataLayer', layerId: 'first', + type: 'dataLayer', layerType: LayerTypes.DATA, seriesType: 'line', xAccessor: 'a', @@ -2270,27 +2283,27 @@ describe('XYChart component', () => { yScaleType: 'linear', isHistogram: false, palette: mockPaletteOutput, + table: data, }, ], }; - const component = shallow(); + const component = shallow(); expect(component.find(Settings).prop('showLegend')).toEqual(true); }); test('it should always show legend if showSingleSeries is set', () => { - const { data, args } = sampleArgs(); + const { args } = sampleArgs(); const component = shallow( { }); test('it should populate the correct legendPosition if isInside is set', () => { - const { data, args } = sampleArgs(); + const { args } = sampleArgs(); const component = shallow( { }); test('it not show legend if isVisible is set to false', () => { - const { data, args } = sampleArgs(); + const { args } = sampleArgs(); const component = shallow( { }); test('it should show legend on right side', () => { - const { data, args } = sampleArgs(); + const { args } = sampleArgs(); const component = shallow( { }); test('it should apply the fitting function to all non-bar series', () => { - const data: LensMultiTable = { - type: 'lens_multitable', - tables: { - first: createSampleDatatableWithRows([ - { a: 1, b: 2, c: 'I', d: 'Foo' }, - { a: 1, b: 5, c: 'J', d: 'Bar' }, - ]), - }, - }; + const data: Datatable = createSampleDatatableWithRows([ + { a: 1, b: 2, c: 'I', d: 'Foo' }, + { a: 1, b: 5, c: 'J', d: 'Bar' }, + ]); - const args: XYArgs = createArgsWithLayers([ - { ...sampleLayer, accessors: ['a'] }, - { ...sampleLayer, seriesType: 'bar', accessors: ['a'] }, - { ...sampleLayer, seriesType: 'area', accessors: ['a'] }, - { ...sampleLayer, seriesType: 'area_stacked', accessors: ['a'] }, + const args: XYProps = createArgsWithLayers([ + { ...sampleLayer, accessors: ['a'], table: data }, + { ...sampleLayer, seriesType: 'bar', accessors: ['a'], table: data }, + { ...sampleLayer, seriesType: 'area', accessors: ['a'], table: data }, + { ...sampleLayer, seriesType: 'area_stacked', accessors: ['a'], table: data }, ]); const component = shallow( - + ); - - expect(component.find(LineSeries).prop('fit')).toEqual({ type: Fit.Carry }); - expect(component.find(BarSeries).prop('fit')).toEqual(undefined); - expect(component.find(AreaSeries).at(0).prop('fit')).toEqual({ type: Fit.Carry }); - expect(component.find(AreaSeries).at(0).prop('stackAccessors')).toEqual([]); - expect(component.find(AreaSeries).at(1).prop('fit')).toEqual({ type: Fit.Carry }); - expect(component.find(AreaSeries).at(1).prop('stackAccessors')).toEqual(['c']); + const dataLayers = component.find(DataLayers).dive(); + expect(dataLayers.find(LineSeries).prop('fit')).toEqual({ type: Fit.Carry }); + expect(dataLayers.find(BarSeries).prop('fit')).toEqual(undefined); + expect(dataLayers.find(AreaSeries).at(0).prop('fit')).toEqual({ type: Fit.Carry }); + expect(dataLayers.find(AreaSeries).at(0).prop('stackAccessors')).toEqual([]); + expect(dataLayers.find(AreaSeries).at(1).prop('fit')).toEqual({ type: Fit.Carry }); + expect(dataLayers.find(AreaSeries).at(1).prop('stackAccessors')).toEqual(['c']); }); test('it should apply None fitting function if not specified', () => { - const { data, args } = sampleArgs(); + const { args } = sampleArgs(); - (args.layers[0] as DataLayerConfigResult).accessors = ['a']; + (args.layers[0] as DataLayerConfig).accessors = ['a']; - const component = shallow(); + const component = shallow(); - expect(component.find(LineSeries).prop('fit')).toEqual({ type: Fit.None }); + expect(component.find(DataLayers).dive().find(LineSeries).prop('fit')).toEqual({ + type: Fit.None, + }); }); test('it should apply the xTitle if is specified', () => { - const { data, args } = sampleArgs(); + const { args } = sampleArgs(); args.xTitle = 'My custom x-axis title'; - const component = shallow(); + const component = shallow(); expect(component.find(Axis).at(0).prop('title')).toEqual('My custom x-axis title'); }); test('it should hide the X axis title if the corresponding switch is off', () => { - const { data, args } = sampleArgs(); + const { args } = sampleArgs(); args.axisTitlesVisibilitySettings = { x: false, @@ -2427,7 +2434,7 @@ describe('XYChart component', () => { type: 'axisTitlesVisibilityConfig', }; - const component = shallow(); + const component = shallow(); const axisStyle = component.find(Axis).first().prop('style'); @@ -2439,7 +2446,7 @@ describe('XYChart component', () => { }); test('it should show the X axis gridlines if the setting is on', () => { - const { data, args } = sampleArgs(); + const { args } = sampleArgs(); args.gridlinesVisibilitySettings = { x: true, @@ -2448,7 +2455,7 @@ describe('XYChart component', () => { type: 'gridlinesConfig', }; - const component = shallow(); + const component = shallow(); expect(component.find(Axis).at(0).prop('gridLine')).toMatchObject({ visible: true, @@ -2456,45 +2463,37 @@ describe('XYChart component', () => { }); test('it should format the boolean values correctly', () => { - const data: LensMultiTable = { - type: 'lens_multitable', - tables: { - first: { - type: 'datatable', - columns: [ - { - id: 'a', - name: 'a', - meta: { type: 'number', params: { id: 'number', params: { pattern: '0,0.000' } } }, - }, - { - id: 'b', - name: 'b', - meta: { type: 'number', params: { id: 'number', params: { pattern: '000,0' } } }, - }, - { - id: 'c', - name: 'c', - meta: { - type: 'boolean', - params: { id: 'boolean' }, - }, - }, - ], - rows: [ - { a: 5, b: 2, c: 0 }, - { a: 19, b: 5, c: 1 }, - ], + const data: Datatable = { + type: 'datatable', + columns: [ + { + id: 'a', + name: 'a', + meta: { type: 'number', params: { id: 'number', params: { pattern: '0,0.000' } } }, }, - }, - dateRange: { - fromDate: new Date('2019-01-02T05:00:00.000Z'), - toDate: new Date('2019-01-03T05:00:00.000Z'), - }, + { + id: 'b', + name: 'b', + meta: { type: 'number', params: { id: 'number', params: { pattern: '000,0' } } }, + }, + { + id: 'c', + name: 'c', + meta: { + type: 'boolean', + params: { id: 'boolean' }, + }, + }, + ], + rows: [ + { a: 5, b: 2, c: 0 }, + { a: 19, b: 5, c: 1 }, + ], }; - const timeSampleLayer: DataLayerConfigResult = { + + const timeSampleLayer: DataLayerConfig = { + layerId: 'timeLayer', type: 'dataLayer', - layerId: 'first', layerType: LayerTypes.DATA, seriesType: 'line', xAccessor: 'c', @@ -2503,22 +2502,19 @@ describe('XYChart component', () => { yScaleType: 'linear', isHistogram: false, palette: mockPaletteOutput, + table: data, }; + const args = createArgsWithLayers([timeSampleLayer]); const getCustomFormatSpy = jest.fn(); getCustomFormatSpy.mockReturnValue({ convert: jest.fn((x) => Boolean(x)) }); const component = shallow( - + ); - expect(component.find(LineSeries).at(1).prop('data')).toEqual([ + expect(component.find(DataLayers).dive().find(LineSeries).at(1).prop('data')).toEqual([ { a: 5, b: 2, @@ -2533,69 +2529,80 @@ describe('XYChart component', () => { }); describe('annotations', () => { - const sampleStyledAnnotation: EventAnnotationOutput = { + const customLineStaticAnnotation: EventAnnotationOutput = { time: '2022-03-18T08:25:00.000Z', label: 'Event 1', icon: 'triangle', - type: 'manual_event_annotation', + type: 'manual_point_event_annotation' as const, color: 'red', lineStyle: 'dashed', lineWidth: 3, }; - const sampleAnnotationLayers: AnnotationLayerConfigResult[] = [ - { - type: 'annotationLayer', - layerType: LayerTypes.ANNOTATIONS, - layerId: 'annotation', - annotations: [ - { - time: '2022-03-18T08:25:17.140Z', - label: 'Annotation', - type: 'manual_event_annotation', - }, - ], - }, - ]; - function sampleArgsWithAnnotation(annotationLayers = sampleAnnotationLayers) { + + const defaultLineStaticAnnotation = { + time: '2022-03-18T08:25:17.140Z', + label: 'Annotation', + type: 'manual_point_event_annotation' as const, + }; + const defaultRangeStaticAnnotation = { + time: '2022-03-18T08:25:17.140Z', + endTime: '2022-03-31T08:25:17.140Z', + label: 'Event range', + type: 'manual_range_event_annotation' as const, + }; + const createLayerWithAnnotations = ( + annotations: EventAnnotationOutput[] = [defaultLineStaticAnnotation] + ): CommonXYAnnotationLayerConfig => ({ + type: 'annotationLayer', + layerType: LayerTypes.ANNOTATIONS, + layerId: 'annotation', + annotations, + }); + function sampleArgsWithAnnotations(annotationLayers = [createLayerWithAnnotations()]) { const { args } = sampleArgs(); return { - data: dateHistogramData, args: { ...args, layers: [dateHistogramLayer, ...annotationLayers], - } as XYArgs, + }, }; } - test('should render basic annotation', () => { - const { data, args } = sampleArgsWithAnnotation(); - const component = mount(); + + test('should render basic line annotation', () => { + const { args } = sampleArgsWithAnnotations(); + const component = mount(); expect(component.find('LineAnnotation')).toMatchSnapshot(); }); - test('should render simplified annotation when hide is true', () => { - const { data, args } = sampleArgsWithAnnotation(); - (args.layers[0] as AnnotationLayerConfigResult).hide = true; - const component = mount(); + test('should render basic range annotation', () => { + const { args } = sampleArgsWithAnnotations([ + createLayerWithAnnotations([defaultLineStaticAnnotation, defaultRangeStaticAnnotation]), + ]); + const component = mount(); + expect(component.find(RectAnnotation)).toMatchSnapshot(); + }); + test('should render simplified annotations when hide is true', () => { + const { args } = sampleArgsWithAnnotations([ + createLayerWithAnnotations([defaultLineStaticAnnotation, defaultRangeStaticAnnotation]), + ]); + (args.layers[1] as CommonXYAnnotationLayerConfig).hide = true; + const component = mount(); expect(component.find('LineAnnotation')).toMatchSnapshot(); + expect(component.find('RectAnnotation')).toMatchSnapshot(); }); - test('should render grouped annotations preserving the shared styles', () => { - const { data, args } = sampleArgsWithAnnotation([ - { - type: 'annotationLayer', - layerType: LayerTypes.ANNOTATIONS, - layerId: 'annotation', - annotations: [ - sampleStyledAnnotation, - { ...sampleStyledAnnotation, time: '2022-03-18T08:25:00.020Z', label: 'Event 2' }, - { - ...sampleStyledAnnotation, - time: '2022-03-18T08:25:00.001Z', - label: 'Event 3', - }, - ], - }, + test('should render grouped line annotations preserving the shared styles', () => { + const { args } = sampleArgsWithAnnotations([ + createLayerWithAnnotations([ + customLineStaticAnnotation, + { ...customLineStaticAnnotation, time: '2022-03-18T08:25:00.020Z', label: 'Event 2' }, + { + ...customLineStaticAnnotation, + time: '2022-03-18T08:25:00.001Z', + label: 'Event 3', + }, + ]), ]); - const component = mount(); + const component = mount(); const groupedAnnotation = component.find(LineAnnotation); expect(groupedAnnotation.length).toEqual(1); @@ -2613,32 +2620,23 @@ describe('XYChart component', () => { ' Event 1 2022-03-18T08:25:00.000Z Event 3 2022-03-18T08:25:00.001Z Event 2 2022-03-18T08:25:00.020Z' ); }); - test('should render grouped annotations with default styles', () => { - const { data, args } = sampleArgsWithAnnotation([ - { - type: 'annotationLayer', - layerType: LayerTypes.ANNOTATIONS, - layerId: 'annotation', - annotations: [sampleStyledAnnotation], - }, - { - type: 'annotationLayer', - layerType: LayerTypes.ANNOTATIONS, - layerId: 'annotation', - annotations: [ - { - ...sampleStyledAnnotation, - icon: 'square', - color: 'blue', - lineStyle: 'dotted', - lineWidth: 10, - time: '2022-03-18T08:25:00.001Z', - label: 'Event 2', - }, - ], - }, + + test('should render grouped line annotations with default styles', () => { + const { args } = sampleArgsWithAnnotations([ + createLayerWithAnnotations([customLineStaticAnnotation]), + createLayerWithAnnotations([ + { + ...customLineStaticAnnotation, + icon: 'triangle' as const, + color: 'blue', + lineStyle: 'dotted', + lineWidth: 10, + time: '2022-03-18T08:25:00.001Z', + label: 'Event 2', + }, + ]), ]); - const component = mount(); + const component = mount(); const groupedAnnotation = component.find(LineAnnotation); expect(groupedAnnotation.length).toEqual(1); @@ -2646,27 +2644,26 @@ describe('XYChart component', () => { expect(groupedAnnotation).toMatchSnapshot(); }); test('should not render hidden annotations', () => { - const { data, args } = sampleArgsWithAnnotation([ - { - type: 'annotationLayer', - layerType: LayerTypes.ANNOTATIONS, - layerId: 'annotation', - annotations: [ - sampleStyledAnnotation, - { ...sampleStyledAnnotation, time: '2022-03-18T08:30:00.020Z', label: 'Event 2' }, - { - ...sampleStyledAnnotation, - time: '2022-03-18T08:35:00.001Z', - label: 'Event 3', - isHidden: true, - }, - ], - }, + const { args } = sampleArgsWithAnnotations([ + createLayerWithAnnotations([ + customLineStaticAnnotation, + { ...customLineStaticAnnotation, time: '2022-03-18T08:30:00.020Z', label: 'Event 2' }, + { + ...customLineStaticAnnotation, + time: '2022-03-18T08:35:00.001Z', + label: 'Event 3', + isHidden: true, + }, + defaultRangeStaticAnnotation, + { ...defaultRangeStaticAnnotation, label: 'range', isHidden: true }, + ]), ]); - const component = mount(); - const annotations = component.find(LineAnnotation); + const component = mount(); + const lineAnnotations = component.find(LineAnnotation); + const rectAnnotations = component.find(Annotations).find(RectAnnotation); - expect(annotations.length).toEqual(2); + expect(lineAnnotations.length).toEqual(2); + expect(rectAnnotations.length).toEqual(1); }); }); }); diff --git a/src/plugins/chart_expressions/expression_xy/public/components/xy_chart.tsx b/src/plugins/chart_expressions/expression_xy/public/components/xy_chart.tsx index 4f543ae0f09ae..db653861a337e 100644 --- a/src/plugins/chart_expressions/expression_xy/public/components/xy_chart.tsx +++ b/src/plugins/chart_expressions/expression_xy/public/components/xy_chart.tsx @@ -6,67 +6,65 @@ * Side Public License, v 1. */ -import React, { useRef } from 'react'; +import React, { useMemo, useRef } from 'react'; import { Chart, Settings, Axis, - LineSeries, - AreaSeries, - BarSeries, Position, GeometryValue, XYChartSeriesIdentifier, - StackMode, VerticalAlignment, HorizontalAlignment, LayoutDirection, ElementClickListener, BrushEndListener, XYBrushEvent, - CurveType, LegendPositionConfig, - LabelOverflowConstraint, DisplayValueStyle, RecursivePartial, AxisStyle, - ScaleType, - AreaSeriesProps, - BarSeriesProps, - LineSeriesProps, - ColorVariant, + Placement, } from '@elastic/charts'; import { IconType } from '@elastic/eui'; -import { i18n } from '@kbn/i18n'; -import { PaletteRegistry, SeriesLayer } from '@kbn/coloring'; -import type { Datatable, DatatableRow, DatatableColumn } from '@kbn/expressions-plugin/public'; +import { PaletteRegistry } from '@kbn/coloring'; import { RenderMode } from '@kbn/expressions-plugin/common'; -import { FieldFormat } from '@kbn/field-formats-plugin/common'; import { EmptyPlaceholder } from '@kbn/charts-plugin/public'; import { EventAnnotationServiceType } from '@kbn/event-annotation-plugin/public'; import { ChartsPluginSetup, ChartsPluginStart, useActiveCursor } from '@kbn/charts-plugin/public'; import { MULTILAYER_TIME_AXIS_STYLE } from '@kbn/charts-plugin/common'; import type { FilterEvent, BrushEvent, FormatFactory } from '../types'; -import type { SeriesType, XYChartProps } from '../../common/types'; -import { isHorizontalChart, getSeriesColor, getAnnotationsLayers, getDataLayers } from '../helpers'; +import type { CommonXYDataLayerConfig, SeriesType, XYChartProps } from '../../common/types'; +import { + isHorizontalChart, + getAnnotationsLayers, + getDataLayers, + Series, + getFormattedTablesByLayers, + validateExtent, +} from '../helpers'; import { getFilteredLayers, getReferenceLayers, isDataLayer, - getFitOptions, getAxesConfiguration, GroupsConfiguration, - validateExtent, - getColorAssignments, getLinesCausedPaddings, } from '../helpers'; import { getXDomain, XyEndzones } from './x_domain'; import { getLegendAction } from './legend_action'; import { ReferenceLineAnnotations, computeChartMargins } from './reference_lines'; import { visualizationDefinitions } from '../definitions'; -import { XYLayerConfigResult } from '../../common/types'; -import { Annotations, getAnnotationsGroupedByInterval } from './annotations'; - +import { CommonXYLayerConfig } from '../../common/types'; +import { + Annotations, + getAnnotationsGroupedByInterval, + getRangeAnnotations, + OUTSIDE_RECT_ANNOTATION_WIDTH, + OUTSIDE_RECT_ANNOTATION_WIDTH_SUGGESTION, +} from './annotations'; +import { AxisExtentModes, SeriesTypes, ValueLabelModes } from '../../common/constants'; +import { DataLayers } from './data_layers'; import './xy_chart.scss'; declare global { @@ -78,8 +76,6 @@ declare global { } } -type SeriesSpec = LineSeriesProps & BarSeriesProps & AreaSeriesProps; - export type XYChartRenderProps = XYChartProps & { chartsThemeService: ChartsPluginSetup['theme']; chartsActiveCursorService: ChartsPluginStart['activeCursor']; @@ -93,11 +89,10 @@ export type XYChartRenderProps = XYChartProps & { onSelectRange: (data: BrushEvent['data']) => void; renderMode: RenderMode; syncColors: boolean; + syncTooltips: boolean; eventAnnotationService: EventAnnotationServiceType; }; -const isPrimitive = (value: unknown): boolean => value != null && typeof value !== 'object'; - function getValueLabelsStyling(isHorizontal: boolean): { displayValue: RecursivePartial; } { @@ -126,7 +121,6 @@ function getIconForSeriesType(seriesType: SeriesType): IconType { export const XYChartReportable = React.memo(XYChart); export function XYChart({ - data, args, formatFactory, timeZone, @@ -138,6 +132,7 @@ export function XYChart({ onSelectRange, interactive = true, syncColors, + syncTooltips, useLegacyTimeAxis, }: XYChartRenderProps) { const { @@ -157,50 +152,47 @@ export function XYChart({ const chartTheme = chartsThemeService.useChartsTheme(); const chartBaseTheme = chartsThemeService.useChartsBaseTheme(); const darkMode = chartsThemeService.useDarkMode(); - const filteredLayers = getFilteredLayers(layers, data); - const layersById = filteredLayers.reduce>( - (hashMap, layer) => { - hashMap[layer.layerId] = layer; - return hashMap; - }, + const filteredLayers = getFilteredLayers(layers); + const layersById = filteredLayers.reduce>( + (hashMap, layer) => ({ ...hashMap, [layer.layerId]: layer }), {} ); const handleCursorUpdate = useActiveCursor(chartsActiveCursorService, chartRef, { - datatables: Object.values(data.tables), + datatables: filteredLayers.map(({ table }) => table), }); + const dataLayers: CommonXYDataLayerConfig[] = filteredLayers.filter(isDataLayer); + const formattedDatatables = useMemo( + () => getFormattedTablesByLayers(dataLayers, formatFactory), + [dataLayers, formatFactory] + ); + if (filteredLayers.length === 0) { - const icon: IconType = getIconForSeriesType(getDataLayers(layers)?.[0]?.seriesType || 'bar'); + const icon: IconType = getIconForSeriesType( + getDataLayers(layers)?.[0]?.seriesType || SeriesTypes.BAR + ); return ; } // use formatting hint of first x axis column to format ticks - const xAxisColumn = data.tables[filteredLayers[0].layerId].columns.find( - ({ id }) => id === filteredLayers[0].xAccessor - ); + const xAxisColumn = dataLayers[0]?.table.columns.find(({ id }) => id === dataLayers[0].xAccessor); const xAxisFormatter = formatFactory(xAxisColumn && xAxisColumn.meta?.params); - const layersAlreadyFormatted: Record = {}; // This is a safe formatter for the xAccessor that abstracts the knowledge of already formatted layers const safeXAccessorLabelRenderer = (value: unknown): string => - xAxisColumn && layersAlreadyFormatted[xAxisColumn.id] + xAxisColumn && formattedDatatables[dataLayers[0]?.layerId]?.formattedColumns[xAxisColumn.id] ? String(value) : String(xAxisFormatter.convert(value)); const chartHasMoreThanOneSeries = filteredLayers.length > 1 || filteredLayers.some((layer) => layer.accessors.length > 1) || - filteredLayers.some((layer) => layer.splitAccessor); - const shouldRotate = isHorizontalChart(filteredLayers); - - const yAxesConfiguration = getAxesConfiguration( - filteredLayers, - shouldRotate, - data.tables, - formatFactory - ); + filteredLayers.some((layer) => isDataLayer(layer) && layer.splitAccessor); + const shouldRotate = isHorizontalChart(dataLayers); + + const yAxesConfiguration = getAxesConfiguration(dataLayers, shouldRotate, formatFactory); const xTitle = args.xTitle || (xAxisColumn && xAxisColumn.name); const axisTitlesVisibilitySettings = args.axisTitlesVisibilitySettings || { @@ -214,25 +206,20 @@ export function XYChart({ yRight: true, }; - const labelsOrientation = args.labelsOrientation || { - x: 0, - yLeft: 0, - yRight: 0, - }; + const labelsOrientation = args.labelsOrientation || { x: 0, yLeft: 0, yRight: 0 }; - const filteredBarLayers = filteredLayers.filter((layer) => layer.seriesType.includes('bar')); + const filteredBarLayers = dataLayers.filter((layer) => layer.seriesType.includes('bar')); const chartHasMoreThanOneBarSeries = filteredBarLayers.length > 1 || filteredBarLayers.some((layer) => layer.accessors.length > 1) || - filteredBarLayers.some((layer) => layer.splitAccessor); + filteredBarLayers.some((layer) => isDataLayer(layer) && layer.splitAccessor); - const isTimeViz = Boolean(filteredLayers.every((l) => l.xScaleType === 'time')); - const isHistogramViz = filteredLayers.every((l) => l.isHistogram); + const isTimeViz = Boolean(dataLayers.every((l) => l.xScaleType === 'time')); + const isHistogramViz = dataLayers.every((l) => l.isHistogram); const { baseDomain: rawXDomain, extendedDomain: xDomain } = getXDomain( - filteredLayers, - data, + dataLayers, minInterval, isTimeViz, isHistogramViz @@ -243,17 +230,16 @@ export function XYChart({ right: yAxesConfiguration.find(({ groupId }) => groupId === 'right'), }; - const getYAxesTitles = ( - axisSeries: Array<{ layer: string; accessor: string }>, - groupId: string - ) => { + const getYAxesTitles = (axisSeries: Series[], groupId: 'right' | 'left') => { const yTitle = groupId === 'right' ? args.yRightTitle : args.yTitle; return ( yTitle || axisSeries .map( (series) => - data.tables[series.layer].columns.find((column) => column.id === series.accessor)?.name + filteredLayers + .find(({ layerId }) => series.layer === layerId) + ?.table.columns.find((column) => column.id === series.accessor)?.name ) .filter((name) => Boolean(name))[0] ); @@ -261,22 +247,25 @@ export function XYChart({ const referenceLineLayers = getReferenceLayers(layers); const annotationsLayers = getAnnotationsLayers(layers); - const firstTable = data.tables[filteredLayers[0].layerId]; + const firstTable = dataLayers[0]?.table; - const xColumnId = firstTable.columns.find((col) => col.id === filteredLayers[0].xAccessor)?.id; + const xColumnId = firstTable.columns.find((col) => col.id === dataLayers[0]?.xAccessor)?.id; - const groupedAnnotations = getAnnotationsGroupedByInterval( + const groupedLineAnnotations = getAnnotationsGroupedByInterval( annotationsLayers, minInterval, xColumnId ? firstTable.rows[0]?.[xColumnId] : undefined, xAxisFormatter ); + const rangeAnnotations = getRangeAnnotations(annotationsLayers); + const visualConfigs = [ ...referenceLineLayers.flatMap(({ yConfig }) => yConfig), - ...groupedAnnotations, + ...groupedLineAnnotations, ].filter(Boolean); - const linesPaddings = getLinesCausedPaddings(visualConfigs, yAxesMap); + const shouldHideDetails = annotationsLayers.length > 0 ? annotationsLayers[0].hide : false; + const linesPaddings = !shouldHideDetails ? getLinesCausedPaddings(visualConfigs, yAxesMap) : {}; const getYAxesStyle = (groupId: 'left' | 'right') => { const tickVisible = @@ -327,10 +316,11 @@ export function XYChart({ return layer.seriesType.includes('bar') || layer.seriesType.includes('area'); }) ); - const fit = !hasBarOrArea && extent.mode === 'dataBounds'; + + const fit = !hasBarOrArea && extent.mode === AxisExtentModes.DATA_BOUNDS; + let min: number = NaN; let max: number = NaN; - if (extent.mode === 'custom') { const { inclusiveZeroError, boundaryError } = validateExtent(hasBarOrArea, extent); if (!inclusiveZeroError && !boundaryError) { @@ -357,38 +347,42 @@ export function XYChart({ const shouldShowValueLabels = // No stacked bar charts - filteredLayers.every((layer) => !layer.seriesType.includes('stacked')) && + dataLayers.every((layer) => !layer.seriesType.includes('stacked')) && // No histogram charts !isHistogramViz; const valueLabelsStyling = - shouldShowValueLabels && valueLabels !== 'hide' && getValueLabelsStyling(shouldRotate); - - const colorAssignments = getColorAssignments(getDataLayers(args.layers), data, formatFactory); + shouldShowValueLabels && + valueLabels !== ValueLabelModes.HIDE && + getValueLabelsStyling(shouldRotate); const clickHandler: ElementClickListener = ([[geometry, series]]) => { // for xyChart series is always XYChartSeriesIdentifier and geometry is always type of GeometryValue const xySeries = series as XYChartSeriesIdentifier; const xyGeometry = geometry as GeometryValue; - const layer = filteredLayers.find((l) => + const layerIndex = dataLayers.findIndex((l) => xySeries.seriesKeys.some((key: string | number) => l.accessors.includes(key.toString())) ); - if (!layer) { + + if (layerIndex === -1) { return; } - const table = data.tables[layer.layerId]; + const layer = dataLayers[layerIndex]; + const { table } = layer; const xColumn = table.columns.find((col) => col.id === layer.xAccessor); const currentXFormatter = - layer.xAccessor && layersAlreadyFormatted[layer.xAccessor] && xColumn + layer.xAccessor && + formattedDatatables[layer.layerId]?.formattedColumns[layer.xAccessor] && + xColumn ? formatFactory(xColumn.meta.params) : xAxisFormatter; const rowIndex = table.rows.findIndex((row) => { if (layer.xAccessor) { - if (layersAlreadyFormatted[layer.xAccessor]) { + if (formattedDatatables[layer.layerId]?.formattedColumns[layer.xAccessor]) { // stringify the value to compare with the chart value return currentXFormatter.convert(row[layer.xAccessor]) === xyGeometry.x; } @@ -413,7 +407,7 @@ export function XYChart({ points.push({ row: table.rows.findIndex((row) => { if (layer.splitAccessor) { - if (layersAlreadyFormatted[layer.splitAccessor]) { + if (formattedDatatables[layer.layerId]?.formattedColumns[layer.splitAccessor]) { return splitFormatter.convert(row[layer.splitAccessor]) === pointValue; } return row[layer.splitAccessor] === pointValue; @@ -424,12 +418,7 @@ export function XYChart({ }); } const context: FilterEvent['data'] = { - data: points.map((point) => ({ - row: point.row, - column: point.column, - value: point.value, - table, - })), + data: points.map(({ row, column, value }) => ({ row, column, value, table })), }; onClickValue(context); }; @@ -443,27 +432,23 @@ export function XYChart({ return; } - const table = data.tables[filteredLayers[0].layerId]; + const { table } = dataLayers[0]; - const xAxisColumnIndex = table.columns.findIndex((el) => el.id === filteredLayers[0].xAccessor); + const xAxisColumnIndex = table.columns.findIndex((el) => el.id === dataLayers[0].xAccessor); - const context: BrushEvent['data'] = { - range: [min, max], - table, - column: xAxisColumnIndex, - }; + const context: BrushEvent['data'] = { range: [min, max], table, column: xAxisColumnIndex }; onSelectRange(context); }; - const legendInsideParams = { + const legendInsideParams: LegendPositionConfig = { vAlign: legend.verticalAlignment ?? VerticalAlignment.Top, hAlign: legend?.horizontalAlignment ?? HorizontalAlignment.Right, direction: LayoutDirection.Vertical, floating: true, floatingColumns: legend?.floatingColumns ?? 1, - } as LegendPositionConfig; + }; - const isHistogramModeEnabled = filteredLayers.some( + const isHistogramModeEnabled = dataLayers.some( ({ isHistogram, seriesType }) => isHistogram && (seriesType.includes('stacked') || @@ -507,11 +492,13 @@ export function XYChart({ : undefined, }, }; - return ( safeXAccessorLabelRenderer(d)} style={xAxisStyle} timeAxisLayerCount={shouldUseNewTimeAxis ? 3 : 0} @@ -595,9 +576,9 @@ export function XYChart({ ? gridlinesVisibilitySettings?.yRight : gridlinesVisibilitySettings?.yLeft, }} - hide={filteredLayers[0].hide} + hide={dataLayers[0]?.hide} tickFormat={(d) => axis.formatter?.convert(d) || ''} - style={getYAxesStyle(axis.groupId as 'left' | 'right')} + style={getYAxesStyle(axis.groupId)} domain={getYAxisDomain(axis)} ticks={5} /> @@ -609,7 +590,7 @@ export function XYChart({ baseDomain={rawXDomain} extendedDomain={xDomain} darkMode={darkMode} - histogramMode={filteredLayers.every( + histogramMode={dataLayers.every( (layer) => layer.isHistogram && (layer.seriesType.includes('stacked') || !layer.splitAccessor) && @@ -620,282 +601,28 @@ export function XYChart({ /> )} - {filteredLayers.flatMap((layer, layerIndex) => - layer.accessors.map((accessor, accessorIndex) => { - const { - splitAccessor, - seriesType, - accessors, - xAccessor, - layerId, - columnToLabel, - yScaleType, - xScaleType, - isHistogram, - palette, - } = layer; - const columnToLabelMap: Record = columnToLabel - ? JSON.parse(columnToLabel) - : {}; - - const table = data.tables[layerId]; - - const formatterPerColumn = new Map(); - for (const column of table.columns) { - formatterPerColumn.set(column, formatFactory(column.meta.params)); - } - - // what if row values are not primitive? That is the case of, for instance, Ranges - // remaps them to their serialized version with the formatHint metadata - // In order to do it we need to make a copy of the table as the raw one is required for more features (filters, etc...) later on - const tableConverted: Datatable = { - ...table, - rows: table.rows.map((row: DatatableRow) => { - const newRow = { ...row }; - for (const column of table.columns) { - const record = newRow[column.id]; - if ( - record != null && - // pre-format values for ordinal x axes because there can only be a single x axis formatter on chart level - (!isPrimitive(record) || (column.id === xAccessor && xScaleType === 'ordinal')) - ) { - newRow[column.id] = formatterPerColumn.get(column)!.convert(record); - } - } - return newRow; - }), - }; - - // save the id of the layer with the custom table - table.columns.reduce>( - (alreadyFormatted: Record, { id }) => { - if (alreadyFormatted[id]) { - return alreadyFormatted; - } - alreadyFormatted[id] = table.rows.some( - (row, i) => row[id] !== tableConverted.rows[i][id] - ); - return alreadyFormatted; - }, - layersAlreadyFormatted - ); - - const isStacked = seriesType.includes('stacked'); - const isPercentage = seriesType.includes('percentage'); - const isBarChart = seriesType.includes('bar'); - const enableHistogramMode = - isHistogram && - (isStacked || !splitAccessor) && - (isStacked || !isBarChart || !chartHasMoreThanOneBarSeries); - - // For date histogram chart type, we're getting the rows that represent intervals without data. - // To not display them in the legend, they need to be filtered out. - const rows = tableConverted.rows.filter( - (row) => - !(xAccessor && typeof row[xAccessor] === 'undefined') && - !( - splitAccessor && - typeof row[splitAccessor] === 'undefined' && - typeof row[accessor] === 'undefined' - ) - ); - - if (!xAccessor) { - rows.forEach((row) => { - row.unifiedX = i18n.translate('expressionXY.xyChart.emptyXLabel', { - defaultMessage: '(empty)', - }); - }); - } - - const yAxis = yAxesConfiguration.find((axisConfiguration) => - axisConfiguration.series.find((currentSeries) => currentSeries.accessor === accessor) - ); - - const formatter = table?.columns.find((column) => column.id === accessor)?.meta?.params; - const splitHint = table.columns.find((col) => col.id === splitAccessor)?.meta?.params; - const splitFormatter = formatFactory(splitHint); - - const seriesProps: SeriesSpec = { - splitSeriesAccessors: splitAccessor ? [splitAccessor] : [], - stackAccessors: isStacked ? [xAccessor as string] : [], - id: `${splitAccessor}-${accessor}`, - xAccessor: xAccessor || 'unifiedX', - yAccessors: [accessor], - data: rows, - xScaleType: xAccessor ? xScaleType : 'ordinal', - yScaleType: - formatter?.id === 'bytes' && yScaleType === ScaleType.Linear - ? ScaleType.LinearBinary - : yScaleType, - color: ({ yAccessor, seriesKeys }) => { - const overwriteColor = getSeriesColor(layer, accessor); - if (overwriteColor !== null) { - return overwriteColor; - } - const colorAssignment = colorAssignments[palette.name]; - const seriesLayers: SeriesLayer[] = [ - { - name: splitAccessor ? String(seriesKeys[0]) : columnToLabelMap[seriesKeys[0]], - totalSeriesAtDepth: colorAssignment.totalSeriesCount, - rankAtDepth: colorAssignment.getRank( - layer, - String(seriesKeys[0]), - String(yAccessor) - ), - }, - ]; - return paletteService.get(palette.name).getCategoricalColor( - seriesLayers, - { - maxDepth: 1, - behindText: false, - totalSeries: colorAssignment.totalSeriesCount, - syncColors, - }, - palette.params - ); - }, - groupId: yAxis?.groupId, - enableHistogramMode, - stackMode: isPercentage ? StackMode.Percentage : undefined, - timeZone, - areaSeriesStyle: { - point: { - visible: !xAccessor, - radius: xAccessor && !emphasizeFitting ? 5 : 0, - }, - ...(args.fillOpacity && { area: { opacity: args.fillOpacity } }), - ...(emphasizeFitting && { - fit: { - area: { - opacity: args.fillOpacity || 0.5, - }, - line: { - visible: true, - stroke: ColorVariant.Series, - opacity: 1, - dash: [], - }, - }, - }), - }, - lineSeriesStyle: { - point: { - visible: !xAccessor, - radius: xAccessor && !emphasizeFitting ? 5 : 0, - }, - ...(emphasizeFitting && { - fit: { - line: { - visible: true, - stroke: ColorVariant.Series, - opacity: 1, - dash: [], - }, - }, - }), - }, - name(d) { - // For multiple y series, the name of the operation is used on each, either: - // * Key - Y name - // * Formatted value - Y name - if (accessors.length > 1) { - const result = d.seriesKeys - .map((key: string | number, i) => { - if ( - i === 0 && - splitHint && - splitAccessor && - !layersAlreadyFormatted[splitAccessor] - ) { - return splitFormatter.convert(key); - } - return splitAccessor && i === 0 ? key : columnToLabelMap[key] ?? ''; - }) - .join(' - '); - return result; - } - - // For formatted split series, format the key - // This handles splitting by dates, for example - if (splitHint) { - if (splitAccessor && layersAlreadyFormatted[splitAccessor]) { - return d.seriesKeys[0]; - } - return splitFormatter.convert(d.seriesKeys[0]); - } - // This handles both split and single-y cases: - // * If split series without formatting, show the value literally - // * If single Y, the seriesKey will be the accessor, so we show the human-readable name - return splitAccessor ? d.seriesKeys[0] : columnToLabelMap[d.seriesKeys[0]] ?? ''; - }, - }; - - const index = `${layerIndex}-${accessorIndex}`; - - const curveType = args.curveType ? CurveType[args.curveType] : undefined; - - switch (seriesType) { - case 'line': - return ( - - ); - case 'bar': - case 'bar_stacked': - case 'bar_percentage_stacked': - case 'bar_horizontal': - case 'bar_horizontal_stacked': - case 'bar_horizontal_percentage_stacked': - const valueLabelsSettings = { - displayValueSettings: { - // This format double fixes two issues in elastic-chart - // * when rotating the chart, the formatter is not correctly picked - // * in some scenarios value labels are not strings, and this breaks the elastic-chart lib - valueFormatter: (d: unknown) => yAxis?.formatter?.convert(d) || '', - showValueLabel: shouldShowValueLabels && valueLabels !== 'hide', - isValueContainedInElement: false, - isAlternatingValueLabel: false, - overflowConstraints: [ - LabelOverflowConstraint.ChartEdges, - LabelOverflowConstraint.BarGeometry, - ], - }, - }; - return ; - case 'area_stacked': - case 'area_percentage_stacked': - return ( - - ); - case 'area': - return ( - - ); - default: - return assertNever(seriesType); - } - }) + {dataLayers.length && ( + )} {referenceLineLayers.length ? ( ) : null} - {groupedAnnotations.length ? ( + {rangeAnnotations.length || groupedLineAnnotations.length ? ( 0} minInterval={minInterval} + hide={annotationsLayers?.[0].hide} + outsideDimension={ + rangeAnnotations.length && shouldHideDetails + ? OUTSIDE_RECT_ANNOTATION_WIDTH_SUGGESTION + : shouldUseNewTimeAxis + ? Number(MULTILAYER_TIME_AXIS_STYLE.tickLine?.padding || 0) + + Number(chartTheme.axes?.tickLabel?.fontSize || 0) + : Number(chartTheme.axes?.tickLine?.size) || OUTSIDE_RECT_ANNOTATION_WIDTH + } /> ) : null} ); } - -function assertNever(x: never): never { - throw new Error('Unexpected series type: ' + x); -} diff --git a/src/plugins/chart_expressions/expression_xy/public/expression_renderers/xy_chart_renderer.tsx b/src/plugins/chart_expressions/expression_xy/public/expression_renderers/xy_chart_renderer.tsx index a35216821c077..c6ad977bbad3a 100644 --- a/src/plugins/chart_expressions/expression_xy/public/expression_renderers/xy_chart_renderer.tsx +++ b/src/plugins/chart_expressions/expression_xy/public/expression_renderers/xy_chart_renderer.tsx @@ -18,7 +18,6 @@ import { ExpressionRenderDefinition } from '@kbn/expressions-plugin'; import { FormatFactory } from '@kbn/field-formats-plugin/common'; import { KibanaThemeProvider } from '@kbn/kibana-react-plugin/public'; import type { XYChartProps } from '../../common'; -import { calculateMinInterval } from '../helpers/interval'; import type { BrushEvent, FilterEvent } from '../types'; export type GetStartDepsFn = () => Promise<{ @@ -56,7 +55,10 @@ export const getXyChartRenderer = ({ }; const deps = await getStartDeps(); - const { XYChartReportable } = await import('../components/xy_chart'); + const [{ XYChartReportable }, { calculateMinInterval }] = await Promise.all([ + import('../components/xy_chart'), + import('../helpers/interval'), + ]); ReactDOM.render( @@ -80,6 +82,7 @@ export const getXyChartRenderer = ({ onSelectRange={onSelectRange} renderMode={handlers.getRenderMode()} syncColors={handlers.isSyncColorsEnabled()} + syncTooltips={handlers.isSyncTooltipsEnabled()} /> {' '} diff --git a/src/plugins/chart_expressions/expression_xy/public/helpers/annotations.tsx b/src/plugins/chart_expressions/expression_xy/public/helpers/annotations.tsx index 9050bdee4a365..d6746cafc0296 100644 --- a/src/plugins/chart_expressions/expression_xy/public/helpers/annotations.tsx +++ b/src/plugins/chart_expressions/expression_xy/public/helpers/annotations.tsx @@ -9,19 +9,32 @@ import React from 'react'; import { Position } from '@elastic/charts'; import { EuiFlexGroup, EuiIcon, EuiIconProps, EuiText } from '@elastic/eui'; import classnames from 'classnames'; -import type { IconPosition, YAxisMode, YConfig } from '../../common/types'; +import type { + IconPosition, + YAxisMode, + ExtendedYConfig, + CollectiveConfig, +} from '../../common/types'; import { getBaseIconPlacement } from '../components'; -import { hasIcon } from './icon'; -import { annotationsIconSet } from './annotations_icon_set'; +import { hasIcon, iconSet } from './icon'; export const LINES_MARKER_SIZE = 20; -// Note: it does not take into consideration whether the reference line is in view or not +type PartialExtendedYConfig = Pick< + ExtendedYConfig, + 'axisMode' | 'icon' | 'iconPosition' | 'textVisibility' +>; + +type PartialCollectiveConfig = Pick; + +const isExtendedYConfig = ( + config: PartialExtendedYConfig | PartialCollectiveConfig | undefined +): config is PartialExtendedYConfig => + (config as PartialExtendedYConfig)?.iconPosition ? true : false; +// Note: it does not take into consideration whether the reference line is in view or not export const getLinesCausedPaddings = ( - visualConfigs: Array< - Pick | undefined - >, + visualConfigs: Array, axesMap: Record<'left' | 'right', unknown> ) => { // collect all paddings for the 4 axis: if any text is detected double it. @@ -31,7 +44,9 @@ export const getLinesCausedPaddings = ( if (!config) { return; } - const { axisMode, icon, iconPosition, textVisibility } = config; + const { axisMode, icon, textVisibility } = config; + const iconPosition = isExtendedYConfig(config) ? config.iconPosition : undefined; + if (axisMode && (hasIcon(icon) || textVisibility)) { const placement = getBaseIconPlacement(iconPosition, axesMap, axisMode); paddings[placement] = Math.max( @@ -48,6 +63,7 @@ export const getLinesCausedPaddings = ( paddings[placement] = LINES_MARKER_SIZE; } }); + return paddings; }; @@ -138,7 +154,7 @@ export const AnnotationIcon = ({ if (isNumericalString(type)) { return ; } - const iconConfig = annotationsIconSet.find((i) => i.value === type); + const iconConfig = iconSet.find((i) => i.value === type); if (!iconConfig) { return null; } diff --git a/src/plugins/chart_expressions/expression_xy/public/helpers/annotations_icon_set.tsx b/src/plugins/chart_expressions/expression_xy/public/helpers/annotations_icon_set.tsx deleted file mode 100644 index 99b4648e4d556..0000000000000 --- a/src/plugins/chart_expressions/expression_xy/public/helpers/annotations_icon_set.tsx +++ /dev/null @@ -1,101 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import { i18n } from '@kbn/i18n'; -import { TriangleIcon, CircleIcon } from '../icons'; - -export const annotationsIconSet = [ - { - value: 'asterisk', - label: i18n.translate('expressionXY.xyChart.iconSelect.asteriskIconLabel', { - defaultMessage: 'Asterisk', - }), - }, - { - value: 'alert', - label: i18n.translate('expressionXY.xyChart.iconSelect.alertIconLabel', { - defaultMessage: 'Alert', - }), - }, - { - value: 'bell', - label: i18n.translate('expressionXY.xyChart.iconSelect.bellIconLabel', { - defaultMessage: 'Bell', - }), - }, - { - value: 'bolt', - label: i18n.translate('expressionXY.xyChart.iconSelect.boltIconLabel', { - defaultMessage: 'Bolt', - }), - }, - { - value: 'bug', - label: i18n.translate('expressionXY.xyChart.iconSelect.bugIconLabel', { - defaultMessage: 'Bug', - }), - }, - { - value: 'circle', - label: i18n.translate('expressionXY.xyChart.iconSelect.circleIconLabel', { - defaultMessage: 'Circle', - }), - icon: CircleIcon, - canFill: true, - }, - - { - value: 'editorComment', - label: i18n.translate('expressionXY.xyChart.iconSelect.commentIconLabel', { - defaultMessage: 'Comment', - }), - }, - { - value: 'flag', - label: i18n.translate('expressionXY.xyChart.iconSelect.flagIconLabel', { - defaultMessage: 'Flag', - }), - }, - { - value: 'heart', - label: i18n.translate('expressionXY.xyChart.iconSelect.heartLabel', { - defaultMessage: 'Heart', - }), - }, - { - value: 'mapMarker', - label: i18n.translate('expressionXY.xyChart.iconSelect.mapMarkerLabel', { - defaultMessage: 'Map Marker', - }), - }, - { - value: 'pinFilled', - label: i18n.translate('expressionXY.xyChart.iconSelect.mapPinLabel', { - defaultMessage: 'Map Pin', - }), - }, - { - value: 'starEmpty', - label: i18n.translate('expressionXY.xyChart.iconSelect.starLabel', { defaultMessage: 'Star' }), - }, - { - value: 'tag', - label: i18n.translate('expressionXY.xyChart.iconSelect.tagIconLabel', { - defaultMessage: 'Tag', - }), - }, - { - value: 'triangle', - label: i18n.translate('expressionXY.xyChart.iconSelect.triangleIconLabel', { - defaultMessage: 'Triangle', - }), - icon: TriangleIcon, - shouldRotate: true, - canFill: true, - }, -]; diff --git a/src/plugins/chart_expressions/expression_xy/public/helpers/axes_configuration.test.ts b/src/plugins/chart_expressions/expression_xy/public/helpers/axes_configuration.test.ts index c5f2f6d7151e5..f3abf76b2d05a 100644 --- a/src/plugins/chart_expressions/expression_xy/public/helpers/axes_configuration.test.ts +++ b/src/plugins/chart_expressions/expression_xy/public/helpers/axes_configuration.test.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { DataLayerConfigResult } from '../../common'; +import { DataLayerConfig } from '../../common'; import { LayerTypes } from '../../common/constants'; import { Datatable } from '@kbn/expressions-plugin/public'; import { getAxesConfiguration } from './axes_configuration'; @@ -220,9 +220,9 @@ describe('axes_configuration', () => { }, }; - const sampleLayer: DataLayerConfigResult = { - type: 'dataLayer', + const sampleLayer: DataLayerConfig = { layerId: 'first', + type: 'dataLayer', layerType: LayerTypes.DATA, seriesType: 'line', xAccessor: 'c', @@ -233,11 +233,12 @@ describe('axes_configuration', () => { yScaleType: 'linear', isHistogram: false, palette: { type: 'palette', name: 'default' }, + table: tables.first, }; it('should map auto series to left axis', () => { const formatFactory = jest.fn(); - const groups = getAxesConfiguration([sampleLayer], false, tables, formatFactory); + const groups = getAxesConfiguration([sampleLayer], false, formatFactory); expect(groups.length).toEqual(1); expect(groups[0].position).toEqual('left'); expect(groups[0].series[0].accessor).toEqual('yAccessorId'); @@ -247,7 +248,7 @@ describe('axes_configuration', () => { it('should map auto series to right axis if formatters do not match', () => { const formatFactory = jest.fn(); const twoSeriesLayer = { ...sampleLayer, accessors: ['yAccessorId', 'yAccessorId2'] }; - const groups = getAxesConfiguration([twoSeriesLayer], false, tables, formatFactory); + const groups = getAxesConfiguration([twoSeriesLayer], false, formatFactory); expect(groups.length).toEqual(2); expect(groups[0].position).toEqual('left'); expect(groups[1].position).toEqual('right'); @@ -261,7 +262,7 @@ describe('axes_configuration', () => { ...sampleLayer, accessors: ['yAccessorId', 'yAccessorId2', 'yAccessorId3'], }; - const groups = getAxesConfiguration([threeSeriesLayer], false, tables, formatFactory); + const groups = getAxesConfiguration([threeSeriesLayer], false, formatFactory); expect(groups.length).toEqual(2); expect(groups[0].position).toEqual('left'); expect(groups[1].position).toEqual('right'); @@ -280,7 +281,6 @@ describe('axes_configuration', () => { }, ], false, - tables, formatFactory ); expect(groups.length).toEqual(1); @@ -300,7 +300,6 @@ describe('axes_configuration', () => { }, ], false, - tables, formatFactory ); expect(groups.length).toEqual(2); @@ -324,7 +323,6 @@ describe('axes_configuration', () => { }, ], false, - tables, formatFactory ); expect(formatFactory).toHaveBeenCalledTimes(2); diff --git a/src/plugins/chart_expressions/expression_xy/public/helpers/axes_configuration.ts b/src/plugins/chart_expressions/expression_xy/public/helpers/axes_configuration.ts index 38d2220904226..65f5441d67226 100644 --- a/src/plugins/chart_expressions/expression_xy/public/helpers/axes_configuration.ts +++ b/src/plugins/chart_expressions/expression_xy/public/helpers/axes_configuration.ts @@ -6,22 +6,25 @@ * Side Public License, v 1. */ -import { Datatable } from '@kbn/expressions-plugin/public'; import type { IFieldFormat, SerializedFieldFormat } from '@kbn/field-formats-plugin/common'; import { FormatFactory } from '../types'; -import { AxisExtentConfig, DataLayerConfigResult } from '../../common'; +import { AxisExtentConfig, CommonXYDataLayerConfig, ExtendedYConfig, YConfig } from '../../common'; +import { isDataLayer } from './visualization'; -interface FormattedMetric { +export interface Series { layer: string; accessor: string; +} + +interface FormattedMetric extends Series { fieldFormat: SerializedFieldFormat; } export type GroupsConfiguration = Array<{ - groupId: string; + groupId: 'left' | 'right'; position: 'left' | 'right' | 'bottom' | 'top'; formatter?: IFieldFormat; - series: Array<{ layer: string; accessor: string }>; + series: Series[]; }>; export function isFormatterCompatible( @@ -31,10 +34,7 @@ export function isFormatterCompatible( return formatter1.id === formatter2.id; } -export function groupAxesByType( - layers: DataLayerConfigResult[], - tables?: Record -) { +export function groupAxesByType(layers: CommonXYDataLayerConfig[]) { const series: { auto: FormattedMetric[]; left: FormattedMetric[]; @@ -47,15 +47,19 @@ export function groupAxesByType( bottom: [], }; - layers?.forEach((layer) => { - const table = tables?.[layer.layerId]; + layers.forEach((layer) => { + const { table } = layer; layer.accessors.forEach((accessor) => { + const yConfig: Array | undefined = layer.yConfig; const mode = - layer.yConfig?.find((yAxisConfig) => yAxisConfig.forAccessor === accessor)?.axisMode || - 'auto'; - let formatter: SerializedFieldFormat = table?.columns.find((column) => column.id === accessor) + yConfig?.find((yAxisConfig) => yAxisConfig.forAccessor === accessor)?.axisMode || 'auto'; + let formatter: SerializedFieldFormat = table.columns?.find((column) => column.id === accessor) ?.meta?.params || { id: 'number' }; - if (layer.seriesType.includes('percentage') && formatter.id !== 'percent') { + if ( + isDataLayer(layer) && + layer.seriesType.includes('percentage') && + formatter.id !== 'percent' + ) { formatter = { id: 'percent', params: { @@ -71,10 +75,12 @@ export function groupAxesByType( }); }); + const tablesExist = layers.filter(({ table }) => Boolean(table)).length > 0; + series.auto.forEach((currentSeries) => { if ( series.left.length === 0 || - (tables && + (tablesExist && series.left.every((leftSeries) => isFormatterCompatible(leftSeries.fieldFormat, currentSeries.fieldFormat) )) @@ -82,7 +88,7 @@ export function groupAxesByType( series.left.push(currentSeries); } else if ( series.right.length === 0 || - (tables && + (tablesExist && series.left.every((leftSeries) => isFormatterCompatible(leftSeries.fieldFormat, currentSeries.fieldFormat) )) @@ -98,12 +104,11 @@ export function groupAxesByType( } export function getAxesConfiguration( - layers: DataLayerConfigResult[], + layers: CommonXYDataLayerConfig[], shouldRotate: boolean, - tables?: Record, formatFactory?: FormatFactory ): GroupsConfiguration { - const series = groupAxesByType(layers, tables); + const series = groupAxesByType(layers); const axisGroups: GroupsConfiguration = []; diff --git a/src/plugins/chart_expressions/expression_xy/public/helpers/color_assignment.test.ts b/src/plugins/chart_expressions/expression_xy/public/helpers/color_assignment.test.ts index bd13e3217c2af..8b1bdeeadb834 100644 --- a/src/plugins/chart_expressions/expression_xy/public/helpers/color_assignment.test.ts +++ b/src/plugins/chart_expressions/expression_xy/public/helpers/color_assignment.test.ts @@ -7,76 +7,76 @@ */ import { getColorAssignments } from './color_assignment'; -import type { DataLayerConfigResult, LensMultiTable } from '../../common'; +import type { DataLayerConfig } from '../../common'; import type { FormatFactory } from '../types'; import { LayerTypes } from '../../common/constants'; +import { Datatable } from '@kbn/expressions-plugin'; describe('color_assignment', () => { - const layers: DataLayerConfigResult[] = [ + const tables: Record = { + '1': { + type: 'datatable', + columns: [ + { id: 'split1', name: '', meta: { type: 'number' } }, + { id: 'y1', name: '', meta: { type: 'number' } }, + { id: 'y2', name: '', meta: { type: 'number' } }, + ], + rows: [ + { split1: 1 }, + { split1: 2 }, + { split1: 3 }, + { split1: 1 }, + { split1: 2 }, + { split1: 3 }, + ], + }, + '2': { + type: 'datatable', + columns: [ + { id: 'split2', name: '', meta: { type: 'number' } }, + { id: 'y1', name: '', meta: { type: 'number' } }, + { id: 'y2', name: '', meta: { type: 'number' } }, + ], + rows: [ + { split2: 1 }, + { split2: 2 }, + { split2: 3 }, + { split2: 1 }, + { split2: 2 }, + { split2: 3 }, + ], + }, + }; + + const layers: DataLayerConfig[] = [ { + layerId: 'first', type: 'dataLayer', yScaleType: 'linear', xScaleType: 'linear', isHistogram: true, seriesType: 'bar', palette: { type: 'palette', name: 'palette1' }, - layerId: '1', layerType: LayerTypes.DATA, splitAccessor: 'split1', accessors: ['y1', 'y2'], + table: tables['1'], }, { + layerId: 'second', type: 'dataLayer', yScaleType: 'linear', xScaleType: 'linear', isHistogram: true, seriesType: 'bar', palette: { type: 'palette', name: 'palette2' }, - layerId: '2', layerType: LayerTypes.DATA, splitAccessor: 'split2', accessors: ['y3', 'y4'], + table: tables['2'], }, ]; - const data: LensMultiTable = { - type: 'lens_multitable', - tables: { - '1': { - type: 'datatable', - columns: [ - { id: 'split1', name: '', meta: { type: 'number' } }, - { id: 'y1', name: '', meta: { type: 'number' } }, - { id: 'y2', name: '', meta: { type: 'number' } }, - ], - rows: [ - { split1: 1 }, - { split1: 2 }, - { split1: 3 }, - { split1: 1 }, - { split1: 2 }, - { split1: 3 }, - ], - }, - '2': { - type: 'datatable', - columns: [ - { id: 'split2', name: '', meta: { type: 'number' } }, - { id: 'y1', name: '', meta: { type: 'number' } }, - { id: 'y2', name: '', meta: { type: 'number' } }, - ], - rows: [ - { split2: 1 }, - { split2: 2 }, - { split2: 3 }, - { split2: 1 }, - { split2: 2 }, - { split2: 3 }, - ], - }, - }, - }; - const formatFactory = (() => ({ convert(x: unknown) { @@ -86,7 +86,7 @@ describe('color_assignment', () => { describe('totalSeriesCount', () => { it('should calculate total number of series per palette', () => { - const assignments = getColorAssignments(layers, data, formatFactory); + const assignments = getColorAssignments(layers, formatFactory); // two y accessors, with 3 splitted series expect(assignments.palette1.totalSeriesCount).toEqual(2 * 3); expect(assignments.palette2.totalSeriesCount).toEqual(2 * 3); @@ -95,7 +95,6 @@ describe('color_assignment', () => { it('should calculate total number of series spanning multible layers', () => { const assignments = getColorAssignments( [layers[0], { ...layers[1], palette: layers[0].palette }], - data, formatFactory ); // two y accessors, with 3 splitted series, two times @@ -106,7 +105,6 @@ describe('color_assignment', () => { it('should calculate total number of series for non split series', () => { const assignments = getColorAssignments( [layers[0], { ...layers[1], palette: layers[0].palette, splitAccessor: undefined }], - data, formatFactory ); // two y accessors, with 3 splitted series for the first layer, 2 non splitted y accessors for the second layer @@ -117,15 +115,16 @@ describe('color_assignment', () => { it('should format non-primitive values and count them correctly', () => { const complexObject = { aProp: 123 }; const formatMock = jest.fn((x) => 'formatted'); - const assignments = getColorAssignments( - layers, + const newLayers = [ { - ...data, - tables: { - ...data.tables, - '1': { ...data.tables['1'], rows: [{ split1: complexObject }, { split1: 'abc' }] }, - }, + ...layers[0], + table: { ...tables['1'], rows: [{ split1: complexObject }, { split1: 'abc' }] }, }, + layers[1], + ]; + + const assignments = getColorAssignments( + newLayers, (() => ({ convert: formatMock, @@ -137,26 +136,18 @@ describe('color_assignment', () => { }); it('should handle missing tables', () => { - const assignments = getColorAssignments(layers, { ...data, tables: {} }, formatFactory); + const assignments = getColorAssignments( + layers.map((l) => ({ ...l, table: {} as any })), + formatFactory + ); // if there is no data, just assume a single split expect(assignments.palette1.totalSeriesCount).toEqual(2); }); it('should handle missing columns', () => { - const assignments = getColorAssignments( - layers, - { - ...data, - tables: { - ...data.tables, - '1': { - ...data.tables['1'], - columns: [], - }, - }, - }, - formatFactory - ); + const newLayers = [{ ...layers[0], table: { ...tables['1'], columns: [] } }, layers[1]]; + const assignments = getColorAssignments(newLayers, formatFactory); + // if the split column is missing, just assume a single split expect(assignments.palette1.totalSeriesCount).toEqual(2); }); @@ -164,7 +155,7 @@ describe('color_assignment', () => { describe('getRank', () => { it('should return the correct rank for a series key', () => { - const assignments = getColorAssignments(layers, data, formatFactory); + const assignments = getColorAssignments(layers, formatFactory); // 3 series in front of 2/y2 - 1/y1, 1/y2 and 2/y1 expect(assignments.palette1.getRank(layers[0], '2', 'y2')).toEqual(3); // 1 series in front of 1/y4 - 1/y3 @@ -173,7 +164,7 @@ describe('color_assignment', () => { it('should return the correct rank for a series key spanning multiple layers', () => { const newLayers = [layers[0], { ...layers[1], palette: layers[0].palette }]; - const assignments = getColorAssignments(newLayers, data, formatFactory); + const assignments = getColorAssignments(newLayers, formatFactory); // 3 series in front of 2/y2 - 1/y1, 1/y2 and 2/y1 expect(assignments.palette1.getRank(newLayers[0], '2', 'y2')).toEqual(3); // 2 series in front for the current layer (1/y3, 1/y4), plus all 6 series from the first layer @@ -185,7 +176,7 @@ describe('color_assignment', () => { layers[0], { ...layers[1], palette: layers[0].palette, splitAccessor: undefined }, ]; - const assignments = getColorAssignments(newLayers, data, formatFactory); + const assignments = getColorAssignments(newLayers, formatFactory); // 3 series in front of 2/y2 - 1/y1, 1/y2 and 2/y1 expect(assignments.palette1.getRank(newLayers[0], '2', 'y2')).toEqual(3); // 1 series in front for the current layer (y3), plus all 6 series from the first layer @@ -193,15 +184,16 @@ describe('color_assignment', () => { }); it('should return the correct rank for a series with a non-primitive value', () => { - const assignments = getColorAssignments( - layers, + const newLayers = [ { - ...data, - tables: { - ...data.tables, - '1': { ...data.tables['1'], rows: [{ split1: 'abc' }, { split1: { aProp: 123 } }] }, - }, + ...layers[0], + table: { ...tables['1'], rows: [{ split1: 'abc' }, { split1: { aProp: 123 } }] }, }, + layers[1], + ]; + + const assignments = getColorAssignments( + newLayers, (() => ({ convert: () => 'formatted', @@ -212,26 +204,19 @@ describe('color_assignment', () => { }); it('should handle missing tables', () => { - const assignments = getColorAssignments(layers, { ...data, tables: {} }, formatFactory); + const assignments = getColorAssignments( + layers.map((l) => ({ ...l, table: {} as any })), + formatFactory + ); // if there is no data, assume it is the first splitted series. One series in front - 0/y1 expect(assignments.palette1.getRank(layers[0], '2', 'y2')).toEqual(1); }); it('should handle missing columns', () => { - const assignments = getColorAssignments( - layers, - { - ...data, - tables: { - ...data.tables, - '1': { - ...data.tables['1'], - columns: [], - }, - }, - }, - formatFactory - ); + const newLayers = [{ ...layers[0], table: { ...tables['1'], columns: [] } }, layers[1]]; + + const assignments = getColorAssignments(newLayers, formatFactory); + // if the split column is missing, assume it is the first splitted series. One series in front - 0/y1 expect(assignments.palette1.getRank(layers[0], '2', 'y2')).toEqual(1); }); diff --git a/src/plugins/chart_expressions/expression_xy/public/helpers/color_assignment.ts b/src/plugins/chart_expressions/expression_xy/public/helpers/color_assignment.ts index ee2f5a0325287..e94d22471aba9 100644 --- a/src/plugins/chart_expressions/expression_xy/public/helpers/color_assignment.ts +++ b/src/plugins/chart_expressions/expression_xy/public/helpers/color_assignment.ts @@ -8,10 +8,9 @@ import { uniq, mapValues } from 'lodash'; import { euiLightVars } from '@kbn/ui-theme'; -import type { Datatable } from '@kbn/expressions-plugin'; import { FormatFactory } from '../types'; import { isDataLayer } from './visualization'; -import { DataLayerConfigResult, XYLayerConfigResult } from '../../common'; +import { CommonXYDataLayerConfig, CommonXYLayerConfig } from '../../common'; const isPrimitive = (value: unknown): boolean => value != null && typeof value !== 'object'; @@ -21,40 +20,41 @@ export type ColorAssignments = Record< string, { totalSeriesCount: number; - getRank(sortedLayer: DataLayerConfigResult, seriesKey: string, yAccessor: string): number; + getRank(sortedLayer: CommonXYDataLayerConfig, seriesKey: string, yAccessor: string): number; } >; export function getColorAssignments( - layers: XYLayerConfigResult[], - data: { tables: Record }, + layers: CommonXYLayerConfig[], formatFactory: FormatFactory ): ColorAssignments { - const layersPerPalette: Record = {}; + const layersPerPalette: Record = {}; - layers - .filter((layer): layer is DataLayerConfigResult => isDataLayer(layer)) - .forEach((layer) => { - const palette = layer.palette?.name || 'default'; - if (!layersPerPalette[palette]) { - layersPerPalette[palette] = []; - } - layersPerPalette[palette].push(layer); - }); + layers.forEach((layer) => { + if (!isDataLayer(layer)) { + return; + } + + const palette = layer.palette?.name || 'default'; + if (!layersPerPalette[palette]) { + layersPerPalette[palette] = []; + } + layersPerPalette[palette].push(layer); + }); return mapValues(layersPerPalette, (paletteLayers) => { - const seriesPerLayer = paletteLayers.map((layer, layerIndex) => { + const seriesPerLayer = paletteLayers.map((layer) => { if (!layer.splitAccessor) { return { numberOfSeries: layer.accessors.length, splits: [] }; } const splitAccessor = layer.splitAccessor; - const column = data.tables[layer.layerId]?.columns.find(({ id }) => id === splitAccessor); + const column = layer.table.columns?.find(({ id }) => id === splitAccessor); const columnFormatter = column && formatFactory(column.meta.params); const splits = - !column || !data.tables[layer.layerId] + !column || !layer.table ? [] : uniq( - data.tables[layer.layerId].rows.map((row) => { + layer.table.rows.map((row) => { let value = row[splitAccessor]; if (value && !isPrimitive(value)) { value = columnFormatter?.convert(value) ?? value; @@ -72,8 +72,10 @@ export function getColorAssignments( ); return { totalSeriesCount, - getRank(sortedLayer: DataLayerConfigResult, seriesKey: string, yAccessor: string) { - const layerIndex = paletteLayers.findIndex((l) => sortedLayer.layerId === l.layerId); + getRank(sortedLayer: CommonXYDataLayerConfig, seriesKey: string, yAccessor: string) { + const layerIndex = paletteLayers.findIndex( + (layer) => sortedLayer.layerId === layer.layerId + ); const currentSeriesPerLayer = seriesPerLayer[layerIndex]; const splitRank = currentSeriesPerLayer.splits.indexOf(seriesKey); return ( diff --git a/src/plugins/chart_expressions/expression_xy/public/helpers/data_layers.tsx b/src/plugins/chart_expressions/expression_xy/public/helpers/data_layers.tsx new file mode 100644 index 0000000000000..07af8a3c408c2 --- /dev/null +++ b/src/plugins/chart_expressions/expression_xy/public/helpers/data_layers.tsx @@ -0,0 +1,332 @@ +/* + * Copyright 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 { + AreaSeriesProps, + BarSeriesProps, + ColorVariant, + LineSeriesProps, + ScaleType, + SeriesName, + StackMode, + XYChartSeriesIdentifier, +} from '@elastic/charts'; +import { i18n } from '@kbn/i18n'; +import { + FieldFormat, + FieldFormatParams, + IFieldFormat, + SerializedFieldFormat, +} from '@kbn/field-formats-plugin/common'; +import { Datatable } from '@kbn/expressions-plugin'; +import { PaletteRegistry, SeriesLayer } from '@kbn/coloring'; +import { CommonXYDataLayerConfig, XScaleType } from '../../common'; +import { FormatFactory } from '../types'; +import { getSeriesColor } from './state'; +import { ColorAssignments } from './color_assignment'; +import { GroupsConfiguration } from './axes_configuration'; + +type SeriesSpec = LineSeriesProps & BarSeriesProps & AreaSeriesProps; + +type GetSeriesPropsFn = (config: { + layer: CommonXYDataLayerConfig; + accessor: string; + chartHasMoreThanOneBarSeries?: boolean; + formatFactory: FormatFactory; + colorAssignments: ColorAssignments; + columnToLabelMap: Record; + paletteService: PaletteRegistry; + syncColors?: boolean; + yAxis?: GroupsConfiguration[number]; + timeZone?: string; + emphasizeFitting?: boolean; + fillOpacity?: number; + formattedDatatableInfo: DatatableWithFormatInfo; +}) => SeriesSpec; + +type GetSeriesNameFn = ( + data: XYChartSeriesIdentifier, + config: { + layer: CommonXYDataLayerConfig; + splitHint: SerializedFieldFormat | undefined; + splitFormatter: FieldFormat; + alreadyFormattedColumns: Record; + columnToLabelMap: Record; + } +) => SeriesName; + +type GetColorFn = ( + seriesIdentifier: XYChartSeriesIdentifier, + config: { + layer: CommonXYDataLayerConfig; + accessor: string; + colorAssignments: ColorAssignments; + columnToLabelMap: Record; + paletteService: PaletteRegistry; + syncColors?: boolean; + } +) => string | null; + +export interface DatatableWithFormatInfo { + table: Datatable; + formattedColumns: Record; +} + +export type DatatablesWithFormatInfo = Record; + +export type FormattedDatatables = Record; + +const isPrimitive = (value: unknown): boolean => value != null && typeof value !== 'object'; + +export const getFormattedRow = ( + row: Datatable['rows'][number], + columns: Datatable['columns'], + columnsFormatters: Record, + xAccessor: string | undefined, + xScaleType: XScaleType +): { row: Datatable['rows'][number]; formattedColumns: Record } => + columns.reduce( + (formattedInfo, { id }) => { + const record = formattedInfo.row[id]; + if ( + record != null && + // pre-format values for ordinal x axes because there can only be a single x axis formatter on chart level + (!isPrimitive(record) || (id === xAccessor && xScaleType === 'ordinal')) + ) { + return { + row: { ...formattedInfo.row, [id]: columnsFormatters[id]!.convert(record) }, + formattedColumns: { ...formattedInfo.formattedColumns, [id]: true }, + }; + } + return formattedInfo; + }, + { row, formattedColumns: {} } + ); + +export const getFormattedTable = ( + table: Datatable, + formatFactory: FormatFactory, + xAccessor: string | undefined, + xScaleType: XScaleType +): { table: Datatable; formattedColumns: Record } => { + const columnsFormatters = table.columns.reduce>( + (formatters, { id, meta }) => ({ ...formatters, [id]: formatFactory(meta.params) }), + {} + ); + + const formattedTableInfo = table.rows.reduce<{ + rows: Datatable['rows']; + formattedColumns: Record; + }>( + ({ rows: formattedRows, formattedColumns }, row) => { + const formattedRowInfo = getFormattedRow( + row, + table.columns, + columnsFormatters, + xAccessor, + xScaleType + ); + return { + rows: [...formattedRows, formattedRowInfo.row], + formattedColumns: { ...formattedColumns, ...formattedRowInfo.formattedColumns }, + }; + }, + { + rows: [], + formattedColumns: {}, + } + ); + + return { + table: { ...table, rows: formattedTableInfo.rows }, + formattedColumns: formattedTableInfo.formattedColumns, + }; +}; + +export const getFormattedTablesByLayers = ( + layers: CommonXYDataLayerConfig[], + formatFactory: FormatFactory +): DatatablesWithFormatInfo => + layers.reduce( + (formattedDatatables, { layerId, table, xAccessor, xScaleType }) => ({ + ...formattedDatatables, + [layerId]: getFormattedTable(table, formatFactory, xAccessor, xScaleType), + }), + {} + ); + +const getSeriesName: GetSeriesNameFn = ( + data, + { layer, splitHint, splitFormatter, alreadyFormattedColumns, columnToLabelMap } +) => { + // For multiple y series, the name of the operation is used on each, either: + // * Key - Y name + // * Formatted value - Y name + if (layer.splitAccessor && layer.accessors.length > 1) { + const formatted = alreadyFormattedColumns[layer.splitAccessor]; + const result = data.seriesKeys + .map((key: string | number, i) => { + if (i === 0 && splitHint && layer.splitAccessor && !formatted) { + return splitFormatter.convert(key); + } + return layer.splitAccessor && i === 0 ? key : columnToLabelMap[key] ?? null; + }) + .join(' - '); + return result; + } + + // For formatted split series, format the key + // This handles splitting by dates, for example + if (splitHint) { + if (layer.splitAccessor && alreadyFormattedColumns[layer.splitAccessor]) { + return data.seriesKeys[0]; + } + return splitFormatter.convert(data.seriesKeys[0]); + } + // This handles both split and single-y cases: + // * If split series without formatting, show the value literally + // * If single Y, the seriesKey will be the accessor, so we show the human-readable name + return layer.splitAccessor ? data.seriesKeys[0] : columnToLabelMap[data.seriesKeys[0]] ?? null; +}; + +const getPointConfig = (xAccessor?: string, emphasizeFitting?: boolean) => ({ + visible: !xAccessor, + radius: xAccessor && !emphasizeFitting ? 5 : 0, +}); + +const getLineConfig = () => ({ visible: true, stroke: ColorVariant.Series, opacity: 1, dash: [] }); + +const getColor: GetColorFn = ( + { yAccessor, seriesKeys }, + { layer, accessor, colorAssignments, columnToLabelMap, paletteService, syncColors } +) => { + const overwriteColor = getSeriesColor(layer, accessor); + if (overwriteColor !== null) { + return overwriteColor; + } + const colorAssignment = colorAssignments[layer.palette.name]; + const seriesLayers: SeriesLayer[] = [ + { + name: layer.splitAccessor ? String(seriesKeys[0]) : columnToLabelMap[seriesKeys[0]], + totalSeriesAtDepth: colorAssignment.totalSeriesCount, + rankAtDepth: colorAssignment.getRank(layer, String(seriesKeys[0]), String(yAccessor)), + }, + ]; + return paletteService.get(layer.palette.name).getCategoricalColor( + seriesLayers, + { + maxDepth: 1, + behindText: false, + totalSeries: colorAssignment.totalSeriesCount, + syncColors, + }, + layer.palette.params + ); +}; + +export const getSeriesProps: GetSeriesPropsFn = ({ + layer, + accessor, + chartHasMoreThanOneBarSeries, + colorAssignments, + formatFactory, + columnToLabelMap, + paletteService, + syncColors, + yAxis, + timeZone, + emphasizeFitting, + fillOpacity, + formattedDatatableInfo, +}): SeriesSpec => { + const { table } = layer; + const isStacked = layer.seriesType.includes('stacked'); + const isPercentage = layer.seriesType.includes('percentage'); + const isBarChart = layer.seriesType.includes('bar'); + const enableHistogramMode = + layer.isHistogram && + (isStacked || !layer.splitAccessor) && + (isStacked || !isBarChart || !chartHasMoreThanOneBarSeries); + + const formatter = table?.columns.find((column) => column.id === accessor)?.meta?.params; + const splitHint = table?.columns.find((col) => col.id === layer.splitAccessor)?.meta?.params; + const splitFormatter = formatFactory(splitHint); + + // what if row values are not primitive? That is the case of, for instance, Ranges + // remaps them to their serialized version with the formatHint metadata + // In order to do it we need to make a copy of the table as the raw one is required for more features (filters, etc...) later on + const { table: formattedTable, formattedColumns } = formattedDatatableInfo; + + // For date histogram chart type, we're getting the rows that represent intervals without data. + // To not display them in the legend, they need to be filtered out. + let rows = formattedTable.rows.filter( + (row) => + !(layer.xAccessor && typeof row[layer.xAccessor] === 'undefined') && + !( + layer.splitAccessor && + typeof row[layer.splitAccessor] === 'undefined' && + typeof row[accessor] === 'undefined' + ) + ); + + if (!layer.xAccessor) { + rows = rows.map((row) => ({ + ...row, + unifiedX: i18n.translate('expressionXY.xyChart.emptyXLabel', { + defaultMessage: '(empty)', + }), + })); + } + + return { + splitSeriesAccessors: layer.splitAccessor ? [layer.splitAccessor] : [], + stackAccessors: isStacked ? [layer.xAccessor as string] : [], + id: layer.splitAccessor ? `${layer.splitAccessor}-${accessor}` : `${accessor}`, + xAccessor: layer.xAccessor || 'unifiedX', + yAccessors: [accessor], + data: rows, + xScaleType: layer.xAccessor ? layer.xScaleType : 'ordinal', + yScaleType: + formatter?.id === 'bytes' && layer.yScaleType === ScaleType.Linear + ? ScaleType.LinearBinary + : layer.yScaleType, + color: (series) => + getColor(series, { + layer, + accessor, + colorAssignments, + columnToLabelMap, + paletteService, + syncColors, + }), + groupId: yAxis?.groupId, + enableHistogramMode, + stackMode: isPercentage ? StackMode.Percentage : undefined, + timeZone, + areaSeriesStyle: { + point: getPointConfig(layer.xAccessor, emphasizeFitting), + ...(fillOpacity && { area: { opacity: fillOpacity } }), + ...(emphasizeFitting && { + fit: { area: { opacity: fillOpacity || 0.5 }, line: getLineConfig() }, + }), + }, + lineSeriesStyle: { + point: getPointConfig(layer.xAccessor, emphasizeFitting), + ...(emphasizeFitting && { fit: { line: getLineConfig() } }), + }, + name(d) { + return getSeriesName(d, { + layer, + splitHint, + splitFormatter, + alreadyFormattedColumns: formattedColumns, + columnToLabelMap, + }); + }, + }; +}; diff --git a/src/plugins/chart_expressions/expression_xy/public/helpers/fitting_functions.ts b/src/plugins/chart_expressions/expression_xy/public/helpers/fitting_functions.ts index 43d5ad9b4c19f..4c26caf59d8d3 100644 --- a/src/plugins/chart_expressions/expression_xy/public/helpers/fitting_functions.ts +++ b/src/plugins/chart_expressions/expression_xy/public/helpers/fitting_functions.ts @@ -8,6 +8,7 @@ import { Fit } from '@elastic/charts'; import { EndValue, FittingFunction } from '../../common'; +import { EndValues } from '../../common/constants'; export function getFitEnum(fittingFunction?: FittingFunction | EndValue) { if (fittingFunction) { @@ -17,10 +18,10 @@ export function getFitEnum(fittingFunction?: FittingFunction | EndValue) { } export function getEndValue(endValue?: EndValue) { - if (endValue === 'Nearest') { + if (endValue === EndValues.NEAREST) { return Fit[endValue]; } - if (endValue === 'Zero') { + if (endValue === EndValues.ZERO) { return 0; } return undefined; diff --git a/src/plugins/chart_expressions/expression_xy/public/helpers/icon.ts b/src/plugins/chart_expressions/expression_xy/public/helpers/icon.ts index 57e285a07232f..8b4113b3ada11 100644 --- a/src/plugins/chart_expressions/expression_xy/public/helpers/icon.ts +++ b/src/plugins/chart_expressions/expression_xy/public/helpers/icon.ts @@ -6,6 +6,107 @@ * Side Public License, v 1. */ +import { i18n } from '@kbn/i18n'; +import { TriangleIcon, CircleIcon } from '../icons'; +import { AvailableReferenceLineIcons } from '../../common/constants'; + export function hasIcon(icon: string | undefined): icon is string { return icon != null && icon !== 'empty'; } + +export const iconSet = [ + { + value: AvailableReferenceLineIcons.EMPTY, + label: i18n.translate('expressionXY.xyChart.iconSelect.noIconLabel', { + defaultMessage: 'None', + }), + }, + { + value: AvailableReferenceLineIcons.ASTERISK, + label: i18n.translate('expressionXY.xyChart.iconSelect.asteriskIconLabel', { + defaultMessage: 'Asterisk', + }), + }, + { + value: AvailableReferenceLineIcons.ALERT, + label: i18n.translate('expressionXY.xyChart.iconSelect.alertIconLabel', { + defaultMessage: 'Alert', + }), + }, + { + value: AvailableReferenceLineIcons.BELL, + label: i18n.translate('expressionXY.xyChart.iconSelect.bellIconLabel', { + defaultMessage: 'Bell', + }), + }, + { + value: AvailableReferenceLineIcons.BOLT, + label: i18n.translate('expressionXY.xyChart.iconSelect.boltIconLabel', { + defaultMessage: 'Bolt', + }), + }, + { + value: AvailableReferenceLineIcons.BUG, + label: i18n.translate('expressionXY.xyChart.iconSelect.bugIconLabel', { + defaultMessage: 'Bug', + }), + }, + { + value: AvailableReferenceLineIcons.CIRCLE, + label: i18n.translate('expressionXY.xyChart.iconSelect.circleIconLabel', { + defaultMessage: 'Circle', + }), + icon: CircleIcon, + canFill: true, + }, + + { + value: AvailableReferenceLineIcons.EDITOR_COMMENT, + label: i18n.translate('expressionXY.xyChart.iconSelect.commentIconLabel', { + defaultMessage: 'Comment', + }), + }, + { + value: AvailableReferenceLineIcons.FLAG, + label: i18n.translate('expressionXY.xyChart.iconSelect.flagIconLabel', { + defaultMessage: 'Flag', + }), + }, + { + value: AvailableReferenceLineIcons.HEART, + label: i18n.translate('expressionXY.xyChart.iconSelect.heartLabel', { + defaultMessage: 'Heart', + }), + }, + { + value: AvailableReferenceLineIcons.MAP_MARKER, + label: i18n.translate('expressionXY.xyChart.iconSelect.mapMarkerLabel', { + defaultMessage: 'Map Marker', + }), + }, + { + value: AvailableReferenceLineIcons.PIN_FILLED, + label: i18n.translate('expressionXY.xyChart.iconSelect.mapPinLabel', { + defaultMessage: 'Map Pin', + }), + }, + { + value: AvailableReferenceLineIcons.STAR_EMPTY, + label: i18n.translate('expressionXY.xyChart.iconSelect.starLabel', { defaultMessage: 'Star' }), + }, + { + value: AvailableReferenceLineIcons.TAG, + label: i18n.translate('expressionXY.xyChart.iconSelect.tagIconLabel', { + defaultMessage: 'Tag', + }), + }, + { + value: AvailableReferenceLineIcons.TRIANGLE, + label: i18n.translate('expressionXY.xyChart.iconSelect.triangleIconLabel', { + defaultMessage: 'Triangle', + }), + icon: TriangleIcon, + shouldRotate: true, + canFill: true, + }, +]; diff --git a/src/plugins/chart_expressions/expression_xy/public/helpers/index.ts b/src/plugins/chart_expressions/expression_xy/public/helpers/index.ts index 2bb3a5a927774..773ae4ee22d94 100644 --- a/src/plugins/chart_expressions/expression_xy/public/helpers/index.ts +++ b/src/plugins/chart_expressions/expression_xy/public/helpers/index.ts @@ -14,5 +14,5 @@ export * from './fitting_functions'; export * from './axes_configuration'; export * from './icon'; export * from './color_assignment'; -export * from './annotations_icon_set'; export * from './annotations'; +export * from './data_layers'; diff --git a/src/plugins/chart_expressions/expression_xy/public/helpers/interval.test.ts b/src/plugins/chart_expressions/expression_xy/public/helpers/interval.test.ts index 0fe979b8c3fc1..6721c293dbe57 100644 --- a/src/plugins/chart_expressions/expression_xy/public/helpers/interval.test.ts +++ b/src/plugins/chart_expressions/expression_xy/public/helpers/interval.test.ts @@ -6,32 +6,36 @@ * Side Public License, v 1. */ -import { DataLayerConfigResult, XYChartProps } from '../../common'; +import { DataLayerConfig, XYChartProps } from '../../common'; import { sampleArgs } from '../../common/__mocks__'; import { calculateMinInterval } from './interval'; describe('calculateMinInterval', () => { let xyProps: XYChartProps; - + let layer: DataLayerConfig; beforeEach(() => { - xyProps = sampleArgs(); - (xyProps.args.layers[0] as DataLayerConfigResult).xScaleType = 'time'; + const { layers, ...restArgs } = sampleArgs().args; + + xyProps = { args: { ...restArgs, layers } }; + layer = xyProps.args.layers[0] as DataLayerConfig; + layer.xScaleType = 'time'; }); it('should use first valid layer and determine interval', async () => { - xyProps.data.tables.first.columns[2].meta.source = 'esaggs'; - xyProps.data.tables.first.columns[2].meta.sourceParams = { + layer.table.columns[2].meta.source = 'esaggs'; + layer.table.columns[2].meta.sourceParams = { type: 'date_histogram', params: { used_interval: '5m', }, }; + xyProps.args.layers[0] = layer; const result = await calculateMinInterval(xyProps); expect(result).toEqual(5 * 60 * 1000); }); it('should return interval of number histogram if available on first x axis columns', async () => { - (xyProps.args.layers[0] as DataLayerConfigResult).xScaleType = 'linear'; - xyProps.data.tables.first.columns[2].meta = { + layer.xScaleType = 'linear'; + layer.table.columns[2].meta = { source: 'esaggs', type: 'number', field: 'someField', @@ -43,19 +47,22 @@ describe('calculateMinInterval', () => { }, }, }; + xyProps.args.layers[0] = layer; const result = await calculateMinInterval(xyProps); expect(result).toEqual(5); }); it('should return undefined if data table is empty', async () => { - xyProps.data.tables.first.rows = []; - xyProps.data.tables.first.columns[2].meta.source = 'esaggs'; - xyProps.data.tables.first.columns[2].meta.sourceParams = { + layer.table.rows = []; + layer.table.columns[2].meta.source = 'esaggs'; + layer.table.columns[2].meta.sourceParams = { type: 'date_histogram', params: { used_interval: '5m', }, }; + + xyProps.args.layers[0] = layer; const result = await calculateMinInterval(xyProps); expect(result).toEqual(undefined); }); @@ -66,14 +73,16 @@ describe('calculateMinInterval', () => { }); it('should return undefined if date column is not found', async () => { - xyProps.data.tables.first.columns.splice(2, 1); + layer.table.columns.splice(2, 1); + xyProps.args.layers[0] = layer; const result = await calculateMinInterval(xyProps); expect(result).toEqual(undefined); }); it('should return undefined if x axis is not a date', async () => { - (xyProps.args.layers[0] as DataLayerConfigResult).xScaleType = 'ordinal'; - xyProps.data.tables.first.columns.splice(2, 1); + layer.xScaleType = 'ordinal'; + xyProps.args.layers[0] = layer; + xyProps.args.layers[0].table.columns.splice(2, 1); const result = await calculateMinInterval(xyProps); expect(result).toEqual(undefined); }); diff --git a/src/plugins/chart_expressions/expression_xy/public/helpers/interval.ts b/src/plugins/chart_expressions/expression_xy/public/helpers/interval.ts index b81fcd33fccad..17e7a9c2aba32 100644 --- a/src/plugins/chart_expressions/expression_xy/public/helpers/interval.ts +++ b/src/plugins/chart_expressions/expression_xy/public/helpers/interval.ts @@ -11,11 +11,11 @@ import { XYChartProps } from '../../common'; import { getFilteredLayers } from './layers'; import { isDataLayer } from './visualization'; -export function calculateMinInterval({ args: { layers }, data }: XYChartProps) { - const filteredLayers = getFilteredLayers(layers, data); +export function calculateMinInterval({ args: { layers } }: XYChartProps) { + const filteredLayers = getFilteredLayers(layers); if (filteredLayers.length === 0) return; const isTimeViz = filteredLayers.every((l) => isDataLayer(l) && l.xScaleType === 'time'); - const xColumn = data.tables[filteredLayers[0].layerId].columns.find( + const xColumn = filteredLayers[0].table.columns.find( (column) => isDataLayer(filteredLayers[0]) && column.id === filteredLayers[0].xAccessor ); diff --git a/src/plugins/chart_expressions/expression_xy/public/helpers/layers.ts b/src/plugins/chart_expressions/expression_xy/public/helpers/layers.ts index be1701e6b6e4b..4408ebd3feb84 100644 --- a/src/plugins/chart_expressions/expression_xy/public/helpers/layers.ts +++ b/src/plugins/chart_expressions/expression_xy/public/helpers/layers.ts @@ -6,24 +6,42 @@ * Side Public License, v 1. */ -import { LensMultiTable } from '../../common'; -import { DataLayerConfigResult, XYLayerConfigResult } from '../../common/types'; -import { getDataLayers } from './visualization'; +import { Datatable } from '@kbn/expressions-plugin/common'; +import { + CommonXYDataLayerConfig, + CommonXYLayerConfig, + CommonXYReferenceLineLayerConfig, +} from '../../common/types'; +import { isDataLayer, isReferenceLayer } from './visualization'; + +export function getFilteredLayers(layers: CommonXYLayerConfig[]) { + return layers.filter( + (layer): layer is CommonXYReferenceLineLayerConfig | CommonXYDataLayerConfig => { + let table: Datatable | undefined; + let accessors: string[] = []; + let xAccessor: undefined | string | number; + let splitAccessor: undefined | string | number; + + if (isDataLayer(layer)) { + xAccessor = layer.xAccessor; + splitAccessor = layer.splitAccessor; + } + + if (isDataLayer(layer) || isReferenceLayer(layer)) { + table = layer.table; + accessors = layer.accessors; + } -export function getFilteredLayers(layers: XYLayerConfigResult[], data: LensMultiTable) { - return getDataLayers(layers).filter( - (layer): layer is DataLayerConfigResult => { - const { layerId, xAccessor, accessors, splitAccessor } = layer; return !( !accessors.length || - !data.tables[layerId] || - data.tables[layerId].rows.length === 0 || + !table || + table.rows.length === 0 || (xAccessor && - data.tables[layerId].rows.every((row) => typeof row[xAccessor] === 'undefined')) || + table.rows.every((row) => xAccessor && typeof row[xAccessor] === 'undefined')) || // stacked percentage bars have no xAccessors but splitAccessor with undefined values in them when empty (!xAccessor && splitAccessor && - data.tables[layerId].rows.every((row) => typeof row[splitAccessor] === 'undefined')) + table.rows.every((row) => splitAccessor && typeof row[splitAccessor] === 'undefined')) ); } ); diff --git a/src/plugins/chart_expressions/expression_xy/public/helpers/state.ts b/src/plugins/chart_expressions/expression_xy/public/helpers/state.ts index a5cd66f178b63..e2f95491dbce8 100644 --- a/src/plugins/chart_expressions/expression_xy/public/helpers/state.ts +++ b/src/plugins/chart_expressions/expression_xy/public/helpers/state.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import type { SeriesType, XYLayerConfigResult, YConfig } from '../../common'; +import type { CommonXYLayerConfig, SeriesType, ExtendedYConfig, YConfig } from '../../common'; import { getDataLayers, isAnnotationsLayer, isDataLayer } from './visualization'; export function isHorizontalSeries(seriesType: SeriesType) { @@ -21,16 +21,14 @@ export function isStackedChart(seriesType: SeriesType) { return seriesType.includes('stacked'); } -export function isHorizontalChart(layers: XYLayerConfigResult[]) { +export function isHorizontalChart(layers: CommonXYLayerConfig[]) { return getDataLayers(layers).every((l) => isHorizontalSeries(l.seriesType)); } -export const getSeriesColor = (layer: XYLayerConfigResult, accessor: string) => { +export const getSeriesColor = (layer: CommonXYLayerConfig, accessor: string) => { if ((isDataLayer(layer) && layer.splitAccessor) || isAnnotationsLayer(layer)) { return null; } - - return ( - layer?.yConfig?.find((yConfig: YConfig) => yConfig.forAccessor === accessor)?.color || null - ); + const yConfig: Array | undefined = layer?.yConfig; + return yConfig?.find((yConf) => yConf.forAccessor === accessor)?.color || null; }; diff --git a/src/plugins/chart_expressions/expression_xy/public/helpers/visualization.ts b/src/plugins/chart_expressions/expression_xy/public/helpers/visualization.ts index af2e80948ffdf..db0b431d56fac 100644 --- a/src/plugins/chart_expressions/expression_xy/public/helpers/visualization.ts +++ b/src/plugins/chart_expressions/expression_xy/public/helpers/visualization.ts @@ -6,38 +6,40 @@ * Side Public License, v 1. */ +import { LayerTypes } from '../../common/constants'; import { - DataLayerConfigResult, - ReferenceLineLayerConfigResult, - XYLayerConfigResult, - AnnotationLayerConfigResult, + CommonXYLayerConfig, + CommonXYDataLayerConfig, + CommonXYReferenceLineLayerConfig, + CommonXYAnnotationLayerConfig, } from '../../common/types'; -import { LayerTypes } from '../../common/constants'; -export const isDataLayer = (layer: XYLayerConfigResult): layer is DataLayerConfigResult => +export const isDataLayer = (layer: CommonXYLayerConfig): layer is CommonXYDataLayerConfig => layer.layerType === LayerTypes.DATA || !layer.layerType; -export const getDataLayers = (layers: XYLayerConfigResult[]) => - (layers || []).filter((layer): layer is DataLayerConfigResult => isDataLayer(layer)); +export const getDataLayers = (layers: CommonXYLayerConfig[]) => + (layers || []).filter((layer): layer is CommonXYDataLayerConfig => isDataLayer(layer)); export const isReferenceLayer = ( - layer: XYLayerConfigResult -): layer is ReferenceLineLayerConfigResult => layer.layerType === LayerTypes.REFERENCELINE; + layer: CommonXYLayerConfig +): layer is CommonXYReferenceLineLayerConfig => layer.layerType === LayerTypes.REFERENCELINE; -export const getReferenceLayers = (layers: XYLayerConfigResult[]) => - (layers || []).filter((layer): layer is ReferenceLineLayerConfigResult => +export const getReferenceLayers = (layers: CommonXYLayerConfig[]) => + (layers || []).filter((layer): layer is CommonXYReferenceLineLayerConfig => isReferenceLayer(layer) ); const isAnnotationLayerCommon = ( - layer: XYLayerConfigResult -): layer is AnnotationLayerConfigResult => layer.layerType === LayerTypes.ANNOTATIONS; + layer: CommonXYLayerConfig +): layer is CommonXYAnnotationLayerConfig => layer.layerType === LayerTypes.ANNOTATIONS; export const isAnnotationsLayer = ( - layer: XYLayerConfigResult -): layer is AnnotationLayerConfigResult => isAnnotationLayerCommon(layer); + layer: CommonXYLayerConfig +): layer is CommonXYAnnotationLayerConfig => isAnnotationLayerCommon(layer); export const getAnnotationsLayers = ( - layers: XYLayerConfigResult[] -): AnnotationLayerConfigResult[] => - (layers || []).filter((layer): layer is AnnotationLayerConfigResult => isAnnotationsLayer(layer)); + layers: CommonXYLayerConfig[] +): CommonXYAnnotationLayerConfig[] => + (layers || []).filter((layer): layer is CommonXYAnnotationLayerConfig => + isAnnotationsLayer(layer) + ); diff --git a/src/plugins/chart_expressions/expression_xy/public/plugin.ts b/src/plugins/chart_expressions/expression_xy/public/plugin.ts index d08ffc0fd2ec6..5e68d2c621894 100755 --- a/src/plugins/chart_expressions/expression_xy/public/plugin.ts +++ b/src/plugins/chart_expressions/expression_xy/public/plugin.ts @@ -16,17 +16,22 @@ import { EventAnnotationPluginSetup } from '@kbn/event-annotation-plugin/public' import { ExpressionXyPluginSetup, ExpressionXyPluginStart, SetupDeps } from './types'; import { xyVisFunction, + layeredXyVisFunction, + dataLayerFunction, + extendedDataLayerFunction, yAxisConfigFunction, + extendedYAxisConfigFunction, legendConfigFunction, gridlinesConfigFunction, - dataLayerConfigFunction, axisExtentConfigFunction, tickLabelsConfigFunction, - annotationLayerConfigFunction, + referenceLineLayerFunction, + extendedReferenceLineLayerFunction, + annotationLayerFunction, labelsOrientationConfigFunction, - referenceLineLayerConfigFunction, axisTitlesVisibilityConfigFunction, -} from '../common'; + extendedAnnotationLayerFunction, +} from '../common/expression_functions'; import { GetStartDepsFn, getXyChartRenderer } from './expression_renderers'; export interface XYPluginStartDependencies { @@ -51,16 +56,21 @@ export class ExpressionXyPlugin { { expressions, charts }: SetupDeps ): ExpressionXyPluginSetup { expressions.registerFunction(yAxisConfigFunction); + expressions.registerFunction(extendedYAxisConfigFunction); expressions.registerFunction(legendConfigFunction); expressions.registerFunction(gridlinesConfigFunction); - expressions.registerFunction(dataLayerConfigFunction); + expressions.registerFunction(dataLayerFunction); + expressions.registerFunction(extendedDataLayerFunction); expressions.registerFunction(axisExtentConfigFunction); expressions.registerFunction(tickLabelsConfigFunction); - expressions.registerFunction(annotationLayerConfigFunction); + expressions.registerFunction(annotationLayerFunction); + expressions.registerFunction(extendedAnnotationLayerFunction); expressions.registerFunction(labelsOrientationConfigFunction); - expressions.registerFunction(referenceLineLayerConfigFunction); + expressions.registerFunction(referenceLineLayerFunction); + expressions.registerFunction(extendedReferenceLineLayerFunction); expressions.registerFunction(axisTitlesVisibilityConfigFunction); expressions.registerFunction(xyVisFunction); + expressions.registerFunction(layeredXyVisFunction); const getStartDeps: GetStartDepsFn = async () => { const [coreStart, deps] = await core.getStartServices(); diff --git a/src/plugins/chart_expressions/expression_xy/server/plugin.ts b/src/plugins/chart_expressions/expression_xy/server/plugin.ts index c16bd2eb28161..37252a7296580 100755 --- a/src/plugins/chart_expressions/expression_xy/server/plugin.ts +++ b/src/plugins/chart_expressions/expression_xy/server/plugin.ts @@ -12,16 +12,21 @@ import { ExpressionXyPluginSetup, ExpressionXyPluginStart } from './types'; import { xyVisFunction, yAxisConfigFunction, + extendedYAxisConfigFunction, legendConfigFunction, gridlinesConfigFunction, - dataLayerConfigFunction, + dataLayerFunction, axisExtentConfigFunction, tickLabelsConfigFunction, - annotationLayerConfigFunction, + annotationLayerFunction, labelsOrientationConfigFunction, - referenceLineLayerConfigFunction, + referenceLineLayerFunction, axisTitlesVisibilityConfigFunction, -} from '../common'; + extendedDataLayerFunction, + extendedReferenceLineLayerFunction, + layeredXyVisFunction, + extendedAnnotationLayerFunction, +} from '../common/expression_functions'; import { SetupDeps } from './types'; export class ExpressionXyPlugin @@ -29,16 +34,21 @@ export class ExpressionXyPlugin { public setup(core: CoreSetup, { expressions }: SetupDeps) { expressions.registerFunction(yAxisConfigFunction); + expressions.registerFunction(extendedYAxisConfigFunction); expressions.registerFunction(legendConfigFunction); expressions.registerFunction(gridlinesConfigFunction); - expressions.registerFunction(dataLayerConfigFunction); + expressions.registerFunction(dataLayerFunction); + expressions.registerFunction(extendedDataLayerFunction); expressions.registerFunction(axisExtentConfigFunction); expressions.registerFunction(tickLabelsConfigFunction); - expressions.registerFunction(annotationLayerConfigFunction); + expressions.registerFunction(annotationLayerFunction); + expressions.registerFunction(extendedAnnotationLayerFunction); expressions.registerFunction(labelsOrientationConfigFunction); - expressions.registerFunction(referenceLineLayerConfigFunction); + expressions.registerFunction(referenceLineLayerFunction); + expressions.registerFunction(extendedReferenceLineLayerFunction); expressions.registerFunction(axisTitlesVisibilityConfigFunction); expressions.registerFunction(xyVisFunction); + expressions.registerFunction(layeredXyVisFunction); } public start(core: CoreStart) {} diff --git a/src/plugins/console/public/application/containers/console_history/history_viewer.tsx b/src/plugins/console/public/application/containers/console_history/history_viewer.tsx index 605f9a254f228..11f4b0a99a993 100644 --- a/src/plugins/console/public/application/containers/console_history/history_viewer.tsx +++ b/src/plugins/console/public/application/containers/console_history/history_viewer.tsx @@ -17,6 +17,7 @@ import * as InputMode from '../../models/legacy_core_editor/mode/input'; const inputMode = new InputMode.Mode(); import * as editor from '../../models/legacy_core_editor'; import { applyCurrentSettings } from '../editor/legacy/console_editor/apply_editor_settings'; +import { formatRequestBodyDoc } from '../../../lib/utils'; interface Props { settings: DevToolsSettings; @@ -41,7 +42,9 @@ export function HistoryViewer({ settings, req }: Props) { if (viewerRef.current) { const { current: viewer } = viewerRef; if (req) { - const s = req.method + ' ' + req.endpoint + '\n' + (req.data || ''); + const indent = true; + const formattedData = req.data ? formatRequestBodyDoc([req.data], indent).data : ''; + const s = req.method + ' ' + req.endpoint + '\n' + formattedData; viewer.update(s, inputMode); viewer.clearSelection(); } else { diff --git a/src/plugins/console/public/application/hooks/use_restore_request_from_history/restore_request_from_history.ts b/src/plugins/console/public/application/hooks/use_restore_request_from_history/restore_request_from_history.ts index 85c9cf6b9f014..ca8a118e767b6 100644 --- a/src/plugins/console/public/application/hooks/use_restore_request_from_history/restore_request_from_history.ts +++ b/src/plugins/console/public/application/hooks/use_restore_request_from_history/restore_request_from_history.ts @@ -9,6 +9,7 @@ import RowParser from '../../../lib/row_parser'; import { ESRequest } from '../../../types'; import { SenseEditor } from '../../models/sense_editor'; +import { formatRequestBodyDoc } from '../../../lib/utils'; export function restoreRequestFromHistory(editor: SenseEditor, req: ESRequest) { const coreEditor = editor.getCoreEditor(); @@ -32,7 +33,9 @@ export function restoreRequestFromHistory(editor: SenseEditor, req: ESRequest) { let s = prefix + req.method + ' ' + req.endpoint; if (req.data) { - s += '\n' + req.data; + const indent = true; + const formattedData = formatRequestBodyDoc([req.data], indent); + s += '\n' + formattedData.data; } s += suffix; diff --git a/src/plugins/controls/public/control_types/range_slider/range_slider_popover.tsx b/src/plugins/controls/public/control_types/range_slider/range_slider_popover.tsx index a51b46d98ff85..1bb7501f7104f 100644 --- a/src/plugins/controls/public/control_types/range_slider/range_slider_popover.tsx +++ b/src/plugins/controls/public/control_types/range_slider/range_slider_popover.tsx @@ -45,6 +45,8 @@ export const RangeSliderPopover: FC = ({ fieldFormatter, }) => { const [isPopoverOpen, setIsPopoverOpen] = useState(false); + const [rangeSliderMin, setRangeSliderMin] = useState(-Infinity); + const [rangeSliderMax, setRangeSliderMax] = useState(Infinity); const rangeRef = useRef(null); let errorMessage = ''; let helpText = ''; @@ -79,17 +81,6 @@ export const RangeSliderPopover: FC = ({ errorMessage = RangeSliderStrings.errors.getUpperLessThanLowerErrorMessage(); } - const rangeSliderMin = Math.min( - roundedMin, - isNaN(lowerBoundValue) ? Infinity : lowerBoundValue, - isNaN(upperBoundValue) ? Infinity : upperBoundValue - ); - const rangeSliderMax = Math.max( - roundedMax, - isNaN(lowerBoundValue) ? -Infinity : lowerBoundValue, - isNaN(upperBoundValue) ? -Infinity : upperBoundValue - ); - const displayedValue = [ hasLowerBoundSelection ? String(lowerBoundValue) : hasAvailableRange ? String(roundedMin) : '', hasUpperBoundSelection ? String(upperBoundValue) : hasAvailableRange ? String(roundedMax) : '', @@ -106,7 +97,27 @@ export const RangeSliderPopover: FC = ({ const button = ( + + + ) : null} + + + + + + + + ) : ( + + )} + + + ); +}; diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/components/bulk_actions.test.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/components/bulk_actions.test.tsx new file mode 100644 index 0000000000000..9ddf8608fc015 --- /dev/null +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/components/bulk_actions.test.tsx @@ -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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React from 'react'; + +import { ThemeProvider } from 'styled-components'; + +import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public'; + +import { coreMock } from '@kbn/core/public/mocks'; +import { registerTestBed } from '@kbn/test-jest-helpers'; + +import type { Agent } from '../../../../types'; + +import { FleetStatusProvider, ConfigContext, KibanaVersionContext } from '../../../../../../hooks'; + +import { getMockTheme } from '../../../../../../mocks'; + +import { AgentBulkActions } from './bulk_actions'; +import type { Props } from './bulk_actions'; + +const mockTheme = getMockTheme({ + eui: { + euiSize: '10px', + }, +}); + +const TestComponent = (props: Props) => ( + + + + + + + + + + + +); + +describe('AgentBulkActions', () => { + it('should show no Actions button when no agent is selected', async () => { + const selectedAgents: Agent[] = []; + const props: Props = { + totalAgents: 10, + totalInactiveAgents: 2, + selectionMode: 'manual', + currentQuery: '', + selectedAgents, + refreshAgents: () => undefined, + }; + const testBed = registerTestBed(TestComponent)(props); + const { exists } = testBed; + + expect(exists('agentBulkActionsButton')).toBe(false); + }); + + it('should show an Actions button when at least an agent is selected', async () => { + const selectedAgents: Agent[] = [ + { + id: 'Agent1', + status: 'online', + packages: ['system'], + type: 'PERMANENT', + active: true, + enrolled_at: `${Date.now()}`, + user_provided_metadata: {}, + local_metadata: {}, + }, + ]; + const props: Props = { + totalAgents: 10, + totalInactiveAgents: 2, + selectionMode: 'manual', + currentQuery: '', + selectedAgents, + refreshAgents: () => undefined, + }; + const testBed = registerTestBed(TestComponent)(props); + const { exists } = testBed; + + expect(exists('agentBulkActionsButton')).not.toBeNull(); + }); +}); diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/components/bulk_actions.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/components/bulk_actions.tsx index 6fd34f0239996..a2515b51814ee 100644 --- a/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/components/bulk_actions.tsx +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/components/bulk_actions.tsx @@ -10,16 +10,14 @@ import styled from 'styled-components'; import { EuiFlexGroup, EuiFlexItem, - EuiText, EuiPopover, EuiContextMenu, - EuiButtonEmpty, + EuiButton, EuiIcon, EuiPortal, } from '@elastic/eui'; -import { FormattedMessage, FormattedNumber } from '@kbn/i18n-react'; +import { FormattedMessage } from '@kbn/i18n-react'; -import { SO_SEARCH_LIMIT } from '../../../../constants'; import type { Agent } from '../../../../types'; import { AgentReassignAgentPolicyModal, @@ -28,43 +26,26 @@ import { } from '../../components'; import { useKibanaVersion } from '../../../../hooks'; -const Divider = styled.div` - width: 0; - height: ${(props) => props.theme.eui.euiSizeL}; - border-left: ${(props) => props.theme.eui.euiBorderThin}; -`; +import type { SelectionMode } from './types'; const FlexItem = styled(EuiFlexItem)` height: ${(props) => props.theme.eui.euiSizeL}; `; - -const Button = styled(EuiButtonEmpty)` - .euiButtonEmpty__text { - font-size: ${(props) => props.theme.eui.euiFontSizeXS}; - } -`; - -export type SelectionMode = 'manual' | 'query'; - -export const AgentBulkActions: React.FunctionComponent<{ +export interface Props { totalAgents: number; totalInactiveAgents: number; - selectableAgents: number; selectionMode: SelectionMode; - setSelectionMode: (mode: SelectionMode) => void; currentQuery: string; selectedAgents: Agent[]; - setSelectedAgents: (agents: Agent[]) => void; refreshAgents: () => void; -}> = ({ +} + +export const AgentBulkActions: React.FunctionComponent = ({ totalAgents, totalInactiveAgents, - selectableAgents, selectionMode, - setSelectionMode, currentQuery, selectedAgents, - setSelectedAgents, refreshAgents, }) => { const kibanaVersion = useKibanaVersion(); @@ -92,6 +73,7 @@ export const AgentBulkActions: React.FunctionComponent<{ name: ( ), @@ -106,6 +88,7 @@ export const AgentBulkActions: React.FunctionComponent<{ name: ( ), @@ -120,6 +103,7 @@ export const AgentBulkActions: React.FunctionComponent<{ name: ( ), @@ -130,29 +114,10 @@ export const AgentBulkActions: React.FunctionComponent<{ setIsUpgradeModalOpen(true); }, }, - { - name: ( - - ), - icon: , - onClick: () => { - closeMenu(); - setSelectionMode('manual'); - setSelectedAgents([]); - }, - }, ], }, ]; - const showSelectEverything = - selectionMode === 'manual' && - selectedAgents.length === selectableAgents && - selectableAgents < totalAgents; - const totalActiveAgents = totalAgents - totalInactiveAgents; const agentCount = selectionMode === 'manual' ? selectedAgents.length : totalActiveAgents; const agents = selectionMode === 'manual' ? selectedAgents : currentQuery; @@ -196,51 +161,25 @@ export const AgentBulkActions: React.FunctionComponent<{ )} - - - {totalAgents > SO_SEARCH_LIMIT ? ( - , - total: , - }} - /> - ) : ( - - )} - - {(selectionMode === 'manual' && selectedAgents.length) || (selectionMode === 'query' && totalAgents > 0) ? ( <> - - - - + } isOpen={isMenuOpen} closePopover={closeMenu} @@ -250,22 +189,6 @@ export const AgentBulkActions: React.FunctionComponent<{ - {showSelectEverything ? ( - - - - ) : null} ) : ( diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/components/empty_prompt.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/components/empty_prompt.tsx new file mode 100644 index 0000000000000..256ab2a0bacd1 --- /dev/null +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/components/empty_prompt.tsx @@ -0,0 +1,44 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React from 'react'; +import { EuiButton, EuiEmptyPrompt } from '@elastic/eui'; +import { FormattedMessage } from '@kbn/i18n-react'; + +export const EmptyPrompt: React.FunctionComponent<{ + hasFleetAllPrivileges: boolean; + setEnrollmentFlyoutState: ( + value: React.SetStateAction<{ + isOpen: boolean; + selectedPolicyId?: string | undefined; + }> + ) => void; +}> = ({ hasFleetAllPrivileges, setEnrollmentFlyoutState }) => { + return ( + + + + } + actions={ + hasFleetAllPrivileges ? ( + setEnrollmentFlyoutState({ isOpen: true })} + > + + + ) : null + } + /> + ); +}; diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/components/search_and_filter_bar.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/components/search_and_filter_bar.tsx index 8965ae9bbc44f..a511c2dc9f3da 100644 --- a/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/components/search_and_filter_bar.tsx +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/components/search_and_filter_bar.tsx @@ -19,10 +19,13 @@ import { import { i18n } from '@kbn/i18n'; import { FormattedMessage } from '@kbn/i18n-react'; -import type { AgentPolicy } from '../../../../types'; +import type { Agent, AgentPolicy } from '../../../../types'; import { AgentEnrollmentFlyout, SearchBar } from '../../../../components'; import { AGENTS_INDEX } from '../../../../constants'; +import { AgentBulkActions } from './bulk_actions'; +import type { SelectionMode } from './types'; + const statusFilters = [ { status: 'healthy', @@ -67,6 +70,12 @@ export const SearchAndFilterBar: React.FunctionComponent<{ onSelectedStatusChange: (selectedStatus: string[]) => void; showUpgradeable: boolean; onShowUpgradeableChange: (showUpgradeable: boolean) => void; + totalAgents: number; + totalInactiveAgents: number; + selectionMode: SelectionMode; + currentQuery: string; + selectedAgents: Agent[]; + refreshAgents: () => void; }> = ({ agentPolicies, draftKuery, @@ -78,6 +87,12 @@ export const SearchAndFilterBar: React.FunctionComponent<{ onSelectedStatusChange, showUpgradeable, onShowUpgradeableChange, + totalAgents, + totalInactiveAgents, + selectionMode, + currentQuery, + selectedAgents, + refreshAgents, }) => { const [isEnrollmentFlyoutOpen, setIsEnrollmentFlyoutOpen] = useState(false); @@ -230,6 +245,16 @@ export const SearchAndFilterBar: React.FunctionComponent<{ + + + diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/components/table_header.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/components/table_header.tsx index ff809d360e744..4e2f058596cf0 100644 --- a/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/components/table_header.tsx +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/components/table_header.tsx @@ -11,51 +11,41 @@ import { EuiFlexGroup, EuiFlexItem, EuiSpacer } from '@elastic/eui'; import type { Agent, SimplifiedAgentStatus } from '../../../../types'; import { AgentStatusBar } from './status_bar'; -import { AgentBulkActions } from './bulk_actions'; +import { AgentsSelectionStatus } from './agents_selection_status'; import {} from '@elastic/eui'; import { AgentStatusBadges } from './status_badges'; - -export type SelectionMode = 'manual' | 'query'; +import type { SelectionMode } from './types'; export const AgentTableHeader: React.FunctionComponent<{ agentStatus?: { [k in SimplifiedAgentStatus]: number }; showInactive: boolean; totalAgents: number; - totalInactiveAgents: number; selectableAgents: number; selectionMode: SelectionMode; setSelectionMode: (mode: SelectionMode) => void; - currentQuery: string; selectedAgents: Agent[]; setSelectedAgents: (agents: Agent[]) => void; - refreshAgents: () => void; }> = ({ agentStatus, totalAgents, - totalInactiveAgents, selectableAgents, selectionMode, setSelectionMode, - currentQuery, selectedAgents, setSelectedAgents, - refreshAgents, showInactive, }) => { return ( <> - diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/components/table_row_actions.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/components/table_row_actions.tsx new file mode 100644 index 0000000000000..be620f0044cd1 --- /dev/null +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/components/table_row_actions.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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { useState } from 'react'; +import { EuiContextMenuItem } from '@elastic/eui'; +import { FormattedMessage } from '@kbn/i18n-react'; + +import type { Agent, AgentPolicy } from '../../../../types'; +import { useAuthz, useLink, useKibanaVersion } from '../../../../hooks'; +import { ContextMenuActions } from '../../../../components'; +import { isAgentUpgradeable } from '../../../../services'; + +export const TableRowActions: React.FunctionComponent<{ + agent: Agent; + agentPolicy?: AgentPolicy; + onReassignClick: () => void; + onUnenrollClick: () => void; + onUpgradeClick: () => void; +}> = ({ agent, agentPolicy, onReassignClick, onUnenrollClick, onUpgradeClick }) => { + const { getHref } = useLink(); + const hasFleetAllPrivileges = useAuthz().fleet.all; + + const isUnenrolling = agent.status === 'unenrolling'; + const kibanaVersion = useKibanaVersion(); + const [isMenuOpen, setIsMenuOpen] = useState(false); + const menuItems = [ + + + , + ]; + + if (agentPolicy?.is_managed === false) { + menuItems.push( + { + onReassignClick(); + }} + disabled={!agent.active} + key="reassignPolicy" + > + + , + { + onUnenrollClick(); + }} + > + {isUnenrolling ? ( + + ) : ( + + )} + , + { + onUpgradeClick(); + }} + > + + + ); + } + return ( + setIsMenuOpen(isOpen)} + items={menuItems} + /> + ); +}; diff --git a/x-pack/plugins/data_enhanced/public/search/ui/search_session_indicator/components/index.ts b/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/components/types.tsx similarity index 84% rename from x-pack/plugins/data_enhanced/public/search/ui/search_session_indicator/components/index.ts rename to x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/components/types.tsx index 9093e1a2535e2..7e22c67b09acb 100644 --- a/x-pack/plugins/data_enhanced/public/search/ui/search_session_indicator/components/index.ts +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/components/types.tsx @@ -5,4 +5,4 @@ * 2.0. */ -export * from './search_session_name'; +export type SelectionMode = 'manual' | 'query'; diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/index.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/index.tsx index d5757419e8ea7..5776a163fd6a3 100644 --- a/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/index.tsx +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/agents/agent_list_page/index.tsx @@ -8,14 +8,11 @@ import React, { useState, useMemo, useCallback, useRef, useEffect, useContext } from 'react'; import { EuiBasicTable, - EuiButton, - EuiEmptyPrompt, EuiFlexGroup, EuiFlexItem, EuiLink, EuiSpacer, EuiText, - EuiContextMenuItem, EuiIcon, EuiPortal, } from '@elastic/eui'; @@ -35,11 +32,7 @@ import { useKibanaVersion, useStartServices, } from '../../../hooks'; -import { - AgentEnrollmentFlyout, - AgentPolicySummaryLine, - ContextMenuActions, -} from '../../../components'; +import { AgentEnrollmentFlyout, AgentPolicySummaryLine } from '../../../components'; import { AgentStatusKueryHelper, isAgentUpgradeable } from '../../../services'; import { AGENTS_PREFIX, FLEET_SERVER_PACKAGE } from '../../../constants'; import { @@ -55,92 +48,13 @@ import { useFleetServerUnhealthy } from '../hooks/use_fleet_server_unhealthy'; import { agentFlyoutContext } from '..'; import { AgentTableHeader } from './components/table_header'; -import type { SelectionMode } from './components/bulk_actions'; +import type { SelectionMode } from './components/types'; import { SearchAndFilterBar } from './components/search_and_filter_bar'; +import { TableRowActions } from './components/table_row_actions'; +import { EmptyPrompt } from './components/empty_prompt'; const REFRESH_INTERVAL_MS = 30000; -const RowActions = React.memo<{ - agent: Agent; - agentPolicy?: AgentPolicy; - refresh: () => void; - onReassignClick: () => void; - onUnenrollClick: () => void; - onUpgradeClick: () => void; -}>(({ agent, agentPolicy, refresh, onReassignClick, onUnenrollClick, onUpgradeClick }) => { - const { getHref } = useLink(); - const hasFleetAllPrivileges = useAuthz().fleet.all; - - const isUnenrolling = agent.status === 'unenrolling'; - const kibanaVersion = useKibanaVersion(); - const [isMenuOpen, setIsMenuOpen] = useState(false); - const menuItems = [ - - - , - ]; - - if (agentPolicy?.is_managed === false) { - menuItems.push( - { - onReassignClick(); - }} - disabled={!agent.active} - key="reassignPolicy" - > - - , - { - onUnenrollClick(); - }} - > - {isUnenrolling ? ( - - ) : ( - - )} - , - { - onUpgradeClick(); - }} - > - - - ); - } - return ( - setIsMenuOpen(isOpen)} - items={menuItems} - /> - ); -}); - function safeMetadata(val: any) { if (typeof val !== 'string') { return '-'; @@ -479,10 +393,9 @@ export const AgentListPage: React.FunctionComponent<{}> = () => { ? agentPoliciesIndexedById[agent.policy_id] : undefined; return ( - fetchData()} onReassignClick={() => setAgentToReassign(agent)} onUnenrollClick={() => setAgentToUnenroll(agent)} onUpgradeClick={() => setAgentToUpgrade(agent)} @@ -495,30 +408,6 @@ export const AgentListPage: React.FunctionComponent<{}> = () => { }, ]; - const emptyPrompt = ( - - - - } - actions={ - hasFleetAllPrivileges ? ( - setEnrollmentFlyoutState({ isOpen: true })} - > - - - ) : null - } - /> - ); - return ( <> {enrollmentFlyout.isOpen ? ( @@ -592,6 +481,12 @@ export const AgentListPage: React.FunctionComponent<{}> = () => { onSelectedStatusChange={setSelectedStatus} showUpgradeable={showUpgradeable} onShowUpgradeableChange={setShowUpgradeable} + totalAgents={totalAgents} + totalInactiveAgents={totalInactiveAgents} + selectionMode={selectionMode} + currentQuery={kuery} + selectedAgents={selectedAgents} + refreshAgents={() => fetchData()} /> @@ -599,12 +494,10 @@ export const AgentListPage: React.FunctionComponent<{}> = () => { { if (tableRef?.current) { @@ -612,7 +505,6 @@ export const AgentListPage: React.FunctionComponent<{}> = () => { setSelectionMode('manual'); } }} - refreshAgents={() => fetchData()} /> @@ -645,7 +537,10 @@ export const AgentListPage: React.FunctionComponent<{}> = () => { }} /> ) : ( - emptyPrompt + ) } items={ diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/agents/components/agent_reassign_policy_modal/index.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/agents/components/agent_reassign_policy_modal/index.tsx index 566bc7f4363ab..5e74b86728247 100644 --- a/x-pack/plugins/fleet/public/applications/fleet/sections/agents/components/agent_reassign_policy_modal/index.tsx +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/agents/components/agent_reassign_policy_modal/index.tsx @@ -99,6 +99,7 @@ export const AgentReassignAgentPolicyModal: React.FunctionComponent = ({ return ( = ({ return ( = ({ return ( diff --git a/x-pack/plugins/fleet/public/mocks.ts b/x-pack/plugins/fleet/public/mocks.ts index 92b002a437649..8088f430ee81e 100644 --- a/x-pack/plugins/fleet/public/mocks.ts +++ b/x-pack/plugins/fleet/public/mocks.ts @@ -5,8 +5,14 @@ * 2.0. */ +import type { EuiTheme } from '@kbn/kibana-react-plugin/common'; +import type { RecursivePartial } from '@elastic/eui/src/components/common'; + import { createStartMock } from './mock'; +export const getMockTheme = (partialTheme: RecursivePartial): EuiTheme => + partialTheme as EuiTheme; + export const fleetMock = { createStartMock, }; diff --git a/x-pack/plugins/fleet/server/services/epm/elasticsearch/template/default_settings.test.ts b/x-pack/plugins/fleet/server/services/epm/elasticsearch/template/default_settings.test.ts index 1ade871b27ef6..df1c87105bcf2 100644 --- a/x-pack/plugins/fleet/server/services/epm/elasticsearch/template/default_settings.test.ts +++ b/x-pack/plugins/fleet/server/services/epm/elasticsearch/template/default_settings.test.ts @@ -36,6 +36,18 @@ describe('buildDefaultSettings', () => { name: 'field2Boolean', type: 'boolean', }, + { + name: 'field3Text', + type: 'text', + }, + { + name: 'field4MatchOnlyText', + type: 'match_only_text', + }, + { + name: 'field5Wildcard', + type: 'wildcard', + }, ], }); @@ -49,6 +61,9 @@ describe('buildDefaultSettings', () => { "query": Object { "default_field": Array [ "field1Keyword", + "field3Text", + "field4MatchOnlyText", + "field5Wildcard", ], }, }, diff --git a/x-pack/plugins/fleet/server/services/epm/elasticsearch/template/default_settings.ts b/x-pack/plugins/fleet/server/services/epm/elasticsearch/template/default_settings.ts index 7f8e8e8544109..5accf7b120f9e 100644 --- a/x-pack/plugins/fleet/server/services/epm/elasticsearch/template/default_settings.ts +++ b/x-pack/plugins/fleet/server/services/epm/elasticsearch/template/default_settings.ts @@ -8,7 +8,7 @@ import { appContextService } from '../../../app_context'; import type { Field, Fields } from '../../fields/field'; -const QUERY_DEFAULT_FIELD_TYPES = ['keyword', 'text']; +const QUERY_DEFAULT_FIELD_TYPES = ['keyword', 'text', 'match_only_text', 'wildcard']; const QUERY_DEFAULT_FIELD_LIMIT = 1024; const flattenFieldsToNameAndType = ( diff --git a/x-pack/plugins/fleet/server/services/epm/packages/_install_package.ts b/x-pack/plugins/fleet/server/services/epm/packages/_install_package.ts index 34ada19685f83..796269eee38b1 100644 --- a/x-pack/plugins/fleet/server/services/epm/packages/_install_package.ts +++ b/x-pack/plugins/fleet/server/services/epm/packages/_install_package.ts @@ -42,11 +42,11 @@ import { packagePolicyService } from '../..'; import { createInstallation, saveKibanaAssetsRefs, updateVersion } from './install'; import { deleteKibanaSavedObjectsAssets } from './remove'; +import { withPackageSpan } from './utils'; // this is only exported for testing // use a leading underscore to indicate it's not the supported path // only the more explicit `installPackage*` functions should be used - export async function _installPackage({ savedObjectsClient, savedObjectsImporter, @@ -106,60 +106,46 @@ export async function _installPackage({ }); } - const kibanaAssets = await getKibanaAssets(paths); - if (installedPkg) await deleteKibanaSavedObjectsAssets({ savedObjectsClient, installedPkg }); - // save new kibana refs before installing the assets - const installedKibanaAssetsRefs = await saveKibanaAssetsRefs( - savedObjectsClient, - pkgName, - kibanaAssets - ); + const installedKibanaAssetsRefs = await withPackageSpan('Install Kibana assets', async () => { + const kibanaAssets = await getKibanaAssets(paths); + if (installedPkg) await deleteKibanaSavedObjectsAssets({ savedObjectsClient, installedPkg }); + // save new kibana refs before installing the assets + const assetRefs = await saveKibanaAssetsRefs(savedObjectsClient, pkgName, kibanaAssets); + + await installKibanaAssets({ + logger, + savedObjectsImporter, + pkgName, + kibanaAssets, + }); - await installKibanaAssets({ - logger, - savedObjectsImporter, - pkgName, - kibanaAssets, + return assetRefs; }); // the rest of the installation must happen in sequential order // currently only the base package has an ILM policy // at some point ILM policies can be installed/modified // per data stream and we should then save them - await installILMPolicy(packageInfo, paths, esClient, logger); + await withPackageSpan('Install ILM policies', () => + installILMPolicy(packageInfo, paths, esClient, logger) + ); - const installedDataStreamIlm = await installIlmForDataStream( - packageInfo, - paths, - esClient, - savedObjectsClient, - logger + const installedDataStreamIlm = await withPackageSpan('Install Data Stream ILM policies', () => + installIlmForDataStream(packageInfo, paths, esClient, savedObjectsClient, logger) ); // installs ml models - const installedMlModel = await installMlModel( - packageInfo, - paths, - esClient, - savedObjectsClient, - logger + const installedMlModel = await withPackageSpan('Install ML models', () => + installMlModel(packageInfo, paths, esClient, savedObjectsClient, logger) ); // installs versionized pipelines without removing currently installed ones - const installedPipelines = await installPipelines( - packageInfo, - paths, - esClient, - savedObjectsClient, - logger + const installedPipelines = await withPackageSpan('Install ingest pipelines', () => + installPipelines(packageInfo, paths, esClient, savedObjectsClient, logger) ); // install or update the templates referencing the newly installed pipelines - const installedTemplates = await installTemplates( - packageInfo, - esClient, - logger, - paths, - savedObjectsClient + const installedTemplates = await withPackageSpan('Install index templates', () => + installTemplates(packageInfo, esClient, logger, paths, savedObjectsClient) ); try { @@ -169,14 +155,12 @@ export async function _installPackage({ } // update current backing indices of each data stream - await updateCurrentWriteIndices(esClient, logger, installedTemplates); + await withPackageSpan('Update write indices', () => + updateCurrentWriteIndices(esClient, logger, installedTemplates) + ); - const installedTransforms = await installTransform( - packageInfo, - paths, - esClient, - savedObjectsClient, - logger + const installedTransforms = await withPackageSpan('Install transforms', () => + installTransform(packageInfo, paths, esClient, savedObjectsClient, logger) ); // If this is an update or retrying an update, delete the previous version's pipelines @@ -187,30 +171,36 @@ export async function _installPackage({ (installType === 'update' || installType === 'reupdate') && installedPkg ) { - await deletePreviousPipelines( - esClient, - savedObjectsClient, - pkgName, - installedPkg.attributes.version + await withPackageSpan('Delete previous ingest pipelines', () => + deletePreviousPipelines( + esClient, + savedObjectsClient, + pkgName, + installedPkg.attributes.version + ) ); } // pipelines from a different version may have installed during a failed update if (installType === 'rollback' && installedPkg) { - await deletePreviousPipelines( - esClient, - savedObjectsClient, - pkgName, - installedPkg.attributes.install_version + await await withPackageSpan('Delete previous ingest pipelines', () => + deletePreviousPipelines( + esClient, + savedObjectsClient, + pkgName, + installedPkg.attributes.install_version + ) ); } const installedTemplateRefs = getAllTemplateRefs(installedTemplates); - const packageAssetResults = await saveArchiveEntries({ - savedObjectsClient, - paths, - packageInfo, - installSource, - }); + const packageAssetResults = await withPackageSpan('Update archive entries', () => + saveArchiveEntries({ + savedObjectsClient, + paths, + packageInfo, + installSource, + }) + ); const packageAssetRefs: PackageAssetReference[] = packageAssetResults.saved_objects.map( (result) => ({ id: result.id, @@ -221,26 +211,26 @@ export async function _installPackage({ // update to newly installed version when all assets are successfully installed if (installedPkg) await updateVersion(savedObjectsClient, pkgName, pkgVersion); - const updatedPackage = await savedObjectsClient.update( - PACKAGES_SAVED_OBJECT_TYPE, - pkgName, - { + const updatedPackage = await withPackageSpan('Update install status', () => + savedObjectsClient.update(PACKAGES_SAVED_OBJECT_TYPE, pkgName, { install_version: pkgVersion, install_status: 'installed', package_assets: packageAssetRefs, - } + }) ); // If the package is flagged with the `keep_policies_up_to_date` flag, upgrade its // associated package policies after installation if (updatedPackage.attributes.keep_policies_up_to_date) { - const policyIdsToUpgrade = await packagePolicyService.listIds(savedObjectsClient, { - page: 1, - perPage: SO_SEARCH_LIMIT, - kuery: `${PACKAGE_POLICY_SAVED_OBJECT_TYPE}.package.name:${pkgName}`, - }); + await withPackageSpan('Upgrade package policies', async () => { + const policyIdsToUpgrade = await packagePolicyService.listIds(savedObjectsClient, { + page: 1, + perPage: SO_SEARCH_LIMIT, + kuery: `${PACKAGE_POLICY_SAVED_OBJECT_TYPE}.package.name:${pkgName}`, + }); - await packagePolicyService.upgrade(savedObjectsClient, esClient, policyIdsToUpgrade.items); + await packagePolicyService.upgrade(savedObjectsClient, esClient, policyIdsToUpgrade.items); + }); } return [ diff --git a/x-pack/plugins/fleet/server/services/epm/packages/install.ts b/x-pack/plugins/fleet/server/services/epm/packages/install.ts index 3ecec951dde7e..9ae549982399c 100644 --- a/x-pack/plugins/fleet/server/services/epm/packages/install.ts +++ b/x-pack/plugins/fleet/server/services/epm/packages/install.ts @@ -5,6 +5,7 @@ * 2.0. */ +import apm from 'elastic-apm-node'; import { i18n } from '@kbn/i18n'; import semverLt from 'semver/functions/lt'; import type Boom from '@hapi/boom'; @@ -250,6 +251,10 @@ async function installPackageFromRegistry({ // TODO: change epm API to /packageName/version so we don't need to do this const { pkgName, pkgVersion } = Registry.splitPkgKey(pkgkey); + // Workaround apm issue with async spans: https://github.com/elastic/apm-agent-nodejs/issues/2611 + await Promise.resolve(); + const span = apm.startSpan(`Install package from registry ${pkgName}@${pkgVersion}`, 'package'); + // if an error happens during getInstallType, report that we don't know let installType: InstallType = 'unknown'; @@ -260,6 +265,12 @@ async function installPackageFromRegistry({ const installedPkg = await getInstallationObject({ savedObjectsClient, pkgName }); installType = getInstallType({ pkgVersion, installedPkg }); + span?.addLabels({ + packageName: pkgName, + packageVersion: pkgVersion, + installType, + }); + // get latest package version const latestPackage = await Registry.fetchFindLatestPackageOrThrow(pkgName, { ignoreConstraints, @@ -326,7 +337,7 @@ async function installPackageFromRegistry({ // try installing the package, if there was an error, call error handler and rethrow // @ts-expect-error status is string instead of InstallResult.status 'installed' | 'already_installed' - return _installPackage({ + return await _installPackage({ savedObjectsClient, savedObjectsImporter, esClient, @@ -377,6 +388,8 @@ async function installPackageFromRegistry({ installType, installSource: 'registry', }; + } finally { + span?.end(); } } @@ -395,6 +408,10 @@ async function installPackageByUpload({ contentType, spaceId, }: InstallUploadedArchiveParams): Promise { + // Workaround apm issue with async spans: https://github.com/elastic/apm-agent-nodejs/issues/2611 + await Promise.resolve(); + const span = apm.startSpan(`Install package from upload`, 'package'); + const logger = appContextService.getLogger(); // if an error happens during getInstallType, report that we don't know let installType: InstallType = 'unknown'; @@ -409,6 +426,12 @@ async function installPackageByUpload({ installType = getInstallType({ pkgVersion: packageInfo.version, installedPkg }); + span?.addLabels({ + packageName: packageInfo.name, + packageVersion: packageInfo.version, + installType, + }); + telemetryEvent.packageName = packageInfo.name; telemetryEvent.newVersion = packageInfo.version; telemetryEvent.installType = installType; @@ -434,7 +457,7 @@ async function installPackageByUpload({ .createImporter(savedObjectsClient); // @ts-expect-error status is string instead of InstallResult.status 'installed' | 'already_installed' - return _installPackage({ + return await _installPackage({ savedObjectsClient, savedObjectsImporter, esClient, @@ -466,6 +489,8 @@ async function installPackageByUpload({ errorMessage: e.message, }); return { error: e, installType, installSource: 'upload' }; + } finally { + span?.end(); } } diff --git a/x-pack/plugins/fleet/server/services/epm/packages/utils.ts b/x-pack/plugins/fleet/server/services/epm/packages/utils.ts new file mode 100644 index 0000000000000..0cb97ca007daf --- /dev/null +++ b/x-pack/plugins/fleet/server/services/epm/packages/utils.ts @@ -0,0 +1,11 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { withSpan } from '@kbn/apm-utils'; + +export const withPackageSpan = (stepName: string, func: () => Promise) => + withSpan({ name: stepName, type: 'package' }, func); diff --git a/x-pack/plugins/fleet/server/services/epm/registry/index.ts b/x-pack/plugins/fleet/server/services/epm/registry/index.ts index 182f20297afd5..2ae531f63379d 100644 --- a/x-pack/plugins/fleet/server/services/epm/registry/index.ts +++ b/x-pack/plugins/fleet/server/services/epm/registry/index.ts @@ -37,6 +37,8 @@ import { PackageNotFoundError, PackageCacheError, RegistryResponseError } from ' import { getBundledPackageByName } from '../packages/bundled_packages'; +import { withPackageSpan } from '../packages/utils'; + import { fetchUrl, getResponse, getResponseStream } from './requests'; import { getRegistryUrl } from './registry_url'; @@ -75,42 +77,44 @@ async function _fetchFindLatestPackage( packageName: string, options?: FetchFindLatestPackageOptions ) { - const logger = appContextService.getLogger(); - const { ignoreConstraints = false } = options ?? {}; + return withPackageSpan(`Find latest package ${packageName}`, async () => { + const logger = appContextService.getLogger(); + const { ignoreConstraints = false } = options ?? {}; - const bundledPackage = await getBundledPackageByName(packageName); + const bundledPackage = await getBundledPackageByName(packageName); - const registryUrl = getRegistryUrl(); - const url = new URL(`${registryUrl}/search?package=${packageName}&experimental=true`); + const registryUrl = getRegistryUrl(); + const url = new URL(`${registryUrl}/search?package=${packageName}&experimental=true`); - if (!ignoreConstraints) { - setKibanaVersion(url); - } + if (!ignoreConstraints) { + setKibanaVersion(url); + } - try { - const res = await fetchUrl(url.toString(), 1); - const searchResults: RegistryPackage[] = JSON.parse(res); + try { + const res = await fetchUrl(url.toString(), 1); + const searchResults: RegistryPackage[] = JSON.parse(res); - const latestPackageFromRegistry = searchResults[0] ?? null; + const latestPackageFromRegistry = searchResults[0] ?? null; - if (bundledPackage && semverGte(bundledPackage.version, latestPackageFromRegistry.version)) { - return bundledPackage; - } + if (bundledPackage && semverGte(bundledPackage.version, latestPackageFromRegistry.version)) { + return bundledPackage; + } - return latestPackageFromRegistry; - } catch (error) { - logger.error( - `Failed to fetch latest version of ${packageName} from registry: ${error.message}` - ); + return latestPackageFromRegistry; + } catch (error) { + logger.error( + `Failed to fetch latest version of ${packageName} from registry: ${error.message}` + ); - // Fall back to the bundled version of the package if it exists - if (bundledPackage) { - return bundledPackage; - } + // Fall back to the bundled version of the package if it exists + if (bundledPackage) { + return bundledPackage; + } - // Otherwise, return null and allow callers to determine whether they'll consider this an error or not - return null; - } + // Otherwise, return null and allow callers to determine whether they'll consider this an error or not + return null; + } + }); } export async function fetchFindLatestPackageOrThrow( @@ -207,12 +211,14 @@ export async function fetchCategories( } export async function getInfo(name: string, version: string) { - let packageInfo = getPackageInfo({ name, version }); - if (!packageInfo) { - packageInfo = await fetchInfo(name, version); - setPackageInfo({ name, version, packageInfo }); - } - return packageInfo as RegistryPackage; + return withPackageSpan('Fetch package info', async () => { + let packageInfo = getPackageInfo({ name, version }); + if (!packageInfo) { + packageInfo = await fetchInfo(name, version); + setPackageInfo({ name, version, packageInfo }); + } + return packageInfo as RegistryPackage; + }); } export async function getRegistryPackage( @@ -222,14 +228,19 @@ export async function getRegistryPackage( const installSource = 'registry'; let paths = getArchiveFilelist({ name, version }); if (!paths || paths.length === 0) { - const { archiveBuffer, archivePath } = await fetchArchiveBuffer(name, version); - paths = await unpackBufferToCache({ - name, - version, - installSource, - archiveBuffer, - contentType: ensureContentType(archivePath), - }); + const { archiveBuffer, archivePath } = await withPackageSpan( + 'Fetch package archive from registry', + () => fetchArchiveBuffer(name, version) + ); + paths = await withPackageSpan('Unpack archive', () => + unpackBufferToCache({ + name, + version, + installSource, + archiveBuffer, + contentType: ensureContentType(archivePath), + }) + ); } const packageInfo = await getInfo(name, version); diff --git a/x-pack/plugins/infra/kibana.json b/x-pack/plugins/infra/kibana.json index 2eec94187900f..d9d432fc702e4 100644 --- a/x-pack/plugins/infra/kibana.json +++ b/x-pack/plugins/infra/kibana.json @@ -9,7 +9,6 @@ "spaces", "embeddable", "data", - "dataEnhanced", "dataViews", "visTypeTimeseries", "alerting", diff --git a/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/node_details/tabs/osquery/index.tsx b/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/node_details/tabs/osquery/index.tsx index 1bd6cfd353140..ce023064edee1 100644 --- a/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/node_details/tabs/osquery/index.tsx +++ b/x-pack/plugins/infra/public/pages/metrics/inventory_view/components/node_details/tabs/osquery/index.tsx @@ -48,7 +48,7 @@ const TabComponent = (props: TabProps) => { return ( - + ); }, [OsqueryAction, loading, metadata]); diff --git a/x-pack/plugins/infra/public/types.ts b/x-pack/plugins/infra/public/types.ts index ab7df75592712..b5147f343ea5b 100644 --- a/x-pack/plugins/infra/public/types.ts +++ b/x-pack/plugins/infra/public/types.ts @@ -20,7 +20,6 @@ import type { TriggersAndActionsUIPublicPluginSetup, TriggersAndActionsUIPublicPluginStart, } from '@kbn/triggers-actions-ui-plugin/public'; -import type { DataEnhancedSetup, DataEnhancedStart } from '@kbn/data-enhanced-plugin/public'; import { MlPluginSetup, MlPluginStart } from '@kbn/ml-plugin/public'; import type { ObservabilityPublicSetup, @@ -52,7 +51,6 @@ export interface InfraClientStartExports { } export interface InfraClientSetupDeps { - dataEnhanced: DataEnhancedSetup; home?: HomePublicPluginSetup; observability: ObservabilityPublicSetup; triggersActionsUi: TriggersAndActionsUIPublicPluginSetup; @@ -64,7 +62,6 @@ export interface InfraClientSetupDeps { export interface InfraClientStartDeps { data: DataPublicPluginStart; - dataEnhanced: DataEnhancedStart; dataViews: DataViewsPublicPluginStart; observability: ObservabilityPublicStart; spaces: SpacesPluginStart; diff --git a/x-pack/plugins/infra/server/lib/metrics/make_get_metric_indices.test.ts b/x-pack/plugins/infra/server/lib/metrics/make_get_metric_indices.test.ts new file mode 100644 index 0000000000000..9dedf9b5afaa0 --- /dev/null +++ b/x-pack/plugins/infra/server/lib/metrics/make_get_metric_indices.test.ts @@ -0,0 +1,30 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { savedObjectsClientMock } from '@kbn/core/server/mocks'; +import { defaultSourceConfiguration, InfraSource } from '../sources'; +import { createInfraSourcesMock } from '../sources/mocks'; +import { makeGetMetricIndices } from './make_get_metric_indices'; + +describe('getMetricIndices', () => { + it('should return the indices from a resolved configuration', async () => { + const sourceConfiguration: InfraSource = { + id: 'default', + origin: 'stored', + configuration: defaultSourceConfiguration, + }; + const infraSourcesMock = createInfraSourcesMock(); + infraSourcesMock.getSourceConfiguration.mockResolvedValueOnce(sourceConfiguration); + + const getMetricIndices = makeGetMetricIndices(infraSourcesMock); + + const savedObjectsClient = savedObjectsClientMock.create(); + const metricIndices = await getMetricIndices(savedObjectsClient); + + expect(metricIndices).toEqual(defaultSourceConfiguration.metricAlias); + }); +}); diff --git a/x-pack/plugins/infra/server/lib/metrics/make_get_metric_indices.ts b/x-pack/plugins/infra/server/lib/metrics/make_get_metric_indices.ts new file mode 100644 index 0000000000000..a6ff7e96a55a0 --- /dev/null +++ b/x-pack/plugins/infra/server/lib/metrics/make_get_metric_indices.ts @@ -0,0 +1,16 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import type { SavedObjectsClientContract } from '@kbn/core/server'; +import type { IInfraSources } from '../sources'; + +export function makeGetMetricIndices(metricSources: IInfraSources) { + return async (savedObjectsClient: SavedObjectsClientContract, sourceId: string = 'default') => { + const source = await metricSources.getSourceConfiguration(savedObjectsClient, sourceId); + return source.configuration.metricAlias; + }; +} diff --git a/x-pack/plugins/infra/server/plugin.ts b/x-pack/plugins/infra/server/plugin.ts index 8eb2bac57dc56..bfd7113ec4dc0 100644 --- a/x-pack/plugins/infra/server/plugin.ts +++ b/x-pack/plugins/infra/server/plugin.ts @@ -7,8 +7,6 @@ import { Server } from '@hapi/hapi'; import { schema } from '@kbn/config-schema'; -import { i18n } from '@kbn/i18n'; -import { Logger } from '@kbn/logging'; import { CoreStart, Plugin, @@ -16,6 +14,8 @@ import { PluginInitializerContext, } from '@kbn/core/server'; import { handleEsError } from '@kbn/es-ui-shared-plugin/server'; +import { i18n } from '@kbn/i18n'; +import { Logger } from '@kbn/logging'; import { LOGS_FEATURE_ID, METRICS_FEATURE_ID } from '../common/constants'; import { defaultLogViewsStaticConfig } from '../common/log_views'; import { publicConfigKeys } from '../common/plugin_config_types'; @@ -35,6 +35,7 @@ import { InfraFieldsDomain } from './lib/domains/fields_domain'; import { InfraLogEntriesDomain } from './lib/domains/log_entries_domain'; import { InfraMetricsDomain } from './lib/domains/metrics_domain'; import { InfraBackendLibs, InfraDomainLibs } from './lib/infra_types'; +import { makeGetMetricIndices } from './lib/metrics/make_get_metric_indices'; import { infraSourceConfigurationSavedObjectType, InfraSources } from './lib/sources'; import { InfraSourceStatus } from './lib/source_status'; import { logViewSavedObjectType } from './saved_objects'; @@ -236,6 +237,7 @@ export class InfraServerPlugin return { logViews, + getMetricIndices: makeGetMetricIndices(this.libs.sources), }; } diff --git a/x-pack/plugins/infra/server/types.ts b/x-pack/plugins/infra/server/types.ts index e3792c8977cfe..108575c0f8324 100644 --- a/x-pack/plugins/infra/server/types.ts +++ b/x-pack/plugins/infra/server/types.ts @@ -5,7 +5,11 @@ * 2.0. */ -import type { CoreSetup, CustomRequestHandlerContext } from '@kbn/core/server'; +import type { + CoreSetup, + CustomRequestHandlerContext, + SavedObjectsClientContract, +} from '@kbn/core/server'; import type { SearchRequestHandlerContext } from '@kbn/data-plugin/server'; import type { MlPluginSetup } from '@kbn/ml-plugin/server'; import type { InfraStaticSourceConfiguration } from '../common/source_configuration/source_configuration'; @@ -27,6 +31,10 @@ export interface InfraPluginSetup { export interface InfraPluginStart { logViews: LogViewsServiceStart; + getMetricIndices: ( + savedObjectsClient: SavedObjectsClientContract, + sourceId?: string + ) => Promise; } export type MlSystem = ReturnType; diff --git a/x-pack/plugins/infra/tsconfig.json b/x-pack/plugins/infra/tsconfig.json index b508b8fb6da80..370644367b441 100644 --- a/x-pack/plugins/infra/tsconfig.json +++ b/x-pack/plugins/infra/tsconfig.json @@ -24,7 +24,6 @@ { "path": "../../../src/plugins/kibana_react/tsconfig.json" }, { "path": "../../../src/plugins/usage_collection/tsconfig.json" }, { "path": "../../../src/plugins/vis_types/timeseries/tsconfig.json" }, - { "path": "../data_enhanced/tsconfig.json" }, { "path": "../alerting/tsconfig.json" }, { "path": "../features/tsconfig.json" }, { "path": "../license_management/tsconfig.json" }, diff --git a/x-pack/plugins/lens/common/embeddable_factory/index.ts b/x-pack/plugins/lens/common/embeddable_factory/index.ts index c4b03ae280778..8ddddf654b017 100644 --- a/x-pack/plugins/lens/common/embeddable_factory/index.ts +++ b/x-pack/plugins/lens/common/embeddable_factory/index.ts @@ -7,9 +7,10 @@ import { SerializableRecord, Serializable } from '@kbn/utility-types'; import { SavedObjectReference } from '@kbn/core/types'; -import { EmbeddableStateWithType } from '@kbn/embeddable-plugin/common'; -// eslint-disable-next-line @kbn/eslint/no-restricted-paths -import { EmbeddableRegistryDefinition } from '@kbn/embeddable-plugin/server'; +import type { + EmbeddableStateWithType, + EmbeddableRegistryDefinition, +} from '@kbn/embeddable-plugin/common'; export type LensEmbeddablePersistableState = EmbeddableStateWithType & { attributes: SerializableRecord; diff --git a/x-pack/plugins/lens/common/expressions/counter_rate/counter_rate.test.ts b/x-pack/plugins/lens/common/expressions/counter_rate/counter_rate.test.ts index 32a37e0cf949e..9f19b5d052c68 100644 --- a/x-pack/plugins/lens/common/expressions/counter_rate/counter_rate.test.ts +++ b/x-pack/plugins/lens/common/expressions/counter_rate/counter_rate.test.ts @@ -7,8 +7,7 @@ import { counterRate, CounterRateArgs } from '.'; -// eslint-disable-next-line @kbn/eslint/no-restricted-paths -import { Datatable } from '@kbn/expressions-plugin/public'; +import { Datatable } from '@kbn/expressions-plugin/common'; import { functionWrapper } from '@kbn/expressions-plugin/common/expression_functions/specs/tests/utils'; describe('lens_counter_rate', () => { diff --git a/x-pack/plugins/lens/common/expressions/format_column/format_column.test.ts b/x-pack/plugins/lens/common/expressions/format_column/format_column.test.ts index 63e32ffbf1df6..d0db49f4afaae 100644 --- a/x-pack/plugins/lens/common/expressions/format_column/format_column.test.ts +++ b/x-pack/plugins/lens/common/expressions/format_column/format_column.test.ts @@ -5,8 +5,7 @@ * 2.0. */ -// eslint-disable-next-line @kbn/eslint/no-restricted-paths -import { Datatable, DatatableColumn } from '@kbn/expressions-plugin/public'; +import type { Datatable, DatatableColumn } from '@kbn/expressions-plugin/common'; import { functionWrapper } from '@kbn/expressions-plugin/common/expression_functions/specs/tests/utils'; import { formatColumn } from '.'; diff --git a/x-pack/plugins/lens/common/expressions/merge_tables/merge_tables.test.ts b/x-pack/plugins/lens/common/expressions/merge_tables/merge_tables.test.ts index 4c8a3bf9aa310..4558bdfe68661 100644 --- a/x-pack/plugins/lens/common/expressions/merge_tables/merge_tables.test.ts +++ b/x-pack/plugins/lens/common/expressions/merge_tables/merge_tables.test.ts @@ -7,8 +7,7 @@ import moment from 'moment'; import { mergeTables } from '.'; -// eslint-disable-next-line @kbn/eslint/no-restricted-paths -import { ExpressionValueSearchContext } from '@kbn/data-plugin/public'; +import type { ExpressionValueSearchContext } from '@kbn/data-plugin/common'; import { Datatable, ExecutionContext, diff --git a/x-pack/plugins/lens/common/expressions/time_scale/time_scale.test.ts b/x-pack/plugins/lens/common/expressions/time_scale/time_scale.test.ts index dd3e18c720c0a..e7fdd720d075c 100644 --- a/x-pack/plugins/lens/common/expressions/time_scale/time_scale.test.ts +++ b/x-pack/plugins/lens/common/expressions/time_scale/time_scale.test.ts @@ -6,10 +6,8 @@ */ import moment from 'moment'; -// eslint-disable-next-line @kbn/eslint/no-restricted-paths -import type { Datatable } from '@kbn/expressions-plugin/public'; -// eslint-disable-next-line @kbn/eslint/no-restricted-paths -import type { TimeRange } from '@kbn/data-plugin/public'; +import type { Datatable } from '@kbn/expressions-plugin/common'; +import type { TimeRange } from '@kbn/data-plugin/common'; import { functionWrapper } from '@kbn/expressions-plugin/common/expression_functions/specs/tests/utils'; // mock the specific inner variable: diff --git a/x-pack/plugins/lens/common/types.ts b/x-pack/plugins/lens/common/types.ts index f4111d51e2918..f85c8ba88a076 100644 --- a/x-pack/plugins/lens/common/types.ts +++ b/x-pack/plugins/lens/common/types.ts @@ -57,8 +57,7 @@ export type CustomPaletteParamsConfig = CustomPaletteParams & { export type LayerType = typeof layerTypes[keyof typeof layerTypes]; -// Shared by XY Chart and Heatmap as for now -export type ValueLabelConfig = 'hide' | 'inside' | 'outside'; +export type ValueLabelConfig = 'hide' | 'show'; export type PieChartType = $Values; export type CategoryDisplayType = $Values; diff --git a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/layer_panel.tsx b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/layer_panel.tsx index e404faacb8f97..c577bf89d6bd1 100644 --- a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/layer_panel.tsx +++ b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/layer_panel.tsx @@ -145,8 +145,6 @@ export function LayerPanel( const isEmptyLayer = !groups.some((d) => d.accessors.length > 0); const { activeId, activeGroup } = activeDimension; - const { setDimension, removeDimension } = activeVisualization; - const allAccessors = groups.flatMap((group) => group.accessors.map((accessor) => accessor.columnId) ); @@ -209,7 +207,7 @@ export function LayerPanel( previousColumn = typeof dropResult === 'object' ? dropResult.deleted : undefined; } } - const newVisState = setDimension({ + const newVisState = activeVisualization.setDimension({ columnId, groupId, layerId: targetLayerId, @@ -221,7 +219,7 @@ export function LayerPanel( if (typeof dropResult === 'object') { // When a column is moved, we delete the reference to the old updateVisualization( - removeDimension({ + activeVisualization.removeDimension({ columnId: dropResult.deleted, layerId: targetLayerId, prevState: newVisState, @@ -234,7 +232,7 @@ export function LayerPanel( } } else { if (dropType === 'duplicate_compatible' || dropType === 'reorder') { - const newVisState = setDimension({ + const newVisState = activeVisualization.setDimension({ columnId, groupId, layerId: targetLayerId, @@ -247,16 +245,15 @@ export function LayerPanel( } }; }, [ - framePublicAPI, + layerDatasource, + setNextFocusedButtonId, groups, layerDatasourceOnDrop, + layerDatasourceDropProps, + activeVisualization, props.visualizationState, + framePublicAPI, updateVisualization, - setDimension, - removeDimension, - layerDatasourceDropProps, - setNextFocusedButtonId, - layerDatasource, ]); const isDimensionPanelOpen = Boolean(activeId); diff --git a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/expression_helpers.ts b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/expression_helpers.ts index cecf75cd58676..b5fa32cd8e306 100644 --- a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/expression_helpers.ts +++ b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/expression_helpers.ts @@ -9,11 +9,10 @@ import { Ast, AstFunction, fromExpression } from '@kbn/interpreter'; import { DatasourceStates } from '../../state_management'; import { Visualization, DatasourceMap, DatasourceLayers } from '../../types'; -export function prependDatasourceExpression( - visualizationExpression: Ast | string | null, +export function getDatasourceExpressionsByLayers( datasourceMap: DatasourceMap, datasourceStates: DatasourceStates -): Ast | null { +): null | Record { const datasourceExpressions: Array<[string, Ast | string]> = []; Object.entries(datasourceMap).forEach(([datasourceId, datasource]) => { @@ -28,19 +27,41 @@ export function prependDatasourceExpression( }); }); - if (datasourceExpressions.length === 0 || visualizationExpression === null) { + if (datasourceExpressions.length === 0) { return null; } - const parsedDatasourceExpressions: Array<[string, Ast]> = datasourceExpressions.map( - ([layerId, expr]) => [layerId, typeof expr === 'string' ? fromExpression(expr) : expr] + + return datasourceExpressions.reduce( + (exprs, [layerId, expr]) => ({ + ...exprs, + [layerId]: typeof expr === 'string' ? fromExpression(expr) : expr, + }), + {} ); +} + +export function prependDatasourceExpression( + visualizationExpression: Ast | string | null, + datasourceMap: DatasourceMap, + datasourceStates: DatasourceStates +): Ast | null { + const datasourceExpressionsByLayers = getDatasourceExpressionsByLayers( + datasourceMap, + datasourceStates + ); + + if (datasourceExpressionsByLayers === null || visualizationExpression === null) { + return null; + } + + const parsedDatasourceExpressions = Object.entries(datasourceExpressionsByLayers); const datafetchExpression: AstFunction = { type: 'function', function: 'lens_merge_tables', arguments: { layerIds: parsedDatasourceExpressions.map(([id]) => id), - tables: parsedDatasourceExpressions.map(([id, expr]) => expr), + tables: parsedDatasourceExpressions.map(([, expr]) => expr), }, }; @@ -79,16 +100,32 @@ export function buildExpression({ if (visualization === null) { return null; } + + if (visualization.shouldBuildDatasourceExpressionManually?.()) { + const datasourceExpressionsByLayers = getDatasourceExpressionsByLayers( + datasourceMap, + datasourceStates + ); + + const visualizationExpression = visualization.toExpression( + visualizationState, + datasourceLayers, + { + title, + description, + }, + datasourceExpressionsByLayers ?? undefined + ); + + return typeof visualizationExpression === 'string' + ? fromExpression(visualizationExpression) + : visualizationExpression; + } + const visualizationExpression = visualization.toExpression(visualizationState, datasourceLayers, { title, description, }); - const completeExpression = prependDatasourceExpression( - visualizationExpression, - datasourceMap, - datasourceStates - ); - - return completeExpression; + return prependDatasourceExpression(visualizationExpression, datasourceMap, datasourceStates); } diff --git a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/frame_layout.scss b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/frame_layout.scss index b49c77bb8b419..cab1a78294a86 100644 --- a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/frame_layout.scss +++ b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/frame_layout.scss @@ -96,7 +96,7 @@ a tilemap in an iframe: https://github.com/elastic/kibana/issues/16457 */ .lnsFrameLayout__sidebar--right { flex-basis: 25%; background-color: lightOrDarkTheme($euiColorLightestShade, $euiColorInk); - min-width: $lnsPanelMinWidth + $euiSizeXL; + min-width: $lnsPanelMinWidth + 70; max-width: $euiFormMaxWidth + $euiSizeXXL; max-height: 100%; diff --git a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/suggestion_panel.tsx b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/suggestion_panel.tsx index 770d25be5388f..dc36e0a671cf0 100644 --- a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/suggestion_panel.tsx +++ b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/suggestion_panel.tsx @@ -22,7 +22,7 @@ import { EuiText, } from '@elastic/eui'; import { IconType } from '@elastic/eui/src/components/icon/icon'; -import { Ast, toExpression } from '@kbn/interpreter'; +import { Ast, fromExpression, toExpression } from '@kbn/interpreter'; import { i18n } from '@kbn/i18n'; import classNames from 'classnames'; import { ExecutionContextSearch } from '@kbn/data-plugin/public'; @@ -39,7 +39,10 @@ import { DatasourceLayers, } from '../../types'; import { getSuggestions, switchToSuggestion } from './suggestion_helpers'; -import { prependDatasourceExpression } from './expression_helpers'; +import { + getDatasourceExpressionsByLayers, + prependDatasourceExpression, +} from './expression_helpers'; import { trackUiEvent, trackSuggestionEvent } from '../../lens_ui_telemetry'; import { getMissingIndexPattern, @@ -485,6 +488,7 @@ function getPreviewExpression( visualizableState: VisualizableState, visualization: Visualization, datasources: Record, + datasourceStates: DatasourceStates, frame: FramePublicAPI ) { if (!visualization.toPreviewExpression) { @@ -518,6 +522,19 @@ function getPreviewExpression( }); } + if (visualization.shouldBuildDatasourceExpressionManually?.()) { + const datasourceExpressionsByLayers = getDatasourceExpressionsByLayers( + datasources, + datasourceStates + ); + + return visualization.toPreviewExpression( + visualizableState.visualizationState, + suggestionFrameApi.datasourceLayers, + datasourceExpressionsByLayers ?? undefined + ); + } + return visualization.toPreviewExpression( visualizableState.visualizationState, suggestionFrameApi.datasourceLayers @@ -534,10 +551,25 @@ function preparePreviewExpression( const suggestionDatasourceId = visualizableState.datasourceId; const suggestionDatasourceState = visualizableState.datasourceState; + const datasourceStatesWithSuggestions = suggestionDatasourceId + ? { + ...datasourceStates, + [suggestionDatasourceId]: { + isLoading: false, + state: suggestionDatasourceState, + }, + } + : datasourceStates; + + const previewExprDatasourcesStates = visualization.shouldBuildDatasourceExpressionManually?.() + ? datasourceStatesWithSuggestions + : datasourceStates; + const expression = getPreviewExpression( visualizableState, visualization, datasourceMap, + previewExprDatasourcesStates, framePublicAPI ); @@ -545,19 +577,9 @@ function preparePreviewExpression( return; } - const expressionWithDatasource = prependDatasourceExpression( - expression, - datasourceMap, - suggestionDatasourceId - ? { - ...datasourceStates, - [suggestionDatasourceId]: { - isLoading: false, - state: suggestionDatasourceState, - }, - } - : datasourceStates - ); + if (visualization.shouldBuildDatasourceExpressionManually?.()) { + return typeof expression === 'string' ? fromExpression(expression) : expression; + } - return expressionWithDatasource; + return prependDatasourceExpression(expression, datasourceMap, datasourceStatesWithSuggestions); } diff --git a/x-pack/plugins/lens/public/embeddable/embeddable.tsx b/x-pack/plugins/lens/public/embeddable/embeddable.tsx index fe26e635542aa..56a24458bbdc0 100644 --- a/x-pack/plugins/lens/public/embeddable/embeddable.tsx +++ b/x-pack/plugins/lens/public/embeddable/embeddable.tsx @@ -348,6 +348,7 @@ export class Embeddable if (!this.savedVis || !this.savedVis.visualizationType) { return []; } + return this.deps.visualizationMap[this.savedVis.visualizationType]?.triggers || []; } @@ -458,6 +459,7 @@ export class Embeddable this.embeddableTitle = this.getTitle(); isDirty = true; } + return isDirty; } @@ -529,6 +531,7 @@ export class Embeddable interactive={!input.disableTriggers} renderMode={input.renderMode} syncColors={input.syncColors} + syncTooltips={input.syncTooltips} hasCompatibleActions={this.hasCompatibleActions} className={input.className} style={input.style} diff --git a/x-pack/plugins/lens/public/embeddable/expression_wrapper.tsx b/x-pack/plugins/lens/public/embeddable/expression_wrapper.tsx index c2b9d1d2dbb31..27094d154efd2 100644 --- a/x-pack/plugins/lens/public/embeddable/expression_wrapper.tsx +++ b/x-pack/plugins/lens/public/embeddable/expression_wrapper.tsx @@ -38,6 +38,7 @@ export interface ExpressionWrapperProps { onRender$: () => void; renderMode?: RenderMode; syncColors?: boolean; + syncTooltips?: boolean; hasCompatibleActions?: ReactExpressionRendererProps['hasCompatibleActions']; style?: React.CSSProperties; className?: string; @@ -110,6 +111,7 @@ export function ExpressionWrapper({ onRender$, renderMode, syncColors, + syncTooltips, hasCompatibleActions, style, className, @@ -138,6 +140,7 @@ export function ExpressionWrapper({ inspectorAdapters={lensInspector.adapters} renderMode={renderMode} syncColors={syncColors} + syncTooltips={syncTooltips} executionContext={executionContext} renderError={(errorMessage, error) => { onRuntimeError(); diff --git a/x-pack/plugins/lens/public/heatmap_visualization/toolbar_component.tsx b/x-pack/plugins/lens/public/heatmap_visualization/toolbar_component.tsx index cb6e6e030eaac..a8d94b743adf8 100644 --- a/x-pack/plugins/lens/public/heatmap_visualization/toolbar_component.tsx +++ b/x-pack/plugins/lens/public/heatmap_visualization/toolbar_component.tsx @@ -62,11 +62,11 @@ export const HeatmapToolbar = memo( buttonDataTestSubj="lnsVisualOptionsButton" > { setState({ ...state, - gridConfig: { ...state.gridConfig, isCellLabelVisible: newMode === 'inside' }, + gridConfig: { ...state.gridConfig, isCellLabelVisible: newMode === 'show' }, }); }} /> diff --git a/x-pack/plugins/lens/public/index.ts b/x-pack/plugins/lens/public/index.ts index 942df72957fc7..b8d00e7ff61b8 100644 --- a/x-pack/plugins/lens/public/index.ts +++ b/x-pack/plugins/lens/public/index.ts @@ -15,6 +15,7 @@ export type { XYState, XYReferenceLineLayerConfig, XYLayerConfig, + ValidLayer, XYDataLayerConfig, XYAnnotationLayerConfig, } from './xy_visualization/types'; @@ -70,7 +71,7 @@ export type { } from './indexpattern_datasource/types'; export type { XYArgs, - YConfig, + ExtendedYConfig, XYRender, LayerType, YAxisMode, @@ -80,28 +81,27 @@ export type { YScaleType, XScaleType, AxisConfig, - ValidLayer, XYCurveType, XYChartProps, LegendConfig, IconPosition, - YConfigResult, + ExtendedYConfigResult, DataLayerArgs, LensMultiTable, ValueLabelMode, AxisExtentMode, + DataLayerConfig, FittingFunction, AxisExtentConfig, LegendConfigResult, AxesSettingsConfig, GridlinesConfigResult, - DataLayerConfigResult, TickLabelsConfigResult, AxisExtentConfigResult, ReferenceLineLayerArgs, LabelsOrientationConfig, + ReferenceLineLayerConfig, LabelsOrientationConfigResult, - ReferenceLineLayerConfigResult, AxisTitlesVisibilityConfigResult, } from '@kbn/expression-xy-plugin/common'; export type { LensEmbeddableInput } from './embeddable'; diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/dimension_editor.scss b/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/dimension_editor.scss index d4c91f80317fd..99286ad34b380 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/dimension_editor.scss +++ b/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/dimension_editor.scss @@ -37,13 +37,7 @@ .lnsIndexPatternDimensionEditor__columns { column-count: 2; - column-gap: $euiSizeXL; -} - -// overrides the .euiListGroupItem display flex. -// The parent container has a column-count property that only works properly with block elements. -.lnsIndexPatternDimensionEditor__operation { - display: block; + column-gap: $euiSizeM; } .lnsIndexPatternDimensionEditor__operation .euiListGroupItem__label { diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/dimension_editor.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/dimension_editor.tsx index 2c03ad902ce81..790873fdc74b2 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/dimension_editor.tsx +++ b/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/dimension_editor.tsx @@ -6,7 +6,7 @@ */ import './dimension_editor.scss'; -import React, { useState, useMemo, useCallback } from 'react'; +import React, { useState, useMemo, useCallback, useRef, useEffect } from 'react'; import { i18n } from '@kbn/i18n'; import { EuiListGroup, @@ -16,6 +16,7 @@ import { EuiToolTip, EuiText, } from '@elastic/eui'; +import ReactDOM from 'react-dom'; import type { IndexPatternDimensionEditorProps } from './dimension_panel'; import type { OperationSupportMatrix } from './operation_support'; import type { GenericIndexPatternColumn } from '../indexpattern'; @@ -58,6 +59,7 @@ import type { TemporaryState } from './dimensions_editor_helpers'; import { FieldInput } from './field_input'; import { NameInput } from '../../shared_components'; import { ParamEditorProps } from '../operations/definitions'; +import { WrappingHelpPopover } from '../help_popover'; const operationPanels = getOperationDisplay(); @@ -228,6 +230,15 @@ export function DimensionEditor(props: DimensionEditorProps) { const [filterByOpenInitially, setFilterByOpenInitally] = useState(false); const [timeShiftedFocused, setTimeShiftFocused] = useState(false); + const helpPopoverContainer = useRef(null); + useEffect(() => { + return () => { + if (helpPopoverContainer.current) { + ReactDOM.unmountComponentAtNode(helpPopoverContainer.current); + document.body.removeChild(helpPopoverContainer.current); + } + }; + }, []); // Operations are compatible if they match inputs. They are always compatible in // the empty state. Field-based operations are not compatible with field-less operations. @@ -309,6 +320,45 @@ export function DimensionEditor(props: DimensionEditorProps) { compatibleWithCurrentField ? '' : ' incompatible' }`, [`aria-pressed`]: isActive, + extraAction: operationDefinitionMap[operationType].helpComponent + ? { + color: 'primary', + onClick: (e) => { + if (!helpPopoverContainer.current) { + const container = document.createElement('div'); + helpPopoverContainer.current = container; + document.body.appendChild(container); + const HelpComponent = operationDefinitionMap[operationType].helpComponent!; + const element = ( + { + if (helpPopoverContainer.current) { + ReactDOM.unmountComponentAtNode(helpPopoverContainer.current); + document.body.removeChild(helpPopoverContainer.current); + helpPopoverContainer.current = null; + } + }} + > + + + ); + ReactDOM.render(element, helpPopoverContainer.current); + } else { + ReactDOM.unmountComponentAtNode(helpPopoverContainer.current); + document.body.removeChild(helpPopoverContainer.current); + helpPopoverContainer.current = null; + } + }, + iconType: 'documentation', + iconSize: 's', + 'aria-label': i18n.translate('xpack.lens.indexPattern.helpLabel', { + defaultMessage: 'Function help', + }), + } + : undefined, onClick() { if ( ['none', 'fullReference', 'managedReference'].includes( diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/dimension_panel.test.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/dimension_panel.test.tsx index 3ab3633725678..7f21cf21000b1 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/dimension_panel.test.tsx +++ b/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/dimension_panel.test.tsx @@ -635,7 +635,7 @@ describe('IndexPatternDimensionEditorPanel', () => { act(() => { wrapper - .find('input[data-test-subj="indexPattern-label-edit"]') + .find('input[data-test-subj="column-label-edit"]') .simulate('change', { target: { value: 'New Label' } }); }); @@ -739,7 +739,7 @@ describe('IndexPatternDimensionEditorPanel', () => { act(() => { wrapper - .find('input[data-test-subj="indexPattern-label-edit"]') + .find('input[data-test-subj="column-label-edit"]') .simulate('change', { target: { value: 'Sum of bytes' } }); }); diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/help_popover.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/help_popover.tsx index 88fb96b58cd21..a1bbc7ccd55f1 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/help_popover.tsx +++ b/x-pack/plugins/lens/public/indexpattern_datasource/help_popover.tsx @@ -12,6 +12,8 @@ import { EuiLinkButtonProps, EuiPopover, EuiPopoverProps, + EuiWrappingPopover, + EuiWrappingPopoverProps, EuiPopoverTitle, EuiText, } from '@elastic/eui'; @@ -75,3 +77,43 @@ export const HelpPopover = ({ ); }; + +export const WrappingHelpPopover = ({ + anchorPosition, + button, + children, + closePopover, + isOpen, + title, +}: { + anchorPosition?: EuiWrappingPopoverProps['anchorPosition']; + button: EuiWrappingPopoverProps['button']; + children: ReactNode; + closePopover: EuiWrappingPopoverProps['closePopover']; + isOpen: EuiWrappingPopoverProps['isOpen']; + title?: string; +}) => { + useEffect(() => { + if (isOpen) { + trackUiEvent('open_help_popover'); + } + }, [isOpen]); + return ( + + {title && {title}} + + + {children} + + + ); +}; diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/indexpattern.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/indexpattern.tsx index b72519c2191be..bfa28b1d1c1ae 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/indexpattern.tsx +++ b/x-pack/plugins/lens/public/indexpattern_datasource/indexpattern.tsx @@ -235,6 +235,7 @@ export function getIndexPatternDatasource({ if (staticValue == null) { return state; } + return mergeLayer({ state, layerId, diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/moving_average.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/moving_average.tsx index aa68c8409ad80..cf96bcd11b788 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/moving_average.tsx +++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/calculations/moving_average.tsx @@ -28,7 +28,6 @@ import { combineErrorMessages, } from '../helpers'; import { adjustTimeScaleOnOtherColumnChange } from '../../time_scale_utils'; -import { HelpPopover, HelpPopoverButton } from '../../../help_popover'; import type { OperationDefinition, ParamEditorProps } from '..'; import { getDisallowedPreviousShiftMessage } from '../../../time_shift_utils'; @@ -129,7 +128,10 @@ export const movingAverageOperation: OperationDefinition< getDisallowedPreviousShiftMessage(layer, columnId), ]); }, - getHelpMessage: () => , + helpComponent: () => , + helpComponentTitle: i18n.translate('xpack.lens.indexPattern.movingAverage.titleHelp', { + defaultMessage: 'How moving average works', + }), getDisabledStatus(indexPattern, layer, layerType) { const opName = i18n.translate('xpack.lens.indexPattern.movingAverage', { defaultMessage: 'Moving average', @@ -217,27 +219,8 @@ function MovingAverageParamEditor({ } const MovingAveragePopup = () => { - const [isPopoverOpen, setIsPopoverOpen] = useState(false); return ( - { - setIsPopoverOpen(!isPopoverOpen); - }} - > - {i18n.translate('xpack.lens.indexPattern.movingAverage.helpText', { - defaultMessage: 'How it works', - })} - - } - closePopover={() => setIsPopoverOpen(false)} - isOpen={isPopoverOpen} - title={i18n.translate('xpack.lens.indexPattern.movingAverage.titleHelp', { - defaultMessage: 'How moving average works', - })} - > + <>

{ defaultMessage="The first moving average value starts at the second item." />

- + ); }; diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/date_histogram.tsx b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/date_histogram.tsx index f96e584326340..56b82dc03101c 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/date_histogram.tsx +++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/date_histogram.tsx @@ -5,7 +5,7 @@ * 2.0. */ -import React, { useCallback, useState } from 'react'; +import React, { useCallback } from 'react'; import { i18n } from '@kbn/i18n'; import { FormattedMessage } from '@kbn/i18n-react'; @@ -25,7 +25,6 @@ import { } from '@elastic/eui'; import { AggFunctionsMapping, - DataPublicPluginStart, IndexPatternAggRestrictions, search, UI_SETTINGS, @@ -36,7 +35,6 @@ import { updateColumnParam } from '../layer_helpers'; import { OperationDefinition, ParamEditorProps } from '.'; import { FieldBasedIndexPatternColumn } from './column_types'; import { getInvalidFieldMessage, getSafeName } from './helpers'; -import { HelpPopover, HelpPopoverButton } from '../../help_popover'; import { IndexPatternLayer } from '../../types'; import { TooltipWrapper } from '../../../shared_components'; @@ -96,7 +94,6 @@ export const dateHistogramOperation: OperationDefinition< ) || []), getMultipleDateHistogramsErrorMessage(layer, columnId) || '', ].filter(Boolean), - getHelpMessage: (props) => , getPossibleOperationForField: ({ aggregationRestrictions, aggregatable, type }) => { if ( (type === 'date' || type === 'date_range') && @@ -467,6 +464,65 @@ export const dateHistogramOperation: OperationDefinition< ); }, + helpComponentTitle: i18n.translate('xpack.lens.indexPattern.dateHistogram.titleHelp', { + defaultMessage: 'How auto date histogram works', + }), + helpComponent() { + const infiniteBound = i18n.translate('xpack.lens.indexPattern.dateHistogram.moreThanYear', { + defaultMessage: 'More than a year', + }); + const upToLabel = i18n.translate('xpack.lens.indexPattern.dateHistogram.upTo', { + defaultMessage: 'Up to', + }); + + return ( + <> +

+ {i18n.translate('xpack.lens.indexPattern.dateHistogram.autoBasicExplanation', { + defaultMessage: 'The auto date histogram splits a data field into buckets by interval.', + })} +

+ +

+ {UI_SETTINGS.HISTOGRAM_MAX_BARS}, + targetBarSetting: {UI_SETTINGS.HISTOGRAM_BAR_TARGET}, + }} + /> +

+ +

+ {i18n.translate('xpack.lens.indexPattern.dateHistogram.autoAdvancedExplanation', { + defaultMessage: 'The interval follows this logic:', + })} +

+ + ({ + bound: typeof bound === 'number' ? infiniteBound : `${upToLabel} ${boundLabel}`, + interval: intervalLabel, + }))} + columns={[ + { + field: 'bound', + name: i18n.translate('xpack.lens.indexPattern.dateHistogram.autoBoundHeader', { + defaultMessage: 'Target interval measured', + }), + }, + { + field: 'interval', + name: i18n.translate('xpack.lens.indexPattern.dateHistogram.autoIntervalHeader', { + defaultMessage: 'Interval used', + }), + }, + ]} + /> + + ); + }, }; function parseInterval(currentInterval: string) { @@ -491,79 +547,3 @@ function restrictedInterval(aggregationRestrictions?: Partial { - const [isPopoverOpen, setIsPopoverOpen] = useState(false); - const infiniteBound = i18n.translate('xpack.lens.indexPattern.dateHistogram.moreThanYear', { - defaultMessage: 'More than a year', - }); - const upToLabel = i18n.translate('xpack.lens.indexPattern.dateHistogram.upTo', { - defaultMessage: 'Up to', - }); - - return ( - { - setIsPopoverOpen(!isPopoverOpen); - }} - > - {i18n.translate('xpack.lens.indexPattern.dateHistogram.autoHelpText', { - defaultMessage: 'How it works', - })} - - } - closePopover={() => setIsPopoverOpen(false)} - isOpen={isPopoverOpen} - title={i18n.translate('xpack.lens.indexPattern.dateHistogram.titleHelp', { - defaultMessage: 'How auto date histogram works', - })} - > -

- {i18n.translate('xpack.lens.indexPattern.dateHistogram.autoBasicExplanation', { - defaultMessage: 'The auto date histogram splits a data field into buckets by interval.', - })} -

- -

- {UI_SETTINGS.HISTOGRAM_MAX_BARS}, - targetBarSetting: {UI_SETTINGS.HISTOGRAM_BAR_TARGET}, - }} - /> -

- -

- {i18n.translate('xpack.lens.indexPattern.dateHistogram.autoAdvancedExplanation', { - defaultMessage: 'The interval follows this logic:', - })} -

- - ({ - bound: typeof bound === 'number' ? infiniteBound : `${upToLabel} ${boundLabel}`, - interval: intervalLabel, - }))} - columns={[ - { - field: 'bound', - name: i18n.translate('xpack.lens.indexPattern.dateHistogram.autoBoundHeader', { - defaultMessage: 'Target interval measured', - }), - }, - { - field: 'interval', - name: i18n.translate('xpack.lens.indexPattern.dateHistogram.autoIntervalHeader', { - defaultMessage: 'Interval used', - }), - }, - ]} - /> - - ); -}; diff --git a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/index.ts b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/index.ts index e62bab6bd808b..36039a058908b 100644 --- a/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/index.ts +++ b/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/index.ts @@ -364,6 +364,14 @@ interface BaseOperationDefinitionProps * are not pass the transferable checks */ getNonTransferableFields?: (column: C, indexPattern: IndexPattern) => string[]; + /** + * Component rendered as inline help + */ + helpComponent?: React.ComponentType<{}>; + /** + * Title for the help component + */ + helpComponentTitle?: string; } interface BaseBuildColumnArgs { diff --git a/x-pack/plugins/lens/public/mocks/index.ts b/x-pack/plugins/lens/public/mocks/index.ts index ab6f2066e8804..58ef8ce05c613 100644 --- a/x-pack/plugins/lens/public/mocks/index.ts +++ b/x-pack/plugins/lens/public/mocks/index.ts @@ -31,14 +31,14 @@ export type FrameMock = jest.Mocked; export const createMockFramePublicAPI = (): FrameMock => ({ datasourceLayers: {}, - dateRange: { fromDate: 'now-7d', toDate: 'now' }, + dateRange: { fromDate: '2022-03-17T08:25:00.000Z', toDate: '2022-04-17T08:25:00.000Z' }, }); export type FrameDatasourceMock = jest.Mocked; export const createMockFrameDatasourceAPI = (): FrameDatasourceMock => ({ datasourceLayers: {}, - dateRange: { fromDate: 'now-7d', toDate: 'now' }, + dateRange: { fromDate: '2022-03-17T08:25:00.000Z', toDate: '2022-04-17T08:25:00.000Z' }, query: { query: '', language: 'lucene' }, filters: [], }); diff --git a/x-pack/plugins/lens/public/shared_components/legend_location_settings.tsx b/x-pack/plugins/lens/public/shared_components/legend_location_settings.tsx index 7372b727268bd..5e4ef239b4295 100644 --- a/x-pack/plugins/lens/public/shared_components/legend_location_settings.tsx +++ b/x-pack/plugins/lens/public/shared_components/legend_location_settings.tsx @@ -30,11 +30,11 @@ export interface LegendLocationSettingsProps { /** * Sets the vertical alignment for legend inside chart */ - verticalAlignment?: VerticalAlignment; + verticalAlignment?: typeof VerticalAlignment.Top | typeof VerticalAlignment.Bottom; /** * Sets the vertical alignment for legend inside chart */ - horizontalAlignment?: HorizontalAlignment; + horizontalAlignment?: typeof HorizontalAlignment.Left | typeof HorizontalAlignment.Right; /** * Callback on horizontal alignment option change */ diff --git a/x-pack/plugins/lens/public/shared_components/legend_settings_popover.tsx b/x-pack/plugins/lens/public/shared_components/legend_settings_popover.tsx index 560a695eaa089..944c55fb56091 100644 --- a/x-pack/plugins/lens/public/shared_components/legend_settings_popover.tsx +++ b/x-pack/plugins/lens/public/shared_components/legend_settings_popover.tsx @@ -58,11 +58,11 @@ export interface LegendSettingsPopoverProps { /** * Sets the vertical alignment for legend inside chart */ - verticalAlignment?: VerticalAlignment; + verticalAlignment?: typeof VerticalAlignment.Top | typeof VerticalAlignment.Bottom; /** * Sets the vertical alignment for legend inside chart */ - horizontalAlignment?: HorizontalAlignment; + horizontalAlignment?: typeof HorizontalAlignment.Left | typeof HorizontalAlignment.Right; /** * Callback on horizontal alignment option change */ @@ -225,13 +225,15 @@ export const LegendSettingsPopover: React.FunctionComponent - + {location !== 'inside' && ( + + )} {location && ( { handleInputChange(e.target.value); diff --git a/x-pack/plugins/lens/public/shared_components/value_labels_settings.test.tsx b/x-pack/plugins/lens/public/shared_components/value_labels_settings.test.tsx index 7f5ebcf7aa281..0d01463d333b0 100644 --- a/x-pack/plugins/lens/public/shared_components/value_labels_settings.test.tsx +++ b/x-pack/plugins/lens/public/shared_components/value_labels_settings.test.tsx @@ -38,7 +38,7 @@ describe('Value labels Settings', () => { }); it('should render the passed value if given', () => { - const component = shallow(); + const component = shallow(); expect( component.find('[data-test-subj="lens-value-labels-visibility-btn"]').prop('idSelected') ).toEqual(`value_labels_inside`); diff --git a/x-pack/plugins/lens/public/shared_components/value_labels_settings.tsx b/x-pack/plugins/lens/public/shared_components/value_labels_settings.tsx index 64d9f5475379a..f5378a2e3ba01 100644 --- a/x-pack/plugins/lens/public/shared_components/value_labels_settings.tsx +++ b/x-pack/plugins/lens/public/shared_components/value_labels_settings.tsx @@ -26,7 +26,7 @@ const valueLabelsOptions: Array<{ }, { id: `value_labels_inside`, - value: 'inside', + value: 'show', label: i18n.translate('xpack.lens.shared.valueLabelsVisibility.inside', { defaultMessage: 'Show', }), diff --git a/x-pack/plugins/lens/public/types.ts b/x-pack/plugins/lens/public/types.ts index 22d794e803df1..8c6c6d9af22dc 100644 --- a/x-pack/plugins/lens/public/types.ts +++ b/x-pack/plugins/lens/public/types.ts @@ -525,7 +525,7 @@ export interface OperationDescriptor extends Operation { export interface VisualizationConfigProps { layerId: string; - frame: Pick; + frame: FramePublicAPI; state: T; } @@ -588,7 +588,7 @@ export type VisualizationDimensionGroupConfig = SharedDimensionProps & { labels?: { buttonAriaLabel: string; buttonLabel: string }; }; -interface VisualizationDimensionChangeProps { +export interface VisualizationDimensionChangeProps { layerId: string; columnId: string; prevState: T; @@ -887,7 +887,8 @@ export interface Visualization { toExpression: ( state: T, datasourceLayers: DatasourceLayers, - attributes?: Partial<{ title: string; description: string }> + attributes?: Partial<{ title: string; description: string }>, + datasourceExpressionsByLayers?: Record ) => ExpressionAstExpression | string | null; /** * Expression to render a preview version of the chart in very constrained space. @@ -895,7 +896,8 @@ export interface Visualization { */ toPreviewExpression?: ( state: T, - datasourceLayers: DatasourceLayers + datasourceLayers: DatasourceLayers, + datasourceExpressionsByLayers?: Record ) => ExpressionAstExpression | string | null; /** * The frame will call this function on all visualizations at few stages (pre-build/build error) in order @@ -920,6 +922,12 @@ export interface Visualization { * On Edit events the frame will call this to know what's going to be the next visualization state */ onEditAction?: (state: T, event: LensEditEvent) => T; + + /** + * `datasourceExpressionsByLayers` will be passed to the params of `toExpression` and `toPreviewExpression` + * functions and datasource expressions will not be appended to the expression automatically. + */ + shouldBuildDatasourceExpressionManually?: () => boolean; } export interface LensFilterEvent { diff --git a/x-pack/plugins/lens/public/xy_visualization/__snapshots__/to_expression.test.ts.snap b/x-pack/plugins/lens/public/xy_visualization/__snapshots__/to_expression.test.ts.snap index 256df38ffa5b3..9c4ee0d3b245f 100644 --- a/x-pack/plugins/lens/public/xy_visualization/__snapshots__/to_expression.test.ts.snap +++ b/x-pack/plugins/lens/public/xy_visualization/__snapshots__/to_expression.test.ts.snap @@ -30,9 +30,6 @@ Object { "curveType": Array [ "LINEAR", ], - "description": Array [ - "", - ], "emphasizeFitting": Array [ true, ], @@ -135,6 +132,18 @@ Object { "splitAccessor": Array [ "d", ], + "table": Array [ + Object { + "chain": Array [ + Object { + "arguments": Object {}, + "function": "kibana", + "type": "function", + }, + ], + "type": "expression", + }, + ], "xAccessor": Array [ "a", ], @@ -146,7 +155,7 @@ Object { "linear", ], }, - "function": "dataLayer", + "function": "extendedDataLayer", "type": "function", }, ], @@ -204,9 +213,6 @@ Object { "type": "expression", }, ], - "title": Array [ - "", - ], "valueLabels": Array [ "hide", ], @@ -263,7 +269,7 @@ Object { "", ], }, - "function": "xyVis", + "function": "layeredXyVis", "type": "function", }, ], diff --git a/x-pack/plugins/lens/public/xy_visualization/annotations/helpers.tsx b/x-pack/plugins/lens/public/xy_visualization/annotations/helpers.tsx index fe120dc71b17a..f9f4b9da5342a 100644 --- a/x-pack/plugins/lens/public/xy_visualization/annotations/helpers.tsx +++ b/x-pack/plugins/lens/public/xy_visualization/annotations/helpers.tsx @@ -7,7 +7,11 @@ import { i18n } from '@kbn/i18n'; import moment from 'moment'; -import { defaultAnnotationColor } from '@kbn/event-annotation-plugin/public'; +import { + defaultAnnotationColor, + defaultAnnotationRangeColor, + isRangeAnnotation, +} from '@kbn/event-annotation-plugin/public'; import { layerTypes } from '../../../common'; import type { FramePublicAPI, Visualization } from '../../types'; import { isHorizontalChart } from '../state_helpers'; @@ -29,6 +33,13 @@ export const defaultAnnotationLabel = i18n.translate('xpack.lens.xyChart.default defaultMessage: 'Event', }); +export const defaultRangeAnnotationLabel = i18n.translate( + 'xpack.lens.xyChart.defaultRangeAnnotationLabel', + { + defaultMessage: 'Event range', + } +); + export function getStaticDate(dataLayers: XYDataLayerConfig[], frame: FramePublicAPI) { const dataLayersId = dataLayers.map(({ layerId }) => layerId); const { activeData, dateRange } = frame; @@ -124,6 +135,7 @@ export const setAnnotationsDimension: Visualization['setDimension'] = ( : undefined; let resultAnnotations = [...inputAnnotations] as XYAnnotationLayerConfig['annotations']; + if (!currentConfig) { resultAnnotations.push({ label: defaultAnnotationLabel, @@ -161,7 +173,9 @@ export const getAnnotationsAccessorColorConfig = (layer: XYAnnotationLayerConfig return { columnId: annotation.id, triggerIcon: annotation.isHidden ? ('invisible' as const) : ('color' as const), - color: annotation?.color || defaultAnnotationColor, + color: + annotation?.color || + (isRangeAnnotation(annotation) ? defaultAnnotationRangeColor : defaultAnnotationColor), }; }); }; diff --git a/x-pack/plugins/lens/public/xy_visualization/axes_configuration.test.ts b/x-pack/plugins/lens/public/xy_visualization/axes_configuration.test.ts index db8ae7122c538..73b355bce7ed2 100644 --- a/x-pack/plugins/lens/public/xy_visualization/axes_configuration.test.ts +++ b/x-pack/plugins/lens/public/xy_visualization/axes_configuration.test.ts @@ -5,10 +5,10 @@ * 2.0. */ -import { DataLayerConfigResult } from '@kbn/expression-xy-plugin/common'; import { layerTypes } from '../../common'; import { Datatable } from '@kbn/expressions-plugin/public'; import { getAxesConfiguration } from './axes_configuration'; +import { XYDataLayerConfig } from './types'; describe('axes_configuration', () => { const tables: Record = { @@ -219,8 +219,7 @@ describe('axes_configuration', () => { }, }; - const sampleLayer: DataLayerConfigResult = { - type: 'dataLayer', + const sampleLayer: XYDataLayerConfig = { layerId: 'first', layerType: layerTypes.DATA, seriesType: 'line', diff --git a/x-pack/plugins/lens/public/xy_visualization/reference_line_helpers.tsx b/x-pack/plugins/lens/public/xy_visualization/reference_line_helpers.tsx index c7e615bb29e12..5ddb1fcc043e7 100644 --- a/x-pack/plugins/lens/public/xy_visualization/reference_line_helpers.tsx +++ b/x-pack/plugins/lens/public/xy_visualization/reference_line_helpers.tsx @@ -7,7 +7,7 @@ import { groupBy, partition } from 'lodash'; import { i18n } from '@kbn/i18n'; -import type { YAxisMode, YConfig } from '@kbn/expression-xy-plugin/common'; +import type { YAxisMode, ExtendedYConfig } from '@kbn/expression-xy-plugin/common'; import { Datatable } from '@kbn/expressions-plugin/public'; import { layerTypes } from '../../common'; import type { DatasourceLayers, FramePublicAPI, Visualization } from '../types'; @@ -34,7 +34,7 @@ export interface ReferenceLineBase { * * what groups are current defined in data layers * * what existing reference line are currently defined in reference layers */ -export function getGroupsToShow( +export function getGroupsToShow( referenceLayers: T[], state: XYState | undefined, datasourceLayers: DatasourceLayers, @@ -104,6 +104,7 @@ export function getStaticValue( untouchedDataLayers, accessors, } = getAccessorCriteriaForGroup(groupId, dataLayers, activeData); + if ( groupId === 'x' && filteredLayers.length && @@ -111,6 +112,7 @@ export function getStaticValue( ) { return fallbackValue; } + const computedValue = computeStaticValueForGroup( filteredLayers, accessors, @@ -118,6 +120,7 @@ export function getStaticValue( groupId !== 'x', // histogram axis should compute the min based on the current data groupId !== 'x' ); + return computedValue ?? fallbackValue; } @@ -165,6 +168,7 @@ export function computeOverallDataDomain( const accessorMap = new Set(accessorIds); let min: number | undefined; let max: number | undefined; + const [stacked, unstacked] = partition( dataLayers, ({ seriesType }) => isStackedChart(seriesType) && allowStacking @@ -268,13 +272,17 @@ export const getReferenceSupportedLayer = ( label: 'x' as const, }, ]; + const referenceLineGroups = getGroupsRelatedToData( referenceLineGroupIds, state, frame?.datasourceLayers || {}, frame?.activeData ); - const dataLayers = getDataLayers(state?.layers || []); + + const layers = state?.layers || []; + const dataLayers = getDataLayers(layers); + const filledDataLayers = dataLayers.filter( ({ accessors, xAccessor }) => accessors.length || xAccessor ); @@ -289,7 +297,7 @@ export const getReferenceSupportedLayer = ( groupId: id, columnId: generateId(), dataType: 'number', - label: getAxisName(label, { isHorizontal: isHorizontalChart(state?.layers || []) }), + label: getAxisName(label, { isHorizontal: isHorizontalChart(layers) }), staticValue: getStaticValue( dataLayers, label, @@ -317,6 +325,7 @@ export const getReferenceSupportedLayer = ( initialDimensions, }; }; + export const setReferenceDimension: Visualization['setDimension'] = ({ prevState, layerId, @@ -397,6 +406,7 @@ export const getReferenceConfiguration = ({ return axisMode; } ); + const groupsToShow = getGroupsToShow( [ // When a reference layer panel is added, a static reference line should automatically be included by default @@ -422,7 +432,7 @@ export const getReferenceConfiguration = ({ ], state, frame.datasourceLayers, - frame?.activeData + frame.activeData ); const isHorizontal = isHorizontalChart(state.layers); return { diff --git a/x-pack/plugins/lens/public/xy_visualization/state_helpers.ts b/x-pack/plugins/lens/public/xy_visualization/state_helpers.ts index 06ea897afa1e7..f37ad12f606b1 100644 --- a/x-pack/plugins/lens/public/xy_visualization/state_helpers.ts +++ b/x-pack/plugins/lens/public/xy_visualization/state_helpers.ts @@ -6,7 +6,7 @@ */ import { EuiIconType } from '@elastic/eui/src/components/icon/icon'; -import type { SeriesType, YConfig, ValidLayer } from '@kbn/expression-xy-plugin/common'; +import type { SeriesType, ExtendedYConfig } from '@kbn/expression-xy-plugin/common'; import type { FramePublicAPI, DatasourcePublicAPI } from '../types'; import { visualizationTypes, @@ -58,7 +58,8 @@ export const getSeriesColor = (layer: XYLayerConfig, accessor: string) => { return null; } return ( - layer?.yConfig?.find((yConfig: YConfig) => yConfig.forAccessor === accessor)?.color || null + layer?.yConfig?.find((yConfig: ExtendedYConfig) => yConfig.forAccessor === accessor)?.color || + null ); }; @@ -79,7 +80,7 @@ export const getColumnToLabelMap = ( }; export function hasHistogramSeries( - layers: ValidLayer[] = [], + layers: XYDataLayerConfig[] = [], datasourceLayers?: FramePublicAPI['datasourceLayers'] ) { if (!datasourceLayers) { @@ -87,7 +88,11 @@ export function hasHistogramSeries( } const validLayers = layers.filter(({ accessors }) => accessors.length); - return validLayers.some(({ layerId, xAccessor }: ValidLayer) => { + return validLayers.some(({ layerId, xAccessor }: XYDataLayerConfig) => { + if (!xAccessor) { + return false; + } + const xAxisOperation = datasourceLayers[layerId].getOperationForColumnId(xAccessor); return ( xAxisOperation && diff --git a/x-pack/plugins/lens/public/xy_visualization/to_expression.test.ts b/x-pack/plugins/lens/public/xy_visualization/to_expression.test.ts index 7cd9a43540c0a..d39b9914f0eef 100644 --- a/x-pack/plugins/lens/public/xy_visualization/to_expression.test.ts +++ b/x-pack/plugins/lens/public/xy_visualization/to_expression.test.ts @@ -5,7 +5,7 @@ * 2.0. */ -import { Ast } from '@kbn/interpreter'; +import { Ast, fromExpression } from '@kbn/interpreter'; import { Position } from '@elastic/charts'; import { chartPluginMock } from '@kbn/charts-plugin/public/mocks'; import { getXyVisualization } from './xy_visualization'; @@ -28,6 +28,8 @@ describe('#toExpression', () => { let mockDatasource: ReturnType; let frame: ReturnType; + let datasourceExpressionsByLayers: Record; + beforeEach(() => { frame = createMockFramePublicAPI(); mockDatasource = createMockDatasource('testDatasource'); @@ -46,6 +48,23 @@ describe('#toExpression', () => { frame.datasourceLayers = { first: mockDatasource.publicAPIMock, }; + + const datasourceExpression = mockDatasource.toExpression( + frame.datasourceLayers.first, + 'first' + ) ?? { + type: 'expression', + chain: [], + }; + const exprAst = + typeof datasourceExpression === 'string' + ? fromExpression(datasourceExpression) + : datasourceExpression; + + datasourceExpressionsByLayers = { + first: exprAst, + referenceLine: exprAst, + }; }); it('should map to a valid AST', () => { @@ -82,7 +101,9 @@ describe('#toExpression', () => { }, ], }, - frame.datasourceLayers + frame.datasourceLayers, + undefined, + datasourceExpressionsByLayers ) ).toMatchSnapshot(); }); @@ -106,7 +127,9 @@ describe('#toExpression', () => { }, ], }, - frame.datasourceLayers + frame.datasourceLayers, + undefined, + datasourceExpressionsByLayers ) as Ast ).chain[0].arguments.fittingFunction[0] ).toEqual('None'); @@ -129,7 +152,9 @@ describe('#toExpression', () => { }, ], }, - frame.datasourceLayers + frame.datasourceLayers, + undefined, + datasourceExpressionsByLayers ) as Ast; expect( (expression.chain[0].arguments.axisTitlesVisibilitySettings[0] as Ast).chain[0].arguments @@ -157,7 +182,9 @@ describe('#toExpression', () => { }, ], }, - frame.datasourceLayers + frame.datasourceLayers, + undefined, + datasourceExpressionsByLayers ) as Ast; expect((expression.chain[0].arguments.layers[0] as Ast).chain[0].arguments.xAccessor).toEqual( [] @@ -182,7 +209,9 @@ describe('#toExpression', () => { }, ], }, - frame.datasourceLayers + frame.datasourceLayers, + undefined, + datasourceExpressionsByLayers ) ).toBeNull(); }); @@ -204,7 +233,9 @@ describe('#toExpression', () => { }, ], }, - frame.datasourceLayers + frame.datasourceLayers, + undefined, + datasourceExpressionsByLayers )! as Ast; expect(mockDatasource.publicAPIMock.getOperationForColumnId).toHaveBeenCalledWith('b'); @@ -241,7 +272,9 @@ describe('#toExpression', () => { }, ], }, - frame.datasourceLayers + frame.datasourceLayers, + undefined, + datasourceExpressionsByLayers ) as Ast; expect( (expression.chain[0].arguments.tickLabelsVisibilitySettings[0] as Ast).chain[0].arguments @@ -269,7 +302,9 @@ describe('#toExpression', () => { }, ], }, - frame.datasourceLayers + frame.datasourceLayers, + undefined, + datasourceExpressionsByLayers ) as Ast; expect((expression.chain[0].arguments.labelsOrientation[0] as Ast).chain[0].arguments).toEqual({ x: [0], @@ -295,7 +330,9 @@ describe('#toExpression', () => { }, ], }, - frame.datasourceLayers + frame.datasourceLayers, + undefined, + datasourceExpressionsByLayers ) as Ast; expect( (expression.chain[0].arguments.gridlinesVisibilitySettings[0] as Ast).chain[0].arguments @@ -310,7 +347,7 @@ describe('#toExpression', () => { const expression = xyVisualization.toExpression( { legend: { position: Position.Bottom, isVisible: true }, - valueLabels: 'inside', + valueLabels: 'show', preferredSeriesType: 'bar', layers: [ { @@ -323,16 +360,18 @@ describe('#toExpression', () => { }, ], }, - frame.datasourceLayers + frame.datasourceLayers, + undefined, + datasourceExpressionsByLayers ) as Ast; - expect(expression.chain[0].arguments.valueLabels[0] as Ast).toEqual('inside'); + expect(expression.chain[0].arguments.valueLabels[0] as Ast).toEqual('show'); }); it('should compute the correct series color fallback based on the layer type', () => { const expression = xyVisualization.toExpression( { legend: { position: Position.Bottom, isVisible: true }, - valueLabels: 'inside', + valueLabels: 'show', preferredSeriesType: 'bar', layers: [ { @@ -352,7 +391,9 @@ describe('#toExpression', () => { }, ], }, - { ...frame.datasourceLayers, referenceLine: mockDatasource.publicAPIMock } + { ...frame.datasourceLayers, referenceLine: mockDatasource.publicAPIMock }, + undefined, + datasourceExpressionsByLayers ) as Ast; function getYConfigColorForLayer(ast: Ast, index: number) { diff --git a/x-pack/plugins/lens/public/xy_visualization/to_expression.ts b/x-pack/plugins/lens/public/xy_visualization/to_expression.ts index eeb56bd7ee115..1c73c455dfe9e 100644 --- a/x-pack/plugins/lens/public/xy_visualization/to_expression.ts +++ b/x-pack/plugins/lens/public/xy_visualization/to_expression.ts @@ -10,13 +10,15 @@ import { ScaleType } from '@elastic/charts'; import type { PaletteRegistry } from '@kbn/coloring'; import { EventAnnotationServiceType } from '@kbn/event-annotation-plugin/public'; -import type { ValidLayer, YConfig } from '@kbn/expression-xy-plugin/common'; +import type { AxisExtentConfig, ExtendedYConfig, YConfig } from '@kbn/expression-xy-plugin/common'; +import type { ExpressionAstExpression } from '@kbn/expressions-plugin/common'; import { State, XYDataLayerConfig, XYReferenceLineLayerConfig, XYAnnotationLayerConfig, } from './types'; +import type { ValidXYDataLayerConfig } from './types'; import { OperationMetadata, DatasourcePublicAPI, DatasourceLayers } from '../types'; import { getColumnToLabelMap } from './state_helpers'; import { hasIcon } from './xy_config_panel/shared/icon_select'; @@ -28,7 +30,7 @@ import { getReferenceLayers, getAnnotationsLayers, } from './visualization_helpers'; -import { getUniqueLabels, defaultAnnotationLabel } from './annotations/helpers'; +import { getUniqueLabels } from './annotations/helpers'; import { layerTypes } from '../../common'; export const getSortedAccessors = ( @@ -50,6 +52,7 @@ export const toExpression = ( datasourceLayers: DatasourceLayers, paletteService: PaletteRegistry, attributes: Partial<{ title: string; description: string }> = {}, + datasourceExpressionsByLayers: Record, eventAnnotationService: EventAnnotationServiceType ): Ast | null => { if (!state || !state.layers.length) { @@ -73,7 +76,7 @@ export const toExpression = ( metadata, datasourceLayers, paletteService, - attributes, + datasourceExpressionsByLayers, eventAnnotationService ); }; @@ -83,7 +86,7 @@ const simplifiedLayerExpression = { [layerTypes.REFERENCELINE]: (layer: XYReferenceLineLayerConfig) => ({ ...layer, hide: true, - yConfig: layer.yConfig?.map(({ lineWidth, ...rest }) => ({ + yConfig: layer.yConfig?.map(({ ...rest }) => ({ ...rest, lineWidth: 1, icon: undefined, @@ -93,12 +96,6 @@ const simplifiedLayerExpression = { [layerTypes.ANNOTATIONS]: (layer: XYAnnotationLayerConfig) => ({ ...layer, hide: true, - annotations: layer.annotations?.map(({ lineWidth, ...rest }) => ({ - ...rest, - lineWidth: 1, - icon: undefined, - textVisibility: false, - })), }), }; @@ -106,6 +103,7 @@ export function toPreviewExpression( state: State, datasourceLayers: DatasourceLayers, paletteService: PaletteRegistry, + datasourceExpressionsByLayers: Record, eventAnnotationService: EventAnnotationServiceType ) { return toExpression( @@ -122,6 +120,7 @@ export function toPreviewExpression( datasourceLayers, paletteService, {}, + datasourceExpressionsByLayers, eventAnnotationService ); } @@ -157,11 +156,13 @@ export const buildExpression = ( metadata: Record>, datasourceLayers: DatasourceLayers, paletteService: PaletteRegistry, - attributes: Partial<{ title: string; description: string }> = {}, + datasourceExpressionsByLayers: Record, eventAnnotationService: EventAnnotationServiceType ): Ast | null => { - const validDataLayers = getDataLayers(state.layers) - .filter((layer): layer is ValidLayer => Boolean(layer.accessors.length)) + const validDataLayers: ValidXYDataLayerConfig[] = getDataLayers(state.layers) + .filter((layer): layer is ValidXYDataLayerConfig => + Boolean(layer.accessors.length) + ) .map((layer) => ({ ...layer, accessors: getSortedAccessors(datasourceLayers[layer.layerId], layer), @@ -194,10 +195,8 @@ export const buildExpression = ( chain: [ { type: 'function', - function: 'xyVis', + function: 'layeredXyVis', arguments: { - title: [attributes?.title || ''], - description: [attributes?.description || ''], xTitle: [state.xTitle || ''], yTitle: [state.yTitle || ''], yRightTitle: [state.yRightTitle || ''], @@ -213,20 +212,26 @@ export const buildExpression = ( showSingleSeries: state.legend.showSingleSeries ? [state.legend.showSingleSeries] : [], - position: [state.legend.position], + position: !state.legend.isInside ? [state.legend.position] : [], isInside: state.legend.isInside ? [state.legend.isInside] : [], - legendSize: state.legend.legendSize ? [state.legend.legendSize] : [], - horizontalAlignment: state.legend.horizontalAlignment - ? [state.legend.horizontalAlignment] - : [], - verticalAlignment: state.legend.verticalAlignment - ? [state.legend.verticalAlignment] - : [], + legendSize: + !state.legend.isInside && state.legend.legendSize + ? [state.legend.legendSize] + : [], + horizontalAlignment: + state.legend.horizontalAlignment && state.legend.isInside + ? [state.legend.horizontalAlignment] + : [], + verticalAlignment: + state.legend.verticalAlignment && state.legend.isInside + ? [state.legend.verticalAlignment] + : [], // ensure that even if the user types more than 5 columns // we will only show 5 - floatingColumns: state.legend.floatingColumns - ? [Math.min(5, state.legend.floatingColumns)] - : [], + floatingColumns: + state.legend.floatingColumns && state.legend.isInside + ? [Math.min(5, state.legend.floatingColumns)] + : [], maxLines: state.legend.maxLines ? [state.legend.maxLines] : [], shouldTruncate: [ state.legend.shouldTruncate ?? @@ -242,50 +247,8 @@ export const buildExpression = ( emphasizeFitting: [state.emphasizeFitting || false], curveType: [state.curveType || 'LINEAR'], fillOpacity: [state.fillOpacity || 0.3], - yLeftExtent: [ - { - type: 'expression', - chain: [ - { - type: 'function', - function: 'axisExtentConfig', - arguments: { - mode: [state?.yLeftExtent?.mode || 'full'], - lowerBound: - state?.yLeftExtent?.lowerBound !== undefined - ? [state?.yLeftExtent?.lowerBound] - : [], - upperBound: - state?.yLeftExtent?.upperBound !== undefined - ? [state?.yLeftExtent?.upperBound] - : [], - }, - }, - ], - }, - ], - yRightExtent: [ - { - type: 'expression', - chain: [ - { - type: 'function', - function: 'axisExtentConfig', - arguments: { - mode: [state?.yRightExtent?.mode || 'full'], - lowerBound: - state?.yRightExtent?.lowerBound !== undefined - ? [state?.yRightExtent?.lowerBound] - : [], - upperBound: - state?.yRightExtent?.upperBound !== undefined - ? [state?.yRightExtent?.upperBound] - : [], - }, - }, - ], - }, - ], + yLeftExtent: [axisExtentConfigToExpression(state.yLeftExtent, validDataLayers)], + yRightExtent: [axisExtentConfigToExpression(state.yRightExtent, validDataLayers)], axisTitlesVisibilitySettings: [ { type: 'expression', @@ -359,13 +322,15 @@ export const buildExpression = ( layer, datasourceLayers[layer.layerId], metadata, - paletteService + paletteService, + datasourceExpressionsByLayers[layer.layerId] ) ), ...validReferenceLayers.map((layer) => referenceLineLayerToExpression( layer, - datasourceLayers[(layer as XYReferenceLineLayerConfig).layerId] + datasourceLayers[(layer as XYReferenceLineLayerConfig).layerId], + datasourceExpressionsByLayers[layer.layerId] ) ), ...validAnnotationsLayers.map((layer) => @@ -378,25 +343,32 @@ export const buildExpression = ( }; }; +const buildTableExpression = (datasourceExpression: Ast): ExpressionAstExpression => ({ + type: 'expression', + chain: [{ type: 'function', function: 'kibana', arguments: {} }, ...datasourceExpression.chain], +}); + const referenceLineLayerToExpression = ( layer: XYReferenceLineLayerConfig, - datasourceLayer: DatasourcePublicAPI + datasourceLayer: DatasourcePublicAPI, + datasourceExpression: Ast ): Ast => { return { type: 'expression', chain: [ { type: 'function', - function: 'referenceLineLayer', + function: 'extendedReferenceLineLayer', arguments: { layerId: [layer.layerId], yConfig: layer.yConfig ? layer.yConfig.map((yConfig) => - yConfigToExpression(yConfig, defaultReferenceLineColor) + extendedYConfigToExpression(yConfig, defaultReferenceLineColor) ) : [], accessors: layer.accessors, columnToLabel: [JSON.stringify(getColumnToLabelMap(layer, datasourceLayer))], + ...(datasourceExpression ? { table: [buildTableExpression(datasourceExpression)] } : {}), }, }, ], @@ -412,24 +384,12 @@ const annotationLayerToExpression = ( chain: [ { type: 'function', - function: 'annotationLayer', + function: 'extendedAnnotationLayer', arguments: { hide: [Boolean(layer.hide)], layerId: [layer.layerId], annotations: layer.annotations - ? layer.annotations.map( - (ann): Ast => - eventAnnotationService.toExpression({ - time: ann.key.timestamp, - label: ann.label || defaultAnnotationLabel, - textVisibility: ann.textVisibility, - icon: ann.icon, - lineStyle: ann.lineStyle, - lineWidth: ann.lineWidth, - color: ann.color, - isHidden: Boolean(ann.isHidden), - }) - ) + ? layer.annotations.map((ann): Ast => eventAnnotationService.toExpression(ann)) : [], }, }, @@ -438,10 +398,11 @@ const annotationLayerToExpression = ( }; const dataLayerToExpression = ( - layer: ValidLayer, + layer: ValidXYDataLayerConfig, datasourceLayer: DatasourcePublicAPI, metadata: Record>, - paletteService: PaletteRegistry + paletteService: PaletteRegistry, + datasourceExpression: Ast ): Ast => { const columnToLabel = getColumnToLabelMap(layer, datasourceLayer); @@ -459,7 +420,7 @@ const dataLayerToExpression = ( chain: [ { type: 'function', - function: 'dataLayer', + function: 'extendedDataLayer', arguments: { layerId: [layer.layerId], hide: [Boolean(layer.hide)], @@ -476,6 +437,7 @@ const dataLayerToExpression = ( seriesType: [layer.seriesType], accessors: layer.accessors, columnToLabel: [JSON.stringify(columnToLabel)], + ...(datasourceExpression ? { table: [buildTableExpression(datasourceExpression)] } : {}), palette: [ { type: 'expression', @@ -514,6 +476,23 @@ const yConfigToExpression = (yConfig: YConfig, defaultColor?: string): Ast => { { type: 'function', function: 'yConfig', + arguments: { + forAccessor: [yConfig.forAccessor], + axisMode: yConfig.axisMode ? [yConfig.axisMode] : [], + color: yConfig.color ? [yConfig.color] : defaultColor ? [defaultColor] : [], + }, + }, + ], + }; +}; + +const extendedYConfigToExpression = (yConfig: ExtendedYConfig, defaultColor?: string): Ast => { + return { + type: 'expression', + chain: [ + { + type: 'function', + function: 'extendedYConfig', arguments: { forAccessor: [yConfig.forAccessor], axisMode: yConfig.axisMode ? [yConfig.axisMode] : [], @@ -532,3 +511,21 @@ const yConfigToExpression = (yConfig: YConfig, defaultColor?: string): Ast => { ], }; }; + +const axisExtentConfigToExpression = ( + extent: AxisExtentConfig | undefined, + layers: ValidXYDataLayerConfig[] +): Ast => ({ + type: 'expression', + chain: [ + { + type: 'function', + function: 'axisExtentConfig', + arguments: { + mode: [extent?.mode ?? 'full'], + lowerBound: extent?.lowerBound !== undefined ? [extent?.lowerBound] : [], + upperBound: extent?.upperBound !== undefined ? [extent?.upperBound] : [], + }, + }, + ], +}); diff --git a/x-pack/plugins/lens/public/xy_visualization/types.ts b/x-pack/plugins/lens/public/xy_visualization/types.ts index 276e338807a35..b96ddf1aaee2d 100644 --- a/x-pack/plugins/lens/public/xy_visualization/types.ts +++ b/x-pack/plugins/lens/public/xy_visualization/types.ts @@ -16,7 +16,10 @@ import type { FittingFunction, LabelsOrientationConfig, EndValue, + ExtendedYConfig, YConfig, + YScaleType, + XScaleType, } from '@kbn/expression-xy-plugin/common'; import { EventAnnotationConfig } from '@kbn/event-annotation-plugin/common'; import { LensIconChartArea } from '../assets/chart_area'; @@ -43,12 +46,16 @@ export interface XYDataLayerConfig { yConfig?: YConfig[]; splitAccessor?: string; palette?: PaletteOutput; + yScaleType?: YScaleType; + xScaleType?: XScaleType; + isHistogram?: boolean; + columnToLabel?: string; } export interface XYReferenceLineLayerConfig { layerId: string; accessors: string[]; - yConfig?: YConfig[]; + yConfig?: ExtendedYConfig[]; layerType: 'referenceLine'; } @@ -64,6 +71,13 @@ export type XYLayerConfig = | XYReferenceLineLayerConfig | XYAnnotationLayerConfig; +export interface ValidXYDataLayerConfig extends XYDataLayerConfig { + xAccessor: NonNullable; + layerId: string; +} + +export type ValidLayer = ValidXYDataLayerConfig | XYReferenceLineLayerConfig; + // Persisted parts of the state export interface XYState { preferredSeriesType: SeriesType; diff --git a/x-pack/plugins/lens/public/xy_visualization/visualization.tsx b/x-pack/plugins/lens/public/xy_visualization/visualization.tsx index d67adb3b860e3..97bac36a93465 100644 --- a/x-pack/plugins/lens/public/xy_visualization/visualization.tsx +++ b/x-pack/plugins/lens/public/xy_visualization/visualization.tsx @@ -16,7 +16,12 @@ import { ThemeServiceStart } from '@kbn/core/public'; import { EventAnnotationServiceType } from '@kbn/event-annotation-plugin/public'; import { KibanaThemeProvider } from '@kbn/kibana-react-plugin/public'; import { VIS_EVENT_TO_TRIGGER } from '@kbn/visualizations-plugin/public'; -import { FillStyle, SeriesType, YAxisMode, YConfig } from '@kbn/expression-xy-plugin/common'; +import { + FillStyle, + SeriesType, + YAxisMode, + ExtendedYConfig, +} from '@kbn/expression-xy-plugin/common'; import { getSuggestions } from './xy_suggestions'; import { XyToolbar } from './xy_config_panel'; import { DimensionEditor } from './xy_config_panel/dimension_editor'; @@ -61,7 +66,7 @@ import { } from './visualization_helpers'; import { groupAxesByType } from './axes_configuration'; import { XYState } from './types'; -import { ReferenceLinePanel } from './xy_config_panel/reference_line_panel'; +import { ReferenceLinePanel } from './xy_config_panel/reference_line_config_panel'; import { AnnotationsPanel } from './xy_config_panel/annotations_config_panel'; import { DimensionTrigger } from '../shared_components/dimension_trigger'; import { defaultAnnotationLabel } from './annotations/helpers'; @@ -295,6 +300,7 @@ export const getXyVisualization = ({ setDimension(props) { const { prevState, layerId, columnId, groupId } = props; + const foundLayer: XYLayerConfig | undefined = prevState.layers.find( (l) => l.layerId === layerId ); @@ -333,7 +339,7 @@ export const getXyVisualization = ({ } const isReferenceLine = metrics.some((metric) => metric.agg === 'static_value'); const axisMode = axisPosition as YAxisMode; - const yConfig = metrics.map((metric, idx) => { + const yConfig = metrics.map((metric, idx) => { return { color: metric.color, forAccessor: metric.accessor ?? foundLayer.accessors[idx], @@ -444,7 +450,7 @@ export const getXyVisualization = ({ const groupsAvailable = getGroupsAvailableInData( getDataLayers(prevState.layers), frame.datasourceLayers, - frame?.activeData + frame.activeData ); if ( @@ -508,10 +514,26 @@ export const getXyVisualization = ({ ); }, - toExpression: (state, layers, attributes) => - toExpression(state, layers, paletteService, attributes, eventAnnotationService), - toPreviewExpression: (state, layers) => - toPreviewExpression(state, layers, paletteService, eventAnnotationService), + shouldBuildDatasourceExpressionManually: () => true, + + toExpression: (state, layers, attributes, datasourceExpressionsByLayers = {}) => + toExpression( + state, + layers, + paletteService, + attributes, + datasourceExpressionsByLayers, + eventAnnotationService + ), + + toPreviewExpression: (state, layers, datasourceExpressionsByLayers = {}) => + toPreviewExpression( + state, + layers, + paletteService, + datasourceExpressionsByLayers, + eventAnnotationService + ), getErrorMessages(state, datasourceLayers) { // Data error handling below here @@ -592,10 +614,12 @@ export const getXyVisualization = ({ ...getDataLayers(state.layers), ...getReferenceLayers(state.layers), ].filter(({ accessors }) => accessors.length > 0); + const accessorsWithArrayValues = []; + for (const layer of filteredLayers) { const { layerId, accessors } = layer; - const rows = frame.activeData[layerId] && frame.activeData[layerId].rows; + const rows = frame.activeData?.[layerId] && frame.activeData[layerId].rows; if (!rows) { break; } @@ -607,6 +631,7 @@ export const getXyVisualization = ({ } } } + return accessorsWithArrayValues.map((label) => ( { + return new Color(transparentize(color, 0.1)).hexa(); +}; + +export const toLineAnnotationColor = (color = defaultAnnotationRangeColor) => { + return new Color(transparentize(color, 1)).hex(); +}; + +export const getEndTimestamp = ( + startTime: string, + { activeData, dateRange }: FramePublicAPI, + dataLayers: XYDataLayerConfig[] +) => { + const startTimeNumber = moment(startTime).valueOf(); + const dateRangeFraction = + (moment(dateRange.toDate).valueOf() - moment(dateRange.fromDate).valueOf()) * 0.1; + const fallbackValue = moment(startTimeNumber + dateRangeFraction).toISOString(); + const dataLayersId = dataLayers.map(({ layerId }) => layerId); + if ( + !dataLayersId.length || + !activeData || + Object.entries(activeData) + .filter(([key]) => dataLayersId.includes(key)) + .every(([, { rows }]) => !rows || !rows.length) + ) { + return fallbackValue; + } + const xColumn = activeData?.[dataLayersId[0]].columns.find( + (column) => column.id === dataLayers[0].xAccessor + ); + if (!xColumn) { + return fallbackValue; + } + + const dateInterval = search.aggs.getDateHistogramMetaDataByDatatableColumn(xColumn)?.interval; + if (!dateInterval) return fallbackValue; + const intervalDuration = search.aggs.parseInterval(dateInterval); + if (!intervalDuration) return fallbackValue; + return moment(startTimeNumber + 3 * intervalDuration.as('milliseconds')).toISOString(); +}; + +const sanitizeProperties = (annotation: EventAnnotationConfig) => { + if (isRangeAnnotation(annotation)) { + const rangeAnnotation: RangeEventAnnotationConfig = pick(annotation, [ + 'label', + 'key', + 'id', + 'isHidden', + 'color', + 'outside', + ]); + return rangeAnnotation; + } else { + const lineAnnotation: PointInTimeEventAnnotationConfig = pick(annotation, [ + 'id', + 'label', + 'key', + 'isHidden', + 'lineStyle', + 'lineWidth', + 'color', + 'icon', + 'textVisibility', + ]); + return lineAnnotation; + } +}; + +export const AnnotationsPanel = ( + props: VisualizationDimensionEditorProps & { + formatFactory: FormatFactory; + paletteService: PaletteRegistry; + } +) => { + const { state, setState, layerId, accessor, frame } = props; + const isHorizontal = isHorizontalChart(state.layers); + + const { inputValue: localState, handleInputChange: setLocalState } = useDebouncedValue({ + value: state, + onChange: setState, + }); + + const index = localState.layers.findIndex((l) => l.layerId === layerId); + const localLayer = localState.layers.find( + (l) => l.layerId === layerId + ) as XYAnnotationLayerConfig; + + const currentAnnotation = localLayer.annotations?.find((c) => c.id === accessor); + + const isRange = isRangeAnnotation(currentAnnotation); + + const setAnnotations = useCallback( + (annotation) => { + if (annotation == null) { + return; + } + const newConfigs = [...(localLayer.annotations || [])]; + const existingIndex = newConfigs.findIndex((c) => c.id === accessor); + if (existingIndex !== -1) { + newConfigs[existingIndex] = sanitizeProperties({ + ...newConfigs[existingIndex], + ...annotation, + }); + } else { + throw new Error( + 'should never happen because annotation is created before config panel is opened' + ); + } + setLocalState(updateLayer(localState, { ...localLayer, annotations: newConfigs }, index)); + }, + [accessor, index, localState, localLayer, setLocalState] + ); + + return ( + <> + + {isRange ? ( + <> + { + if (date) { + const currentEndTime = moment(currentAnnotation?.key.endTimestamp).valueOf(); + if (currentEndTime < date.valueOf()) { + const currentStartTime = moment(currentAnnotation?.key.timestamp).valueOf(); + const dif = currentEndTime - currentStartTime; + setAnnotations({ + key: { + ...(currentAnnotation?.key || { type: 'range' }), + timestamp: date.toISOString(), + endTimestamp: moment(date.valueOf() + dif).toISOString(), + }, + }); + } else { + setAnnotations({ + key: { + ...(currentAnnotation?.key || { type: 'range' }), + timestamp: date.toISOString(), + }, + }); + } + } + }} + label={i18n.translate('xpack.lens.xyChart.annotationDate', { + defaultMessage: 'Annotation date', + })} + /> + { + if (date) { + const currentStartTime = moment(currentAnnotation?.key.timestamp).valueOf(); + if (currentStartTime > date.valueOf()) { + const currentEndTime = moment(currentAnnotation?.key.endTimestamp).valueOf(); + const dif = currentEndTime - currentStartTime; + setAnnotations({ + key: { + ...(currentAnnotation?.key || { type: 'range' }), + endTimestamp: date.toISOString(), + timestamp: moment(date.valueOf() - dif).toISOString(), + }, + }); + } else { + setAnnotations({ + key: { + ...(currentAnnotation?.key || { type: 'range' }), + endTimestamp: date.toISOString(), + }, + }); + } + } + }} + /> + + ) : ( + { + if (date) { + setAnnotations({ + key: { + ...(currentAnnotation?.key || { type: 'point_in_time' }), + timestamp: date.toISOString(), + }, + }); + } + }} + /> + )} + + + + + { + setAnnotations({ label: value }); + }} + /> + {!isRange && ( + + )} + {!isRange && ( + + )} + {!isRange && ( + + )} + + {isRange && ( + + { + setAnnotations({ + outside: id === `lens_xyChart_fillStyle_outside`, + }); + }} + isFullWidth + /> + + )} + + + setAnnotations({ isHidden: ev.target.checked })} + /> + + + ); +}; + +const ConfigPanelApplyAsRangeSwitch = ({ + annotation, + onChange, + frame, + state, +}: { + annotation?: EventAnnotationConfig; + onChange: (annotations: Partial | undefined) => void; + frame: FramePublicAPI; + state: XYState; +}) => { + const isRange = isRangeAnnotation(annotation); + return ( + + + {i18n.translate('xpack.lens.xyChart.applyAsRange', { + defaultMessage: 'Apply as range', + })} + + } + checked={isRange} + onChange={() => { + if (isRange) { + const newPointAnnotation: PointInTimeEventAnnotationConfig = { + key: { + type: 'point_in_time', + timestamp: annotation.key.timestamp, + }, + id: annotation.id, + label: + annotation.label === defaultRangeAnnotationLabel + ? defaultAnnotationLabel + : annotation.label, + color: toLineAnnotationColor(annotation.color), + isHidden: annotation.isHidden, + }; + onChange(newPointAnnotation); + } else if (annotation) { + const fromTimestamp = moment(annotation?.key.timestamp); + const dataLayers = getDataLayers(state.layers); + const newRangeAnnotation: RangeEventAnnotationConfig = { + key: { + type: 'range', + timestamp: annotation.key.timestamp, + endTimestamp: getEndTimestamp(fromTimestamp.toISOString(), frame, dataLayers), + }, + id: annotation.id, + label: + annotation.label === defaultAnnotationLabel + ? defaultRangeAnnotationLabel + : annotation.label, + color: toRangeAnnotationColor(annotation.color), + isHidden: annotation.isHidden, + }; + onChange(newRangeAnnotation); + } + }} + compressed + /> + + ); +}; + +const ConfigPanelRangeDatePicker = ({ + value, + label, + prependLabel, + onChange, + dataTestSubj = 'lnsXY_annotation_date_picker', +}: { + value: moment.Moment; + prependLabel?: string; + label?: string; + onChange: (val: moment.Moment | null) => void; + dataTestSubj?: string; +}) => { + return ( + + {prependLabel ? ( + {prependLabel} + } + > + + + ) : ( + + )} + + ); +}; + +const ConfigPanelHideSwitch = ({ + value, + onChange, +}: { + value: boolean; + onChange: (event: EuiSwitchEvent) => void; +}) => { + return ( + + + + ); +}; diff --git a/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/annotations_config_panel/icon_set.ts b/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/annotations_config_panel/icon_set.ts index 87813ec12913e..32721285a4477 100644 --- a/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/annotations_config_panel/icon_set.ts +++ b/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/annotations_config_panel/icon_set.ts @@ -4,10 +4,13 @@ * 2.0; you may not use this file except in compliance with the Elastic License * 2.0. */ + import { i18n } from '@kbn/i18n'; +import { AvailableAnnotationIcon } from '@kbn/event-annotation-plugin/common'; import { IconTriangle, IconCircle } from '../../../assets/annotation_icons'; +import { IconSet } from '../shared/icon_select'; -export const annotationsIconSet = [ +export const annotationsIconSet: IconSet = [ { value: 'asterisk', label: i18n.translate('xpack.lens.xyChart.iconSelect.asteriskIconLabel', { diff --git a/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/annotations_config_panel/index.scss b/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/annotations_config_panel/index.scss new file mode 100644 index 0000000000000..3a0f4b944aa6c --- /dev/null +++ b/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/annotations_config_panel/index.scss @@ -0,0 +1,12 @@ +.lnsRowCompressedMargin+.lnsRowCompressedMargin { + margin-top: $euiSizeS; +} + +.lnsConfigPanelNoPadding { + padding: 0; +} + +.lnsConfigPanelDate__label { + min-width: 56px; // makes both labels ("from" and "to") the same width + text-align: center; +} \ No newline at end of file diff --git a/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/annotations_config_panel/index.test.tsx b/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/annotations_config_panel/index.test.tsx new file mode 100644 index 0000000000000..f97b4009e3e3e --- /dev/null +++ b/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/annotations_config_panel/index.test.tsx @@ -0,0 +1,222 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React from 'react'; +import { mountWithIntl as mount } from '@kbn/test-jest-helpers'; +import { AnnotationsPanel } from '.'; +import { FramePublicAPI } from '../../../types'; +import { layerTypes } from '../../..'; +import { createMockFramePublicAPI } from '../../../mocks'; +import { State } from '../../types'; +import { Position } from '@elastic/charts'; +import { chartPluginMock } from '@kbn/charts-plugin/public/mocks'; +import moment from 'moment'; + +jest.mock('lodash', () => { + const original = jest.requireActual('lodash'); + + return { + ...original, + debounce: (fn: unknown) => fn, + }; +}); + +const customLineStaticAnnotation = { + id: 'ann1', + key: { type: 'point_in_time' as const, timestamp: '2022-03-18T08:25:00.000Z' }, + label: 'Event', + icon: 'triangle' as const, + color: 'red', + lineStyle: 'dashed' as const, + lineWidth: 3, +}; + +describe('AnnotationsPanel', () => { + let frame: FramePublicAPI; + + function testState(): State { + return { + legend: { isVisible: true, position: Position.Right }, + valueLabels: 'hide', + preferredSeriesType: 'bar', + layers: [ + { + layerType: layerTypes.ANNOTATIONS, + layerId: 'annotation', + annotations: [customLineStaticAnnotation], + }, + ], + }; + } + + beforeEach(() => { + frame = createMockFramePublicAPI(); + frame.datasourceLayers = {}; + }); + describe('Dimension Editor', () => { + test('shows correct options for line annotations', () => { + const state = testState(); + const component = mount( + + ); + + expect( + component.find('EuiDatePicker[data-test-subj="lns-xyAnnotation-time"]').prop('selected') + ).toEqual(moment('2022-03-18T08:25:00.000Z')); + expect( + component.find('EuiDatePicker[data-test-subj="lns-xyAnnotation-fromTime"]').exists() + ).toBeFalsy(); + expect( + component.find('EuiDatePicker[data-test-subj="lns-xyAnnotation-toTime"]').exists() + ).toBeFalsy(); + expect( + component.find('EuiSwitch[data-test-subj="lns-xyAnnotation-rangeSwitch"]').prop('checked') + ).toEqual(false); + expect( + component.find('EuiFieldText[data-test-subj="column-label-edit"]').prop('value') + ).toEqual('Event'); + expect( + component.find('EuiComboBox[data-test-subj="lns-icon-select"]').prop('selectedOptions') + ).toEqual([{ label: 'Triangle', value: 'triangle' }]); + expect(component.find('TextDecorationSetting').exists()).toBeTruthy(); + expect(component.find('LineStyleSettings').exists()).toBeTruthy(); + expect( + component.find('EuiButtonGroup[data-test-subj="lns-xyAnnotation-fillStyle"]').exists() + ).toBeFalsy(); + }); + test('shows correct options for range annotations', () => { + const state = testState(); + state.layers[0] = { + annotations: [ + { + color: 'red', + icon: 'triangle', + id: 'ann1', + isHidden: undefined, + key: { + endTimestamp: '2022-03-21T10:49:00.000Z', + timestamp: '2022-03-18T08:25:00.000Z', + type: 'range', + }, + label: 'Event range', + lineStyle: 'dashed', + lineWidth: 3, + }, + ], + layerId: 'annotation', + layerType: 'annotations', + }; + const component = mount( + + ); + + expect( + component.find('EuiDatePicker[data-test-subj="lns-xyAnnotation-fromTime"]').prop('selected') + ).toEqual(moment('2022-03-18T08:25:00.000Z')); + expect( + component.find('EuiDatePicker[data-test-subj="lns-xyAnnotation-toTime"]').prop('selected') + ).toEqual(moment('2022-03-21T10:49:00.000Z')); + expect( + component.find('EuiDatePicker[data-test-subj="lns-xyAnnotation-time"]').exists() + ).toBeFalsy(); + expect( + component.find('EuiSwitch[data-test-subj="lns-xyAnnotation-rangeSwitch"]').prop('checked') + ).toEqual(true); + expect( + component.find('EuiFieldText[data-test-subj="column-label-edit"]').prop('value') + ).toEqual('Event range'); + expect(component.find('EuiComboBox[data-test-subj="lns-icon-select"]').exists()).toBeFalsy(); + expect(component.find('TextDecorationSetting').exists()).toBeFalsy(); + expect(component.find('LineStyleSettings').exists()).toBeFalsy(); + expect(component.find('[data-test-subj="lns-xyAnnotation-fillStyle"]').exists()).toBeTruthy(); + }); + + test('calculates correct endTimstamp and transparent color when switching for range annotation and back', () => { + const state = testState(); + const setState = jest.fn(); + const component = mount( + + ); + component.find('button[data-test-subj="lns-xyAnnotation-rangeSwitch"]').simulate('click'); + + expect(setState).toBeCalledWith({ + ...state, + layers: [ + { + annotations: [ + { + color: '#FF00001A', + id: 'ann1', + isHidden: undefined, + label: 'Event range', + key: { + endTimestamp: '2022-03-21T10:49:00.000Z', + timestamp: '2022-03-18T08:25:00.000Z', + type: 'range', + }, + }, + ], + layerId: 'annotation', + layerType: 'annotations', + }, + ], + }); + component.find('button[data-test-subj="lns-xyAnnotation-rangeSwitch"]').simulate('click'); + expect(setState).toBeCalledWith({ + ...state, + layers: [ + { + annotations: [ + { + color: '#FF0000', + id: 'ann1', + isHidden: undefined, + key: { + timestamp: '2022-03-18T08:25:00.000Z', + type: 'point_in_time', + }, + label: 'Event', + }, + ], + layerId: 'annotation', + layerType: 'annotations', + }, + ], + }); + }); + }); +}); diff --git a/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/annotations_config_panel/index.tsx b/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/annotations_config_panel/index.tsx index 6435f4c7ba2b8..bd63354936703 100644 --- a/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/annotations_config_panel/index.tsx +++ b/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/annotations_config_panel/index.tsx @@ -5,183 +5,4 @@ * 2.0. */ -import React, { useCallback } from 'react'; -import { i18n } from '@kbn/i18n'; -import { EuiDatePicker, EuiFormRow, EuiSwitch, EuiSwitchEvent } from '@elastic/eui'; -import type { PaletteRegistry } from '@kbn/coloring'; -import moment from 'moment'; -import { EventAnnotationConfig } from '@kbn/event-annotation-plugin/common/types'; -import type { VisualizationDimensionEditorProps } from '../../../types'; -import { State, XYState, XYAnnotationLayerConfig } from '../../types'; -import { FormatFactory } from '../../../../common'; -import { DimensionEditorSection, NameInput, useDebouncedValue } from '../../../shared_components'; -import { isHorizontalChart } from '../../state_helpers'; -import { defaultAnnotationLabel } from '../../annotations/helpers'; -import { ColorPicker } from '../color_picker'; -import { IconSelectSetting, TextDecorationSetting } from '../shared/marker_decoration_settings'; -import { LineStyleSettings } from '../shared/line_style_settings'; -import { updateLayer } from '..'; -import { annotationsIconSet } from './icon_set'; - -export const AnnotationsPanel = ( - props: VisualizationDimensionEditorProps & { - formatFactory: FormatFactory; - paletteService: PaletteRegistry; - } -) => { - const { state, setState, layerId, accessor } = props; - const isHorizontal = isHorizontalChart(state.layers); - - const { inputValue: localState, handleInputChange: setLocalState } = useDebouncedValue({ - value: state, - onChange: setState, - }); - - const index = localState.layers.findIndex((l) => l.layerId === layerId); - const localLayer = localState.layers.find( - (l) => l.layerId === layerId - ) as XYAnnotationLayerConfig; - - const currentAnnotations = localLayer.annotations?.find((c) => c.id === accessor); - - const setAnnotations = useCallback( - (annotations: Partial | undefined) => { - if (annotations == null) { - return; - } - const newConfigs = [...(localLayer.annotations || [])]; - const existingIndex = newConfigs.findIndex((c) => c.id === accessor); - if (existingIndex !== -1) { - newConfigs[existingIndex] = { ...newConfigs[existingIndex], ...annotations }; - } else { - return; // that should never happen because annotations are created before annotations panel is opened - } - setLocalState(updateLayer(localState, { ...localLayer, annotations: newConfigs }, index)); - }, - [accessor, index, localState, localLayer, setLocalState] - ); - - return ( - <> - - { - if (date) { - setAnnotations({ - key: { - ...(currentAnnotations?.key || { type: 'point_in_time' }), - timestamp: date.toISOString(), - }, - }); - } - }} - label={i18n.translate('xpack.lens.xyChart.annotationDate', { - defaultMessage: 'Annotation date', - })} - /> - - - { - setAnnotations({ label: value }); - }} - /> - - - - - setAnnotations({ isHidden: ev.target.checked })} - /> - - - ); -}; - -const ConfigPanelDatePicker = ({ - value, - label, - onChange, -}: { - value: moment.Moment; - label: string; - onChange: (val: moment.Moment | null) => void; -}) => { - return ( - - - - ); -}; - -const ConfigPanelHideSwitch = ({ - value, - onChange, -}: { - value: boolean; - onChange: (event: EuiSwitchEvent) => void; -}) => { - return ( - - - - ); -}; +export { AnnotationsPanel } from './annotations_panel'; diff --git a/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/color_picker.tsx b/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/color_picker.tsx index 37ee50f527d43..00f03f261ef7b 100644 --- a/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/color_picker.tsx +++ b/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/color_picker.tsx @@ -5,23 +5,26 @@ * 2.0. */ -import React, { useMemo, useState } from 'react'; +import React, { useEffect, useMemo, useState } from 'react'; +import chroma from 'chroma-js'; import { i18n } from '@kbn/i18n'; -import { EuiFormRow, EuiColorPicker, EuiColorPickerProps, EuiToolTip, EuiIcon } from '@elastic/eui'; +import { + EuiFormRow, + EuiColorPicker, + EuiColorPickerProps, + EuiToolTip, + EuiIcon, + euiPaletteColorBlind, +} from '@elastic/eui'; import type { PaletteRegistry } from '@kbn/coloring'; -import { defaultAnnotationColor } from '@kbn/event-annotation-plugin/public'; import type { VisualizationDimensionEditorProps } from '../../types'; -import { State, XYDataLayerConfig } from '../types'; +import { State } from '../types'; import { FormatFactory } from '../../../common'; import { getSeriesColor } from '../state_helpers'; -import { - defaultReferenceLineColor, - getAccessorColorConfig, - getColorAssignments, -} from '../color_assignment'; +import { getAccessorColorConfig, getColorAssignments } from '../color_assignment'; import { getSortedAccessors } from '../to_expression'; import { TooltipWrapper } from '../../shared_components'; -import { isReferenceLayer, isAnnotationsLayer, getDataLayers } from '../visualization_helpers'; +import { getDataLayers, isDataLayer } from '../visualization_helpers'; const tooltipContent = { auto: i18n.translate('xpack.lens.configPanel.color.tooltip.auto', { @@ -47,6 +50,8 @@ export const ColorPicker = ({ disableHelpTooltip, disabled, setConfig, + showAlpha, + defaultColor, }: VisualizationDimensionEditorProps & { formatFactory: FormatFactory; paletteService: PaletteRegistry; @@ -54,6 +59,8 @@ export const ColorPicker = ({ disableHelpTooltip?: boolean; disabled?: boolean; setConfig: (config: { color?: string }) => void; + showAlpha?: boolean; + defaultColor?: string; }) => { const index = state.layers.findIndex((l) => l.layerId === layerId); const layer = state.layers[index]; @@ -61,38 +68,47 @@ export const ColorPicker = ({ const overwriteColor = getSeriesColor(layer, accessor); const currentColor = useMemo(() => { if (overwriteColor || !frame.activeData) return overwriteColor; - if (isReferenceLayer(layer)) { - return defaultReferenceLineColor; - } else if (isAnnotationsLayer(layer)) { - return defaultAnnotationColor; + if (defaultColor) { + return defaultColor; } - - const dataLayer: XYDataLayerConfig = layer; - const sortedAccessors: string[] = getSortedAccessors( - frame.datasourceLayers[layer.layerId] ?? layer.accessors, - layer - ); - - const colorAssignments = getColorAssignments( - getDataLayers(state.layers), - { tables: frame.activeData }, - formatFactory - ); - const mappedAccessors = getAccessorColorConfig( - colorAssignments, - frame, - { - ...dataLayer, - accessors: sortedAccessors.filter((sorted) => dataLayer.accessors.includes(sorted)), - }, - paletteService - ); - - return mappedAccessors.find((a) => a.columnId === accessor)?.color || null; - }, [overwriteColor, frame, paletteService, state.layers, accessor, formatFactory, layer]); + if (isDataLayer(layer)) { + const sortedAccessors: string[] = getSortedAccessors( + frame.datasourceLayers[layer.layerId] ?? layer.accessors, + layer + ); + const colorAssignments = getColorAssignments( + getDataLayers(state.layers), + { tables: frame.activeData ?? {} }, + formatFactory + ); + const mappedAccessors = getAccessorColorConfig( + colorAssignments, + frame, + { + ...layer, + accessors: sortedAccessors.filter((sorted) => layer.accessors.includes(sorted)), + }, + paletteService + ); + return mappedAccessors.find((a) => a.columnId === accessor)?.color || null; + } + }, [ + overwriteColor, + frame, + paletteService, + state.layers, + accessor, + formatFactory, + layer, + defaultColor, + ]); const [color, setColor] = useState(currentColor); + useEffect(() => { + setColor(currentColor); + }, [currentColor]); + const handleColor: EuiColorPickerProps['onChange'] = (text, output) => { setColor(text); if (output.isValid || text === '') { @@ -107,8 +123,11 @@ export const ColorPicker = ({ defaultMessage: 'Series color', }); + const currentColorAlpha = color ? chroma(color).alpha() : 1; + const colorPicker = ( chroma(c).alpha(currentColorAlpha).hex()) + } /> ); diff --git a/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/dimension_editor.tsx b/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/dimension_editor.tsx index 39d08e4c710bd..eec3335c5b44c 100644 --- a/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/dimension_editor.tsx +++ b/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/dimension_editor.tsx @@ -9,7 +9,7 @@ import React, { useCallback } from 'react'; import { i18n } from '@kbn/i18n'; import { EuiButtonGroup, EuiFormRow, htmlIdGenerator } from '@elastic/eui'; import type { PaletteRegistry } from '@kbn/coloring'; -import { YAxisMode, YConfig } from '@kbn/expression-xy-plugin/common'; +import { YAxisMode, ExtendedYConfig } from '@kbn/expression-xy-plugin/common'; import type { VisualizationDimensionEditorProps } from '../../types'; import { State, XYState, XYDataLayerConfig } from '../types'; import { FormatFactory } from '../../../common'; @@ -17,7 +17,7 @@ import { isHorizontalChart } from '../state_helpers'; import { ColorPicker } from './color_picker'; import { PalettePicker, useDebouncedValue } from '../../shared_components'; import { isAnnotationsLayer, isReferenceLayer } from '../visualization_helpers'; -import { ReferenceLinePanel } from './reference_line_panel'; +import { ReferenceLinePanel } from './reference_line_config_panel'; import { AnnotationsPanel } from './annotations_config_panel'; type UnwrapArray = T extends Array ? P : T; @@ -57,7 +57,7 @@ export function DimensionEditor( const axisMode = localYConfig?.axisMode || 'auto'; const setConfig = useCallback( - (yConfig: Partial | undefined) => { + (yConfig: Partial | undefined) => { if (yConfig == null) { return; } diff --git a/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/index.tsx b/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/index.tsx index b61f4694f8a91..00c4e9c8eaeb2 100644 --- a/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/index.tsx +++ b/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/index.tsx @@ -7,7 +7,7 @@ import React, { memo, useCallback } from 'react'; import { i18n } from '@kbn/i18n'; -import { Position, ScaleType, VerticalAlignment, HorizontalAlignment } from '@elastic/charts'; +import { Position, ScaleType } from '@elastic/charts'; import { EuiFlexGroup, EuiFlexItem } from '@elastic/eui'; import { AxesSettingsConfig, AxisExtentConfig } from '@kbn/expression-xy-plugin/common'; import type { VisualizationToolbarProps, FramePublicAPI } from '../../types'; @@ -21,6 +21,7 @@ import { getScaleType } from '../to_expression'; import { TooltipWrapper } from '../../shared_components'; import { getDefaultVisualValuesForLayer } from '../../shared_components/datasource_default_values'; import { getDataLayers } from '../visualization_helpers'; +import { LegendSettingsPopoverProps } from '../../shared_components/legend_settings_popover'; type UnwrapArray = T extends Array ? P : T; type AxesSettingsConfigKeys = keyof AxesSettingsConfig; @@ -380,8 +381,10 @@ export const XyToolbar = memo(function XyToolbar( }} onAlignmentChange={(value) => { const [vertical, horizontal] = value.split('_'); - const verticalAlignment = vertical as VerticalAlignment; - const horizontalAlignment = horizontal as HorizontalAlignment; + const verticalAlignment = vertical as LegendSettingsPopoverProps['verticalAlignment']; + const horizontalAlignment = + horizontal as LegendSettingsPopoverProps['horizontalAlignment']; + setState({ ...state, legend: { ...state.legend, verticalAlignment, horizontalAlignment }, diff --git a/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/layer_header.tsx b/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/layer_header.tsx index 367785da2d6b1..1fbb2af8f1e98 100644 --- a/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/layer_header.tsx +++ b/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/layer_header.tsx @@ -11,14 +11,14 @@ import { EuiIcon, EuiPopover, EuiSelectable, EuiText, EuiPopoverTitle } from '@e import { SeriesType } from '@kbn/expression-xy-plugin/common'; import { ToolbarButton } from '@kbn/kibana-react-plugin/public'; import type { VisualizationLayerWidgetProps, VisualizationType } from '../../types'; -import { State, visualizationTypes, XYDataLayerConfig } from '../types'; +import { State, visualizationTypes } from '../types'; import { isHorizontalChart, isHorizontalSeries } from '../state_helpers'; import { trackUiEvent } from '../../lens_ui_telemetry'; import { StaticHeader } from '../../shared_components'; import { LensIconChartBarReferenceLine } from '../../assets/chart_bar_reference_line'; import { LensIconChartBarAnnotations } from '../../assets/chart_bar_annotations'; import { updateLayer } from '.'; -import { isAnnotationsLayer, isReferenceLayer } from '../visualization_helpers'; +import { isAnnotationsLayer, isDataLayer, isReferenceLayer } from '../visualization_helpers'; export function LayerHeader(props: VisualizationLayerWidgetProps) { const layer = props.state.layers.find((l) => l.layerId === props.layerId); @@ -58,7 +58,7 @@ function AnnotationsLayerHeader() { function DataLayerHeader(props: VisualizationLayerWidgetProps) { const [isPopoverOpen, setPopoverIsOpen] = useState(false); const { state, layerId } = props; - const layers = state.layers as XYDataLayerConfig[]; + const layers = state.layers.filter(isDataLayer); const index = layers.findIndex((l) => l.layerId === layerId); const layer = layers[index]; const currentVisType = visualizationTypes.find(({ id }) => id === layer.seriesType)!; diff --git a/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/reference_line_config_panel/icon_set.ts b/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/reference_line_config_panel/icon_set.ts new file mode 100644 index 0000000000000..eda5d06cd3ef1 --- /dev/null +++ b/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/reference_line_config_panel/icon_set.ts @@ -0,0 +1,67 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { i18n } from '@kbn/i18n'; +import { AvailableReferenceLineIcon } from '@kbn/expression-xy-plugin/common'; +import { IconSet } from '../shared/icon_select'; + +export const referenceLineIconsSet: IconSet = [ + { + value: 'empty', + label: i18n.translate('xpack.lens.xyChart.iconSelect.noIconLabel', { + defaultMessage: 'None', + }), + }, + { + value: 'asterisk', + label: i18n.translate('xpack.lens.xyChart.iconSelect.asteriskIconLabel', { + defaultMessage: 'Asterisk', + }), + }, + { + value: 'bell', + label: i18n.translate('xpack.lens.xyChart.iconSelect.bellIconLabel', { + defaultMessage: 'Bell', + }), + }, + { + value: 'bolt', + label: i18n.translate('xpack.lens.xyChart.iconSelect.boltIconLabel', { + defaultMessage: 'Bolt', + }), + }, + { + value: 'bug', + label: i18n.translate('xpack.lens.xyChart.iconSelect.bugIconLabel', { + defaultMessage: 'Bug', + }), + }, + { + value: 'editorComment', + label: i18n.translate('xpack.lens.xyChart.iconSelect.commentIconLabel', { + defaultMessage: 'Comment', + }), + }, + { + value: 'alert', + label: i18n.translate('xpack.lens.xyChart.iconSelect.alertIconLabel', { + defaultMessage: 'Alert', + }), + }, + { + value: 'flag', + label: i18n.translate('xpack.lens.xyChart.iconSelect.flagIconLabel', { + defaultMessage: 'Flag', + }), + }, + { + value: 'tag', + label: i18n.translate('xpack.lens.xyChart.iconSelect.tagIconLabel', { + defaultMessage: 'Tag', + }), + }, +]; diff --git a/x-pack/plugins/data_enhanced/.storybook/main.js b/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/reference_line_config_panel/index.tsx similarity index 80% rename from x-pack/plugins/data_enhanced/.storybook/main.js rename to x-pack/plugins/lens/public/xy_visualization/xy_config_panel/reference_line_config_panel/index.tsx index 86b48c32f103e..4297f7d35cd6c 100644 --- a/x-pack/plugins/data_enhanced/.storybook/main.js +++ b/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/reference_line_config_panel/index.tsx @@ -5,4 +5,4 @@ * 2.0. */ -module.exports = require('@kbn/storybook').defaultConfig; +export { ReferenceLinePanel } from './reference_line_panel'; diff --git a/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/reference_line_panel.tsx b/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/reference_line_config_panel/reference_line_panel.tsx similarity index 80% rename from x-pack/plugins/lens/public/xy_visualization/xy_config_panel/reference_line_panel.tsx rename to x-pack/plugins/lens/public/xy_visualization/xy_config_panel/reference_line_config_panel/reference_line_panel.tsx index d5a3e8ffd7a46..e25c191d2bec1 100644 --- a/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/reference_line_panel.tsx +++ b/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/reference_line_config_panel/reference_line_panel.tsx @@ -9,22 +9,24 @@ import React, { useCallback } from 'react'; import { i18n } from '@kbn/i18n'; import { EuiButtonGroup, EuiFormRow } from '@elastic/eui'; import type { PaletteRegistry } from '@kbn/coloring'; -import { FillStyle, YConfig } from '@kbn/expression-xy-plugin/common'; -import type { VisualizationDimensionEditorProps } from '../../types'; -import { State, XYState, XYReferenceLineLayerConfig } from '../types'; -import { FormatFactory } from '../../../common'; +import { FillStyle, ExtendedYConfig } from '@kbn/expression-xy-plugin/common'; +import type { VisualizationDimensionEditorProps } from '../../../types'; +import { State, XYState, XYReferenceLineLayerConfig } from '../../types'; +import { FormatFactory } from '../../../../common'; -import { ColorPicker } from './color_picker'; -import { updateLayer } from '.'; -import { useDebouncedValue } from '../../shared_components'; -import { idPrefix } from './dimension_editor'; -import { isHorizontalChart } from '../state_helpers'; +import { ColorPicker } from '../color_picker'; +import { updateLayer } from '..'; +import { useDebouncedValue } from '../../../shared_components'; +import { idPrefix } from '../dimension_editor'; +import { isHorizontalChart } from '../../state_helpers'; import { IconSelectSetting, MarkerDecorationPosition, TextDecorationSetting, -} from './shared/marker_decoration_settings'; -import { LineStyleSettings } from './shared/line_style_settings'; +} from '../shared/marker_decoration_settings'; +import { LineStyleSettings } from '../shared/line_style_settings'; +import { referenceLineIconsSet } from './icon_set'; +import { defaultReferenceLineColor } from '../../color_assignment'; export const ReferenceLinePanel = ( props: VisualizationDimensionEditorProps & { @@ -50,7 +52,7 @@ export const ReferenceLinePanel = ( ); const setConfig = useCallback( - (yConfig: Partial | undefined) => { + (yConfig: Partial | undefined) => { if (yConfig == null) { return; } @@ -74,7 +76,11 @@ export const ReferenceLinePanel = ( return ( <> - + | undefined) => void; + currentConfig?: ExtendedYConfig; + setConfig: (yConfig: Partial | undefined) => void; isHorizontal: boolean; }) => { return ( diff --git a/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/shared/icon_select.tsx b/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/shared/icon_select.tsx index e2b5923e81031..74eb23e3e8297 100644 --- a/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/shared/icon_select.tsx +++ b/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/shared/icon_select.tsx @@ -6,71 +6,20 @@ */ import React from 'react'; -import { i18n } from '@kbn/i18n'; import { EuiComboBox, EuiFlexGroup, EuiFlexItem, EuiIcon, IconType } from '@elastic/eui'; +import { AvailableReferenceLineIcon } from '@kbn/expression-xy-plugin/common'; export function hasIcon(icon: string | undefined): icon is string { return icon != null && icon !== 'empty'; } -export type IconSet = Array<{ value: string; label: string; icon?: IconType }>; - -export const euiIconsSet = [ - { - value: 'empty', - label: i18n.translate('xpack.lens.xyChart.iconSelect.noIconLabel', { - defaultMessage: 'None', - }), - }, - { - value: 'asterisk', - label: i18n.translate('xpack.lens.xyChart.iconSelect.asteriskIconLabel', { - defaultMessage: 'Asterisk', - }), - }, - { - value: 'bell', - label: i18n.translate('xpack.lens.xyChart.iconSelect.bellIconLabel', { - defaultMessage: 'Bell', - }), - }, - { - value: 'bolt', - label: i18n.translate('xpack.lens.xyChart.iconSelect.boltIconLabel', { - defaultMessage: 'Bolt', - }), - }, - { - value: 'bug', - label: i18n.translate('xpack.lens.xyChart.iconSelect.bugIconLabel', { - defaultMessage: 'Bug', - }), - }, - { - value: 'editorComment', - label: i18n.translate('xpack.lens.xyChart.iconSelect.commentIconLabel', { - defaultMessage: 'Comment', - }), - }, - { - value: 'alert', - label: i18n.translate('xpack.lens.xyChart.iconSelect.alertIconLabel', { - defaultMessage: 'Alert', - }), - }, - { - value: 'flag', - label: i18n.translate('xpack.lens.xyChart.iconSelect.flagIconLabel', { - defaultMessage: 'Flag', - }), - }, - { - value: 'tag', - label: i18n.translate('xpack.lens.xyChart.iconSelect.tagIconLabel', { - defaultMessage: 'Tag', - }), - }, -]; +export type IconSet = Array<{ + value: T; + label: string; + icon?: T | IconType; + shouldRotate?: boolean; + canFill?: boolean; +}>; const IconView = (props: { value?: string; label: string; icon?: IconType }) => { if (!props.value) return null; @@ -84,24 +33,33 @@ const IconView = (props: { value?: string; label: string; icon?: IconType }) => ); }; -export const IconSelect = ({ +export function IconSelect({ value, onChange, - customIconSet = euiIconsSet, + customIconSet, + defaultIcon = 'empty', }: { - value?: string; - onChange: (newIcon: string) => void; - customIconSet?: IconSet; -}) => { + value?: Icon; + onChange: (newIcon: Icon) => void; + customIconSet: IconSet; + defaultIcon?: string; +}) { const selectedIcon = customIconSet.find((option) => value === option.value) || - customIconSet.find((option) => option.value === 'empty')!; + customIconSet.find((option) => option.value === defaultIcon)!; return ( { onChange(selection[0].value!); }} @@ -115,4 +73,4 @@ export const IconSelect = ({ } /> ); -}; +} diff --git a/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/shared/marker_decoration_settings.tsx b/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/shared/marker_decoration_settings.tsx index b780737877388..64b00ef246161 100644 --- a/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/shared/marker_decoration_settings.tsx +++ b/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/shared/marker_decoration_settings.tsx @@ -71,22 +71,22 @@ function getIconPositionOptions({ isHorizontal, axisMode }: LabelConfigurationOp ]; } -interface MarkerDecorationConfig { +export interface MarkerDecorationConfig { axisMode?: YAxisMode; - icon?: string; + icon?: T; iconPosition?: IconPosition; textVisibility?: boolean; } -export const TextDecorationSetting = ({ +export function TextDecorationSetting({ currentConfig, setConfig, customIconSet, }: { - currentConfig?: MarkerDecorationConfig; - setConfig: (config: MarkerDecorationConfig) => void; - customIconSet?: IconSet; -}) => { + currentConfig?: MarkerDecorationConfig; + setConfig: (config: MarkerDecorationConfig) => void; + customIconSet?: IconSet; +}) { return ( ); -}; +} -export const IconSelectSetting = ({ +export function IconSelectSetting({ currentConfig, setConfig, customIconSet, + defaultIcon = 'empty', }: { - currentConfig?: MarkerDecorationConfig; - setConfig: (config: MarkerDecorationConfig) => void; - customIconSet?: IconSet; -}) => { + currentConfig?: MarkerDecorationConfig; + setConfig: (config: MarkerDecorationConfig) => void; + customIconSet: IconSet; + defaultIcon?: string; +}) { return ( { @@ -154,17 +157,17 @@ export const IconSelectSetting = ({ /> ); -}; +} -export const MarkerDecorationPosition = ({ +export function MarkerDecorationPosition({ currentConfig, setConfig, isHorizontal, }: { - currentConfig?: MarkerDecorationConfig; - setConfig: (config: MarkerDecorationConfig) => void; + currentConfig?: MarkerDecorationConfig; + setConfig: (config: MarkerDecorationConfig) => void; isHorizontal: boolean; -}) => { +}) { return ( <> {hasIcon(currentConfig?.icon) || currentConfig?.textVisibility ? ( @@ -210,4 +213,4 @@ export const MarkerDecorationPosition = ({ ) : null} ); -}; +} diff --git a/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/visual_options_popover/index.tsx b/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/visual_options_popover/index.tsx index d4edb960e70f7..ba8a246043bf2 100644 --- a/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/visual_options_popover/index.tsx +++ b/x-pack/plugins/lens/public/xy_visualization/xy_config_panel/visual_options_popover/index.tsx @@ -7,7 +7,6 @@ import React from 'react'; import { i18n } from '@kbn/i18n'; -import { ValidLayer } from '@kbn/expression-xy-plugin/common'; import { ToolbarPopover, TooltipWrapper, ValueLabelsSettings } from '../../../shared_components'; import { MissingValuesOptions } from './missing_values_option'; import { LineCurveOption } from './line_curve_option'; @@ -67,9 +66,7 @@ export const VisualOptionsPopover: React.FC = ({ ['area_stacked', 'area', 'area_percentage_stacked'].includes(seriesType) ); - const isHistogramSeries = Boolean( - hasHistogramSeries(dataLayers as ValidLayer[], datasourceLayers) - ); + const isHistogramSeries = Boolean(hasHistogramSeries(dataLayers, datasourceLayers)); const isValueLabelsEnabled = !hasNonBarSeries && hasBarNotStacked && !isHistogramSeries; const isFittingEnabled = hasNonBarSeries; diff --git a/x-pack/plugins/lens/server/embeddable/make_lens_embeddable_factory.ts b/x-pack/plugins/lens/server/embeddable/make_lens_embeddable_factory.ts index 0f996e428ed2c..215f080d3dbdf 100644 --- a/x-pack/plugins/lens/server/embeddable/make_lens_embeddable_factory.ts +++ b/x-pack/plugins/lens/server/embeddable/make_lens_embeddable_factory.ts @@ -14,6 +14,7 @@ import { import { DOC_TYPE } from '../../common'; import { commonEnhanceTableRowHeight, + commonFixValueLabelsInXY, commonLockOldMetricVisSettings, commonMakeReversePaletteAsCustom, commonRemoveTimezoneDateHistogramParam, @@ -34,7 +35,9 @@ import { LensDocShapePre712, VisState716, VisState810, + VisState820, VisStatePre715, + VisStatePre830, } from '../migrations/types'; import { extract, inject } from '../../common/embeddable_factory'; @@ -95,18 +98,26 @@ export const makeLensEmbeddableFactory = } as unknown as SerializableRecord; }, '8.2.0': (state) => { - const lensState = state as unknown as { attributes: LensDocShape810 }; + const lensState = state as unknown as { + attributes: LensDocShape810; + }; let migratedLensState = commonSetLastValueShowArrayValues(lensState.attributes); - migratedLensState = commonEnhanceTableRowHeight(migratedLensState); + migratedLensState = commonEnhanceTableRowHeight( + migratedLensState as LensDocShape810 + ); migratedLensState = commonSetIncludeEmptyRowsDateHistogram(migratedLensState); + return { ...lensState, attributes: migratedLensState, } as unknown as SerializableRecord; }, '8.3.0': (state) => { - const lensState = state as unknown as { attributes: LensDocShape810 }; - const migratedLensState = commonLockOldMetricVisSettings(lensState.attributes); + const lensState = state as unknown as { attributes: LensDocShape810 }; + let migratedLensState = commonLockOldMetricVisSettings(lensState.attributes); + migratedLensState = commonFixValueLabelsInXY( + migratedLensState as LensDocShape810 + ); return { ...lensState, attributes: migratedLensState, diff --git a/x-pack/plugins/lens/server/migrations/common_migrations.ts b/x-pack/plugins/lens/server/migrations/common_migrations.ts index df0ce94abca84..7cafa41f569d4 100644 --- a/x-pack/plugins/lens/server/migrations/common_migrations.ts +++ b/x-pack/plugins/lens/server/migrations/common_migrations.ts @@ -25,8 +25,11 @@ import { VisState716, VisState810, VisState820, + VisState830, CustomVisualizationMigrations, LensDocShape810, + LensDocShape830, + VisStatePre830, } from './types'; import { DOCUMENT_FIELD_NAME, layerTypes, MetricState } from '../../common'; import { LensDocShape } from './saved_object_migrations'; @@ -194,9 +197,7 @@ export const commonRenameFilterReferences = (attributes: LensDocShape715): LensD return newAttributes as LensDocShape810; }; -export const commonSetLastValueShowArrayValues = ( - attributes: LensDocShape810 -): LensDocShape810 => { +export const commonSetLastValueShowArrayValues = (attributes: LensDocShape810): LensDocShape810 => { const newAttributes = cloneDeep(attributes); for (const layer of Object.values(newAttributes.state.datasourceStates.indexpattern.layers)) { for (const column of Object.values(layer.columns)) { @@ -215,19 +216,19 @@ export const commonEnhanceTableRowHeight = ( attributes: LensDocShape810 ): LensDocShape810 => { if (attributes.visualizationType !== 'lnsDatatable') { - return attributes; + return attributes as LensDocShape810; } const visState810 = attributes.state.visualization as VisState810; const newAttributes = cloneDeep(attributes); const vizState = newAttributes.state.visualization as VisState820; vizState.rowHeight = visState810.fitRowToContent ? 'auto' : 'single'; vizState.rowHeightLines = visState810.fitRowToContent ? 2 : 1; - return newAttributes; + return newAttributes as LensDocShape810; }; export const commonSetIncludeEmptyRowsDateHistogram = ( attributes: LensDocShape810 -): LensDocShape810 => { +): LensDocShape810 => { const newAttributes = cloneDeep(attributes); for (const layer of Object.values(newAttributes.state.datasourceStates.indexpattern.layers)) { for (const column of Object.values(layer.columns)) { @@ -241,17 +242,17 @@ export const commonSetIncludeEmptyRowsDateHistogram = ( export const commonLockOldMetricVisSettings = ( attributes: LensDocShape810 -): LensDocShape810 => { +): LensDocShape830 => { const newAttributes = cloneDeep(attributes); if (newAttributes.visualizationType !== 'lnsMetric') { - return newAttributes; + return newAttributes as LensDocShape830; } const visState = newAttributes.state.visualization as MetricState; visState.textAlign = visState.textAlign ?? 'center'; visState.titlePosition = visState.titlePosition ?? 'bottom'; visState.size = visState.size ?? 'xl'; - return newAttributes; + return newAttributes as LensDocShape830; }; const getApplyCustomVisualizationMigrationToLens = (id: string, migration: MigrateFunction) => { @@ -343,3 +344,25 @@ export const fixLensTopValuesCustomFormatting = (attributes: LensDocShape810): L ); return newAttributes as LensDocShape810; }; + +export const commonFixValueLabelsInXY = ( + attributes: LensDocShape830 +): LensDocShape830 => { + if (attributes.visualizationType !== 'lnsXY') { + return attributes as LensDocShape830; + } + + const newAttributes: LensDocShape830 = cloneDeep(attributes); + const { visualization } = newAttributes.state; + const { valueLabels } = visualization; + return { + ...newAttributes, + state: { + ...newAttributes.state, + visualization: { + ...visualization, + valueLabels: valueLabels && valueLabels !== 'hide' ? 'show' : valueLabels, + }, + }, + }; +}; diff --git a/x-pack/plugins/lens/server/migrations/saved_object_migrations.test.ts b/x-pack/plugins/lens/server/migrations/saved_object_migrations.test.ts index 7fb9c350a0fa5..af68c5020e420 100644 --- a/x-pack/plugins/lens/server/migrations/saved_object_migrations.test.ts +++ b/x-pack/plugins/lens/server/migrations/saved_object_migrations.test.ts @@ -21,6 +21,7 @@ import { VisStatePre715, VisState810, VisState820, + VisState830, } from './types'; import { layerTypes, MetricState } from '../../common'; import { Filter } from '@kbn/es-query'; @@ -2113,4 +2114,52 @@ describe('Lens migrations', () => { expect(visState.size).toBe('s'); }); }); + + describe('8.3.0 valueLabels in XY', () => { + const context = { log: { warning: () => {} } } as unknown as SavedObjectMigrationContext; + const example = { + type: 'lens', + id: 'mocked-saved-object-id', + attributes: { + savedObjectId: '1', + title: 'MyRenamedOps', + description: '', + visualizationType: 'lnsXY', + state: { + visualization: { + valueLabels: 'inside', + }, + }, + }, + } as unknown as SavedObjectUnsanitizedDoc; + + it('migrates valueLabels from `inside` to `show`', () => { + const result = migrations['8.3.0'](example, context) as ReturnType< + SavedObjectMigrationFn + >; + const visState = result.attributes.state.visualization as VisState830; + expect(visState.valueLabels).toBe('show'); + }); + + it("doesn't migrate valueLabels with `hide` value", () => { + const result = migrations['8.3.0']( + { + ...example, + attributes: { + ...example.attributes, + state: { + ...example.attributes.state, + visualization: { + ...(example.attributes.state.visualization as Record), + valueLabels: 'hide', + }, + }, + }, + }, + context + ) as ReturnType>; + const visState = result.attributes.state.visualization as VisState830; + expect(visState.valueLabels).toBe('hide'); + }); + }); }); diff --git a/x-pack/plugins/lens/server/migrations/saved_object_migrations.ts b/x-pack/plugins/lens/server/migrations/saved_object_migrations.ts index f5fa4b27447ac..00ec6c29154e3 100644 --- a/x-pack/plugins/lens/server/migrations/saved_object_migrations.ts +++ b/x-pack/plugins/lens/server/migrations/saved_object_migrations.ts @@ -13,9 +13,7 @@ import { SavedObjectReference, SavedObjectUnsanitizedDoc, } from '@kbn/core/server'; -import { Filter } from '@kbn/es-query'; -// eslint-disable-next-line @kbn/eslint/no-restricted-paths -import { Query } from '@kbn/data-plugin/public'; +import type { Query, Filter } from '@kbn/es-query'; import { mergeSavedObjectMigrationMaps } from '@kbn/core/server'; import { MigrateFunctionsObject } from '@kbn/kibana-utils-plugin/common'; import { PersistableFilter } from '../../common'; @@ -30,6 +28,11 @@ import { VisState716, CustomVisualizationMigrations, LensDocShape810, + LensDocShape830, + XYVisualizationStatePre830, + XYVisualizationState830, + VisState810, + VisState820, } from './types'; import { commonRenameOperationsForFormula, @@ -44,6 +47,7 @@ import { commonSetLastValueShowArrayValues, commonEnhanceTableRowHeight, commonSetIncludeEmptyRowsDateHistogram, + commonFixValueLabelsInXY, commonLockOldMetricVisSettings, } from './common_migrations'; @@ -475,7 +479,10 @@ const setLastValueShowArrayValues: SavedObjectMigrationFn = (doc) => { +const enhanceTableRowHeight: SavedObjectMigrationFn< + LensDocShape810, + LensDocShape810 +> = (doc) => { const newDoc = cloneDeep(doc); return { ...newDoc, attributes: commonEnhanceTableRowHeight(newDoc.attributes) }; }; @@ -486,6 +493,14 @@ const setIncludeEmptyRowsDateHistogram: SavedObjectMigrationFn, + LensDocShape830 +> = (doc) => { + const newDoc = cloneDeep(doc); + return { ...newDoc, attributes: commonFixValueLabelsInXY(newDoc.attributes) }; +}; + const lockOldMetricVisSettings: SavedObjectMigrationFn = ( doc ) => ({ ...doc, attributes: commonLockOldMetricVisSettings(doc.attributes) }); @@ -509,7 +524,7 @@ const lensMigrations: SavedObjectMigrationMap = { setIncludeEmptyRowsDateHistogram, enhanceTableRowHeight ), - '8.3.0': lockOldMetricVisSettings, + '8.3.0': flow(lockOldMetricVisSettings, fixValueLabelsInXY), }; export const getAllMigrations = ( diff --git a/x-pack/plugins/lens/server/migrations/types.ts b/x-pack/plugins/lens/server/migrations/types.ts index 9b66f7023cdeb..6b38bb4b4f631 100644 --- a/x-pack/plugins/lens/server/migrations/types.ts +++ b/x-pack/plugins/lens/server/migrations/types.ts @@ -6,11 +6,9 @@ */ import type { PaletteOutput, CustomPaletteParams } from '@kbn/coloring'; -import { Filter } from '@kbn/es-query'; -// eslint-disable-next-line @kbn/eslint/no-restricted-paths -import { Query } from '@kbn/data-plugin/public'; +import type { Query, Filter } from '@kbn/es-query'; import type { MigrateFunctionsObject } from '@kbn/kibana-utils-plugin/common'; -import type { LayerType, PersistableFilter } from '../../common'; +import type { LayerType, PersistableFilter, ValueLabelConfig } from '../../common'; export type CustomVisualizationMigrations = Record MigrateFunctionsObject>; @@ -204,7 +202,7 @@ export type LensDocShape810 = Omit< 'filters' | 'state' > & { filters: Filter[]; - state: Omit & { + state: Omit['state'], 'datasourceStates'> & { datasourceStates: { indexpattern: Omit & { layers: Record< @@ -258,3 +256,16 @@ export interface VisState820 { rowHeight: 'auto' | 'single' | 'custom'; rowHeightLines: number; } + +export type LensDocShape830 = LensDocShape810; + +export interface XYVisualizationStatePre830 extends VisState820 { + valueLabels: 'hide' | 'inside' | 'outside'; +} + +export interface XYVisualizationState830 extends VisState820 { + valueLabels: ValueLabelConfig; +} + +export type VisStatePre830 = XYVisualizationStatePre830; +export type VisState830 = XYVisualizationState830; diff --git a/x-pack/plugins/maps/common/descriptor_types/data_request_descriptor_types.ts b/x-pack/plugins/maps/common/descriptor_types/data_request_descriptor_types.ts index f3132d145c7a2..a560114d71b4f 100644 --- a/x-pack/plugins/maps/common/descriptor_types/data_request_descriptor_types.ts +++ b/x-pack/plugins/maps/common/descriptor_types/data_request_descriptor_types.ts @@ -41,6 +41,7 @@ export type VectorSourceRequestMeta = DataFilters & { sourceQuery?: Query; sourceMeta: object | null; isForceRefresh: boolean; + isFeatureEditorOpenForLayer: boolean; }; export type VectorJoinSourceRequestMeta = Omit; diff --git a/x-pack/plugins/maps/common/descriptor_types/layer_descriptor_types.ts b/x-pack/plugins/maps/common/descriptor_types/layer_descriptor_types.ts index 1cd8b254f9e14..996e3d7303b82 100644 --- a/x-pack/plugins/maps/common/descriptor_types/layer_descriptor_types.ts +++ b/x-pack/plugins/maps/common/descriptor_types/layer_descriptor_types.ts @@ -35,11 +35,17 @@ export type TileMetaFeature = Feature & { 'hits.total.value': number; // For _mvt requests with "aggs" property in request: aggregation statistics returned in the pattern outined below + // aggregations._count.avg + // aggregations._count.count // aggregations._count.min // aggregations._count.max + // aggregations._count.sum + // aggregations..avg + // aggregations..count // aggregations..min // aggregations..max - [key: string]: number | string; + // aggregations..sum + [key: string]: number | string | boolean; }; }; diff --git a/x-pack/plugins/maps/common/embeddable/extract.ts b/x-pack/plugins/maps/common/embeddable/extract.ts index e73b1566c0289..d329aefe7cff6 100644 --- a/x-pack/plugins/maps/common/embeddable/extract.ts +++ b/x-pack/plugins/maps/common/embeddable/extract.ts @@ -5,8 +5,7 @@ * 2.0. */ -// eslint-disable-next-line @kbn/eslint/no-restricted-paths -import { EmbeddableRegistryDefinition } from '@kbn/embeddable-plugin/server'; +import { EmbeddableRegistryDefinition } from '@kbn/embeddable-plugin/common'; import { MapEmbeddablePersistableState } from './types'; import { MapSavedObjectAttributes } from '../map_saved_object_type'; import { extractReferences } from '../migrations/references'; diff --git a/x-pack/plugins/maps/common/embeddable/inject.ts b/x-pack/plugins/maps/common/embeddable/inject.ts index 2e1892b95a0f1..4bb26dd00d28d 100644 --- a/x-pack/plugins/maps/common/embeddable/inject.ts +++ b/x-pack/plugins/maps/common/embeddable/inject.ts @@ -5,10 +5,9 @@ * 2.0. */ -// eslint-disable-next-line @kbn/eslint/no-restricted-paths -import { EmbeddableRegistryDefinition } from '@kbn/embeddable-plugin/server'; -import { MapEmbeddablePersistableState } from './types'; -import { MapSavedObjectAttributes } from '../map_saved_object_type'; +import type { EmbeddableRegistryDefinition } from '@kbn/embeddable-plugin/common'; +import type { MapEmbeddablePersistableState } from './types'; +import type { MapSavedObjectAttributes } from '../map_saved_object_type'; import { extractReferences, injectReferences } from '../migrations/references'; export const inject: EmbeddableRegistryDefinition['inject'] = (state, references) => { diff --git a/x-pack/plugins/maps/public/actions/data_request_actions.ts b/x-pack/plugins/maps/public/actions/data_request_actions.ts index 5788c9360fdf2..d2cb416dcbe20 100644 --- a/x-pack/plugins/maps/public/actions/data_request_actions.ts +++ b/x-pack/plugins/maps/public/actions/data_request_actions.ts @@ -24,6 +24,7 @@ import { getDataRequestDescriptor, getLayerById, getLayerList, + getEditState, } from '../selectors/map_selectors'; import { cancelRequest, @@ -67,6 +68,7 @@ export type DataRequestContext = { dataFilters: DataFilters; forceRefreshDueToDrawing: boolean; // Boolean signaling data request triggered by a user updating layer features via drawing tools. When true, layer will re-load regardless of "source.applyForceRefresh" flag. isForceRefresh: boolean; // Boolean signaling data request triggered by auto-refresh timer or user clicking refresh button. When true, layer will re-load only when "source.applyForceRefresh" flag is set to true. + isFeatureEditorOpenForLayer: boolean; // Boolean signaling that feature editor menu is open for a layer. When true, layer will ignore all global and layer filtering so drawn features are displayed and not filtered out. }; export function clearDataRequests(layer: ILayer) { @@ -145,6 +147,7 @@ function getDataRequestContext( dispatch(registerCancelCallback(requestToken, callback)), forceRefreshDueToDrawing, isForceRefresh, + isFeatureEditorOpenForLayer: getEditState(getState())?.layerId === layerId, }; } diff --git a/x-pack/plugins/maps/public/actions/map_actions.ts b/x-pack/plugins/maps/public/actions/map_actions.ts index 8a16d036393ad..e8585560238fd 100644 --- a/x-pack/plugins/maps/public/actions/map_actions.ts +++ b/x-pack/plugins/maps/public/actions/map_actions.ts @@ -58,6 +58,7 @@ import { autoFitToBounds, syncDataForAllLayers, syncDataForLayerDueToDrawing, + syncDataForLayerId, } from './data_request_actions'; import { addLayer, addLayerWithoutDataSync } from './layer_actions'; import { MapSettings } from '../reducers/map'; @@ -394,7 +395,7 @@ export function setEditLayerToSelectedLayer() { } export function updateEditLayer(layerId: string | null) { - return (dispatch: Dispatch) => { + return (dispatch: ThunkDispatch) => { if (layerId !== null) { dispatch({ type: SET_OPEN_TOOLTIPS, openTooltips: [] }); } @@ -406,6 +407,7 @@ export function updateEditLayer(layerId: string | null) { type: UPDATE_EDIT_STATE, editState: layerId ? { layerId } : undefined, }); + dispatch(syncDataForLayerId(layerId, false)); }; } diff --git a/x-pack/plugins/maps/public/classes/fields/agg/agg_field.ts b/x-pack/plugins/maps/public/classes/fields/agg/agg_field.ts index 13b40962c5461..9202e09bab67d 100644 --- a/x-pack/plugins/maps/public/classes/fields/agg/agg_field.ts +++ b/x-pack/plugins/maps/public/classes/fields/agg/agg_field.ts @@ -13,6 +13,7 @@ import { isMetricCountable } from '../../util/is_metric_countable'; import { CountAggFieldParams } from './agg_field_types'; import { addFieldToDSL, getField } from '../../../../common/elasticsearch_util'; import { IField } from '../field'; +import { getAggRange } from '../../util/tile_meta_feature_utils'; const TERMS_AGG_SHARD_SIZE = 5; @@ -111,15 +112,6 @@ export class AggField extends CountAggField { } pluckRangeFromTileMetaFeature(metaFeature: TileMetaFeature) { - const minField = `aggregations.${this.getName()}.min`; - const maxField = `aggregations.${this.getName()}.max`; - return metaFeature.properties && - typeof metaFeature.properties[minField] === 'number' && - typeof metaFeature.properties[maxField] === 'number' - ? { - min: metaFeature.properties[minField] as number, - max: metaFeature.properties[maxField] as number, - } - : null; + return getAggRange(metaFeature, this.getName()); } } diff --git a/x-pack/plugins/maps/public/classes/fields/agg/count_agg_field.ts b/x-pack/plugins/maps/public/classes/fields/agg/count_agg_field.ts index 03c0d3f0791a5..4b136ab950ffa 100644 --- a/x-pack/plugins/maps/public/classes/fields/agg/count_agg_field.ts +++ b/x-pack/plugins/maps/public/classes/fields/agg/count_agg_field.ts @@ -13,6 +13,7 @@ import { TileMetaFeature } from '../../../../common/descriptor_types'; import { ITooltipProperty, TooltipProperty } from '../../tooltips/tooltip_property'; import { ESAggTooltipProperty } from '../../tooltips/es_agg_tooltip_property'; import { IESAggField, CountAggFieldParams } from './agg_field_types'; +import { getAggRange } from '../../util/tile_meta_feature_utils'; // Agg without field. Essentially a count-aggregation. export class CountAggField implements IESAggField { @@ -116,15 +117,6 @@ export class CountAggField implements IESAggField { } pluckRangeFromTileMetaFeature(metaFeature: TileMetaFeature) { - const minField = `aggregations._count.min`; - const maxField = `aggregations._count.max`; - return metaFeature.properties && - typeof metaFeature.properties[minField] === 'number' && - typeof metaFeature.properties[maxField] === 'number' - ? { - min: metaFeature.properties[minField] as number, - max: metaFeature.properties[maxField] as number, - } - : null; + return getAggRange(metaFeature, '_count'); } } diff --git a/x-pack/plugins/maps/public/classes/layers/__fixtures__/mock_sync_context.ts b/x-pack/plugins/maps/public/classes/layers/__fixtures__/mock_sync_context.ts index b81ba6c854629..4d1f23599f48d 100644 --- a/x-pack/plugins/maps/public/classes/layers/__fixtures__/mock_sync_context.ts +++ b/x-pack/plugins/maps/public/classes/layers/__fixtures__/mock_sync_context.ts @@ -20,6 +20,7 @@ export class MockSyncContext implements DataRequestContext { updateSourceData: (newData: unknown) => void; forceRefreshDueToDrawing: boolean; isForceRefresh: boolean; + isFeatureEditorOpenForLayer: boolean; constructor({ dataFilters }: { dataFilters: Partial }) { const mapFilters: DataFilters = { @@ -44,5 +45,6 @@ export class MockSyncContext implements DataRequestContext { this.updateSourceData = sinon.spy(); this.forceRefreshDueToDrawing = false; this.isForceRefresh = false; + this.isFeatureEditorOpenForLayer = false; } } diff --git a/x-pack/plugins/maps/public/classes/layers/build_vector_request_meta.ts b/x-pack/plugins/maps/public/classes/layers/build_vector_request_meta.ts index 52dd93033020d..e8d74003c6790 100644 --- a/x-pack/plugins/maps/public/classes/layers/build_vector_request_meta.ts +++ b/x-pack/plugins/maps/public/classes/layers/build_vector_request_meta.ts @@ -16,7 +16,8 @@ export function buildVectorRequestMeta( fieldNames: string[], dataFilters: DataFilters, sourceQuery: Query | null | undefined, - isForceRefresh: boolean + isForceRefresh: boolean, + isFeatureEditorOpenForLayer: boolean ): VectorSourceRequestMeta { return { ...dataFilters, @@ -28,5 +29,6 @@ export function buildVectorRequestMeta( sourceMeta: source.getSyncMeta(), applyForceRefresh: source.isESSource() ? source.getApplyForceRefresh() : false, isForceRefresh, + isFeatureEditorOpenForLayer, }; } diff --git a/x-pack/plugins/maps/public/classes/layers/ems_vector_tile_layer/ems_vector_tile_layer.test.ts b/x-pack/plugins/maps/public/classes/layers/ems_vector_tile_layer/ems_vector_tile_layer.test.ts index 8b27bacff8ecb..21c9c1f79d970 100644 --- a/x-pack/plugins/maps/public/classes/layers/ems_vector_tile_layer/ems_vector_tile_layer.test.ts +++ b/x-pack/plugins/maps/public/classes/layers/ems_vector_tile_layer/ems_vector_tile_layer.test.ts @@ -6,14 +6,18 @@ */ import { SOURCE_TYPES } from '../../../../common/constants'; -import { DataFilters, XYZTMSSourceDescriptor } from '../../../../common/descriptor_types'; +import { + DataFilters, + LayerDescriptor, + XYZTMSSourceDescriptor, +} from '../../../../common/descriptor_types'; import { ILayer } from '../layer'; import { EmsVectorTileLayer } from './ems_vector_tile_layer'; import { DataRequestContext } from '../../../actions'; import { EMSTMSSource } from '../../sources/ems_tms_source'; describe('EmsVectorTileLayer', () => { - it('should correctly inject tileLayerId in meta', async () => { + test('should correctly inject tileLayerId in meta', async () => { const layer: ILayer = new EmsVectorTileLayer({ source: { getTileLayerId: () => { @@ -50,4 +54,34 @@ describe('EmsVectorTileLayer', () => { expect(actualMeta).toStrictEqual({ tileLayerId: 'myTileLayerId' }); expect(actualErrorMessage).toStrictEqual('network error'); }); + + describe('isInitialDataLoadComplete', () => { + test('should return false when tile loading has not started', () => { + const layer = new EmsVectorTileLayer({ + source: {} as unknown as EMSTMSSource, + layerDescriptor: {} as unknown as LayerDescriptor, + }); + expect(layer.isInitialDataLoadComplete()).toBe(false); + }); + + test('should return false when tiles are loading', () => { + const layer = new EmsVectorTileLayer({ + source: {} as unknown as EMSTMSSource, + layerDescriptor: { + __areTilesLoaded: false, + } as unknown as LayerDescriptor, + }); + expect(layer.isInitialDataLoadComplete()).toBe(false); + }); + + test('should return true when tiles are loaded', () => { + const layer = new EmsVectorTileLayer({ + source: {} as unknown as EMSTMSSource, + layerDescriptor: { + __areTilesLoaded: true, + } as unknown as LayerDescriptor, + }); + expect(layer.isInitialDataLoadComplete()).toBe(true); + }); + }); }); diff --git a/x-pack/plugins/maps/public/classes/layers/ems_vector_tile_layer/ems_vector_tile_layer.tsx b/x-pack/plugins/maps/public/classes/layers/ems_vector_tile_layer/ems_vector_tile_layer.tsx index 428156165c4c3..646ccb3c09acd 100644 --- a/x-pack/plugins/maps/public/classes/layers/ems_vector_tile_layer/ems_vector_tile_layer.tsx +++ b/x-pack/plugins/maps/public/classes/layers/ems_vector_tile_layer/ems_vector_tile_layer.tsx @@ -67,6 +67,10 @@ export class EmsVectorTileLayer extends AbstractLayer { this._style = new TileStyle(); } + isInitialDataLoadComplete(): boolean { + return !!this._descriptor.__areTilesLoaded; + } + getSource(): EMSTMSSource { return super.getSource() as EMSTMSSource; } diff --git a/x-pack/plugins/maps/public/classes/layers/heatmap_layer/heatmap_layer.ts b/x-pack/plugins/maps/public/classes/layers/heatmap_layer/heatmap_layer.ts index 66aef6d38803f..d1247590af2e9 100644 --- a/x-pack/plugins/maps/public/classes/layers/heatmap_layer/heatmap_layer.ts +++ b/x-pack/plugins/maps/public/classes/layers/heatmap_layer/heatmap_layer.ts @@ -11,10 +11,16 @@ import { HeatmapStyle } from '../../styles/heatmap/heatmap_style'; import { LAYER_TYPE } from '../../../../common/constants'; import { HeatmapLayerDescriptor } from '../../../../common/descriptor_types'; import { ESGeoGridSource } from '../../sources/es_geo_grid_source'; -import { syncBoundsData, MvtSourceData, syncMvtSourceData } from '../vector_layer'; +import { + NO_RESULTS_ICON_AND_TOOLTIPCONTENT, + syncBoundsData, + MvtSourceData, + syncMvtSourceData, +} from '../vector_layer'; import { DataRequestContext } from '../../../actions'; import { buildVectorRequestMeta } from '../build_vector_request_meta'; import { IMvtVectorSource } from '../../sources/vector_source'; +import { getAggsMeta } from '../../util/tile_meta_feature_utils'; export class HeatmapLayer extends AbstractLayer { private readonly _style: HeatmapStyle; @@ -48,6 +54,11 @@ export class HeatmapLayer extends AbstractLayer { } } + getLayerIcon(isTocIcon: boolean) { + const { docCount } = getAggsMeta(this._getMetaFromTiles()); + return docCount === 0 ? NO_RESULTS_ICON_AND_TOOLTIPCONTENT : super.getLayerIcon(isTocIcon); + } + getSource(): ESGeoGridSource { return super.getSource() as ESGeoGridSource; } @@ -89,7 +100,8 @@ export class HeatmapLayer extends AbstractLayer { this.getSource().getFieldNames(), syncContext.dataFilters, this.getQuery(), - syncContext.isForceRefresh + syncContext.isForceRefresh, + syncContext.isFeatureEditorOpenForLayer ), source: this.getSource() as IMvtVectorSource, syncContext, diff --git a/x-pack/plugins/maps/public/classes/layers/vector_layer/blended_vector_layer/blended_vector_layer.ts b/x-pack/plugins/maps/public/classes/layers/vector_layer/blended_vector_layer/blended_vector_layer.ts index e46c670b677ba..b1fddcca5d5f2 100644 --- a/x-pack/plugins/maps/public/classes/layers/vector_layer/blended_vector_layer/blended_vector_layer.ts +++ b/x-pack/plugins/maps/public/classes/layers/vector_layer/blended_vector_layer/blended_vector_layer.ts @@ -298,7 +298,8 @@ export class BlendedVectorLayer extends GeoJsonVectorLayer implements IVectorLay syncContext.isForceRefresh, syncContext.dataFilters, this.getSource(), - this.getCurrentStyle() + this.getCurrentStyle(), + syncContext.isFeatureEditorOpenForLayer ); const source = this.getSource(); diff --git a/x-pack/plugins/maps/public/classes/layers/vector_layer/bounds_data.ts b/x-pack/plugins/maps/public/classes/layers/vector_layer/bounds_data.ts index 29ecf1635d626..7136c9d0c2235 100644 --- a/x-pack/plugins/maps/public/classes/layers/vector_layer/bounds_data.ts +++ b/x-pack/plugins/maps/public/classes/layers/vector_layer/bounds_data.ts @@ -22,7 +22,13 @@ export async function syncBoundsData({ source: IVectorSource; sourceQuery: Query | null; }): Promise { - const { startLoading, stopLoading, registerCancelCallback, dataFilters } = syncContext; + const { + startLoading, + stopLoading, + registerCancelCallback, + dataFilters, + isFeatureEditorOpenForLayer, + } = syncContext; const requestToken = Symbol(`${SOURCE_BOUNDS_DATA_REQUEST_ID}-${layerId}`); @@ -37,6 +43,7 @@ export async function syncBoundsData({ joinKeyFilter: dataFilters.joinKeyFilter, applyGlobalQuery: source.getApplyGlobalQuery(), applyGlobalTime: source.getApplyGlobalTime(), + isFeatureEditorOpenForLayer, }; let bounds = null; diff --git a/x-pack/plugins/maps/public/classes/layers/vector_layer/geojson_vector_layer/geojson_vector_layer.tsx b/x-pack/plugins/maps/public/classes/layers/vector_layer/geojson_vector_layer/geojson_vector_layer.tsx index c6f9a282d0fa4..bc7ba78c84d98 100644 --- a/x-pack/plugins/maps/public/classes/layers/vector_layer/geojson_vector_layer/geojson_vector_layer.tsx +++ b/x-pack/plugins/maps/public/classes/layers/vector_layer/geojson_vector_layer/geojson_vector_layer.tsx @@ -237,7 +237,8 @@ export class GeoJsonVectorLayer extends AbstractVectorLayer { syncContext.isForceRefresh, syncContext.dataFilters, source, - style + style, + syncContext.isFeatureEditorOpenForLayer ), syncContext, source, diff --git a/x-pack/plugins/maps/public/classes/layers/vector_layer/mvt_vector_layer/mvt_source_data.test.ts b/x-pack/plugins/maps/public/classes/layers/vector_layer/mvt_vector_layer/mvt_source_data.test.ts index 4b45adc8848bd..ccc73f94aac57 100644 --- a/x-pack/plugins/maps/public/classes/layers/vector_layer/mvt_vector_layer/mvt_source_data.test.ts +++ b/x-pack/plugins/maps/public/classes/layers/vector_layer/mvt_vector_layer/mvt_source_data.test.ts @@ -59,6 +59,7 @@ describe('syncMvtSourceData', () => { fieldNames: [], sourceMeta: {}, isForceRefresh: false, + isFeatureEditorOpenForLayer: false, }, source: mockSource, syncContext, @@ -90,6 +91,7 @@ describe('syncMvtSourceData', () => { fieldNames: [], sourceMeta: {}, isForceRefresh: false, + isFeatureEditorOpenForLayer: false, }; await syncMvtSourceData({ @@ -131,6 +133,7 @@ describe('syncMvtSourceData', () => { fieldNames: [], sourceMeta: {}, isForceRefresh: false, + isFeatureEditorOpenForLayer: false, }; await syncMvtSourceData({ @@ -169,6 +172,7 @@ describe('syncMvtSourceData', () => { fieldNames: [], sourceMeta: {}, isForceRefresh: false, + isFeatureEditorOpenForLayer: false, }; await syncMvtSourceData({ @@ -215,6 +219,7 @@ describe('syncMvtSourceData', () => { fieldNames: [], sourceMeta: {}, isForceRefresh: false, + isFeatureEditorOpenForLayer: false, }; await syncMvtSourceData({ @@ -253,6 +258,7 @@ describe('syncMvtSourceData', () => { fieldNames: [], sourceMeta: {}, isForceRefresh: false, + isFeatureEditorOpenForLayer: false, }; await syncMvtSourceData({ @@ -291,6 +297,7 @@ describe('syncMvtSourceData', () => { fieldNames: [], sourceMeta: {}, isForceRefresh: false, + isFeatureEditorOpenForLayer: false, }; await syncMvtSourceData({ diff --git a/x-pack/plugins/maps/public/classes/layers/vector_layer/mvt_vector_layer/mvt_vector_layer.test.tsx b/x-pack/plugins/maps/public/classes/layers/vector_layer/mvt_vector_layer/mvt_vector_layer.test.tsx index 27d377851152e..d9ee5207b29f3 100644 --- a/x-pack/plugins/maps/public/classes/layers/vector_layer/mvt_vector_layer/mvt_vector_layer.test.tsx +++ b/x-pack/plugins/maps/public/classes/layers/vector_layer/mvt_vector_layer/mvt_vector_layer.test.tsx @@ -17,6 +17,8 @@ import { shallow } from 'enzyme'; import { Feature } from 'geojson'; import { MVTSingleLayerVectorSource } from '../../../sources/mvt_single_layer_vector_source'; +import { IVectorSource } from '../../../sources/vector_source'; +import { InnerJoin } from '../../../joins/inner_join'; import { TiledSingleLayerVectorSourceDescriptor, VectorLayerDescriptor, @@ -93,3 +95,107 @@ describe('getFeatureById', () => { expect(feature).toEqual(null); }); }); + +describe('isInitialDataLoadComplete', () => { + const sourceDataRequestDescriptor = { + data: {}, + dataId: 'source', + dataRequestMeta: {}, + dataRequestMetaAtStart: undefined, + dataRequestToken: undefined, + }; + test('should return false when tile loading has not started', () => { + const layer = new MvtVectorLayer({ + customIcons: [], + layerDescriptor: { + __dataRequests: [sourceDataRequestDescriptor], + } as unknown as VectorLayerDescriptor, + source: {} as unknown as IVectorSource, + }); + expect(layer.isInitialDataLoadComplete()).toBe(false); + }); + + test('should return false when tiles are loading', () => { + const layer = new MvtVectorLayer({ + customIcons: [], + layerDescriptor: { + __areTilesLoaded: false, + __dataRequests: [sourceDataRequestDescriptor], + } as unknown as VectorLayerDescriptor, + source: {} as unknown as IVectorSource, + }); + expect(layer.isInitialDataLoadComplete()).toBe(false); + }); + + test('should return true when tiles are loaded', () => { + const layer = new MvtVectorLayer({ + customIcons: [], + layerDescriptor: { + __areTilesLoaded: true, + __dataRequests: [sourceDataRequestDescriptor], + } as unknown as VectorLayerDescriptor, + source: {} as unknown as IVectorSource, + }); + expect(layer.isInitialDataLoadComplete()).toBe(true); + }); + + test('should return false when tiles are loaded but join is loading', () => { + const layer = new MvtVectorLayer({ + customIcons: [], + joins: [ + { + hasCompleteConfig: () => { + return true; + }, + getSourceDataRequestId: () => { + return 'join_source_a0b0da65-5e1a-4967-9dbe-74f24391afe2'; + }, + } as unknown as InnerJoin, + ], + layerDescriptor: { + __areTilesLoaded: true, + __dataRequests: [ + sourceDataRequestDescriptor, + { + dataId: 'join_source_a0b0da65-5e1a-4967-9dbe-74f24391afe2', + dataRequestMetaAtStart: {}, + dataRequestToken: Symbol('join request'), + }, + ], + } as unknown as VectorLayerDescriptor, + source: {} as unknown as IVectorSource, + }); + expect(layer.isInitialDataLoadComplete()).toBe(false); + }); + + test('should return true when tiles are loaded and joins are loaded', () => { + const layer = new MvtVectorLayer({ + customIcons: [], + joins: [ + { + hasCompleteConfig: () => { + return true; + }, + getSourceDataRequestId: () => { + return 'join_source_a0b0da65-5e1a-4967-9dbe-74f24391afe2'; + }, + } as unknown as InnerJoin, + ], + layerDescriptor: { + __areTilesLoaded: true, + __dataRequests: [ + sourceDataRequestDescriptor, + { + data: {}, + dataId: 'join_source_a0b0da65-5e1a-4967-9dbe-74f24391afe2', + dataRequestMeta: {}, + dataRequestMetaAtStart: undefined, + dataRequestToken: undefined, + }, + ], + } as unknown as VectorLayerDescriptor, + source: {} as unknown as IVectorSource, + }); + expect(layer.isInitialDataLoadComplete()).toBe(true); + }); +}); diff --git a/x-pack/plugins/maps/public/classes/layers/vector_layer/mvt_vector_layer/mvt_vector_layer.tsx b/x-pack/plugins/maps/public/classes/layers/vector_layer/mvt_vector_layer/mvt_vector_layer.tsx index a7a190c1c5b56..adb211f8f9420 100644 --- a/x-pack/plugins/maps/public/classes/layers/vector_layer/mvt_vector_layer/mvt_vector_layer.tsx +++ b/x-pack/plugins/maps/public/classes/layers/vector_layer/mvt_vector_layer/mvt_vector_layer.tsx @@ -29,7 +29,6 @@ import { DataRequestContext } from '../../../../actions'; import { DataRequestMeta, StyleMetaDescriptor, - TileMetaFeature, VectorLayerDescriptor, } from '../../../../../common/descriptor_types'; import { ESSearchSource } from '../../../sources/es_search_source'; @@ -39,10 +38,14 @@ import { LayerIcon } from '../../layer'; import { MvtSourceData, syncMvtSourceData } from './mvt_source_data'; import { PropertiesMap } from '../../../../../common/elasticsearch_util'; import { pluckStyleMeta } from './pluck_style_meta'; +import { + ES_MVT_HITS_TOTAL_RELATION, + ES_MVT_HITS_TOTAL_VALUE, + ES_MVT_META_LAYER_NAME, + getAggsMeta, + getHitsMeta, +} from '../../../util/tile_meta_feature_utils'; -export const ES_MVT_META_LAYER_NAME = 'meta'; -const ES_MVT_HITS_TOTAL_RELATION = 'hits.total.relation'; -const ES_MVT_HITS_TOTAL_VALUE = 'hits.total.value'; const MAX_RESULT_WINDOW_DATA_REQUEST_ID = 'maxResultWindow'; export class MvtVectorLayer extends AbstractVectorLayer { @@ -68,6 +71,12 @@ export class MvtVectorLayer extends AbstractVectorLayer { this._source = args.source as IMvtVectorSource; } + isInitialDataLoadComplete(): boolean { + return this._descriptor.__areTilesLoaded === undefined || !this._descriptor.__areTilesLoaded + ? false + : super.isInitialDataLoadComplete(); + } + async getBounds(syncContext: DataRequestContext) { // Add filter to narrow bounds to features with matching join keys let joinKeyFilter; @@ -116,19 +125,15 @@ export class MvtVectorLayer extends AbstractVectorLayer { // // TODO ES MVT specific - move to es_tiled_vector_layer implementation // - - const tileMetaFeatures = this._getMetaFromTiles(); - if (!tileMetaFeatures.length) { - return NO_RESULTS_ICON_AND_TOOLTIPCONTENT; - } - - if (this.getSource().getType() !== SOURCE_TYPES.ES_SEARCH) { - // aggregation ES sources are never trimmed - return { - icon: this.getCurrentStyle().getIcon(false), - tooltipContent: null, - areResultsTrimmed: false, - }; + if (this.getSource().getType() === SOURCE_TYPES.ES_GEO_GRID) { + const { docCount } = getAggsMeta(this._getMetaFromTiles()); + return docCount === 0 + ? NO_RESULTS_ICON_AND_TOOLTIPCONTENT + : { + icon: this.getCurrentStyle().getIcon(false), + tooltipContent: null, + areResultsTrimmed: false, + }; } const maxResultWindow = this._getMaxResultWindow(); @@ -140,28 +145,16 @@ export class MvtVectorLayer extends AbstractVectorLayer { }; } - let totalFeaturesCount = 0; - let tilesWithFeatures = 0; - tileMetaFeatures.forEach((tileMeta: Feature) => { - const count = - tileMeta && tileMeta.properties ? tileMeta.properties[ES_MVT_HITS_TOTAL_VALUE] : 0; - if (count > 0) { - totalFeaturesCount += count; - tilesWithFeatures++; - } - }); + const { totalFeaturesCount, tilesWithFeatures, tilesWithTrimmedResults } = getHitsMeta( + this._getMetaFromTiles(), + maxResultWindow + ); if (totalFeaturesCount === 0) { return NO_RESULTS_ICON_AND_TOOLTIPCONTENT; } - const areResultsTrimmed: boolean = tileMetaFeatures.some((tileMeta: TileMetaFeature) => { - if (tileMeta?.properties?.[ES_MVT_HITS_TOTAL_RELATION] === 'gte') { - return tileMeta?.properties?.[ES_MVT_HITS_TOTAL_VALUE] >= maxResultWindow + 1; - } else { - return false; - } - }); + const areResultsTrimmed = tilesWithTrimmedResults > 0; // Documents may be counted multiple times if geometry crosses tile boundaries. const canMultiCountShapes = @@ -232,7 +225,8 @@ export class MvtVectorLayer extends AbstractVectorLayer { syncContext.isForceRefresh, syncContext.dataFilters, this.getSource(), - this.getCurrentStyle() + this.getCurrentStyle(), + syncContext.isFeatureEditorOpenForLayer ), source: this.getSource() as IMvtVectorSource, syncContext, diff --git a/x-pack/plugins/maps/public/classes/layers/vector_layer/vector_layer.tsx b/x-pack/plugins/maps/public/classes/layers/vector_layer/vector_layer.tsx index 1b178d204f6e2..aee4312713b7d 100644 --- a/x-pack/plugins/maps/public/classes/layers/vector_layer/vector_layer.tsx +++ b/x-pack/plugins/maps/public/classes/layers/vector_layer/vector_layer.tsx @@ -366,7 +366,8 @@ export class AbstractVectorLayer extends AbstractLayer implements IVectorLayer { isForceRefresh: boolean, dataFilters: DataFilters, source: IVectorSource, - style: IVectorStyle + style: IVectorStyle, + isFeatureEditorOpenForLayer: boolean ): Promise { const fieldNames = [ ...source.getFieldNames(), @@ -378,7 +379,14 @@ export class AbstractVectorLayer extends AbstractLayer implements IVectorLayer { if (timesliceMaskFieldName) { fieldNames.push(timesliceMaskFieldName); } - return buildVectorRequestMeta(source, fieldNames, dataFilters, this.getQuery(), isForceRefresh); + return buildVectorRequestMeta( + source, + fieldNames, + dataFilters, + this.getQuery(), + isForceRefresh, + isFeatureEditorOpenForLayer + ); } async _syncSourceStyleMeta( @@ -542,6 +550,7 @@ export class AbstractVectorLayer extends AbstractLayer implements IVectorLayer { registerCancelCallback, dataFilters, isForceRefresh, + isFeatureEditorOpenForLayer, }: { join: InnerJoin } & DataRequestContext): Promise { const joinSource = join.getRightJoinSource(); const sourceDataId = join.getSourceDataRequestId(); @@ -552,7 +561,8 @@ export class AbstractVectorLayer extends AbstractLayer implements IVectorLayer { joinSource.getFieldNames(), dataFilters, joinSource.getWhereQuery(), - isForceRefresh + isForceRefresh, + isFeatureEditorOpenForLayer ) as VectorJoinSourceRequestMeta; const prevDataRequest = this.getDataRequest(sourceDataId); diff --git a/x-pack/plugins/maps/public/classes/sources/es_geo_grid_source/es_geo_grid_source.test.ts b/x-pack/plugins/maps/public/classes/sources/es_geo_grid_source/es_geo_grid_source.test.ts index bcbc50c7e0090..7110473b11261 100644 --- a/x-pack/plugins/maps/public/classes/sources/es_geo_grid_source/es_geo_grid_source.test.ts +++ b/x-pack/plugins/maps/public/classes/sources/es_geo_grid_source/es_geo_grid_source.test.ts @@ -178,6 +178,7 @@ describe('ESGeoGridSource', () => { sourceMeta: null, zoom: 0, isForceRefresh: false, + isFeatureEditorOpenForLayer: false, }; describe('getGeoJsonWithMeta', () => { diff --git a/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.test.ts b/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.test.ts index 54071848f9a40..2df2e119df30c 100644 --- a/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.test.ts +++ b/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.test.ts @@ -106,6 +106,7 @@ describe('ESSearchSource', () => { applyGlobalTime: true, applyForceRefresh: true, isForceRefresh: false, + isFeatureEditorOpenForLayer: false, }; it('Should only include required props', async () => { diff --git a/x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts b/x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts index c0eef8ba1ca22..944bf0ee3e0b1 100644 --- a/x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts +++ b/x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts @@ -230,7 +230,17 @@ export class AbstractESSource extends AbstractVectorSource implements IESSource allFilters.push(extentFilter); } - if (searchFilters.applyGlobalTime && (await this.isTimeAware())) { + + let isFeatureEditorOpenForLayer = false; + if ('isFeatureEditorOpenForLayer' in searchFilters) { + isFeatureEditorOpenForLayer = searchFilters.isFeatureEditorOpenForLayer; + } + + if ( + searchFilters.applyGlobalTime && + (await this.isTimeAware()) && + !isFeatureEditorOpenForLayer + ) { const timeRange = searchFilters.timeslice ? { from: new Date(searchFilters.timeslice.from).toISOString(), @@ -250,11 +260,11 @@ export class AbstractESSource extends AbstractVectorSource implements IESSource searchSource.setField('index', indexPattern); searchSource.setField('size', limit); searchSource.setField('filter', allFilters); - if (searchFilters.applyGlobalQuery) { + if (searchFilters.applyGlobalQuery && !isFeatureEditorOpenForLayer) { searchSource.setField('query', searchFilters.query); } - if (searchFilters.sourceQuery) { + if (searchFilters.sourceQuery && !isFeatureEditorOpenForLayer) { const layerSearchSource = searchService.searchSource.createEmpty(); layerSearchSource.setField('index', indexPattern); diff --git a/x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx b/x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx index 79830068628e5..43a2a00ca59e1 100644 --- a/x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx +++ b/x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx @@ -42,6 +42,7 @@ export interface BoundsRequestMeta { sourceQuery?: Query; timeFilters: TimeRange; timeslice?: Timeslice; + isFeatureEditorOpenForLayer: boolean; joinKeyFilter?: Filter; } diff --git a/x-pack/plugins/maps/public/classes/util/can_skip_fetch.ts b/x-pack/plugins/maps/public/classes/util/can_skip_fetch.ts index 69a5c73ba2933..71d4730880b96 100644 --- a/x-pack/plugins/maps/public/classes/util/can_skip_fetch.ts +++ b/x-pack/plugins/maps/public/classes/util/can_skip_fetch.ts @@ -86,6 +86,10 @@ export async function canSkipSourceUpdate({ return false; } + if (prevMeta.isFeatureEditorOpenForLayer !== nextRequestMeta.isFeatureEditorOpenForLayer) { + return false; + } + let updateDueToApplyGlobalTime = false; let updateDueToTime = false; let updateDueToTimeslice = false; diff --git a/x-pack/plugins/maps/public/classes/util/tile_meta_feature_utils.test.ts b/x-pack/plugins/maps/public/classes/util/tile_meta_feature_utils.test.ts new file mode 100644 index 0000000000000..c812dfa6b94f2 --- /dev/null +++ b/x-pack/plugins/maps/public/classes/util/tile_meta_feature_utils.test.ts @@ -0,0 +1,378 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { TileMetaFeature } from '../../../common/descriptor_types'; +import { getAggsMeta, getAggRange, getHitsMeta } from './tile_meta_feature_utils'; + +describe('getAggsMeta', () => { + test('should extract doc_count = 0 from meta features when there are no matches', () => { + const metaFeatures = [ + { + type: 'Feature', + geometry: { + type: 'Polygon', + coordinates: [ + [ + [-101.25, 31.952162238024968], + [-95.625, 31.952162238024968], + [-95.625, 36.597889133070225], + [-101.25, 36.597889133070225], + [-101.25, 31.952162238024968], + ], + ], + }, + properties: { + '_shards.failed': 0, + '_shards.skipped': 0, + '_shards.successful': 1, + '_shards.total': 1, + 'aggregations._count.count': 0, + 'aggregations._count.sum': 0, + 'hits.total.relation': 'eq', + 'hits.total.value': 0, + timed_out: false, + took: 1, + }, + }, + { + type: 'Feature', + geometry: { + type: 'Polygon', + coordinates: [ + [ + [-106.875, 31.952162238024968], + [-101.25, 31.952162238024968], + [-101.25, 36.597889133070225], + [-106.875, 36.597889133070225], + [-106.875, 31.952162238024968], + ], + ], + }, + properties: { + '_shards.failed': 0, + '_shards.skipped': 0, + '_shards.successful': 1, + '_shards.total': 1, + 'aggregations._count.count': 0, + 'aggregations._count.sum': 0, + 'hits.total.relation': 'eq', + 'hits.total.value': 0, + timed_out: false, + took: 1, + }, + }, + ] as TileMetaFeature[]; + const { docCount } = getAggsMeta(metaFeatures); + expect(docCount).toBe(0); + }); + + test('should extract doc_count from meta features', () => { + const metaFeatures = [ + { + type: 'Feature', + geometry: { + type: 'Polygon', + coordinates: [ + [ + [-106.875, 36.597889133070225], + [-101.25, 36.597889133070225], + [-101.25, 40.979898069620134], + [-106.875, 40.979898069620134], + [-106.875, 36.597889133070225], + ], + ], + }, + properties: { + '_shards.failed': 0, + '_shards.skipped': 0, + '_shards.successful': 1, + '_shards.total': 1, + 'aggregations._count.avg': 92.3133514986376, + 'aggregations._count.count': 9175, + 'aggregations._count.max': 8297, + 'aggregations._count.min': 1, + 'aggregations._count.sum': 846975, + 'hits.total.relation': 'gte', + 'hits.total.value': 10000, + timed_out: false, + took: 968, + }, + }, + { + type: 'Feature', + geometry: { + type: 'Polygon', + coordinates: [ + [ + [-112.5, 36.597889133070225], + [-106.875, 36.597889133070225], + [-106.875, 40.979898069620134], + [-112.5, 40.979898069620134], + [-112.5, 36.597889133070225], + ], + ], + }, + properties: { + '_shards.failed': 0, + '_shards.skipped': 0, + '_shards.successful': 1, + '_shards.total': 1, + 'aggregations._count.avg': 41.19310344827586, + 'aggregations._count.count': 4495, + 'aggregations._count.max': 2398, + 'aggregations._count.min': 1, + 'aggregations._count.sum': 185163, + 'hits.total.relation': 'gte', + 'hits.total.value': 10000, + timed_out: false, + took: 522, + }, + }, + { + type: 'Feature', + geometry: { + type: 'Polygon', + coordinates: [ + [ + [-106.875, 40.979898069620134], + [-101.25, 40.979898069620134], + [-101.25, 45.08903556483102], + [-106.875, 45.08903556483102], + [-106.875, 40.979898069620134], + ], + ], + }, + properties: { + '_shards.failed': 0, + '_shards.skipped': 0, + '_shards.successful': 1, + '_shards.total': 1, + 'aggregations._count.avg': 9.938271604938272, + 'aggregations._count.count': 81, + 'aggregations._count.max': 96, + 'aggregations._count.min': 1, + 'aggregations._count.sum': 805, + 'hits.total.relation': 'eq', + 'hits.total.value': 792, + timed_out: false, + took: 12, + }, + }, + ] as TileMetaFeature[]; + const { docCount } = getAggsMeta(metaFeatures); + expect(docCount).toBe(1032943); + }); +}); + +test('getAggRange', () => { + const metaFeature = { + type: 'Feature', + geometry: { + type: 'Polygon', + coordinates: [ + [ + [-106.875, 40.979898069620134], + [-101.25, 40.979898069620134], + [-101.25, 45.08903556483102], + [-106.875, 45.08903556483102], + [-106.875, 40.979898069620134], + ], + ], + }, + properties: { + '_shards.failed': 0, + '_shards.skipped': 0, + '_shards.successful': 1, + '_shards.total': 1, + 'aggregations._count.avg': 9.938271604938272, + 'aggregations._count.count': 81, + 'aggregations._count.max': 96, + 'aggregations._count.min': 1, + 'aggregations._count.sum': 805, + 'hits.total.relation': 'eq', + 'hits.total.value': 792, + timed_out: false, + took: 12, + }, + } as TileMetaFeature; + expect(getAggRange(metaFeature, '_count')).toEqual({ + max: 96, + min: 1, + }); +}); + +describe('getHitsMeta', () => { + test('should extract 0 total hits from meta features when there are no matches', () => { + const metaFeatures = [ + { + type: 'Feature', + geometry: { + type: 'Polygon', + coordinates: [ + [ + [-101.25, 31.952162238024968], + [-95.625, 31.952162238024968], + [-95.625, 36.597889133070225], + [-101.25, 36.597889133070225], + [-101.25, 31.952162238024968], + ], + ], + }, + properties: { + '_shards.failed': 0, + '_shards.skipped': 0, + '_shards.successful': 1, + '_shards.total': 1, + 'hits.total.relation': 'eq', + 'hits.total.value': 0, + timed_out: false, + took: 7, + }, + }, + { + type: 'Feature', + geometry: { + type: 'Polygon', + coordinates: [ + [ + [-106.875, 31.952162238024968], + [-101.25, 31.952162238024968], + [-101.25, 36.597889133070225], + [-106.875, 36.597889133070225], + [-106.875, 31.952162238024968], + ], + ], + }, + properties: { + '_shards.failed': 0, + '_shards.skipped': 0, + '_shards.successful': 1, + '_shards.total': 1, + 'hits.total.relation': 'eq', + 'hits.total.value': 0, + timed_out: false, + took: 7, + }, + }, + ] as TileMetaFeature[]; + expect(getHitsMeta(metaFeatures, 10000)).toEqual({ + tilesWithFeatures: 0, + tilesWithTrimmedResults: 0, + totalFeaturesCount: 0, + }); + }); + + test('should extract hits meta from meta features', () => { + const metaFeatures = [ + { + type: 'Feature', + geometry: { + type: 'Polygon', + coordinates: [ + [ + [-106.875, 36.99268153210721], + [-102.03826904296875, 36.99268153210721], + [-102.03826904296875, 40.979898069620134], + [-106.875, 40.979898069620134], + [-106.875, 36.99268153210721], + ], + ], + }, + properties: { + '_shards.failed': 0, + '_shards.skipped': 0, + '_shards.successful': 1, + '_shards.total': 1, + 'hits.total.relation': 'gte', + 'hits.total.value': 10001, + timed_out: false, + took: 1571, + }, + }, + { + type: 'Feature', + geometry: { + type: 'Polygon', + coordinates: [ + [ + [-109.05853271484375, 36.99706886366255], + [-106.875, 36.99706886366255], + [-106.875, 40.95086262813277], + [-109.05853271484375, 40.95086262813277], + [-109.05853271484375, 36.99706886366255], + ], + ], + }, + properties: { + '_shards.failed': 0, + '_shards.skipped': 0, + '_shards.successful': 1, + '_shards.total': 1, + 'hits.total.relation': 'gte', + 'hits.total.value': 10001, + timed_out: false, + took: 1039, + }, + }, + { + type: 'Feature', + geometry: { + type: 'Polygon', + coordinates: [ + [ + [-101.25, 40.979898069620134], + [-95.625, 40.979898069620134], + [-95.625, 45.08903556483102], + [-101.25, 45.08903556483102], + [-101.25, 40.979898069620134], + ], + ], + }, + properties: { + '_shards.failed': 0, + '_shards.skipped': 0, + '_shards.successful': 1, + '_shards.total': 1, + 'hits.total.relation': 'eq', + 'hits.total.value': 0, + timed_out: false, + took: 7, + }, + }, + { + type: 'Feature', + geometry: { + type: 'Polygon', + coordinates: [ + [ + [-107.7923583984375, 40.991301354803056], + [-107.05078125, 40.991301354803056], + [-107.05078125, 41.0037390532903], + [-107.7923583984375, 41.0037390532903], + [-107.7923583984375, 40.991301354803056], + ], + ], + }, + properties: { + '_shards.failed': 0, + '_shards.skipped': 0, + '_shards.successful': 1, + '_shards.total': 1, + 'hits.total.relation': 'eq', + 'hits.total.value': 28, + timed_out: false, + took: 10, + }, + }, + ] as TileMetaFeature[]; + expect(getHitsMeta(metaFeatures, 10000)).toEqual({ + tilesWithFeatures: 3, + tilesWithTrimmedResults: 2, + totalFeaturesCount: 20030, + }); + }); +}); diff --git a/x-pack/plugins/maps/public/classes/util/tile_meta_feature_utils.ts b/x-pack/plugins/maps/public/classes/util/tile_meta_feature_utils.ts new file mode 100644 index 0000000000000..ac12399a2e011 --- /dev/null +++ b/x-pack/plugins/maps/public/classes/util/tile_meta_feature_utils.ts @@ -0,0 +1,70 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { TileMetaFeature } from '../../../common/descriptor_types'; + +// Elasticsearch vector tile API returns "meta" layer containing a single metadata feature for each tile request +// This file contains utility methods for pulling values out of metadata features +// Placing logic in a single file to provide a centrialize location and avoid scattering logic throughout plugin + +export const ES_MVT_META_LAYER_NAME = 'meta'; +export const ES_MVT_HITS_TOTAL_RELATION = 'hits.total.relation'; +export const ES_MVT_HITS_TOTAL_VALUE = 'hits.total.value'; + +export function getAggsMeta(metaFeatures: TileMetaFeature[]): { docCount: number } { + let docCount = 0; + metaFeatures.forEach((metaFeature) => { + const count = metaFeature.properties + ? (metaFeature.properties['aggregations._count.sum'] as number) + : 0; + if (count > 0) { + docCount += count; + } + }); + + return { docCount }; +} + +export function getHitsMeta( + metaFeatures: TileMetaFeature[], + maxResultWindow: number +): { totalFeaturesCount: number; tilesWithFeatures: number; tilesWithTrimmedResults: number } { + let totalFeaturesCount = 0; + let tilesWithFeatures = 0; + let tilesWithTrimmedResults = 0; + metaFeatures.forEach((metaFeature) => { + const count = metaFeature.properties ? metaFeature.properties[ES_MVT_HITS_TOTAL_VALUE] : 0; + if (count > 0) { + totalFeaturesCount += count; + tilesWithFeatures++; + } + + if ( + metaFeature?.properties?.[ES_MVT_HITS_TOTAL_RELATION] === 'gte' && + metaFeature?.properties?.[ES_MVT_HITS_TOTAL_VALUE] >= maxResultWindow + 1 + ) { + tilesWithTrimmedResults++; + } + }); + return { totalFeaturesCount, tilesWithFeatures, tilesWithTrimmedResults }; +} + +export function getAggRange( + metaFeature: TileMetaFeature, + subAggName: string +): { min: number; max: number } | null { + const minField = `aggregations.${subAggName}.min`; + const maxField = `aggregations.${subAggName}.max`; + return metaFeature.properties && + typeof metaFeature.properties[minField] === 'number' && + typeof metaFeature.properties[maxField] === 'number' + ? { + min: metaFeature.properties[minField] as number, + max: metaFeature.properties[maxField] as number, + } + : null; +} diff --git a/x-pack/plugins/maps/public/components/global_filter_checkbox.tsx b/x-pack/plugins/maps/public/components/global_filter_checkbox.tsx index 96805e0c6b5ec..502cc1973d329 100644 --- a/x-pack/plugins/maps/public/components/global_filter_checkbox.tsx +++ b/x-pack/plugins/maps/public/components/global_filter_checkbox.tsx @@ -13,27 +13,37 @@ interface Props { applyGlobalQuery: boolean; label: string; setApplyGlobalQuery: (applyGlobalQuery: boolean) => void; + isFeatureEditorOpenForLayer?: boolean; } -export function GlobalFilterCheckbox({ applyGlobalQuery, label, setApplyGlobalQuery }: Props) { +export function GlobalFilterCheckbox({ + applyGlobalQuery, + label, + setApplyGlobalQuery, + isFeatureEditorOpenForLayer, +}: Props) { const onApplyGlobalQueryChange = (event: EuiSwitchEvent) => { setApplyGlobalQuery(event.target.checked); }; + const tooltipMessage = isFeatureEditorOpenForLayer + ? i18n.translate('xpack.maps.filterEditor.isGlobalSearchNotApplied', { + defaultMessage: 'Global search is not applied to the layer while editing features', + }) + : i18n.translate('xpack.maps.filterEditor.applyGlobalFilterHelp', { + defaultMessage: 'When enabled, results narrowed by global search', + }); + return ( - + diff --git a/x-pack/plugins/maps/public/components/global_time_checkbox.tsx b/x-pack/plugins/maps/public/components/global_time_checkbox.tsx index 70d6859b8b02a..4db771c1edbaf 100644 --- a/x-pack/plugins/maps/public/components/global_time_checkbox.tsx +++ b/x-pack/plugins/maps/public/components/global_time_checkbox.tsx @@ -12,27 +12,37 @@ interface Props { applyGlobalTime: boolean; label: string; setApplyGlobalTime: (applyGlobalTime: boolean) => void; + isFeatureEditorOpenForLayer?: boolean; } -export function GlobalTimeCheckbox({ applyGlobalTime, label, setApplyGlobalTime }: Props) { +export function GlobalTimeCheckbox({ + applyGlobalTime, + label, + setApplyGlobalTime, + isFeatureEditorOpenForLayer, +}: Props) { const onApplyGlobalTimeChange = (event: EuiSwitchEvent) => { setApplyGlobalTime(event.target.checked); }; + const tooltipMessage = isFeatureEditorOpenForLayer + ? i18n.translate('xpack.maps.filterEditor.isGlobalTimeNotApplied', { + defaultMessage: 'Global time is not applied to the layer while editing features', + }) + : i18n.translate('xpack.maps.filterEditor.applyGlobalTimeHelp', { + defaultMessage: 'When enabled, results narrowed by global time', + }); + return ( - + diff --git a/x-pack/plugins/maps/public/connected_components/edit_layer_panel/filter_editor/filter_editor.tsx b/x-pack/plugins/maps/public/connected_components/edit_layer_panel/filter_editor/filter_editor.tsx index afb18aa582a3c..9e3edeb1fc255 100644 --- a/x-pack/plugins/maps/public/connected_components/edit_layer_panel/filter_editor/filter_editor.tsx +++ b/x-pack/plugins/maps/public/connected_components/edit_layer_panel/filter_editor/filter_editor.tsx @@ -35,6 +35,7 @@ export interface Props { layer: ILayer; setLayerQuery: (id: string, query: Query) => void; updateSourceProp: (layerId: string, propName: string, value: unknown) => void; + isFeatureEditorOpenForLayer: boolean; } interface State { @@ -157,6 +158,15 @@ export class FilterEditor extends Component { } _renderQuery() { + if (this.props.isFeatureEditorOpenForLayer) { + return ( + + ); + } + const query = this.props.layer.getQuery(); if (!query || !query.query) { return ( @@ -199,6 +209,7 @@ export class FilterEditor extends Component { onClick={this._toggle} data-test-subj="mapLayerPanelOpenFilterEditorButton" iconType={openButtonIcon} + disabled={this.props.isFeatureEditorOpenForLayer} > {openButtonLabel} @@ -213,6 +224,7 @@ export class FilterEditor extends Component { })} applyGlobalTime={this.props.layer.getSource().getApplyGlobalTime()} setApplyGlobalTime={this._onApplyGlobalTimeChange} + isFeatureEditorOpenForLayer={this.props.isFeatureEditorOpenForLayer} /> ) : null; @@ -244,6 +256,7 @@ export class FilterEditor extends Component { })} applyGlobalQuery={this.props.layer.getSource().getApplyGlobalQuery()} setApplyGlobalQuery={this._onApplyGlobalQueryChange} + isFeatureEditorOpenForLayer={this.props.isFeatureEditorOpenForLayer} /> {globalTimeCheckbox} diff --git a/x-pack/plugins/maps/public/connected_components/edit_layer_panel/filter_editor/index.ts b/x-pack/plugins/maps/public/connected_components/edit_layer_panel/filter_editor/index.ts index 7c3db15f10236..51b19e7b05c96 100644 --- a/x-pack/plugins/maps/public/connected_components/edit_layer_panel/filter_editor/index.ts +++ b/x-pack/plugins/maps/public/connected_components/edit_layer_panel/filter_editor/index.ts @@ -10,13 +10,15 @@ import { ThunkDispatch } from 'redux-thunk'; import { connect } from 'react-redux'; import type { Query } from '@kbn/data-plugin/public'; import { FilterEditor } from './filter_editor'; -import { getSelectedLayer } from '../../../selectors/map_selectors'; +import { getEditState, getSelectedLayer } from '../../../selectors/map_selectors'; import { setLayerQuery, updateSourceProp } from '../../../actions'; import { MapStoreState } from '../../../reducers/store'; function mapStateToProps(state: MapStoreState) { + const layer = getSelectedLayer(state)!; return { - layer: getSelectedLayer(state)!, + layer, + isFeatureEditorOpenForLayer: getEditState(state)?.layerId === layer.getId(), }; } diff --git a/x-pack/plugins/maps/public/connected_components/edit_layer_panel/join_editor/join_editor.tsx b/x-pack/plugins/maps/public/connected_components/edit_layer_panel/join_editor/join_editor.tsx index cfa46ecf32b32..2865e2d8099d1 100644 --- a/x-pack/plugins/maps/public/connected_components/edit_layer_panel/join_editor/join_editor.tsx +++ b/x-pack/plugins/maps/public/connected_components/edit_layer_panel/join_editor/join_editor.tsx @@ -79,6 +79,7 @@ export function JoinEditor({ joins, layer, onChange, leftJoinFields, layerDispla function renderContent() { const disabledReason = layer.getJoinsDisabledReason(); + return disabledReason ? ( {disabledReason} ) : ( diff --git a/x-pack/plugins/maps/public/connected_components/mb_map/tile_status_tracker.test.ts b/x-pack/plugins/maps/public/connected_components/mb_map/tile_status_tracker.test.ts index ffc6459262c8b..6485582149db7 100644 --- a/x-pack/plugins/maps/public/connected_components/mb_map/tile_status_tracker.test.ts +++ b/x-pack/plugins/maps/public/connected_components/mb_map/tile_status_tracker.test.ts @@ -113,7 +113,7 @@ describe('TileStatusTracker', () => { expect(loadedMap.get('foo')).toBe(true); expect(loadedMap.get('bar')).toBe(false); // still outstanding tile requests - expect(loadedMap.has('foobar')).toBe(true); // never received tile requests + expect(loadedMap.has('foobar')).toBe(false); // never received tile requests, status should not have been reported for layer (aa11BarTile as { tile: { aborted: boolean } })!.tile.aborted = true; // abort tile mockMbMap.emit('sourcedataloading', createMockMbDataEvent('barsource', 'af1d')); @@ -125,7 +125,7 @@ describe('TileStatusTracker', () => { expect(loadedMap.get('foo')).toBe(false); // still outstanding tile requests expect(loadedMap.get('bar')).toBe(true); // tiles were aborted or errored - expect(loadedMap.has('foobar')).toBe(true); // never received tile requests + expect(loadedMap.has('foobar')).toBe(false); // never received tile requests, status should not have been reported for layer }); test('should cleanup listeners on destroy', async () => { diff --git a/x-pack/plugins/maps/public/connected_components/mb_map/tile_status_tracker.ts b/x-pack/plugins/maps/public/connected_components/mb_map/tile_status_tracker.ts index 94a4344bac009..c349ef0ede3b6 100644 --- a/x-pack/plugins/maps/public/connected_components/mb_map/tile_status_tracker.ts +++ b/x-pack/plugins/maps/public/connected_components/mb_map/tile_status_tracker.ts @@ -29,8 +29,21 @@ interface Tile { } export class TileStatusTracker { - private _tileCache: Tile[]; - private _tileErrorCache: Record; + // Tile cache tracks active tile requests + // 'sourcedataloading' event adds tile request to cache + // 'sourcedata' and 'error' events remove tile request from cache + // Tile requests with 'aborted' status are removed from cache when reporting 'areTilesLoaded' status + private _tileCache: Tile[] = []; + + // Tile error cache tracks tile request errors per layer + // Error cache is cleared when map center tile changes + private _tileErrorCache: Record = {}; + + // Layer cache tracks layers that have requested one or more tiles + // Layer cache is used so that only a layer that has requested one or more tiles reports 'areTilesLoaded' status + // layer cache is never cleared + private _layerCache: Map = new Map(); + private _prevCenterTileKey?: string; private readonly _mbMap: MapboxMap; private readonly _updateTileStatus: ( @@ -48,6 +61,14 @@ export class TileStatusTracker { e.tile && (e.source.type === 'vector' || e.source.type === 'raster') ) { + const targetLayer = this._getCurrentLayerList().find((layer) => { + return layer.ownsMbSourceId(e.sourceId); + }); + const layerId = targetLayer ? targetLayer.getId() : undefined; + if (layerId && !this._layerCache.has(layerId)) { + this._layerCache.set(layerId, true); + } + const tracked = this._tileCache.find((tile) => { return ( tile.mbKey === (e.tile.tileID.key as unknown as string) && tile.mbSourceId === e.sourceId @@ -127,8 +148,6 @@ export class TileStatusTracker { updateTileStatus: (layer: ILayer, areTilesLoaded: boolean, errorMessage?: string) => void; getCurrentLayerList: () => ILayer[]; }) { - this._tileCache = []; - this._tileErrorCache = {}; this._updateTileStatus = updateTileStatus; this._getCurrentLayerList = getCurrentLayerList; @@ -146,6 +165,12 @@ export class TileStatusTracker { const layerList = this._getCurrentLayerList(); for (let i = 0; i < layerList.length; i++) { const layer: ILayer = layerList[i]; + + if (!this._layerCache.has(layer.getId())) { + // do not report status for layers that have not started loading tiles. + continue; + } + let atLeastOnePendingTile = false; for (let j = 0; j < this._tileCache.length; j++) { const tile = this._tileCache[j]; diff --git a/x-pack/plugins/maps/public/connected_components/mb_map/utils.ts b/x-pack/plugins/maps/public/connected_components/mb_map/utils.ts index 5fc9fd62b20c2..552a618e11f7e 100644 --- a/x-pack/plugins/maps/public/connected_components/mb_map/utils.ts +++ b/x-pack/plugins/maps/public/connected_components/mb_map/utils.ts @@ -9,7 +9,7 @@ import type { Map as MbMap } from '@kbn/mapbox-gl'; import { TileMetaFeature } from '../../../common/descriptor_types'; import { isGlDrawLayer } from './sort_layers'; import { ILayer } from '../../classes/layers/layer'; -import { ES_MVT_META_LAYER_NAME } from '../../classes/layers/vector_layer/mvt_vector_layer/mvt_vector_layer'; +import { ES_MVT_META_LAYER_NAME } from '../../classes/util/tile_meta_feature_utils'; export function removeOrphanedSourcesAndLayers( mbMap: MbMap, diff --git a/x-pack/plugins/maps/public/connected_components/right_side_controls/layer_control/layer_toc/toc_entry/__snapshots__/toc_entry.test.tsx.snap b/x-pack/plugins/maps/public/connected_components/right_side_controls/layer_control/layer_toc/toc_entry/__snapshots__/toc_entry.test.tsx.snap index 5beaf12029d2f..cec85cb0e1cd6 100644 --- a/x-pack/plugins/maps/public/connected_components/right_side_controls/layer_control/layer_toc/toc_entry/__snapshots__/toc_entry.test.tsx.snap +++ b/x-pack/plugins/maps/public/connected_components/right_side_controls/layer_control/layer_toc/toc_entry/__snapshots__/toc_entry.test.tsx.snap @@ -11,7 +11,6 @@ exports[`TOCEntry is rendered 1`] = ` > {}, showTOCDetails: () => {}, - editModeActiveForLayer: false, + isFeatureEditorOpenForLayer: false, cancelEditing: () => {}, }; diff --git a/x-pack/plugins/maps/public/connected_components/right_side_controls/layer_control/layer_toc/toc_entry/toc_entry.tsx b/x-pack/plugins/maps/public/connected_components/right_side_controls/layer_control/layer_toc/toc_entry/toc_entry.tsx index aeba28cf033bd..65431432d8c6d 100644 --- a/x-pack/plugins/maps/public/connected_components/right_side_controls/layer_control/layer_toc/toc_entry/toc_entry.tsx +++ b/x-pack/plugins/maps/public/connected_components/right_side_controls/layer_control/layer_toc/toc_entry/toc_entry.tsx @@ -31,7 +31,7 @@ export interface ReduxStateProps { hasDirtyStateSelector: boolean; isLegendDetailsOpen: boolean; isEditButtonDisabled: boolean; - editModeActiveForLayer: boolean; + isFeatureEditorOpenForLayer: boolean; } export interface ReduxDispatchProps { @@ -282,7 +282,6 @@ export class TOCEntry extends Component { openLayerSettings={this._openLayerPanelWithCheck} isEditButtonDisabled={this.props.isEditButtonDisabled} supportsFitToBounds={this.state.supportsFitToBounds} - editModeActiveForLayer={this.props.editModeActiveForLayer} /> {this._renderQuickActions()} @@ -317,7 +316,7 @@ export class TOCEntry extends Component { 'mapTocEntry-isSelected': this.props.layer.isPreviewLayer() || (this.props.selectedLayer && this.props.selectedLayer.getId() === this.props.layer.getId()), - 'mapTocEntry-isInEditingMode': this.props.editModeActiveForLayer, + 'mapTocEntry-isInEditingMode': this.props.isFeatureEditorOpenForLayer, }); return ( @@ -334,7 +333,7 @@ export class TOCEntry extends Component { {this._renderCancelModal()} - {this.props.editModeActiveForLayer && ( + {this.props.isFeatureEditorOpenForLayer && (
diff --git a/x-pack/plugins/maps/public/connected_components/right_side_controls/layer_control/layer_toc/toc_entry/toc_entry_actions_popover/toc_entry_actions_popover.test.tsx b/x-pack/plugins/maps/public/connected_components/right_side_controls/layer_control/layer_toc/toc_entry/toc_entry_actions_popover/toc_entry_actions_popover.test.tsx index ae62b75400769..cb2697663766a 100644 --- a/x-pack/plugins/maps/public/connected_components/right_side_controls/layer_control/layer_toc/toc_entry/toc_entry_actions_popover/toc_entry_actions_popover.test.tsx +++ b/x-pack/plugins/maps/public/connected_components/right_side_controls/layer_control/layer_toc/toc_entry/toc_entry_actions_popover/toc_entry_actions_popover.test.tsx @@ -48,7 +48,6 @@ const defaultProps = { enableShapeEditing: () => {}, enablePointEditing: () => {}, openLayerSettings: () => {}, - editModeActiveForLayer: false, numLayers: 2, showThisLayerOnly: () => {}, }; @@ -105,9 +104,7 @@ describe('TOCEntryActionsPopover', () => { }); test('should disable Edit features when edit mode active for layer', async () => { - const component = shallow( - - ); + const component = shallow(); // Ensure all promises resolve await new Promise((resolve) => process.nextTick(resolve)); diff --git a/x-pack/plugins/maps/public/connected_components/right_side_controls/layer_control/layer_toc/toc_entry/toc_entry_actions_popover/toc_entry_actions_popover.tsx b/x-pack/plugins/maps/public/connected_components/right_side_controls/layer_control/layer_toc/toc_entry/toc_entry_actions_popover/toc_entry_actions_popover.tsx index 3f3b7558409f8..5e33931a8943e 100644 --- a/x-pack/plugins/maps/public/connected_components/right_side_controls/layer_control/layer_toc/toc_entry/toc_entry_actions_popover/toc_entry_actions_popover.tsx +++ b/x-pack/plugins/maps/public/connected_components/right_side_controls/layer_control/layer_toc/toc_entry/toc_entry_actions_popover/toc_entry_actions_popover.tsx @@ -36,7 +36,6 @@ export interface Props { showThisLayerOnly: (layerId: string) => void; supportsFitToBounds: boolean; toggleVisible: (layerId: string) => void; - editModeActiveForLayer: boolean; numLayers: number; } @@ -90,9 +89,7 @@ export class TOCEntryActionsPopover extends Component { } if ( - (source as ESSearchSource).getApplyGlobalQuery() || (source as ESSearchSource).getSyncMeta().scalingType === SCALING_TYPES.CLUSTERS || - (await vectorLayer.isFilteredByGlobalTime()) || vectorLayer.isPreviewLayer() || !vectorLayer.isVisible() || vectorLayer.hasJoins() @@ -194,9 +191,9 @@ export class TOCEntryActionsPopover extends Component { ? null : i18n.translate('xpack.maps.layerTocActions.editFeaturesTooltip.disabledMessage', { defaultMessage: - 'Edit features only supported for document layers without clustering, term joins, time filtering, or global search.', + 'Edit features is only supported for layers without clustering and term joins', }), - disabled: !this.state.isFeatureEditingEnabled || this.props.editModeActiveForLayer, + disabled: !this.state.isFeatureEditingEnabled, onClick: async () => { this._closePopover(); const supportedShapeTypes = await ( diff --git a/x-pack/plugins/ml/common/constants/trained_models.ts b/x-pack/plugins/ml/common/constants/trained_models.ts index 79fe65936b231..75ea25dcc9efa 100644 --- a/x-pack/plugins/ml/common/constants/trained_models.ts +++ b/x-pack/plugins/ml/common/constants/trained_models.ts @@ -22,10 +22,10 @@ export type TrainedModelType = typeof TRAINED_MODEL_TYPE[keyof typeof TRAINED_MO export const SUPPORTED_PYTORCH_TASKS = { NER: 'ner', - // ZERO_SHOT_CLASSIFICATION: 'zero_shot_classification', - // CLASSIFICATION_LABELS: 'classification_labels', - // TEXT_CLASSIFICATION: 'text_classification', - // TEXT_EMBEDDING: 'text_embedding', + ZERO_SHOT_CLASSIFICATION: 'zero_shot_classification', + TEXT_CLASSIFICATION: 'text_classification', + TEXT_EMBEDDING: 'text_embedding', + FILL_MASK: 'fill_mask', } as const; export type SupportedPytorchTasksType = typeof SUPPORTED_PYTORCH_TASKS[keyof typeof SUPPORTED_PYTORCH_TASKS]; diff --git a/x-pack/plugins/ml/common/util/errors/errors.test.ts b/x-pack/plugins/ml/common/util/errors/errors.test.ts index 625374857c7ce..e299c67d882f4 100644 --- a/x-pack/plugins/ml/common/util/errors/errors.test.ts +++ b/x-pack/plugins/ml/common/util/errors/errors.test.ts @@ -7,7 +7,7 @@ import Boom from '@hapi/boom'; -import { extractErrorMessage, MLHttpFetchError, MLResponseError, EsErrorBody } from '.'; +import { extractErrorMessage, MLHttpFetchError, EsErrorBody } from '.'; describe('ML - error message utils', () => { describe('extractErrorMessage', () => { @@ -39,7 +39,7 @@ describe('ML - error message utils', () => { expect(extractErrorMessage(stringMessage)).toBe(testMsg); // kibana error without attributes - const bodyWithoutAttributes: MLHttpFetchError = { + const bodyWithoutAttributes: MLHttpFetchError = { name: 'name', req: {} as Request, request: {} as Request, @@ -53,7 +53,7 @@ describe('ML - error message utils', () => { expect(extractErrorMessage(bodyWithoutAttributes)).toBe(testMsg); // kibana error with attributes - const bodyWithAttributes: MLHttpFetchError = { + const bodyWithAttributes: MLHttpFetchError = { name: 'name', req: {} as Request, request: {} as Request, diff --git a/x-pack/plugins/ml/common/util/errors/types.ts b/x-pack/plugins/ml/common/util/errors/types.ts index d1f0d3216f42e..fafbeeb4c1a12 100644 --- a/x-pack/plugins/ml/common/util/errors/types.ts +++ b/x-pack/plugins/ml/common/util/errors/types.ts @@ -45,16 +45,13 @@ export interface MLErrorObject { fullError?: EsErrorBody; } -export interface MLHttpFetchError extends HttpFetchError { +export interface MLHttpFetchErrorBase extends HttpFetchError { body: T; } -export type ErrorType = - | MLHttpFetchError - | EsErrorBody - | Boom.Boom - | string - | undefined; +export type MLHttpFetchError = MLHttpFetchErrorBase; + +export type ErrorType = MLHttpFetchError | EsErrorBody | Boom.Boom | string | undefined; export function isEsErrorBody(error: any): error is EsErrorBody { return error && error.error?.reason !== undefined; diff --git a/x-pack/plugins/ml/public/application/jobs/new_job/common/job_creator/util/model_memory_estimator.ts b/x-pack/plugins/ml/public/application/jobs/new_job/common/job_creator/util/model_memory_estimator.ts index 1e28ac6ef8a2d..a0ca9e4502cc2 100644 --- a/x-pack/plugins/ml/public/application/jobs/new_job/common/job_creator/util/model_memory_estimator.ts +++ b/x-pack/plugins/ml/public/application/jobs/new_job/common/job_creator/util/model_memory_estimator.ts @@ -24,11 +24,7 @@ import { useEffect, useMemo } from 'react'; import { DEFAULT_MODEL_MEMORY_LIMIT } from '../../../../../../../common/constants/new_job'; import { ml } from '../../../../../services/ml_api_service'; import { JobValidator, VALIDATION_DELAY_MS } from '../../job_validator/job_validator'; -import { - MLHttpFetchError, - MLResponseError, - extractErrorMessage, -} from '../../../../../../../common/util/errors'; +import { MLHttpFetchError, extractErrorMessage } from '../../../../../../../common/util/errors'; import { useMlKibana } from '../../../../../contexts/kibana'; import { JobCreator } from '../job_creator'; @@ -41,10 +37,10 @@ export const modelMemoryEstimatorProvider = ( jobValidator: JobValidator ) => { const modelMemoryCheck$ = new Subject(); - const error$ = new Subject>(); + const error$ = new Subject(); return { - get error$(): Observable> { + get error$(): Observable { return error$.asObservable(); }, get updates$(): Observable { diff --git a/x-pack/plugins/ml/public/application/trained_models/models_management/models_list.tsx b/x-pack/plugins/ml/public/application/trained_models/models_management/models_list.tsx index 063235e9db9fd..357015b057996 100644 --- a/x-pack/plugins/ml/public/application/trained_models/models_management/models_list.tsx +++ b/x-pack/plugins/ml/public/application/trained_models/models_management/models_list.tsx @@ -484,6 +484,9 @@ export const ModelsList: FC = ({ isPrimary: true, available: isTestable, onClick: setShowTestFlyout, + enabled: (item) => + isPopulatedObject(item.stats?.deployment_stats) && + item.stats?.deployment_stats?.state === DEPLOYMENT_STATE.STARTED, }, ] as Array>) ); diff --git a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/index.ts b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/index.ts new file mode 100644 index 0000000000000..ef46c223f609e --- /dev/null +++ b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { NerInference } from './ner'; +import { + TextClassificationInference, + ZeroShotClassificationInference, + FillMaskInference, +} from './text_classification'; +import { TextEmbeddingInference } from './text_embedding'; +import { LangIdentInference } from './lang_ident'; + +export type InferrerType = + | NerInference + | TextClassificationInference + | TextEmbeddingInference + | ZeroShotClassificationInference + | FillMaskInference + | LangIdentInference; diff --git a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/inference_base.ts b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/inference_base.ts index 777ca2d314c4d..db27fb96e9c2a 100644 --- a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/inference_base.ts +++ b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/inference_base.ts @@ -5,19 +5,38 @@ * 2.0. */ +import { BehaviorSubject } from 'rxjs'; import * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; +import { MLHttpFetchError } from '../../../../../../common/util/errors'; import { trainedModelsApiProvider } from '../../../../services/ml_api_service/trained_models'; const DEFAULT_INPUT_FIELD = 'text_field'; -export type FormattedNerResp = Array<{ +export type FormattedNerResponse = Array<{ value: string; entity: estypes.MlTrainedModelEntities | null; }>; +export interface InferResponse { + inputText: string; + response: T; + rawResponse: U; +} + +export enum RUNNING_STATE { + STOPPED, + RUNNING, + FINISHED, + FINISHED_WITH_ERRORS, +} + export abstract class InferenceBase { protected readonly inputField: string; + public inputText$ = new BehaviorSubject(''); + public inferenceResult$ = new BehaviorSubject(null); + public inferenceError$ = new BehaviorSubject(null); + public runningState$ = new BehaviorSubject(RUNNING_STATE.STOPPED); constructor( protected trainedModelsApi: ReturnType, @@ -26,5 +45,26 @@ export abstract class InferenceBase { this.inputField = model.input?.field_names[0] ?? DEFAULT_INPUT_FIELD; } - protected abstract infer(inputText: string): Promise; + public setStopped() { + this.inferenceError$.next(null); + this.runningState$.next(RUNNING_STATE.STOPPED); + } + public setRunning() { + this.inferenceError$.next(null); + this.runningState$.next(RUNNING_STATE.RUNNING); + } + + public setFinished() { + this.runningState$.next(RUNNING_STATE.FINISHED); + } + + public setFinishedWithErrors(error: MLHttpFetchError) { + this.inferenceError$.next(error); + this.runningState$.next(RUNNING_STATE.FINISHED_WITH_ERRORS); + } + + protected abstract getInputComponent(): JSX.Element; + protected abstract getOutputComponent(): JSX.Element; + + protected abstract infer(): Promise; } diff --git a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/inference_input_form.tsx b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/inference_input_form.tsx index 6503486d98211..0ee33791ef55e 100644 --- a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/inference_input_form.tsx +++ b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/inference_input_form.tsx @@ -5,25 +5,20 @@ * 2.0. */ -import React, { FC, useState } from 'react'; +import React, { FC, useState, useMemo } from 'react'; -import { i18n } from '@kbn/i18n'; +import useObservable from 'react-use/lib/useObservable'; import { FormattedMessage } from '@kbn/i18n-react'; -import { EuiSpacer, EuiTextArea, EuiButton, EuiTabs, EuiTab } from '@elastic/eui'; - -import { LangIdentInference } from './lang_ident/lang_ident_inference'; -import { NerInference } from './ner/ner_inference'; -import type { FormattedLangIdentResp } from './lang_ident/lang_ident_inference'; -import type { FormattedNerResp } from './ner/ner_inference'; - -import { MLJobEditor } from '../../../../jobs/jobs_list/components/ml_job_editor'; +import { EuiSpacer, EuiButton, EuiTabs, EuiTab } from '@elastic/eui'; import { extractErrorMessage } from '../../../../../../common/util/errors'; import { ErrorMessage } from '../inference_error'; import { OutputLoadingContent } from '../output_loading'; +import { RUNNING_STATE } from './inference_base'; +import { RawOutput } from './raw_output'; +import type { InferrerType } from '.'; interface Props { - inferrer: LangIdentInference | NerInference; - getOutputComponent(output: any): JSX.Element; + inferrer: InferrerType; } enum TAB { @@ -31,61 +26,41 @@ enum TAB { RAW, } -export const InferenceInputForm: FC = ({ inferrer, getOutputComponent }) => { - const [inputText, setInputText] = useState(''); - const [isRunning, setIsRunning] = useState(false); - const [output, setOutput] = useState(null); - const [rawOutput, setRawOutput] = useState(null); +export const InferenceInputForm: FC = ({ inferrer }) => { const [selectedTab, setSelectedTab] = useState(TAB.TEXT); - const [showOutput, setShowOutput] = useState(false); const [errorText, setErrorText] = useState(null); + const runningState = useObservable(inferrer.runningState$); + const inputText = useObservable(inferrer.inputText$); + const inputComponent = useMemo(() => inferrer.getInputComponent(), []); + const outputComponent = useMemo(() => inferrer.getOutputComponent(), []); + async function run() { - setShowOutput(true); - setOutput(null); - setRawOutput(null); - setIsRunning(true); setErrorText(null); try { - const { response, rawResponse } = await inferrer.infer(inputText); - setOutput(response); - setRawOutput(JSON.stringify(rawResponse, null, 2)); + await inferrer.infer(); } catch (e) { - setIsRunning(false); - setOutput(null); setErrorText(extractErrorMessage(e)); - setRawOutput(JSON.stringify(e.body ?? e, null, 2)); } - setIsRunning(false); } return ( <> - { - setInputText(e.target.value); - }} - /> + <>{inputComponent}
- {showOutput === true ? ( + {runningState !== RUNNING_STATE.STOPPED ? ( <> @@ -94,7 +69,7 @@ export const InferenceInputForm: FC = ({ inferrer, getOutputComponent }) onClick={setSelectedTab.bind(null, TAB.TEXT)} > @@ -103,7 +78,7 @@ export const InferenceInputForm: FC = ({ inferrer, getOutputComponent }) onClick={setSelectedTab.bind(null, TAB.RAW)} > @@ -113,16 +88,16 @@ export const InferenceInputForm: FC = ({ inferrer, getOutputComponent }) {selectedTab === TAB.TEXT ? ( <> - {errorText !== null ? ( + {runningState === RUNNING_STATE.RUNNING ? : null} + + {errorText !== null || runningState === RUNNING_STATE.FINISHED_WITH_ERRORS ? ( - ) : output === null ? ( - - ) : ( - <>{getOutputComponent(output)} - )} + ) : null} + + {runningState === RUNNING_STATE.FINISHED ? <>{outputComponent} : null} ) : ( - + )} ) : null} diff --git a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/lang_ident/index.ts b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/lang_ident/index.ts index b3439d90e8828..8e5bd8cdbeb5f 100644 --- a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/lang_ident/index.ts +++ b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/lang_ident/index.ts @@ -5,6 +5,6 @@ * 2.0. */ -export type { FormattedLangIdentResp } from './lang_ident_inference'; +export type { FormattedLangIdentResponse, LangIdentResponse } from './lang_ident_inference'; export { LangIdentInference } from './lang_ident_inference'; -export { LangIdentOutput } from './lang_ident_output'; +export { getLangIdentOutputComponent } from './lang_ident_output'; diff --git a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/lang_ident/lang_ident_inference.ts b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/lang_ident/lang_ident_inference.ts index 9108a59197617..34893d7dc9402 100644 --- a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/lang_ident/lang_ident_inference.ts +++ b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/lang_ident/lang_ident_inference.ts @@ -7,62 +7,86 @@ import * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; -import { InferenceBase } from '../inference_base'; +import { InferenceBase, InferResponse } from '../inference_base'; +import { getGeneralInputComponent } from '../text_input'; +import { getLangIdentOutputComponent } from './lang_ident_output'; -export type FormattedLangIdentResp = Array<{ +export type FormattedLangIdentResponse = Array<{ className: string; classProbability: number; classScore: number; }>; -interface InferResponse { - response: FormattedLangIdentResp; - rawResponse: estypes.IngestSimulateResponse; -} +export type LangIdentResponse = InferResponse< + FormattedLangIdentResponse, + estypes.IngestSimulateResponse +>; -export class LangIdentInference extends InferenceBase { - public async infer(inputText: string) { - const payload: estypes.IngestSimulateRequest['body'] = { - pipeline: { - processors: [ - { - inference: { - model_id: this.model.model_id, - inference_config: { - // @ts-expect-error classification missing from type - classification: { - num_top_classes: 3, +export class LangIdentInference extends InferenceBase { + public async infer() { + try { + this.setRunning(); + const inputText = this.inputText$.value; + const payload: estypes.IngestSimulateRequest['body'] = { + pipeline: { + processors: [ + { + inference: { + model_id: this.model.model_id, + inference_config: { + // @ts-expect-error classification missing from type + classification: { + num_top_classes: 3, + }, }, + field_mappings: { + contents: this.inputField, + }, + target_field: '_ml.lang_ident', }, - field_mappings: { - contents: this.inputField, - }, - target_field: '_ml.lang_ident', + }, + ], + }, + docs: [ + { + _source: { + contents: inputText, }, }, ], - }, - docs: [ - { - _source: { - contents: inputText, - }, - }, - ], - }; - const resp = await this.trainedModelsApi.ingestPipelineSimulate(payload); - if (resp.docs.length) { - const topClasses = resp.docs[0].doc?._source._ml?.lang_ident?.top_classes ?? []; - - return { - response: topClasses.map((t: any) => ({ - className: t.class_name, - classProbability: t.class_probability, - classScore: t.class_score, - })), - rawResponse: resp, }; + const resp = await this.trainedModelsApi.ingestPipelineSimulate(payload); + if (resp.docs.length) { + const topClasses = resp.docs[0].doc?._source._ml?.lang_ident?.top_classes ?? []; + + const r: LangIdentResponse = { + response: topClasses.map((t: estypes.MlTopClassEntry) => ({ + className: t.class_name, + classProbability: t.class_probability, + classScore: t.class_score, + })), + rawResponse: resp, + inputText, + }; + this.inferenceResult$.next(r); + this.setFinished(); + return r; + } + const r: LangIdentResponse = { response: [], rawResponse: resp, inputText }; + this.inferenceResult$.next(r); + this.setFinished(); + return r; + } catch (error) { + this.setFinishedWithErrors(error); + throw error; } - return { response: [], rawResponse: resp }; + } + + public getInputComponent(): JSX.Element { + return getGeneralInputComponent(this); + } + + public getOutputComponent(): JSX.Element { + return getLangIdentOutputComponent(this); } } diff --git a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/lang_ident/lang_ident_output.tsx b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/lang_ident/lang_ident_output.tsx index e4968bc516f83..584e367aac784 100644 --- a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/lang_ident/lang_ident_output.tsx +++ b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/lang_ident/lang_ident_output.tsx @@ -6,22 +6,28 @@ */ import React, { FC } from 'react'; +import useObservable from 'react-use/lib/useObservable'; import { i18n } from '@kbn/i18n'; import { EuiSpacer, EuiBasicTable, EuiTitle } from '@elastic/eui'; -import type { FormattedLangIdentResp } from './lang_ident_inference'; +import type { LangIdentInference } from './lang_ident_inference'; import { getLanguage } from './lang_codes'; const PROBABILITY_SIG_FIGS = 3; -export const LangIdentOutput: FC<{ result: FormattedLangIdentResp }> = ({ result }) => { - if (result.length === 0) { +export const getLangIdentOutputComponent = (inferrer: LangIdentInference) => ( + +); + +const LangIdentOutput: FC<{ inferrer: LangIdentInference }> = ({ inferrer }) => { + const result = useObservable(inferrer.inferenceResult$); + if (!result || result.response.length === 0) { return null; } - const lang = getLanguage(result[0].className); + const lang = getLanguage(result.response[0].className); - const items = result.map(({ className, classProbability }, i) => { + const items = result.response.map(({ className, classProbability }, i) => { return { noa: `${i + 1}`, className: getLanguage(className), @@ -70,7 +76,7 @@ export const LangIdentOutput: FC<{ result: FormattedLangIdentResp }> = ({ result }) : i18n.translate('xpack.ml.trainedModels.testModelsFlyout.langIdent.output.titleUnknown', { defaultMessage: 'Language code unknown: {code}', - values: { code: result[0].className }, + values: { code: result.response[0].className }, }); return ( diff --git a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/ner/index.ts b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/ner/index.ts index 38ddad8bdeb80..5e5a029997965 100644 --- a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/ner/index.ts +++ b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/ner/index.ts @@ -5,6 +5,6 @@ * 2.0. */ -export type { FormattedNerResp } from './ner_inference'; +export type { FormattedNerResponse, NerResponse } from './ner_inference'; export { NerInference } from './ner_inference'; -export { NerOutput } from './ner_output'; +export { getNerOutputComponent } from './ner_output'; diff --git a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/ner/ner_inference.ts b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/ner/ner_inference.ts index e4dcfcc2c6333..4125dcd02c6db 100644 --- a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/ner/ner_inference.ts +++ b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/ner/ner_inference.ts @@ -7,28 +7,56 @@ import * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; -import { InferenceBase } from '../inference_base'; +import { InferenceBase, InferResponse } from '../inference_base'; +import { getGeneralInputComponent } from '../text_input'; +import { getNerOutputComponent } from './ner_output'; -export type FormattedNerResp = Array<{ +export type FormattedNerResponse = Array<{ value: string; entity: estypes.MlTrainedModelEntities | null; }>; -interface InferResponse { - response: FormattedNerResp; - rawResponse: estypes.MlInferTrainedModelDeploymentResponse; -} +export type NerResponse = InferResponse< + FormattedNerResponse, + estypes.MlInferTrainedModelDeploymentResponse +>; + +export class NerInference extends InferenceBase { + public async infer() { + try { + this.setRunning(); + const inputText = this.inputText$.value; + const payload = { docs: { [this.inputField]: inputText } }; + const resp = await this.trainedModelsApi.inferTrainedModel( + this.model.model_id, + payload, + '30s' + ); + + const processedResponse: NerResponse = { + response: parseResponse(resp), + rawResponse: resp, + inputText, + }; + this.inferenceResult$.next(processedResponse); + this.setFinished(); + return processedResponse; + } catch (error) { + this.setFinishedWithErrors(error); + throw error; + } + } -export class NerInference extends InferenceBase { - public async infer(inputText: string) { - const payload = { docs: { [this.inputField]: inputText } }; - const resp = await this.trainedModelsApi.inferTrainedModel(this.model.model_id, payload, '30s'); + public getInputComponent(): JSX.Element { + return getGeneralInputComponent(this); + } - return { response: parseResponse(resp), rawResponse: resp }; + public getOutputComponent(): JSX.Element { + return getNerOutputComponent(this); } } -function parseResponse(resp: estypes.MlInferTrainedModelDeploymentResponse): FormattedNerResp { +function parseResponse(resp: estypes.MlInferTrainedModelDeploymentResponse): FormattedNerResponse { const { predicted_value: predictedValue, entities } = resp; const splitWordsAndEntitiesRegex = /(\[.*?\]\(.*?&.*?\))/; const matchEntityRegex = /(\[.*?\])\((.*?)&(.*?)\)/; diff --git a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/ner/ner_output.tsx b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/ner/ner_output.tsx index e9db3fa8efd36..76c154e1000b1 100644 --- a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/ner/ner_output.tsx +++ b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/ner/ner_output.tsx @@ -7,6 +7,7 @@ import * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import React, { FC, ReactNode } from 'react'; +import useObservable from 'react-use/lib/useObservable'; import { FormattedMessage } from '@kbn/i18n-react'; import { EuiHorizontalRule, @@ -21,7 +22,7 @@ import { useCurrentEuiTheme, EuiThemeType, } from '../../../../../components/color_range_legend/use_color_range'; -import type { FormattedNerResp } from './ner_inference'; +import type { NerInference } from './ner_inference'; const ICON_PADDING = '2px'; const PROBABILITY_SIG_FIGS = 3; @@ -60,10 +61,18 @@ const UNKNOWN_ENTITY_TYPE = { borderColor: 'euiColorVis5', }; -export const NerOutput: FC<{ result: FormattedNerResp }> = ({ result }) => { +export const getNerOutputComponent = (inferrer: NerInference) => ; + +const NerOutput: FC<{ inferrer: NerInference }> = ({ inferrer }) => { const { euiTheme } = useCurrentEuiTheme(); + const result = useObservable(inferrer.inferenceResult$); + + if (!result) { + return null; + } + const lineSplit: JSX.Element[] = []; - result.forEach(({ value, entity }) => { + result.response.forEach(({ value, entity }) => { if (entity === null) { const lines = value .split(/(\n)/) diff --git a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/raw_output.tsx b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/raw_output.tsx new file mode 100644 index 0000000000000..0031aafa81443 --- /dev/null +++ b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/raw_output.tsx @@ -0,0 +1,50 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { FC } from 'react'; +import { Observable } from 'rxjs'; +import useObservable from 'react-use/lib/useObservable'; +import { MLJobEditor } from '../../../../jobs/jobs_list/components/ml_job_editor'; + +import type { InferrerType } from '.'; +import { NerResponse } from './ner'; +import { TextClassificationResponse } from './text_classification'; +import { TextEmbeddingResponse } from './text_embedding'; +import { LangIdentResponse } from './lang_ident'; +import { RUNNING_STATE } from './inference_base'; + +type InferenceResponse = + | LangIdentResponse + | NerResponse + | TextClassificationResponse + | TextEmbeddingResponse; + +export const RawOutput: FC<{ + inferrer: InferrerType; +}> = ({ inferrer }) => { + const inferenceError = useObservable(inferrer.inferenceError$); + const runningState = useObservable(inferrer.runningState$); + const inferenceResult = useObservable(inferrer.inferenceResult$ as Observable); + + if ( + (runningState === RUNNING_STATE.FINISHED_WITH_ERRORS && !inferenceError) || + (runningState === RUNNING_STATE.FINISHED && !inferenceResult) + ) { + return null; + } + + const rawResponse = + runningState === RUNNING_STATE.FINISHED_WITH_ERRORS + ? JSON.stringify(inferenceError?.body ?? inferenceError, null, 2) + : JSON.stringify(inferenceResult?.rawResponse, null, 2); + + return ( + <> + + + ); +}; diff --git a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_classification/common.ts b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_classification/common.ts new file mode 100644 index 0000000000000..d360711995f98 --- /dev/null +++ b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_classification/common.ts @@ -0,0 +1,84 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ +import * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; +import { InferResponse } from '../inference_base'; + +const PROBABILITY_SIG_FIGS = 3; + +export interface RawTextClassificationResponse { + predicted_value: string; + prediction_probability: number; + top_classes?: Array<{ + class_name: string; + class_probability: number; + class_score: number; + }>; +} + +export type FormattedTextClassificationResponse = Array<{ + value: string; + predictionProbability: number; +}>; + +export type TextClassificationResponse = InferResponse< + FormattedTextClassificationResponse, + RawTextClassificationResponse +>; + +export function processResponse( + resp: RawTextClassificationResponse, + model: estypes.MlTrainedModelConfig, + inputText: string +): TextClassificationResponse { + const labels: string[] = + // @ts-expect-error inference config is wrong + model.inference_config.text_classification?.classification_labels ?? []; + + let formattedResponse = [ + { + value: resp.predicted_value, + predictionProbability: resp.prediction_probability, + }, + ]; + + if (resp.top_classes !== undefined) { + // if num_top_classes has been specified in the model, + // base the returned results on this list + formattedResponse = resp.top_classes.map((topClass) => { + return { + value: topClass.class_name, + predictionProbability: topClass.class_probability, + }; + }); + } else if (labels.length === 2) { + // otherwise, if the config only contains two classification_labels + // we can safely assume the non-top value and return two results + formattedResponse = labels.map((value) => { + const predictionProbability = + resp.predicted_value === value + ? resp.prediction_probability + : 1 - resp.prediction_probability; + + return { + value, + predictionProbability, + }; + }); + } + + return { + response: formattedResponse + .map(({ value, predictionProbability }) => ({ + value, + predictionProbability: Number(predictionProbability.toPrecision(PROBABILITY_SIG_FIGS)), + })) + .sort((a, b) => a.predictionProbability - b.predictionProbability) + .reverse(), + rawResponse: resp, + inputText, + }; +} diff --git a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_classification/fill_mask_inference.ts b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_classification/fill_mask_inference.ts new file mode 100644 index 0000000000000..c8c993785dac2 --- /dev/null +++ b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_classification/fill_mask_inference.ts @@ -0,0 +1,70 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { i18n } from '@kbn/i18n'; +import { InferenceBase } from '../inference_base'; +import type { TextClassificationResponse, RawTextClassificationResponse } from './common'; +import { processResponse } from './common'; +import { getGeneralInputComponent } from '../text_input'; +import { getFillMaskOutputComponent } from './fill_mask_output'; + +const MASK = '[MASK]'; + +export class FillMaskInference extends InferenceBase { + // @ts-expect-error model type is wrong + private numTopClasses = this.model.inference_config?.fill_mask?.num_top_classes || 5; + + public async infer() { + try { + this.setRunning(); + const inputText = this.inputText$.value; + const payload = { + docs: { [this.inputField]: inputText }, + inference_config: { fill_mask: { num_top_classes: this.numTopClasses } }, + }; + const resp = (await this.trainedModelsApi.inferTrainedModel( + this.model.model_id, + payload, + '30s' + )) as unknown as RawTextClassificationResponse; + + const processedResponse = processResponse(resp, this.model, inputText); + this.inferenceResult$.next(processedResponse); + this.setFinished(); + + return processedResponse; + } catch (error) { + this.setFinishedWithErrors(error); + throw error; + } + } + + public predictedValue() { + const result = this.inferenceResult$.value; + if (result === null) { + return ''; + } + return result.response[0]?.value + ? result.inputText.replace(MASK, result.response[0].value) + : result.inputText; + } + + public getInputComponent(): JSX.Element { + const placeholder = i18n.translate( + 'xpack.ml.trainedModels.testModelsFlyout.langIdent.inputText', + { + defaultMessage: 'Mask token: [MASK]. e.g. Paris is the [MASK] of France.', + } + ); + + return getGeneralInputComponent(this, placeholder); + } + + public getOutputComponent(): JSX.Element { + return getFillMaskOutputComponent(this); + } +} diff --git a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_classification/fill_mask_output.tsx b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_classification/fill_mask_output.tsx new file mode 100644 index 0000000000000..dee08392aad09 --- /dev/null +++ b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_classification/fill_mask_output.tsx @@ -0,0 +1,51 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { FC, useMemo } from 'react'; +import useObservable from 'react-use/lib/useObservable'; +import { EuiFlexGroup, EuiFlexItem, EuiSpacer, EuiProgress, EuiTitle } from '@elastic/eui'; + +import type { FillMaskInference } from './fill_mask_inference'; + +export const getFillMaskOutputComponent = (inferrer: FillMaskInference) => ( + +); + +const FillMaskOutput: FC<{ + inferrer: FillMaskInference; +}> = ({ inferrer }) => { + const result = useObservable(inferrer.inferenceResult$); + const title = useMemo(() => inferrer.predictedValue(), []); + + if (!result) { + return null; + } + + return ( + <> + +

{title}

+ + + + + {result.response.map(({ value, predictionProbability }) => ( + <> + + + + <> + {value} + {predictionProbability} + + + + + ))} + + ); +}; diff --git a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_classification/index.ts b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_classification/index.ts new file mode 100644 index 0000000000000..4eeef37519ff2 --- /dev/null +++ b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_classification/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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +export type { TextClassificationResponse, FormattedTextClassificationResponse } from './common'; + +export { TextClassificationInference } from './text_classification_inference'; +export { getTextClassificationOutputComponent } from './text_classification_output'; + +export { ZeroShotClassificationInference } from './zero_shot_classification_inference'; +export { getZeroShotClassificationInput } from './zero_shot_classification_input'; + +export { FillMaskInference } from './fill_mask_inference'; +export { getFillMaskOutputComponent } from './fill_mask_output'; diff --git a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_classification/text_classification_inference.ts b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_classification/text_classification_inference.ts new file mode 100644 index 0000000000000..1bebdc6ac82e4 --- /dev/null +++ b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_classification/text_classification_inference.ts @@ -0,0 +1,54 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { InferenceBase } from '../inference_base'; +import { processResponse } from './common'; +import type { TextClassificationResponse, RawTextClassificationResponse } from './common'; +import { getGeneralInputComponent } from '../text_input'; +import { getTextClassificationOutputComponent } from './text_classification_output'; + +export class TextClassificationInference extends InferenceBase { + // @ts-expect-error model type is wrong + private numTopClasses = this.model.inference_config?.text_classification?.num_top_classes || 5; + + public async infer() { + try { + this.setRunning(); + const inputText = this.inputText$.value; + const payload = { + docs: { [this.inputField]: inputText }, + inference_config: { text_classification: { num_top_classes: this.numTopClasses } }, + }; + const resp = (await this.trainedModelsApi.inferTrainedModel( + this.model.model_id, + payload, + '30s' + )) as unknown as RawTextClassificationResponse; + + const processedResponse: TextClassificationResponse = processResponse( + resp, + this.model, + inputText + ); + this.inferenceResult$.next(processedResponse); + this.setFinished(); + + return processedResponse; + } catch (error) { + this.setFinishedWithErrors(error); + throw error; + } + } + + public getInputComponent(): JSX.Element { + return getGeneralInputComponent(this); + } + + public getOutputComponent(): JSX.Element { + return getTextClassificationOutputComponent(this); + } +} diff --git a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_classification/text_classification_output.tsx b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_classification/text_classification_output.tsx new file mode 100644 index 0000000000000..faeed456d1a21 --- /dev/null +++ b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_classification/text_classification_output.tsx @@ -0,0 +1,42 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { FC } from 'react'; +import useObservable from 'react-use/lib/useObservable'; +import { EuiFlexGroup, EuiFlexItem, EuiSpacer, EuiProgress } from '@elastic/eui'; + +import type { TextClassificationInference, ZeroShotClassificationInference } from '.'; + +export const getTextClassificationOutputComponent = ( + inferrer: TextClassificationInference | ZeroShotClassificationInference +) => ; + +const TextClassificationOutput: FC<{ + inferrer: TextClassificationInference | ZeroShotClassificationInference; +}> = ({ inferrer }) => { + const result = useObservable(inferrer.inferenceResult$); + if (!result) { + return null; + } + return ( + <> + {result.response.map(({ value, predictionProbability }) => ( + <> + + + + <> + {value} + {predictionProbability} + + + + + ))} + + ); +}; diff --git a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_classification/zero_shot_classification_inference.ts b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_classification/zero_shot_classification_inference.ts new file mode 100644 index 0000000000000..b8897c439ece8 --- /dev/null +++ b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_classification/zero_shot_classification_inference.ts @@ -0,0 +1,62 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { BehaviorSubject } from 'rxjs'; +import { InferenceBase } from '../inference_base'; +import { processResponse } from './common'; +import type { TextClassificationResponse, RawTextClassificationResponse } from './common'; + +import { getZeroShotClassificationInput } from './zero_shot_classification_input'; +import { getTextClassificationOutputComponent } from './text_classification_output'; + +export class ZeroShotClassificationInference extends InferenceBase { + public labelsText$ = new BehaviorSubject(''); + + public async infer() { + try { + this.setRunning(); + const inputText = this.inputText$.value; + const labelsText = this.labelsText$.value; + const inputLabels = labelsText?.split(',').map((l) => l.trim()); + const payload = { + docs: { [this.inputField]: inputText }, + inference_config: { + zero_shot_classification: { + labels: inputLabels, + multi_label: false, + }, + }, + }; + const resp = (await this.trainedModelsApi.inferTrainedModel( + this.model.model_id, + payload, + '30s' + )) as unknown as RawTextClassificationResponse; + + const processedResponse: TextClassificationResponse = processResponse( + resp, + this.model, + inputText + ); + this.inferenceResult$.next(processedResponse); + this.setFinished(); + + return processedResponse; + } catch (error) { + this.setFinishedWithErrors(error); + throw error; + } + } + + public getInputComponent(): JSX.Element { + return getZeroShotClassificationInput(this); + } + + public getOutputComponent(): JSX.Element { + return getTextClassificationOutputComponent(this); + } +} diff --git a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_classification/zero_shot_classification_input.tsx b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_classification/zero_shot_classification_input.tsx new file mode 100644 index 0000000000000..60f06bb8baf79 --- /dev/null +++ b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_classification/zero_shot_classification_input.tsx @@ -0,0 +1,59 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { FC, useEffect, useState } from 'react'; +import useObservable from 'react-use/lib/useObservable'; +import { i18n } from '@kbn/i18n'; + +import { EuiSpacer, EuiFieldText, EuiFormRow } from '@elastic/eui'; + +import { TextInput } from '../text_input'; +import { ZeroShotClassificationInference } from './zero_shot_classification_inference'; +import { RUNNING_STATE } from '../inference_base'; + +const ClassNameInput: FC<{ + inferrer: ZeroShotClassificationInference; +}> = ({ inferrer }) => { + const [labelsText, setLabelsText] = useState(''); + + useEffect(() => { + inferrer.labelsText$.next(labelsText); + }, [labelsText]); + + const runningState = useObservable(inferrer.runningState$); + return ( + + { + setLabelsText(e.target.value); + }} + /> + + ); +}; + +export const getZeroShotClassificationInput = ( + inferrer: ZeroShotClassificationInference, + placeholder?: string +) => ( + <> + + + + +); diff --git a/x-pack/plugins/osquery/public/live_queries/form/schema.ts b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_embedding/index.ts similarity index 50% rename from x-pack/plugins/osquery/public/live_queries/form/schema.ts rename to x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_embedding/index.ts index 3d0195a112fec..cafa529c5e301 100644 --- a/x-pack/plugins/osquery/public/live_queries/form/schema.ts +++ b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_embedding/index.ts @@ -5,14 +5,10 @@ * 2.0. */ -import { FIELD_TYPES, FormSchema } from '../../shared_imports'; +export type { + TextEmbeddingResponse, + FormattedTextEmbeddingResponse, +} from './text_embedding_inference'; -export const formSchema: FormSchema = { - agents: { - type: FIELD_TYPES.MULTI_SELECT, - }, - query: { - type: FIELD_TYPES.TEXTAREA, - validations: [], - }, -}; +export { TextEmbeddingInference } from './text_embedding_inference'; +export { getTextEmbeddingOutputComponent } from './text_embedding_output'; diff --git a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_embedding/text_embedding_inference.ts b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_embedding/text_embedding_inference.ts new file mode 100644 index 0000000000000..ffddc81938f19 --- /dev/null +++ b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_embedding/text_embedding_inference.ts @@ -0,0 +1,68 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; + +import { InferenceBase, InferResponse } from '../inference_base'; +import { getGeneralInputComponent } from '../text_input'; +import { getTextEmbeddingOutputComponent } from './text_embedding_output'; + +export interface RawTextEmbeddingResponse { + predicted_value: number[]; +} + +export interface FormattedTextEmbeddingResponse { + predictedValue: number[]; +} + +export type TextEmbeddingResponse = InferResponse< + FormattedTextEmbeddingResponse, + RawTextEmbeddingResponse +>; + +export class TextEmbeddingInference extends InferenceBase { + public async infer() { + try { + this.setRunning(); + const inputText = this.inputText$.value; + const payload = { + docs: { [this.inputField]: inputText }, + }; + const resp = (await this.trainedModelsApi.inferTrainedModel( + this.model.model_id, + payload, + '30s' + )) as unknown as RawTextEmbeddingResponse; + + const processedResponse: TextEmbeddingResponse = processResponse(resp, this.model, inputText); + this.inferenceResult$.next(processedResponse); + this.setFinished(); + + return processedResponse; + } catch (error) { + this.setFinishedWithErrors(error); + throw error; + } + } + + public getInputComponent(): JSX.Element { + return getGeneralInputComponent(this); + } + + public getOutputComponent(): JSX.Element { + return getTextEmbeddingOutputComponent(this); + } +} + +function processResponse( + resp: RawTextEmbeddingResponse, + model: estypes.MlTrainedModelConfig, + inputText: string +) { + const predictedValue = resp.predicted_value; + return { response: { predictedValue }, rawResponse: resp, inputText }; +} diff --git a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_embedding/text_embedding_output.tsx b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_embedding/text_embedding_output.tsx new file mode 100644 index 0000000000000..bb60140d39e68 --- /dev/null +++ b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_embedding/text_embedding_output.tsx @@ -0,0 +1,43 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { FC } from 'react'; +import useObservable from 'react-use/lib/useObservable'; +import { FormattedMessage } from '@kbn/i18n-react'; +import { EuiTextArea, EuiCopy, EuiButton } from '@elastic/eui'; + +import type { TextEmbeddingInference } from './text_embedding_inference'; + +export const getTextEmbeddingOutputComponent = (inferrer: TextEmbeddingInference) => ( + +); + +const TextEmbeddingOutput: FC<{ + inferrer: TextEmbeddingInference; +}> = ({ inferrer }) => { + const result = useObservable(inferrer.inferenceResult$); + if (!result) { + return null; + } + + const value = result.response.predictedValue.toString(); + return ( + <> + + + {(copy) => ( + + + + )} + + + ); +}; diff --git a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_input.tsx b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_input.tsx new file mode 100644 index 0000000000000..a154bf97ef56b --- /dev/null +++ b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/text_input.tsx @@ -0,0 +1,47 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { FC, useState, useEffect } from 'react'; +import { i18n } from '@kbn/i18n'; +import useObservable from 'react-use/lib/useObservable'; +import { EuiTextArea } from '@elastic/eui'; +import { RUNNING_STATE } from './inference_base'; +import type { InferrerType } from '.'; + +export const TextInput: FC<{ + placeholder?: string; + inferrer: InferrerType; +}> = ({ placeholder, inferrer }) => { + const [inputText, setInputText] = useState(''); + + useEffect(() => { + inferrer.inputText$.next(inputText); + }, [inputText]); + + const runningState = useObservable(inferrer.runningState$); + + return ( + { + setInputText(e.target.value); + }} + /> + ); +}; + +export const getGeneralInputComponent = (inferrer: InferrerType, placeholder?: string) => ( + +); diff --git a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/selected_model.tsx b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/selected_model.tsx index 29dbb855b0084..50a5f9615d126 100644 --- a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/selected_model.tsx +++ b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/selected_model.tsx @@ -8,10 +8,17 @@ import * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import React, { FC } from 'react'; -import { NerOutput, NerInference } from './models/ner'; -import type { FormattedNerResp } from './models/ner'; -import { LangIdentOutput, LangIdentInference } from './models/lang_ident'; -import type { FormattedLangIdentResp } from './models/lang_ident'; +import { NerInference } from './models/ner'; + +import { LangIdentInference } from './models/lang_ident'; + +import { + TextClassificationInference, + FillMaskInference, + ZeroShotClassificationInference, +} from './models/text_classification'; + +import { TextEmbeddingInference } from './models/text_embedding'; import { TRAINED_MODEL_TYPE, @@ -31,26 +38,37 @@ export const SelectedModel: FC = ({ model }) => { return null; } - if ( - model.model_type === TRAINED_MODEL_TYPE.PYTORCH && - Object.keys(model.inference_config)[0] === SUPPORTED_PYTORCH_TASKS.NER - ) { - const inferrer = new NerInference(trainedModels, model); - return ( - } - /> - ); + if (model.model_type === TRAINED_MODEL_TYPE.PYTORCH) { + if (Object.keys(model.inference_config)[0] === SUPPORTED_PYTORCH_TASKS.NER) { + const inferrer = new NerInference(trainedModels, model); + return ; + } + + if (Object.keys(model.inference_config)[0] === SUPPORTED_PYTORCH_TASKS.TEXT_CLASSIFICATION) { + const inferrer = new TextClassificationInference(trainedModels, model); + return ; + } + + if ( + Object.keys(model.inference_config)[0] === SUPPORTED_PYTORCH_TASKS.ZERO_SHOT_CLASSIFICATION + ) { + const inferrer = new ZeroShotClassificationInference(trainedModels, model); + return ; + } + + if (Object.keys(model.inference_config)[0] === SUPPORTED_PYTORCH_TASKS.TEXT_EMBEDDING) { + const inferrer = new TextEmbeddingInference(trainedModels, model); + return ; + } + + if (Object.keys(model.inference_config)[0] === SUPPORTED_PYTORCH_TASKS.FILL_MASK) { + const inferrer = new FillMaskInference(trainedModels, model); + return ; + } } if (model.model_type === TRAINED_MODEL_TYPE.LANG_IDENT) { const inferrer = new LangIdentInference(trainedModels, model); - return ( - } - /> - ); + return ; } return null; diff --git a/x-pack/plugins/ml/server/routes/schemas/inference_schema.ts b/x-pack/plugins/ml/server/routes/schemas/inference_schema.ts index 1b9a865dcfca9..ea18930cdec36 100644 --- a/x-pack/plugins/ml/server/routes/schemas/inference_schema.ts +++ b/x-pack/plugins/ml/server/routes/schemas/inference_schema.ts @@ -45,4 +45,5 @@ export const pipelineSchema = schema.object({ export const inferTrainedModelQuery = schema.object({ timeout: schema.maybe(schema.string()) }); export const inferTrainedModelBody = schema.object({ docs: schema.any(), + inference_config: schema.maybe(schema.any()), }); diff --git a/x-pack/plugins/ml/server/routes/trained_models.ts b/x-pack/plugins/ml/server/routes/trained_models.ts index 27a062b45767c..731d159032d45 100644 --- a/x-pack/plugins/ml/server/routes/trained_models.ts +++ b/x-pack/plugins/ml/server/routes/trained_models.ts @@ -381,7 +381,12 @@ export function trainedModelsRoutes({ router, routeGuard }: RouteInitialization) const { modelId } = request.params; const body = await mlClient.inferTrainedModelDeployment({ model_id: modelId, - docs: request.body.docs, + body: { + docs: request.body.docs, + ...(request.body.inference_config + ? { inference_config: request.body.inference_config } + : {}), + }, ...(request.query.timeout ? { timeout: request.query.timeout } : {}), }); return response.ok({ diff --git a/x-pack/plugins/monitoring/common/types/es.ts b/x-pack/plugins/monitoring/common/types/es.ts index fc19ef0e9aab9..f4c4b385d625d 100644 --- a/x-pack/plugins/monitoring/common/types/es.ts +++ b/x-pack/plugins/monitoring/common/types/es.ts @@ -412,6 +412,7 @@ export interface ElasticsearchIndexRecoveryShard { export interface ElasticsearchMetricbeatNode { name?: string; stats?: ElasticsearchNodeStats; + master: boolean; } export interface ElasticsearchMetricbeatSource { diff --git a/x-pack/plugins/monitoring/server/alerts/base_rule.ts b/x-pack/plugins/monitoring/server/alerts/base_rule.ts index 9c9d993e0a340..1888265c124f6 100644 --- a/x-pack/plugins/monitoring/server/alerts/base_rule.ts +++ b/x-pack/plugins/monitoring/server/alerts/base_rule.ts @@ -344,6 +344,7 @@ export class BaseRule { if (ccs) { globalState.push(`ccs:${ccs}`); } - return `${Globals.app.url}/app/monitoring#/${link}?_g=(${globalState.toString()})`; + + return `${Globals.app.url ?? ''}/app/monitoring#/${link}?_g=(${globalState.toString()})`; } } diff --git a/x-pack/plugins/monitoring/server/lib/elasticsearch/nodes/get_node_type_class_label.ts b/x-pack/plugins/monitoring/server/lib/elasticsearch/nodes/get_node_type_class_label.ts index c0a4f4ff2a48c..057e4ec7efee0 100644 --- a/x-pack/plugins/monitoring/server/lib/elasticsearch/nodes/get_node_type_class_label.ts +++ b/x-pack/plugins/monitoring/server/lib/elasticsearch/nodes/get_node_type_class_label.ts @@ -21,7 +21,13 @@ export function getNodeTypeClassLabel( node: ElasticsearchLegacySource['source_node'] | ElasticsearchMetricbeatNode, type: keyof typeof nodeTypeLabel ) { - const nodeType = node && 'master' in node ? 'master' : type; + let nodeType = null; + if (isElasticsearchMetricbeatNode(node)) { + nodeType = node.master ? 'master' : type; + } else { + nodeType = type; + } + const returnObj = { nodeType, nodeTypeLabel: nodeTypeLabel[nodeType], @@ -29,3 +35,13 @@ export function getNodeTypeClassLabel( }; return returnObj; } + +function isElasticsearchMetricbeatNode( + node: ElasticsearchLegacySource['source_node'] | ElasticsearchMetricbeatNode +): node is ElasticsearchMetricbeatNode { + if (!node) { + return false; + } + + return 'master' in node; +} diff --git a/x-pack/plugins/monitoring/server/static_globals.ts b/x-pack/plugins/monitoring/server/static_globals.ts index e601dd0c55155..429ec8693a3e7 100644 --- a/x-pack/plugins/monitoring/server/static_globals.ts +++ b/x-pack/plugins/monitoring/server/static_globals.ts @@ -6,7 +6,6 @@ */ import { CoreSetup, ElasticsearchClient, Logger, PluginInitializerContext } from '@kbn/core/server'; -import url from 'url'; import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import { MonitoringConfig } from './config'; import { PluginsSetup } from './types'; @@ -32,7 +31,7 @@ export type EndpointTypes = export type ClientParams = estypes.SearchRequest | undefined; interface IAppGlobals { - url: string; + url?: string; isCloud: boolean; config: MonitoringConfig; getLogger: GetLogger; @@ -79,11 +78,8 @@ export class Globals { return body; }); - const { protocol, hostname, port } = coreSetup.http.getServerInfo(); - const pathname = coreSetup.http.basePath.serverBasePath; - Globals._app = { - url: url.format({ protocol, hostname, port, pathname }), + url: coreSetup.http.basePath.publicBaseUrl, isCloud: setupPlugins.cloud?.isCloudEnabled || false, config, getLogger, diff --git a/x-pack/plugins/observability/public/application/application.test.tsx b/x-pack/plugins/observability/public/application/application.test.tsx index a3160d713d1b7..a03f007c2d751 100644 --- a/x-pack/plugins/observability/public/application/application.test.tsx +++ b/x-pack/plugins/observability/public/application/application.test.tsx @@ -63,7 +63,6 @@ describe('renderApp', () => { unsafe: { alertingExperience: { enabled: true }, cases: { enabled: true }, - overviewNext: { enabled: false }, rules: { enabled: true }, }, }; diff --git a/x-pack/plugins/observability/public/components/app/section/alerts/index.tsx b/x-pack/plugins/observability/public/components/app/section/alerts/index.tsx deleted file mode 100644 index 9c65df16d9060..0000000000000 --- a/x-pack/plugins/observability/public/components/app/section/alerts/index.tsx +++ /dev/null @@ -1,195 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import { - EuiBadge, - EuiFlexGroup, - EuiFlexItem, - EuiLink, - EuiText, - EuiSpacer, - EuiTitle, - EuiButtonEmpty, - EuiLoadingSpinner, - EuiCallOut, - EuiPanel, -} from '@elastic/eui'; -import { i18n } from '@kbn/i18n'; -import { FormattedMessage } from '@kbn/i18n-react'; -import moment from 'moment'; -import React, { useState, useMemo } from 'react'; -import { EuiSelect } from '@elastic/eui'; -import { uniqBy } from 'lodash'; -import { useKibana } from '@kbn/kibana-react-plugin/public'; -import { usePluginContext } from '../../../../hooks/use_plugin_context'; -import { FETCH_STATUS, useFetcher } from '../../../../hooks/use_fetcher'; -import { getObservabilityAlerts } from '../../../../services/get_observability_alerts'; -import { paths } from '../../../../config'; -import { ObservabilityAppServices } from '../../../../application/types'; - -const ALL_TYPES = 'ALL_TYPES'; -const allTypes = { - value: ALL_TYPES, - text: i18n.translate('xpack.observability.overview.alert.allTypes', { - defaultMessage: 'All types', - }), -}; - -export function AlertsSection() { - const { config } = usePluginContext(); - const { http } = useKibana().services; - const [filter, setFilter] = useState(ALL_TYPES); - const manageLink = config.unsafe.alertingExperience.enabled - ? http.basePath.prepend(paths.observability.alerts) - : http.basePath.prepend(paths.management.rules); - - const { data, status } = useFetcher(() => getObservabilityAlerts({ http }), [http]); - - const alerts = useMemo(() => data ?? [], [data]); - - const filterOptions = useMemo(() => { - if (!alerts) { - return []; - } - return uniqBy(alerts, (alert) => alert.consumer).map(({ consumer }) => ({ - value: consumer, - text: consumer, - })); - }, [alerts]); - - const isError = status === FETCH_STATUS.FAILURE; - const isLoading = status !== FETCH_STATUS.SUCCESS && !isError; - - if (isLoading) { - return ( - - - - - - ); - } - - if (isError) { - return ( - - - -

- -

- - - - ); - } - - return ( -
- - - -

- {i18n.translate('xpack.observability.overview.alerts.title', { - defaultMessage: 'Alerts', - })} -

- - - - - {i18n.translate('xpack.observability.overview.alert.appLink', { - defaultMessage: 'Show all alerts', - })} - - - - <> - - - setFilter(e.target.value)} - prepend="Show" - /> - - - {alerts - .filter((alert) => filter === ALL_TYPES || alert.consumer === filter) - .map((alert, index) => { - return ( - - - - - - - {alert.name} - - - - - - {alert.alertTypeId} - - {alert.tags.map((tag, idx) => { - return ( - - {tag} - - ); - })} - - - - - {alert.muteAll && ( - - - {i18n.translate('xpack.observability.overview.alerts.muted', { - defaultMessage: 'Muted', - })} - - - )} - - - Last updated{' '} - {moment.duration(moment().diff(alert.updatedAt)).humanize()} ago - - - - - - - - - ); - })} - -
- ); -} diff --git a/x-pack/plugins/observability/public/components/app/section/apm/index.test.tsx b/x-pack/plugins/observability/public/components/app/section/apm/index.test.tsx index a8f49f7d9cbb4..179e8ef70deb1 100644 --- a/x-pack/plugins/observability/public/components/app/section/apm/index.test.tsx +++ b/x-pack/plugins/observability/public/components/app/section/apm/index.test.tsx @@ -48,7 +48,6 @@ describe('APMSection', () => { unsafe: { alertingExperience: { enabled: true }, cases: { enabled: true }, - overviewNext: { enabled: false }, rules: { enabled: true }, }, }, diff --git a/x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts b/x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts index 072f6e42d1cd8..ad06e5b628eea 100644 --- a/x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts +++ b/x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts @@ -13,7 +13,7 @@ import type { FieldBasedIndexPatternColumn, SeriesType, OperationType, - YConfig, + ExtendedYConfig, } from '@kbn/lens-plugin/public'; import type { PersistableFilter } from '@kbn/lens-plugin/common'; @@ -71,7 +71,7 @@ export interface SeriesConfig { hasOperationType: boolean; palette?: PaletteOutput; yTitle?: string; - yConfig?: YConfig[]; + yConfig?: ExtendedYConfig[]; query?: { query: string; language: 'kuery' }; } diff --git a/x-pack/plugins/observability/public/config/register_alerts_table_configuration.tsx b/x-pack/plugins/observability/public/config/register_alerts_table_configuration.tsx new file mode 100644 index 0000000000000..1999fe82e3a6d --- /dev/null +++ b/x-pack/plugins/observability/public/config/register_alerts_table_configuration.tsx @@ -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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { AlertsTableConfigurationRegistryContract } from '@kbn/triggers-actions-ui-plugin/public'; + +import { observabilityFeatureId } from '../../common'; +import { columns as alertO11yColumns } from '../pages/alerts/containers/alerts_table_t_grid/alerts_table_t_grid'; + +const registerAlertsTableConfiguration = (registry: AlertsTableConfigurationRegistryContract) => { + if (registry.has(observabilityFeatureId)) { + return; + } + registry.register({ + id: observabilityFeatureId, + columns: alertO11yColumns, + }); +}; + +export { registerAlertsTableConfiguration }; diff --git a/x-pack/plugins/observability/public/index.ts b/x-pack/plugins/observability/public/index.ts index cfabbaaec4afa..19468ef0e2736 100644 --- a/x-pack/plugins/observability/public/index.ts +++ b/x-pack/plugins/observability/public/index.ts @@ -36,7 +36,6 @@ export interface ConfigSchema { alertingExperience: { enabled: boolean }; rules: { enabled: boolean }; cases: { enabled: boolean }; - overviewNext: { enabled: boolean }; }; } diff --git a/x-pack/plugins/observability/public/observability_public_plugins_start.mock.ts b/x-pack/plugins/observability/public/observability_public_plugins_start.mock.ts index 7e5ad089cd50f..930b75f578eb1 100644 --- a/x-pack/plugins/observability/public/observability_public_plugins_start.mock.ts +++ b/x-pack/plugins/observability/public/observability_public_plugins_start.mock.ts @@ -36,6 +36,7 @@ const triggersActionsUiStartMock = { createStart() { return { getAddAlertFlyout: jest.fn(), + getRuleStatusDropdown: jest.fn(), getRuleTagBadge: jest.fn(), ruleTypeRegistry: { has: jest.fn(), diff --git a/x-pack/plugins/observability/public/pages/alerts/containers/alerts_page/alerts_page.tsx b/x-pack/plugins/observability/public/pages/alerts/containers/alerts_page/alerts_page.tsx index 10315af5874a5..e99a3195d0f30 100644 --- a/x-pack/plugins/observability/public/pages/alerts/containers/alerts_page/alerts_page.tsx +++ b/x-pack/plugins/observability/public/pages/alerts/containers/alerts_page/alerts_page.tsx @@ -39,6 +39,7 @@ import { import './styles.scss'; import { AlertsStatusFilter, AlertsDisclaimer, AlertsSearchBar } from '../../components'; import { ObservabilityAppServices } from '../../../../application/types'; +import { OBSERVABILITY_RULE_TYPES } from '../../../rules/config'; interface RuleStatsState { total: number; @@ -115,6 +116,7 @@ function AlertsPage() { try { const response = await loadRuleAggregations({ http, + typesFilter: OBSERVABILITY_RULE_TYPES, }); const { ruleExecutionStatus, ruleMutedStatus, ruleEnabledStatus, ruleSnoozedStatus } = response; diff --git a/x-pack/plugins/observability/public/pages/cases/empty_page.tsx b/x-pack/plugins/observability/public/pages/cases/empty_page.tsx index faeafa6b4730f..5f8be8483c9d3 100644 --- a/x-pack/plugins/observability/public/pages/cases/empty_page.tsx +++ b/x-pack/plugins/observability/public/pages/cases/empty_page.tsx @@ -103,7 +103,7 @@ const EmptyPageComponent = React.memo(({ actions, message, title return ( {title}} body={message &&

{message}

} actions={{renderActions}} diff --git a/x-pack/plugins/observability/public/pages/overview/index.test.tsx b/x-pack/plugins/observability/public/pages/overview/index.test.tsx deleted file mode 100644 index 45206e4440205..0000000000000 --- a/x-pack/plugins/observability/public/pages/overview/index.test.tsx +++ /dev/null @@ -1,87 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ -import React from 'react'; -import { shallow } from 'enzyme'; -import * as PluginContext from '../../hooks/use_plugin_context'; -import { PluginContextValue } from '../../context/plugin_context'; -import { OverviewPage } from '.'; -import { OverviewPage as OldOverviewPage } from './old_overview_page'; -import { OverviewPage as NewOverviewPage } from './overview_page'; - -describe('Overview page', () => { - it('should render the old overview page when feature flag is disabled and queryParams are empty', () => { - const pluginContext = { - config: { - unsafe: { - overviewNext: { enabled: false }, - }, - }, - }; - - jest - .spyOn(PluginContext, 'usePluginContext') - .mockReturnValue(pluginContext as PluginContextValue); - - const component = shallow(); - expect(component.find(OldOverviewPage)).toHaveLength(1); - expect(component.find(NewOverviewPage)).toHaveLength(0); - }); - - it('should render the new overview page when feature flag is enabled and queryParams are empty', () => { - const pluginContext = { - config: { - unsafe: { - overviewNext: { enabled: true }, - }, - }, - }; - - jest - .spyOn(PluginContext, 'usePluginContext') - .mockReturnValue(pluginContext as PluginContextValue); - - const component = shallow(); - expect(component.find(OldOverviewPage)).toHaveLength(0); - expect(component.find(NewOverviewPage)).toHaveLength(1); - }); - - it('should render the new overview page when feature flag is enabled and alpha param is in the url', () => { - const pluginContext = { - config: { - unsafe: { - overviewNext: { enabled: true }, - }, - }, - }; - - jest - .spyOn(PluginContext, 'usePluginContext') - .mockReturnValue(pluginContext as PluginContextValue); - - const component = shallow(); - expect(component.find(OldOverviewPage)).toHaveLength(0); - expect(component.find(NewOverviewPage)).toHaveLength(1); - }); - - it('should render the new overview page when feature flag is disabled and alpha param is in the url', () => { - const pluginContext = { - config: { - unsafe: { - overviewNext: { enabled: false }, - }, - }, - }; - - jest - .spyOn(PluginContext, 'usePluginContext') - .mockReturnValue(pluginContext as PluginContextValue); - - const component = shallow(); - expect(component.find(OldOverviewPage)).toHaveLength(0); - expect(component.find(NewOverviewPage)).toHaveLength(1); - }); -}); diff --git a/x-pack/plugins/observability/public/pages/overview/index.tsx b/x-pack/plugins/observability/public/pages/overview/index.tsx index 6b773b303031e..6733c90dd0f7a 100644 --- a/x-pack/plugins/observability/public/pages/overview/index.tsx +++ b/x-pack/plugins/observability/public/pages/overview/index.tsx @@ -4,25 +4,300 @@ * 2.0; you may not use this file except in compliance with the Elastic License * 2.0. */ -import React from 'react'; -import { RouteParams } from '../../routes'; +import { + EuiFlexGroup, + EuiFlexItem, + EuiSpacer, + EuiHorizontalRule, + EuiButton, + EuiFlyout, + EuiFlyoutHeader, + EuiTitle, + EuiFlyoutBody, + EuiText, +} from '@elastic/eui'; +import { i18n } from '@kbn/i18n'; +import { FormattedMessage } from '@kbn/i18n-react'; +import React, { useMemo, useRef, useCallback, useState, useEffect } from 'react'; +import { useKibana } from '@kbn/kibana-react-plugin/public'; +import { Storage } from '@kbn/kibana-utils-plugin/public'; +import { observabilityFeatureId } from '../../../common'; +import { useTrackPageview, useUiTracker } from '../..'; +import { EmptySections } from '../../components/app/empty_sections'; +import { ObservabilityHeaderMenu } from '../../components/app/header'; +import { NewsFeed } from '../../components/app/news_feed'; +import { Resources } from '../../components/app/resources'; +import { DatePicker } from '../../components/shared/date_picker'; +import { useBreadcrumbs } from '../../hooks/use_breadcrumbs'; +import { useFetcher } from '../../hooks/use_fetcher'; +import { useHasData } from '../../hooks/use_has_data'; import { usePluginContext } from '../../hooks/use_plugin_context'; -import { OverviewPage as OldOverviewPage } from './old_overview_page'; -import { OverviewPage as NewOverviewPage } from './overview_page'; +import { useAlertIndexNames } from '../../hooks/use_alert_index_names'; +import { RouteParams } from '../../routes'; +import { getNewsFeed } from '../../services/get_news_feed'; +import { getBucketSize } from '../../utils/get_bucket_size'; +import { getNoDataConfig } from '../../utils/no_data_config'; +import { DataSections } from './data_sections'; +import { LoadingObservability } from './loading_observability'; +import { AlertsTableTGrid } from '../alerts/containers/alerts_table_t_grid/alerts_table_t_grid'; +import { SectionContainer } from '../../components/app/section'; +import { ObservabilityAppServices } from '../../application/types'; +import { useGetUserCasesPermissions } from '../../hooks/use_get_user_cases_permissions'; +import { paths } from '../../config'; +import { useDatePickerContext } from '../../hooks/use_date_picker_context'; +import { ObservabilityStatusProgress } from '../../components/app/observability_status/observability_status_progress'; +import { ObservabilityStatus } from '../../components/app/observability_status'; +import { useGuidedSetupProgress } from '../../hooks/use_guided_setup_progress'; -export type { BucketSize } from './old_overview_page'; +export type BucketSize = ReturnType; interface Props { routeParams: RouteParams<'/overview'>; } -export function OverviewPage(props: Props) { - const { config } = usePluginContext(); - const alpha = props.routeParams.query.alpha; +const CAPABILITIES_KEYS = ['logs', 'infrastructure', 'apm', 'uptime']; - if (config.unsafe.overviewNext.enabled || alpha) { - return ; - } else { - return ; +function calculateBucketSize({ start, end }: { start?: number; end?: number }) { + if (start && end) { + return getBucketSize({ start, end, minInterval: '60s' }); } } + +const ALERT_TABLE_STATE_STORAGE_KEY = 'xpack.observability.overview.alert.tableState'; + +export function OverviewPage({ routeParams }: Props) { + const trackMetric = useUiTracker({ app: 'observability-overview' }); + useTrackPageview({ app: 'observability-overview', path: 'overview' }); + useTrackPageview({ app: 'observability-overview', path: 'overview', delay: 15000 }); + useBreadcrumbs([ + { + text: i18n.translate('xpack.observability.breadcrumbs.overviewLinkText', { + defaultMessage: 'Overview', + }), + }, + ]); + const [isFlyoutVisible, setIsFlyoutVisible] = useState(false); + + const indexNames = useAlertIndexNames(); + const { + cases, + docLinks, + http, + application: { capabilities }, + } = useKibana().services; + + const { ObservabilityPageTemplate, config } = usePluginContext(); + const { relativeStart, relativeEnd, absoluteStart, absoluteEnd } = useDatePickerContext(); + + const { data: newsFeed } = useFetcher(() => getNewsFeed({ http }), [http]); + + const { hasAnyData, isAllRequestsComplete } = useHasData(); + const refetch = useRef<() => void>(); + + const { isGuidedSetupProgressDismissed } = useGuidedSetupProgress(); + + const bucketSize = useMemo( + () => + calculateBucketSize({ + start: absoluteStart, + end: absoluteEnd, + }), + [absoluteStart, absoluteEnd] + ); + + const setRefetch = useCallback((ref) => { + refetch.current = ref; + }, []); + + const handleGuidedSetupClick = useCallback(() => { + if (isGuidedSetupProgressDismissed) { + trackMetric({ metric: 'guided_setup_view_details_after_dismiss' }); + } + + setIsFlyoutVisible(true); + }, [trackMetric, isGuidedSetupProgressDismissed]); + + const onTimeRangeRefresh = useCallback(() => { + return refetch.current && refetch.current(); + }, []); + + const CasesContext = cases.ui.getCasesContext(); + const userPermissions = useGetUserCasesPermissions(); + + useEffect(() => { + if (hasAnyData !== true) { + return; + } + + CAPABILITIES_KEYS.forEach((feature) => { + if (capabilities[feature].show === false) { + trackMetric({ + metric: `oblt_disabled_feature_${feature === 'infrastructure' ? 'metrics' : feature}`, + }); + } + }); + }, [capabilities, hasAnyData, trackMetric]); + + if (hasAnyData === undefined) { + return ; + } + + const hasData = hasAnyData === true || (isAllRequestsComplete === false ? undefined : false); + + const noDataConfig = getNoDataConfig({ + hasData, + basePath: http.basePath, + docsLink: docLinks.links.observability.guide, + }); + + const alertsLink = config.unsafe.alertingExperience.enabled + ? paths.observability.alerts + : paths.management.rules; + + return ( + + ), + } + : undefined + } + > + {hasData && ( + <> + + setIsFlyoutVisible(true)} /> + + + + + + + + + + {/* Data sections */} + {hasAnyData && } + + + + + + + + {/* Resources / What's New sections */} + + + {!!newsFeed?.items?.length && } + + + + + + + + + )} + {isFlyoutVisible && ( + setIsFlyoutVisible(false)} + aria-labelledby="statusVisualizationFlyoutTitle" + > + + +

+ +

+ + + +

+ +

+ + + + + + + )} + + ); +} + +interface PageHeaderProps { + handleGuidedSetupClick: () => void; + onTimeRangeRefresh: () => void; +} + +function PageHeader({ handleGuidedSetupClick, onTimeRangeRefresh }: PageHeaderProps) { + const { relativeStart, relativeEnd, refreshInterval, refreshPaused } = useDatePickerContext(); + return ( + + + +

{overviewPageTitle}

+ + + + + + + + + + + + ); +} + +const overviewPageTitle = i18n.translate('xpack.observability.overview.pageTitle', { + defaultMessage: 'Overview', +}); diff --git a/x-pack/plugins/observability/public/pages/overview/old_overview_page.tsx b/x-pack/plugins/observability/public/pages/overview/old_overview_page.tsx deleted file mode 100644 index 0c95362b15dbb..0000000000000 --- a/x-pack/plugins/observability/public/pages/overview/old_overview_page.tsx +++ /dev/null @@ -1,302 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import { - EuiFlexGroup, - EuiFlexItem, - EuiSpacer, - EuiHorizontalRule, - EuiButton, - EuiFlyout, - EuiFlyoutHeader, - EuiTitle, - EuiFlyoutBody, - EuiText, -} from '@elastic/eui'; -import { i18n } from '@kbn/i18n'; -import { FormattedMessage } from '@kbn/i18n-react'; -import React, { useMemo, useRef, useCallback, useState, useEffect } from 'react'; -import { useKibana } from '@kbn/kibana-react-plugin/public'; -import { Storage } from '@kbn/kibana-utils-plugin/public'; -import { observabilityFeatureId } from '../../../common'; -import { useTrackPageview, useUiTracker } from '../..'; -import { EmptySections } from '../../components/app/empty_sections'; -import { ObservabilityHeaderMenu } from '../../components/app/header'; -import { NewsFeed } from '../../components/app/news_feed'; -import { Resources } from '../../components/app/resources'; -import { DatePicker } from '../../components/shared/date_picker'; -import { useBreadcrumbs } from '../../hooks/use_breadcrumbs'; -import { useFetcher } from '../../hooks/use_fetcher'; -import { useHasData } from '../../hooks/use_has_data'; -import { usePluginContext } from '../../hooks/use_plugin_context'; -import { useAlertIndexNames } from '../../hooks/use_alert_index_names'; -import { RouteParams } from '../../routes'; -import { getNewsFeed } from '../../services/get_news_feed'; -import { getBucketSize } from '../../utils/get_bucket_size'; -import { getNoDataConfig } from '../../utils/no_data_config'; -import { DataSections } from './data_sections'; -import { LoadingObservability } from './loading_observability'; -import { AlertsTableTGrid } from '../alerts/containers/alerts_table_t_grid/alerts_table_t_grid'; -import { SectionContainer } from '../../components/app/section'; -import { ObservabilityAppServices } from '../../application/types'; -import { useGetUserCasesPermissions } from '../../hooks/use_get_user_cases_permissions'; -import { paths } from '../../config'; -import { useDatePickerContext } from '../../hooks/use_date_picker_context'; -import { ObservabilityStatusProgress } from '../../components/app/observability_status/observability_status_progress'; -import { ObservabilityStatus } from '../../components/app/observability_status'; -import { useGuidedSetupProgress } from '../../hooks/use_guided_setup_progress'; -interface Props { - routeParams: RouteParams<'/overview'>; -} -export type BucketSize = ReturnType; - -const CAPABILITIES_KEYS = ['logs', 'infrastructure', 'apm', 'uptime']; - -function calculateBucketSize({ start, end }: { start?: number; end?: number }) { - if (start && end) { - return getBucketSize({ start, end, minInterval: '60s' }); - } -} - -const ALERT_TABLE_STATE_STORAGE_KEY = 'xpack.observability.overview.alert.tableState'; - -export function OverviewPage({ routeParams }: Props) { - const trackMetric = useUiTracker({ app: 'observability-overview' }); - useTrackPageview({ app: 'observability-overview', path: 'overview' }); - useTrackPageview({ app: 'observability-overview', path: 'overview', delay: 15000 }); - useBreadcrumbs([ - { - text: i18n.translate('xpack.observability.breadcrumbs.overviewLinkText', { - defaultMessage: 'Overview', - }), - }, - ]); - const [isFlyoutVisible, setIsFlyoutVisible] = useState(false); - - const indexNames = useAlertIndexNames(); - const { - cases, - docLinks, - http, - application: { capabilities }, - } = useKibana().services; - - const { ObservabilityPageTemplate, config } = usePluginContext(); - const { relativeStart, relativeEnd, absoluteStart, absoluteEnd } = useDatePickerContext(); - - const { data: newsFeed } = useFetcher(() => getNewsFeed({ http }), [http]); - - const { hasAnyData, isAllRequestsComplete } = useHasData(); - const refetch = useRef<() => void>(); - - const { isGuidedSetupProgressDismissed } = useGuidedSetupProgress(); - - const bucketSize = useMemo( - () => - calculateBucketSize({ - start: absoluteStart, - end: absoluteEnd, - }), - [absoluteStart, absoluteEnd] - ); - - const setRefetch = useCallback((ref) => { - refetch.current = ref; - }, []); - - const handleGuidedSetupClick = useCallback(() => { - if (isGuidedSetupProgressDismissed) { - trackMetric({ metric: 'guided_setup_view_details_after_dismiss' }); - } - - setIsFlyoutVisible(true); - }, [trackMetric, isGuidedSetupProgressDismissed]); - - const onTimeRangeRefresh = useCallback(() => { - return refetch.current && refetch.current(); - }, []); - - const CasesContext = cases.ui.getCasesContext(); - const userPermissions = useGetUserCasesPermissions(); - - useEffect(() => { - if (hasAnyData !== true) { - return; - } - - CAPABILITIES_KEYS.forEach((feature) => { - if (capabilities[feature].show === false) { - trackMetric({ - metric: `oblt_disabled_feature_${feature === 'infrastructure' ? 'metrics' : feature}`, - }); - } - }); - }, [capabilities, hasAnyData, trackMetric]); - - if (hasAnyData === undefined) { - return ; - } - - const hasData = hasAnyData === true || (isAllRequestsComplete === false ? undefined : false); - - const noDataConfig = getNoDataConfig({ - hasData, - basePath: http.basePath, - docsLink: docLinks.links.observability.guide, - }); - - const alertsLink = config.unsafe.alertingExperience.enabled - ? paths.observability.alerts - : paths.management.rules; - - return ( - - ), - } - : undefined - } - > - {hasData && ( - <> - - setIsFlyoutVisible(true)} /> - - - - - - - - - - {/* Data sections */} - {hasAnyData && } - - - - - - - - {/* Resources / What's New sections */} - - - {!!newsFeed?.items?.length && } - - - - - - - - - )} - {isFlyoutVisible && ( - setIsFlyoutVisible(false)} - aria-labelledby="statusVisualizationFlyoutTitle" - > - - -

- -

- - - -

- -

- - - - - - - )} - - ); -} - -interface PageHeaderProps { - handleGuidedSetupClick: () => void; - onTimeRangeRefresh: () => void; -} - -function PageHeader({ handleGuidedSetupClick, onTimeRangeRefresh }: PageHeaderProps) { - const { relativeStart, relativeEnd, refreshInterval, refreshPaused } = useDatePickerContext(); - return ( - - - -

{overviewPageTitle}

- - - - - - - - - - - - ); -} - -const overviewPageTitle = i18n.translate('xpack.observability.overview.pageTitle', { - defaultMessage: 'Overview', -}); diff --git a/x-pack/plugins/observability/public/pages/overview/overview.stories.tsx b/x-pack/plugins/observability/public/pages/overview/overview.stories.tsx index b975e45ac06df..95d263168f82e 100644 --- a/x-pack/plugins/observability/public/pages/overview/overview.stories.tsx +++ b/x-pack/plugins/observability/public/pages/overview/overview.stories.tsx @@ -85,7 +85,6 @@ const withCore = makeDecorator({ unsafe: { alertingExperience: { enabled: true }, cases: { enabled: true }, - overviewNext: { enabled: false }, rules: { enabled: true }, }, }, diff --git a/x-pack/plugins/observability/public/pages/overview/overview_page.tsx b/x-pack/plugins/observability/public/pages/overview/overview_page.tsx deleted file mode 100644 index 7f81f71cf6683..0000000000000 --- a/x-pack/plugins/observability/public/pages/overview/overview_page.tsx +++ /dev/null @@ -1,110 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ -import { i18n } from '@kbn/i18n'; -import React, { useState } from 'react'; -import { EuiButton, EuiFlyout, EuiFlyoutBody, EuiFlyoutHeader, EuiTitle } from '@elastic/eui'; -import { useKibana } from '@kbn/kibana-react-plugin/public'; -import { useTrackPageview } from '../..'; -import { DatePicker } from '../../components/shared/date_picker'; -import { useBreadcrumbs } from '../../hooks/use_breadcrumbs'; -import { useHasData } from '../../hooks/use_has_data'; -import { usePluginContext } from '../../hooks/use_plugin_context'; -import { useDatePickerContext } from '../../hooks/use_date_picker_context'; -import { RouteParams } from '../../routes'; -import { getNoDataConfig } from '../../utils/no_data_config'; -import { LoadingObservability } from './loading_observability'; -import { ObservabilityStatus } from '../../components/app/observability_status'; -import { ObservabilityAppServices } from '../../application/types'; - -interface Props { - routeParams: RouteParams<'/overview'>; -} - -export function OverviewPage({ routeParams }: Props) { - useTrackPageview({ app: 'observability-overview', path: 'overview' }); - useTrackPageview({ app: 'observability-overview', path: 'overview', delay: 15000 }); - useBreadcrumbs([ - { - text: i18n.translate('xpack.observability.breadcrumbs.overviewLinkText', { - defaultMessage: 'Overview', - }), - }, - ]); - - const [isFlyoutVisible, setIsFlyoutVisible] = useState(false); - - const { docLinks, http } = useKibana().services; - const { ObservabilityPageTemplate } = usePluginContext(); - - const { relativeStart, relativeEnd } = useDatePickerContext(); - - const relativeTime = { start: relativeStart, end: relativeEnd }; - - const { hasAnyData, isAllRequestsComplete } = useHasData(); - - if (hasAnyData === undefined) { - return ; - } - - const hasData = hasAnyData === true || (isAllRequestsComplete === false ? undefined : false); - - const noDataConfig = getNoDataConfig({ - hasData, - basePath: http.basePath, - docsLink: docLinks.links.observability.guide, - }); - - const { refreshInterval = 10000, refreshPaused = true } = routeParams.query; - - return ( - , - ], - } - : undefined - } - > - {hasData && ( - <> - setIsFlyoutVisible(true)}>Show observability status - {isFlyoutVisible && ( - setIsFlyoutVisible(false)} - aria-labelledby="flyout-id" - > - - -

Status

- - - - - - - )} - - )} - - ); -} - -const overviewPageTitle = i18n.translate('xpack.observability.overview.pageTitle', { - defaultMessage: 'Overview', -}); diff --git a/x-pack/plugins/observability/public/pages/rules/components/status.tsx b/x-pack/plugins/observability/public/pages/rules/components/status.tsx deleted file mode 100644 index 612d6f8f30bdd..0000000000000 --- a/x-pack/plugins/observability/public/pages/rules/components/status.tsx +++ /dev/null @@ -1,34 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import React, { useMemo } from 'react'; -import { EuiBadge } from '@elastic/eui'; -import { noop } from 'lodash/fp'; -import { StatusProps } from '../types'; -import { statusMap } from '../config'; -import { RULES_CHANGE_STATUS } from '../translations'; - -export function Status({ type, disabled, onClick }: StatusProps) { - const props = useMemo( - () => ({ - color: statusMap[type].color, - ...(!disabled ? { onClick } : { onClick: noop }), - ...(!disabled ? { iconType: 'arrowDown', iconSide: 'right' as const } : {}), - ...(!disabled ? { iconOnClick: onClick } : { iconOnClick: noop }), - }), - [disabled, onClick, type] - ); - return ( - - {statusMap[type].label} - - ); -} diff --git a/x-pack/plugins/observability/public/pages/rules/components/status_context.tsx b/x-pack/plugins/observability/public/pages/rules/components/status_context.tsx deleted file mode 100644 index c7bd29d85b17a..0000000000000 --- a/x-pack/plugins/observability/public/pages/rules/components/status_context.tsx +++ /dev/null @@ -1,103 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import React, { useState, useCallback, useMemo } from 'react'; -import { - EuiPopover, - EuiContextMenuItem, - EuiContextMenuPanel, - EuiLoadingSpinner, -} from '@elastic/eui'; -import { Status } from './status'; -import { RuleStatus, StatusContextProps } from '../types'; -import { statusMap } from '../config'; - -export function StatusContext({ - item, - disabled = false, - onStatusChanged, - enableRule, - disableRule, - muteRule, - unMuteRule, -}: StatusContextProps) { - const [isPopoverOpen, setIsPopoverOpen] = useState(false); - const [isUpdating, setIsUpdating] = useState(false); - const togglePopover = useCallback(() => setIsPopoverOpen(!isPopoverOpen), [isPopoverOpen]); - - let currentStatus: RuleStatus; - if (item.enabled) { - currentStatus = item.muteAll ? RuleStatus.snoozed : RuleStatus.enabled; - } else { - currentStatus = RuleStatus.disabled; - } - const popOverButton = useMemo( - () => , - [disabled, currentStatus, togglePopover] - ); - - const onContextMenuItemClick = useCallback( - async (status: RuleStatus) => { - togglePopover(); - if (currentStatus !== status) { - setIsUpdating(true); - - if (status === RuleStatus.enabled) { - await enableRule({ ...item, enabled: true }); - if (item.muteAll) { - await unMuteRule({ ...item, muteAll: false }); - } - } else if (status === RuleStatus.disabled) { - await disableRule({ ...item, enabled: false }); - } else if (status === RuleStatus.snoozed) { - await muteRule({ ...item, muteAll: true }); - } - setIsUpdating(false); - onStatusChanged(status); - } - }, - [ - item, - togglePopover, - enableRule, - disableRule, - muteRule, - unMuteRule, - currentStatus, - onStatusChanged, - ] - ); - - const panelItems = useMemo( - () => - Object.values(RuleStatus).map((status: RuleStatus) => ( - onContextMenuItemClick(status)} - disabled={status === RuleStatus.snoozed && currentStatus === RuleStatus.disabled} - > - {statusMap[status].label} - - )), - [currentStatus, onContextMenuItemClick] - ); - - return isUpdating ? ( - - ) : ( - setIsPopoverOpen(false)} - anchorPosition="downLeft" - isOpen={isPopoverOpen} - panelPaddingSize="none" - > - - - ); -} diff --git a/x-pack/plugins/observability/public/pages/rules/index.tsx b/x-pack/plugins/observability/public/pages/rules/index.tsx index b33b252cbecc7..693c5dd11f4d1 100644 --- a/x-pack/plugins/observability/public/pages/rules/index.tsx +++ b/x-pack/plugins/observability/public/pages/rules/index.tsx @@ -5,7 +5,7 @@ * 2.0. */ -import React, { useState, useMemo } from 'react'; +import React, { useState, useMemo, useCallback } from 'react'; import { capitalize, sortBy } from 'lodash'; import { EuiButton, @@ -25,12 +25,14 @@ import { RuleTableItem, enableRule, disableRule, - muteRule, + snoozeRule, useLoadRuleTypes, - unmuteRule, + unsnoozeRule, } from '@kbn/triggers-actions-ui-plugin/public'; import { RuleExecutionStatus, ALERTS_FEATURE_ID } from '@kbn/alerting-plugin/common'; import { usePluginContext } from '../../hooks/use_plugin_context'; +import { Provider, rulesPageStateContainer, useRulesPageStateContainer } from './state_container'; + import { useBreadcrumbs } from '../../hooks/use_breadcrumbs'; import { useKibana } from '../../utils/kibana_react'; import { useFetchRules } from '../../hooks/use_fetch_rules'; @@ -38,7 +40,6 @@ import { RulesTable } from './components/rules_table'; import { Name } from './components/name'; import { LastResponseFilter } from './components/last_response_filter'; import { TypeFilter } from './components/type_filter'; -import { StatusContext } from './components/status_context'; import { ExecutionStatus } from './components/execution_status'; import { LastRun } from './components/last_run'; import { EditRuleFlyout } from './components/edit_rule_flyout'; @@ -72,7 +73,7 @@ import { import { ExperimentalBadge } from '../../components/shared/experimental_badge'; const ENTER_KEY = 13; -export function RulesPage() { +function RulesPage() { const { ObservabilityPageTemplate, kibanaFeatures } = usePluginContext(); const { http, @@ -81,6 +82,7 @@ export function RulesPage() { application: { capabilities }, notifications: { toasts }, } = useKibana().services; + const { lastResponse, setLastResponse } = useRulesPageStateContainer(); const documentationLink = docLinks.links.observability.createAlerts; const ruleTypeRegistry = triggersActionsUi.ruleTypeRegistry; const canExecuteActions = hasExecuteActionsCapability(capabilities); @@ -91,7 +93,7 @@ export function RulesPage() { }); const [inputText, setInputText] = useState(); const [searchText, setSearchText] = useState(); - const [ruleLastResponseFilter, setRuleLastResponseFilter] = useState([]); + // const [ruleLastResponseFilter, setRuleLastResponseFilter] = useState([]); const [typesFilter, setTypesFilter] = useState([]); const [currentRuleToEdit, setCurrentRuleToEdit] = useState(null); const [rulesToDelete, setRulesToDelete] = useState([]); @@ -107,7 +109,7 @@ export function RulesPage() { const { rulesState, setRulesState, reload, noData, initialLoad } = useFetchRules({ searchText, - ruleLastResponseFilter, + ruleLastResponseFilter: lastResponse, typesFilter, page, setPage, @@ -211,17 +213,17 @@ export function RulesPage() { name: STATUS_COLUMN_TITLE, sortable: true, render: (_enabled: boolean, item: RuleTableItem) => { - return ( - reload()} - enableRule={async () => await enableRule({ http, id: item.id })} - disableRule={async () => await disableRule({ http, id: item.id })} - muteRule={async () => await muteRule({ http, id: item.id })} - unMuteRule={async () => await unmuteRule({ http, id: item.id })} - /> - ); + return triggersActionsUi.getRuleStatusDropdown({ + rule: item, + enableRule: async () => await enableRule({ http, id: item.id }), + disableRule: async () => await disableRule({ http, id: item.id }), + onRuleChanged: () => reload(), + isEditable: item.isEditable && isRuleTypeEditableInContext(item.ruleTypeId), + snoozeRule: async (snoozeEndTime: string | -1) => { + await snoozeRule({ http, id: item.id, snoozeEndTime }); + }, + unsnoozeRule: async () => await unsnoozeRule({ http, id: item.id }), + }); }, }, { @@ -281,6 +283,13 @@ export function RulesPage() { [] ); + const setExecutionStatusFilter = useCallback( + (ids: string[]) => { + setLastResponse(ids); + }, + [setLastResponse] + ); + const getRulesTable = () => { if (noData && !rulesState.isLoading) { return authorizedToCreateAnyRules ? ( @@ -295,6 +304,10 @@ export function RulesPage() { if (initialLoad) { return ; } + + // const nextSearchParams = new URLSearchParams(history.location.search); + // const xx = [...nextSearchParams.getAll('executionStatus')] || []; + // console.log(xx, '!!'); return ( <> @@ -332,8 +345,8 @@ export function RulesPage() { setRuleLastResponseFilter(ids)} + selectedStatuses={lastResponse} + onChange={setExecutionStatusFilter} /> @@ -458,3 +471,13 @@ export function RulesPage() { ); } + +function WrappedRulesPage() { + return ( + + + + ); +} + +export { WrappedRulesPage as RulesPage }; diff --git a/x-pack/plugins/data_enhanced/public/search/sessions_mgmt/components/table/index.ts b/x-pack/plugins/observability/public/pages/rules/state_container/index.tsx similarity index 62% rename from x-pack/plugins/data_enhanced/public/search/sessions_mgmt/components/table/index.ts rename to x-pack/plugins/observability/public/pages/rules/state_container/index.tsx index 361261ff65c87..7820342482035 100644 --- a/x-pack/plugins/data_enhanced/public/search/sessions_mgmt/components/table/index.ts +++ b/x-pack/plugins/observability/public/pages/rules/state_container/index.tsx @@ -5,4 +5,5 @@ * 2.0. */ -export { SearchSessionsMgmtTable } from './table'; +export { Provider, rulesPageStateContainer } from './state_container'; +export { useRulesPageStateContainer } from './use_rules_page_state_container'; diff --git a/x-pack/plugins/observability/public/pages/rules/state_container/state_container.tsx b/x-pack/plugins/observability/public/pages/rules/state_container/state_container.tsx new file mode 100644 index 0000000000000..b36ffca96972e --- /dev/null +++ b/x-pack/plugins/observability/public/pages/rules/state_container/state_container.tsx @@ -0,0 +1,50 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { + createStateContainer, + createStateContainerReactHelpers, +} from '@kbn/kibana-utils-plugin/public'; + +interface RulesPageContainerState { + lastResponse: string[]; +} + +const defaultState: RulesPageContainerState = { + lastResponse: [], +}; + +interface RulesPageStateTransitions { + setLastResponse: ( + state: RulesPageContainerState + ) => (lastResponse: string[]) => RulesPageContainerState; +} + +const transitions: RulesPageStateTransitions = { + setLastResponse: (state) => (lastResponse) => { + const filteredIds = lastResponse; + lastResponse.forEach((id) => { + const isPreviouslyChecked = state.lastResponse.includes(id); + if (!isPreviouslyChecked) { + filteredIds.concat(id); + } else { + filteredIds.filter((val) => { + return val !== id; + }); + } + }); + return { ...state, lastResponse: filteredIds }; + }, +}; + +const rulesPageStateContainer = createStateContainer(defaultState, transitions); + +type RulesPageStateContainer = typeof rulesPageStateContainer; +const { Provider, useContainer } = createStateContainerReactHelpers(); + +export { Provider, rulesPageStateContainer, useContainer, defaultState }; +export type { RulesPageStateContainer, RulesPageContainerState, RulesPageStateTransitions }; diff --git a/x-pack/plugins/observability/public/pages/rules/state_container/use_rules_page_state_container.tsx b/x-pack/plugins/observability/public/pages/rules/state_container/use_rules_page_state_container.tsx new file mode 100644 index 0000000000000..6b44dc8ae31d5 --- /dev/null +++ b/x-pack/plugins/observability/public/pages/rules/state_container/use_rules_page_state_container.tsx @@ -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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { useEffect } from 'react'; +import { useHistory } from 'react-router-dom'; + +import { + createKbnUrlStateStorage, + syncState, + IKbnUrlStateStorage, + useContainerSelector, +} from '@kbn/kibana-utils-plugin/public'; + +import { + useContainer, + defaultState, + RulesPageStateContainer, + RulesPageContainerState, +} from './state_container'; + +export function useRulesPageStateContainer() { + const stateContainer = useContainer(); + + useUrlStateSyncEffect(stateContainer); + + const { setLastResponse } = stateContainer.transitions; + const { lastResponse } = useContainerSelector(stateContainer, (state) => state); + + return { + lastResponse, + setLastResponse, + }; +} + +function useUrlStateSyncEffect(stateContainer: RulesPageStateContainer) { + const history = useHistory(); + + useEffect(() => { + const urlStateStorage = createKbnUrlStateStorage({ + history, + useHash: false, + useHashQuery: false, + }); + const { start, stop } = setupUrlStateSync(stateContainer, urlStateStorage); + + start(); + + syncUrlStateWithInitialContainerState(stateContainer, urlStateStorage); + + return stop; + }, [stateContainer, history]); +} + +function setupUrlStateSync( + stateContainer: RulesPageStateContainer, + stateStorage: IKbnUrlStateStorage +) { + // This handles filling the state when an incomplete URL set is provided + const setWithDefaults = (changedState: Partial | null) => { + stateContainer.set({ ...defaultState, ...changedState }); + }; + return syncState({ + storageKey: '_a', + stateContainer: { + ...stateContainer, + set: setWithDefaults, + }, + stateStorage, + }); +} + +function syncUrlStateWithInitialContainerState( + stateContainer: RulesPageStateContainer, + urlStateStorage: IKbnUrlStateStorage +) { + const urlState = urlStateStorage.get>('_a'); + + if (urlState) { + const newState = { + ...defaultState, + ...urlState, + }; + + stateContainer.set(newState); + } else { + // Reset the state container when no URL state or timefilter range is set to avoid accidentally + // re-using state set on a previous visit to the page in the same session + stateContainer.set(defaultState); + } + + urlStateStorage.set('_a', stateContainer.get()); +} diff --git a/x-pack/plugins/observability/public/plugin.ts b/x-pack/plugins/observability/public/plugin.ts index a19c5dfa0c3ce..cb8dcaf2dd7e4 100644 --- a/x-pack/plugins/observability/public/plugin.ts +++ b/x-pack/plugins/observability/public/plugin.ts @@ -32,6 +32,7 @@ import { TriggersAndActionsUIPublicPluginStart, } from '@kbn/triggers-actions-ui-plugin/public'; import { KibanaFeature } from '@kbn/features-plugin/common'; + import { ConfigSchema } from '.'; import { observabilityAppId, observabilityFeatureId, casesPath } from '../common'; import { createLazyObservabilityPageTemplate } from './components/shared'; @@ -144,6 +145,12 @@ export class Plugin const { renderApp } = await import('./application'); // Get start services const [coreStart, pluginsStart, { navigation }] = await coreSetup.getStartServices(); + // Register alerts metadata + const { registerAlertsTableConfiguration } = await import( + './config/register_alerts_table_configuration' + ); + const { alertsTableConfigurationRegistry } = pluginsStart.triggersActionsUi; + registerAlertsTableConfiguration(alertsTableConfigurationRegistry); // The `/api/features` endpoint requires the "Global All" Kibana privilege. Users with a // subset of this privilege are not authorized to access this endpoint and will receive a 404 // error that causes the Alerting view to fail to load. @@ -268,7 +275,6 @@ export class Plugin public start(coreStart: CoreStart, pluginsStart: ObservabilityPublicPluginsStart) { const { application } = coreStart; - const config = this.initializerContext.config.get(); updateGlobalNavigation({ diff --git a/x-pack/plugins/observability/public/utils/test_helper.tsx b/x-pack/plugins/observability/public/utils/test_helper.tsx index d5607b5ee8b48..bdbb9dd71164a 100644 --- a/x-pack/plugins/observability/public/utils/test_helper.tsx +++ b/x-pack/plugins/observability/public/utils/test_helper.tsx @@ -26,7 +26,6 @@ const config = { unsafe: { alertingExperience: { enabled: true }, cases: { enabled: true }, - overviewNext: { enabled: false }, rules: { enabled: true }, }, }; diff --git a/x-pack/plugins/observability/server/index.ts b/x-pack/plugins/observability/server/index.ts index 39537a67a8cbf..ab2a566fc6b85 100644 --- a/x-pack/plugins/observability/server/index.ts +++ b/x-pack/plugins/observability/server/index.ts @@ -35,7 +35,6 @@ export const config: PluginConfigDescriptor = { alertingExperience: schema.object({ enabled: schema.boolean({ defaultValue: true }) }), rules: schema.object({ enabled: schema.boolean({ defaultValue: true }) }), cases: schema.object({ enabled: schema.boolean({ defaultValue: true }) }), - overviewNext: schema.object({ enabled: schema.boolean({ defaultValue: false }) }), }), }), }; diff --git a/x-pack/plugins/osquery/common/schemas/common/utils.ts b/x-pack/plugins/osquery/common/schemas/common/utils.ts new file mode 100644 index 0000000000000..95b2bdd7a4050 --- /dev/null +++ b/x-pack/plugins/osquery/common/schemas/common/utils.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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { isEmpty, reduce } from 'lodash'; + +export const convertECSMappingToArray = (ecsMapping: Record | undefined) => + ecsMapping + ? Object.entries(ecsMapping).map((item) => ({ + key: item[0], + value: item[1], + })) + : undefined; + +export const convertECSMappingToObject = ( + ecsMapping: Array<{ + key: string; + result: { + type: string; + value: string; + }; + }> +): Record => + reduce( + ecsMapping, + (acc, value) => { + if (!isEmpty(value?.key) && !isEmpty(value.result?.type) && !isEmpty(value.result?.value)) { + acc[value.key] = { + [value.result.type]: value.result.value, + }; + } + + return acc; + }, + {} as Record + ); diff --git a/x-pack/plugins/osquery/cypress/integration/all/alerts.spec.ts b/x-pack/plugins/osquery/cypress/integration/all/alerts.spec.ts index 7813a94e2bfe3..21d3584b9fc46 100644 --- a/x-pack/plugins/osquery/cypress/integration/all/alerts.spec.ts +++ b/x-pack/plugins/osquery/cypress/integration/all/alerts.spec.ts @@ -37,6 +37,7 @@ describe('Alert Event Details', () => { it('should be able to run live query', () => { const PACK_NAME = 'testpack'; const RULE_NAME = 'Test-rule'; + const TIMELINE_NAME = 'Untitled timeline'; navigateTo('/app/osquery/packs'); preparePack(PACK_NAME); findAndClickButton('Edit'); @@ -57,6 +58,7 @@ describe('Alert Event Details', () => { cy.getBySel('ruleSwitch').click(); cy.getBySel('ruleSwitch').should('have.attr', 'aria-checked', 'true'); cy.visit('/app/security/alerts'); + cy.wait(500); cy.getBySel('expand-event').first().click(); cy.getBySel('take-action-dropdown-btn').click(); cy.getBySel('osquery-action-item').click(); @@ -64,12 +66,16 @@ describe('Alert Event Details', () => { inputQuery('select * from uptime;'); submitQuery(); checkResults(); - + cy.contains('Save for later').click(); + cy.contains('Save query'); + cy.get('.euiButtonEmpty--flushLeft').contains('Cancel').click(); + cy.getBySel('add-to-timeline').first().click(); + cy.getBySel('globalToastList').contains('Added'); cy.getBySel(RESULTS_TABLE).within(() => { cy.getBySel(RESULTS_TABLE_BUTTON).should('not.exist'); }); - cy.contains('Save for later').click(); - cy.contains('Save query'); - cy.contains(/^Save$/); + cy.contains('Cancel').click(); + cy.contains(TIMELINE_NAME).click(); + cy.getBySel('draggableWrapperKeyboardHandler').contains('action_id: "'); }); }); diff --git a/x-pack/plugins/osquery/cypress/integration/all/delete_all_ecs_mappings.spec.ts b/x-pack/plugins/osquery/cypress/integration/all/delete_all_ecs_mappings.spec.ts index dab935d919a28..1ce25a77f834a 100644 --- a/x-pack/plugins/osquery/cypress/integration/all/delete_all_ecs_mappings.spec.ts +++ b/x-pack/plugins/osquery/cypress/integration/all/delete_all_ecs_mappings.spec.ts @@ -31,7 +31,10 @@ describe('ALL - Delete ECS Mappings', () => { }).click(); cy.contains('Custom key/value pairs.').should('exist'); cy.contains('Hours of uptime').should('exist'); - cy.react('EuiButtonIcon', { props: { id: 'labels-trash' } }).click(); + cy.react('ECSComboboxFieldComponent', { props: { field: { value: 'labels' } } }) + .parents('[data-test-subj="ECSMappingEditorForm"]') + .react('EuiButtonIcon', { props: { iconType: 'trash' } }) + .click(); cy.react('EuiButton').contains('Update query').click(); cy.wait(5000); diff --git a/x-pack/plugins/osquery/cypress/integration/all/live_query.spec.ts b/x-pack/plugins/osquery/cypress/integration/all/live_query.spec.ts index 6a9d102784a58..7cdc55c014505 100644 --- a/x-pack/plugins/osquery/cypress/integration/all/live_query.spec.ts +++ b/x-pack/plugins/osquery/cypress/integration/all/live_query.spec.ts @@ -61,10 +61,8 @@ describe('ALL - Live Query', () => { }).should('exist'); cy.react(RESULTS_TABLE_CELL_WRRAPER, { props: { id: 'osquery.days.number', index: 2 }, - }).within(() => { - cy.get('.euiToolTipAnchor').within(() => { - cy.get('svg').should('exist'); - }); - }); + }) + .react('EuiIconTip', { props: { type: 'indexMapping' } }) + .should('exist'); }); }); diff --git a/x-pack/plugins/osquery/cypress/integration/all/packs.spec.ts b/x-pack/plugins/osquery/cypress/integration/all/packs.spec.ts index 255dabbc433b0..917147fe88457 100644 --- a/x-pack/plugins/osquery/cypress/integration/all/packs.spec.ts +++ b/x-pack/plugins/osquery/cypress/integration/all/packs.spec.ts @@ -55,7 +55,7 @@ describe('ALL - Packs', () => { cy.react('List').first().click(); findAndClickButton('Add query'); cy.contains('Attach next query'); - getSavedQueriesDropdown().click().type(`${SAVED_QUERY_ID}{downArrow}{enter}`); + getSavedQueriesDropdown().type(`${SAVED_QUERY_ID}{downArrow}{enter}`); cy.react('EuiFormRow', { props: { label: 'Interval (s)' } }) .click() .clear() @@ -92,7 +92,7 @@ describe('ALL - Packs', () => { findAndClickButton('Add query'); cy.contains('Attach next query'); cy.contains('ID must be unique').should('not.exist'); - getSavedQueriesDropdown().click().type(`${SAVED_QUERY_ID}{downArrow}{enter}`); + getSavedQueriesDropdown().type(`${SAVED_QUERY_ID}{downArrow}{enter}`); cy.contains('ID must be unique').should('exist'); cy.react('EuiFlyoutFooter').react('EuiButtonEmpty').contains('Cancel').click(); }); @@ -170,7 +170,7 @@ describe('ALL - Packs', () => { findAndClickButton('Add query'); - getSavedQueriesDropdown().click().type('Multiple {downArrow} {enter}'); + getSavedQueriesDropdown().type('Multiple {downArrow} {enter}'); cy.contains('Custom key/value pairs'); cy.contains('Days of uptime'); cy.contains('List of keywords used to tag each'); @@ -178,7 +178,7 @@ describe('ALL - Packs', () => { cy.contains('Client network address.'); cy.contains('Total uptime seconds'); - getSavedQueriesDropdown().click().type('NOMAPPING {downArrow} {enter}'); + getSavedQueriesDropdown().type('NOMAPPING {downArrow} {enter}'); cy.contains('Custom key/value pairs').should('not.exist'); cy.contains('Days of uptime').should('not.exist'); cy.contains('List of keywords used to tag each').should('not.exist'); @@ -186,7 +186,7 @@ describe('ALL - Packs', () => { cy.contains('Client network address.').should('not.exist'); cy.contains('Total uptime seconds').should('not.exist'); - getSavedQueriesDropdown().click().type('ONE_MAPPING {downArrow} {enter}'); + getSavedQueriesDropdown().type('ONE_MAPPING {downArrow} {enter}'); cy.contains('Name of the continent'); cy.contains('Seconds of uptime'); diff --git a/x-pack/plugins/osquery/cypress/integration/roles/t1_analyst.spec.ts b/x-pack/plugins/osquery/cypress/integration/roles/t1_analyst.spec.ts index 64d72c92dda04..51270332e0a51 100644 --- a/x-pack/plugins/osquery/cypress/integration/roles/t1_analyst.spec.ts +++ b/x-pack/plugins/osquery/cypress/integration/roles/t1_analyst.spec.ts @@ -60,7 +60,7 @@ describe('T1 Analyst - READ + runSavedQueries ', () => { cy.waitForReact(1000); cy.contains('New live query').should('not.be.disabled').click(); selectAllAgents(); - getSavedQueriesDropdown().click().type(`${SAVED_QUERY_ID}{downArrow} {enter}`); + getSavedQueriesDropdown().type(`${SAVED_QUERY_ID}{downArrow} {enter}`); cy.contains('select * from uptime'); submitQuery(); checkResults(); diff --git a/x-pack/plugins/osquery/cypress/integration/roles/t2_analyst.spec.ts b/x-pack/plugins/osquery/cypress/integration/roles/t2_analyst.spec.ts index 619865e50bb6b..28a8f8a7880ac 100644 --- a/x-pack/plugins/osquery/cypress/integration/roles/t2_analyst.spec.ts +++ b/x-pack/plugins/osquery/cypress/integration/roles/t2_analyst.spec.ts @@ -104,7 +104,10 @@ describe('T2 Analyst - READ + Write Live/Saved + runSavedQueries ', () => { }).click(); cy.contains('Custom key/value pairs.').should('exist'); cy.contains('Hours of uptime').should('exist'); - cy.react('EuiButtonIcon', { props: { id: 'labels-trash' } }).click(); + cy.react('ECSComboboxFieldComponent', { props: { field: { value: 'labels' } } }) + .parents('[data-test-subj="ECSMappingEditorForm"]') + .react('EuiButtonIcon', { props: { iconType: 'trash' } }) + .click(); cy.react('EuiButton').contains('Update query').click(); cy.wait(5000); diff --git a/x-pack/plugins/osquery/cypress/tasks/live_query.ts b/x-pack/plugins/osquery/cypress/tasks/live_query.ts index b3006a3d1074a..ca232d8507d2a 100644 --- a/x-pack/plugins/osquery/cypress/tasks/live_query.ts +++ b/x-pack/plugins/osquery/cypress/tasks/live_query.ts @@ -8,14 +8,15 @@ import { LIVE_QUERY_EDITOR } from '../screens/live_query'; export const DEFAULT_QUERY = 'select * from processes;'; -export const BIG_QUERY = 'select * from processes, users;'; +export const BIG_QUERY = 'select * from processes, users limit 200;'; export const selectAllAgents = () => { - cy.react('EuiComboBox', { props: { placeholder: 'Select agents or groups' } }).type('All agents'); + cy.react('AgentsTable').find('input').should('not.be.disabled'); + cy.react('AgentsTable EuiComboBox', { + props: { placeholder: 'Select agents or groups' }, + }).click(); cy.react('EuiFilterSelectItem').contains('All agents').should('exist'); - cy.react('EuiComboBox', { props: { placeholder: 'Select agents or groups' } }).type( - '{downArrow}{enter}{esc}' - ); + cy.react('AgentsTable EuiComboBox').type('{downArrow}{enter}{esc}'); cy.contains('1 agent selected.'); }; @@ -24,12 +25,11 @@ export const inputQuery = (query: string) => cy.get(LIVE_QUERY_EDITOR).type(quer export const submitQuery = () => cy.contains('Submit').click(); export const checkResults = () => - cy.getBySel('dataGridRowCell', { timeout: 60000 }).should('have.lengthOf.above', 0); + cy.getBySel('dataGridRowCell', { timeout: 120000 }).should('have.lengthOf.above', 0); -export const typeInECSFieldInput = (text: string) => - cy.getBySel('ECS-field-input').click().type(text); +export const typeInECSFieldInput = (text: string) => cy.getBySel('ECS-field-input').type(text); export const typeInOsqueryFieldInput = (text: string) => - cy.react('OsqueryColumnFieldComponent').first().react('ResultComboBox').click().type(text); + cy.react('OsqueryColumnFieldComponent').first().react('ResultComboBox').type(text); export const findFormFieldByRowsLabelAndType = (label: string, text: string) => { cy.react('EuiFormRow', { props: { label } }).type(text); diff --git a/x-pack/plugins/osquery/kibana.json b/x-pack/plugins/osquery/kibana.json index 619bcbeed14f4..1ea8468529b85 100644 --- a/x-pack/plugins/osquery/kibana.json +++ b/x-pack/plugins/osquery/kibana.json @@ -12,7 +12,6 @@ "requiredPlugins": [ "actions", "data", - "dataEnhanced", "discover", "features", "navigation", diff --git a/x-pack/plugins/osquery/public/action_results/use_action_results.ts b/x-pack/plugins/osquery/public/action_results/use_action_results.ts index e567c7ccdb635..d8dd3186238f7 100644 --- a/x-pack/plugins/osquery/public/action_results/use_action_results.ts +++ b/x-pack/plugins/osquery/public/action_results/use_action_results.ts @@ -9,7 +9,7 @@ import { flatten, reverse, uniqBy } from 'lodash/fp'; import { useQuery } from 'react-query'; import { i18n } from '@kbn/i18n'; -import { firstValueFrom } from 'rxjs'; +import { lastValueFrom } from 'rxjs'; import { createFilter, getInspectResponse, @@ -68,7 +68,7 @@ export const useActionResults = ({ return useQuery( ['actionResults', { actionId }], async () => { - const responseData = await firstValueFrom( + const responseData = await lastValueFrom( data.search.search( { actionId, diff --git a/x-pack/plugins/osquery/public/actions/use_action_details.ts b/x-pack/plugins/osquery/public/actions/use_action_details.ts index 1a6550d8f47dd..32b8d4578cb77 100644 --- a/x-pack/plugins/osquery/public/actions/use_action_details.ts +++ b/x-pack/plugins/osquery/public/actions/use_action_details.ts @@ -8,7 +8,7 @@ import { useQuery } from 'react-query'; import { i18n } from '@kbn/i18n'; -import { firstValueFrom } from 'rxjs'; +import { lastValueFrom } from 'rxjs'; import { createFilter } from '../common/helpers'; import { useKibana } from '../common/lib/kibana'; import { @@ -37,7 +37,7 @@ export const useActionDetails = ({ actionId, filterQuery, skip = false }: UseAct return useQuery( ['actionDetails', { actionId, filterQuery }], async () => { - const responseData = await firstValueFrom( + const responseData = await lastValueFrom( data.search.search( { actionId, diff --git a/x-pack/plugins/osquery/public/actions/use_all_actions.ts b/x-pack/plugins/osquery/public/actions/use_all_actions.ts index d1fe00c81a0b5..34a25fa47b6e9 100644 --- a/x-pack/plugins/osquery/public/actions/use_all_actions.ts +++ b/x-pack/plugins/osquery/public/actions/use_all_actions.ts @@ -8,7 +8,7 @@ import { useQuery } from 'react-query'; import { i18n } from '@kbn/i18n'; -import { firstValueFrom } from 'rxjs'; +import { lastValueFrom } from 'rxjs'; import { createFilter, generateTablePaginationOptions, @@ -60,7 +60,7 @@ export const useAllActions = ({ return useQuery( ['actions', { activePage, direction, limit, sortField }], async () => { - const responseData = await firstValueFrom( + const responseData = await lastValueFrom( data.search.search( { factoryQueryType: OsqueryQueries.actions, diff --git a/x-pack/plugins/osquery/public/agents/agents_table.tsx b/x-pack/plugins/osquery/public/agents/agents_table.tsx index 55e63456fe916..75d073c4d9292 100644 --- a/x-pack/plugins/osquery/public/agents/agents_table.tsx +++ b/x-pack/plugins/osquery/public/agents/agents_table.tsx @@ -6,13 +6,13 @@ */ import { find } from 'lodash/fp'; -import React, { useCallback, useEffect, useMemo, useRef, useState } from 'react'; +import React, { useCallback, useEffect, useRef, useState } from 'react'; import { EuiComboBox, EuiHealth, EuiHighlight, EuiSpacer } from '@elastic/eui'; +import deepEqual from 'fast-deep-equal'; import useDebounce from 'react-use/lib/useDebounce'; import { useAllAgents } from './use_all_agents'; import { useAgentGroups } from './use_agent_groups'; -import { useOsqueryPolicies } from './use_osquery_policies'; import { AgentGrouper } from './agent_grouper'; import { getNumAgentsInGrouping, @@ -61,19 +61,16 @@ const AgentsTableComponent: React.FC = ({ agentSelection, onCh ); // grouping related - const osqueryPolicyData = useOsqueryPolicies(); const { - loading: groupsLoading, - totalCount: totalNumAgents, - groups, + isLoading: groupsLoading, + data: agentGroupsData, isFetched: groupsFetched, - } = useAgentGroups(osqueryPolicyData); - const grouper = useMemo(() => new AgentGrouper(), []); + } = useAgentGroups(); const { isLoading: agentsLoading, data: agents, isFetched: agentsFetched, - } = useAllAgents(osqueryPolicyData, debouncedSearchValue, { + } = useAllAgents(debouncedSearchValue, { perPage, }); @@ -96,7 +93,7 @@ const AgentsTableComponent: React.FC = ({ agentSelection, onCh selectedGroups: SelectedGroups; } = generateAgentSelection(selection); if (newAgentSelection.allAgentsSelected) { - setNumAgentsSelected(totalNumAgents); + setNumAgentsSelected(agentGroupsData?.totalCount ?? 0); } else { const checkAgent = generateAgentCheck(selectedGroups); setNumAgentsSelected( @@ -105,14 +102,14 @@ const AgentsTableComponent: React.FC = ({ agentSelection, onCh // add the number of agents added via policy and platform groups getNumAgentsInGrouping(selectedGroups) - // subtract the number of agents double counted by policy/platform selections - getNumOverlapped(selectedGroups, groups.overlap) + getNumOverlapped(selectedGroups, agentGroupsData?.groups?.overlap ?? {}) ); } onChange(newAgentSelection); setSelectedOptions(selection); }, - [groups, onChange, totalNumAgents] + [agentGroupsData, onChange] ); useEffect(() => { @@ -154,26 +151,18 @@ const AgentsTableComponent: React.FC = ({ agentSelection, onCh }, [agentSelection, onSelection, options, selectedOptions]); useEffect(() => { - if (agentsFetched && groupsFetched) { + if (agentsFetched && groupsFetched && agentGroupsData) { + const grouper = new AgentGrouper(); // update the groups when groups or agents have changed - grouper.setTotalAgents(totalNumAgents); - grouper.updateGroup(AGENT_GROUP_KEY.Platform, groups.platforms); - grouper.updateGroup(AGENT_GROUP_KEY.Policy, groups.policies); + grouper.setTotalAgents(agentGroupsData?.totalCount); + grouper.updateGroup(AGENT_GROUP_KEY.Platform, agentGroupsData?.groups.platforms); + grouper.updateGroup(AGENT_GROUP_KEY.Policy, agentGroupsData?.groups.policies); // @ts-expect-error update types grouper.updateGroup(AGENT_GROUP_KEY.Agent, agents); const newOptions = grouper.generateOptions(); - setOptions(newOptions); + setOptions((prevOptions) => (!deepEqual(prevOptions, newOptions) ? newOptions : prevOptions)); } - }, [ - groups.platforms, - groups.policies, - totalNumAgents, - groupsLoading, - agents, - agentsFetched, - groupsFetched, - grouper, - ]); + }, [groupsLoading, agents, agentsFetched, groupsFetched, agentGroupsData]); const renderOption = useCallback((option, searchVal, contentClassName) => { const { label, value } = option; @@ -202,6 +191,7 @@ const AgentsTableComponent: React.FC = ({ agentSelection, onCh return (
= ({ agentSelection, onCh ); }; +AgentsTableComponent.displayName = 'AgentsTable'; + export const AgentsTable = React.memo(AgentsTableComponent); diff --git a/x-pack/plugins/osquery/public/agents/helpers.ts b/x-pack/plugins/osquery/public/agents/helpers.ts index 1c23eac3ca201..db48b5d417c96 100644 --- a/x-pack/plugins/osquery/public/agents/helpers.ts +++ b/x-pack/plugins/osquery/public/agents/helpers.ts @@ -38,7 +38,17 @@ interface Aggs extends estypes.AggregationsTermsAggregateBase { buckets: AggregationDataPoint[]; } -export const processAggregations = (aggs: Record) => { +export const processAggregations = ( + aggs: Record | undefined +) => { + if (!aggs) { + return { + platforms: [], + overlap: {}, + policies: [], + }; + } + const platforms: Group[] = []; const overlap: Overlap = {}; const platformTerms = aggs.platforms as Aggs; diff --git a/x-pack/plugins/osquery/public/agents/use_agent_groups.ts b/x-pack/plugins/osquery/public/agents/use_agent_groups.ts index 2dba1c471a786..3dc96c1f150c7 100644 --- a/x-pack/plugins/osquery/public/agents/use_agent_groups.ts +++ b/x-pack/plugins/osquery/public/agents/use_agent_groups.ts @@ -4,10 +4,9 @@ * 2.0; you may not use this file except in compliance with the Elastic License * 2.0. */ -import { useState } from 'react'; import { useQuery } from 'react-query'; import { i18n } from '@kbn/i18n'; -import { firstValueFrom } from 'rxjs'; +import { lastValueFrom } from 'rxjs'; import { useKibana } from '../common/lib/kibana'; import { useAgentPolicies } from './use_agent_policies'; @@ -19,28 +18,27 @@ import { import { processAggregations } from './helpers'; import { generateTablePaginationOptions } from '../common/helpers'; -import { Overlap, Group } from './types'; import { useErrorToast } from '../common/hooks/use_error_toast'; +import { useOsqueryPolicies } from './use_osquery_policies'; -interface UseAgentGroups { - osqueryPolicies: string[]; - osqueryPoliciesLoading: boolean; -} - -export const useAgentGroups = ({ osqueryPolicies, osqueryPoliciesLoading }: UseAgentGroups) => { +export const useAgentGroups = () => { const { data } = useKibana().services; const setErrorToast = useErrorToast(); + const { data: osqueryPolicies, isFetched: isOsqueryPoliciesFetched } = useOsqueryPolicies(); const { agentPoliciesLoading, agentPolicyById } = useAgentPolicies(osqueryPolicies); - const [platforms, setPlatforms] = useState([]); - const [policies, setPolicies] = useState([]); - const [loading, setLoading] = useState(true); - const [overlap, setOverlap] = useState(() => ({})); - const [totalCount, setTotalCount] = useState(0); - const { isFetched } = useQuery( + + return useQuery< + AgentsStrategyResponse, + unknown, + { + totalCount: number; + groups: ReturnType; + } + >( ['agentGroups'], async () => { - const responseData = await firstValueFrom( + const responseData = await lastValueFrom( data.search.search( { filterQuery: { terms: { policy_id: osqueryPolicies } }, @@ -76,32 +74,54 @@ export const useAgentGroups = ({ osqueryPolicies, osqueryPoliciesLoading }: UseA ) ); - if (responseData.rawResponse.aggregations) { - const { - platforms: newPlatforms, - overlap: newOverlap, - policies: newPolicies, - } = processAggregations(responseData.rawResponse.aggregations); - - setPlatforms(newPlatforms); - setOverlap(newOverlap); - setPolicies( - newPolicies.map((p) => { - const name = agentPolicyById[p.id]?.name ?? p.name; - - return { - ...p, - name, - }; - }) - ); - } - - setLoading(false); - setTotalCount(responseData.totalCount); + return responseData; }, { - enabled: !osqueryPoliciesLoading && !agentPoliciesLoading, + select: (response) => { + const { platforms, overlap, policies } = processAggregations( + response.rawResponse.aggregations + ); + + return { + totalCount: response.totalCount, + groups: { + platforms, + overlap, + policies: policies.map((p) => { + const name = agentPolicyById[p.id]?.name ?? p.name; + + return { + ...p, + name, + }; + }), + }, + }; + }, + placeholderData: { + totalCount: 0, + edges: [], + pageInfo: { + activePage: 1, + fakeTotalCount: 100, + showMorePagesIndicator: true, + }, + rawResponse: { + took: 0, + timed_out: false, + _shards: { + failed: 0, + successful: 0, + total: 0, + }, + hits: { + hits: [], + }, + }, + }, + refetchOnWindowFocus: false, + keepPreviousData: true, + enabled: isOsqueryPoliciesFetched && !agentPoliciesLoading, onSuccess: () => setErrorToast(), onError: (error) => setErrorToast(error as Error, { @@ -111,15 +131,4 @@ export const useAgentGroups = ({ osqueryPolicies, osqueryPoliciesLoading }: UseA }), } ); - - return { - isFetched, - loading, - totalCount, - groups: { - platforms, - policies, - overlap, - }, - }; }; diff --git a/x-pack/plugins/osquery/public/agents/use_all_agents.ts b/x-pack/plugins/osquery/public/agents/use_all_agents.ts index 9ffcaae16bc6d..defe625eb9a28 100644 --- a/x-pack/plugins/osquery/public/agents/use_all_agents.ts +++ b/x-pack/plugins/osquery/public/agents/use_all_agents.ts @@ -11,11 +11,7 @@ import { useQuery } from 'react-query'; import { GetAgentsResponse } from '@kbn/fleet-plugin/common'; import { useErrorToast } from '../common/hooks/use_error_toast'; import { useKibana } from '../common/lib/kibana'; - -interface UseAllAgents { - osqueryPolicies: string[]; - osqueryPoliciesLoading: boolean; -} +import { useOsqueryPolicies } from './use_osquery_policies'; interface RequestOptions { perPage?: number; @@ -23,22 +19,24 @@ interface RequestOptions { } // TODO: break out the paginated vs all cases into separate hooks -export const useAllAgents = ( - { osqueryPolicies, osqueryPoliciesLoading }: UseAllAgents, - searchValue = '', - opts: RequestOptions = { perPage: 9000 } -) => { +export const useAllAgents = (searchValue = '', opts: RequestOptions = { perPage: 9000 }) => { const { perPage } = opts; const { http } = useKibana().services; const setErrorToast = useErrorToast(); + const { data: osqueryPolicies, isFetched } = useOsqueryPolicies(); + return useQuery( ['agents', osqueryPolicies, searchValue, perPage], () => { - let kuery = `(${osqueryPolicies.map((p) => `policy_id:${p}`).join(' or ')})`; + let kuery = ''; + + if (osqueryPolicies?.length) { + kuery = `(${osqueryPolicies.map((p) => `policy_id:${p}`).join(' or ')})`; - if (searchValue) { - kuery += ` and (local_metadata.host.hostname:*${searchValue}* or local_metadata.elastic.agent.id:*${searchValue}*)`; + if (searchValue) { + kuery += ` and (local_metadata.host.hostname:*${searchValue}* or local_metadata.elastic.agent.id:*${searchValue}*)`; + } } return http.get(`/internal/osquery/fleet_wrapper/agents`, { @@ -51,7 +49,7 @@ export const useAllAgents = ( { // @ts-expect-error update types select: (data) => data?.agents || [], - enabled: !osqueryPoliciesLoading && osqueryPolicies.length > 0, + enabled: isFetched && !!osqueryPolicies?.length, onSuccess: () => setErrorToast(), onError: (error) => // @ts-expect-error update types diff --git a/x-pack/plugins/osquery/public/agents/use_osquery_policies.ts b/x-pack/plugins/osquery/public/agents/use_osquery_policies.ts index 679aeef1bd23b..9ecf5d14c6b38 100644 --- a/x-pack/plugins/osquery/public/agents/use_osquery_policies.ts +++ b/x-pack/plugins/osquery/public/agents/use_osquery_policies.ts @@ -7,7 +7,6 @@ import { uniq } from 'lodash'; import { useQuery } from 'react-query'; -import { useMemo } from 'react'; import { i18n } from '@kbn/i18n'; import { useKibana } from '../common/lib/kibana'; import { useErrorToast } from '../common/hooks/use_error_toast'; @@ -16,7 +15,7 @@ export const useOsqueryPolicies = () => { const { http } = useKibana().services; const setErrorToast = useErrorToast(); - const { isLoading: osqueryPoliciesLoading, data: osqueryPolicies = [] } = useQuery( + return useQuery( ['osqueryPolicies'], () => http.get<{ items: Array<{ policy_id: string }> }>( @@ -33,9 +32,4 @@ export const useOsqueryPolicies = () => { }), } ); - - return useMemo( - () => ({ osqueryPoliciesLoading, osqueryPolicies }), - [osqueryPoliciesLoading, osqueryPolicies] - ); }; diff --git a/x-pack/plugins/osquery/public/live_queries/form/index.tsx b/x-pack/plugins/osquery/public/live_queries/form/index.tsx index e63ad38aaa695..6a72a0b59979f 100644 --- a/x-pack/plugins/osquery/public/live_queries/form/index.tsx +++ b/x-pack/plugins/osquery/public/live_queries/form/index.tsx @@ -8,22 +8,21 @@ import { EuiButton, EuiButtonEmpty, - EuiSteps, EuiSpacer, EuiFlexGroup, EuiFlexItem, EuiAccordion, EuiAccordionProps, } from '@elastic/eui'; -import { EuiContainedStepProps } from '@elastic/eui/src/components/steps/steps'; import { i18n } from '@kbn/i18n'; import { FormattedMessage } from '@kbn/i18n-react'; -import React, { useCallback, useEffect, useMemo, useState, useRef } from 'react'; +import React, { useCallback, useEffect, useMemo, useState } from 'react'; import { useMutation } from 'react-query'; import deepMerge from 'deepmerge'; import styled from 'styled-components'; -import { pickBy, isEmpty } from 'lodash'; +import { pickBy, isEmpty, map } from 'lodash'; +import { convertECSMappingToObject } from '../../../common/schemas/common/utils'; import { UseField, Form, FormData, useForm, useFormData, FIELD_TYPES } from '../../shared_imports'; import { AgentsTableField } from './agents_table_field'; import { LiveQueryQueryField } from './live_query_query_field'; @@ -33,16 +32,13 @@ import { queryFieldValidation } from '../../common/validations'; import { fieldValidators } from '../../shared_imports'; import { SavedQueryFlyout } from '../../saved_queries'; import { useErrorToast } from '../../common/hooks/use_error_toast'; -import { - ECSMappingEditorField, - ECSMappingEditorFieldRef, -} from '../../packs/queries/lazy_ecs_mapping_editor_field'; +import { ECSMappingEditorField } from '../../packs/queries/lazy_ecs_mapping_editor_field'; import { SavedQueriesDropdown } from '../../saved_queries/saved_queries_dropdown'; const FORM_ID = 'liveQueryForm'; const StyledEuiAccordion = styled(EuiAccordion)` - ${({ isDisabled }: { isDisabled: boolean }) => isDisabled && 'display: none;'} + ${({ isDisabled }: { isDisabled?: boolean }) => isDisabled && 'display: none;'} .euiAccordion__button { color: ${({ theme }) => theme.eui.euiColorPrimary}; } @@ -55,27 +51,26 @@ const GhostFormField = () => <>; type FormType = 'simple' | 'steps'; interface LiveQueryFormProps { - defaultValue?: Partial | undefined; + defaultValue?: Partial; onSuccess?: () => void; - agentsField?: boolean; queryField?: boolean; ecsMappingField?: boolean; formType?: FormType; enabled?: boolean; - isExternal?: true; + hideAgentsField?: boolean; + addToTimeline?: (payload: { query: [string, string]; isIcon?: true }) => React.ReactElement; } const LiveQueryFormComponent: React.FC = ({ defaultValue, onSuccess, - agentsField = true, queryField = true, ecsMappingField = true, formType = 'steps', enabled = true, - isExternal, + hideAgentsField = false, + addToTimeline, }) => { - const ecsFieldRef = useRef(); const permissions = useKibana().services.application.capabilities.osquery; const { http } = useKibana().services; const [advancedContentState, setAdvancedContentState] = @@ -136,7 +131,7 @@ const LiveQueryFormComponent: React.FC = ({ ], }, ecs_mapping: { - defaultValue: {}, + defaultValue: [], type: FIELD_TYPES.JSON, validations: [], }, @@ -146,18 +141,9 @@ const LiveQueryFormComponent: React.FC = ({ id: FORM_ID, schema: formSchema, onSubmit: async (formData, isValid) => { - const ecsFieldValue = await ecsFieldRef?.current?.validate(); - if (isValid && (!ecsMappingField || !!ecsFieldValue)) { + if (isValid) { try { - await mutateAsync( - pickBy( - { - ...formData, - ...(isEmpty(ecsFieldValue) ? {} : { ecs_mapping: ecsFieldValue }), - }, - (value) => !isEmpty(value) - ) - ); + await mutateAsync(pickBy(formData, (value) => !isEmpty(value))); // eslint-disable-next-line no-empty } catch (e) {} } @@ -165,8 +151,16 @@ const LiveQueryFormComponent: React.FC = ({ options: { stripEmptyFields: false, }, - serializer: ({ savedQueryId, ...formData }) => - pickBy({ ...formData, saved_query_id: savedQueryId }, (value) => !isEmpty(value)), + // eslint-disable-next-line @typescript-eslint/naming-convention + serializer: ({ savedQueryId, ecs_mapping, ...formData }) => + pickBy( + { + ...formData, + saved_query_id: savedQueryId, + ecs_mapping: convertECSMappingToObject(ecs_mapping), + }, + (value) => !isEmpty(value) + ), defaultValue: deepMerge( { agentSelection: { @@ -177,12 +171,13 @@ const LiveQueryFormComponent: React.FC = ({ }, query: '', savedQueryId: null, + ecs_mapping: [], }, defaultValue ?? {} ), }); - const { setFieldValue, submit, isSubmitting } = form; + const { updateFieldValues, setFieldValue, submit, isSubmitting } = form; const actionId = useMemo(() => data?.actions[0].action_id, [data?.actions]); const agentIds = useMemo(() => data?.actions[0].agents, [data?.actions]); @@ -207,13 +202,12 @@ const LiveQueryFormComponent: React.FC = ({ const queryValueProvided = useMemo(() => !!query?.length, [query]); const queryStatus = useMemo(() => { - if (!agentSelected) return 'disabled'; - if (isError || !form.getFields().query.isValid) return 'danger'; + if (isError || !form.getFields().query?.isValid) return 'danger'; if (isLoading) return 'loading'; if (isSuccess) return 'complete'; return 'incomplete'; - }, [agentSelected, isError, isLoading, isSuccess, form]); + }, [isError, isLoading, isSuccess, form]); const resultsStatus = useMemo( () => (queryStatus === 'complete' ? 'incomplete' : 'disabled'), @@ -223,19 +217,28 @@ const LiveQueryFormComponent: React.FC = ({ const handleSavedQueryChange = useCallback( (savedQuery) => { if (savedQuery) { - setFieldValue('query', savedQuery.query); - setFieldValue('savedQueryId', savedQuery.savedQueryId); + updateFieldValues({ + query: savedQuery.query, + savedQueryId: savedQuery.savedQueryId, + ecs_mapping: savedQuery.ecs_mapping + ? map(savedQuery.ecs_mapping, (value, key) => ({ + key, + result: { + type: Object.keys(value)[0], + value: Object.values(value)[0], + }, + })) + : [], + }); + if (!isEmpty(savedQuery.ecs_mapping)) { - setFieldValue('ecs_mapping', savedQuery.ecs_mapping); setAdvancedContentState('open'); - } else { - setFieldValue('ecs_mapping', {}); } } else { setFieldValue('savedQueryId', null); } }, - [setFieldValue] + [setFieldValue, updateFieldValues] ); const commands = useMemo( @@ -251,10 +254,9 @@ const LiveQueryFormComponent: React.FC = ({ const queryComponentProps = useMemo( () => ({ - disabled: queryStatus === 'disabled', commands, }), - [queryStatus, commands] + [commands] ); const flyoutFormDefaultValue = useMemo( @@ -275,9 +277,8 @@ const LiveQueryFormComponent: React.FC = ({ ); const isSavedQueryDisabled = useMemo( - () => - queryComponentProps.disabled || !permissions.runSavedQueries || !permissions.readSavedQueries, - [permissions.readSavedQueries, permissions.runSavedQueries, queryComponentProps.disabled] + () => !permissions.runSavedQueries || !permissions.readSavedQueries, + [permissions.readSavedQueries, permissions.runSavedQueries] ); const queryFieldStepContent = useMemo( @@ -314,16 +315,9 @@ const LiveQueryFormComponent: React.FC = ({ forceState={advancedContentState} onToggle={handleToggle} buttonContent="Advanced" - isDisabled={queryComponentProps.disabled} > - + ) : ( @@ -372,7 +366,6 @@ const LiveQueryFormComponent: React.FC = ({ ecsMappingField, advancedContentState, handleToggle, - query, ecsFieldProps, formType, agentSelected, @@ -393,81 +386,49 @@ const LiveQueryFormComponent: React.FC = ({ actionId={actionId} endDate={data?.actions[0].expiration} agentIds={agentIds} - isExternal={isExternal} + addToTimeline={addToTimeline} /> ) : null, - [actionId, agentIds, data?.actions, isExternal] - ); - - const formSteps: EuiContainedStepProps[] = useMemo( - () => [ - { - title: i18n.translate('xpack.osquery.liveQueryForm.steps.agentsStepHeading', { - defaultMessage: 'Select agents', - }), - children: , - status: agentSelected ? 'complete' : 'incomplete', - }, - { - title: i18n.translate('xpack.osquery.liveQueryForm.steps.queryStepHeading', { - defaultMessage: 'Enter query', - }), - children: queryFieldStepContent, - status: queryStatus, - }, - { - title: i18n.translate('xpack.osquery.liveQueryForm.steps.resultsStepHeading', { - defaultMessage: 'Check results', - }), - children: resultsStepContent, - status: resultsStatus, - }, - ], - [agentSelected, queryFieldStepContent, queryStatus, resultsStepContent, resultsStatus] - ); - - const simpleForm = useMemo( - () => ( - - - {queryFieldStepContent} - {resultsStepContent} - - ), - [agentsField, queryFieldStepContent, resultsStepContent] + [actionId, agentIds, data?.actions, addToTimeline] ); useEffect(() => { - if (defaultValue?.agentSelection) { - setFieldValue('agentSelection', defaultValue?.agentSelection); - } - - if (defaultValue?.query) { - setFieldValue('query', defaultValue?.query); - } - - // TODO: Set query and ECS mapping from savedQueryId object - if (defaultValue?.savedQueryId) { - setFieldValue('savedQueryId', defaultValue?.savedQueryId); - } - - if (!isEmpty(defaultValue?.ecs_mapping)) { - setFieldValue('ecs_mapping', defaultValue?.ecs_mapping); + if (defaultValue) { + updateFieldValues({ + agentSelection: defaultValue.agentSelection, + query: defaultValue.query, + savedQueryId: defaultValue.savedQueryId, + ecs_mapping: defaultValue.ecs_mapping + ? map(defaultValue.ecs_mapping, (value, key) => ({ + key, + result: { + type: Object.keys(value)[0], + value: Object.values(value)[0], + }, + })) + : undefined, + }); } - }, [defaultValue, setFieldValue]); + }, [defaultValue, updateFieldValues]); return ( <>
- {formType === 'steps' ? : simpleForm} + + + + + {queryFieldStepContent} + {resultsStepContent} + {showSavedQueryFlyout ? ( diff --git a/x-pack/plugins/osquery/public/live_queries/index.tsx b/x-pack/plugins/osquery/public/live_queries/index.tsx index 56cac9cdf5ec7..a147f929f7f25 100644 --- a/x-pack/plugins/osquery/public/live_queries/index.tsx +++ b/x-pack/plugins/osquery/public/live_queries/index.tsx @@ -28,7 +28,8 @@ interface LiveQueryProps { ecsMappingField?: boolean; enabled?: boolean; formType?: 'steps' | 'simple'; - isExternal?: true; + hideAgentsField?: boolean; + addToTimeline?: (payload: { query: [string, string]; isIcon?: true }) => React.ReactElement; } const LiveQueryComponent: React.FC = ({ @@ -40,12 +41,12 @@ const LiveQueryComponent: React.FC = ({ savedQueryId, // eslint-disable-next-line @typescript-eslint/naming-convention ecs_mapping, - agentsField, queryField, ecsMappingField, formType, enabled, - isExternal, + hideAgentsField, + addToTimeline, }) => { const { data: hasActionResultsPrivileges, isLoading } = useActionResultsPrivileges(); @@ -108,14 +109,14 @@ const LiveQueryComponent: React.FC = ({ return ( ); }; diff --git a/x-pack/plugins/osquery/public/packs/queries/ecs_mapping_editor_field.tsx b/x-pack/plugins/osquery/public/packs/queries/ecs_mapping_editor_field.tsx index bca3036d19f4c..a9c663051e273 100644 --- a/x-pack/plugins/osquery/public/packs/queries/ecs_mapping_editor_field.tsx +++ b/x-pack/plugins/osquery/public/packs/queries/ecs_mapping_editor_field.tsx @@ -5,7 +5,6 @@ * 2.0. */ -import { produce } from 'immer'; import { castArray, each, @@ -19,16 +18,7 @@ import { trim, get, } from 'lodash'; -import React, { - forwardRef, - useCallback, - useEffect, - useMemo, - useRef, - useState, - useImperativeHandle, - MutableRefObject, -} from 'react'; +import React, { useCallback, useEffect, useLayoutEffect, useMemo, useRef, useState } from 'react'; import { EuiFormLabel, EuiButtonIcon, @@ -49,7 +39,6 @@ import { FormattedMessage } from '@kbn/i18n-react'; import { i18n } from '@kbn/i18n'; import styled from 'styled-components'; import deepEqual from 'fast-deep-equal'; -import deepmerge from 'deepmerge'; import ECSSchema from '../../common/schemas/ecs/v8.2.0.json'; import osquerySchema from '../../common/schemas/osquery/v5.2.2.json'; @@ -57,17 +46,17 @@ import osquerySchema from '../../common/schemas/osquery/v5.2.2.json'; import { FieldIcon } from '../../common/lib/kibana'; import { FIELD_TYPES, - Form, - FormData, FieldHook, getFieldValidityAndErrorMessage, - useForm, useFormData, Field, getUseField, fieldValidators, ValidationFuncArg, UseMultiFields, + UseArray, + ArrayItem, + FormArrayField, } from '../../shared_imports'; import { OsqueryIcon } from '../../components/osquery_icon'; @@ -179,7 +168,7 @@ const ECSComboboxFieldComponent: React.FC = ({ setSelected(newSelectedOptions); setValue(newSelectedOptions[0]?.label ?? ''); }, - [setSelected, setValue] + [setValue] ); // TODO: Create own component for this. @@ -339,7 +328,7 @@ const OsqueryColumnFieldComponent: React.FC = ({ }) => { const inputRef = useRef(); const { setValue } = resultValue; - const { setValue: setType } = resultType; + const { value: typeValue, setValue: setType } = resultType; const { isInvalid, errorMessage } = getFieldValidityAndErrorMessage(resultValue); const describedByIds = useMemo(() => (idAria ? [idAria] : []), [idAria]); const [selectedOptions, setSelected] = useState< @@ -383,12 +372,12 @@ const OsqueryColumnFieldComponent: React.FC = ({ const onTypeChange = useCallback( (newType) => { - if (newType !== resultType.value) { + if (newType !== typeValue) { setType(newType); setValue(newType === 'value' && euiFieldProps.singleSelection === false ? [] : ''); } }, - [resultType.value, setType, setValue, euiFieldProps.singleSelection] + [typeValue, setType, setValue, euiFieldProps.singleSelection] ); const handleCreateOption = useCallback( @@ -416,8 +405,9 @@ const OsqueryColumnFieldComponent: React.FC = ({ const Prepend = useMemo( () => ( = ({ onChange={onTypeChange} /> ), - [onTypeChange, resultType.value] + [euiFieldProps.isDisabled, onTypeChange, typeValue] ); useEffect(() => { @@ -438,8 +428,7 @@ const OsqueryColumnFieldComponent: React.FC = ({ if (!euiFieldProps?.singleSelection && !isArray(resultValue.value)) { setValue(resultValue.value.length ? [resultValue.value] : []); } - // eslint-disable-next-line react-hooks/exhaustive-deps - }, [euiFieldProps?.singleSelection, setValue]); + }, [euiFieldProps?.singleSelection, resultValue.value, setValue]); useEffect(() => { setSelected(() => { @@ -482,7 +471,7 @@ const OsqueryColumnFieldComponent: React.FC = ({ rowHeight={32} isClearable {...euiFieldProps} - options={(resultType.value === 'field' && euiFieldProps.options) || EMPTY_ARRAY} + options={(typeValue === 'field' && euiFieldProps.options) || EMPTY_ARRAY} /> @@ -490,105 +479,96 @@ const OsqueryColumnFieldComponent: React.FC = ({ ); }; -export const OsqueryColumnField = React.memo( - OsqueryColumnFieldComponent, - (prevProps, nextProps) => - prevProps.resultType.value === nextProps.resultType.value && - prevProps.resultType.isChangingValue === nextProps.resultType.isChangingValue && - prevProps.resultType.errors === nextProps.resultType.errors && - prevProps.resultValue.value === nextProps.resultValue.value && - prevProps.resultValue.isChangingValue === nextProps.resultValue.isChangingValue && - prevProps.resultValue.errors === nextProps.resultValue.errors && - deepEqual(prevProps.euiFieldProps, nextProps.euiFieldProps) -); - -export interface ECSMappingEditorFieldRef { - validate: () => Promise< - | Record< - string, - { - field: string; - } - > - | false - | {} - >; -} +export const OsqueryColumnField = React.memo(OsqueryColumnFieldComponent); export interface ECSMappingEditorFieldProps { - field: FieldHook>; - query: string; - fieldRef: MutableRefObject; - euiFieldProps: EuiComboBoxProps<{}>; + euiFieldProps?: EuiComboBoxProps<{}>; } interface ECSMappingEditorFormProps { isDisabled?: boolean; osquerySchemaOptions: OsquerySchemaOption[]; - defaultValue?: FormData; - onAdd?: (payload: FormData) => void; - onChange?: (payload: FormData) => void; - onDelete?: (key: string) => void; + item: ArrayItem; + isLastItem?: boolean; + onDelete?: FormArrayField['removeItem']; } -const getEcsFieldValidator = - (editForm: boolean) => - (args: ValidationFuncArg) => { - const fieldRequiredError = fieldValidators.emptyField( - i18n.translate('xpack.osquery.pack.queryFlyoutForm.ecsFieldRequiredErrorMessage', { - defaultMessage: 'ECS field is required.', - }) - )(args); - +const ecsFieldValidator = ( + args: ValidationFuncArg & { + customData: { + value: { + editForm: boolean; + }; + }; + } +) => { + const editForm: boolean = args.customData.value?.editForm; + const rootPath = args.path.split('.')[0]; + + const fieldRequiredError = fieldValidators.emptyField( + i18n.translate('xpack.osquery.pack.queryFlyoutForm.ecsFieldRequiredErrorMessage', { + defaultMessage: 'ECS field is required.', + }) + )(args); + + if ( + fieldRequiredError && // @ts-expect-error update types - if (fieldRequiredError && ((!editForm && args.formData['result.value'].length) || editForm)) { - return fieldRequiredError; - } + ((!editForm && args.formData[`${rootPath}.result.value`]?.length) || editForm) + ) { + return fieldRequiredError; + } - return undefined; - }; + return undefined; +}; -const getOsqueryResultFieldValidator = - (osquerySchemaOptions: OsquerySchemaOption[], editForm: boolean) => - ( - args: ValidationFuncArg - ) => { - const fieldRequiredError = fieldValidators.emptyField( - i18n.translate('xpack.osquery.pack.queryFlyoutForm.osqueryResultFieldRequiredErrorMessage', { - defaultMessage: 'Value is required.', - }) - )(args); - - if (fieldRequiredError && ((!editForm && args.formData.key.length) || editForm)) { - return fieldRequiredError; - } +const osqueryResultFieldValidator = async ( + args: ValidationFuncArg & { + customData: { + value: { + editForm: boolean; + osquerySchemaOptions: OsquerySchemaOption[]; + }; + }; + } +) => { + const rootPath = args.path.split('.')[0]; + const { editForm, osquerySchemaOptions } = args.customData.value; + const fieldRequiredError = fieldValidators.emptyField( + i18n.translate('xpack.osquery.pack.queryFlyoutForm.osqueryResultFieldRequiredErrorMessage', { + defaultMessage: 'Value is required.', + }) + )(args); + + // @ts-expect-error update types + if (fieldRequiredError && ((!editForm && args.formData[`${rootPath}.key`]?.length) || editForm)) { + return fieldRequiredError; + } - // @ts-expect-error update types - if (!args.value?.length || args.formData['result.type'] !== 'field') return; - - const osqueryColumnExists = find(osquerySchemaOptions, ['label', args.value]); - - return !osqueryColumnExists - ? { - code: 'ERR_FIELD_FORMAT', - path: args.path, - message: i18n.translate( - 'xpack.osquery.pack.queryFlyoutForm.osqueryResultFieldValueMissingErrorMessage', - { - defaultMessage: 'The current query does not return a {columnName} field', - values: { - columnName: args.value, - }, - } - ), - __isBlocking__: false, - } - : undefined; - }; + // @ts-expect-error update types + if (!args.value?.length || args.formData[`${rootPath}.result.type`] !== 'field') return; + + const osqueryColumnExists = find(osquerySchemaOptions, [ + 'label', + isArray(args.value) ? args.value[0] : args.value, + ]); -const FORM_DEFAULT_VALUE = { - key: '', - value: { field: '' }, + return !osqueryColumnExists + ? { + code: 'ERR_FIELD_FORMAT', + path: args.path, + message: i18n.translate( + 'xpack.osquery.pack.queryFlyoutForm.osqueryResultFieldValueMissingErrorMessage', + { + defaultMessage: 'The current query does not return a {columnName} field', + values: { + columnName: args.value, + }, + } + ), + __isBlocking__: false, + } + : undefined; }; interface ECSMappingEditorFormData { @@ -599,217 +579,141 @@ interface ECSMappingEditorFormData { }; } -interface ECSMappingEditorFormRef { - validate: () => Promise<{ - data: ECSMappingEditorFormData | {}; - isValid: boolean; - }>; -} +export const ECSMappingEditorForm: React.FC = ({ + isDisabled, + osquerySchemaOptions, + item, + isLastItem, + onDelete, +}) => { + const multipleValuesField = useRef(false); -export const ECSMappingEditorForm = forwardRef( - ({ isDisabled, osquerySchemaOptions, defaultValue, onAdd, onChange, onDelete }, ref) => { - const editForm = !!defaultValue; - const multipleValuesField = useRef(false); - const currentFormData = useRef(defaultValue); - const formSchema = useMemo( - () => ({ - key: { - type: FIELD_TYPES.COMBO_BOX, - fieldsToValidateOnChange: ['result.value', 'key'], - validations: [ - { - validator: getEcsFieldValidator(editForm), + const MultiFields = useMemo( + () => ( + ({ - key: data.key ?? '', - result: { - type: data.value - ? Object.keys(data.value)[0] - : OSQUERY_COLUMN_VALUE_TYPE_OPTIONS[0].value, - value: data.value ? Object.values(data.value)[0] : '', - }, - }), - }); - - const { submit, reset, validate, validateFields } = form; - - const [formData] = useFormData({ form }); - - const handleSubmit = useCallback(async () => { - validate(); - validateFields(['result.value', 'key']); - const { data, isValid } = await submit(); - - if (isValid) { - const serializedData = { - key: data.key, - value: { - [data.result.type]: data.result.value, }, - }; - if (onAdd) { - onAdd(serializedData); - } - - if (onChange) { - onChange(serializedData); - } - - reset(); - } - }, [validate, validateFields, submit, onAdd, onChange, reset]); - - const handleDeleteClick = useCallback(() => { - if (defaultValue?.key && onDelete) { - onDelete(defaultValue.key); - } - }, [defaultValue, onDelete]); - - const MultiFields = useMemo( - () => ( - - {(fields) => ( - - )} - - ), - [osquerySchemaOptions, isDisabled] - ); - - const ecsComboBoxEuiFieldProps = useMemo(() => ({ isDisabled }), [isDisabled]); + }, + }} + > + {(fields) => ( + + )} + + ), + [item.path, osquerySchemaOptions, isLastItem, isDisabled] + ); - useImperativeHandle( - ref, - () => ({ - validate: async () => { - if (!editForm && deepEqual(formData, FORM_DEFAULT_VALUE)) { - return { data: {}, isValid: true }; - } + const ecsComboBoxEuiFieldProps = useMemo(() => ({ isDisabled }), [isDisabled]); - validateFields(['result.value', 'key']); - const isValid = await validate(); + const validationData = useMemo(() => ({ editForm: !isLastItem }), [isLastItem]); - return { - data: formData?.key?.length - ? { - [formData.key]: { - [formData.result.type]: formData.result.value, - }, - } - : {}, - isValid, - }; + const config = useMemo( + () => ({ + valueChangeDebounceTime: 300, + fieldsToValidateOnChange: [`${item.path}.key`, `${item.path}.result.value`], + validations: [ + { + validator: ecsFieldValidator, }, - }), - [validateFields, editForm, formData, validate] - ); + ], + }), + [item.path] + ); - useEffect(() => { - if (!deepEqual(formData, currentFormData.current)) { - currentFormData.current = formData; - const ecsOption = find(ECSSchemaOptions, ['label', formData.key]); - multipleValuesField.current = - ecsOption?.value?.normalization === 'array' && formData.result.type === 'value'; - handleSubmit(); - } - }, [handleSubmit, formData, onAdd]); + const handleDeleteClick = useCallback(() => { + if (onDelete) { + onDelete(item.id); + } + }, [item.id, onDelete]); - return ( -
- - - - - - + return ( + <> + + + + + + + + + : + + + + + + + {MultiFields} + {!isDisabled && ( - - : - + + {!isLastItem && ( + + )} + - - - - - {MultiFields} - {!isDisabled && ( - - - {defaultValue && ( - - )} - - - )} - - - - - - ); - } -); + )} + + +
+ + + ); +}; interface OsquerySchemaOption { label: string; @@ -831,177 +735,155 @@ interface OsqueryColumn { } export const ECSMappingEditorField = React.memo( - ({ field, query, fieldRef, euiFieldProps }: ECSMappingEditorFieldProps) => { - const { setValue, value = {} } = field; - const [osquerySchemaOptions, setOsquerySchemaOptions] = useState([]); - const formRefs = useRef>({}); - - useImperativeHandle( - fieldRef, - () => ({ - validate: async () => { - const validations = await Promise.all( - Object.values(formRefs.current).map(async (formRef) => { - const { data, isValid } = await formRef.validate(); - - return [data, isValid]; - }) - ); - - if (find(validations, (result) => result[1] === false)) { - return false; - } - - return deepmerge.all(map(validations, '[0]')); - }, - }), - [] - ); + ({ euiFieldProps }: ECSMappingEditorFieldProps) => { + const lastItemPath = useRef(); + const onAdd = useRef(); + const osquerySchemaOptions = useRef([]); + const [{ query, ...formData }, formDataSerializer, isMounted] = useFormData(); useEffect(() => { - setOsquerySchemaOptions((currentValue) => { - if (!query?.length) { - return currentValue; - } + if (!query?.length) { + return; + } - // eslint-disable-next-line @typescript-eslint/no-explicit-any - let ast: Record | undefined; + // eslint-disable-next-line @typescript-eslint/no-explicit-any + let ast: Record | undefined; - try { - ast = sqlParser.parse(query)?.value; - } catch (e) { - return currentValue; - } + try { + ast = sqlParser.parse(query)?.value; + } catch (e) { + return; + } - const astOsqueryTables: Record< - string, - { - columns: OsqueryColumn[]; - order: number; - } - > = - ast?.from?.value?.reduce( - ( - acc: { - [x: string]: { - columns: OsqueryColumn[]; - order: number; - }; - }, - table: { - value: { - left?: { value: { value: string }; alias?: { value: string } }; - right?: { value: { value: string }; alias?: { value: string } }; - value?: { value: string }; - alias?: { value: string }; - }; - } - ) => { - each(['value.left', 'value.right', 'value'], (valueKey) => { - if (valueKey) { - const osqueryTable = find(osquerySchema, [ - 'name', - get(table, `${valueKey}.value.value`), - ]); - - if (osqueryTable) { - acc[ - get(table, `${valueKey}.alias.value`) ?? get(table, `${valueKey}.value.value`) - ] = { - columns: osqueryTable.columns, - order: Object.keys(acc).length, - }; - } + const astOsqueryTables: Record< + string, + { + columns: OsqueryColumn[]; + order: number; + } + > = + ast?.from?.value?.reduce( + ( + acc: { + [x: string]: { + columns: OsqueryColumn[]; + order: number; + }; + }, + table: { + value: { + left?: { value: { value: string }; alias?: { value: string } }; + right?: { value: { value: string }; alias?: { value: string } }; + value?: { value: string }; + alias?: { value: string }; + }; + } + ) => { + each(['value.left', 'value.right', 'value'], (valueKey) => { + if (valueKey) { + const osqueryTable = find(osquerySchema, [ + 'name', + get(table, `${valueKey}.value.value`), + ]); + + if (osqueryTable) { + acc[ + get(table, `${valueKey}.alias.value`) ?? get(table, `${valueKey}.value.value`) + ] = { + columns: osqueryTable.columns, + order: Object.keys(acc).length, + }; } - }); + } + }); - return acc; - }, - {} - ) ?? {}; + return acc; + }, + {} + ) ?? {}; - // Table doesn't exist in osquery schema - if (isEmpty(astOsqueryTables)) { - return currentValue; - } + // Table doesn't exist in osquery schema + if (isEmpty(astOsqueryTables)) { + return; + } - const suggestions = - isArray(ast?.selectItems?.value) && - ast?.selectItems?.value - ?.map((selectItem: { type: string; value: string; hasAs: boolean; alias?: string }) => { - if (selectItem.type === 'Identifier') { - /* + const suggestions = + isArray(ast?.selectItems?.value) && + ast?.selectItems?.value + ?.map((selectItem: { type: string; value: string; hasAs: boolean; alias?: string }) => { + if (selectItem.type === 'Identifier') { + /* select * from routes, uptime; */ - if (ast?.selectItems?.value.length === 1 && selectItem.value === '*') { - return reduce( - astOsqueryTables, - (acc, { columns: osqueryColumns, order: tableOrder }, table) => { - acc.push( - ...osqueryColumns.map((osqueryColumn) => ({ - label: osqueryColumn.name, - value: { - name: osqueryColumn.name, - description: osqueryColumn.description, - table, - tableOrder, - suggestion_label: osqueryColumn.name, - }, - })) - ); - - return acc; - }, - [] as OsquerySchemaOption[] - ); - } - - /* - select i.*, p.resident_size, p.user_time, p.system_time, time.minutes as counter from osquery_info i, processes p, time where p.pid = i.pid; - */ - - const [table, column] = selectItem.value.includes('.') - ? selectItem.value?.split('.') - : [Object.keys(astOsqueryTables)[0], selectItem.value]; - - if (column === '*' && astOsqueryTables[table]) { - const { columns: osqueryColumns, order: tableOrder } = astOsqueryTables[table]; - - return osqueryColumns.map((osqueryColumn) => ({ - label: osqueryColumn.name, - value: { - name: osqueryColumn.name, - description: osqueryColumn.description, - table, - tableOrder, - suggestion_label: `${osqueryColumn.name}`, - }, - })); - } - - if (astOsqueryTables[table]) { - const osqueryColumn = find(astOsqueryTables[table].columns, ['name', column]); - - if (osqueryColumn) { - const label = selectItem.hasAs ? selectItem.alias : column; - - return [ - { - label, + if (ast?.selectItems?.value.length === 1 && selectItem.value === '*') { + return reduce( + astOsqueryTables, + (acc, { columns: osqueryColumns, order: tableOrder }, table) => { + acc.push( + ...osqueryColumns.map((osqueryColumn) => ({ + label: osqueryColumn.name, value: { name: osqueryColumn.name, description: osqueryColumn.description, table, - tableOrder: astOsqueryTables[table].order, - suggestion_label: `${label}`, + tableOrder, + suggestion_label: osqueryColumn.name, }, + })) + ); + + return acc; + }, + [] as OsquerySchemaOption[] + ); + } + + /* + select i.*, p.resident_size, p.user_time, p.system_time, time.minutes as counter from osquery_info i, processes p, time where p.pid = i.pid; + */ + + const [table, column] = selectItem.value.includes('.') + ? selectItem.value?.split('.') + : [Object.keys(astOsqueryTables)[0], selectItem.value]; + + if (column === '*' && astOsqueryTables[table]) { + const { columns: osqueryColumns, order: tableOrder } = astOsqueryTables[table]; + + return osqueryColumns.map((osqueryColumn) => ({ + label: osqueryColumn.name, + value: { + name: osqueryColumn.name, + description: osqueryColumn.description, + table, + tableOrder, + suggestion_label: `${osqueryColumn.name}`, + }, + })); + } + + if (astOsqueryTables[table]) { + const osqueryColumn = find(astOsqueryTables[table].columns, ['name', column]); + + if (osqueryColumn) { + const label = selectItem.hasAs ? selectItem.alias : column; + + return [ + { + label, + value: { + name: osqueryColumn.name, + description: osqueryColumn.description, + table, + tableOrder: astOsqueryTables[table].order, + suggestion_label: `${label}`, }, - ]; - } + }, + ]; } } + } - /* + /* SELECT pid, uid, name, ROUND(( (user_time + system_time) / (cpu_time.tsb - cpu_time.itsb) ) * 100, 2) AS percentage @@ -1015,95 +897,57 @@ export const ECSMappingEditorField = React.memo( LIMIT 5; */ - if (selectItem.hasAs && selectItem.alias) { - return [ - { - label: selectItem.alias, - value: { - name: selectItem.alias, - description: '', - table: '', - tableOrder: -1, - suggestion_label: selectItem.alias, - }, + if (selectItem.hasAs && selectItem.alias) { + return [ + { + label: selectItem.alias, + value: { + name: selectItem.alias, + description: '', + table: '', + tableOrder: -1, + suggestion_label: selectItem.alias, }, - ]; - } + }, + ]; + } - return []; - }) - .flat(); + return []; + }) + .flat(); - // Remove column duplicates by keeping the column from the table that appears last in the query - return sortedUniqBy( - orderBy(suggestions, ['value.suggestion_label', 'value.tableOrder'], ['asc', 'desc']), - 'label' - ); - }); + // Remove column duplicates by keeping the column from the table that appears last in the query + osquerySchemaOptions.current = sortedUniqBy( + orderBy(suggestions, ['value.suggestion_label', 'value.tableOrder'], ['asc', 'desc']), + 'label' + ); }, [query]); - useEffect(() => { - Object.keys(formRefs.current).forEach((key) => { - if (!value[key]) { - delete formRefs.current[key]; - } - }); - }, [value]); - - const handleAddRow = useCallback( - (newRow) => { - if (newRow?.key && newRow?.value) { - setValue( - produce((draft) => { - draft[newRow.key] = newRow.value; - - return draft; - }) - ); - } - }, - [setValue] - ); - - const handleUpdateRow = useCallback( - (currentKey: string) => (updatedRow: FormData) => { - if (updatedRow?.key && updatedRow?.value) { - setValue( - produce((draft) => { - if (currentKey !== updatedRow.key) { - delete draft[currentKey]; - } + useLayoutEffect(() => { + if (isMounted) { + if (!lastItemPath.current && onAdd.current) { + onAdd.current(); - draft[updatedRow.key] = updatedRow.value; + return; + } - return draft; - }) - ); + if (euiFieldProps?.isDisabled) { + return; } - }, - [setValue] - ); - const handleDeleteRow = useCallback( - (key) => { - if (key) { - setValue( - produce((draft) => { - if (draft[key]) { - delete draft[key]; - } + const itemKey = get(formData, `${lastItemPath.current}.key`); - return draft; - }) - ); + if (itemKey) { + const serializedFormData = formDataSerializer(); + const itemValue = + serializedFormData.ecs_mapping && serializedFormData.ecs_mapping[`${itemKey}`]?.field; - if (formRefs.current[key]) { - delete formRefs.current[key]; + if (itemValue && onAdd.current) { + onAdd.current(); } } - }, - [setValue] - ); + } + }, [euiFieldProps?.isDisabled, formData, formDataSerializer, isMounted, onAdd]); return ( <> @@ -1145,45 +989,31 @@ export const ECSMappingEditorField = React.memo( - {Object.entries(value).map(([ecsKey, ecsValue]) => ( - { - if (formRef) { - formRefs.current[ecsKey] = formRef; - } - }} - key={ecsKey} - osquerySchemaOptions={osquerySchemaOptions} - // eslint-disable-next-line react-perf/jsx-no-new-object-as-prop - defaultValue={{ - key: ecsKey, - value: ecsValue, - }} - onChange={handleUpdateRow(ecsKey)} - onDelete={handleDeleteRow} - isDisabled={!!euiFieldProps?.isDisabled} - /> - ))} - {!euiFieldProps?.isDisabled && ( - { - if (formRef) { - formRefs.current.new = formRef; - } - }} - osquerySchemaOptions={osquerySchemaOptions} - onAdd={handleAddRow} - /> - )} + + {({ items, addItem, removeItem }) => { + lastItemPath.current = items[items.length - 1]?.path; + onAdd.current = addItem; + + return ( + <> + {items.map((item, index) => ( + + ))} + + ); + }} + ); }, - (prevProps, nextProps) => - prevProps.field.value === nextProps.field.value && - prevProps.query === nextProps.query && - deepEqual(prevProps.euiFieldProps, nextProps.euiFieldProps) + (prevProps, nextProps) => deepEqual(prevProps.euiFieldProps, nextProps.euiFieldProps) ); // eslint-disable-next-line import/no-default-export diff --git a/x-pack/plugins/osquery/public/packs/queries/lazy_ecs_mapping_editor_field.tsx b/x-pack/plugins/osquery/public/packs/queries/lazy_ecs_mapping_editor_field.tsx index 69c3e4bc477c9..e2e4d45b669ee 100644 --- a/x-pack/plugins/osquery/public/packs/queries/lazy_ecs_mapping_editor_field.tsx +++ b/x-pack/plugins/osquery/public/packs/queries/lazy_ecs_mapping_editor_field.tsx @@ -6,14 +6,11 @@ */ import React, { lazy, Suspense } from 'react'; -import type { - ECSMappingEditorFieldProps, - ECSMappingEditorFieldRef, -} from './ecs_mapping_editor_field'; +import type { ECSMappingEditorFieldProps } from './ecs_mapping_editor_field'; const LazyECSMappingEditorField = lazy(() => import('./ecs_mapping_editor_field')); -export type { ECSMappingEditorFieldProps, ECSMappingEditorFieldRef }; +export type { ECSMappingEditorFieldProps }; export const ECSMappingEditorField = (props: ECSMappingEditorFieldProps) => ( diff --git a/x-pack/plugins/osquery/public/packs/queries/query_flyout.tsx b/x-pack/plugins/osquery/public/packs/queries/query_flyout.tsx index 8590968b58fb0..9bb0b521fb132 100644 --- a/x-pack/plugins/osquery/public/packs/queries/query_flyout.tsx +++ b/x-pack/plugins/osquery/public/packs/queries/query_flyout.tsx @@ -5,7 +5,7 @@ * 2.0. */ -import { isEmpty } from 'lodash'; +import { map } from 'lodash'; import { EuiFlyout, EuiTitle, @@ -19,17 +19,17 @@ import { EuiButton, EuiText, } from '@elastic/eui'; -import React, { useCallback, useMemo, useState, useRef } from 'react'; +import React, { useCallback, useMemo, useState } from 'react'; import { i18n } from '@kbn/i18n'; import { FormattedMessage } from '@kbn/i18n-react'; import { CodeEditorField } from '../../saved_queries/form/code_editor_field'; -import { Form, getUseField, Field, useFormData } from '../../shared_imports'; +import { Form, getUseField, Field } from '../../shared_imports'; import { PlatformCheckBoxGroupField } from './platform_checkbox_group_field'; import { ALL_OSQUERY_VERSIONS_OPTIONS } from './constants'; import { UsePackQueryFormProps, PackFormData, usePackQueryForm } from './use_pack_query_form'; import { SavedQueriesDropdown } from '../../saved_queries/saved_queries_dropdown'; -import { ECSMappingEditorField, ECSMappingEditorFieldRef } from './lazy_ecs_mapping_editor_field'; +import { ECSMappingEditorField } from './lazy_ecs_mapping_editor_field'; const CommonUseField = getUseField({ component: Field }); @@ -46,70 +46,46 @@ const QueryFlyoutComponent: React.FC = ({ onSave, onClose, }) => { - const ecsFieldRef = useRef(); const [isEditMode] = useState(!!defaultValue); const { form } = usePackQueryForm({ uniqueQueryIds, defaultValue, - handleSubmit: async (payload, isValid) => { - const ecsFieldValue = await ecsFieldRef?.current?.validate(); - const isEcsFieldValueValid = - ecsFieldValue && - Object.values(ecsFieldValue).every((field) => !isEmpty(Object.values(field)[0])); - - return new Promise((resolve) => { - if (isValid && isEcsFieldValueValid) { - onSave({ - ...payload, - ...(isEmpty(ecsFieldValue) ? {} : { ecs_mapping: ecsFieldValue }), - }); + handleSubmit: async (payload, isValid) => + new Promise((resolve) => { + if (isValid) { + onSave(payload); onClose(); } resolve(); - }); - }, + }), }); - const { submit, setFieldValue, reset, isSubmitting, validate } = form; - - const [{ query }] = useFormData({ - form, - watch: ['query'], - }); + const { submit, isSubmitting, updateFieldValues } = form; const handleSetQueryValue = useCallback( (savedQuery) => { - reset(); - if (savedQuery) { - setFieldValue('id', savedQuery.id); - setFieldValue('query', savedQuery.query); - - if (savedQuery.description) { - setFieldValue('description', savedQuery.description); - } - - if (savedQuery.interval) { - setFieldValue('interval', savedQuery.interval); - } - - if (savedQuery.platform) { - setFieldValue('platform', savedQuery.platform); - } - - if (savedQuery.version) { - setFieldValue('version', [savedQuery.version]); - } - - if (savedQuery.ecs_mapping) { - setFieldValue('ecs_mapping', savedQuery.ecs_mapping); - } + updateFieldValues({ + id: savedQuery.id, + query: savedQuery.query, + description: savedQuery.description, + platform: savedQuery.platform, + version: savedQuery.version, + interval: savedQuery.interval, + // @ts-expect-error update types + ecs_mapping: + map(savedQuery.ecs_mapping, (value, key) => ({ + key, + result: { + type: Object.keys(value)[0], + value: Object.values(value)[0], + }, + })) ?? [], + }); } - - validate(); }, - [reset, validate, setFieldValue] + [updateFieldValues] ); /* Avoids accidental closing of the flyout when the user clicks outside of the flyout */ const maskProps = useMemo(() => ({ onClick: () => ({}) }), []); @@ -190,12 +166,7 @@ const QueryFlyoutComponent: React.FC = ({ - + diff --git a/x-pack/plugins/osquery/public/packs/queries/schema.tsx b/x-pack/plugins/osquery/public/packs/queries/schema.tsx index d5b169b2c116c..526de9b73b0ea 100644 --- a/x-pack/plugins/osquery/public/packs/queries/schema.tsx +++ b/x-pack/plugins/osquery/public/packs/queries/schema.tsx @@ -71,7 +71,7 @@ export const createFormSchema = (ids: Set) => ({ validations: [], }, ecs_mapping: { - defaultValue: {}, + defaultValue: [], type: FIELD_TYPES.JSON, validations: [], }, diff --git a/x-pack/plugins/osquery/public/packs/queries/use_pack_query_form.tsx b/x-pack/plugins/osquery/public/packs/queries/use_pack_query_form.tsx index b46230a65267e..2b044a443004d 100644 --- a/x-pack/plugins/osquery/public/packs/queries/use_pack_query_form.tsx +++ b/x-pack/plugins/osquery/public/packs/queries/use_pack_query_form.tsx @@ -5,11 +5,12 @@ * 2.0. */ -import { isArray, isEmpty, xor } from 'lodash'; +import { isArray, isEmpty, xor, map } from 'lodash'; import uuid from 'uuid'; import { produce } from 'immer'; import { useMemo } from 'react'; +import { convertECSMappingToObject } from '../../../common/schemas/common/utils'; import { FormConfig, useForm } from '../../shared_imports'; import { createFormSchema } from './schema'; @@ -37,11 +38,14 @@ export interface PackFormData { platform?: string | undefined; version?: string | undefined; ecs_mapping?: - | Record< - string, - { - field: string; - } + | Array< + Record< + string, + { + field?: string; + value?: string; + } + > > | undefined; } @@ -76,7 +80,7 @@ export const usePackQueryForm = ({ id: '', query: '', interval: 3600, - ecs_mapping: {}, + ecs_mapping: [], }, // @ts-expect-error update types serializer: (payload) => @@ -100,6 +104,9 @@ export const usePackQueryForm = ({ if (isEmpty(draft.ecs_mapping)) { delete draft.ecs_mapping; + } else { + // @ts-expect-error update types + draft.ecs_mapping = convertECSMappingToObject(payload.ecs_mapping); } return draft; @@ -114,7 +121,17 @@ export const usePackQueryForm = ({ interval: payload.interval, platform: payload.platform, version: payload.version ? [payload.version] : [], - ecs_mapping: payload.ecs_mapping ?? {}, + ecs_mapping: !isArray(payload.ecs_mapping) + ? map(payload.ecs_mapping, (value, key) => ({ + key, + result: { + // @ts-expect-error update types + type: Object.keys(value)[0], + // @ts-expect-error update types + value: Object.values(value)[0], + }, + })) + : payload.ecs_mapping, }; }, // @ts-expect-error update types diff --git a/x-pack/plugins/osquery/public/results/results_table.tsx b/x-pack/plugins/osquery/public/results/results_table.tsx index 9b3dc144a7e3f..229714eaaed99 100644 --- a/x-pack/plugins/osquery/public/results/results_table.tsx +++ b/x-pack/plugins/osquery/public/results/results_table.tsx @@ -18,6 +18,8 @@ import { EuiProgress, EuiSpacer, EuiIconTip, + EuiDataGridCellValueElementProps, + EuiDataGridControlColumn, } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; import { FormattedMessage } from '@kbn/i18n-react'; @@ -46,7 +48,7 @@ interface ResultsTableComponentProps { agentIds?: string[]; endDate?: string; startDate?: string; - isExternal?: true; + addToTimeline?: (payload: { query: [string, string]; isIcon?: true }) => React.ReactElement; } const ResultsTableComponent: React.FC = ({ @@ -54,7 +56,7 @@ const ResultsTableComponent: React.FC = ({ agentIds, startDate, endDate, - isExternal, + addToTimeline, }) => { const [isLive, setIsLive] = useState(true); const { data: hasActionResultsPrivileges } = useActionResultsPrivileges(); @@ -107,11 +109,7 @@ const ResultsTableComponent: React.FC = ({ ]); const [columns, setColumns] = useState([]); - const { - data: allResultsData, - isFetched, - isLoading, - } = useAllResults({ + const { data: allResultsData, isLoading } = useAllResults({ actionId, activePage: pagination.pageIndex, limit: pagination.pageSize, @@ -309,10 +307,30 @@ const ResultsTableComponent: React.FC = ({ // eslint-disable-next-line react-hooks/exhaustive-deps }, [allResultsData?.columns.length, ecsMappingColumns, getHeaderDisplay]); + const leadingControlColumns: EuiDataGridControlColumn[] = useMemo(() => { + const data = allResultsData?.edges; + if (addToTimeline && data) { + return [ + { + id: 'timeline', + width: 38, + headerCellRender: () => null, + rowCellRender: (actionProps: EuiDataGridCellValueElementProps) => { + const eventId = data[actionProps.rowIndex]._id; + + return addToTimeline({ query: ['_id', eventId], isIcon: true }); + }, + }, + ]; + } + + return []; + }, [addToTimeline, allResultsData?.edges]); + const toolbarVisibility = useMemo( () => ({ showDisplaySelector: false, - showFullScreenSelector: !isExternal, + showFullScreenSelector: !addToTimeline, additionalControls: ( <> = ({ endDate={endDate} startDate={startDate} /> + {addToTimeline && addToTimeline({ query: ['action_id', actionId] })} ), }), - [actionId, endDate, startDate, isExternal] + [actionId, addToTimeline, endDate, startDate] ); useEffect( @@ -338,20 +357,44 @@ const ResultsTableComponent: React.FC = ({ setIsLive(() => { if (!agentIds?.length || expired) return false; - return !!(aggregations.totalResponded !== agentIds?.length); + return !!( + aggregations.totalResponded !== agentIds?.length || + allResultsData?.totalCount !== aggregations?.totalRowCount || + (allResultsData?.totalCount && !allResultsData?.edges.length) + ); }), - [agentIds?.length, aggregations.failed, aggregations.totalResponded, expired] + [ + agentIds?.length, + aggregations.totalResponded, + aggregations?.totalRowCount, + allResultsData?.edges.length, + allResultsData?.totalCount, + expired, + ] ); if (!hasActionResultsPrivileges) { return ( - + + } + color="danger" + iconType="alert" + >

- {'Your user role doesn’t have index read permissions on the '} - logs-{OSQUERY_INTEGRATION_NAME}.result* - { - 'index. Access to this index is required to view osquery results. Administrators can update role permissions in Stack Management > Roles.' - } + read, + logs: logs-{OSQUERY_INTEGRATION_NAME}.result*, + }} + />

); @@ -365,13 +408,12 @@ const ResultsTableComponent: React.FC = ({ <> {isLive && } - {isFetched && !allResultsData?.edges.length && !aggregations?.totalRowCount ? ( + {!allResultsData?.edges.length ? ( <> ) : ( - // @ts-expect-error update types = ({ columnVisibility={columnVisibility} rowCount={allResultsData?.totalCount ?? 0} renderCellValue={renderCellValue} + leadingControlColumns={leadingControlColumns} sorting={tableSorting} pagination={tablePagination} height="500px" diff --git a/x-pack/plugins/osquery/public/results/use_all_results.ts b/x-pack/plugins/osquery/public/results/use_all_results.ts index c35ce881586b1..aa63e584bccef 100644 --- a/x-pack/plugins/osquery/public/results/use_all_results.ts +++ b/x-pack/plugins/osquery/public/results/use_all_results.ts @@ -8,7 +8,7 @@ import { useQuery } from 'react-query'; import { i18n } from '@kbn/i18n'; -import { firstValueFrom } from 'rxjs'; +import { lastValueFrom } from 'rxjs'; import { createFilter, generateTablePaginationOptions, @@ -62,7 +62,7 @@ export const useAllResults = ({ return useQuery( ['allActionResults', { actionId, activePage, limit, sort }], async () => { - const responseData = await firstValueFrom( + const responseData = await lastValueFrom( data.search.search( { actionId, diff --git a/x-pack/plugins/osquery/public/routes/saved_queries/edit/form.tsx b/x-pack/plugins/osquery/public/routes/saved_queries/edit/form.tsx index 432a108c8ece3..75969fd8f5dd1 100644 --- a/x-pack/plugins/osquery/public/routes/saved_queries/edit/form.tsx +++ b/x-pack/plugins/osquery/public/routes/saved_queries/edit/form.tsx @@ -13,12 +13,12 @@ import { EuiFlexItem, EuiSpacer, } from '@elastic/eui'; -import React, { useRef } from 'react'; +import React from 'react'; import { FormattedMessage } from '@kbn/i18n-react'; import { useRouterNavigate } from '../../../common/lib/kibana'; import { Form } from '../../../shared_imports'; -import { SavedQueryForm, SavedQueryFormRefObject } from '../../../saved_queries/form'; +import { SavedQueryForm } from '../../../saved_queries/form'; import { useSavedQueryForm } from '../../../saved_queries/form/use_saved_query_form'; interface EditSavedQueryFormProps { @@ -32,19 +32,17 @@ const EditSavedQueryFormComponent: React.FC = ({ handleSubmit, viewMode, }) => { - const savedQueryFormRef = useRef(null); const savedQueryListProps = useRouterNavigate('saved_queries'); const { form } = useSavedQueryForm({ defaultValue, - savedQueryFormRef, handleSubmit, }); const { submit, isSubmitting } = form; return (
- + {!viewMode && ( <> diff --git a/x-pack/plugins/osquery/public/routes/saved_queries/edit/tabs.tsx b/x-pack/plugins/osquery/public/routes/saved_queries/edit/tabs.tsx index 0956dc6528a7f..76e8bfd9dd029 100644 --- a/x-pack/plugins/osquery/public/routes/saved_queries/edit/tabs.tsx +++ b/x-pack/plugins/osquery/public/routes/saved_queries/edit/tabs.tsx @@ -17,7 +17,7 @@ interface ResultTabsProps { agentIds?: string[]; startDate?: string; endDate?: string; - isExternal?: true; + addToTimeline?: (payload: { query: [string, string]; isIcon?: true }) => React.ReactElement; } const ResultTabsComponent: React.FC = ({ @@ -25,7 +25,7 @@ const ResultTabsComponent: React.FC = ({ agentIds, endDate, startDate, - isExternal, + addToTimeline, }) => { const tabs = useMemo( () => [ @@ -40,7 +40,7 @@ const ResultTabsComponent: React.FC = ({ agentIds={agentIds} startDate={startDate} endDate={endDate} - isExternal={isExternal} + addToTimeline={addToTimeline} /> ), @@ -60,7 +60,7 @@ const ResultTabsComponent: React.FC = ({ ), }, ], - [actionId, agentIds, endDate, startDate, isExternal] + [actionId, agentIds, endDate, startDate, addToTimeline] ); return ( diff --git a/x-pack/plugins/osquery/public/routes/saved_queries/new/form.tsx b/x-pack/plugins/osquery/public/routes/saved_queries/new/form.tsx index 80899c476f2a3..414cfaabf7f83 100644 --- a/x-pack/plugins/osquery/public/routes/saved_queries/new/form.tsx +++ b/x-pack/plugins/osquery/public/routes/saved_queries/new/form.tsx @@ -13,12 +13,12 @@ import { EuiFlexItem, EuiSpacer, } from '@elastic/eui'; -import React, { useRef } from 'react'; +import React from 'react'; import { FormattedMessage } from '@kbn/i18n-react'; import { useRouterNavigate } from '../../../common/lib/kibana'; import { Form } from '../../../shared_imports'; -import { SavedQueryForm, SavedQueryFormRefObject } from '../../../saved_queries/form'; +import { SavedQueryForm } from '../../../saved_queries/form'; import { useSavedQueryForm } from '../../../saved_queries/form/use_saved_query_form'; interface NewSavedQueryFormProps { @@ -30,19 +30,17 @@ const NewSavedQueryFormComponent: React.FC = ({ defaultValue, handleSubmit, }) => { - const savedQueryFormRef = useRef(null); const savedQueryListProps = useRouterNavigate('saved_queries'); const { form } = useSavedQueryForm({ defaultValue, - savedQueryFormRef, handleSubmit, }); const { submit, isSubmitting, isValid } = form; return ( - + diff --git a/x-pack/plugins/osquery/public/saved_queries/form/index.tsx b/x-pack/plugins/osquery/public/saved_queries/form/index.tsx index cc0aa8ee08ca4..44fae4efd3608 100644 --- a/x-pack/plugins/osquery/public/saved_queries/form/index.tsx +++ b/x-pack/plugins/osquery/public/saved_queries/form/index.tsx @@ -13,25 +13,15 @@ import { EuiText, EuiButtonEmpty, } from '@elastic/eui'; -import React, { - useCallback, - useMemo, - useRef, - forwardRef, - useImperativeHandle, - useState, -} from 'react'; +import React, { useCallback, useMemo, useState } from 'react'; import { i18n } from '@kbn/i18n'; import { FormattedMessage } from '@kbn/i18n-react'; import { ALL_OSQUERY_VERSIONS_OPTIONS } from '../../packs/queries/constants'; import { PlatformCheckBoxGroupField } from '../../packs/queries/platform_checkbox_group_field'; -import { Field, getUseField, UseField, useFormData } from '../../shared_imports'; +import { Field, getUseField, UseField } from '../../shared_imports'; import { CodeEditorField } from './code_editor_field'; -import { - ECSMappingEditorField, - ECSMappingEditorFieldRef, -} from '../../packs/queries/lazy_ecs_mapping_editor_field'; +import { ECSMappingEditorField } from '../../packs/queries/lazy_ecs_mapping_editor_field'; import { PlaygroundFlyout } from './playground_flyout'; export const CommonUseField = getUseField({ component: Field }); @@ -41,131 +31,112 @@ interface SavedQueryFormProps { hasPlayground?: boolean; isValid?: boolean; } -export interface SavedQueryFormRefObject { - validateEcsMapping: ECSMappingEditorFieldRef['validate']; -} -const SavedQueryFormComponent = forwardRef( - ({ viewMode, hasPlayground, isValid }, ref) => { - const [playgroundVisible, setPlaygroundVisible] = useState(false); - const ecsFieldRef = useRef(); - - const euiFieldProps = useMemo( - () => ({ - isDisabled: !!viewMode, - }), - [viewMode] - ); +const SavedQueryFormComponent: React.FC = ({ + viewMode, + hasPlayground, + isValid, +}) => { + const [playgroundVisible, setPlaygroundVisible] = useState(false); - const [{ query }] = useFormData({ watch: ['query'] }); + const euiFieldProps = useMemo( + () => ({ + isDisabled: !!viewMode, + }), + [viewMode] + ); - const handleHidePlayground = useCallback(() => setPlaygroundVisible(false), []); + const handleHidePlayground = useCallback(() => setPlaygroundVisible(false), []); - const handleTogglePlayground = useCallback( - () => setPlaygroundVisible((prevValue) => !prevValue), - [] - ); + const handleTogglePlayground = useCallback( + () => setPlaygroundVisible((prevValue) => !prevValue), + [] + ); - useImperativeHandle( - ref, - () => ({ - validateEcsMapping: () => { - if (ecsFieldRef.current) { - return ecsFieldRef.current.validate(); - } + const intervalEuiFieldProps = useMemo( + () => ({ + append: 's', + ...euiFieldProps, + }), + [euiFieldProps] + ); - return Promise.resolve(false); - }, + const versionEuiFieldProps = useMemo( + () => ({ + noSuggestions: false, + singleSelection: { asPlainText: true }, + placeholder: i18n.translate('xpack.osquery.pack.queriesTable.osqueryVersionAllLabel', { + defaultMessage: 'ALL', }), - [] - ); + options: ALL_OSQUERY_VERSIONS_OPTIONS, + onCreateOption: undefined, + ...euiFieldProps, + }), + [euiFieldProps] + ); - return ( - <> - - - - - - + return ( + <> + + + + + + + + + + + + {!viewMode && hasPlayground && ( - - + + + Test configuration + - {!viewMode && hasPlayground && ( - - - - Test configuration - - - - )} - - - - -
- -
- - + )} + + + + +
- - - - - - - + + + - - - - - - - - {playgroundVisible && ( - - )} - - ); - } -); + + + + + + + + + + + + + + + {playgroundVisible && ( + + )} + + ); +}; + +SavedQueryFormComponent.displayName = 'SavedQueryForm'; export const SavedQueryForm = React.memo(SavedQueryFormComponent); diff --git a/x-pack/plugins/osquery/public/saved_queries/form/playground_flyout.tsx b/x-pack/plugins/osquery/public/saved_queries/form/playground_flyout.tsx index 60f1dff400867..b5af2652fd110 100644 --- a/x-pack/plugins/osquery/public/saved_queries/form/playground_flyout.tsx +++ b/x-pack/plugins/osquery/public/saved_queries/form/playground_flyout.tsx @@ -6,7 +6,7 @@ */ import { EuiFlyout, EuiFlyoutHeader, EuiTitle, EuiFlyoutBody } from '@elastic/eui'; -import React from 'react'; +import React, { useMemo } from 'react'; import styled from 'styled-components'; import { FormattedMessage } from '@kbn/i18n-react'; @@ -26,11 +26,14 @@ interface PlaygroundFlyoutProps { } const PlaygroundFlyoutComponent: React.FC = ({ enabled, onClose }) => { - // eslint-disable-next-line @typescript-eslint/naming-convention - const [{ query, ecs_mapping, id }] = useFormData({ + const [{ query, ecs_mapping: ecsMapping, id }, formDataSerializer] = useFormData({ watch: ['query', 'ecs_mapping', 'savedQueryId'], }); + /* recalculate the form data when ecs_mapping changes */ + // eslint-disable-next-line react-hooks/exhaustive-deps + const serializedFormData = useMemo(() => formDataSerializer(), [ecsMapping, formDataSerializer]); + return ( @@ -48,7 +51,7 @@ const PlaygroundFlyoutComponent: React.FC = ({ enabled, o enabled={enabled && query !== ''} formType="simple" query={query} - ecs_mapping={ecs_mapping} + ecs_mapping={serializedFormData.ecs_mapping} savedQueryId={id} queryField={false} ecsMappingField={false} diff --git a/x-pack/plugins/osquery/public/saved_queries/form/use_saved_query_form.tsx b/x-pack/plugins/osquery/public/saved_queries/form/use_saved_query_form.tsx index bf4123fd86128..6da252f78aedf 100644 --- a/x-pack/plugins/osquery/public/saved_queries/form/use_saved_query_form.tsx +++ b/x-pack/plugins/osquery/public/saved_queries/form/use_saved_query_form.tsx @@ -8,27 +8,22 @@ import { isArray, isEmpty, map } from 'lodash'; import uuid from 'uuid'; import { produce } from 'immer'; -import { RefObject, useMemo } from 'react'; +import { useMemo } from 'react'; +import { convertECSMappingToObject } from '../../../common/schemas/common/utils'; import { useForm } from '../../shared_imports'; import { createFormSchema } from '../../packs/queries/schema'; import { PackFormData } from '../../packs/queries/use_pack_query_form'; import { useSavedQueries } from '../use_saved_queries'; -import { SavedQueryFormRefObject } from '.'; const SAVED_QUERY_FORM_ID = 'savedQueryForm'; interface UseSavedQueryFormProps { defaultValue?: unknown; handleSubmit: (payload: unknown) => Promise; - savedQueryFormRef: RefObject; } -export const useSavedQueryForm = ({ - defaultValue, - handleSubmit, - savedQueryFormRef, -}: UseSavedQueryFormProps) => { +export const useSavedQueryForm = ({ defaultValue, handleSubmit }: UseSavedQueryFormProps) => { const { data } = useSavedQueries({}); const ids: string[] = useMemo( () => map(data?.saved_objects, 'attributes.id') ?? [], @@ -50,14 +45,9 @@ export const useSavedQueryForm = ({ id: SAVED_QUERY_FORM_ID + uuid.v4(), schema: formSchema, onSubmit: async (formData, isValid) => { - const ecsFieldValue = await savedQueryFormRef?.current?.validateEcsMapping(); - - if (isValid && !!ecsFieldValue) { + if (isValid) { try { - await handleSubmit({ - ...formData, - ecs_mapping: ecsFieldValue, - }); + await handleSubmit(formData); // eslint-disable-next-line no-empty } catch (e) {} } @@ -82,9 +72,12 @@ export const useSavedQueryForm = ({ } } - if (isEmpty(draft.ecs_mapping)) { + if (isEmpty(payload.ecs_mapping)) { // @ts-expect-error update types delete draft.ecs_mapping; + } else { + // @ts-expect-error update types + draft.ecs_mapping = convertECSMappingToObject(payload.ecs_mapping); } // @ts-expect-error update types @@ -103,7 +96,16 @@ export const useSavedQueryForm = ({ interval: payload.interval ?? 3600, platform: payload.platform, version: payload.version ? [payload.version] : [], - ecs_mapping: payload.ecs_mapping ?? {}, + ecs_mapping: + (!isEmpty(payload.ecs_mapping) && + map(payload.ecs_mapping, (value, key) => ({ + key, + result: { + type: Object.keys(value)[0], + value: Object.values(value)[0], + }, + }))) ?? + [], }; }, }); diff --git a/x-pack/plugins/osquery/public/saved_queries/saved_queries_dropdown.tsx b/x-pack/plugins/osquery/public/saved_queries/saved_queries_dropdown.tsx index 4d352b7fd2516..eec949fbe312b 100644 --- a/x-pack/plugins/osquery/public/saved_queries/saved_queries_dropdown.tsx +++ b/x-pack/plugins/osquery/public/saved_queries/saved_queries_dropdown.tsx @@ -12,7 +12,6 @@ import { SimpleSavedObject } from '@kbn/core/public'; import { i18n } from '@kbn/i18n'; import { FormattedMessage } from '@kbn/i18n-react'; import styled from 'styled-components'; -import deepEqual from 'fast-deep-equal'; import { useSavedQueries } from './use_saved_queries'; import { useFormData } from '../shared_imports'; @@ -47,10 +46,7 @@ const SavedQueriesDropdownComponent: React.FC = ({ }) => { const [selectedOptions, setSelectedOptions] = useState([]); - // eslint-disable-next-line @typescript-eslint/naming-convention - const [{ query, ecs_mapping, savedQueryId }] = useFormData({ - watch: ['ecs_mapping', 'query', 'savedQueryId'], - }); + const [{ savedQueryId }] = useFormData(); const { data } = useSavedQueries({}); @@ -122,15 +118,11 @@ const SavedQueriesDropdownComponent: React.FC = ({ if ( selectedOptions.length && // @ts-expect-error update types - (selectedOptions[0].value.savedQueryId !== savedQueryId || - // @ts-expect-error update types - selectedOptions[0].value.query !== query || - // @ts-expect-error update types - !deepEqual(selectedOptions[0].value.ecs_mapping, ecs_mapping)) + selectedOptions[0].value.savedQueryId !== savedQueryId ) { setSelectedOptions([]); } - }, [ecs_mapping, query, savedQueryId, selectedOptions]); + }, [savedQueryId, selectedOptions]); return ( void; - isExternal?: true; + isExternal?: boolean; } const additionalZIndexStyle = { style: 'z-index: 6000' }; @@ -38,7 +38,6 @@ const SavedQueryFlyoutComponent: React.FC = ({ onClose, isExternal, }) => { - const savedQueryFormRef = useRef(null); const createSavedQueryMutation = useCreateSavedQuery({ withRedirect: false }); const handleSubmit = useCallback( @@ -48,7 +47,6 @@ const SavedQueryFlyoutComponent: React.FC = ({ const { form } = useSavedQueryForm({ defaultValue, - savedQueryFormRef, handleSubmit, }); const { submit, isSubmitting } = form; @@ -60,7 +58,7 @@ const SavedQueryFlyoutComponent: React.FC = ({ ownFocus onClose={onClose} aria-labelledby="flyoutTitle" - maskProps={isExternal && additionalZIndexStyle} // For an edge case to display above the alerts flyout + maskProps={isExternal ? additionalZIndexStyle : undefined} // For an edge case to display above the alerts flyout > @@ -74,7 +72,7 @@ const SavedQueryFlyoutComponent: React.FC = ({ - + diff --git a/x-pack/plugins/osquery/public/shared_components/osquery_action/index.tsx b/x-pack/plugins/osquery/public/shared_components/osquery_action/index.tsx index 5fbc6caedcd15..01285ed69c5d0 100644 --- a/x-pack/plugins/osquery/public/shared_components/osquery_action/index.tsx +++ b/x-pack/plugins/osquery/public/shared_components/osquery_action/index.tsx @@ -8,6 +8,7 @@ import { EuiErrorBoundary, EuiLoadingContent, EuiEmptyPrompt, EuiCode } from '@elastic/eui'; import React, { useMemo } from 'react'; import { QueryClientProvider } from 'react-query'; +import { CoreStart } from '@kbn/core/public'; import { AGENT_STATUS_ERROR, EMPTY_PROMPT, @@ -22,14 +23,21 @@ import { queryClient } from '../../query_client'; import { OsqueryIcon } from '../../components/osquery_icon'; import { KibanaThemeProvider } from '../../shared_imports'; import { useIsOsqueryAvailable } from './use_is_osquery_available'; +import { StartPlugins } from '../../types'; interface OsqueryActionProps { agentId?: string; formType: 'steps' | 'simple'; - isExternal?: true; + hideAgentsField?: boolean; + addToTimeline?: (payload: { query: [string, string]; isIcon?: true }) => React.ReactElement; } -const OsqueryActionComponent: React.FC = ({ agentId, formType = 'simple' }) => { +const OsqueryActionComponent: React.FC = ({ + agentId, + formType = 'simple', + hideAgentsField, + addToTimeline, +}) => { const permissions = useKibana().services.application.capabilities.osquery; const emptyPrompt = useMemo( @@ -99,18 +107,37 @@ const OsqueryActionComponent: React.FC = ({ agentId, formTyp ); } - return ; + return ( + + ); }; export const OsqueryAction = React.memo(OsqueryActionComponent); -// @ts-expect-error update types -const OsqueryActionWrapperComponent = ({ services, agentId, formType, isExternal }) => ( +type OsqueryActionWrapperProps = { services: CoreStart & StartPlugins } & OsqueryActionProps; + +const OsqueryActionWrapperComponent: React.FC = ({ + services, + agentId, + formType, + hideAgentsField = false, + addToTimeline, +}) => ( - + diff --git a/x-pack/plugins/osquery/public/shared_components/osquery_action/osquery_action.test.tsx b/x-pack/plugins/osquery/public/shared_components/osquery_action/osquery_action.test.tsx index f6128642ba645..4c9214ca3ea14 100644 --- a/x-pack/plugins/osquery/public/shared_components/osquery_action/osquery_action.test.tsx +++ b/x-pack/plugins/osquery/public/shared_components/osquery_action/osquery_action.test.tsx @@ -78,35 +78,27 @@ describe('Osquery Action', () => { spyOsquery(); mockKibana(); - const { getByText } = renderWithContext( - - ); + const { getByText } = renderWithContext(); expect(getByText(EMPTY_PROMPT)).toBeInTheDocument(); }); it('should return empty prompt when no agentId', async () => { spyOsquery(); mockKibana(); - const { getByText } = renderWithContext( - - ); + const { getByText } = renderWithContext(); expect(getByText(EMPTY_PROMPT)).toBeInTheDocument(); }); it('should return permission denied when agentFetched and agentData available', async () => { spyOsquery({ agentData: {} }); mockKibana(); - const { getByText } = renderWithContext( - - ); + const { getByText } = renderWithContext(); expect(getByText(PERMISSION_DENIED)).toBeInTheDocument(); }); it('should return agent status error when permissions are ok and agent status is wrong', async () => { spyOsquery({ agentData: {} }); mockKibana(properPermissions); - const { getByText } = renderWithContext( - - ); + const { getByText } = renderWithContext(); expect(getByText(AGENT_STATUS_ERROR)).toBeInTheDocument(); }); it('should return permission denied if just one permission (runSavedQueries) is available', async () => { @@ -116,9 +108,7 @@ describe('Osquery Action', () => { runSavedQueries: true, }, }); - const { getByText } = renderWithContext( - - ); + const { getByText } = renderWithContext(); expect(getByText(PERMISSION_DENIED)).toBeInTheDocument(); }); it('should return permission denied if just one permission (readSavedQueries) is available', async () => { @@ -128,9 +118,7 @@ describe('Osquery Action', () => { readSavedQueries: true, }, }); - const { getByText } = renderWithContext( - - ); + const { getByText } = renderWithContext(); expect(getByText(PERMISSION_DENIED)).toBeInTheDocument(); }); it('should return permission denied if no writeLiveQueries', async () => { @@ -140,9 +128,7 @@ describe('Osquery Action', () => { writeLiveQueries: true, }, }); - const { getByText } = renderWithContext( - - ); + const { getByText } = renderWithContext(); expect(getByText(AGENT_STATUS_ERROR)).toBeInTheDocument(); }); it('should return not available prompt if osquery is not available', async () => { @@ -152,9 +138,7 @@ describe('Osquery Action', () => { writeLiveQueries: true, }, }); - const { getByText } = renderWithContext( - - ); + const { getByText } = renderWithContext(); expect(getByText(NOT_AVAILABLE)).toBeInTheDocument(); }); it('should not return any errors when all data is ok', async () => { @@ -162,7 +146,7 @@ describe('Osquery Action', () => { mockKibana(properPermissions); const { queryByText } = renderWithContext( - + ); expect(queryByText(EMPTY_PROMPT)).not.toBeInTheDocument(); expect(queryByText(PERMISSION_DENIED)).not.toBeInTheDocument(); diff --git a/x-pack/plugins/osquery/public/shared_imports.ts b/x-pack/plugins/osquery/public/shared_imports.ts index 4e08bcd46d9ee..843cc512826c6 100644 --- a/x-pack/plugins/osquery/public/shared_imports.ts +++ b/x-pack/plugins/osquery/public/shared_imports.ts @@ -23,6 +23,8 @@ export { Form, FormDataProvider, UseArray, + ArrayItem, + FormArrayField, UseField, UseMultiFields, useForm, diff --git a/x-pack/plugins/osquery/tsconfig.json b/x-pack/plugins/osquery/tsconfig.json index 5c70e5ffbb944..4eac1baa43d79 100644 --- a/x-pack/plugins/osquery/tsconfig.json +++ b/x-pack/plugins/osquery/tsconfig.json @@ -24,7 +24,6 @@ // requiredPlugins from ./kibana.json { "path": "../../../src/plugins/data/tsconfig.json" }, { "path": "../../../src/plugins/navigation/tsconfig.json" }, - { "path": "../data_enhanced/tsconfig.json" }, { "path": "../fleet/tsconfig.json" }, // optionalPlugins from ./kibana.json diff --git a/x-pack/plugins/runtime_fields/public/types.ts b/x-pack/plugins/runtime_fields/public/types.ts index 3cd8506c01b10..b39e5e2ee5e6d 100644 --- a/x-pack/plugins/runtime_fields/public/types.ts +++ b/x-pack/plugins/runtime_fields/public/types.ts @@ -5,8 +5,6 @@ * 2.0. */ -import { DataPublicPluginStart } from '@kbn/data-plugin/public'; - import { RUNTIME_FIELD_TYPES } from './constants'; import { OpenRuntimeFieldEditorProps } from './load_editor'; @@ -24,9 +22,8 @@ export interface PluginStart {} // eslint-disable-next-line @typescript-eslint/no-empty-interface export interface SetupPlugins {} -export interface StartPlugins { - data: DataPublicPluginStart; -} +// eslint-disable-next-line @typescript-eslint/no-empty-interface +export interface StartPlugins {} export type RuntimeType = typeof RUNTIME_FIELD_TYPES[number]; diff --git a/x-pack/plugins/saved_objects_tagging/server/index.ts b/x-pack/plugins/saved_objects_tagging/server/index.ts index 5f731c77caac7..b9fcdcdbb7b4e 100644 --- a/x-pack/plugins/saved_objects_tagging/server/index.ts +++ b/x-pack/plugins/saved_objects_tagging/server/index.ts @@ -9,6 +9,13 @@ import { PluginInitializerContext } from '@kbn/core/server'; import { SavedObjectTaggingPlugin } from './plugin'; export { config } from './config'; +export type { + SavedObjectTaggingStart, + CreateTagAssignmentServiceOptions, + CreateTagClientOptions, +} from './types'; +export type { IAssignmentService } from './services'; +export type { ITagsClient } from '../common'; export const plugin = (initializerContext: PluginInitializerContext) => new SavedObjectTaggingPlugin(); diff --git a/x-pack/plugins/saved_objects_tagging/server/mocks.ts b/x-pack/plugins/saved_objects_tagging/server/mocks.ts new file mode 100644 index 0000000000000..6e1b456090dd4 --- /dev/null +++ b/x-pack/plugins/saved_objects_tagging/server/mocks.ts @@ -0,0 +1,28 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import type { SavedObjectTaggingStart } from './types'; +import { tagsClientMock } from './services/tags/tags_client.mock'; +import { assigmentServiceMock } from './services/assignments/assignment_service.mock'; + +const createStartMock = () => { + const start: jest.Mocked = { + createTagClient: jest.fn(), + createInternalAssignmentService: jest.fn(), + }; + + start.createTagClient.mockImplementation(() => tagsClientMock.create()); + start.createInternalAssignmentService.mockImplementation(() => assigmentServiceMock.create()); + + return start; +}; + +export const savedObjectsTaggingMock = { + createStartContract: createStartMock, + createTagClient: tagsClientMock.create, + createAssignmentService: assigmentServiceMock.create, +}; diff --git a/x-pack/plugins/saved_objects_tagging/server/plugin.test.ts b/x-pack/plugins/saved_objects_tagging/server/plugin.test.ts index a62952937bc21..78cd2cd1f1f95 100644 --- a/x-pack/plugins/saved_objects_tagging/server/plugin.test.ts +++ b/x-pack/plugins/saved_objects_tagging/server/plugin.test.ts @@ -41,7 +41,7 @@ describe('SavedObjectTaggingPlugin', () => { it('registers the globalSearch route handler context', async () => { const coreSetup = coreMock.createSetup(); - await plugin.setup(coreSetup, { features: featuresPluginSetup }); + plugin.setup(coreSetup, { features: featuresPluginSetup }); expect(coreSetup.http.registerRouteHandlerContext).toHaveBeenCalledTimes(1); expect(coreSetup.http.registerRouteHandlerContext).toHaveBeenCalledWith( 'tags', @@ -50,7 +50,7 @@ describe('SavedObjectTaggingPlugin', () => { }); it('registers the `savedObjectsTagging` feature', async () => { - await plugin.setup(coreMock.createSetup(), { features: featuresPluginSetup }); + plugin.setup(coreMock.createSetup(), { features: featuresPluginSetup }); expect(featuresPluginSetup.registerKibanaFeature).toHaveBeenCalledTimes(1); expect(featuresPluginSetup.registerKibanaFeature).toHaveBeenCalledWith( savedObjectsTaggingFeature @@ -61,7 +61,7 @@ describe('SavedObjectTaggingPlugin', () => { const tagUsageCollector = Symbol('saved_objects_tagging'); createTagUsageCollectorMock.mockReturnValue(tagUsageCollector); - await plugin.setup(coreMock.createSetup(), { + plugin.setup(coreMock.createSetup(), { features: featuresPluginSetup, usageCollection: usageCollectionSetup, }); @@ -70,4 +70,16 @@ describe('SavedObjectTaggingPlugin', () => { expect(usageCollectionSetup.registerCollector).toHaveBeenCalledWith(tagUsageCollector); }); }); + + describe('#start', () => { + it('returns the expected contract', () => { + plugin.setup(coreMock.createSetup(), { features: featuresPluginSetup }); + const contract = plugin.start(coreMock.createStart(), {}); + + expect(contract).toEqual({ + createTagClient: expect.any(Function), + createInternalAssignmentService: expect.any(Function), + }); + }); + }); }); diff --git a/x-pack/plugins/saved_objects_tagging/server/plugin.ts b/x-pack/plugins/saved_objects_tagging/server/plugin.ts index 05a2bb31514f1..59c40ab4f124b 100644 --- a/x-pack/plugins/saved_objects_tagging/server/plugin.ts +++ b/x-pack/plugins/saved_objects_tagging/server/plugin.ts @@ -8,13 +8,19 @@ import { CoreSetup, CoreStart, Plugin } from '@kbn/core/server'; import { PluginSetupContract as FeaturesPluginSetup } from '@kbn/features-plugin/server'; import { UsageCollectionSetup } from '@kbn/usage-collection-plugin/server'; -import { SecurityPluginSetup } from '@kbn/security-plugin/server'; +import { SecurityPluginSetup, SecurityPluginStart } from '@kbn/security-plugin/server'; import { savedObjectsTaggingFeature } from './features'; import { tagType } from './saved_objects'; -import type { TagsHandlerContext } from './types'; +import type { + TagsHandlerContext, + SavedObjectTaggingStart, + CreateTagClientOptions, + CreateTagAssignmentServiceOptions, +} from './types'; import { TagsRequestHandlerContext } from './request_handler_context'; import { registerRoutes } from './routes'; import { createTagUsageCollector } from './usage'; +import { TagsClient, AssignmentService } from './services'; interface SetupDeps { features: FeaturesPluginSetup; @@ -22,7 +28,13 @@ interface SetupDeps { security?: SecurityPluginSetup; } -export class SavedObjectTaggingPlugin implements Plugin<{}, {}, SetupDeps, {}> { +interface StartDeps { + security?: SecurityPluginStart; +} + +export class SavedObjectTaggingPlugin + implements Plugin<{}, SavedObjectTaggingStart, SetupDeps, StartDeps> +{ public setup( { savedObjects, http }: CoreSetup, { features, usageCollection, security }: SetupDeps @@ -53,7 +65,19 @@ export class SavedObjectTaggingPlugin implements Plugin<{}, {}, SetupDeps, {}> { return {}; } - public start(core: CoreStart) { - return {}; + public start(core: CoreStart, { security }: StartDeps) { + return { + createTagClient: ({ client }: CreateTagClientOptions) => { + return new TagsClient({ client }); + }, + createInternalAssignmentService: ({ client }: CreateTagAssignmentServiceOptions) => { + return new AssignmentService({ + client, + authorization: security?.authz, + typeRegistry: core.savedObjects.getTypeRegistry(), + internal: true, + }); + }, + }; } } diff --git a/x-pack/plugins/saved_objects_tagging/server/services/assignments/assignment_service.test.ts b/x-pack/plugins/saved_objects_tagging/server/services/assignments/assignment_service.test.ts index 3cc4c00da5b30..61e4fbc2fb651 100644 --- a/x-pack/plugins/saved_objects_tagging/server/services/assignments/assignment_service.test.ts +++ b/x-pack/plugins/saved_objects_tagging/server/services/assignments/assignment_service.test.ts @@ -28,245 +28,350 @@ describe('AssignmentService', () => { authorization = securityMock.createSetup().authz; savedObjectClient = savedObjectsClientMock.create(); typeRegistry = savedObjectsTypeRegistryMock.create(); - - service = new AssignmentService({ - request, - typeRegistry, - authorization, - client: savedObjectClient, - }); }); afterEach(() => { getUpdatableSavedObjectTypesMock.mockReset(); }); - describe('#updateTagAssignments', () => { + describe('scoped service', () => { beforeEach(() => { - getUpdatableSavedObjectTypesMock.mockImplementation(({ types }) => Promise.resolve(types)); - - savedObjectClient.bulkGet.mockResolvedValue({ - saved_objects: [], + service = new AssignmentService({ + request, + typeRegistry, + authorization, + client: savedObjectClient, }); }); - it('throws an error if trying to assign non-taggable types', async () => { - await expect( - service.updateTagAssignments({ - tags: ['tag-1', 'tag-2'], - assign: [ - { type: 'dashboard', id: 'dash-1' }, - { type: 'not-supported', id: 'foo' }, - ], - unassign: [], - }) - ).rejects.toThrowErrorMatchingInlineSnapshot(`"Unsupported type [not-supported]"`); + it('throws when instantiated with `internal: false` if no request is provided', () => { + expect(() => { + new AssignmentService({ + internal: false, + typeRegistry, + authorization, + client: savedObjectClient, + }); + }).toThrowErrorMatchingInlineSnapshot(`"request required for non-internal usages"`); }); - it('throws an error if trying to assign non-assignable types', async () => { - getUpdatableSavedObjectTypesMock.mockResolvedValue(['dashboard']); + describe('#updateTagAssignments', () => { + beforeEach(() => { + getUpdatableSavedObjectTypesMock.mockImplementation(({ types }) => Promise.resolve(types)); + + savedObjectClient.bulkGet.mockResolvedValue({ + saved_objects: [], + }); + }); + + it('throws an error if trying to assign non-taggable types', async () => { + await expect( + service.updateTagAssignments({ + tags: ['tag-1', 'tag-2'], + assign: [ + { type: 'dashboard', id: 'dash-1' }, + { type: 'not-supported', id: 'foo' }, + ], + unassign: [], + }) + ).rejects.toThrowErrorMatchingInlineSnapshot(`"Unsupported type [not-supported]"`); + }); - await expect( - service.updateTagAssignments({ + it('throws an error if trying to assign non-assignable types', async () => { + getUpdatableSavedObjectTypesMock.mockResolvedValue(['dashboard']); + + await expect( + service.updateTagAssignments({ + tags: ['tag-1', 'tag-2'], + assign: [ + { type: 'dashboard', id: 'dash-1' }, + { type: 'map', id: 'map-1' }, + ], + unassign: [], + }) + ).rejects.toThrowErrorMatchingInlineSnapshot(`"Forbidden type [map]"`); + }); + + it('calls `soClient.bulkGet` with the correct parameters', async () => { + await service.updateTagAssignments({ tags: ['tag-1', 'tag-2'], - assign: [ - { type: 'dashboard', id: 'dash-1' }, - { type: 'map', id: 'map-1' }, - ], - unassign: [], - }) - ).rejects.toThrowErrorMatchingInlineSnapshot(`"Forbidden type [map]"`); - }); + assign: [{ type: 'dashboard', id: 'dash-1' }], + unassign: [{ type: 'map', id: 'map-1' }], + }); - it('calls `soClient.bulkGet` with the correct parameters', async () => { - await service.updateTagAssignments({ - tags: ['tag-1', 'tag-2'], - assign: [{ type: 'dashboard', id: 'dash-1' }], - unassign: [{ type: 'map', id: 'map-1' }], + expect(savedObjectClient.bulkGet).toHaveBeenCalledTimes(1); + expect(savedObjectClient.bulkGet).toHaveBeenCalledWith([ + { type: 'dashboard', id: 'dash-1', fields: [] }, + { type: 'map', id: 'map-1', fields: [] }, + ]); }); - expect(savedObjectClient.bulkGet).toHaveBeenCalledTimes(1); - expect(savedObjectClient.bulkGet).toHaveBeenCalledWith([ - { type: 'dashboard', id: 'dash-1', fields: [] }, - { type: 'map', id: 'map-1', fields: [] }, - ]); - }); + it('throws an error if any result from `soClient.bulkGet` has an error', async () => { + savedObjectClient.bulkGet.mockResolvedValue({ + saved_objects: [ + createSavedObject({ type: 'dashboard', id: 'dash-1' }), + createSavedObject({ + type: 'map', + id: 'map-1', + error: { + statusCode: 404, + message: 'not found', + error: 'object was not found', + }, + }), + ], + }); - it('throws an error if any result from `soClient.bulkGet` has an error', async () => { - savedObjectClient.bulkGet.mockResolvedValue({ - saved_objects: [ - createSavedObject({ type: 'dashboard', id: 'dash-1' }), - createSavedObject({ - type: 'map', - id: 'map-1', - error: { - statusCode: 404, - message: 'not found', - error: 'object was not found', - }, - }), - ], + await expect( + service.updateTagAssignments({ + tags: ['tag-1', 'tag-2'], + assign: [{ type: 'dashboard', id: 'dash-1' }], + unassign: [{ type: 'map', id: 'map-1' }], + }) + ).rejects.toThrowErrorMatchingInlineSnapshot(`"not found"`); }); - await expect( - service.updateTagAssignments({ + it('calls `soClient.bulkUpdate` to update the references', async () => { + savedObjectClient.bulkGet.mockResolvedValue({ + saved_objects: [ + createSavedObject({ + type: 'dashboard', + id: 'dash-1', + references: [], + }), + createSavedObject({ + type: 'map', + id: 'map-1', + references: [createReference('dashboard', 'dash-1'), createReference('tag', 'tag-1')], + }), + ], + }); + + await service.updateTagAssignments({ tags: ['tag-1', 'tag-2'], assign: [{ type: 'dashboard', id: 'dash-1' }], unassign: [{ type: 'map', id: 'map-1' }], - }) - ).rejects.toThrowErrorMatchingInlineSnapshot(`"not found"`); - }); + }); - it('calls `soClient.bulkUpdate` to update the references', async () => { - savedObjectClient.bulkGet.mockResolvedValue({ - saved_objects: [ - createSavedObject({ + expect(savedObjectClient.bulkUpdate).toHaveBeenCalledTimes(1); + expect(savedObjectClient.bulkUpdate).toHaveBeenCalledWith([ + { type: 'dashboard', id: 'dash-1', - references: [], - }), - createSavedObject({ + attributes: {}, + references: [createReference('tag', 'tag-1'), createReference('tag', 'tag-2')], + }, + { type: 'map', id: 'map-1', - references: [createReference('dashboard', 'dash-1'), createReference('tag', 'tag-1')], - }), - ], + attributes: {}, + references: [createReference('dashboard', 'dash-1')], + }, + ]); }); + }); - await service.updateTagAssignments({ - tags: ['tag-1', 'tag-2'], - assign: [{ type: 'dashboard', id: 'dash-1' }], - unassign: [{ type: 'map', id: 'map-1' }], + describe('#findAssignableObjects', () => { + beforeEach(() => { + getUpdatableSavedObjectTypesMock.mockImplementation(({ types }) => Promise.resolve(types)); + typeRegistry.getType.mockImplementation( + (name) => + ({ + management: { + defaultSearchField: `${name}-search-field`, + }, + } as any) + ); + savedObjectClient.find.mockResolvedValue({ + saved_objects: [], + total: 0, + page: 1, + per_page: 20, + }); }); - expect(savedObjectClient.bulkUpdate).toHaveBeenCalledTimes(1); - expect(savedObjectClient.bulkUpdate).toHaveBeenCalledWith([ - { - type: 'dashboard', - id: 'dash-1', - attributes: {}, - references: [createReference('tag', 'tag-1'), createReference('tag', 'tag-2')], - }, - { - type: 'map', - id: 'map-1', - attributes: {}, - references: [createReference('dashboard', 'dash-1')], - }, - ]); - }); - }); + it('calls `soClient.find` with the correct parameters', async () => { + await service.findAssignableObjects({ + types: ['dashboard', 'map'], + search: 'term', + maxResults: 20, + }); - describe('#findAssignableObjects', () => { - beforeEach(() => { - getUpdatableSavedObjectTypesMock.mockImplementation(({ types }) => Promise.resolve(types)); - typeRegistry.getType.mockImplementation( - (name) => - ({ - management: { - defaultSearchField: `${name}-search-field`, - }, - } as any) - ); - savedObjectClient.find.mockResolvedValue({ - saved_objects: [], - total: 0, - page: 1, - per_page: 20, + expect(savedObjectClient.find).toHaveBeenCalledTimes(1); + expect(savedObjectClient.find).toHaveBeenCalledWith({ + page: 1, + perPage: 20, + search: 'term', + type: ['dashboard', 'map'], + searchFields: ['dashboard-search-field', 'map-search-field'], + }); }); - }); - it('calls `soClient.find` with the correct parameters', async () => { - await service.findAssignableObjects({ - types: ['dashboard', 'map'], - search: 'term', - maxResults: 20, + it('filters the non-assignable types', async () => { + getUpdatableSavedObjectTypesMock.mockResolvedValue(['dashboard']); + + await service.findAssignableObjects({ + types: ['dashboard', 'map'], + search: 'term', + maxResults: 20, + }); + + expect(savedObjectClient.find).toHaveBeenCalledTimes(1); + expect(savedObjectClient.find).toHaveBeenCalledWith( + expect.objectContaining({ + type: ['dashboard'], + }) + ); }); - expect(savedObjectClient.find).toHaveBeenCalledTimes(1); - expect(savedObjectClient.find).toHaveBeenCalledWith({ - page: 1, - perPage: 20, - search: 'term', - type: ['dashboard', 'map'], - searchFields: ['dashboard-search-field', 'map-search-field'], + it('converts the results returned from `soClient.find`', async () => { + savedObjectClient.find.mockResolvedValue({ + saved_objects: [ + createSavedObject({ + type: 'dashboard', + id: 'dash-1', + }), + createSavedObject({ + type: 'map', + id: 'dash-2', + }), + ] as any[], + total: 2, + page: 1, + per_page: 20, + }); + + const results = await service.findAssignableObjects({ + types: ['dashboard', 'map'], + search: 'term', + maxResults: 20, + }); + + expect(results.map(({ type, id }) => ({ type, id }))).toEqual([ + { type: 'dashboard', id: 'dash-1' }, + { type: 'map', id: 'dash-2' }, + ]); }); }); - it('filters the non-assignable types', async () => { - getUpdatableSavedObjectTypesMock.mockResolvedValue(['dashboard']); + describe('#getAssignableTypes', () => { + it('calls `getUpdatableSavedObjectTypes` with the correct parameters', async () => { + await service.getAssignableTypes(['type-a', 'type-b']); - await service.findAssignableObjects({ - types: ['dashboard', 'map'], - search: 'term', - maxResults: 20, + expect(getUpdatableSavedObjectTypesMock).toHaveBeenCalledTimes(1); + expect(getUpdatableSavedObjectTypesMock).toHaveBeenCalledWith({ + request, + authorization, + types: ['type-a', 'type-b'], + }); }); + it('calls `getUpdatableSavedObjectTypes` with `taggableTypes` when `types` is not specified ', async () => { + await service.getAssignableTypes(); - expect(savedObjectClient.find).toHaveBeenCalledTimes(1); - expect(savedObjectClient.find).toHaveBeenCalledWith( - expect.objectContaining({ - type: ['dashboard'], - }) - ); + expect(getUpdatableSavedObjectTypesMock).toHaveBeenCalledTimes(1); + expect(getUpdatableSavedObjectTypesMock).toHaveBeenCalledWith({ + request, + authorization, + types: taggableTypes, + }); + }); + it('forward the result of `getUpdatableSavedObjectTypes`', async () => { + getUpdatableSavedObjectTypesMock.mockReturnValue(['updatable-a', 'updatable-b']); + + const assignableTypes = await service.getAssignableTypes(); + + expect(assignableTypes).toEqual(['updatable-a', 'updatable-b']); + }); }); + }); - it('converts the results returned from `soClient.find`', async () => { - savedObjectClient.find.mockResolvedValue({ - saved_objects: [ - createSavedObject({ - type: 'dashboard', - id: 'dash-1', - }), - createSavedObject({ - type: 'map', - id: 'dash-2', - }), - ] as any[], - total: 2, - page: 1, - per_page: 20, + describe('internal service', () => { + beforeEach(() => { + service = new AssignmentService({ + internal: true, + typeRegistry, + authorization, + client: savedObjectClient, }); + }); - const results = await service.findAssignableObjects({ - types: ['dashboard', 'map'], - search: 'term', - maxResults: 20, + describe('#updateTagAssignments', () => { + beforeEach(() => { + getUpdatableSavedObjectTypesMock.mockImplementation(({ types }) => Promise.resolve(types)); + + savedObjectClient.bulkGet.mockResolvedValue({ + saved_objects: [], + }); }); - expect(results.map(({ type, id }) => ({ type, id }))).toEqual([ - { type: 'dashboard', id: 'dash-1' }, - { type: 'map', id: 'dash-2' }, - ]); - }); - }); + it('does not calls `getUpdatableSavedObjectTypes`', async () => { + getUpdatableSavedObjectTypesMock.mockResolvedValue(['dashboard']); - describe('#getAssignableTypes', () => { - it('calls `getUpdatableSavedObjectTypes` with the correct parameters', async () => { - await service.getAssignableTypes(['type-a', 'type-b']); + await service.updateTagAssignments({ + tags: ['tag-1', 'tag-2'], + assign: [ + { type: 'dashboard', id: 'dash-1' }, + { type: 'map', id: 'map-1' }, + ], + unassign: [], + }); - expect(getUpdatableSavedObjectTypesMock).toHaveBeenCalledTimes(1); - expect(getUpdatableSavedObjectTypesMock).toHaveBeenCalledWith({ - request, - authorization, - types: ['type-a', 'type-b'], + expect(getUpdatableSavedObjectTypesMock).not.toHaveBeenCalled(); + expect(savedObjectClient.bulkGet).toHaveBeenCalledTimes(1); + expect(savedObjectClient.bulkGet).toHaveBeenCalledWith([ + { type: 'dashboard', id: 'dash-1', fields: [] }, + { type: 'map', id: 'map-1', fields: [] }, + ]); }); }); - it('calls `getUpdatableSavedObjectTypes` with `taggableTypes` when `types` is not specified ', async () => { - await service.getAssignableTypes(); - expect(getUpdatableSavedObjectTypesMock).toHaveBeenCalledTimes(1); - expect(getUpdatableSavedObjectTypesMock).toHaveBeenCalledWith({ - request, - authorization, - types: taggableTypes, + describe('#findAssignableObjects', () => { + beforeEach(() => { + typeRegistry.getType.mockImplementation( + (name) => + ({ + management: { + defaultSearchField: `${name}-search-field`, + }, + } as any) + ); + savedObjectClient.find.mockResolvedValue({ + saved_objects: [], + total: 0, + page: 1, + per_page: 20, + }); + }); + + it('does not calls `getUpdatableSavedObjectTypes`', async () => { + getUpdatableSavedObjectTypesMock.mockResolvedValue(['dashboard']); + + await service.findAssignableObjects({ + types: ['dashboard', 'map'], + search: 'term', + maxResults: 20, + }); + + expect(getUpdatableSavedObjectTypesMock).not.toHaveBeenCalled(); + expect(savedObjectClient.find).toHaveBeenCalledTimes(1); + expect(savedObjectClient.find).toHaveBeenCalledWith( + expect.objectContaining({ + type: ['dashboard', 'map'], + }) + ); }); }); - it('forward the result of `getUpdatableSavedObjectTypes`', async () => { - getUpdatableSavedObjectTypesMock.mockReturnValue(['updatable-a', 'updatable-b']); - const assignableTypes = await service.getAssignableTypes(); + describe('#getAssignableTypes', () => { + it('does not calls `getUpdatableSavedObjectTypes`', async () => { + await service.getAssignableTypes(['type-a', 'type-b']); - expect(assignableTypes).toEqual(['updatable-a', 'updatable-b']); + expect(getUpdatableSavedObjectTypesMock).not.toHaveBeenCalled(); + }); + it('returns the list of all taggable types', async () => { + const assignableTypes = await service.getAssignableTypes(); + expect(assignableTypes).toEqual(taggableTypes); + }); }); }); }); diff --git a/x-pack/plugins/saved_objects_tagging/server/services/assignments/assignment_service.ts b/x-pack/plugins/saved_objects_tagging/server/services/assignments/assignment_service.ts index d6d14f68357be..09a726db856c2 100644 --- a/x-pack/plugins/saved_objects_tagging/server/services/assignments/assignment_service.ts +++ b/x-pack/plugins/saved_objects_tagging/server/services/assignments/assignment_service.ts @@ -28,10 +28,11 @@ import { AssignmentError } from './errors'; import { toAssignableObject } from './utils'; interface AssignmentServiceOptions { - request: KibanaRequest; + request?: KibanaRequest; client: SavedObjectsClientContract; typeRegistry: ISavedObjectTypeRegistry; authorization?: SecurityPluginSetup['authz']; + internal?: boolean; } export type IAssignmentService = PublicMethodsOf; @@ -40,9 +41,20 @@ export class AssignmentService { private readonly soClient: SavedObjectsClientContract; private readonly typeRegistry: ISavedObjectTypeRegistry; private readonly authorization?: SecurityPluginSetup['authz']; - private readonly request: KibanaRequest; - - constructor({ client, typeRegistry, authorization, request }: AssignmentServiceOptions) { + private readonly request?: KibanaRequest; + private readonly internal: boolean; + + constructor({ + client, + typeRegistry, + authorization, + request, + internal = false, + }: AssignmentServiceOptions) { + if (!internal && !request) { + throw new Error('request required for non-internal usages'); + } + this.internal = internal; this.soClient = client; this.typeRegistry = typeRegistry; this.authorization = authorization; @@ -84,8 +96,11 @@ export class AssignmentService { } public async getAssignableTypes(types?: string[]) { + if (this.internal) { + return types ?? taggableTypes; + } return getUpdatableSavedObjectTypes({ - request: this.request, + request: this.request!, types: types ?? taggableTypes, authorization: this.authorization, }); diff --git a/x-pack/plugins/saved_objects_tagging/server/types.ts b/x-pack/plugins/saved_objects_tagging/server/types.ts index 366f2779b6a81..0bc023214151d 100644 --- a/x-pack/plugins/saved_objects_tagging/server/types.ts +++ b/x-pack/plugins/saved_objects_tagging/server/types.ts @@ -5,7 +5,11 @@ * 2.0. */ -import type { IRouter, CustomRequestHandlerContext } from '@kbn/core/server'; +import type { + IRouter, + CustomRequestHandlerContext, + SavedObjectsClientContract, +} from '@kbn/core/server'; import { ITagsClient } from '../common/types'; import { IAssignmentService } from './services'; @@ -14,6 +18,37 @@ export interface ITagsRequestHandlerContext { assignmentService: IAssignmentService; } +/** @public */ +export interface CreateTagClientOptions { + client: SavedObjectsClientContract; +} + +/** @public */ +export interface CreateTagAssignmentServiceOptions { + client: SavedObjectsClientContract; +} + +/** @public */ +export interface SavedObjectTaggingStart { + /** + * Creates a TagClient bound to the provided SavedObject client. + */ + createTagClient: (options: CreateTagClientOptions) => ITagsClient; + + /** + * Creates an internal AssignmentService bound to the provided SavedObject client. + * + * @remark: As assignment services created via this API will not be performing authz check to ensure + * that the current user is allowed to update the assigned/unassigned objects. + * This API is only meant to be used to perform operations on behalf of the 'internal' Kibana user. + * When trying to assign or unassign tags on behalf of a user, use the `tags` request handler context + * instead. + */ + createInternalAssignmentService: ( + options: CreateTagAssignmentServiceOptions + ) => IAssignmentService; +} + /** * @internal */ diff --git a/x-pack/plugins/security/public/management/roles/edit_role/edit_role_page.test.tsx b/x-pack/plugins/security/public/management/roles/edit_role/edit_role_page.test.tsx index ae64ad4655ba5..72612904f1c08 100644 --- a/x-pack/plugins/security/public/management/roles/edit_role/edit_role_page.test.tsx +++ b/x-pack/plugins/security/public/management/roles/edit_role/edit_role_page.test.tsx @@ -11,7 +11,7 @@ import React from 'react'; import type { Capabilities } from '@kbn/core/public'; import { coreMock, scopedHistoryMock } from '@kbn/core/public/mocks'; -import { dataPluginMock } from '@kbn/data-plugin/public/mocks'; +import { dataViewPluginMocks } from '@kbn/data-views-plugin/public/mocks'; import { KibanaFeature } from '@kbn/features-plugin/public'; import type { Space } from '@kbn/spaces-plugin/public'; import { mountWithIntl, nextTick } from '@kbn/test-jest-helpers'; @@ -139,7 +139,7 @@ function getProps({ const rolesAPIClient = rolesAPIClientMock.create(); rolesAPIClient.getRole.mockResolvedValue(role); - const dataViews = dataPluginMock.createStartContract().dataViews; + const dataViews = dataViewPluginMocks.createStartContract(); // `undefined` titles can technically happen via import/export or other manual manipulation dataViews.getTitles = jest.fn().mockResolvedValue(['foo*', 'bar*', undefined]); @@ -352,7 +352,7 @@ describe('', () => { }); it('can render if index patterns are not available', async () => { - const dataViews = dataPluginMock.createStartContract().dataViews; + const dataViews = dataViewPluginMocks.createStartContract(); dataViews.getTitles = jest.fn().mockRejectedValue({ response: { status: 403 } }); const wrapper = mountWithIntl( diff --git a/x-pack/plugins/security/public/management/roles/edit_role/edit_role_page.tsx b/x-pack/plugins/security/public/management/roles/edit_role/edit_role_page.tsx index 1cda335ace204..cc9803063b860 100644 --- a/x-pack/plugins/security/public/management/roles/edit_role/edit_role_page.tsx +++ b/x-pack/plugins/security/public/management/roles/edit_role/edit_role_page.tsx @@ -31,7 +31,7 @@ import type { NotificationsStart, ScopedHistory, } from '@kbn/core/public'; -import type { DataViewsContract } from '@kbn/data-plugin/public'; +import type { DataViewsContract } from '@kbn/data-views-plugin/public'; import type { KibanaFeature } from '@kbn/features-plugin/common'; import type { FeaturesPluginStart } from '@kbn/features-plugin/public'; import { i18n } from '@kbn/i18n'; diff --git a/x-pack/plugins/security_solution/common/endpoint/data_loaders/index_endpoint_fleet_actions.ts b/x-pack/plugins/security_solution/common/endpoint/data_loaders/index_endpoint_fleet_actions.ts index 369b1fff5fe39..04dce4e60a092 100644 --- a/x-pack/plugins/security_solution/common/endpoint/data_loaders/index_endpoint_fleet_actions.ts +++ b/x-pack/plugins/security_solution/common/endpoint/data_loaders/index_endpoint_fleet_actions.ts @@ -71,6 +71,7 @@ export const indexEndpointAndFleetActionsForHost = async ( { index: AGENT_ACTIONS_INDEX, body: action, + refresh: 'wait_for', }, ES_INDEX_OPTIONS ) @@ -98,6 +99,7 @@ export const indexEndpointAndFleetActionsForHost = async ( .index({ index: ENDPOINT_ACTIONS_INDEX, body: endpointActionsBody, + refresh: 'wait_for', }) .catch(wrapErrorAndRejectPromise), ]); @@ -125,6 +127,7 @@ export const indexEndpointAndFleetActionsForHost = async ( { index: AGENT_ACTIONS_RESULTS_INDEX, body: actionResponse, + refresh: 'wait_for', }, ES_INDEX_OPTIONS ) @@ -159,6 +162,7 @@ export const indexEndpointAndFleetActionsForHost = async ( .index({ index: ENDPOINT_ACTION_RESPONSES_INDEX, body: endpointActionResponseBody, + refresh: 'wait_for', }) .catch(wrapErrorAndRejectPromise), ]); @@ -197,6 +201,7 @@ export const indexEndpointAndFleetActionsForHost = async ( { index: AGENT_ACTIONS_INDEX, body: action, + refresh: 'wait_for', }, ES_INDEX_OPTIONS ) @@ -221,6 +226,7 @@ export const indexEndpointAndFleetActionsForHost = async ( { index: AGENT_ACTIONS_INDEX, body: action1, + refresh: 'wait_for', }, ES_INDEX_OPTIONS ) @@ -230,6 +236,7 @@ export const indexEndpointAndFleetActionsForHost = async ( { index: AGENT_ACTIONS_INDEX, body: action2, + refresh: 'wait_for', }, ES_INDEX_OPTIONS ) diff --git a/x-pack/plugins/security_solution/common/endpoint/data_loaders/index_endpoint_hosts.ts b/x-pack/plugins/security_solution/common/endpoint/data_loaders/index_endpoint_hosts.ts index 7d9d08021fe54..30d75b30a11b6 100644 --- a/x-pack/plugins/security_solution/common/endpoint/data_loaders/index_endpoint_hosts.ts +++ b/x-pack/plugins/security_solution/common/endpoint/data_loaders/index_endpoint_hosts.ts @@ -6,7 +6,7 @@ */ import { Client } from '@elastic/elasticsearch'; -import { cloneDeep, merge } from 'lodash'; +import { cloneDeep } from 'lodash'; import { AxiosResponse } from 'axios'; import uuid from 'uuid'; // eslint-disable-next-line import/no-extraneous-dependencies @@ -35,7 +35,7 @@ import { indexFleetEndpointPolicy, } from './index_fleet_endpoint_policy'; import { metadataCurrentIndexPattern } from '../constants'; -import { EndpointDataLoadingError, wrapErrorAndRejectPromise } from './utils'; +import { EndpointDataLoadingError, mergeAndAppendArrays, wrapErrorAndRejectPromise } from './utils'; export interface IndexedHostsResponse extends IndexedFleetAgentResponse, @@ -141,7 +141,7 @@ export async function indexEndpointHostDocs({ epmEndpointPackage.version ); - merge(response, createdPolicies); + mergeAndAppendArrays(response, createdPolicies); // eslint-disable-next-line require-atomic-updates realPolicies[appliedPolicyId] = createdPolicies.integrationPolicies[0]; @@ -160,11 +160,15 @@ export async function indexEndpointHostDocs({ ); enrolledAgent = indexedAgentResponse.agents[0]; - merge(response, indexedAgentResponse); + mergeAndAppendArrays(response, indexedAgentResponse); } // Update the Host metadata record with the ID of the "real" policy along with the enrolled agent id hostMetadata = { ...hostMetadata, + agent: { + ...hostMetadata.agent, + id: enrolledAgent?.id ?? hostMetadata.agent.id, + }, elastic: { ...hostMetadata.elastic, agent: { @@ -201,6 +205,7 @@ export async function indexEndpointHostDocs({ index: metadataIndex, body: hostMetadata, op_type: 'create', + refresh: 'wait_for', }) .catch(wrapErrorAndRejectPromise); @@ -214,6 +219,7 @@ export async function indexEndpointHostDocs({ index: policyResponseIndex, body: hostPolicyResponse, op_type: 'create', + refresh: 'wait_for', }) .catch(wrapErrorAndRejectPromise); @@ -317,9 +323,9 @@ export const deleteIndexedEndpointHosts = async ( .catch(wrapErrorAndRejectPromise); } - merge(response, await deleteIndexedFleetAgents(esClient, indexedData)); - merge(response, await deleteIndexedEndpointAndFleetActions(esClient, indexedData)); - merge(response, await deleteIndexedFleetEndpointPolicies(kbnClient, indexedData)); + mergeAndAppendArrays(response, await deleteIndexedFleetAgents(esClient, indexedData)); + mergeAndAppendArrays(response, await deleteIndexedEndpointAndFleetActions(esClient, indexedData)); + mergeAndAppendArrays(response, await deleteIndexedFleetEndpointPolicies(kbnClient, indexedData)); return response; }; diff --git a/x-pack/plugins/security_solution/common/endpoint/data_loaders/index_fleet_agent.ts b/x-pack/plugins/security_solution/common/endpoint/data_loaders/index_fleet_agent.ts index 70b1e1c52a77b..b051eff37edc7 100644 --- a/x-pack/plugins/security_solution/common/endpoint/data_loaders/index_fleet_agent.ts +++ b/x-pack/plugins/security_solution/common/endpoint/data_loaders/index_fleet_agent.ts @@ -47,6 +47,7 @@ export const indexFleetAgentForHost = async ( fleetAgentGenerator: FleetAgentGenerator = defaultFleetAgentGenerator ): Promise => { const agentDoc = fleetAgentGenerator.generateEsHit({ + _id: endpointHost.agent.id, _source: { agent: { id: endpointHost.agent.id, @@ -75,6 +76,7 @@ export const indexFleetAgentForHost = async ( id: agentDoc._id, body: agentDoc._source, op_type: 'create', + refresh: 'wait_for', }) .catch(wrapErrorAndRejectPromise); diff --git a/x-pack/plugins/security_solution/common/endpoint/data_loaders/index_fleet_server.ts b/x-pack/plugins/security_solution/common/endpoint/data_loaders/index_fleet_server.ts index c11c2025ee88e..8b8a15a1164e5 100644 --- a/x-pack/plugins/security_solution/common/endpoint/data_loaders/index_fleet_server.ts +++ b/x-pack/plugins/security_solution/common/endpoint/data_loaders/index_fleet_server.ts @@ -31,6 +31,7 @@ export const enableFleetServerIfNecessary = async (esClient: Client, version: st await esClient .index({ index: FLEET_SERVER_SERVERS_INDEX, + refresh: 'wait_for', body: { agent: { id: '12988155-475c-430d-ac89-84dc84b67cd1', diff --git a/x-pack/plugins/security_solution/common/endpoint/data_loaders/utils.ts b/x-pack/plugins/security_solution/common/endpoint/data_loaders/utils.ts index 80a7699e51cf8..fcba3a522a522 100644 --- a/x-pack/plugins/security_solution/common/endpoint/data_loaders/utils.ts +++ b/x-pack/plugins/security_solution/common/endpoint/data_loaders/utils.ts @@ -5,6 +5,8 @@ * 2.0. */ +import { mergeWith } from 'lodash'; + export class EndpointDataLoadingError extends Error { constructor(message: string, public meta?: unknown) { super(message); @@ -18,3 +20,13 @@ export const wrapErrorIfNeeded = (error: Error): EndpointDataLoadingError => // Use it in Promise's `.catch()` as `.catch(wrapErrorAndRejectPromise)` export const wrapErrorAndRejectPromise = (error: Error) => Promise.reject(wrapErrorIfNeeded(error)); + +export const mergeAndAppendArrays = (destinationObj: T, srcObj: S): T => { + const customizer = (objValue: T[keyof T], srcValue: S[keyof S]) => { + if (Array.isArray(objValue)) { + return objValue.concat(srcValue); + } + }; + + return mergeWith(destinationObj, srcObj, customizer); +}; diff --git a/x-pack/plugins/security_solution/common/endpoint/generate_data.ts b/x-pack/plugins/security_solution/common/endpoint/generate_data.ts index a571c7848bdf3..5a6b20550f224 100644 --- a/x-pack/plugins/security_solution/common/endpoint/generate_data.ts +++ b/x-pack/plugins/security_solution/common/endpoint/generate_data.ts @@ -464,16 +464,17 @@ export class EndpointDocGenerator extends BaseDataGenerator { const agentVersion = this.randomVersion(); const minCapabilitiesVersion = '7.15.0'; const capabilities = ['isolation']; + const agentId = this.seededUUIDv4(); return { agent: { version: agentVersion, - id: this.seededUUIDv4(), + id: agentId, type: 'endpoint', }, elastic: { agent: { - id: this.seededUUIDv4(), + id: agentId, }, }, host: { diff --git a/x-pack/plugins/security_solution/common/endpoint/index_data.ts b/x-pack/plugins/security_solution/common/endpoint/index_data.ts index a783c523f07b0..e063f9695e7ed 100644 --- a/x-pack/plugins/security_solution/common/endpoint/index_data.ts +++ b/x-pack/plugins/security_solution/common/endpoint/index_data.ts @@ -10,7 +10,6 @@ import seedrandom from 'seedrandom'; // eslint-disable-next-line import/no-extraneous-dependencies import { KbnClient } from '@kbn/test'; import { AxiosResponse } from 'axios'; -import { merge } from 'lodash'; import { CreatePackagePolicyResponse, EPM_API_ROUTES, @@ -26,6 +25,7 @@ import { import { enableFleetServerIfNecessary } from './data_loaders/index_fleet_server'; import { indexAlerts } from './data_loaders/index_alerts'; import { setupFleetForEndpoint } from './data_loaders/setup_fleet_for_endpoint'; +import { mergeAndAppendArrays } from './data_loaders/utils'; export type IndexedHostsAndAlertsResponse = IndexedHostsResponse; @@ -105,7 +105,7 @@ export async function indexHostsAndAlerts( generator, }); - merge(response, indexedHosts); + mergeAndAppendArrays(response, indexedHosts); await indexAlerts({ client, diff --git a/x-pack/plugins/security_solution/common/endpoint/service/host_isolation/utils.test.ts b/x-pack/plugins/security_solution/common/endpoint/service/host_isolation/utils.test.ts index 8b72fe5deb8f6..48928fb435fec 100644 --- a/x-pack/plugins/security_solution/common/endpoint/service/host_isolation/utils.test.ts +++ b/x-pack/plugins/security_solution/common/endpoint/service/host_isolation/utils.test.ts @@ -8,6 +8,7 @@ import { isVersionSupported, isOsSupported, isIsolationSupported } from './utils'; describe('Host Isolation utils isVersionSupported', () => { + // NOTE: the `7.15.0.8295.0` and the text current versions are invalid. test.each` currentVersion | minVersionRequired | expected ${'8.14.0'} | ${'7.13.0'} | ${true} @@ -22,6 +23,8 @@ describe('Host Isolation utils isVersionSupported', () => { ${'7.14.0-alpha'} | ${'7.14.0'} | ${true} ${'8.0.0-SNAPSHOT'} | ${'7.14.0'} | ${true} ${'8.0.0'} | ${'7.14.0'} | ${true} + ${'7.15.0.8295.0'} | ${'7.14.0'} | ${false} + ${'NOT_SEMVER'} | ${'7.14.0'} | ${false} `( 'should validate that version $a is compatible($expected) to $b', ({ currentVersion, minVersionRequired, expected }) => { diff --git a/x-pack/plugins/security_solution/common/endpoint/service/host_isolation/utils.ts b/x-pack/plugins/security_solution/common/endpoint/service/host_isolation/utils.ts index d012ddfda15ba..0e9404f250786 100644 --- a/x-pack/plugins/security_solution/common/endpoint/service/host_isolation/utils.ts +++ b/x-pack/plugins/security_solution/common/endpoint/service/host_isolation/utils.ts @@ -26,8 +26,20 @@ export const isVersionSupported = ({ currentVersion: string; minVersionRequired?: string; }) => { - const parsedCurrentVersion = parseSemver(currentVersion); - return semverLte(minVersionRequired, parsedCurrentVersion); + // `parseSemver()` will throw if the version provided is not a valid semver value. + // If that happens, then just return false from this function + try { + const parsedCurrentVersion = parseSemver(currentVersion); + return semverLte(minVersionRequired, parsedCurrentVersion); + } catch (e) { + // If running in the browser, log to console + if (window && window.console) { + window.console.warn( + `SecuritySolution: isVersionSupported(): Unable to determine if current version [${currentVersion}] meets minimum version [${minVersionRequired}]. Error: ${e.message}` + ); + } + return false; + } }; export const isOsSupported = ({ diff --git a/x-pack/plugins/security_solution/common/search_strategy/security_solution/users/authentications/index.ts b/x-pack/plugins/security_solution/common/search_strategy/security_solution/users/authentications/index.ts index c412c96204138..be60776e683f4 100644 --- a/x-pack/plugins/security_solution/common/search_strategy/security_solution/users/authentications/index.ts +++ b/x-pack/plugins/security_solution/common/search_strategy/security_solution/users/authentications/index.ts @@ -59,7 +59,7 @@ export interface LastSourceHost { } export interface AuthenticationHit extends Hit { - _source: { + fields: { '@timestamp': string; lastSuccess?: LastSourceHost; lastFailure?: LastSourceHost; diff --git a/x-pack/plugins/security_solution/common/search_strategy/security_solution/users/common/index.ts b/x-pack/plugins/security_solution/common/search_strategy/security_solution/users/common/index.ts index 9b9d3028594d3..9f3a2e94e7e13 100644 --- a/x-pack/plugins/security_solution/common/search_strategy/security_solution/users/common/index.ts +++ b/x-pack/plugins/security_solution/common/search_strategy/security_solution/users/common/index.ts @@ -67,7 +67,7 @@ export interface AllUsersAggEsItem { export interface UsersDomainHitsItem { hits: { hits: Array<{ - _source: { user: { domain: Maybe } }; + fields: { user: { domain: Maybe } }; }>; }; } diff --git a/x-pack/plugins/security_solution/cypress/integration/cases/attach_alert_to_case.spec.ts b/x-pack/plugins/security_solution/cypress/integration/cases/attach_alert_to_case.spec.ts index daf73d2db69d6..cac79b2114dd7 100644 --- a/x-pack/plugins/security_solution/cypress/integration/cases/attach_alert_to_case.spec.ts +++ b/x-pack/plugins/security_solution/cypress/integration/cases/attach_alert_to_case.spec.ts @@ -10,10 +10,9 @@ import { ROLES } from '../../../common/test'; import { expandFirstAlertActions } from '../../tasks/alerts'; import { createCustomRuleEnabled } from '../../tasks/api_calls/rules'; -import { cleanKibana } from '../../tasks/common'; +import { cleanKibana, waitForPageToBeLoaded } from '../../tasks/common'; import { waitForAlertsToPopulate } from '../../tasks/create_new_rule'; import { login, visit, waitForPageWithoutDateRange } from '../../tasks/login'; -import { refreshPage } from '../../tasks/security_header'; import { ALERTS_URL } from '../../urls/navigation'; import { ATTACH_ALERT_TO_CASE_BUTTON, TIMELINE_CONTEXT_MENU_BTN } from '../../screens/alerts'; @@ -27,19 +26,17 @@ describe('Alerts timeline', () => { before(() => { // First we login as a privileged user to create alerts. cleanKibana(); - login(ROLES.platform_engineer); - visit(ALERTS_URL); + login(); createCustomRuleEnabled(getNewRule()); - refreshPage(); + visit(ALERTS_URL); waitForAlertsToPopulate(); - - // Then we login as read-only user to test. - login(ROLES.reader); }); context('Privileges: read only', () => { beforeEach(() => { + login(ROLES.reader); loadDetectionsPage(ROLES.reader); + waitForPageToBeLoaded(); }); it('should not allow user with read only privileges to attach alerts to cases', () => { @@ -50,7 +47,9 @@ describe('Alerts timeline', () => { context('Privileges: can crud', () => { beforeEach(() => { + login(ROLES.platform_engineer); loadDetectionsPage(ROLES.platform_engineer); + waitForPageToBeLoaded(); }); it('should allow a user with crud privileges to attach alerts to cases', () => { diff --git a/x-pack/plugins/security_solution/kibana.json b/x-pack/plugins/security_solution/kibana.json index af0bd12303119..0c72f5af846d7 100644 --- a/x-pack/plugins/security_solution/kibana.json +++ b/x-pack/plugins/security_solution/kibana.json @@ -13,7 +13,6 @@ "alerting", "cases", "data", - "dataEnhanced", "embeddable", "eventLog", "features", diff --git a/x-pack/plugins/security_solution/public/common/containers/query_client/query_client_provider.tsx b/x-pack/plugins/security_solution/public/common/containers/query_client/query_client_provider.tsx index 9d2f9ca9f48fa..2f67dc2734fed 100644 --- a/x-pack/plugins/security_solution/public/common/containers/query_client/query_client_provider.tsx +++ b/x-pack/plugins/security_solution/public/common/containers/query_client/query_client_provider.tsx @@ -8,14 +8,38 @@ import React, { memo, PropsWithChildren, useMemo } from 'react'; import { QueryClient, QueryClientProvider } from 'react-query'; +type QueryClientOptionsProp = ConstructorParameters[0]; + +/** + * A security solution specific react-query query client that sets defaults + */ +export class SecuritySolutionQueryClient extends QueryClient { + constructor(options: QueryClientOptionsProp = {}) { + const optionsWithDefaults: QueryClientOptionsProp = { + ...options, + defaultOptions: { + ...(options.defaultOptions ?? {}), + queries: { + refetchIntervalInBackground: false, + refetchOnWindowFocus: false, + refetchOnMount: true, + keepPreviousData: true, + ...(options?.defaultOptions?.queries ?? {}), + }, + }, + }; + super(optionsWithDefaults); + } +} + export type ReactQueryClientProviderProps = PropsWithChildren<{ - queryClient?: QueryClient; + queryClient?: SecuritySolutionQueryClient; }>; export const ReactQueryClientProvider = memo( ({ queryClient, children }) => { const client = useMemo(() => { - return queryClient || new QueryClient(); + return queryClient || new SecuritySolutionQueryClient(); }, [queryClient]); return {children}; } diff --git a/x-pack/plugins/security_solution/public/common/hooks/eql/use_eql_preview.ts b/x-pack/plugins/security_solution/public/common/hooks/eql/use_eql_preview.ts index 4addd9048a565..20a9ccbefa900 100644 --- a/x-pack/plugins/security_solution/public/common/hooks/eql/use_eql_preview.ts +++ b/x-pack/plugins/security_solution/public/common/hooks/eql/use_eql_preview.ts @@ -17,9 +17,9 @@ import { isPartialResponse, EqlSearchStrategyRequest, EqlSearchStrategyResponse, + EQL_SEARCH_STRATEGY, } from '@kbn/data-plugin/common'; import { AbortError } from '@kbn/kibana-utils-plugin/common'; -import { EQL_SEARCH_STRATEGY } from '@kbn/data-enhanced-plugin/public'; import * as i18n from '../translations'; import { useKibana } from '../../lib/kibana'; import { formatInspect, getEqlAggsData } from './helpers'; diff --git a/x-pack/plugins/security_solution/public/common/lib/triggers_actions_ui/register_alerts_table_configuration.tsx b/x-pack/plugins/security_solution/public/common/lib/triggers_actions_ui/register_alerts_table_configuration.tsx new file mode 100644 index 0000000000000..3a1bcee1eed51 --- /dev/null +++ b/x-pack/plugins/security_solution/public/common/lib/triggers_actions_ui/register_alerts_table_configuration.tsx @@ -0,0 +1,31 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { Storage } from '@kbn/kibana-utils-plugin/public'; +import { AlertsTableConfigurationRegistryContract } from '@kbn/triggers-actions-ui-plugin/public'; + +import { APP_ID } from '../../../../common/constants'; +import { getTimelinesInStorageByIds } from '../../../timelines/containers/local_storage'; +import { TimelineId } from '../../../../common/types'; +import { columns } from '../../../detections/configurations/security_solution_detections'; + +const registerAlertsTableConfiguration = ( + registry: AlertsTableConfigurationRegistryContract, + storage: Storage +) => { + if (registry.has(APP_ID)) { + return; + } + const timelineStorage = getTimelinesInStorageByIds(storage, [TimelineId.detectionsPage]); + const alertColumns = timelineStorage?.[TimelineId.detectionsPage]?.columns ?? columns; + registry.register({ + id: APP_ID, + columns: alertColumns, + }); +}; + +export { registerAlertsTableConfiguration }; diff --git a/x-pack/plugins/security_solution/public/detections/components/host_isolation/use_host_isolation_action.tsx b/x-pack/plugins/security_solution/public/detections/components/host_isolation/use_host_isolation_action.tsx index 57d81d48fca05..62debf400a387 100644 --- a/x-pack/plugins/security_solution/public/detections/components/host_isolation/use_host_isolation_action.tsx +++ b/x-pack/plugins/security_solution/public/detections/components/host_isolation/use_host_isolation_action.tsx @@ -56,11 +56,15 @@ export const useHostIsolationAction = ({ agentId, }); - const isolationSupported = isIsolationSupported({ - osName: hostOsFamily, - version: agentVersion, - capabilities, - }); + const isolationSupported = useMemo(() => { + return isEndpointAlert + ? isIsolationSupported({ + osName: hostOsFamily, + version: agentVersion, + capabilities, + }) + : false; + }, [agentVersion, capabilities, hostOsFamily, isEndpointAlert]); const isIsolationAllowed = useUserPrivileges().endpointPrivileges.canIsolateHost; diff --git a/x-pack/plugins/security_solution/public/detections/components/osquery/osquery_flyout.tsx b/x-pack/plugins/security_solution/public/detections/components/osquery/osquery_flyout.tsx index 3262fc36abf75..f19601649a2f3 100644 --- a/x-pack/plugins/security_solution/public/detections/components/osquery/osquery_flyout.tsx +++ b/x-pack/plugins/security_solution/public/detections/components/osquery/osquery_flyout.tsx @@ -5,13 +5,20 @@ * 2.0. */ -import React from 'react'; +import React, { useCallback } from 'react'; import styled from 'styled-components'; -import { EuiFlyout, EuiFlyoutFooter, EuiFlyoutBody, EuiFlyoutHeader } from '@elastic/eui'; +import { + EuiFlyout, + EuiFlyoutFooter, + EuiFlyoutBody, + EuiFlyoutHeader, + EuiButtonEmpty, + EuiTitle, +} from '@elastic/eui'; import { useKibana } from '../../../common/lib/kibana'; import { OsqueryEventDetailsFooter } from './osquery_flyout_footer'; -import { OsqueryEventDetailsHeader } from './osquery_flyout_header'; import { ACTION_OSQUERY } from './translations'; +import { DataProvider } from '../../../timelines/components/timeline/data_providers/data_provider'; const OsqueryActionWrapper = styled.div` padding: 8px; @@ -22,11 +29,47 @@ export interface OsqueryFlyoutProps { onClose: () => void; } -export const OsqueryFlyout: React.FC = ({ agentId, onClose }) => { +const TimelineComponent = React.memo((props) => { + return ; +}); +TimelineComponent.displayName = 'TimelineComponent'; + +export const OsqueryFlyoutComponent: React.FC = ({ agentId, onClose }) => { const { - services: { osquery }, + services: { osquery, timelines }, } = useKibana(); + const { getAddToTimelineButton } = timelines.getHoverActions(); + + const handleAddToTimeline = useCallback( + (payload: { query: [string, string]; isIcon?: true }) => { + const { + query: [field, value], + isIcon, + } = payload; + const providerA: DataProvider = { + and: [], + enabled: true, + excluded: false, + id: value, + kqlQuery: '', + name: value, + queryMatch: { + field, + value, + operator: ':', + }, + }; + + return getAddToTimelineButton({ + dataProvider: providerA, + field: value, + ownFocus: false, + ...(isIcon ? { showTooltip: true } : { Component: TimelineComponent }), + }); + }, + [getAddToTimelineButton] + ); // @ts-expect-error const { OsqueryAction } = osquery; return ( @@ -36,16 +79,14 @@ export const OsqueryFlyout: React.FC = ({ agentId, onClose } size="m" onClose={onClose} > - - {ACTION_OSQUERY}
} - handleClick={onClose} - data-test-subj="flyout-header-osquery" - /> + + +

{ACTION_OSQUERY}

+ - + @@ -55,4 +96,4 @@ export const OsqueryFlyout: React.FC = ({ agentId, onClose } ); }; -OsqueryFlyout.displayName = 'OsqueryFlyout'; +export const OsqueryFlyout = React.memo(OsqueryFlyoutComponent); diff --git a/x-pack/plugins/security_solution/public/detections/components/osquery/osquery_flyout_header.tsx b/x-pack/plugins/security_solution/public/detections/components/osquery/osquery_flyout_header.tsx deleted file mode 100644 index 7a0f7f15f3e74..0000000000000 --- a/x-pack/plugins/security_solution/public/detections/components/osquery/osquery_flyout_header.tsx +++ /dev/null @@ -1,30 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import React from 'react'; -import { EuiButtonEmpty, EuiText, EuiTitle } from '@elastic/eui'; -import { BACK_TO_ALERT_DETAILS } from './translations'; - -interface IProps { - primaryText: React.ReactElement; - handleClick: () => void; -} - -const OsqueryEventDetailsHeaderComponent: React.FC = ({ primaryText, handleClick }) => { - return ( - <> - - -

{BACK_TO_ALERT_DETAILS}

- - - {primaryText} - - ); -}; - -export const OsqueryEventDetailsHeader = React.memo(OsqueryEventDetailsHeaderComponent); diff --git a/x-pack/plugins/security_solution/public/management/hooks/artifacts/use_bulk_delete_artifact.tsx b/x-pack/plugins/security_solution/public/management/hooks/artifacts/use_bulk_delete_artifact.tsx index 994ed4f466d00..f534cc01e62ee 100644 --- a/x-pack/plugins/security_solution/public/management/hooks/artifacts/use_bulk_delete_artifact.tsx +++ b/x-pack/plugins/security_solution/public/management/hooks/artifacts/use_bulk_delete_artifact.tsx @@ -7,14 +7,19 @@ import pMap from 'p-map'; import { HttpFetchError } from '@kbn/core/public'; import { ExceptionListItemSchema } from '@kbn/securitysolution-io-ts-list-types'; -import { useMutation, UseMutationResult, UseQueryOptions } from 'react-query'; +import { useMutation, UseMutationOptions, UseMutationResult } from 'react-query'; import { ExceptionsListApiClient } from '../../services/exceptions_list/exceptions_list_api_client'; const DEFAULT_OPTIONS = Object.freeze({}); export function useBulkDeleteArtifact( exceptionListApiClient: ExceptionsListApiClient, - customOptions: UseQueryOptions = DEFAULT_OPTIONS, + customOptions: UseMutationOptions< + ExceptionListItemSchema[], + HttpFetchError, + Array<{ itemId?: string; id?: string }>, + () => void + > = DEFAULT_OPTIONS, options: { concurrency: number; } = { diff --git a/x-pack/plugins/security_solution/public/management/hooks/artifacts/use_bulk_update_artifact.tsx b/x-pack/plugins/security_solution/public/management/hooks/artifacts/use_bulk_update_artifact.tsx index 3389b3563577a..68090e2aabc90 100644 --- a/x-pack/plugins/security_solution/public/management/hooks/artifacts/use_bulk_update_artifact.tsx +++ b/x-pack/plugins/security_solution/public/management/hooks/artifacts/use_bulk_update_artifact.tsx @@ -10,14 +10,19 @@ import { UpdateExceptionListItemSchema, ExceptionListItemSchema, } from '@kbn/securitysolution-io-ts-list-types'; -import { useMutation, UseMutationResult, UseQueryOptions } from 'react-query'; +import { useMutation, UseMutationOptions, UseMutationResult } from 'react-query'; import { ExceptionsListApiClient } from '../../services/exceptions_list/exceptions_list_api_client'; const DEFAULT_OPTIONS = Object.freeze({}); export function useBulkUpdateArtifact( exceptionListApiClient: ExceptionsListApiClient, - customOptions: UseQueryOptions = DEFAULT_OPTIONS, + customOptions: UseMutationOptions< + ExceptionListItemSchema[], + HttpFetchError, + UpdateExceptionListItemSchema[], + () => void + > = DEFAULT_OPTIONS, options: { concurrency: number; } = { diff --git a/x-pack/plugins/security_solution/public/management/hooks/artifacts/use_create_artifact.tsx b/x-pack/plugins/security_solution/public/management/hooks/artifacts/use_create_artifact.tsx index c1aed4be8005b..79dd59d744e7f 100644 --- a/x-pack/plugins/security_solution/public/management/hooks/artifacts/use_create_artifact.tsx +++ b/x-pack/plugins/security_solution/public/management/hooks/artifacts/use_create_artifact.tsx @@ -9,14 +9,19 @@ import { ExceptionListItemSchema, } from '@kbn/securitysolution-io-ts-list-types'; import { HttpFetchError } from '@kbn/core/public'; -import { useMutation, UseMutationResult, UseQueryOptions } from 'react-query'; +import { useMutation, UseMutationOptions, UseMutationResult } from 'react-query'; import { ExceptionsListApiClient } from '../../services/exceptions_list/exceptions_list_api_client'; const DEFAULT_OPTIONS = Object.freeze({}); export function useCreateArtifact( exceptionListApiClient: ExceptionsListApiClient, - customOptions: UseQueryOptions = DEFAULT_OPTIONS + customOptions: UseMutationOptions< + ExceptionListItemSchema, + HttpFetchError, + CreateExceptionListItemSchema, + () => void + > = DEFAULT_OPTIONS ): UseMutationResult< ExceptionListItemSchema, HttpFetchError, diff --git a/x-pack/plugins/security_solution/public/management/hooks/artifacts/use_delete_artifact.tsx b/x-pack/plugins/security_solution/public/management/hooks/artifacts/use_delete_artifact.tsx index 16568a0766444..a12b3aaa9ba40 100644 --- a/x-pack/plugins/security_solution/public/management/hooks/artifacts/use_delete_artifact.tsx +++ b/x-pack/plugins/security_solution/public/management/hooks/artifacts/use_delete_artifact.tsx @@ -6,14 +6,19 @@ */ import { ExceptionListItemSchema } from '@kbn/securitysolution-io-ts-list-types'; import { HttpFetchError } from '@kbn/core/public'; -import { useMutation, UseMutationResult, UseQueryOptions } from 'react-query'; +import { useMutation, UseMutationOptions, UseMutationResult } from 'react-query'; import { ExceptionsListApiClient } from '../../services/exceptions_list/exceptions_list_api_client'; const DEFAULT_OPTIONS = Object.freeze({}); export function useDeleteArtifact( exceptionListApiClient: ExceptionsListApiClient, - customOptions: UseQueryOptions = DEFAULT_OPTIONS + customOptions: UseMutationOptions< + ExceptionListItemSchema, + HttpFetchError, + { itemId?: string; id?: string }, + () => void + > = DEFAULT_OPTIONS ): UseMutationResult< ExceptionListItemSchema, HttpFetchError, diff --git a/x-pack/plugins/security_solution/public/management/hooks/artifacts/use_get_artifact.tsx b/x-pack/plugins/security_solution/public/management/hooks/artifacts/use_get_artifact.tsx index eb80a689e5a0d..36ae203707c28 100644 --- a/x-pack/plugins/security_solution/public/management/hooks/artifacts/use_get_artifact.tsx +++ b/x-pack/plugins/security_solution/public/management/hooks/artifacts/use_get_artifact.tsx @@ -9,24 +9,17 @@ import { HttpFetchError } from '@kbn/core/public'; import { QueryObserverResult, useQuery, UseQueryOptions } from 'react-query'; import { ExceptionsListApiClient } from '../../services/exceptions_list/exceptions_list_api_client'; -const DEFAULT_OPTIONS = Object.freeze({}); - export function useGetArtifact( exceptionListApiClient: ExceptionsListApiClient, itemId?: string, id?: string, - customQueryOptions: UseQueryOptions = DEFAULT_OPTIONS + customQueryOptions?: UseQueryOptions ): QueryObserverResult { return useQuery( ['get', exceptionListApiClient, itemId, id], () => { return exceptionListApiClient.get(itemId, id); }, - { - refetchIntervalInBackground: false, - refetchOnWindowFocus: false, - refetchOnMount: true, - ...customQueryOptions, - } + customQueryOptions ); } diff --git a/x-pack/plugins/security_solution/public/management/hooks/artifacts/use_list_artifact.tsx b/x-pack/plugins/security_solution/public/management/hooks/artifacts/use_list_artifact.tsx index 68bee6de0113a..64a5b908e2d9e 100644 --- a/x-pack/plugins/security_solution/public/management/hooks/artifacts/use_list_artifact.tsx +++ b/x-pack/plugins/security_solution/public/management/hooks/artifacts/use_list_artifact.tsx @@ -31,9 +31,7 @@ export function useListArtifact( excludedPolicies: string[]; }> = DEFAULT_OPTIONS, searchableFields: MaybeImmutable = DEFAULT_EXCEPTION_LIST_ITEM_SEARCHABLE_FIELDS, - customQueryOptions: Partial< - UseQueryOptions - > = DEFAULT_OPTIONS, + customQueryOptions?: Partial>, customQueryIds: string[] = [] ): QueryObserverResult { const { @@ -64,12 +62,6 @@ export function useListArtifact( return result; }, - { - refetchIntervalInBackground: false, - refetchOnWindowFocus: false, - refetchOnMount: true, - keepPreviousData: true, - ...customQueryOptions, - } + customQueryOptions ); } diff --git a/x-pack/plugins/security_solution/public/management/hooks/artifacts/use_summary_artifact.tsx b/x-pack/plugins/security_solution/public/management/hooks/artifacts/use_summary_artifact.tsx index 62e5372dc39aa..111fdb4565785 100644 --- a/x-pack/plugins/security_solution/public/management/hooks/artifacts/use_summary_artifact.tsx +++ b/x-pack/plugins/security_solution/public/management/hooks/artifacts/use_summary_artifact.tsx @@ -21,9 +21,7 @@ export function useSummaryArtifact( policies: string[]; }> = DEFAULT_OPTIONS, searchableFields: MaybeImmutable = DEFAULT_EXCEPTION_LIST_ITEM_SEARCHABLE_FIELDS, - customQueryOptions: Partial< - UseQueryOptions - > = DEFAULT_OPTIONS + customQueryOptions: Partial> ): QueryObserverResult { const { filter = '', policies = [] } = options; @@ -37,12 +35,6 @@ export function useSummaryArtifact( }) ); }, - { - refetchIntervalInBackground: false, - refetchOnWindowFocus: false, - refetchOnMount: true, - keepPreviousData: true, - ...customQueryOptions, - } + customQueryOptions ); } diff --git a/x-pack/plugins/security_solution/public/management/hooks/artifacts/use_update_artifact.tsx b/x-pack/plugins/security_solution/public/management/hooks/artifacts/use_update_artifact.tsx index 92da096f71e66..e3a7e37eebf56 100644 --- a/x-pack/plugins/security_solution/public/management/hooks/artifacts/use_update_artifact.tsx +++ b/x-pack/plugins/security_solution/public/management/hooks/artifacts/use_update_artifact.tsx @@ -9,14 +9,19 @@ import { ExceptionListItemSchema, } from '@kbn/securitysolution-io-ts-list-types'; import { HttpFetchError } from '@kbn/core/public'; -import { useMutation, UseMutationResult, UseQueryOptions } from 'react-query'; +import { useMutation, UseMutationOptions, UseMutationResult } from 'react-query'; import { ExceptionsListApiClient } from '../../services/exceptions_list/exceptions_list_api_client'; const DEFAULT_OPTIONS = Object.freeze({}); export function useUpdateArtifact( exceptionListApiClient: ExceptionsListApiClient, - customQueryOptions: UseQueryOptions = DEFAULT_OPTIONS + customQueryOptions: UseMutationOptions< + ExceptionListItemSchema, + HttpFetchError, + UpdateExceptionListItemSchema, + () => void + > = DEFAULT_OPTIONS ): UseMutationResult< ExceptionListItemSchema, HttpFetchError, diff --git a/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.test.ts b/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.test.ts index 57cdaca1f2147..d8dc87885a1fa 100644 --- a/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.test.ts +++ b/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.test.ts @@ -424,16 +424,16 @@ describe('endpoint list middleware', () => { path: expect.any(String), query: { agent_ids: [ - '6db499e5-4927-4350-abb8-d8318e7d0eec', - 'c082dda9-1847-4997-8eda-f1192d95bec3', - '8aa1cd61-cc25-4783-afb5-0eefc4919c07', - '47fe24c1-7370-419a-9732-3ff38bf41272', - '0d2b2fa7-a9cd-49fc-ad5f-0252c642290e', - 'f480092d-0445-4bf3-9c96-8a3d5cb97824', - '3850e676-0940-4c4b-aaca-571bd1bc66d9', - '46efcc7a-086a-47a3-8f09-c4ecd6d2d917', - 'afa55826-b81b-4440-a2ac-0644d77a3fc6', - '25b49e50-cb5c-43df-824f-67b8cf697d9d', + '0dc3661d-6e67-46b0-af39-6f12b025fcb0', + 'a8e32a61-2685-47f0-83eb-edf157b8e616', + '37e219a8-fe16-4da9-bf34-634c5824b484', + '2484eb13-967e-4491-bf83-dffefdfe607c', + '0bc08ef6-6d6a-4113-92f2-b97811187c63', + 'f4127d87-b567-4a6e-afa6-9a1c7dc95f01', + 'f9ab5b8c-a43e-4e80-99d6-11570845a697', + '406c4b6a-ca57-4bd1-bc66-d9d999df3e70', + '2da1dd51-f7af-4f0e-b64c-e7751c74b0e7', + '89a94ea4-073c-4cb6-90a2-500805837027', ], }, }); diff --git a/x-pack/plugins/security_solution/public/management/pages/policy/view/ingest_manager_integration/mocks.tsx b/x-pack/plugins/security_solution/public/management/pages/policy/view/ingest_manager_integration/mocks.tsx index 908ebc22a19cd..daa44f01dbffd 100644 --- a/x-pack/plugins/security_solution/public/management/pages/policy/view/ingest_manager_integration/mocks.tsx +++ b/x-pack/plugins/security_solution/public/management/pages/policy/view/ingest_manager_integration/mocks.tsx @@ -13,7 +13,7 @@ import { I18nProvider } from '@kbn/i18n-react'; import type { PackageInfo } from '@kbn/fleet-plugin/common/types'; import { EuiThemeProvider } from '@kbn/kibana-react-plugin/common'; import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public'; -import { QueryClient } from 'react-query'; +import { SecuritySolutionQueryClient } from '../../../../../common/containers/query_client/query_client_provider'; import { AppContextTestRender, createAppRootMockRenderer, @@ -85,7 +85,7 @@ export const createFleetContextRendererMock = (): AppContextTestRender => { additionalMiddleware: [mockedContext.middlewareSpy.actionSpyMiddleware], }); - const queryClient = new QueryClient(); + const queryClient = new SecuritySolutionQueryClient(); const Wrapper: RenderOptions['wrapper'] = ({ children }) => { const services = useMemo(() => { diff --git a/x-pack/plugins/security_solution/public/management/pages/policy/view/ingest_manager_integration/with_security_context/render_context_providers.tsx b/x-pack/plugins/security_solution/public/management/pages/policy/view/ingest_manager_integration/with_security_context/render_context_providers.tsx index 9b3472192a718..ec222de1713f0 100644 --- a/x-pack/plugins/security_solution/public/management/pages/policy/view/ingest_manager_integration/with_security_context/render_context_providers.tsx +++ b/x-pack/plugins/security_solution/public/management/pages/policy/view/ingest_manager_integration/with_security_context/render_context_providers.tsx @@ -8,8 +8,10 @@ import React, { memo, PropsWithChildren } from 'react'; import { Provider as ReduxStoreProvider } from 'react-redux'; import { Store } from 'redux'; -import type { QueryClient } from 'react-query'; -import { ReactQueryClientProvider } from '../../../../../../common/containers/query_client/query_client_provider'; +import { + ReactQueryClientProvider, + SecuritySolutionQueryClient, +} from '../../../../../../common/containers/query_client/query_client_provider'; import { SecuritySolutionStartDependenciesContext } from '../../../../../../common/components/user_privileges/endpoint/security_solution_start_dependencies'; import { CurrentLicense } from '../../../../../../common/components/current_license'; import { StartPlugins } from '../../../../../../types'; @@ -17,7 +19,7 @@ import { StartPlugins } from '../../../../../../types'; export type RenderContextProvidersProps = PropsWithChildren<{ store: Store; depsStart: Pick; - queryClient?: QueryClient; + queryClient?: SecuritySolutionQueryClient; }>; export const RenderContextProviders = memo( diff --git a/x-pack/plugins/security_solution/public/management/services/policies/hooks.ts b/x-pack/plugins/security_solution/public/management/services/policies/hooks.ts index 6cc6140d336d2..cf053128e5f37 100644 --- a/x-pack/plugins/security_solution/public/management/services/policies/hooks.ts +++ b/x-pack/plugins/security_solution/public/management/services/policies/hooks.ts @@ -40,11 +40,11 @@ export function useGetEndpointSpecificPolicies( }, }); }, - { - refetchIntervalInBackground: false, - refetchOnWindowFocus: false, - onError, - } + onError + ? { + onError, + } + : undefined ); } @@ -56,7 +56,7 @@ export function useGetEndpointSpecificPolicies( */ export function useGetAgentCountForPolicy({ policyIds, - customQueryOptions = {}, + customQueryOptions, }: { policyIds: string[]; customQueryOptions?: UseQueryOptions; @@ -72,11 +72,7 @@ export function useGetAgentCountForPolicy({ }, }); }, - { - refetchIntervalInBackground: false, - refetchOnWindowFocus: false, - ...customQueryOptions, - } + customQueryOptions ); } @@ -84,7 +80,7 @@ export function useGetAgentCountForPolicy({ * This hook returns the endpoint security package which contains endpoint version info */ export function useGetEndpointSecurityPackage({ - customQueryOptions = {}, + customQueryOptions, }: { customQueryOptions?: UseQueryOptions; }): QueryObserverResult { @@ -94,10 +90,6 @@ export function useGetEndpointSecurityPackage({ () => { return sendGetEndpointSecurityPackage(http); }, - { - refetchIntervalInBackground: false, - refetchOnWindowFocus: false, - ...customQueryOptions, - } + customQueryOptions ); } diff --git a/x-pack/plugins/security_solution/public/plugin.tsx b/x-pack/plugins/security_solution/public/plugin.tsx index bea6ace83cf23..343259d88cb76 100644 --- a/x-pack/plugins/security_solution/public/plugin.tsx +++ b/x-pack/plugins/security_solution/public/plugin.tsx @@ -142,6 +142,12 @@ export class Plugin implements IPlugin { + // required to show the alert table inside cases + const { alertsTableConfigurationRegistry } = plugins.triggersActionsUi; + const { registerAlertsTableConfiguration } = + await this.lazyRegisterAlertsTableConfiguration(); + registerAlertsTableConfiguration(alertsTableConfigurationRegistry, this.storage); + const [coreStart, startPlugins] = await core.getStartServices(); const subPlugins = await this.startSubPlugins(this.storage, coreStart, startPlugins); const { renderApp } = await this.lazyApplicationDependencies(); @@ -283,6 +289,17 @@ export class Plugin implements IPlugin, + destIps?: Array, + sortIds?: string[] +): SignalSourceHit[] => { + return Array.from({ length: count }).map((x, index) => ({ + ...sampleDocWithSortId( + guids[index], + sortIds, + ips ? ips[index] : '127.0.0.1', + destIps ? destIps[index] : '127.0.0.1' + ), + })); +}; + export const repeatedSearchResultsWithSortId = ( total: number, pageSize: number, @@ -929,14 +955,7 @@ export const repeatedSearchResultsWithSortId = ( hits: { total, max_score: 100, - hits: Array.from({ length: pageSize }).map((x, index) => ({ - ...sampleDocWithSortId( - guids[index], - sortIds, - ips ? ips[index] : '127.0.0.1', - destIps ? destIps[index] : '127.0.0.1' - ), - })), + hits: repeatedHitsWithSortId(pageSize, guids, ips, destIps, sortIds), }, }); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/bulk_create_ml_signals.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/bulk_create_ml_signals.ts index 66394d4bca81d..e38ee3952cadb 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/bulk_create_ml_signals.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/bulk_create_ml_signals.ts @@ -15,7 +15,7 @@ import { RuleExecutorServices, } from '@kbn/alerting-plugin/server'; import { GenericBulkCreateResponse } from '../rule_types/factories'; -import { AnomalyResults, Anomaly } from '../../machine_learning'; +import { Anomaly } from '../../machine_learning'; import { BuildRuleMessage } from './rule_messages'; import { BulkCreate, WrapHits } from './types'; import { CompleteRule, MachineLearningRuleParams } from '../schemas/rule_schemas'; @@ -23,7 +23,7 @@ import { buildReasonMessageForMlAlert } from './reason_formatters'; import { BaseFieldsLatest } from '../../../../common/detection_engine/schemas/alerts'; interface BulkCreateMlSignalsParams { - someResult: AnomalyResults; + anomalyHits: Array>; completeRule: CompleteRule; services: RuleExecutorServices; logger: Logger; @@ -65,32 +65,23 @@ export const transformAnomalyFieldsToEcs = (anomaly: Anomaly): EcsAnomaly => { }; const transformAnomalyResultsToEcs = ( - results: AnomalyResults -): estypes.SearchResponse => { - const transformedHits = results.hits.hits.map(({ _source, ...rest }) => ({ + results: Array> +): Array> => { + return results.map(({ _source, ...rest }) => ({ ...rest, _source: transformAnomalyFieldsToEcs( // @ts-expect-error @elastic/elasticsearch _source is optional _source ), })); - - // @ts-expect-error Anomaly is not assignable to EcsAnomaly - return { - ...results, - hits: { - ...results.hits, - hits: transformedHits, - }, - }; }; export const bulkCreateMlSignals = async ( params: BulkCreateMlSignalsParams ): Promise> => { - const anomalyResults = params.someResult; + const anomalyResults = params.anomalyHits; const ecsResults = transformAnomalyResultsToEcs(anomalyResults); - const wrappedDocs = params.wrapHits(ecsResults.hits.hits, buildReasonMessageForMlAlert); + const wrappedDocs = params.wrapHits(ecsResults, buildReasonMessageForMlAlert); return params.bulkCreate(wrappedDocs); }; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/executors/ml.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/executors/ml.ts index 2070d487c49d0..22c11b565e909 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/executors/ml.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/executors/ml.ts @@ -97,21 +97,21 @@ export const mlExecutor = async ({ exceptionItems, }); - const filteredAnomalyResults = await filterEventsAgainstList({ + const [filteredAnomalyHits, _] = await filterEventsAgainstList({ listClient, exceptionsList: exceptionItems, logger, - eventSearchResult: anomalyResults, + events: anomalyResults.hits.hits, buildRuleMessage, }); - const anomalyCount = filteredAnomalyResults.hits.hits.length; + const anomalyCount = filteredAnomalyHits.length; if (anomalyCount) { logger.debug(buildRuleMessage(`Found ${anomalyCount} signals from ML anomalies.`)); } const { success, errors, bulkCreateDuration, createdItemsCount, createdItems } = await bulkCreateMlSignals({ - someResult: filteredAnomalyResults, + anomalyHits: filteredAnomalyHits, completeRule, services, logger, @@ -124,7 +124,7 @@ export const mlExecutor = async ({ // The legacy ES client does not define failures when it can be present on the structure, hence why I have the & { failures: [] } const shardFailures = ( - filteredAnomalyResults._shards as typeof filteredAnomalyResults._shards & { + anomalyResults._shards as typeof anomalyResults._shards & { failures: []; } ).failures ?? []; @@ -134,7 +134,7 @@ export const mlExecutor = async ({ return mergeReturns([ result, createSearchAfterReturnType({ - success: success && filteredAnomalyResults._shards.failed === 0, + success: success && anomalyResults._shards.failed === 0, errors: [...errors, ...searchErrors], createdSignalsCount: createdItemsCount, createdSignals: createdItems, diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filters/filter_events.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filters/filter_events.test.ts index df9bb0cd59f83..bed5f96fbc233 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filters/filter_events.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filters/filter_events.test.ts @@ -9,10 +9,10 @@ import { sampleDocWithSortId } from '../__mocks__/es_results'; import { listMock } from '@kbn/lists-plugin/server/mocks'; import { getSearchListItemResponseMock } from '@kbn/lists-plugin/common/schemas/response/search_list_item_schema.mock'; -import { filterEvents } from './filter_events'; +import { partitionEvents } from './filter_events'; import { FieldSet } from './types'; -describe('filterEvents', () => { +describe('partitionEvents', () => { let listClient = listMock.getListClient(); let events = [sampleDocWithSortId('123', undefined, '1.1.1.1')]; @@ -43,11 +43,12 @@ describe('filterEvents', () => { matchedSet: new Set([JSON.stringify(['1.1.1.1'])]), }, ]; - const field = filterEvents({ + const [included, excluded] = partitionEvents({ events, fieldAndSetTuples, }); - expect([...field]).toEqual([]); + expect(included).toEqual([]); + expect(excluded).toEqual(events); }); test('it does not filter out the event if it is "excluded"', () => { @@ -59,11 +60,12 @@ describe('filterEvents', () => { matchedSet: new Set([JSON.stringify(['1.1.1.1'])]), }, ]; - const field = filterEvents({ + const [included, excluded] = partitionEvents({ events, fieldAndSetTuples, }); - expect([...field]).toEqual(events); + expect(included).toEqual(events); + expect(excluded).toEqual([]); }); test('it does NOT filter out the event if the field is not found', () => { @@ -75,11 +77,12 @@ describe('filterEvents', () => { matchedSet: new Set([JSON.stringify(['1.1.1.1'])]), }, ]; - const field = filterEvents({ + const [included, excluded] = partitionEvents({ events, fieldAndSetTuples, }); - expect([...field]).toEqual(events); + expect(included).toEqual(events); + expect(excluded).toEqual([]); }); test('it does NOT filter out the event if it is in both an inclusion and exclusion list', () => { @@ -100,10 +103,11 @@ describe('filterEvents', () => { }, ]; - const field = filterEvents({ + const [included, excluded] = partitionEvents({ events, fieldAndSetTuples, }); - expect([...field]).toEqual(events); + expect(included).toEqual(events); + expect(excluded).toEqual([]); }); }); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filters/filter_events.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filters/filter_events.ts index d267153a4813a..aee98b7e0ff5b 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filters/filter_events.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filters/filter_events.ts @@ -5,6 +5,7 @@ * 2.0. */ import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; +import { partition } from 'lodash'; import { FilterEventsOptions } from './types'; /** @@ -12,12 +13,14 @@ import { FilterEventsOptions } from './types'; * If the entry is in both an inclusion and exclusion list it will not be filtered out. * @param events The events to check against * @param fieldAndSetTuples The field and set tuples + * @returns A tuple where the first element is an array of alerts that should be created and second element is + * an array of alerts that matched the exception and should not be created. */ -export const filterEvents = ({ +export const partitionEvents = ({ events, fieldAndSetTuples, -}: FilterEventsOptions): Array> => { - return events.filter((item) => { +}: FilterEventsOptions): [Array>, Array>] => { + return partition(events, (item) => { return fieldAndSetTuples .map((tuple) => { const eventItem = item.fields ? item.fields[tuple.field] : undefined; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filters/filter_events_against_list.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filters/filter_events_against_list.test.ts index 8c33cf2ea1314..22dc5136fcded 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filters/filter_events_against_list.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filters/filter_events_against_list.test.ts @@ -8,7 +8,7 @@ import uuid from 'uuid'; import { filterEventsAgainstList } from './filter_events_against_list'; import { buildRuleMessageMock as buildRuleMessage } from '../rule_messages.mock'; -import { mockLogger, repeatedSearchResultsWithSortId } from '../__mocks__/es_results'; +import { mockLogger, repeatedHitsWithSortId } from '../__mocks__/es_results'; import { getExceptionListItemSchemaMock } from '@kbn/lists-plugin/common/schemas/response/exception_list_item_schema.mock'; import { listMock } from '@kbn/lists-plugin/server/mocks'; @@ -30,11 +30,11 @@ describe('filterEventsAgainstList', () => { }); it('should respond with eventSearchResult if exceptionList is empty array', async () => { - const res = await filterEventsAgainstList({ + const [included, excluded] = await filterEventsAgainstList({ logger: mockLogger, listClient, exceptionsList: [], - eventSearchResult: repeatedSearchResultsWithSortId(4, 4, someGuids.slice(0, 3), [ + events: repeatedHitsWithSortId(4, someGuids.slice(0, 3), [ '1.1.1.1', '2.2.2.2', '3.3.3.3', @@ -42,15 +42,16 @@ describe('filterEventsAgainstList', () => { ]), buildRuleMessage, }); - expect(res.hits.hits.length).toEqual(4); + expect(included.length).toEqual(4); + expect(excluded.length).toEqual(0); }); it('should respond with eventSearchResult if exceptionList does not contain value list exceptions', async () => { - const res = await filterEventsAgainstList({ + const [included, excluded] = await filterEventsAgainstList({ logger: mockLogger, listClient, exceptionsList: [getExceptionListItemSchemaMock()], - eventSearchResult: repeatedSearchResultsWithSortId(4, 4, someGuids.slice(0, 3), [ + events: repeatedHitsWithSortId(4, someGuids.slice(0, 3), [ '1.1.1.1', '2.2.2.2', '3.3.3.3', @@ -58,7 +59,8 @@ describe('filterEventsAgainstList', () => { ]), buildRuleMessage, }); - expect(res.hits.hits.length).toEqual(4); + expect(included.length).toEqual(4); + expect(excluded.length).toEqual(0); expect((mockLogger.debug as unknown as jest.Mock).mock.calls[0][0]).toContain( 'no exception items of type list found - returning original search result' ); @@ -79,14 +81,15 @@ describe('filterEventsAgainstList', () => { }, ]; - const res = await filterEventsAgainstList({ + const [included, excluded] = await filterEventsAgainstList({ logger: mockLogger, listClient, exceptionsList: [exceptionItem], - eventSearchResult: repeatedSearchResultsWithSortId(4, 4, someGuids.slice(0, 3)), + events: repeatedHitsWithSortId(4, someGuids.slice(0, 3)), buildRuleMessage, }); - expect(res.hits.hits.length).toEqual(4); + expect(included.length).toEqual(4); + expect(excluded.length).toEqual(0); }); it('should respond with less items in the list if some values match', async () => { @@ -110,11 +113,11 @@ describe('filterEventsAgainstList', () => { })) ) ); - const res = await filterEventsAgainstList({ + const [included, excluded] = await filterEventsAgainstList({ logger: mockLogger, listClient, exceptionsList: [exceptionItem], - eventSearchResult: repeatedSearchResultsWithSortId(4, 4, someGuids.slice(0, 3), [ + events: repeatedHitsWithSortId(4, someGuids.slice(0, 3), [ '1.1.1.1', '2.2.2.2', '3.3.3.3', @@ -126,10 +129,11 @@ describe('filterEventsAgainstList', () => { expect((listClient.searchListItemByValues as jest.Mock).mock.calls[0][0].listId).toEqual( 'ci-badguys.txt' ); - expect(res.hits.hits.length).toEqual(2); + expect(included.length).toEqual(2); + expect(excluded.length).toEqual(2); // @ts-expect-error - const ipVals = res.hits.hits.map((item) => item._source.source.ip); + const ipVals = included.map((item) => item._source.source.ip); expect(['3.3.3.3', '7.7.7.7']).toEqual(ipVals); }); @@ -170,11 +174,11 @@ describe('filterEventsAgainstList', () => { { ...getSearchListItemResponseMock(), value: ['6.6.6.6'] }, ]); - const res = await filterEventsAgainstList({ + const [included, excluded] = await filterEventsAgainstList({ logger: mockLogger, listClient, exceptionsList: [exceptionItem, exceptionItemAgain], - eventSearchResult: repeatedSearchResultsWithSortId(9, 9, someGuids.slice(0, 9), [ + events: repeatedHitsWithSortId(9, someGuids.slice(0, 9), [ '1.1.1.1', '2.2.2.2', '3.3.3.3', @@ -188,10 +192,11 @@ describe('filterEventsAgainstList', () => { buildRuleMessage, }); expect(listClient.searchListItemByValues as jest.Mock).toHaveBeenCalledTimes(2); - expect(res.hits.hits.length).toEqual(6); + expect(included.length).toEqual(6); + expect(excluded.length).toEqual(3); // @ts-expect-error - const ipVals = res.hits.hits.map((item) => item._source.source.ip); + const ipVals = included.map((item) => item._source.source.ip); expect(['1.1.1.1', '3.3.3.3', '5.5.5.5', '7.7.7.7', '8.8.8.8', '9.9.9.9']).toEqual(ipVals); }); @@ -231,11 +236,11 @@ describe('filterEventsAgainstList', () => { { ...getSearchListItemResponseMock(), value: ['6.6.6.6'] }, ]); - const res = await filterEventsAgainstList({ + const [included, excluded] = await filterEventsAgainstList({ logger: mockLogger, listClient, exceptionsList: [exceptionItem, exceptionItemAgain], - eventSearchResult: repeatedSearchResultsWithSortId(9, 9, someGuids.slice(0, 9), [ + events: repeatedHitsWithSortId(9, someGuids.slice(0, 9), [ '1.1.1.1', '2.2.2.2', '3.3.3.3', @@ -250,8 +255,9 @@ describe('filterEventsAgainstList', () => { }); expect(listClient.searchListItemByValues as jest.Mock).toHaveBeenCalledTimes(2); // @ts-expect-error - const ipVals = res.hits.hits.map((item) => item._source.source.ip); - expect(res.hits.hits.length).toEqual(7); + const ipVals = included.map((item) => item._source.source.ip); + expect(included.length).toEqual(7); + expect(excluded.length).toEqual(2); expect(['1.1.1.1', '3.3.3.3', '4.4.4.4', '5.5.5.5', '7.7.7.7', '8.8.8.8', '9.9.9.9']).toEqual( ipVals @@ -290,12 +296,11 @@ describe('filterEventsAgainstList', () => { { ...getSearchListItemResponseMock(), value: ['4.4.4.4'] }, ]); - const res = await filterEventsAgainstList({ + const [included, excluded] = await filterEventsAgainstList({ logger: mockLogger, listClient, exceptionsList: [exceptionItem], - eventSearchResult: repeatedSearchResultsWithSortId( - 9, + events: repeatedHitsWithSortId( 9, someGuids.slice(0, 9), [ @@ -324,10 +329,11 @@ describe('filterEventsAgainstList', () => { buildRuleMessage, }); expect(listClient.searchListItemByValues as jest.Mock).toHaveBeenCalledTimes(2); - expect(res.hits.hits.length).toEqual(8); + expect(included.length).toEqual(8); + expect(excluded.length).toEqual(1); // @ts-expect-error - const ipVals = res.hits.hits.map((item) => item._source.source.ip); + const ipVals = included.map((item) => item._source?.source?.ip); expect([ '1.1.1.1', '2.2.2.2', @@ -368,11 +374,11 @@ describe('filterEventsAgainstList', () => { { ...getSearchListItemResponseMock(), value: ['2.2.2.2'] }, ]); - const res = await filterEventsAgainstList({ + const [included, excluded] = await filterEventsAgainstList({ logger: mockLogger, listClient, exceptionsList: [exceptionItem], - eventSearchResult: repeatedSearchResultsWithSortId(9, 9, someGuids.slice(0, 9), [ + events: repeatedHitsWithSortId(9, someGuids.slice(0, 9), [ '1.1.1.1', '2.2.2.2', '3.3.3.3', @@ -386,10 +392,11 @@ describe('filterEventsAgainstList', () => { buildRuleMessage, }); expect(listClient.searchListItemByValues as jest.Mock).toHaveBeenCalledTimes(2); - expect(res.hits.hits.length).toEqual(9); + expect(included.length).toEqual(9); + expect(excluded.length).toEqual(0); // @ts-expect-error - const ipVals = res.hits.hits.map((item) => item._source.source.ip); + const ipVals = included.map((item) => item._source.source.ip); expect([ '1.1.1.1', '2.2.2.2', @@ -435,12 +442,11 @@ describe('filterEventsAgainstList', () => { { ...getSearchListItemResponseMock(), value: ['3.3.3.3', '4.4.4.4'] }, ]); - const res = await filterEventsAgainstList({ + const [included, excluded] = await filterEventsAgainstList({ logger: mockLogger, listClient, exceptionsList: [exceptionItem], - eventSearchResult: repeatedSearchResultsWithSortId( - 3, + events: repeatedHitsWithSortId( 3, someGuids.slice(0, 3), [ @@ -467,16 +473,17 @@ describe('filterEventsAgainstList', () => { ['2.2.2.2', '3.3.3.3'], ['3.3.3.3', '4.4.4.4'], ]); - expect(res.hits.hits.length).toEqual(2); + expect(included.length).toEqual(2); + expect(excluded.length).toEqual(1); // @ts-expect-error - const sourceIpVals = res.hits.hits.map((item) => item._source.source.ip); + const sourceIpVals = included.map((item) => item._source.source.ip); expect([ ['1.1.1.1', '1.1.1.1'], ['1.1.1.1', '2.2.2.2'], ]).toEqual(sourceIpVals); // @ts-expect-error - const destIpVals = res.hits.hits.map((item) => item._source.destination.ip); + const destIpVals = included.map((item) => item._source.destination.ip); expect([ ['1.1.1.1', '2.2.2.2'], ['2.2.2.2', '3.3.3.3'], @@ -497,14 +504,15 @@ describe('filterEventsAgainstList', () => { }, }, ]; - const res = await filterEventsAgainstList({ + const [included, excluded] = await filterEventsAgainstList({ logger: mockLogger, listClient, exceptionsList: [exceptionItem], - eventSearchResult: repeatedSearchResultsWithSortId(4, 4, someGuids.slice(0, 3)), + events: repeatedHitsWithSortId(4, someGuids.slice(0, 3)), buildRuleMessage, }); - expect(res.hits.hits.length).toEqual(0); + expect(included.length).toEqual(0); + expect(excluded.length).toEqual(4); }); it('should respond with less items in the list if some values match', async () => { @@ -528,11 +536,11 @@ describe('filterEventsAgainstList', () => { })) ) ); - const res = await filterEventsAgainstList({ + const [included, excluded] = await filterEventsAgainstList({ logger: mockLogger, listClient, exceptionsList: [exceptionItem], - eventSearchResult: repeatedSearchResultsWithSortId(4, 4, someGuids.slice(0, 3), [ + events: repeatedHitsWithSortId(4, someGuids.slice(0, 3), [ '1.1.1.1', '2.2.2.2', '3.3.3.3', @@ -544,7 +552,8 @@ describe('filterEventsAgainstList', () => { expect((listClient.searchListItemByValues as jest.Mock).mock.calls[0][0].listId).toEqual( 'ci-badguys.txt' ); - expect(res.hits.hits.length).toEqual(2); + expect(included.length).toEqual(2); + expect(excluded.length).toEqual(2); }); it('should respond with the same items in the list given one exception item with two entries of type list and array of values in document', async () => { @@ -582,12 +591,11 @@ describe('filterEventsAgainstList', () => { { ...getSearchListItemResponseMock(), value: ['3.3.3.3', '4.4.4.4'] }, ]); - const res = await filterEventsAgainstList({ + const [included, excluded] = await filterEventsAgainstList({ logger: mockLogger, listClient, exceptionsList: [exceptionItem], - eventSearchResult: repeatedSearchResultsWithSortId( - 3, + events: repeatedHitsWithSortId( 3, someGuids.slice(0, 3), [ @@ -614,16 +622,17 @@ describe('filterEventsAgainstList', () => { ['2.2.2.2', '3.3.3.3'], ['3.3.3.3', '4.4.4.4'], ]); - expect(res.hits.hits.length).toEqual(2); + expect(included.length).toEqual(2); + expect(excluded.length).toEqual(1); // @ts-expect-error - const sourceIpVals = res.hits.hits.map((item) => item._source.source.ip); + const sourceIpVals = included.map((item) => item._source.source.ip); expect([ ['1.1.1.1', '2.2.2.2'], ['2.2.2.2', '3.3.3.3'], ]).toEqual(sourceIpVals); // @ts-expect-error - const destIpVals = res.hits.hits.map((item) => item._source.destination.ip); + const destIpVals = included.map((item) => item._source.destination.ip); expect([ ['2.2.2.2', '3.3.3.3'], ['3.3.3.3', '4.4.4.4'], diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filters/filter_events_against_list.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filters/filter_events_against_list.ts index 49a8ab0781eb0..7b9f6fde51842 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filters/filter_events_against_list.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filters/filter_events_against_list.ts @@ -5,13 +5,12 @@ * 2.0. */ -import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import { entriesList, ExceptionListItemSchema } from '@kbn/securitysolution-io-ts-list-types'; import { hasLargeValueList } from '@kbn/securitysolution-list-utils'; -import { FilterEventsAgainstListOptions } from './types'; -import { filterEvents } from './filter_events'; +import { FilterEventsAgainstListOptions, FilterEventsAgainstListReturn } from './types'; +import { partitionEvents } from './filter_events'; import { createFieldAndSetTuples } from './create_field_and_set_tuples'; /** @@ -39,9 +38,9 @@ export const filterEventsAgainstList = async ({ listClient, exceptionsList, logger, - eventSearchResult, + events, buildRuleMessage, -}: FilterEventsAgainstListOptions): Promise> => { +}: FilterEventsAgainstListOptions): Promise> => { try { const atLeastOneLargeValueList = exceptionsList.some(({ entries }) => hasLargeValueList(entries) @@ -51,46 +50,41 @@ export const filterEventsAgainstList = async ({ logger.debug( buildRuleMessage('no exception items of type list found - returning original search result') ); - return eventSearchResult; + return [events, []]; } const valueListExceptionItems = exceptionsList.filter((listItem: ExceptionListItemSchema) => { return listItem.entries.every((entry) => entriesList.is(entry)); }); - const res = await valueListExceptionItems.reduce>>>( + // Every event starts out in the 'included' list, and each value list item checks all the + // current 'included' events and moves events that match the exception to the 'excluded' list + return valueListExceptionItems.reduce>>( async ( - filteredAccum: Promise>>, + filteredAccum: Promise>, exceptionItem: ExceptionListItemSchema ) => { - const events = await filteredAccum; + const [includedEvents, excludedEvents] = await filteredAccum; const fieldAndSetTuples = await createFieldAndSetTuples({ - events, + events: includedEvents, exceptionItem, listClient, logger, buildRuleMessage, }); - const filteredEvents = filterEvents({ events, fieldAndSetTuples }); - const diff = eventSearchResult.hits.hits.length - filteredEvents.length; + const [nextIncludedEvents, nextExcludedEvents] = partitionEvents({ + events: includedEvents, + fieldAndSetTuples, + }); logger.debug( - buildRuleMessage(`Exception with id ${exceptionItem.id} filtered out ${diff} events`) + buildRuleMessage( + `Exception with id ${exceptionItem.id} filtered out ${nextExcludedEvents.length} events` + ) ); - return filteredEvents; + return [nextIncludedEvents, [...excludedEvents, ...nextExcludedEvents]]; }, - Promise.resolve>>(eventSearchResult.hits.hits) + Promise.resolve>([events, []]) ); - - return { - took: eventSearchResult.took, - timed_out: eventSearchResult.timed_out, - _shards: eventSearchResult._shards, - hits: { - total: res.length, - max_score: eventSearchResult.hits.max_score, - hits: res, - }, - }; } catch (exc) { throw new Error(`Failed to query large value based lists index. Reason: ${exc.message}`); } diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filters/types.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filters/types.ts index 051685c67db4a..f5d438f54bdb3 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filters/types.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filters/types.ts @@ -15,10 +15,15 @@ export interface FilterEventsAgainstListOptions { listClient: ListClient; exceptionsList: ExceptionListItemSchema[]; logger: Logger; - eventSearchResult: estypes.SearchResponse; + events: Array>; buildRuleMessage: BuildRuleMessage; } +export type FilterEventsAgainstListReturn = [ + Array>, + Array> +]; + export interface CreateSetToFilterAgainstOptions { events: Array>; field: string; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/search_after_bulk_create.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/search_after_bulk_create.test.ts index b96b0e6dc7148..4f3a798a327ce 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/search_after_bulk_create.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/search_after_bulk_create.test.ts @@ -1004,16 +1004,12 @@ describe('searchAfterAndBulkCreate', () => { }); expect(mockEnrichment).toHaveBeenCalledWith( - expect.objectContaining({ - hits: expect.objectContaining({ - hits: expect.arrayContaining([ - expect.objectContaining({ - ...sampleDocWithSortId(), - _id: expect.any(String), - }), - ]), + expect.objectContaining([ + expect.objectContaining({ + ...sampleDocWithSortId(), + _id: expect.any(String), }), - }) + ]) ); expect(success).toEqual(true); expect(mockService.scopedClusterClient.asCurrentUser.search).toHaveBeenCalledTimes(4); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/search_after_bulk_create.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/search_after_bulk_create.ts index 69c001898b217..84ef95b856a5f 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/search_after_bulk_create.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/search_after_bulk_create.ts @@ -127,11 +127,11 @@ export const searchAfterAndBulkCreate = async ({ // filter out the search results that match with the values found in the list. // the resulting set are signals to be indexed, given they are not duplicates // of signals already present in the signals index. - const filteredEvents = await filterEventsAgainstList({ + const [includedEvents, _] = await filterEventsAgainstList({ listClient, exceptionsList, logger, - eventSearchResult: mergedSearchResults, + events: mergedSearchResults.hits.hits, buildRuleMessage, }); @@ -139,16 +139,11 @@ export const searchAfterAndBulkCreate = async ({ // if there isn't anything after going through the value list filter // skip the call to bulk create and proceed to the next search_after, // if there is a sort id to continue the search_after with. - if (filteredEvents.hits.hits.length !== 0) { + if (includedEvents.length !== 0) { // make sure we are not going to create more signals than maxSignals allows - if (signalsCreatedCount + filteredEvents.hits.hits.length > tuple.maxSignals) { - filteredEvents.hits.hits = filteredEvents.hits.hits.slice( - 0, - tuple.maxSignals - signalsCreatedCount - ); - } - const enrichedEvents = await enrichment(filteredEvents); - const wrappedDocs = wrapHits(enrichedEvents.hits.hits, buildReasonMessage); + const limitedEvents = includedEvents.slice(0, tuple.maxSignals - signalsCreatedCount); + const enrichedEvents = await enrichment(limitedEvents); + const wrappedDocs = wrapHits(enrichedEvents, buildReasonMessage); const { bulkCreateDuration: bulkDuration, @@ -171,9 +166,7 @@ export const searchAfterAndBulkCreate = async ({ signalsCreatedCount += createdCount; logger.debug(buildRuleMessage(`created ${createdCount} signals`)); logger.debug(buildRuleMessage(`signalsCreatedCount: ${signalsCreatedCount}`)); - logger.debug( - buildRuleMessage(`enrichedEvents.hits.hits: ${enrichedEvents.hits.hits.length}`) - ); + logger.debug(buildRuleMessage(`enrichedEvents.hits.hits: ${enrichedEvents.length}`)); sendAlertTelemetryEvents( logger, diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/send_telemetry_events.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/send_telemetry_events.test.ts index 36bb90936620b..d598b84ea99e2 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/send_telemetry_events.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/send_telemetry_events.test.ts @@ -9,100 +9,86 @@ import { selectEvents, enrichEndpointAlertsSignalID } from './send_telemetry_eve describe('sendAlertTelemetry', () => { it('selectEvents', () => { - const filteredEvents = { - took: 0, - timed_out: false, - _shards: { - total: 1, - successful: 1, - failed: 0, - skipped: 0, + const filteredEvents = [ + { + _index: 'x', + _type: 'x', + _id: 'x', + _score: 0, + _source: { + '@timestamp': 'x', + key1: 'hello', + data_stream: { + dataset: 'endpoint.events', + }, + event: { + id: 'foo', + }, + }, }, - hits: { - total: 2, - max_score: 0, - hits: [ - { - _index: 'x', - _type: 'x', - _id: 'x', - _score: 0, - _source: { - '@timestamp': 'x', - key1: 'hello', - data_stream: { - dataset: 'endpoint.events', - }, - event: { - id: 'foo', - }, - }, + { + _index: 'x', + _type: 'x', + _id: 'x', + _score: 0, + _source: { + '@timestamp': 'x', + key2: 'hello', + data_stream: { + dataset: 'endpoint.alerts', + other: 'x', + }, + event: { + id: 'bar', }, - { - _index: 'x', - _type: 'x', - _id: 'x', - _score: 0, - _source: { - '@timestamp': 'x', - key2: 'hello', - data_stream: { - dataset: 'endpoint.alerts', - other: 'x', - }, - event: { - id: 'bar', - }, - }, + }, + }, + { + _index: 'x', + _type: 'x', + _id: 'x', + _score: 0, + _source: { + '@timestamp': 'x', + key3: 'hello', + data_stream: {}, + event: { + id: 'baz', }, - { - _index: 'x', - _type: 'x', - _id: 'x', - _score: 0, - _source: { - '@timestamp': 'x', - key3: 'hello', - data_stream: {}, - event: { - id: 'baz', - }, - }, + }, + }, + { + _index: 'y', + _type: 'y', + _id: 'y', + _score: 0, + _source: { + '@timestamp': 'y', + key3: 'hello', + data_stream: { + dataset: 'endpoint.alerts', + other: 'y', }, - { - _index: 'y', - _type: 'y', - _id: 'y', - _score: 0, - _source: { - '@timestamp': 'y', - key3: 'hello', - data_stream: { - dataset: 'endpoint.alerts', - other: 'y', - }, - event: { - id: 'not-in-map', - }, - }, + event: { + id: 'not-in-map', }, - { - _index: 'z', - _type: 'z', - _id: 'z', - _score: 0, - _source: { - '@timestamp': 'z', - key3: 'no-event-id', - data_stream: { - dataset: 'endpoint.alerts', - other: 'z', - }, - }, + }, + }, + { + _index: 'z', + _type: 'z', + _id: 'z', + _score: 0, + _source: { + '@timestamp': 'z', + key3: 'no-event-id', + data_stream: { + dataset: 'endpoint.alerts', + other: 'z', }, - ], + }, }, - }; + ]; const joinMap = new Map([ ['foo', '1234'], ['bar', 'abcd'], diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/send_telemetry_events.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/send_telemetry_events.ts index 511f148f13d68..e419fdf632137 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/send_telemetry_events.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/send_telemetry_events.ts @@ -9,7 +9,7 @@ import { Logger } from '@kbn/core/server'; import { ITelemetryEventsSender } from '../../telemetry/sender'; import { TelemetryEvent } from '../../telemetry/types'; import { BuildRuleMessage } from './rule_messages'; -import { SignalSearchResponse, SignalSource } from './types'; +import { SignalSource, SignalSourceHit } from './types'; interface SearchResultSource { _source: SignalSource; @@ -18,9 +18,9 @@ interface SearchResultSource { type CreatedSignalId = string; type AlertId = string; -export function selectEvents(filteredEvents: SignalSearchResponse): TelemetryEvent[] { +export function selectEvents(filteredEvents: SignalSourceHit[]): TelemetryEvent[] { // @ts-expect-error @elastic/elasticsearch _source is optional - const sources: TelemetryEvent[] = filteredEvents.hits.hits.map(function ( + const sources: TelemetryEvent[] = filteredEvents.map(function ( obj: SearchResultSource ): TelemetryEvent { return obj._source; @@ -46,7 +46,7 @@ export function enrichEndpointAlertsSignalID( export function sendAlertTelemetryEvents( logger: Logger, eventsTelemetry: ITelemetryEventsSender | undefined, - filteredEvents: SignalSearchResponse, + filteredEvents: SignalSourceHit[], createdEvents: SignalSource[], buildRuleMessage: BuildRuleMessage ) { diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/threat_mapping/build_threat_enrichment.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/threat_mapping/build_threat_enrichment.ts index bc31ee660aad8..4c5391d238b31 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/threat_mapping/build_threat_enrichment.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/threat_mapping/build_threat_enrichment.ts @@ -5,7 +5,7 @@ * 2.0. */ -import { SignalSearchResponse, SignalsEnrichment } from '../types'; +import { SignalsEnrichment } from '../types'; import { enrichSignalThreatMatches } from './enrich_signal_threat_matches'; import { BuildThreatEnrichmentOptions, GetMatchedThreats } from './types'; import { getThreatList } from './get_threat_list'; @@ -55,6 +55,5 @@ export const buildThreatEnrichment = ({ return threatResponse.hits.hits; }; - return (signals: SignalSearchResponse): Promise => - enrichSignalThreatMatches(signals, getMatchedThreats, threatIndicatorPath); + return (signals) => enrichSignalThreatMatches(signals, getMatchedThreats, threatIndicatorPath); }; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/threat_mapping/create_event_signal.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/threat_mapping/create_event_signal.ts index c5d86c9ab460c..2587c76907ccb 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/threat_mapping/create_event_signal.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/threat_mapping/create_event_signal.ts @@ -10,7 +10,7 @@ import { getFilter } from '../get_filter'; import { searchAfterAndBulkCreate } from '../search_after_bulk_create'; import { buildReasonMessageForThreatMatchAlert } from '../reason_formatters'; import { CreateEventSignalOptions } from './types'; -import { SearchAfterAndBulkCreateReturnType, SignalSearchResponse } from '../types'; +import { SearchAfterAndBulkCreateReturnType, SignalSourceHit } from '../types'; import { getAllThreatListHits } from './get_threat_list'; import { enrichSignalThreatMatches, @@ -112,7 +112,7 @@ export const createEventSignal = async ({ ) ); - const threatEnrichment = (signals: SignalSearchResponse): Promise => + const threatEnrichment = (signals: SignalSourceHit[]): Promise => enrichSignalThreatMatches( signals, () => Promise.resolve(threatListHits), diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/threat_mapping/enrich_signal_threat_matches.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/threat_mapping/enrich_signal_threat_matches.test.ts index 66e44e5796eb6..b6df435c04dda 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/threat_mapping/enrich_signal_threat_matches.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/threat_mapping/enrich_signal_threat_matches.test.ts @@ -8,6 +8,7 @@ import { get } from 'lodash'; import { ENRICHMENT_DESTINATION_PATH } from '../../../../../common/constants'; import { ENRICHMENT_TYPES } from '../../../../../common/cti/constants'; +import { SignalSourceHit } from '../types'; import { getThreatListItemMock } from './build_threat_mapping_filter.mock'; import { @@ -16,11 +17,7 @@ import { groupAndMergeSignalMatches, getSignalMatchesFromThreatList, } from './enrich_signal_threat_matches'; -import { - getNamedQueryMock, - getSignalHitMock, - getSignalsResponseMock, -} from './enrich_signal_threat_matches.mock'; +import { getNamedQueryMock, getSignalHitMock } from './enrich_signal_threat_matches.mock'; import { GetMatchedThreats, ThreatListItem, ThreatMatchNamedQuery } from './types'; import { encodeThreatMatchNamedQuery } from './utils'; @@ -507,14 +504,14 @@ describe('enrichSignalThreatMatches', () => { }); it('performs no enrichment if there are no signals', async () => { - const signals = getSignalsResponseMock([]); + const signals: SignalSourceHit[] = []; const enrichedSignals = await enrichSignalThreatMatches( signals, getMatchedThreats, indicatorPath ); - expect(enrichedSignals.hits.hits).toEqual([]); + expect(enrichedSignals).toEqual([]); }); it('preserves existing threat.enrichments objects on signals', async () => { @@ -526,13 +523,13 @@ describe('enrichSignalThreatMatches', () => { }, matched_queries: [matchedQuery], }); - const signals = getSignalsResponseMock([signalHit]); + const signals: SignalSourceHit[] = [signalHit]; const enrichedSignals = await enrichSignalThreatMatches( signals, getMatchedThreats, indicatorPath ); - const [enrichedHit] = enrichedSignals.hits.hits; + const [enrichedHit] = enrichedSignals; const enrichments = get(enrichedHit._source, ENRICHMENT_DESTINATION_PATH); expect(enrichments).toEqual([ @@ -560,13 +557,13 @@ describe('enrichSignalThreatMatches', () => { const signalHit = getSignalHitMock({ matched_queries: [matchedQuery], }); - const signals = getSignalsResponseMock([signalHit]); + const signals: SignalSourceHit[] = [signalHit]; const enrichedSignals = await enrichSignalThreatMatches( signals, getMatchedThreats, indicatorPath ); - const [enrichedHit] = enrichedSignals.hits.hits; + const [enrichedHit] = enrichedSignals; const enrichments = get(enrichedHit._source, ENRICHMENT_DESTINATION_PATH); expect(enrichments).toEqual([ @@ -598,13 +595,13 @@ describe('enrichSignalThreatMatches', () => { }, matched_queries: [matchedQuery], }); - const signals = getSignalsResponseMock([signalHit]); + const signals: SignalSourceHit[] = [signalHit]; const enrichedSignals = await enrichSignalThreatMatches( signals, getMatchedThreats, indicatorPath ); - const [enrichedHit] = enrichedSignals.hits.hits; + const [enrichedHit] = enrichedSignals; const enrichments = get(enrichedHit._source, ENRICHMENT_DESTINATION_PATH); expect(enrichments).toEqual([ @@ -637,7 +634,7 @@ describe('enrichSignalThreatMatches', () => { _source: { '@timestamp': 'mocked', threat: 'whoops' }, matched_queries: [matchedQuery], }); - const signals = getSignalsResponseMock([signalHit]); + const signals: SignalSourceHit[] = [signalHit]; await expect(() => enrichSignalThreatMatches(signals, getMatchedThreats, indicatorPath) ).rejects.toThrowError('Expected threat field to be an object, but found: whoops'); @@ -674,13 +671,13 @@ describe('enrichSignalThreatMatches', () => { }, matched_queries: [matchedQuery], }); - const signals = getSignalsResponseMock([signalHit]); + const signals: SignalSourceHit[] = [signalHit]; const enrichedSignals = await enrichSignalThreatMatches( signals, getMatchedThreats, 'custom_threat.custom_indicator' ); - const [enrichedHit] = enrichedSignals.hits.hits; + const [enrichedHit] = enrichedSignals; const enrichments = get(enrichedHit._source, ENRICHMENT_DESTINATION_PATH); expect(enrichments).toEqual([ @@ -748,16 +745,15 @@ describe('enrichSignalThreatMatches', () => { ), ], }); - const signals = getSignalsResponseMock([signalHit, otherSignalHit]); + const signals: SignalSourceHit[] = [signalHit, otherSignalHit]; const enrichedSignals = await enrichSignalThreatMatches( signals, getMatchedThreats, indicatorPath ); - expect(enrichedSignals.hits.total).toEqual(expect.objectContaining({ value: 1 })); - expect(enrichedSignals.hits.hits).toHaveLength(1); + expect(enrichedSignals).toHaveLength(1); - const [enrichedHit] = enrichedSignals.hits.hits; + const [enrichedHit] = enrichedSignals; const enrichments = get(enrichedHit._source, ENRICHMENT_DESTINATION_PATH); expect(enrichments).toEqual([ diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/threat_mapping/enrich_signal_threat_matches.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/threat_mapping/enrich_signal_threat_matches.ts index c1fb88176fd4c..58a486068013f 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/threat_mapping/enrich_signal_threat_matches.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/threat_mapping/enrich_signal_threat_matches.ts @@ -8,7 +8,7 @@ import { get, isObject } from 'lodash'; import { ENRICHMENT_TYPES, FEED_NAME_PATH } from '../../../../../common/cti/constants'; -import type { SignalSearchResponse, SignalSourceHit } from '../types'; +import type { SignalSourceHit } from '../types'; import type { GetMatchedThreats, ThreatEnrichment, @@ -109,17 +109,16 @@ export const buildEnrichments = ({ }); export const enrichSignalThreatMatches = async ( - signals: SignalSearchResponse, + signals: SignalSourceHit[], getMatchedThreats: GetMatchedThreats, indicatorPath: string, signalMatchesArg?: SignalMatch[] -): Promise => { - const signalHits = signals.hits.hits; - if (signalHits.length === 0) { +): Promise => { + if (signals.length === 0) { return signals; } - const uniqueHits = groupAndMergeSignalMatches(signalHits); + const uniqueHits = groupAndMergeSignalMatches(signals); const signalMatches: SignalMatch[] = signalMatchesArg ? signalMatchesArg : uniqueHits.map((signalHit) => ({ @@ -177,14 +176,5 @@ export const enrichSignalThreatMatches = async ( }; }); - return { - ...signals, - hits: { - ...signals.hits, - hits: enrichedSignals, - total: isObject(signals.hits.total) - ? { ...signals.hits.total, value: enrichedSignals.length } - : enrichedSignals.length, - }, - }; + return enrichedSignals; }; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/types.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/types.ts index 235865a8b60a9..5dc19b1b257b8 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/types.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/types.ts @@ -277,7 +277,7 @@ export interface AlertAttributes { export type BulkResponseErrorAggregation = Record; -export type SignalsEnrichment = (signals: SignalSearchResponse) => Promise; +export type SignalsEnrichment = (signals: SignalSourceHit[]) => Promise; export type BulkCreate = ( docs: Array> diff --git a/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/all/__mocks__/index.ts b/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/all/__mocks__/index.ts index bc31f64fcc626..346c8845751ce 100644 --- a/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/all/__mocks__/index.ts +++ b/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/all/__mocks__/index.ts @@ -13,12 +13,6 @@ import { UsersFields } from '../../../../../../../common/search_strategy/securit export const mockOptions: UsersRequestOptions = { defaultIndex: ['test_indices*'], - docValueFields: [ - { - field: '@timestamp', - format: 'date_time', - }, - ], factoryQueryType: UsersQueries.users, filterQuery: '{"bool":{"must":[],"filter":[{"match_all":{}},{"match_phrase":{"user.name":{"query":"test_user"}}}],"should":[],"must_not":[]}}', @@ -78,10 +72,12 @@ export const mockSearchStrategyResponse: IEsSearchResponse = { _index: 'endgame-00001', _id: 'inT0934BjUd1_U2597Vf', _score: null, - _source: { - user: { - domain: 'ENDPOINT-W-8-03', - }, + fields: { + 'user.name': ['jose52'], + '@timestamp': ['2022-04-13T17:16:34.540Z'], + 'user.id': ['17'], + 'user.email': ['jose52@barrett.com'], + 'user.domain': ['ENDPOINT-W-8-03'], }, sort: [1644837532000], }, diff --git a/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/all/__snapshots__/index.test.ts.snap b/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/all/__snapshots__/index.test.ts.snap index b52d0b1fc1cfd..6383808293a9d 100644 --- a/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/all/__snapshots__/index.test.ts.snap +++ b/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/all/__snapshots__/index.test.ts.snap @@ -3,7 +3,9 @@ exports[`allHosts search strategy parse should parse data correctly 1`] = ` Array [ Object { - "domain": "ENDPOINT-W-8-03", + "domain": Array [ + "ENDPOINT-W-8-03", + ], "lastSeen": "2022-02-14T11:18:52.000Z", "name": "vagrant", }, diff --git a/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/all/__snapshots__/query.all_users.dsl.test.ts.snap b/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/all/__snapshots__/query.all_users.dsl.test.ts.snap index 99f85724d2f5c..2b661fe355a13 100644 --- a/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/all/__snapshots__/query.all_users.dsl.test.ts.snap +++ b/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/all/__snapshots__/query.all_users.dsl.test.ts.snap @@ -4,6 +4,7 @@ exports[`buildUsersQuery build query from options correctly 1`] = ` Object { "allow_no_indices": true, "body": Object { + "_source": false, "aggregations": Object { "user_count": Object { "cardinality": Object { @@ -14,11 +15,7 @@ Object { "aggs": Object { "domain": Object { "top_hits": Object { - "_source": Object { - "includes": Array [ - "user.domain", - ], - }, + "_source": false, "size": 1, "sort": Array [ Object { @@ -44,10 +41,12 @@ Object { }, }, }, - "docvalue_fields": Array [ + "fields": Array [ + "user.name", + "user.domain", Object { "field": "@timestamp", - "format": "date_time", + "format": "strict_date_optional_time", }, ], "query": Object { diff --git a/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/all/index.ts b/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/all/index.ts index b8babe0b19845..9c62e55cc0bb1 100644 --- a/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/all/index.ts +++ b/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/all/index.ts @@ -50,7 +50,7 @@ export const allUsers: SecuritySolutionFactory = { (bucket: AllUsersAggEsItem) => ({ name: bucket.key, lastSeen: getOr(null, `lastSeen.value_as_string`, bucket), - domain: getOr(null, `domain.hits.hits[0]._source.user.domain`, bucket), + domain: getOr(null, `domain.hits.hits[0].fields['user.domain']`, bucket), }), {} ); diff --git a/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/all/query.all_users.dsl.ts b/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/all/query.all_users.dsl.ts index 82df1d2d97246..d7f8f7e50abe1 100644 --- a/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/all/query.all_users.dsl.ts +++ b/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/all/query.all_users.dsl.ts @@ -5,7 +5,6 @@ * 2.0. */ -import { isEmpty } from 'lodash/fp'; import type { ISearchRequestParams } from '@kbn/data-plugin/common'; import { Direction } from '../../../../../../common/search_strategy'; import { createQueryFilterClauses } from '../../../../../utils/build_query'; @@ -18,7 +17,6 @@ import { assertUnreachable } from '../../../../../../common/utility_types'; export const buildUsersQuery = ({ defaultIndex, - docValueFields, filterQuery, pagination: { querySize }, sort, @@ -43,7 +41,6 @@ export const buildUsersQuery = ({ ignore_unavailable: true, track_total_hits: false, body: { - ...(!isEmpty(docValueFields) ? { docvalue_fields: docValueFields } : {}), aggregations: { user_count: { cardinality: { field: 'user.name' } }, user_data: { @@ -60,15 +57,22 @@ export const buildUsersQuery = ({ }, }, ], - _source: { - includes: ['user.domain'], - }, + _source: false, }, }, }, }, }, query: { bool: { filter } }, + _source: false, + fields: [ + 'user.name', + 'user.domain', + { + field: '@timestamp', + format: 'strict_date_optional_time', + }, + ], size: 0, }, }; diff --git a/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/authentications/__mocks__/index.ts b/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/authentications/__mocks__/index.ts index 487f4537cd50d..028ee4e4ba1b9 100644 --- a/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/authentications/__mocks__/index.ts +++ b/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/authentications/__mocks__/index.ts @@ -26,408 +26,6 @@ export const mockOptions: UserAuthenticationsRequestOptions = { 'winlogbeat-*', ], stackByField: AuthStackByField.userName, - docValueFields: [ - { - field: '@timestamp', - format: 'date_time', - }, - { - field: 'event.created', - format: 'date_time', - }, - { - field: 'event.end', - format: 'date_time', - }, - { - field: 'event.ingested', - format: 'date_time', - }, - { - field: 'event.start', - format: 'date_time', - }, - { - field: 'file.accessed', - format: 'date_time', - }, - { - field: 'file.created', - format: 'date_time', - }, - { - field: 'file.ctime', - format: 'date_time', - }, - { - field: 'file.mtime', - format: 'date_time', - }, - { - field: 'package.installed', - format: 'date_time', - }, - { - field: 'process.parent.start', - format: 'date_time', - }, - { - field: 'process.start', - format: 'date_time', - }, - { - field: 'system.audit.host.boottime', - format: 'date_time', - }, - { - field: 'system.audit.package.installtime', - format: 'date_time', - }, - { - field: 'system.audit.user.password.last_changed', - format: 'date_time', - }, - { - field: 'tls.client.not_after', - format: 'date_time', - }, - { - field: 'tls.client.not_before', - format: 'date_time', - }, - { - field: 'tls.server.not_after', - format: 'date_time', - }, - { - field: 'tls.server.not_before', - format: 'date_time', - }, - { - field: 'aws.cloudtrail.user_identity.session_context.creation_date', - format: 'date_time', - }, - { - field: 'azure.auditlogs.properties.activity_datetime', - format: 'date_time', - }, - { - field: 'azure.enqueued_time', - format: 'date_time', - }, - { - field: 'azure.signinlogs.properties.created_at', - format: 'date_time', - }, - { - field: 'cef.extensions.agentReceiptTime', - format: 'date_time', - }, - { - field: 'cef.extensions.deviceCustomDate1', - format: 'date_time', - }, - { - field: 'cef.extensions.deviceCustomDate2', - format: 'date_time', - }, - { - field: 'cef.extensions.deviceReceiptTime', - format: 'date_time', - }, - { - field: 'cef.extensions.endTime', - format: 'date_time', - }, - { - field: 'cef.extensions.fileCreateTime', - format: 'date_time', - }, - { - field: 'cef.extensions.fileModificationTime', - format: 'date_time', - }, - { - field: 'cef.extensions.flexDate1', - format: 'date_time', - }, - { - field: 'cef.extensions.managerReceiptTime', - format: 'date_time', - }, - { - field: 'cef.extensions.oldFileCreateTime', - format: 'date_time', - }, - { - field: 'cef.extensions.oldFileModificationTime', - format: 'date_time', - }, - { - field: 'cef.extensions.startTime', - format: 'date_time', - }, - { - field: 'checkpoint.subs_exp', - format: 'date_time', - }, - { - field: 'crowdstrike.event.EndTimestamp', - format: 'date_time', - }, - { - field: 'crowdstrike.event.IncidentEndTime', - format: 'date_time', - }, - { - field: 'crowdstrike.event.IncidentStartTime', - format: 'date_time', - }, - { - field: 'crowdstrike.event.ProcessEndTime', - format: 'date_time', - }, - { - field: 'crowdstrike.event.ProcessStartTime', - format: 'date_time', - }, - { - field: 'crowdstrike.event.StartTimestamp', - format: 'date_time', - }, - { - field: 'crowdstrike.event.Timestamp', - format: 'date_time', - }, - { - field: 'crowdstrike.event.UTCTimestamp', - format: 'date_time', - }, - { - field: 'crowdstrike.metadata.eventCreationTime', - format: 'date_time', - }, - { - field: 'gsuite.admin.email.log_search_filter.end_date', - format: 'date_time', - }, - { - field: 'gsuite.admin.email.log_search_filter.start_date', - format: 'date_time', - }, - { - field: 'gsuite.admin.user.birthdate', - format: 'date_time', - }, - { - field: 'kafka.block_timestamp', - format: 'date_time', - }, - { - field: 'microsoft.defender_atp.lastUpdateTime', - format: 'date_time', - }, - { - field: 'microsoft.defender_atp.resolvedTime', - format: 'date_time', - }, - { - field: 'misp.campaign.first_seen', - format: 'date_time', - }, - { - field: 'misp.campaign.last_seen', - format: 'date_time', - }, - { - field: 'misp.intrusion_set.first_seen', - format: 'date_time', - }, - { - field: 'misp.intrusion_set.last_seen', - format: 'date_time', - }, - { - field: 'misp.observed_data.first_observed', - format: 'date_time', - }, - { - field: 'misp.observed_data.last_observed', - format: 'date_time', - }, - { - field: 'misp.report.published', - format: 'date_time', - }, - { - field: 'misp.threat_indicator.valid_from', - format: 'date_time', - }, - { - field: 'misp.threat_indicator.valid_until', - format: 'date_time', - }, - { - field: 'netflow.collection_time_milliseconds', - format: 'date_time', - }, - { - field: 'netflow.exporter.timestamp', - format: 'date_time', - }, - { - field: 'netflow.flow_end_microseconds', - format: 'date_time', - }, - { - field: 'netflow.flow_end_milliseconds', - format: 'date_time', - }, - { - field: 'netflow.flow_end_nanoseconds', - format: 'date_time', - }, - { - field: 'netflow.flow_end_seconds', - format: 'date_time', - }, - { - field: 'netflow.flow_start_microseconds', - format: 'date_time', - }, - { - field: 'netflow.flow_start_milliseconds', - format: 'date_time', - }, - { - field: 'netflow.flow_start_nanoseconds', - format: 'date_time', - }, - { - field: 'netflow.flow_start_seconds', - format: 'date_time', - }, - { - field: 'netflow.max_export_seconds', - format: 'date_time', - }, - { - field: 'netflow.max_flow_end_microseconds', - format: 'date_time', - }, - { - field: 'netflow.max_flow_end_milliseconds', - format: 'date_time', - }, - { - field: 'netflow.max_flow_end_nanoseconds', - format: 'date_time', - }, - { - field: 'netflow.max_flow_end_seconds', - format: 'date_time', - }, - { - field: 'netflow.min_export_seconds', - format: 'date_time', - }, - { - field: 'netflow.min_flow_start_microseconds', - format: 'date_time', - }, - { - field: 'netflow.min_flow_start_milliseconds', - format: 'date_time', - }, - { - field: 'netflow.min_flow_start_nanoseconds', - format: 'date_time', - }, - { - field: 'netflow.min_flow_start_seconds', - format: 'date_time', - }, - { - field: 'netflow.monitoring_interval_end_milli_seconds', - format: 'date_time', - }, - { - field: 'netflow.monitoring_interval_start_milli_seconds', - format: 'date_time', - }, - { - field: 'netflow.observation_time_microseconds', - format: 'date_time', - }, - { - field: 'netflow.observation_time_milliseconds', - format: 'date_time', - }, - { - field: 'netflow.observation_time_nanoseconds', - format: 'date_time', - }, - { - field: 'netflow.observation_time_seconds', - format: 'date_time', - }, - { - field: 'netflow.system_init_time_milliseconds', - format: 'date_time', - }, - { - field: 'rsa.internal.lc_ctime', - format: 'date_time', - }, - { - field: 'rsa.internal.time', - format: 'date_time', - }, - { - field: 'rsa.time.effective_time', - format: 'date_time', - }, - { - field: 'rsa.time.endtime', - format: 'date_time', - }, - { - field: 'rsa.time.event_queue_time', - format: 'date_time', - }, - { - field: 'rsa.time.event_time', - format: 'date_time', - }, - { - field: 'rsa.time.expire_time', - format: 'date_time', - }, - { - field: 'rsa.time.recorded_time', - format: 'date_time', - }, - { - field: 'rsa.time.stamp', - format: 'date_time', - }, - { - field: 'rsa.time.starttime', - format: 'date_time', - }, - { - field: 'sophos.xg.date', - format: 'date_time', - }, - { - field: 'sophos.xg.eventtime', - format: 'date_time', - }, - { - field: 'sophos.xg.start_time', - format: 'date_time', - }, - ], factoryQueryType: UsersQueries.authentications, filterQuery: '{"bool":{"must":[],"filter":[{"match_all":{}}],"should":[],"must_not":[]}}', pagination: { @@ -481,106 +79,10 @@ export const mockSearchStrategyResponse: IEsSearchResponse = { _index: 'winlogbeat-8.0.0-2020.09.02-000001', _id: 'zqY7WXQBA6bGZw2uLeKI', _score: null, - _source: { - process: { - name: 'services.exe', - pid: 564, - executable: 'C:\\Windows\\System32\\services.exe', - }, - agent: { - build_date: '2020-07-16 09:16:27 +0000 UTC ', - name: 'siem-windows', - commit: '4dcbde39492bdc3843034bba8db811c68cb44b97 ', - id: '05e1bff7-d7a8-416a-8554-aa10288fa07d', - type: 'winlogbeat', - ephemeral_id: '655abd6c-6c33-435d-a2eb-79b2a01e6d61', - version: '8.0.0', - user: { name: 'inside_winlogbeat_user' }, - }, - winlog: { - computer_name: 'siem-windows', - process: { pid: 576, thread: { id: 880 } }, - keywords: ['Audit Success'], - logon: { id: '0x3e7', type: 'Service' }, - channel: 'Security', - event_data: { - LogonGuid: '{00000000-0000-0000-0000-000000000000}', - TargetOutboundDomainName: '-', - VirtualAccount: '%%1843', - LogonType: '5', - IpPort: '-', - TransmittedServices: '-', - SubjectLogonId: '0x3e7', - LmPackageName: '-', - TargetOutboundUserName: '-', - KeyLength: '0', - TargetLogonId: '0x3e7', - RestrictedAdminMode: '-', - SubjectUserName: 'SIEM-WINDOWS$', - TargetLinkedLogonId: '0x0', - ElevatedToken: '%%1842', - SubjectDomainName: 'WORKGROUP', - IpAddress: '-', - ImpersonationLevel: '%%1833', - TargetUserName: 'SYSTEM', - LogonProcessName: 'Advapi ', - TargetDomainName: 'NT AUTHORITY', - SubjectUserSid: 'S-1-5-18', - TargetUserSid: 'S-1-5-18', - AuthenticationPackageName: 'Negotiate', - }, - opcode: 'Info', - version: 2, - record_id: 57818, - task: 'Logon', - event_id: 4624, - provider_guid: '{54849625-5478-4994-a5ba-3e3b0328c30d}', - activity_id: '{d2485217-6bac-0000-8fbb-3f7e2571d601}', - api: 'wineventlog', - provider_name: 'Microsoft-Windows-Security-Auditing', - }, - log: { level: 'information' }, - source: { domain: '-' }, - message: - 'An account was successfully logged on.\n\nSubject:\n\tSecurity ID:\t\tS-1-5-18\n\tAccount Name:\t\tSIEM-WINDOWS$\n\tAccount Domain:\t\tWORKGROUP\n\tLogon ID:\t\t0x3E7\n\nLogon Information:\n\tLogon Type:\t\t5\n\tRestricted Admin Mode:\t-\n\tVirtual Account:\t\tNo\n\tElevated Token:\t\tYes\n\nImpersonation Level:\t\tImpersonation\n\nNew Logon:\n\tSecurity ID:\t\tS-1-5-18\n\tAccount Name:\t\tSYSTEM\n\tAccount Domain:\t\tNT AUTHORITY\n\tLogon ID:\t\t0x3E7\n\tLinked Logon ID:\t\t0x0\n\tNetwork Account Name:\t-\n\tNetwork Account Domain:\t-\n\tLogon GUID:\t\t{00000000-0000-0000-0000-000000000000}\n\nProcess Information:\n\tProcess ID:\t\t0x234\n\tProcess Name:\t\tC:\\Windows\\System32\\services.exe\n\nNetwork Information:\n\tWorkstation Name:\t-\n\tSource Network Address:\t-\n\tSource Port:\t\t-\n\nDetailed Authentication Information:\n\tLogon Process:\t\tAdvapi \n\tAuthentication Package:\tNegotiate\n\tTransited Services:\t-\n\tPackage Name (NTLM only):\t-\n\tKey Length:\t\t0\n\nThis event is generated when a logon session is created. It is generated on the computer that was accessed.\n\nThe subject fields indicate the account on the local system which requested the logon. This is most commonly a service such as the Server service, or a local process such as Winlogon.exe or Services.exe.\n\nThe logon type field indicates the kind of logon that occurred. The most common types are 2 (interactive) and 3 (network).\n\nThe New Logon fields indicate the account for whom the new logon was created, i.e. the account that was logged on.\n\nThe network fields indicate where a remote logon request originated. Workstation name is not always available and may be left blank in some cases.\n\nThe impersonation level field indicates the extent to which a process in the logon session can impersonate.\n\nThe authentication information fields provide detailed information about this specific logon request.\n\t- Logon GUID is a unique identifier that can be used to correlate this event with a KDC event.\n\t- Transited services indicate which intermediate services have participated in this logon request.\n\t- Package name indicates which sub-protocol was used among the NTLM protocols.\n\t- Key length indicates the length of the generated session key. This will be 0 if no session key was requested.', - cloud: { - availability_zone: 'us-central1-c', - instance: { name: 'siem-windows', id: '9156726559029788564' }, - provider: 'gcp', - machine: { type: 'g1-small' }, - project: { id: 'elastic-siem' }, - }, - '@timestamp': '2020-09-04T13:08:02.532Z', - related: { user: ['SYSTEM', 'SIEM-WINDOWS$'] }, - ecs: { version: '1.5.0' }, - host: { - hostname: 'siem-windows', - os: { - build: '17763.1397', - kernel: '10.0.17763.1397 (WinBuild.160101.0800)', - name: 'Windows Server 2019 Datacenter', - family: 'windows', - version: '10.0', - platform: 'windows', - }, - ip: ['fe80::ecf5:decc:3ec3:767e', '10.200.0.15'], - name: 'siem-windows', - id: 'ce1d3c9b-a815-4643-9641-ada0f2c00609', - mac: ['42:01:0a:c8:00:0f'], - architecture: 'x86_64', - }, - event: { - code: 4624, - provider: 'Microsoft-Windows-Security-Auditing', - created: '2020-09-04T13:08:03.638Z', - kind: 'event', - module: 'security', - action: 'logged-in', - category: 'authentication', - type: 'start', - outcome: 'success', - }, - user: { domain: 'NT AUTHORITY', name: 'SYSTEM', id: 'S-1-5-18' }, + fields: { + '@timestamp': ['2020-09-04T13:08:02.532Z'], + 'host.id': ['ce1d3c9b-a815-4643-9641-ada0f2c00609'], + 'host.name': ['siem-windows'], }, sort: [1599224882532], }, @@ -607,76 +109,11 @@ export const mockSearchStrategyResponse: IEsSearchResponse = { _index: '.ds-logs-system.auth-default-000001', _id: '9_sfWXQBc39KFIJbIsDh', _score: null, - _source: { - agent: { - hostname: 'siem-kibana', - name: 'siem-kibana', - id: 'aa3d9dc7-fef1-4c2f-a68d-25785d624e35', - ephemeral_id: 'e503bd85-11c7-4bc9-ae7d-70be1d919fb7', - type: 'filebeat', - version: '7.9.1', - }, - process: { name: 'sshd', pid: 20764 }, - log: { file: { path: '/var/log/auth.log' }, offset: 552463 }, - source: { - geo: { - continent_name: 'Europe', - region_iso_code: 'DE-BE', - city_name: 'Berlin', - country_iso_code: 'DE', - region_name: 'Land Berlin', - location: { lon: 13.3512, lat: 52.5727 }, - }, - as: { number: 6805, organization: { name: 'Telefonica Germany' } }, - port: 57457, - ip: '77.183.42.188', - }, - cloud: { - availability_zone: 'us-east1-b', - instance: { name: 'siem-kibana', id: '5412578377715150143' }, - provider: 'gcp', - machine: { type: 'n1-standard-2' }, - project: { id: 'elastic-beats' }, - }, - input: { type: 'log' }, - '@timestamp': '2020-09-04T11:49:21.000Z', - system: { - auth: { - ssh: { - method: 'publickey', - signature: 'RSA SHA256:vv64JNLzKZWYA9vonnGWuW7zxWhyZrL/BFxyIGbISx8', - event: 'Accepted', - }, - }, - }, - ecs: { version: '1.5.0' }, - data_stream: { namespace: 'default', type: 'logs', dataset: 'system.auth' }, - host: { - hostname: 'siem-kibana', - os: { - kernel: '4.9.0-8-amd64', - codename: 'stretch', - name: 'Debian GNU/Linux', - family: 'debian', - version: '9 (stretch)', - platform: 'debian', - }, - containerized: false, - ip: ['10.142.0.7', 'fe80::4001:aff:fe8e:7'], - name: 'siem-kibana', - id: 'aa7ca589f1b8220002f2fc61c64cfbf1', - mac: ['42:01:0a:8e:00:07'], - architecture: 'x86_64', - }, - event: { - timezone: '+00:00', - action: 'ssh_login', - type: 'authentication_success', - category: 'authentication', - dataset: 'system.auth', - outcome: 'success', - }, - user: { name: 'tsg' }, + fields: { + 'source.ip': ['77.183.42.188'], + 'host.id': ['aa7ca589f1b8220002f2fc61c64cfbf1'], + 'host.name': ['siem-kibana'], + '@timestamp': ['2020-09-04T11:49:21.000Z'], }, sort: [1599220161000], }, @@ -699,67 +136,11 @@ export const mockSearchStrategyResponse: IEsSearchResponse = { _index: '.ds-logs-system.auth-default-000001', _id: 'ZfxZWXQBc39KFIJbLN5U', _score: null, - _source: { - agent: { - hostname: 'siem-kibana', - name: 'siem-kibana', - id: 'aa3d9dc7-fef1-4c2f-a68d-25785d624e35', - ephemeral_id: 'e503bd85-11c7-4bc9-ae7d-70be1d919fb7', - type: 'filebeat', - version: '7.9.1', - }, - process: { name: 'sshd', pid: 22913 }, - log: { file: { path: '/var/log/auth.log' }, offset: 562910 }, - source: { - geo: { - continent_name: 'Asia', - region_iso_code: 'KR-28', - city_name: 'Incheon', - country_iso_code: 'KR', - region_name: 'Incheon', - location: { lon: 126.7288, lat: 37.4562 }, - }, - as: { number: 4766, organization: { name: 'Korea Telecom' } }, - ip: '59.15.3.197', - }, - cloud: { - availability_zone: 'us-east1-b', - instance: { name: 'siem-kibana', id: '5412578377715150143' }, - provider: 'gcp', - machine: { type: 'n1-standard-2' }, - project: { id: 'elastic-beats' }, - }, - input: { type: 'log' }, - '@timestamp': '2020-09-04T13:40:46.000Z', - system: { auth: { ssh: { event: 'Invalid' } } }, - ecs: { version: '1.5.0' }, - data_stream: { namespace: 'default', type: 'logs', dataset: 'system.auth' }, - host: { - hostname: 'siem-kibana', - os: { - kernel: '4.9.0-8-amd64', - codename: 'stretch', - name: 'Debian GNU/Linux', - family: 'debian', - version: '9 (stretch)', - platform: 'debian', - }, - containerized: false, - ip: ['10.142.0.7', 'fe80::4001:aff:fe8e:7'], - name: 'siem-kibana', - id: 'aa7ca589f1b8220002f2fc61c64cfbf1', - mac: ['42:01:0a:8e:00:07'], - architecture: 'x86_64', - }, - event: { - timezone: '+00:00', - action: 'ssh_login', - type: 'authentication_failure', - category: 'authentication', - dataset: 'system.auth', - outcome: 'failure', - }, - user: { name: 'admin' }, + fields: { + 'source.ip': ['59.15.3.197'], + 'host.id': ['aa7ca589f1b8220002f2fc61c64cfbf1'], + 'host.name': ['siem-kibana'], + '@timestamp': ['2020-09-04T13:40:46.000Z'], }, sort: [1599226846000], }, @@ -786,47 +167,10 @@ export const mockSearchStrategyResponse: IEsSearchResponse = { _index: 'filebeat-8.0.0-2020.09.02-000001', _id: 'M_xLWXQBc39KFIJbY7Cb', _score: null, - _source: { - agent: { - name: 'bastion00.siem.estc.dev', - id: 'f9a321c1-ec27-49fa-aacf-6a50ef6d836f', - type: 'filebeat', - ephemeral_id: '734ee3da-1a4f-4bc9-b400-e0cf0e5eeebc', - version: '8.0.0', - }, - process: { name: 'sshd', pid: 20671 }, - log: { file: { path: '/var/log/auth.log' }, offset: 1028103 }, - source: { - geo: { - continent_name: 'North America', - region_iso_code: 'US-NY', - city_name: 'New York', - country_iso_code: 'US', - region_name: 'New York', - location: { lon: -74, lat: 40.7157 }, - }, - ip: '64.227.88.245', - }, - fileset: { name: 'auth' }, - input: { type: 'log' }, - '@timestamp': '2020-09-04T13:25:43.000Z', - system: { auth: { ssh: { event: 'Invalid' } } }, - ecs: { version: '1.5.0' }, - related: { ip: ['64.227.88.245'], user: ['user'] }, - service: { type: 'system' }, - host: { hostname: 'bastion00', name: 'bastion00.siem.estc.dev' }, - event: { - ingested: '2020-09-04T13:25:47.034172Z', - timezone: '+00:00', - kind: 'event', - module: 'system', - action: 'ssh_login', - type: ['authentication_failure', 'info'], - category: ['authentication'], - dataset: 'system.auth', - outcome: 'failure', - }, - user: { name: 'user' }, + fields: { + 'source.ip': ['64.227.88.245'], + 'host.name': ['bastion00.siem.estc.dev'], + '@timestamp': ['2020-09-04T13:25:43.000Z'], }, sort: [1599225943000], }, @@ -853,47 +197,10 @@ export const mockSearchStrategyResponse: IEsSearchResponse = { _index: 'filebeat-8.0.0-2020.09.02-000001', _id: 'nPxKWXQBc39KFIJb7q4w', _score: null, - _source: { - agent: { - name: 'bastion00.siem.estc.dev', - id: 'f9a321c1-ec27-49fa-aacf-6a50ef6d836f', - ephemeral_id: '734ee3da-1a4f-4bc9-b400-e0cf0e5eeebc', - type: 'filebeat', - version: '8.0.0', - }, - process: { name: 'sshd', pid: 20665 }, - log: { file: { path: '/var/log/auth.log' }, offset: 1027372 }, - source: { - geo: { - continent_name: 'North America', - region_iso_code: 'US-NY', - city_name: 'New York', - country_iso_code: 'US', - region_name: 'New York', - location: { lon: -74, lat: 40.7157 }, - }, - ip: '64.227.88.245', - }, - fileset: { name: 'auth' }, - input: { type: 'log' }, - '@timestamp': '2020-09-04T13:25:07.000Z', - system: { auth: { ssh: { event: 'Invalid' } } }, - ecs: { version: '1.5.0' }, - related: { ip: ['64.227.88.245'], user: ['ubuntu'] }, - service: { type: 'system' }, - host: { hostname: 'bastion00', name: 'bastion00.siem.estc.dev' }, - event: { - ingested: '2020-09-04T13:25:16.974606Z', - timezone: '+00:00', - kind: 'event', - module: 'system', - action: 'ssh_login', - type: ['authentication_failure', 'info'], - category: ['authentication'], - dataset: 'system.auth', - outcome: 'failure', - }, - user: { name: 'ubuntu' }, + fields: { + 'source.ip': ['64.227.88.245'], + 'host.name': ['bastion00.siem.estc.dev'], + '@timestamp': ['2020-09-04T13:25:07.000Z'], }, sort: [1599225907000], }, @@ -920,67 +227,11 @@ export const mockSearchStrategyResponse: IEsSearchResponse = { _index: '.ds-logs-system.auth-default-000001', _id: 'mPsfWXQBc39KFIJbI8HI', _score: null, - _source: { - agent: { - hostname: 'siem-kibana', - name: 'siem-kibana', - id: 'aa3d9dc7-fef1-4c2f-a68d-25785d624e35', - type: 'filebeat', - ephemeral_id: 'e503bd85-11c7-4bc9-ae7d-70be1d919fb7', - version: '7.9.1', - }, - process: { name: 'sshd', pid: 21506 }, - log: { file: { path: '/var/log/auth.log' }, offset: 556761 }, - source: { - geo: { - continent_name: 'Asia', - region_iso_code: 'IN-DL', - city_name: 'New Delhi', - country_iso_code: 'IN', - region_name: 'National Capital Territory of Delhi', - location: { lon: 77.2245, lat: 28.6358 }, - }, - as: { number: 10029, organization: { name: 'SHYAM SPECTRA PVT LTD' } }, - ip: '180.151.228.166', - }, - cloud: { - availability_zone: 'us-east1-b', - instance: { name: 'siem-kibana', id: '5412578377715150143' }, - provider: 'gcp', - machine: { type: 'n1-standard-2' }, - project: { id: 'elastic-beats' }, - }, - input: { type: 'log' }, - '@timestamp': '2020-09-04T12:26:36.000Z', - system: { auth: { ssh: { event: 'Invalid' } } }, - ecs: { version: '1.5.0' }, - data_stream: { namespace: 'default', type: 'logs', dataset: 'system.auth' }, - host: { - hostname: 'siem-kibana', - os: { - kernel: '4.9.0-8-amd64', - codename: 'stretch', - name: 'Debian GNU/Linux', - family: 'debian', - version: '9 (stretch)', - platform: 'debian', - }, - containerized: false, - ip: ['10.142.0.7', 'fe80::4001:aff:fe8e:7'], - name: 'siem-kibana', - id: 'aa7ca589f1b8220002f2fc61c64cfbf1', - mac: ['42:01:0a:8e:00:07'], - architecture: 'x86_64', - }, - event: { - timezone: '+00:00', - action: 'ssh_login', - type: 'authentication_failure', - category: 'authentication', - dataset: 'system.auth', - outcome: 'failure', - }, - user: { name: 'odoo' }, + fields: { + 'source.ip': ['180.151.228.166'], + 'host.id': ['aa7ca589f1b8220002f2fc61c64cfbf1'], + 'host.name': ['siem-kibana'], + '@timestamp': ['2020-09-04T12:26:36.000Z'], }, sort: [1599222396000], }, @@ -1007,48 +258,10 @@ export const mockSearchStrategyResponse: IEsSearchResponse = { _index: 'filebeat-8.0.0-2020.09.02-000001', _id: 'aaToWHQBA6bGZw2uR-St', _score: null, - _source: { - agent: { - name: 'bastion00.siem.estc.dev', - id: 'f9a321c1-ec27-49fa-aacf-6a50ef6d836f', - type: 'filebeat', - ephemeral_id: '734ee3da-1a4f-4bc9-b400-e0cf0e5eeebc', - version: '8.0.0', - }, - process: { name: 'sshd', pid: 20475 }, - log: { file: { path: '/var/log/auth.log' }, offset: 1019218 }, - source: { - geo: { - continent_name: 'Europe', - region_iso_code: 'SE-AB', - city_name: 'Stockholm', - country_iso_code: 'SE', - region_name: 'Stockholm', - location: { lon: 17.7833, lat: 59.25 }, - }, - as: { number: 8473, organization: { name: 'Bahnhof AB' } }, - ip: '178.174.148.58', - }, - fileset: { name: 'auth' }, - input: { type: 'log' }, - '@timestamp': '2020-09-04T11:37:22.000Z', - system: { auth: { ssh: { event: 'Invalid' } } }, - ecs: { version: '1.5.0' }, - related: { ip: ['178.174.148.58'], user: ['pi'] }, - service: { type: 'system' }, - host: { hostname: 'bastion00', name: 'bastion00.siem.estc.dev' }, - event: { - ingested: '2020-09-04T11:37:31.797423Z', - timezone: '+00:00', - kind: 'event', - module: 'system', - action: 'ssh_login', - type: ['authentication_failure', 'info'], - category: ['authentication'], - dataset: 'system.auth', - outcome: 'failure', - }, - user: { name: 'pi' }, + fields: { + 'source.ip': ['178.174.148.58'], + 'host.name': ['bastion00.siem.estc.dev'], + '@timestamp': ['2020-09-04T11:37:22.000Z'], }, sort: [1599219442000], }, @@ -1075,48 +288,10 @@ export const mockSearchStrategyResponse: IEsSearchResponse = { _index: 'filebeat-8.0.0-2020.09.02-000001', _id: 'VaP_V3QBA6bGZw2upUbg', _score: null, - _source: { - agent: { - name: 'bastion00.siem.estc.dev', - id: 'f9a321c1-ec27-49fa-aacf-6a50ef6d836f', - type: 'filebeat', - ephemeral_id: '734ee3da-1a4f-4bc9-b400-e0cf0e5eeebc', - version: '8.0.0', - }, - process: { name: 'sshd', pid: 19849 }, - log: { file: { path: '/var/log/auth.log' }, offset: 981036 }, - source: { - geo: { - continent_name: 'Europe', - country_iso_code: 'HR', - location: { lon: 15.5, lat: 45.1667 }, - }, - as: { - number: 42864, - organization: { name: 'Giganet Internet Szolgaltato Kft' }, - }, - ip: '45.95.168.157', - }, - fileset: { name: 'auth' }, - input: { type: 'log' }, - '@timestamp': '2020-09-04T07:23:22.000Z', - system: { auth: { ssh: { event: 'Invalid' } } }, - ecs: { version: '1.5.0' }, - related: { ip: ['45.95.168.157'], user: ['demo'] }, - service: { type: 'system' }, - host: { hostname: 'bastion00', name: 'bastion00.siem.estc.dev' }, - event: { - ingested: '2020-09-04T07:23:26.046346Z', - timezone: '+00:00', - kind: 'event', - module: 'system', - action: 'ssh_login', - type: ['authentication_failure', 'info'], - category: ['authentication'], - dataset: 'system.auth', - outcome: 'failure', - }, - user: { name: 'demo' }, + fields: { + 'source.ip': ['45.95.168.157'], + 'host.name': ['bastion00.siem.estc.dev'], + '@timestamp': ['2020-09-04T07:23:22.000Z'], }, sort: [1599204202000], }, @@ -1143,72 +318,11 @@ export const mockSearchStrategyResponse: IEsSearchResponse = { _index: '.ds-logs-system.auth-default-000001', _id: 'PqYfWXQBA6bGZw2uIhVU', _score: null, - _source: { - agent: { - hostname: 'siem-kibana', - name: 'siem-kibana', - id: 'aa3d9dc7-fef1-4c2f-a68d-25785d624e35', - ephemeral_id: 'e503bd85-11c7-4bc9-ae7d-70be1d919fb7', - type: 'filebeat', - version: '7.9.1', - }, - process: { name: 'sshd', pid: 20396 }, - log: { file: { path: '/var/log/auth.log' }, offset: 550795 }, - source: { - geo: { - continent_name: 'Asia', - region_iso_code: 'CN-BJ', - city_name: 'Beijing', - country_iso_code: 'CN', - region_name: 'Beijing', - location: { lon: 116.3889, lat: 39.9288 }, - }, - as: { - number: 45090, - organization: { - name: 'Shenzhen Tencent Computer Systems Company Limited', - }, - }, - ip: '123.206.30.76', - }, - cloud: { - availability_zone: 'us-east1-b', - instance: { name: 'siem-kibana', id: '5412578377715150143' }, - provider: 'gcp', - machine: { type: 'n1-standard-2' }, - project: { id: 'elastic-beats' }, - }, - input: { type: 'log' }, - '@timestamp': '2020-09-04T11:20:26.000Z', - system: { auth: { ssh: { event: 'Invalid' } } }, - ecs: { version: '1.5.0' }, - data_stream: { namespace: 'default', type: 'logs', dataset: 'system.auth' }, - host: { - hostname: 'siem-kibana', - os: { - kernel: '4.9.0-8-amd64', - codename: 'stretch', - name: 'Debian GNU/Linux', - family: 'debian', - version: '9 (stretch)', - platform: 'debian', - }, - containerized: false, - ip: ['10.142.0.7', 'fe80::4001:aff:fe8e:7'], - name: 'siem-kibana', - id: 'aa7ca589f1b8220002f2fc61c64cfbf1', - mac: ['42:01:0a:8e:00:07'], - architecture: 'x86_64', - }, - event: { - timezone: '+00:00', - action: 'ssh_login', - type: 'authentication_failure', - category: 'authentication', - dataset: 'system.auth', - outcome: 'failure', - }, - user: { name: 'git' }, + fields: { + 'source.ip': ['123.206.30.76'], + 'host.id': ['aa7ca589f1b8220002f2fc61c64cfbf1'], + 'host.name': ['siem-kibana'], + '@timestamp': ['2020-09-04T11:20:26.000Z'], }, sort: [1599218426000], }, @@ -1235,48 +349,10 @@ export const mockSearchStrategyResponse: IEsSearchResponse = { _index: 'filebeat-8.0.0-2020.09.02-000001', _id: 'iMABWHQBB-gskclyitP-', _score: null, - _source: { - agent: { - name: 'bastion00.siem.estc.dev', - id: 'f9a321c1-ec27-49fa-aacf-6a50ef6d836f', - type: 'filebeat', - ephemeral_id: '734ee3da-1a4f-4bc9-b400-e0cf0e5eeebc', - version: '8.0.0', - }, - process: { name: 'sshd', pid: 19870 }, - log: { file: { path: '/var/log/auth.log' }, offset: 984133 }, - source: { - geo: { - continent_name: 'Europe', - country_iso_code: 'HR', - location: { lon: 15.5, lat: 45.1667 }, - }, - as: { - number: 42864, - organization: { name: 'Giganet Internet Szolgaltato Kft' }, - }, - ip: '45.95.168.157', - }, - fileset: { name: 'auth' }, - input: { type: 'log' }, - '@timestamp': '2020-09-04T07:25:28.000Z', - system: { auth: { ssh: { event: 'Invalid' } } }, - ecs: { version: '1.5.0' }, - related: { ip: ['45.95.168.157'], user: ['webadmin'] }, - service: { type: 'system' }, - host: { hostname: 'bastion00', name: 'bastion00.siem.estc.dev' }, - event: { - ingested: '2020-09-04T07:25:30.236651Z', - timezone: '+00:00', - kind: 'event', - module: 'system', - action: 'ssh_login', - type: ['authentication_failure', 'info'], - category: ['authentication'], - dataset: 'system.auth', - outcome: 'failure', - }, - user: { name: 'webadmin' }, + fields: { + 'source.ip': ['45.95.168.157'], + 'host.name': ['bastion00.siem.estc.dev'], + '@timestamp': ['2020-09-04T07:25:28.000Z'], }, sort: [1599204328000], }, @@ -1331,106 +407,10 @@ export const formattedSearchStrategyResponse = { _index: 'winlogbeat-8.0.0-2020.09.02-000001', _id: 'zqY7WXQBA6bGZw2uLeKI', _score: null, - _source: { - process: { - name: 'services.exe', - pid: 564, - executable: 'C:\\Windows\\System32\\services.exe', - }, - agent: { - build_date: '2020-07-16 09:16:27 +0000 UTC ', - name: 'siem-windows', - commit: '4dcbde39492bdc3843034bba8db811c68cb44b97 ', - id: '05e1bff7-d7a8-416a-8554-aa10288fa07d', - type: 'winlogbeat', - ephemeral_id: '655abd6c-6c33-435d-a2eb-79b2a01e6d61', - version: '8.0.0', - user: { name: 'inside_winlogbeat_user' }, - }, - winlog: { - computer_name: 'siem-windows', - process: { pid: 576, thread: { id: 880 } }, - keywords: ['Audit Success'], - logon: { id: '0x3e7', type: 'Service' }, - channel: 'Security', - event_data: { - LogonGuid: '{00000000-0000-0000-0000-000000000000}', - TargetOutboundDomainName: '-', - VirtualAccount: '%%1843', - LogonType: '5', - IpPort: '-', - TransmittedServices: '-', - SubjectLogonId: '0x3e7', - LmPackageName: '-', - TargetOutboundUserName: '-', - KeyLength: '0', - TargetLogonId: '0x3e7', - RestrictedAdminMode: '-', - SubjectUserName: 'SIEM-WINDOWS$', - TargetLinkedLogonId: '0x0', - ElevatedToken: '%%1842', - SubjectDomainName: 'WORKGROUP', - IpAddress: '-', - ImpersonationLevel: '%%1833', - TargetUserName: 'SYSTEM', - LogonProcessName: 'Advapi ', - TargetDomainName: 'NT AUTHORITY', - SubjectUserSid: 'S-1-5-18', - TargetUserSid: 'S-1-5-18', - AuthenticationPackageName: 'Negotiate', - }, - opcode: 'Info', - version: 2, - record_id: 57818, - task: 'Logon', - event_id: 4624, - provider_guid: '{54849625-5478-4994-a5ba-3e3b0328c30d}', - activity_id: '{d2485217-6bac-0000-8fbb-3f7e2571d601}', - api: 'wineventlog', - provider_name: 'Microsoft-Windows-Security-Auditing', - }, - log: { level: 'information' }, - source: { domain: '-' }, - message: - 'An account was successfully logged on.\n\nSubject:\n\tSecurity ID:\t\tS-1-5-18\n\tAccount Name:\t\tSIEM-WINDOWS$\n\tAccount Domain:\t\tWORKGROUP\n\tLogon ID:\t\t0x3E7\n\nLogon Information:\n\tLogon Type:\t\t5\n\tRestricted Admin Mode:\t-\n\tVirtual Account:\t\tNo\n\tElevated Token:\t\tYes\n\nImpersonation Level:\t\tImpersonation\n\nNew Logon:\n\tSecurity ID:\t\tS-1-5-18\n\tAccount Name:\t\tSYSTEM\n\tAccount Domain:\t\tNT AUTHORITY\n\tLogon ID:\t\t0x3E7\n\tLinked Logon ID:\t\t0x0\n\tNetwork Account Name:\t-\n\tNetwork Account Domain:\t-\n\tLogon GUID:\t\t{00000000-0000-0000-0000-000000000000}\n\nProcess Information:\n\tProcess ID:\t\t0x234\n\tProcess Name:\t\tC:\\Windows\\System32\\services.exe\n\nNetwork Information:\n\tWorkstation Name:\t-\n\tSource Network Address:\t-\n\tSource Port:\t\t-\n\nDetailed Authentication Information:\n\tLogon Process:\t\tAdvapi \n\tAuthentication Package:\tNegotiate\n\tTransited Services:\t-\n\tPackage Name (NTLM only):\t-\n\tKey Length:\t\t0\n\nThis event is generated when a logon session is created. It is generated on the computer that was accessed.\n\nThe subject fields indicate the account on the local system which requested the logon. This is most commonly a service such as the Server service, or a local process such as Winlogon.exe or Services.exe.\n\nThe logon type field indicates the kind of logon that occurred. The most common types are 2 (interactive) and 3 (network).\n\nThe New Logon fields indicate the account for whom the new logon was created, i.e. the account that was logged on.\n\nThe network fields indicate where a remote logon request originated. Workstation name is not always available and may be left blank in some cases.\n\nThe impersonation level field indicates the extent to which a process in the logon session can impersonate.\n\nThe authentication information fields provide detailed information about this specific logon request.\n\t- Logon GUID is a unique identifier that can be used to correlate this event with a KDC event.\n\t- Transited services indicate which intermediate services have participated in this logon request.\n\t- Package name indicates which sub-protocol was used among the NTLM protocols.\n\t- Key length indicates the length of the generated session key. This will be 0 if no session key was requested.', - cloud: { - availability_zone: 'us-central1-c', - instance: { name: 'siem-windows', id: '9156726559029788564' }, - provider: 'gcp', - machine: { type: 'g1-small' }, - project: { id: 'elastic-siem' }, - }, - '@timestamp': '2020-09-04T13:08:02.532Z', - related: { user: ['SYSTEM', 'SIEM-WINDOWS$'] }, - ecs: { version: '1.5.0' }, - host: { - hostname: 'siem-windows', - os: { - build: '17763.1397', - kernel: '10.0.17763.1397 (WinBuild.160101.0800)', - name: 'Windows Server 2019 Datacenter', - family: 'windows', - version: '10.0', - platform: 'windows', - }, - ip: ['fe80::ecf5:decc:3ec3:767e', '10.200.0.15'], - name: 'siem-windows', - id: 'ce1d3c9b-a815-4643-9641-ada0f2c00609', - mac: ['42:01:0a:c8:00:0f'], - architecture: 'x86_64', - }, - event: { - code: 4624, - provider: 'Microsoft-Windows-Security-Auditing', - created: '2020-09-04T13:08:03.638Z', - kind: 'event', - module: 'security', - action: 'logged-in', - category: 'authentication', - type: 'start', - outcome: 'success', - }, - user: { domain: 'NT AUTHORITY', name: 'SYSTEM', id: 'S-1-5-18' }, + fields: { + 'host.id': ['ce1d3c9b-a815-4643-9641-ada0f2c00609'], + 'host.name': ['siem-windows'], + '@timestamp': ['2020-09-04T13:08:02.532Z'], }, sort: [1599224882532], }, @@ -1457,76 +437,11 @@ export const formattedSearchStrategyResponse = { _index: '.ds-logs-system.auth-default-000001', _id: '9_sfWXQBc39KFIJbIsDh', _score: null, - _source: { - agent: { - hostname: 'siem-kibana', - name: 'siem-kibana', - id: 'aa3d9dc7-fef1-4c2f-a68d-25785d624e35', - ephemeral_id: 'e503bd85-11c7-4bc9-ae7d-70be1d919fb7', - type: 'filebeat', - version: '7.9.1', - }, - process: { name: 'sshd', pid: 20764 }, - log: { file: { path: '/var/log/auth.log' }, offset: 552463 }, - source: { - geo: { - continent_name: 'Europe', - region_iso_code: 'DE-BE', - city_name: 'Berlin', - country_iso_code: 'DE', - region_name: 'Land Berlin', - location: { lon: 13.3512, lat: 52.5727 }, - }, - as: { number: 6805, organization: { name: 'Telefonica Germany' } }, - port: 57457, - ip: '77.183.42.188', - }, - cloud: { - availability_zone: 'us-east1-b', - instance: { name: 'siem-kibana', id: '5412578377715150143' }, - provider: 'gcp', - machine: { type: 'n1-standard-2' }, - project: { id: 'elastic-beats' }, - }, - input: { type: 'log' }, - '@timestamp': '2020-09-04T11:49:21.000Z', - system: { - auth: { - ssh: { - method: 'publickey', - signature: 'RSA SHA256:vv64JNLzKZWYA9vonnGWuW7zxWhyZrL/BFxyIGbISx8', - event: 'Accepted', - }, - }, - }, - ecs: { version: '1.5.0' }, - data_stream: { namespace: 'default', type: 'logs', dataset: 'system.auth' }, - host: { - hostname: 'siem-kibana', - os: { - kernel: '4.9.0-8-amd64', - codename: 'stretch', - name: 'Debian GNU/Linux', - family: 'debian', - version: '9 (stretch)', - platform: 'debian', - }, - containerized: false, - ip: ['10.142.0.7', 'fe80::4001:aff:fe8e:7'], - name: 'siem-kibana', - id: 'aa7ca589f1b8220002f2fc61c64cfbf1', - mac: ['42:01:0a:8e:00:07'], - architecture: 'x86_64', - }, - event: { - timezone: '+00:00', - action: 'ssh_login', - type: 'authentication_success', - category: 'authentication', - dataset: 'system.auth', - outcome: 'success', - }, - user: { name: 'tsg' }, + fields: { + 'source.ip': ['77.183.42.188'], + 'host.id': ['aa7ca589f1b8220002f2fc61c64cfbf1'], + 'host.name': ['siem-kibana'], + '@timestamp': ['2020-09-04T11:49:21.000Z'], }, sort: [1599220161000], }, @@ -1549,67 +464,11 @@ export const formattedSearchStrategyResponse = { _index: '.ds-logs-system.auth-default-000001', _id: 'ZfxZWXQBc39KFIJbLN5U', _score: null, - _source: { - agent: { - hostname: 'siem-kibana', - name: 'siem-kibana', - id: 'aa3d9dc7-fef1-4c2f-a68d-25785d624e35', - ephemeral_id: 'e503bd85-11c7-4bc9-ae7d-70be1d919fb7', - type: 'filebeat', - version: '7.9.1', - }, - process: { name: 'sshd', pid: 22913 }, - log: { file: { path: '/var/log/auth.log' }, offset: 562910 }, - source: { - geo: { - continent_name: 'Asia', - region_iso_code: 'KR-28', - city_name: 'Incheon', - country_iso_code: 'KR', - region_name: 'Incheon', - location: { lon: 126.7288, lat: 37.4562 }, - }, - as: { number: 4766, organization: { name: 'Korea Telecom' } }, - ip: '59.15.3.197', - }, - cloud: { - availability_zone: 'us-east1-b', - instance: { name: 'siem-kibana', id: '5412578377715150143' }, - provider: 'gcp', - machine: { type: 'n1-standard-2' }, - project: { id: 'elastic-beats' }, - }, - input: { type: 'log' }, - '@timestamp': '2020-09-04T13:40:46.000Z', - system: { auth: { ssh: { event: 'Invalid' } } }, - ecs: { version: '1.5.0' }, - data_stream: { namespace: 'default', type: 'logs', dataset: 'system.auth' }, - host: { - hostname: 'siem-kibana', - os: { - kernel: '4.9.0-8-amd64', - codename: 'stretch', - name: 'Debian GNU/Linux', - family: 'debian', - version: '9 (stretch)', - platform: 'debian', - }, - containerized: false, - ip: ['10.142.0.7', 'fe80::4001:aff:fe8e:7'], - name: 'siem-kibana', - id: 'aa7ca589f1b8220002f2fc61c64cfbf1', - mac: ['42:01:0a:8e:00:07'], - architecture: 'x86_64', - }, - event: { - timezone: '+00:00', - action: 'ssh_login', - type: 'authentication_failure', - category: 'authentication', - dataset: 'system.auth', - outcome: 'failure', - }, - user: { name: 'admin' }, + fields: { + 'source.ip': ['59.15.3.197'], + 'host.id': ['aa7ca589f1b8220002f2fc61c64cfbf1'], + 'host.name': ['siem-kibana'], + '@timestamp': ['2020-09-04T13:40:46.000Z'], }, sort: [1599226846000], }, @@ -1636,47 +495,10 @@ export const formattedSearchStrategyResponse = { _index: 'filebeat-8.0.0-2020.09.02-000001', _id: 'M_xLWXQBc39KFIJbY7Cb', _score: null, - _source: { - agent: { - name: 'bastion00.siem.estc.dev', - id: 'f9a321c1-ec27-49fa-aacf-6a50ef6d836f', - type: 'filebeat', - ephemeral_id: '734ee3da-1a4f-4bc9-b400-e0cf0e5eeebc', - version: '8.0.0', - }, - process: { name: 'sshd', pid: 20671 }, - log: { file: { path: '/var/log/auth.log' }, offset: 1028103 }, - source: { - geo: { - continent_name: 'North America', - region_iso_code: 'US-NY', - city_name: 'New York', - country_iso_code: 'US', - region_name: 'New York', - location: { lon: -74, lat: 40.7157 }, - }, - ip: '64.227.88.245', - }, - fileset: { name: 'auth' }, - input: { type: 'log' }, - '@timestamp': '2020-09-04T13:25:43.000Z', - system: { auth: { ssh: { event: 'Invalid' } } }, - ecs: { version: '1.5.0' }, - related: { ip: ['64.227.88.245'], user: ['user'] }, - service: { type: 'system' }, - host: { hostname: 'bastion00', name: 'bastion00.siem.estc.dev' }, - event: { - ingested: '2020-09-04T13:25:47.034172Z', - timezone: '+00:00', - kind: 'event', - module: 'system', - action: 'ssh_login', - type: ['authentication_failure', 'info'], - category: ['authentication'], - dataset: 'system.auth', - outcome: 'failure', - }, - user: { name: 'user' }, + fields: { + 'source.ip': ['64.227.88.245'], + 'host.name': ['bastion00.siem.estc.dev'], + '@timestamp': ['2020-09-04T13:25:43.000Z'], }, sort: [1599225943000], }, @@ -1703,47 +525,10 @@ export const formattedSearchStrategyResponse = { _index: 'filebeat-8.0.0-2020.09.02-000001', _id: 'nPxKWXQBc39KFIJb7q4w', _score: null, - _source: { - agent: { - name: 'bastion00.siem.estc.dev', - id: 'f9a321c1-ec27-49fa-aacf-6a50ef6d836f', - ephemeral_id: '734ee3da-1a4f-4bc9-b400-e0cf0e5eeebc', - type: 'filebeat', - version: '8.0.0', - }, - process: { name: 'sshd', pid: 20665 }, - log: { file: { path: '/var/log/auth.log' }, offset: 1027372 }, - source: { - geo: { - continent_name: 'North America', - region_iso_code: 'US-NY', - city_name: 'New York', - country_iso_code: 'US', - region_name: 'New York', - location: { lon: -74, lat: 40.7157 }, - }, - ip: '64.227.88.245', - }, - fileset: { name: 'auth' }, - input: { type: 'log' }, - '@timestamp': '2020-09-04T13:25:07.000Z', - system: { auth: { ssh: { event: 'Invalid' } } }, - ecs: { version: '1.5.0' }, - related: { ip: ['64.227.88.245'], user: ['ubuntu'] }, - service: { type: 'system' }, - host: { hostname: 'bastion00', name: 'bastion00.siem.estc.dev' }, - event: { - ingested: '2020-09-04T13:25:16.974606Z', - timezone: '+00:00', - kind: 'event', - module: 'system', - action: 'ssh_login', - type: ['authentication_failure', 'info'], - category: ['authentication'], - dataset: 'system.auth', - outcome: 'failure', - }, - user: { name: 'ubuntu' }, + fields: { + 'source.ip': ['64.227.88.245'], + 'host.name': ['bastion00.siem.estc.dev'], + '@timestamp': ['2020-09-04T13:25:07.000Z'], }, sort: [1599225907000], }, @@ -1770,67 +555,11 @@ export const formattedSearchStrategyResponse = { _index: '.ds-logs-system.auth-default-000001', _id: 'mPsfWXQBc39KFIJbI8HI', _score: null, - _source: { - agent: { - hostname: 'siem-kibana', - name: 'siem-kibana', - id: 'aa3d9dc7-fef1-4c2f-a68d-25785d624e35', - type: 'filebeat', - ephemeral_id: 'e503bd85-11c7-4bc9-ae7d-70be1d919fb7', - version: '7.9.1', - }, - process: { name: 'sshd', pid: 21506 }, - log: { file: { path: '/var/log/auth.log' }, offset: 556761 }, - source: { - geo: { - continent_name: 'Asia', - region_iso_code: 'IN-DL', - city_name: 'New Delhi', - country_iso_code: 'IN', - region_name: 'National Capital Territory of Delhi', - location: { lon: 77.2245, lat: 28.6358 }, - }, - as: { number: 10029, organization: { name: 'SHYAM SPECTRA PVT LTD' } }, - ip: '180.151.228.166', - }, - cloud: { - availability_zone: 'us-east1-b', - instance: { name: 'siem-kibana', id: '5412578377715150143' }, - provider: 'gcp', - machine: { type: 'n1-standard-2' }, - project: { id: 'elastic-beats' }, - }, - input: { type: 'log' }, - '@timestamp': '2020-09-04T12:26:36.000Z', - system: { auth: { ssh: { event: 'Invalid' } } }, - ecs: { version: '1.5.0' }, - data_stream: { namespace: 'default', type: 'logs', dataset: 'system.auth' }, - host: { - hostname: 'siem-kibana', - os: { - kernel: '4.9.0-8-amd64', - codename: 'stretch', - name: 'Debian GNU/Linux', - family: 'debian', - version: '9 (stretch)', - platform: 'debian', - }, - containerized: false, - ip: ['10.142.0.7', 'fe80::4001:aff:fe8e:7'], - name: 'siem-kibana', - id: 'aa7ca589f1b8220002f2fc61c64cfbf1', - mac: ['42:01:0a:8e:00:07'], - architecture: 'x86_64', - }, - event: { - timezone: '+00:00', - action: 'ssh_login', - type: 'authentication_failure', - category: 'authentication', - dataset: 'system.auth', - outcome: 'failure', - }, - user: { name: 'odoo' }, + fields: { + 'source.ip': ['180.151.228.166'], + 'host.id': ['aa7ca589f1b8220002f2fc61c64cfbf1'], + 'host.name': ['siem-kibana'], + '@timestamp': ['2020-09-04T12:26:36.000Z'], }, sort: [1599222396000], }, @@ -1857,48 +586,10 @@ export const formattedSearchStrategyResponse = { _index: 'filebeat-8.0.0-2020.09.02-000001', _id: 'aaToWHQBA6bGZw2uR-St', _score: null, - _source: { - agent: { - name: 'bastion00.siem.estc.dev', - id: 'f9a321c1-ec27-49fa-aacf-6a50ef6d836f', - type: 'filebeat', - ephemeral_id: '734ee3da-1a4f-4bc9-b400-e0cf0e5eeebc', - version: '8.0.0', - }, - process: { name: 'sshd', pid: 20475 }, - log: { file: { path: '/var/log/auth.log' }, offset: 1019218 }, - source: { - geo: { - continent_name: 'Europe', - region_iso_code: 'SE-AB', - city_name: 'Stockholm', - country_iso_code: 'SE', - region_name: 'Stockholm', - location: { lon: 17.7833, lat: 59.25 }, - }, - as: { number: 8473, organization: { name: 'Bahnhof AB' } }, - ip: '178.174.148.58', - }, - fileset: { name: 'auth' }, - input: { type: 'log' }, - '@timestamp': '2020-09-04T11:37:22.000Z', - system: { auth: { ssh: { event: 'Invalid' } } }, - ecs: { version: '1.5.0' }, - related: { ip: ['178.174.148.58'], user: ['pi'] }, - service: { type: 'system' }, - host: { hostname: 'bastion00', name: 'bastion00.siem.estc.dev' }, - event: { - ingested: '2020-09-04T11:37:31.797423Z', - timezone: '+00:00', - kind: 'event', - module: 'system', - action: 'ssh_login', - type: ['authentication_failure', 'info'], - category: ['authentication'], - dataset: 'system.auth', - outcome: 'failure', - }, - user: { name: 'pi' }, + fields: { + 'source.ip': ['178.174.148.58'], + 'host.name': ['bastion00.siem.estc.dev'], + '@timestamp': ['2020-09-04T11:37:22.000Z'], }, sort: [1599219442000], }, @@ -1925,48 +616,10 @@ export const formattedSearchStrategyResponse = { _index: 'filebeat-8.0.0-2020.09.02-000001', _id: 'VaP_V3QBA6bGZw2upUbg', _score: null, - _source: { - agent: { - name: 'bastion00.siem.estc.dev', - id: 'f9a321c1-ec27-49fa-aacf-6a50ef6d836f', - type: 'filebeat', - ephemeral_id: '734ee3da-1a4f-4bc9-b400-e0cf0e5eeebc', - version: '8.0.0', - }, - process: { name: 'sshd', pid: 19849 }, - log: { file: { path: '/var/log/auth.log' }, offset: 981036 }, - source: { - geo: { - continent_name: 'Europe', - country_iso_code: 'HR', - location: { lon: 15.5, lat: 45.1667 }, - }, - as: { - number: 42864, - organization: { name: 'Giganet Internet Szolgaltato Kft' }, - }, - ip: '45.95.168.157', - }, - fileset: { name: 'auth' }, - input: { type: 'log' }, - '@timestamp': '2020-09-04T07:23:22.000Z', - system: { auth: { ssh: { event: 'Invalid' } } }, - ecs: { version: '1.5.0' }, - related: { ip: ['45.95.168.157'], user: ['demo'] }, - service: { type: 'system' }, - host: { hostname: 'bastion00', name: 'bastion00.siem.estc.dev' }, - event: { - ingested: '2020-09-04T07:23:26.046346Z', - timezone: '+00:00', - kind: 'event', - module: 'system', - action: 'ssh_login', - type: ['authentication_failure', 'info'], - category: ['authentication'], - dataset: 'system.auth', - outcome: 'failure', - }, - user: { name: 'demo' }, + fields: { + 'source.ip': ['45.95.168.157'], + 'host.name': ['bastion00.siem.estc.dev'], + '@timestamp': ['2020-09-04T07:23:22.000Z'], }, sort: [1599204202000], }, @@ -1993,72 +646,11 @@ export const formattedSearchStrategyResponse = { _index: '.ds-logs-system.auth-default-000001', _id: 'PqYfWXQBA6bGZw2uIhVU', _score: null, - _source: { - agent: { - hostname: 'siem-kibana', - name: 'siem-kibana', - id: 'aa3d9dc7-fef1-4c2f-a68d-25785d624e35', - ephemeral_id: 'e503bd85-11c7-4bc9-ae7d-70be1d919fb7', - type: 'filebeat', - version: '7.9.1', - }, - process: { name: 'sshd', pid: 20396 }, - log: { file: { path: '/var/log/auth.log' }, offset: 550795 }, - source: { - geo: { - continent_name: 'Asia', - region_iso_code: 'CN-BJ', - city_name: 'Beijing', - country_iso_code: 'CN', - region_name: 'Beijing', - location: { lon: 116.3889, lat: 39.9288 }, - }, - as: { - number: 45090, - organization: { - name: 'Shenzhen Tencent Computer Systems Company Limited', - }, - }, - ip: '123.206.30.76', - }, - cloud: { - availability_zone: 'us-east1-b', - instance: { name: 'siem-kibana', id: '5412578377715150143' }, - provider: 'gcp', - machine: { type: 'n1-standard-2' }, - project: { id: 'elastic-beats' }, - }, - input: { type: 'log' }, - '@timestamp': '2020-09-04T11:20:26.000Z', - system: { auth: { ssh: { event: 'Invalid' } } }, - ecs: { version: '1.5.0' }, - data_stream: { namespace: 'default', type: 'logs', dataset: 'system.auth' }, - host: { - hostname: 'siem-kibana', - os: { - kernel: '4.9.0-8-amd64', - codename: 'stretch', - name: 'Debian GNU/Linux', - family: 'debian', - version: '9 (stretch)', - platform: 'debian', - }, - containerized: false, - ip: ['10.142.0.7', 'fe80::4001:aff:fe8e:7'], - name: 'siem-kibana', - id: 'aa7ca589f1b8220002f2fc61c64cfbf1', - mac: ['42:01:0a:8e:00:07'], - architecture: 'x86_64', - }, - event: { - timezone: '+00:00', - action: 'ssh_login', - type: 'authentication_failure', - category: 'authentication', - dataset: 'system.auth', - outcome: 'failure', - }, - user: { name: 'git' }, + fields: { + 'source.ip': ['123.206.30.76'], + 'host.id': ['aa7ca589f1b8220002f2fc61c64cfbf1'], + 'host.name': ['siem-kibana'], + '@timestamp': ['2020-09-04T11:20:26.000Z'], }, sort: [1599218426000], }, @@ -2085,48 +677,10 @@ export const formattedSearchStrategyResponse = { _index: 'filebeat-8.0.0-2020.09.02-000001', _id: 'iMABWHQBB-gskclyitP-', _score: null, - _source: { - agent: { - name: 'bastion00.siem.estc.dev', - id: 'f9a321c1-ec27-49fa-aacf-6a50ef6d836f', - type: 'filebeat', - ephemeral_id: '734ee3da-1a4f-4bc9-b400-e0cf0e5eeebc', - version: '8.0.0', - }, - process: { name: 'sshd', pid: 19870 }, - log: { file: { path: '/var/log/auth.log' }, offset: 984133 }, - source: { - geo: { - continent_name: 'Europe', - country_iso_code: 'HR', - location: { lon: 15.5, lat: 45.1667 }, - }, - as: { - number: 42864, - organization: { name: 'Giganet Internet Szolgaltato Kft' }, - }, - ip: '45.95.168.157', - }, - fileset: { name: 'auth' }, - input: { type: 'log' }, - '@timestamp': '2020-09-04T07:25:28.000Z', - system: { auth: { ssh: { event: 'Invalid' } } }, - ecs: { version: '1.5.0' }, - related: { ip: ['45.95.168.157'], user: ['webadmin'] }, - service: { type: 'system' }, - host: { hostname: 'bastion00', name: 'bastion00.siem.estc.dev' }, - event: { - ingested: '2020-09-04T07:25:30.236651Z', - timezone: '+00:00', - kind: 'event', - module: 'system', - action: 'ssh_login', - type: ['authentication_failure', 'info'], - category: ['authentication'], - dataset: 'system.auth', - outcome: 'failure', - }, - user: { name: 'webadmin' }, + fields: { + 'source.ip': ['45.95.168.157'], + 'host.name': ['bastion00.siem.estc.dev'], + '@timestamp': ['2020-09-04T07:25:28.000Z'], }, sort: [1599204328000], }, @@ -2163,7 +717,6 @@ export const formattedSearchStrategyResponse = { ], ignore_unavailable: true, body: { - docvalue_fields: mockOptions.docValueFields, aggregations: { stack_by_count: { cardinality: { field: 'user.name' } }, stack_by: { @@ -2179,7 +732,7 @@ export const formattedSearchStrategyResponse = { lastFailure: { top_hits: { size: 1, - _source: [], + _source: false, sort: [{ '@timestamp': { order: 'desc' } }], }, }, @@ -2191,7 +744,7 @@ export const formattedSearchStrategyResponse = { lastSuccess: { top_hits: { size: 1, - _source: [], + _source: false, sort: [{ '@timestamp': { order: 'desc' } }], }, }, @@ -2218,6 +771,16 @@ export const formattedSearchStrategyResponse = { }, }, size: 0, + _source: false, + fields: [ + 'source.ip', + 'host.id', + 'host.name', + { + field: '@timestamp', + format: 'strict_date_optional_time', + }, + ], }, track_total_hits: false, }, @@ -2238,7 +801,7 @@ export const formattedSearchStrategyResponse = { host: { id: ['ce1d3c9b-a815-4643-9641-ada0f2c00609'], name: ['siem-windows'] }, }, }, - cursor: { value: '', tiebreaker: null }, + cursor: { value: undefined, tiebreaker: null }, }, { node: { @@ -2252,13 +815,13 @@ export const formattedSearchStrategyResponse = { host: { id: ['aa7ca589f1b8220002f2fc61c64cfbf1'], name: ['siem-kibana'] }, }, }, - cursor: { value: '', tiebreaker: null }, + cursor: { value: undefined, tiebreaker: null }, }, { node: { failures: 23, successes: 0, - _id: 'admin+23', + _id: 'ZfxZWXQBc39KFIJbLN5U', stackedValue: ['admin'], lastFailure: { timestamp: ['2020-09-04T13:40:46.000Z'], @@ -2266,13 +829,13 @@ export const formattedSearchStrategyResponse = { host: { id: ['aa7ca589f1b8220002f2fc61c64cfbf1'], name: ['siem-kibana'] }, }, }, - cursor: { value: '', tiebreaker: null }, + cursor: { value: undefined, tiebreaker: null }, }, { node: { failures: 21, successes: 0, - _id: 'user+21', + _id: 'M_xLWXQBc39KFIJbY7Cb', stackedValue: ['user'], lastFailure: { timestamp: ['2020-09-04T13:25:43.000Z'], @@ -2280,13 +843,13 @@ export const formattedSearchStrategyResponse = { host: { name: ['bastion00.siem.estc.dev'] }, }, }, - cursor: { value: '', tiebreaker: null }, + cursor: { value: undefined, tiebreaker: null }, }, { node: { failures: 18, successes: 0, - _id: 'ubuntu+18', + _id: 'nPxKWXQBc39KFIJb7q4w', stackedValue: ['ubuntu'], lastFailure: { timestamp: ['2020-09-04T13:25:07.000Z'], @@ -2294,13 +857,13 @@ export const formattedSearchStrategyResponse = { host: { name: ['bastion00.siem.estc.dev'] }, }, }, - cursor: { value: '', tiebreaker: null }, + cursor: { value: undefined, tiebreaker: null }, }, { node: { failures: 17, successes: 0, - _id: 'odoo+17', + _id: 'mPsfWXQBc39KFIJbI8HI', stackedValue: ['odoo'], lastFailure: { timestamp: ['2020-09-04T12:26:36.000Z'], @@ -2308,13 +871,13 @@ export const formattedSearchStrategyResponse = { host: { id: ['aa7ca589f1b8220002f2fc61c64cfbf1'], name: ['siem-kibana'] }, }, }, - cursor: { value: '', tiebreaker: null }, + cursor: { value: undefined, tiebreaker: null }, }, { node: { failures: 17, successes: 0, - _id: 'pi+17', + _id: 'aaToWHQBA6bGZw2uR-St', stackedValue: ['pi'], lastFailure: { timestamp: ['2020-09-04T11:37:22.000Z'], @@ -2322,13 +885,13 @@ export const formattedSearchStrategyResponse = { host: { name: ['bastion00.siem.estc.dev'] }, }, }, - cursor: { value: '', tiebreaker: null }, + cursor: { value: undefined, tiebreaker: null }, }, { node: { failures: 14, successes: 0, - _id: 'demo+14', + _id: 'VaP_V3QBA6bGZw2upUbg', stackedValue: ['demo'], lastFailure: { timestamp: ['2020-09-04T07:23:22.000Z'], @@ -2336,13 +899,13 @@ export const formattedSearchStrategyResponse = { host: { name: ['bastion00.siem.estc.dev'] }, }, }, - cursor: { value: '', tiebreaker: null }, + cursor: { value: undefined, tiebreaker: null }, }, { node: { failures: 13, successes: 0, - _id: 'git+13', + _id: 'PqYfWXQBA6bGZw2uIhVU', stackedValue: ['git'], lastFailure: { timestamp: ['2020-09-04T11:20:26.000Z'], @@ -2350,13 +913,13 @@ export const formattedSearchStrategyResponse = { host: { id: ['aa7ca589f1b8220002f2fc61c64cfbf1'], name: ['siem-kibana'] }, }, }, - cursor: { value: '', tiebreaker: null }, + cursor: { value: undefined, tiebreaker: null }, }, { node: { failures: 13, successes: 0, - _id: 'webadmin+13', + _id: 'iMABWHQBB-gskclyitP-', stackedValue: ['webadmin'], lastFailure: { timestamp: ['2020-09-04T07:25:28.000Z'], @@ -2364,7 +927,7 @@ export const formattedSearchStrategyResponse = { host: { name: ['bastion00.siem.estc.dev'] }, }, }, - cursor: { value: '', tiebreaker: null }, + cursor: { value: undefined, tiebreaker: null }, }, ], totalCount: 188, @@ -2385,7 +948,6 @@ export const expectedDsl = { ], ignore_unavailable: true, body: { - docvalue_fields: mockOptions.docValueFields, aggregations: { stack_by_count: { cardinality: { field: 'user.name' } }, stack_by: { @@ -2399,7 +961,7 @@ export const expectedDsl = { filter: { term: { 'event.outcome': 'failure' } }, aggs: { lastFailure: { - top_hits: { size: 1, _source: [], sort: [{ '@timestamp': { order: 'desc' } }] }, + top_hits: { size: 1, _source: false, sort: [{ '@timestamp': { order: 'desc' } }] }, }, }, }, @@ -2407,7 +969,7 @@ export const expectedDsl = { filter: { term: { 'event.outcome': 'success' } }, aggs: { lastSuccess: { - top_hits: { size: 1, _source: [], sort: [{ '@timestamp': { order: 'desc' } }] }, + top_hits: { size: 1, _source: false, sort: [{ '@timestamp': { order: 'desc' } }] }, }, }, }, @@ -2431,6 +993,16 @@ export const expectedDsl = { ], }, }, + _source: false, + fields: [ + 'source.ip', + 'host.id', + 'host.name', + { + field: '@timestamp', + format: 'strict_date_optional_time', + }, + ], size: 0, }, track_total_hits: false, @@ -2441,7 +1013,7 @@ export const mockHit: AuthenticationHit = { _type: 'type-123', _id: 'id-123', _score: 10, - _source: { + fields: { '@timestamp': 'time-1', }, cursor: 'cursor-1', diff --git a/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/authentications/dsl/query.dsl.ts b/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/authentications/dsl/query.dsl.ts index e018716d4c216..3c32ae3f85944 100644 --- a/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/authentications/dsl/query.dsl.ts +++ b/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/authentications/dsl/query.dsl.ts @@ -5,26 +5,10 @@ * 2.0. */ -import { isEmpty } from 'lodash/fp'; import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import { UserAuthenticationsRequestOptions } from '../../../../../../../common/search_strategy/security_solution/users/authentications'; -import { sourceFieldsMap, hostFieldsMap } from '../../../../../../../common/ecs/ecs_fields'; - import { createQueryFilterClauses } from '../../../../../../utils/build_query'; -import { reduceFields } from '../../../../../../utils/build_query/reduce_fields'; - import { authenticationsFields } from '../helpers'; -import { extendMap } from '../../../../../../../common/ecs/ecs_fields/extend_map'; - -export const auditdFieldsMap: Readonly> = { - latest: '@timestamp', - 'lastSuccess.timestamp': 'lastSuccess.@timestamp', - 'lastFailure.timestamp': 'lastFailure.@timestamp', - ...{ ...extendMap('lastSuccess', sourceFieldsMap) }, - ...{ ...extendMap('lastSuccess', hostFieldsMap) }, - ...{ ...extendMap('lastFailure', sourceFieldsMap) }, - ...{ ...extendMap('lastFailure', hostFieldsMap) }, -}; export const buildQuery = ({ filterQuery, @@ -32,13 +16,7 @@ export const buildQuery = ({ timerange: { from, to }, pagination: { querySize }, defaultIndex, - docValueFields, }: UserAuthenticationsRequestOptions) => { - const esFields = reduceFields(authenticationsFields, { - ...hostFieldsMap, - ...sourceFieldsMap, - }) as string[]; - const filter = [ ...createQueryFilterClauses(filterQuery), { term: { 'event.category': 'authentication' } }, @@ -52,13 +30,13 @@ export const buildQuery = ({ }, }, ]; + const queryFields = authenticationsFields.filter((field) => field !== 'timestamp'); const dslQuery = { allow_no_indices: true, index: defaultIndex, ignore_unavailable: true, body: { - ...(!isEmpty(docValueFields) ? { docvalue_fields: docValueFields } : {}), aggregations: { stack_by_count: { cardinality: { @@ -85,7 +63,7 @@ export const buildQuery = ({ lastFailure: { top_hits: { size: 1, - _source: esFields, + _source: false, sort: [{ '@timestamp': { order: 'desc' as const } }], }, }, @@ -101,7 +79,7 @@ export const buildQuery = ({ lastSuccess: { top_hits: { size: 1, - _source: esFields, + _source: false, sort: [{ '@timestamp': { order: 'desc' as const } }], }, }, @@ -116,6 +94,14 @@ export const buildQuery = ({ }, }, size: 0, + _source: false, + fields: [ + ...queryFields, + { + field: '@timestamp', + format: 'strict_date_optional_time', + }, + ], }, track_total_hits: false, }; diff --git a/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/authentications/helpers.test.ts b/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/authentications/helpers.test.ts index 1e745ffcbf2ed..a8eea076ae1be 100644 --- a/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/authentications/helpers.test.ts +++ b/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/authentications/helpers.test.ts @@ -6,15 +6,12 @@ */ import { AuthenticationsEdges } from '../../../../../../common/search_strategy'; -import { auditdFieldsMap } from './dsl/query.dsl'; - import { formatAuthenticationData } from './helpers'; import { mockHit } from './__mocks__'; describe('#formatAuthenticationsData', () => { test('it formats a authentication with an empty set', () => { - const fields: readonly string[] = ['']; - const data = formatAuthenticationData(fields, mockHit, auditdFieldsMap); + const data = formatAuthenticationData(mockHit); const expected: AuthenticationsEdges = { cursor: { tiebreaker: null, @@ -32,8 +29,7 @@ describe('#formatAuthenticationsData', () => { }); test('it formats a authentications with a source ip correctly', () => { - const fields: readonly string[] = ['lastSuccess.source.ip']; - const data = formatAuthenticationData(fields, mockHit, auditdFieldsMap); + const data = formatAuthenticationData(mockHit); const expected: AuthenticationsEdges = { cursor: { tiebreaker: null, @@ -51,8 +47,7 @@ describe('#formatAuthenticationsData', () => { }); test('it formats a authentications with a host name only', () => { - const fields: readonly string[] = ['lastSuccess.host.name']; - const data = formatAuthenticationData(fields, mockHit, auditdFieldsMap); + const data = formatAuthenticationData(mockHit); const expected: AuthenticationsEdges = { cursor: { tiebreaker: null, @@ -70,8 +65,7 @@ describe('#formatAuthenticationsData', () => { }); test('it formats a authentications with a host id only', () => { - const fields: readonly string[] = ['lastSuccess.host.id']; - const data = formatAuthenticationData(fields, mockHit, auditdFieldsMap); + const data = formatAuthenticationData(mockHit); const expected: AuthenticationsEdges = { cursor: { tiebreaker: null, @@ -89,8 +83,7 @@ describe('#formatAuthenticationsData', () => { }); test('it formats a authentications with a host name and id correctly', () => { - const fields: readonly string[] = ['lastSuccess.host.name', 'lastSuccess.host.id']; - const data = formatAuthenticationData(fields, mockHit, auditdFieldsMap); + const data = formatAuthenticationData(mockHit); const expected: AuthenticationsEdges = { cursor: { tiebreaker: null, diff --git a/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/authentications/helpers.ts b/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/authentications/helpers.ts index 43baa4aadea14..46c0a83a3b572 100644 --- a/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/authentications/helpers.ts +++ b/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/authentications/helpers.ts @@ -7,8 +7,8 @@ import { get, getOr, isEmpty } from 'lodash/fp'; import { set } from '@elastic/safer-lodash-set/fp'; -import { mergeFieldsWithHit } from '../../../../../utils/build_query'; import { toObjectArrayOfStrings } from '../../../../../../common/utils/to_array'; +import { sourceFieldsMap, hostFieldsMap } from '../../../../../../common/ecs/ecs_fields'; import { AuthenticationsEdges, AuthenticationHit, @@ -17,78 +17,79 @@ import { StrategyResponseType, } from '../../../../../../common/search_strategy/security_solution'; -export const authenticationsFields = [ - '_id', - 'failures', - 'successes', - 'stackedValue', - 'lastSuccess.timestamp', - 'lastSuccess.source.ip', - 'lastSuccess.host.id', - 'lastSuccess.host.name', - 'lastFailure.timestamp', - 'lastFailure.source.ip', - 'lastFailure.host.id', - 'lastFailure.host.name', -]; +export const authenticationsFields = ['timestamp', 'source.ip', 'host.id', 'host.name']; +export const authenticationsFieldsMap: Readonly> = { + latest: '@timestamp', + lastSuccess: { + timestamp: '@timestamp', + ...sourceFieldsMap, + ...hostFieldsMap, + }, + lastFailure: { + timestamp: '@timestamp', + ...sourceFieldsMap, + ...hostFieldsMap, + }, +}; -export const formatAuthenticationData = ( - fields: readonly string[] = authenticationsFields, - hit: AuthenticationHit, - fieldMap: Readonly> -): AuthenticationsEdges => - fields.reduce( - (flattenedFields, fieldName) => { - if (hit.cursor) { - flattenedFields.cursor.value = hit.cursor; - } - flattenedFields.node = { - ...flattenedFields.node, - ...{ - _id: hit._id, - stackedValue: [hit.stackedValue], - failures: hit.failures, - successes: hit.successes, - }, - }; - const mergedResult = mergeFieldsWithHit(fieldName, flattenedFields, fieldMap, hit); - const fieldPath = `node.${fieldName}`; - const fieldValue = get(fieldPath, mergedResult); +export const formatAuthenticationData = (hit: AuthenticationHit): AuthenticationsEdges => { + let flattenedFields = { + node: { + _id: hit._id, + stackedValue: [hit.stackedValue], + failures: hit.failures, + successes: hit.successes, + }, + cursor: { + value: hit.cursor, + tiebreaker: null, + }, + }; + + const lastSuccessFields = getAuthenticationFields(authenticationsFields, hit, 'lastSuccess'); + if (Object.keys(lastSuccessFields).length > 0) { + flattenedFields = set('node.lastSuccess', lastSuccessFields, flattenedFields); + } + + const lastFailureFields = getAuthenticationFields(authenticationsFields, hit, 'lastFailure'); + if (Object.keys(lastFailureFields).length > 0) { + flattenedFields = set('node.lastFailure', lastFailureFields, flattenedFields); + } + + return flattenedFields; +}; + +const getAuthenticationFields = (fields: string[], hit: AuthenticationHit, parentField: string) => { + return fields.reduce((flattenedFields, fieldName) => { + const fieldPath = `${fieldName}`; + const esField = get(`${parentField}['${fieldName}']`, authenticationsFieldsMap); + + if (!isEmpty(esField)) { + const fieldValue = get(`${parentField}['${esField}']`, hit.fields); if (!isEmpty(fieldValue)) { return set( fieldPath, toObjectArrayOfStrings(fieldValue).map(({ str }) => str), - mergedResult + flattenedFields ); - } else { - return mergedResult; } - }, - { - node: { - failures: 0, - successes: 0, - _id: '', - stackedValue: [''], - }, - cursor: { - value: '', - tiebreaker: null, - }, } - ); + + return flattenedFields; + }, {}); +}; export const getHits = (response: StrategyResponseType) => getOr([], 'aggregations.stack_by.buckets', response.rawResponse).map( (bucket: AuthenticationBucket) => ({ _id: getOr( `${bucket.key}+${bucket.doc_count}`, - 'failures.lastFailure.hits.hits[0].id', + 'failures.lastFailure.hits.hits[0]._id', bucket ), - _source: { - lastSuccess: getOr(null, 'successes.lastSuccess.hits.hits[0]._source', bucket), - lastFailure: getOr(null, 'failures.lastFailure.hits.hits[0]._source', bucket), + fields: { + lastSuccess: getOr(null, 'successes.lastSuccess.hits.hits[0].fields', bucket), + lastFailure: getOr(null, 'failures.lastFailure.hits.hits[0].fields', bucket), }, stackedValue: bucket.key, failures: bucket.failures.doc_count, diff --git a/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/authentications/index.tsx b/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/authentications/index.tsx index 5bb62f685ce4b..f2483b78dc3ef 100644 --- a/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/authentications/index.tsx +++ b/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/authentications/index.tsx @@ -20,9 +20,9 @@ import { UsersQueries } from '../../../../../../common/search_strategy/security_ import { inspectStringifyObject } from '../../../../../utils/build_query'; import { SecuritySolutionFactory } from '../../types'; -import { auditdFieldsMap, buildQuery as buildAuthenticationQuery } from './dsl/query.dsl'; +import { buildQuery as buildAuthenticationQuery } from './dsl/query.dsl'; -import { authenticationsFields, formatAuthenticationData, getHits } from './helpers'; +import { formatAuthenticationData, getHits } from './helpers'; export const authentications: SecuritySolutionFactory = { buildDsl: (options: UserAuthenticationsRequestOptions) => { @@ -42,7 +42,7 @@ export const authentications: SecuritySolutionFactory - formatAuthenticationData(authenticationsFields, hit, auditdFieldsMap) + formatAuthenticationData(hit) ); const edges = authenticationEdges.splice(cursorStart, querySize - cursorStart); diff --git a/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/details/__mocks__/index.ts b/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/details/__mocks__/index.ts index 33760eec4556e..5b54ffaf8dff8 100644 --- a/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/details/__mocks__/index.ts +++ b/x-pack/plugins/security_solution/server/search_strategy/security_solution/factory/users/details/__mocks__/index.ts @@ -12,12 +12,6 @@ import { UserDetailsRequestOptions } from '../../../../../../../common/search_st export const mockOptions: UserDetailsRequestOptions = { defaultIndex: ['test_indices*'], - docValueFields: [ - { - field: '@timestamp', - format: 'date_time', - }, - ], factoryQueryType: UsersQueries.details, filterQuery: '{"bool":{"must":[],"filter":[{"match_all":{}},{"match_phrase":{"user.name":{"query":"test_user"}}}],"should":[],"must_not":[]}}', diff --git a/x-pack/plugins/security_solution/tsconfig.json b/x-pack/plugins/security_solution/tsconfig.json index 95aaeffad7f71..cc1656ace3c65 100644 --- a/x-pack/plugins/security_solution/tsconfig.json +++ b/x-pack/plugins/security_solution/tsconfig.json @@ -32,7 +32,6 @@ { "path": "../actions/tsconfig.json" }, { "path": "../alerting/tsconfig.json" }, { "path": "../cases/tsconfig.json" }, - { "path": "../data_enhanced/tsconfig.json" }, { "path": "../encrypted_saved_objects/tsconfig.json" }, { "path": "../features/tsconfig.json" }, { "path": "../fleet/tsconfig.json" }, diff --git a/x-pack/plugins/session_view/common/mocks/constants/session_view_process.mock.ts b/x-pack/plugins/session_view/common/mocks/constants/session_view_process.mock.ts index 6def7c7bcbd47..76f954d1fe72e 100644 --- a/x-pack/plugins/session_view/common/mocks/constants/session_view_process.mock.ts +++ b/x-pack/plugins/session_view/common/mocks/constants/session_view_process.mock.ts @@ -819,8 +819,8 @@ export const mockAlerts: ProcessEvent[] = [ architecture: 'x86_64', hostname: 'james-fleet-714-2', id: '48c1b3f1ac5da4e0057fc9f60f4d1d5d', - ip: '127.0.0.1,::1,10.132.0.50,fe80::7d39:3147:4d9a:f809', - mac: '42:01:0a:84:00:32', + ip: ['127.0.0.1', '::1', '10.132.0.50', 'fe80::7d39:3147:4d9a:f809'], + mac: ['42:01:0a:84:00:32'], name: 'james-fleet-714-2', os: { family: 'centos', @@ -1006,8 +1006,8 @@ export const mockAlerts: ProcessEvent[] = [ architecture: 'x86_64', hostname: 'james-fleet-714-2', id: '48c1b3f1ac5da4e0057fc9f60f4d1d5d', - ip: '127.0.0.1,::1,10.132.0.50,fe80::7d39:3147:4d9a:f809', - mac: '42:01:0a:84:00:32', + ip: ['127.0.0.1', '::1', '10.132.0.50', 'fe80::7d39:3147:4d9a:f809'], + mac: ['42:01:0a:84:00:32'], name: 'james-fleet-714-2', os: { family: 'centos', @@ -1285,8 +1285,8 @@ export const childProcessMock: Process = { architecture: 'x86_64', hostname: 'james-fleet-714-2', id: '48c1b3f1ac5da4e0057fc9f60f4d1d5d', - ip: '127.0.0.1,::1,10.132.0.50,fe80::7d39:3147:4d9a:f809', - mac: '42:01:0a:84:00:32', + ip: ['127.0.0.1', '::1', '10.132.0.50', 'fe80::7d39:3147:4d9a:f809'], + mac: ['42:01:0a:84:00:32'], name: 'james-fleet-714-2', os: { family: 'centos', @@ -1370,8 +1370,8 @@ export const processMock: Process = { architecture: 'x86_64', hostname: 'james-fleet-714-2', id: '48c1b3f1ac5da4e0057fc9f60f4d1d5d', - ip: '127.0.0.1,::1,10.132.0.50,fe80::7d39:3147:4d9a:f809', - mac: '42:01:0a:84:00:32', + ip: ['127.0.0.1', '::1', '10.132.0.50', 'fe80::7d39:3147:4d9a:f809'], + mac: ['42:01:0a:84:00:32'], name: 'james-fleet-714-2', os: { family: 'centos', diff --git a/x-pack/plugins/session_view/common/mocks/responses/session_view_process_events.mock.ts b/x-pack/plugins/session_view/common/mocks/responses/session_view_process_events.mock.ts index 47849f859ba9c..78206cc1a6320 100644 --- a/x-pack/plugins/session_view/common/mocks/responses/session_view_process_events.mock.ts +++ b/x-pack/plugins/session_view/common/mocks/responses/session_view_process_events.mock.ts @@ -24,8 +24,8 @@ export const sessionViewProcessEventsMock: ProcessEventResults = { architecture: 'x86_64', hostname: 'james-fleet-714-2', id: '48c1b3f1ac5da4e0057fc9f60f4d1d5d', - ip: '127.0.0.1,::1,10.132.0.50,fe80::7d39:3147:4d9a:f809', - mac: '42:01:0a:84:00:32', + ip: ['127.0.0.1', '::1', '10.132.0.50', 'fe80::7d39:3147:4d9a:f809'], + mac: ['42:01:0a:84:00:32'], name: 'james-fleet-714-2', os: { Ext: { @@ -427,8 +427,8 @@ export const sessionViewProcessEventsMock: ProcessEventResults = { architecture: 'x86_64', hostname: 'james-fleet-714-2', id: '48c1b3f1ac5da4e0057fc9f60f4d1d5d', - ip: '127.0.0.1,::1,10.132.0.50,fe80::7d39:3147:4d9a:f809', - mac: '42:01:0a:84:00:32', + ip: ['127.0.0.1', '::1', '10.132.0.50', 'fe80::7d39:3147:4d9a:f809'], + mac: ['42:01:0a:84:00:32'], name: 'james-fleet-714-2', os: { Ext: { @@ -836,8 +836,8 @@ export const sessionViewProcessEventsMock: ProcessEventResults = { architecture: 'x86_64', hostname: 'james-fleet-714-2', id: '48c1b3f1ac5da4e0057fc9f60f4d1d5d', - ip: '127.0.0.1,::1,10.132.0.50,fe80::7d39:3147:4d9a:f809', - mac: '42:01:0a:84:00:32', + ip: ['127.0.0.1', '::1', '10.132.0.50', 'fe80::7d39:3147:4d9a:f809'], + mac: ['42:01:0a:84:00:32'], name: 'james-fleet-714-2', os: { Ext: { diff --git a/x-pack/plugins/session_view/common/types/process_tree/index.ts b/x-pack/plugins/session_view/common/types/process_tree/index.ts index 11f5aeb2ffac2..f337b6a38c742 100644 --- a/x-pack/plugins/session_view/common/types/process_tree/index.ts +++ b/x-pack/plugins/session_view/common/types/process_tree/index.ts @@ -97,8 +97,8 @@ export interface ProcessEventHost { architecture?: string; hostname?: string; id?: string; - ip?: string; - mac?: string; + ip?: string[]; + mac?: string[]; name?: string; os?: { family?: string; diff --git a/x-pack/plugins/session_view/public/components/detail_panel_copy/index.test.tsx b/x-pack/plugins/session_view/public/components/detail_panel_copy/index.test.tsx index 3489b516689de..2b1f53c9ab8ab 100644 --- a/x-pack/plugins/session_view/public/components/detail_panel_copy/index.test.tsx +++ b/x-pack/plugins/session_view/public/components/detail_panel_copy/index.test.tsx @@ -24,7 +24,9 @@ describe('DetailPanelCopy component', () => { describe('When DetailPanelCopy is mounted', () => { it('renders DetailPanelCopy correctly', async () => { renderResult = mockedContext.render( - {TEST_CHILD} + + {TEST_CHILD} + ); expect(renderResult.queryByText(TEST_TEXT_COPY)).toBeVisible(); diff --git a/x-pack/plugins/session_view/public/components/detail_panel_copy/index.tsx b/x-pack/plugins/session_view/public/components/detail_panel_copy/index.tsx index 92bfe6bd0c73e..72febd9ea25ea 100644 --- a/x-pack/plugins/session_view/public/components/detail_panel_copy/index.tsx +++ b/x-pack/plugins/session_view/public/components/detail_panel_copy/index.tsx @@ -8,12 +8,12 @@ import React, { ReactNode } from 'react'; import { EuiButtonIcon, EuiCopy, EuiToolTip } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; import { DetailPanelListItem } from '../detail_panel_list_item'; -import { dataOrDash } from '../../utils/data_or_dash'; import { useStyles } from './styles'; interface DetailPanelCopyDeps { children: ReactNode; textToCopy: string; + tooltipContent: ReactNode; display?: 'inlineBlock' | 'block' | undefined; } @@ -28,6 +28,7 @@ interface DetailPanelListItemProps { export const DetailPanelCopy = ({ children, textToCopy, + tooltipContent, display = 'inlineBlock', }: DetailPanelCopyDeps) => { const styles = useStyles(); @@ -57,7 +58,7 @@ export const DetailPanelCopy = ({ return ( - + <>{children} diff --git a/x-pack/plugins/session_view/public/components/detail_panel_host_tab/helpers.test.ts b/x-pack/plugins/session_view/public/components/detail_panel_host_tab/helpers.test.ts new file mode 100644 index 0000000000000..a2d096d91310e --- /dev/null +++ b/x-pack/plugins/session_view/public/components/detail_panel_host_tab/helpers.test.ts @@ -0,0 +1,85 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ +import { ProcessEventHost } from '../../../common/types/process_tree'; +import { DASH } from '../../constants'; +import { getHostData } from './helpers'; + +const MOCK_HOST_DATA: ProcessEventHost = { + architecture: 'x86_64', + hostname: 'james-fleet-714-2', + id: '48c1b3f1ac5da4e0057fc9f60f4d1d5d', + ip: ['127.0.0.1', '::1', '10.132.0.50', 'fe80::7d39:3147:4d9a:f809'], + mac: ['42:01:0a:84:00:32'], + name: 'james-fleet-714-2', + os: { + family: 'centos', + full: 'CentOS 7.9.2009', + kernel: '3.10.0-1160.31.1.el7.x86_64 #1 SMP Thu Jun 10 13:32:12 UTC 2021', + name: 'Linux', + platform: 'centos', + version: '7.9.2009', + }, +}; + +describe('detail panel host tab helpers tests', () => { + it('getHostData returns fields with a dash with undefined host', () => { + const result = getHostData(undefined); + expect(result.architecture).toEqual(DASH); + expect(result.hostname).toEqual(DASH); + expect(result.id).toEqual(DASH); + expect(result.ip).toEqual(DASH); + expect(result.mac).toEqual(DASH); + expect(result.name).toEqual(DASH); + expect(result.os.family).toEqual(DASH); + expect(result.os.full).toEqual(DASH); + expect(result.os.kernel).toEqual(DASH); + expect(result.os.name).toEqual(DASH); + expect(result.os.platform).toEqual(DASH); + expect(result.os.version).toEqual(DASH); + }); + + it('getHostData returns dashes for missing fields', () => { + const result = getHostData({ + ...MOCK_HOST_DATA, + ip: ['127.0.0.1', '', '', 'fe80::7d39:3147:4d9a:f809'], + name: undefined, + os: { + ...MOCK_HOST_DATA.os, + full: undefined, + platform: undefined, + }, + }); + expect(result.architecture).toEqual(MOCK_HOST_DATA.architecture); + expect(result.hostname).toEqual(MOCK_HOST_DATA.hostname); + expect(result.id).toEqual(MOCK_HOST_DATA.id); + expect(result.ip).toEqual(['127.0.0.1', DASH, DASH, 'fe80::7d39:3147:4d9a:f809'].join(', ')); + expect(result.mac).toEqual(MOCK_HOST_DATA.mac?.join(', ')); + expect(result.name).toEqual(DASH); + expect(result.os.family).toEqual(MOCK_HOST_DATA.os?.family); + expect(result.os.full).toEqual(DASH); + expect(result.os.kernel).toEqual(MOCK_HOST_DATA.os?.kernel); + expect(result.os.name).toEqual(MOCK_HOST_DATA.os?.name); + expect(result.os.platform).toEqual(DASH); + expect(result.os.version).toEqual(MOCK_HOST_DATA.os?.version); + }); + + it('getHostData returns all data provided', () => { + const result = getHostData(MOCK_HOST_DATA); + expect(result.architecture).toEqual(MOCK_HOST_DATA.architecture); + expect(result.hostname).toEqual(MOCK_HOST_DATA.hostname); + expect(result.id).toEqual(MOCK_HOST_DATA.id); + expect(result.ip).toEqual(MOCK_HOST_DATA.ip?.join(', ')); + expect(result.mac).toEqual(MOCK_HOST_DATA.mac?.join(', ')); + expect(result.name).toEqual(MOCK_HOST_DATA.name); + expect(result.os.family).toEqual(MOCK_HOST_DATA.os?.family); + expect(result.os.full).toEqual(MOCK_HOST_DATA.os?.full); + expect(result.os.kernel).toEqual(MOCK_HOST_DATA.os?.kernel); + expect(result.os.name).toEqual(MOCK_HOST_DATA.os?.name); + expect(result.os.platform).toEqual(MOCK_HOST_DATA.os?.platform); + expect(result.os.version).toEqual(MOCK_HOST_DATA.os?.version); + }); +}); diff --git a/x-pack/plugins/session_view/public/components/detail_panel_host_tab/helpers.ts b/x-pack/plugins/session_view/public/components/detail_panel_host_tab/helpers.ts new file mode 100644 index 0000000000000..72565f5885e37 --- /dev/null +++ b/x-pack/plugins/session_view/public/components/detail_panel_host_tab/helpers.ts @@ -0,0 +1,49 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { ProcessEventHost } from '../../../common/types/process_tree'; +import { DASH } from '../../constants'; +import { DetailPanelHost } from '../../types'; +import { dataOrDash } from '../../utils/data_or_dash'; + +export const getHostData = (host: ProcessEventHost | undefined): DetailPanelHost => { + const detailPanelHost: DetailPanelHost = { + architecture: DASH, + hostname: DASH, + id: DASH, + ip: DASH, + mac: DASH, + name: DASH, + os: { + family: DASH, + full: DASH, + kernel: DASH, + name: DASH, + platform: DASH, + version: DASH, + }, + }; + + if (!host) { + return detailPanelHost; + } + + detailPanelHost.hostname = dataOrDash(host.hostname).toString(); + detailPanelHost.id = dataOrDash(host.id).toString(); + detailPanelHost.ip = host.ip?.map?.((ip) => dataOrDash(ip)).join(', ') ?? DASH; + detailPanelHost.mac = host.mac?.map?.((mac) => dataOrDash(mac)).join(', ') ?? DASH; + detailPanelHost.name = dataOrDash(host.name).toString(); + detailPanelHost.architecture = dataOrDash(host.architecture).toString(); + detailPanelHost.os.family = dataOrDash(host.os?.family).toString(); + detailPanelHost.os.full = dataOrDash(host.os?.full).toString(); + detailPanelHost.os.kernel = dataOrDash(host.os?.kernel).toString(); + detailPanelHost.os.name = dataOrDash(host.os?.name).toString(); + detailPanelHost.os.platform = dataOrDash(host.os?.platform).toString(); + detailPanelHost.os.version = dataOrDash(host.os?.version).toString(); + + return detailPanelHost; +}; diff --git a/x-pack/plugins/session_view/public/components/detail_panel_host_tab/index.test.tsx b/x-pack/plugins/session_view/public/components/detail_panel_host_tab/index.test.tsx index 17e9102fb8ed9..41a5ada524974 100644 --- a/x-pack/plugins/session_view/public/components/detail_panel_host_tab/index.test.tsx +++ b/x-pack/plugins/session_view/public/components/detail_panel_host_tab/index.test.tsx @@ -13,8 +13,8 @@ import { DetailPanelHostTab } from '.'; const TEST_ARCHITECTURE = 'x86_64'; const TEST_HOSTNAME = 'host-james-fleet-714-2'; const TEST_ID = '48c1b3f1ac5da4e0057fc9f60f4d1d5d'; -const TEST_IP = '127.0.0.1,::1,10.132.0.50,fe80::7d39:3147:4d9a:f809'; -const TEST_MAC = '42:01:0a:84:00:32'; +const TEST_IP = ['127.0.0.1', '::1', '10.132.0.50', 'fe80::7d39:3147:4d9a:f809']; +const TEST_MAC = ['42:01:0a:84:00:32']; const TEST_NAME = 'name-james-fleet-714-2'; const TEST_OS_FAMILY = 'family-centos'; const TEST_OS_FULL = 'full-CentOS 7.9.2009'; @@ -62,8 +62,8 @@ describe('DetailPanelHostTab component', () => { expect(renderResult.queryByText(TEST_ARCHITECTURE)).toBeVisible(); expect(renderResult.queryByText(TEST_HOSTNAME)).toBeVisible(); expect(renderResult.queryByText(TEST_ID)).toBeVisible(); - expect(renderResult.queryByText(TEST_IP)).toBeVisible(); - expect(renderResult.queryByText(TEST_MAC)).toBeVisible(); + expect(renderResult.queryByText(TEST_IP.join(', '))).toBeVisible(); + expect(renderResult.queryByText(TEST_MAC.join(', '))).toBeVisible(); expect(renderResult.queryByText(TEST_NAME)).toBeVisible(); // expand host os accordion diff --git a/x-pack/plugins/session_view/public/components/detail_panel_host_tab/index.tsx b/x-pack/plugins/session_view/public/components/detail_panel_host_tab/index.tsx index 49e77089972a4..2b1c2f97fa738 100644 --- a/x-pack/plugins/session_view/public/components/detail_panel_host_tab/index.tsx +++ b/x-pack/plugins/session_view/public/components/detail_panel_host_tab/index.tsx @@ -4,15 +4,15 @@ * 2.0; you may not use this file except in compliance with the Elastic License * 2.0. */ -import React from 'react'; +import React, { useMemo } from 'react'; import { EuiTextColor } from '@elastic/eui'; import { ProcessEventHost } from '../../../common/types/process_tree'; import { DetailPanelAccordion } from '../detail_panel_accordion'; import { DetailPanelCopy } from '../detail_panel_copy'; import { DetailPanelDescriptionList } from '../detail_panel_description_list'; import { DetailPanelListItem } from '../detail_panel_list_item'; -import { dataOrDash } from '../../utils/data_or_dash'; import { useStyles } from '../detail_panel_process_tab/styles'; +import { getHostData } from './helpers'; interface DetailPanelHostTabDeps { processHost?: ProcessEventHost; @@ -23,6 +23,7 @@ interface DetailPanelHostTabDeps { */ export const DetailPanelHostTab = ({ processHost }: DetailPanelHostTabDeps) => { const styles = useStyles(); + const hostData = useMemo(() => getHostData(processHost), [processHost]); return ( <> @@ -31,9 +32,12 @@ export const DetailPanelHostTab = ({ processHost }: DetailPanelHostTabDeps) => { { title: hostname, description: ( - + - {dataOrDash(processHost?.hostname)} + {hostData.hostname} ), @@ -41,9 +45,12 @@ export const DetailPanelHostTab = ({ processHost }: DetailPanelHostTabDeps) => { { title: id, description: ( - + - {dataOrDash(processHost?.id)} + {hostData.id} ), @@ -51,9 +58,12 @@ export const DetailPanelHostTab = ({ processHost }: DetailPanelHostTabDeps) => { { title: ip, description: ( - + - {dataOrDash(processHost?.ip)} + {hostData.ip} ), @@ -61,9 +71,12 @@ export const DetailPanelHostTab = ({ processHost }: DetailPanelHostTabDeps) => { { title: mac, description: ( - + - {dataOrDash(processHost?.mac)} + {hostData.mac} ), @@ -71,9 +84,12 @@ export const DetailPanelHostTab = ({ processHost }: DetailPanelHostTabDeps) => { { title: name, description: ( - + - {dataOrDash(processHost?.name)} + {hostData.name} ), @@ -88,10 +104,11 @@ export const DetailPanelHostTab = ({ processHost }: DetailPanelHostTabDeps) => { title: architecture, description: ( - {dataOrDash(processHost?.architecture)} + {hostData.architecture} ), @@ -100,10 +117,11 @@ export const DetailPanelHostTab = ({ processHost }: DetailPanelHostTabDeps) => { title: os.family, description: ( - {dataOrDash(processHost?.os?.family)} + {hostData.os.family} ), @@ -111,9 +129,12 @@ export const DetailPanelHostTab = ({ processHost }: DetailPanelHostTabDeps) => { { title: os.full, description: ( - + - {dataOrDash(processHost?.os?.full)} + {hostData.os.full} ), @@ -122,10 +143,11 @@ export const DetailPanelHostTab = ({ processHost }: DetailPanelHostTabDeps) => { title: os.kernel, description: ( - {dataOrDash(processHost?.os?.kernel)} + {hostData.os.kernel} ), @@ -133,9 +155,12 @@ export const DetailPanelHostTab = ({ processHost }: DetailPanelHostTabDeps) => { { title: os.name, description: ( - + - {dataOrDash(processHost?.os?.name)} + {hostData.os.name} ), @@ -144,10 +169,11 @@ export const DetailPanelHostTab = ({ processHost }: DetailPanelHostTabDeps) => { title: os.platform, description: ( - {dataOrDash(processHost?.os?.platform)} + {hostData.os.platform} ), @@ -156,10 +182,11 @@ export const DetailPanelHostTab = ({ processHost }: DetailPanelHostTabDeps) => { title: os.version, description: ( - {dataOrDash(processHost?.os?.version)} + {hostData.os.version} ), diff --git a/x-pack/plugins/session_view/public/components/detail_panel_process_tab/helpers.test.ts b/x-pack/plugins/session_view/public/components/detail_panel_process_tab/helpers.test.ts index de5339fa2bbbe..a50c6e73e198d 100644 --- a/x-pack/plugins/session_view/public/components/detail_panel_process_tab/helpers.test.ts +++ b/x-pack/plugins/session_view/public/components/detail_panel_process_tab/helpers.test.ts @@ -4,6 +4,7 @@ * 2.0; you may not use this file except in compliance with the Elastic License * 2.0. */ +import { DASH } from '../../constants'; import { getProcessExecutableCopyText, formatProcessArgs, getIsInterativeString } from './helpers'; describe('detail panel process tab helpers tests', () => { @@ -36,7 +37,7 @@ describe('detail panel process tab helpers tests', () => { it("formatProcessArgs returns '-' when given empty args array", () => { const result = formatProcessArgs([]); - expect(result).toEqual('-'); + expect(result).toEqual(DASH); }); it('formatProcessArgs returns formatted args string', () => { diff --git a/x-pack/plugins/session_view/public/components/detail_panel_process_tab/helpers.ts b/x-pack/plugins/session_view/public/components/detail_panel_process_tab/helpers.ts index 4584e7fb217dd..4417a5329a752 100644 --- a/x-pack/plugins/session_view/public/components/detail_panel_process_tab/helpers.ts +++ b/x-pack/plugins/session_view/public/components/detail_panel_process_tab/helpers.ts @@ -5,7 +5,29 @@ * 2.0. */ -import { Teletype } from '../../../common/types/process_tree'; +import { EventAction, Process, ProcessFields, Teletype } from '../../../common/types/process_tree'; +import { DetailPanelProcess, DetailPanelProcessLeader } from '../../types'; +import { DASH } from '../../constants'; +import { dataOrDash } from '../../utils/data_or_dash'; + +const FILTER_FORKS_EXECS = [EventAction.fork, EventAction.exec]; + +const DEFAULT_PROCESS_DATA: DetailPanelProcessLeader = { + id: DASH, + name: DASH, + start: DASH, + end: DASH, + exitCode: DASH, + userName: DASH, + groupName: DASH, + workingDirectory: DASH, + interactive: DASH, + args: DASH, + pid: DASH, + entryMetaType: DASH, + entryMetaSourceIp: DASH, + executable: [[DASH]], +}; /** * Serialize an array of executable tuples to a copyable text. @@ -32,11 +54,11 @@ export const getProcessExecutableCopyText = (executable: string[][]): string => /** * Format an array of args for display. * - * @param {String[]} args + * @param {String[] | undefined} args * @return {String} formatted string of process args */ -export const formatProcessArgs = (args: string[]): string => - args.length ? `[${args.map((arg) => `'${arg}'`).join(', ')}]` : '-'; +export const formatProcessArgs = (args: string[] | undefined): string => + args && args.length && args.map ? `[${args.map((arg) => `'${arg}'`).join(', ')}]` : DASH; /** * Get isInteractive boolean string from tty. @@ -46,3 +68,86 @@ export const formatProcessArgs = (args: string[]): string => */ export const getIsInterativeString = (tty: Teletype | undefined): string => !!tty ? 'True' : 'False'; + +const getDetailPanelProcessLeader = ( + leader: ProcessFields | undefined +): DetailPanelProcessLeader => ({ + ...leader, + id: leader?.entity_id ?? DEFAULT_PROCESS_DATA.id, + name: leader?.name ?? DEFAULT_PROCESS_DATA.name, + start: leader?.start ?? DEFAULT_PROCESS_DATA.start, + end: leader?.end ?? DEFAULT_PROCESS_DATA.end, + exitCode: leader?.exit_code?.toString() ?? DEFAULT_PROCESS_DATA.exitCode, + interactive: getIsInterativeString(leader?.tty), + userName: leader?.user?.name ?? DEFAULT_PROCESS_DATA.userName, + groupName: leader?.group?.name ?? DEFAULT_PROCESS_DATA.groupName, + workingDirectory: leader?.working_directory ?? DEFAULT_PROCESS_DATA.workingDirectory, + args: formatProcessArgs(leader?.args) ?? DEFAULT_PROCESS_DATA.args, + pid: leader?.pid?.toString() ?? DEFAULT_PROCESS_DATA.pid, + // TODO: get the event action of leader + executable: leader?.executable ? [[leader?.executable]] : DEFAULT_PROCESS_DATA.executable, + entryMetaType: leader?.entry_meta?.type ?? DEFAULT_PROCESS_DATA.entryMetaType, + entryMetaSourceIp: leader?.entry_meta?.source?.ip ?? DEFAULT_PROCESS_DATA.entryMetaSourceIp, +}); + +export const getDetailPanelProcess = (process: Process | null): DetailPanelProcess => { + const processData = { + id: DEFAULT_PROCESS_DATA.id, + start: DEFAULT_PROCESS_DATA.start, + end: DEFAULT_PROCESS_DATA.end, + exitCode: DEFAULT_PROCESS_DATA.exitCode, + interactive: DEFAULT_PROCESS_DATA.interactive, + userName: DEFAULT_PROCESS_DATA.userName, + groupName: DEFAULT_PROCESS_DATA.groupName, + args: DEFAULT_PROCESS_DATA.args, + pid: DEFAULT_PROCESS_DATA.pid, + executable: DEFAULT_PROCESS_DATA.executable, + workingDirectory: DEFAULT_PROCESS_DATA.workingDirectory, + entryLeader: DEFAULT_PROCESS_DATA, + sessionLeader: DEFAULT_PROCESS_DATA, + groupLeader: DEFAULT_PROCESS_DATA, + parent: DEFAULT_PROCESS_DATA, + } as DetailPanelProcess; + if (!process) { + return processData; + } + + const details = process.getDetails(); + + processData.id = `${dataOrDash(process.id)}`; + processData.start = `${dataOrDash(details.process?.start)}`; + processData.end = `${dataOrDash(process.getEndTime())}`; + processData.exitCode = `${dataOrDash(details.process?.exit_code)}`; + processData.interactive = getIsInterativeString(details.process?.tty); + processData.userName = `${dataOrDash(details.process?.user?.name)}`; + processData.groupName = `${dataOrDash(details.process?.group?.name)}`; + processData.pid = `${dataOrDash(details.process?.pid)}`; + processData.workingDirectory = `${dataOrDash(details.process?.working_directory)}`; + if (details.process?.args) { + processData.args = formatProcessArgs(details.process.args); + } + + // we grab the executable from each process lifecycle event to give an indication + // of the processes journey. Processes can sometimes exec multiple times, so it's good + // information to have. + processData.executable = []; + process.events.forEach((event) => { + if ( + event.process?.executable && + event.event?.action && + FILTER_FORKS_EXECS.includes(event.event.action) + ) { + processData.executable.push([event.process.executable, `(${event.event.action})`]); + } + }); + if (!processData.executable.length) { + processData.executable = DEFAULT_PROCESS_DATA.executable; + } + + processData.entryLeader = getDetailPanelProcessLeader(details?.process?.entry_leader); + processData.sessionLeader = getDetailPanelProcessLeader(details?.process?.session_leader); + processData.groupLeader = getDetailPanelProcessLeader(details?.process?.group_leader); + processData.parent = getDetailPanelProcessLeader(details?.process?.parent); + + return processData; +}; diff --git a/x-pack/plugins/session_view/public/components/detail_panel_process_tab/index.test.tsx b/x-pack/plugins/session_view/public/components/detail_panel_process_tab/index.test.tsx index 7daaf997e2af8..488d83ca9880e 100644 --- a/x-pack/plugins/session_view/public/components/detail_panel_process_tab/index.test.tsx +++ b/x-pack/plugins/session_view/public/components/detail_panel_process_tab/index.test.tsx @@ -7,60 +7,15 @@ import React from 'react'; import { AppContextTestRender, createAppRootMockRenderer } from '../../test'; -import { DetailPanelProcess, DetailPanelProcessLeader } from '../../types'; +import { sessionViewBasicProcessMock } from '../../../common/mocks/constants/session_view_process.mock'; import { DetailPanelProcessTab } from '.'; -const getLeaderDetail = (leader: string): DetailPanelProcessLeader => ({ - id: `${leader}-id`, - name: `${leader}-name`, - start: new Date('2022-02-24').toISOString(), - entryMetaType: 'sshd', - working_directory: '/home/jack', - tty: { - char_device: { - major: 8, - minor: 1, - }, - }, - args: ['ls'], - userName: `${leader}-jack`, - groupName: `${leader}-jack-group`, - pid: 1234, - entryMetaSourceIp: '10.132.0.50', - executable: '/usr/bin/bash', -}); - -const TEST_PROCESS_DETAIL: DetailPanelProcess = { - id: 'process-id', - start: new Date('2022-02-22').toISOString(), - end: new Date('2022-02-23').toISOString(), - exit_code: 137, - userName: 'process-jack', - groupName: 'process-jack-group', - args: ['vi', 'test.txt'], - executable: [ - ['test-executable-cmd', '(fork)'], - ['test-executable-cmd', '(exec)'], - ['test-executable-cmd', '(end)'], - ], - working_directory: '/home/jack', - tty: { - char_device: { - major: 8, - minor: 1, - }, - }, - pid: 1233, - entryLeader: getLeaderDetail('entryLeader'), - sessionLeader: getLeaderDetail('sessionLeader'), - groupLeader: getLeaderDetail('groupLeader'), - parent: getLeaderDetail('parent'), -}; - describe('DetailPanelProcessTab component', () => { let render: () => ReturnType; let renderResult: ReturnType; let mockedContext: AppContextTestRender; + const processDetail = sessionViewBasicProcessMock.getDetails(); + const MOCK_PROCESS_END = '2021-11-24T15:25:04.210Z'; beforeEach(() => { mockedContext = createAppRootMockRenderer(); @@ -69,21 +24,29 @@ describe('DetailPanelProcessTab component', () => { describe('When DetailPanelProcessTab is mounted', () => { it('renders DetailPanelProcessTab correctly', async () => { renderResult = mockedContext.render( - + MOCK_PROCESS_END, + }} + /> ); // Process detail rendered correctly - expect(renderResult.queryByText(TEST_PROCESS_DETAIL.id)).toBeVisible(); - expect(renderResult.queryByText(TEST_PROCESS_DETAIL.start)).toBeVisible(); - expect(renderResult.queryByText(TEST_PROCESS_DETAIL.end)).toBeVisible(); - expect(renderResult.queryByText(TEST_PROCESS_DETAIL.exit_code!)).toBeVisible(); - expect(renderResult.queryByText(TEST_PROCESS_DETAIL.userName)).toBeVisible(); - expect(renderResult.queryByText(`['vi', 'test.txt']`)).toBeVisible(); - expect(renderResult.queryAllByText('test-executable-cmd')).toHaveLength(3); + expect(renderResult.queryByText(processDetail!.process!.entity_id!)).toBeVisible(); + expect(renderResult.queryByText(processDetail!.process!.start!)).toBeVisible(); + expect(renderResult.queryByText(MOCK_PROCESS_END)).toBeVisible(); + expect(renderResult.queryByText(processDetail!.process!.exit_code!)).toBeVisible(); + expect(renderResult.queryAllByText(processDetail!.process!.user!.name!)).toHaveLength(10); + expect(renderResult.queryAllByText(processDetail!.process!.working_directory!)).toHaveLength( + 5 + ); + expect(renderResult.queryByText(`['bash']`)).toBeVisible(); + expect(renderResult.queryAllByText('/usr/bin/bash')).toHaveLength(5); + expect(renderResult.queryByText('/usr/bin/vi')).toBeVisible(); expect(renderResult.queryByText('(fork)')).toBeVisible(); expect(renderResult.queryByText('(exec)')).toBeVisible(); - expect(renderResult.queryByText('(end)')).toBeVisible(); - expect(renderResult.queryByText(TEST_PROCESS_DETAIL.pid!)).toBeVisible(); + expect(renderResult.queryByText(processDetail!.process!.pid!)).toBeVisible(); // Process tab accordions rendered correctly // TODO: revert back when we have jump to leaders button working diff --git a/x-pack/plugins/session_view/public/components/detail_panel_process_tab/index.tsx b/x-pack/plugins/session_view/public/components/detail_panel_process_tab/index.tsx index 7fbf2f262f9cf..f62c6188203a2 100644 --- a/x-pack/plugins/session_view/public/components/detail_panel_process_tab/index.tsx +++ b/x-pack/plugins/session_view/public/components/detail_panel_process_tab/index.tsx @@ -4,20 +4,20 @@ * 2.0; you may not use this file except in compliance with the Elastic License * 2.0. */ -import React, { ReactNode } from 'react'; +import React, { ReactNode, useCallback, useMemo } from 'react'; import { EuiTextColor } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; -import { DetailPanelProcess } from '../../types'; +import { Process } from '../../../common/types/process_tree'; import { DetailPanelAccordion } from '../detail_panel_accordion'; import { DetailPanelCopy } from '../detail_panel_copy'; import { DetailPanelDescriptionList } from '../detail_panel_description_list'; import { DetailPanelListItem } from '../detail_panel_list_item'; import { dataOrDash } from '../../utils/data_or_dash'; -import { getProcessExecutableCopyText, formatProcessArgs, getIsInterativeString } from './helpers'; +import { getProcessExecutableCopyText, getDetailPanelProcess } from './helpers'; import { useStyles } from './styles'; interface DetailPanelProcessTabDeps { - processDetail: DetailPanelProcess; + selectedProcess: Process | null; } type ListItems = Array<{ @@ -70,8 +70,30 @@ const LEADER_FIELD_PREFIX = [ /** * Detail panel in the session view. */ -export const DetailPanelProcessTab = ({ processDetail }: DetailPanelProcessTabDeps) => { +export const DetailPanelProcessTab = ({ selectedProcess }: DetailPanelProcessTabDeps) => { const styles = useStyles(); + + const processDetail = useMemo(() => getDetailPanelProcess(selectedProcess), [selectedProcess]); + const renderExecs = useCallback( + (executable: string[][]) => + executable.map((execTuple, idx) => { + const [exec, eventAction] = execTuple; + return ( +
+ + {exec} + + {eventAction && ( + + {eventAction} + + )} +
+ ); + }), + [styles.descriptionSemibold, styles.ellipsis, styles.executableAction] + ); + const leaderListItems = [ processDetail.entryLeader, processDetail.sessionLeader, @@ -82,27 +104,29 @@ export const DetailPanelProcessTab = ({ processDetail }: DetailPanelProcessTabDe id, start, end, - exit_code: exitCode, + exitCode, entryMetaType, - tty, - working_directory: workingDirectory, + interactive, + workingDirectory, args, + executable, pid, userName, groupName, entryMetaSourceIp, } = leader; - const leaderArgs = formatProcessArgs(args); - const isLeaderInteractive = getIsInterativeString(tty); + + const leaderExecutableText = getProcessExecutableCopyText(executable); const listItems: ListItems = [ { title: entity_id, description: ( - {dataOrDash(id)} + {id} ), @@ -110,8 +134,22 @@ export const DetailPanelProcessTab = ({ processDetail }: DetailPanelProcessTabDe { title: args, description: ( - - {leaderArgs} + + {args} + + ), + }, + { + title: executable, + description: ( + + {renderExecs(executable)} ), }, @@ -119,10 +157,11 @@ export const DetailPanelProcessTab = ({ processDetail }: DetailPanelProcessTabDe title: interactive, description: ( - {isLeaderInteractive} + {interactive} ), @@ -131,12 +170,11 @@ export const DetailPanelProcessTab = ({ processDetail }: DetailPanelProcessTabDe title: working_directory, description: ( - {dataOrDash(workingDirectory)} + {workingDirectory} ), @@ -144,9 +182,12 @@ export const DetailPanelProcessTab = ({ processDetail }: DetailPanelProcessTabDe { title: pid, description: ( - + - {dataOrDash(pid)} + {pid} ), @@ -154,16 +195,22 @@ export const DetailPanelProcessTab = ({ processDetail }: DetailPanelProcessTabDe { title: start, description: ( - - {dataOrDash(start)} + + {start} ), }, { title: end, description: ( - - {dataOrDash(end)} + + {end} ), }, @@ -171,10 +218,11 @@ export const DetailPanelProcessTab = ({ processDetail }: DetailPanelProcessTabDe title: exit_code, description: ( - {dataOrDash(exitCode)} + {exitCode} ), @@ -183,9 +231,10 @@ export const DetailPanelProcessTab = ({ processDetail }: DetailPanelProcessTabDe title: user.name, description: ( - {dataOrDash(userName)} + {userName} ), }, @@ -193,9 +242,10 @@ export const DetailPanelProcessTab = ({ processDetail }: DetailPanelProcessTabDe title: group.name, description: ( - {dataOrDash(groupName)} + {groupName} ), }, @@ -207,12 +257,11 @@ export const DetailPanelProcessTab = ({ processDetail }: DetailPanelProcessTabDe title: entry_meta.type, description: ( - {dataOrDash(entryMetaType)} + {entryMetaType} ), @@ -221,9 +270,8 @@ export const DetailPanelProcessTab = ({ processDetail }: DetailPanelProcessTabDe title: entry_meta.source.ip, description: ( {dataOrDash(entryMetaSourceIp)} @@ -244,17 +292,15 @@ export const DetailPanelProcessTab = ({ processDetail }: DetailPanelProcessTabDe start, end, executable, - exit_code: exitCode, + exitCode, pid, - working_directory: workingDirectory, - tty, + workingDirectory, + interactive, userName, groupName, args, } = processDetail; - - const isInteractive = getIsInterativeString(tty); - const processArgs = formatProcessArgs(args); + const executableText = getProcessExecutableCopyText(executable); return ( <> @@ -264,10 +310,11 @@ export const DetailPanelProcessTab = ({ processDetail }: DetailPanelProcessTabDe title: entity_id, description: ( - {dataOrDash(id)} + {id} ), @@ -275,8 +322,11 @@ export const DetailPanelProcessTab = ({ processDetail }: DetailPanelProcessTabDe { title: args, description: ( - - {processArgs} + + {args} ), }, @@ -284,24 +334,11 @@ export const DetailPanelProcessTab = ({ processDetail }: DetailPanelProcessTabDe title: executable, description: ( - {executable.map((execTuple, idx) => { - const [exec, eventAction] = execTuple; - return ( -
- - {dataOrDash(exec)} - - - {eventAction} - -
- ); - })} + {renderExecs(executable)} ), }, @@ -309,10 +346,11 @@ export const DetailPanelProcessTab = ({ processDetail }: DetailPanelProcessTabDe title: interactive, description: ( - {isInteractive} + {interactive} ), @@ -321,12 +359,11 @@ export const DetailPanelProcessTab = ({ processDetail }: DetailPanelProcessTabDe title: working_directory, description: ( - {dataOrDash(workingDirectory)} + {workingDirectory} ), @@ -334,9 +371,12 @@ export const DetailPanelProcessTab = ({ processDetail }: DetailPanelProcessTabDe { title: pid, description: ( - + - {dataOrDash(pid)} + {pid} ), @@ -344,16 +384,22 @@ export const DetailPanelProcessTab = ({ processDetail }: DetailPanelProcessTabDe { title: start, description: ( - - {dataOrDash(start)} + + {start} ), }, { title: end, description: ( - - {dataOrDash(end)} + + {end} ), }, @@ -361,10 +407,11 @@ export const DetailPanelProcessTab = ({ processDetail }: DetailPanelProcessTabDe title: exit_code, description: ( - {dataOrDash(exitCode)} + {exitCode} ), @@ -373,9 +420,10 @@ export const DetailPanelProcessTab = ({ processDetail }: DetailPanelProcessTabDe title: user.name, description: ( - {dataOrDash(userName)} + {userName} ), }, @@ -383,9 +431,10 @@ export const DetailPanelProcessTab = ({ processDetail }: DetailPanelProcessTabDe title: group.name, description: ( - {dataOrDash(groupName)} + {groupName} ), }, diff --git a/x-pack/plugins/session_view/public/components/session_view_detail_panel/helpers.test.ts b/x-pack/plugins/session_view/public/components/session_view_detail_panel/helpers.test.ts new file mode 100644 index 0000000000000..70b0fe7ec272f --- /dev/null +++ b/x-pack/plugins/session_view/public/components/session_view_detail_panel/helpers.test.ts @@ -0,0 +1,38 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ +import { getSelectedTabContent } from './helpers'; +import { EuiTabProps } from '../../types'; + +const TABS: EuiTabProps[] = [ + { + id: '1', + name: 'Process', + content: 'process content', + }, + { + id: '2', + name: 'Host', + content: 'host content', + }, + { + id: '3', + name: 'Alert', + content: 'alert content', + }, +]; + +describe('session view detail panel helpers tests', () => { + it('getSelectedTabContent works', () => { + const result = getSelectedTabContent(TABS, '1'); + expect(result).toBe(TABS[0].content); + }); + + it('getSelectedTabContent returns null if tab id not found', () => { + const result = getSelectedTabContent(TABS, 'process'); + expect(result).toBeNull(); + }); +}); diff --git a/x-pack/plugins/session_view/public/components/session_view_detail_panel/helpers.ts b/x-pack/plugins/session_view/public/components/session_view_detail_panel/helpers.ts index e4e6cb0134bbc..755c24f83361a 100644 --- a/x-pack/plugins/session_view/public/components/session_view_detail_panel/helpers.ts +++ b/x-pack/plugins/session_view/public/components/session_view_detail_panel/helpers.ts @@ -4,108 +4,7 @@ * 2.0; you may not use this file except in compliance with the Elastic License * 2.0. */ -import { EventAction, Process, ProcessFields } from '../../../common/types/process_tree'; -import { DetailPanelProcess, EuiTabProps } from '../../types'; - -const FILTER_FORKS_EXECS = [EventAction.fork, EventAction.exec]; - -const DEFAULT_PROCESS_DATA = { - id: '', - name: '', - start: '', - end: '', - userName: '', - groupName: '', - working_directory: '', - args: [], - entryMetaType: '', - entryMetaSourceIp: '', - executable: '', -}; - -const getDetailPanelProcessLeader = (leader: ProcessFields | undefined) => ({ - ...leader, - name: leader?.name ?? DEFAULT_PROCESS_DATA.name, - start: leader?.start ?? DEFAULT_PROCESS_DATA.start, - working_directory: leader?.working_directory ?? DEFAULT_PROCESS_DATA.working_directory, - args: leader?.args ?? DEFAULT_PROCESS_DATA.args, - executable: leader?.executable ?? DEFAULT_PROCESS_DATA.executable, - id: leader?.entity_id ?? DEFAULT_PROCESS_DATA.id, - entryMetaType: leader?.entry_meta?.type ?? DEFAULT_PROCESS_DATA.entryMetaType, - userName: leader?.user?.name ?? DEFAULT_PROCESS_DATA.userName, - groupName: leader?.group?.name ?? DEFAULT_PROCESS_DATA.groupName, - entryMetaSourceIp: leader?.entry_meta?.source?.ip ?? DEFAULT_PROCESS_DATA.entryMetaSourceIp, -}); - -export const getDetailPanelProcess = (process: Process | null) => { - const processData = {} as DetailPanelProcess; - if (!process) { - return { - id: DEFAULT_PROCESS_DATA.id, - start: DEFAULT_PROCESS_DATA.start, - end: DEFAULT_PROCESS_DATA.end, - userName: DEFAULT_PROCESS_DATA.userName, - groupName: DEFAULT_PROCESS_DATA.groupName, - args: DEFAULT_PROCESS_DATA.args, - executable: [], - working_directory: DEFAULT_PROCESS_DATA.working_directory, - entryLeader: DEFAULT_PROCESS_DATA, - sessionLeader: DEFAULT_PROCESS_DATA, - groupLeader: DEFAULT_PROCESS_DATA, - parent: DEFAULT_PROCESS_DATA, - }; - } - - const details = process.getDetails(); - - processData.id = process.id; - processData.start = details.process?.start ?? ''; - processData.args = []; - processData.executable = []; - - if (!processData.userName) { - processData.userName = details.process?.user?.name ?? ''; - } - if (!processData.groupName) { - processData.groupName = details.process?.group?.name ?? ''; - } - if (!processData.pid) { - processData.pid = details.process?.pid; - } - if (!processData.working_directory) { - processData.working_directory = details.process?.working_directory ?? ''; - } - if (!processData.tty) { - processData.tty = details.process?.tty; - } - if (details.process?.args && details.process.args.length > 0) { - processData.args = details.process.args; - } - if (details.process?.exit_code !== undefined) { - processData.exit_code = details.process.exit_code; - } - - // we grab the executable from each process lifecycle event to give an indication - // of the processes journey. Processes can sometimes exec multiple times, so it's good - // information to have. - process.events.forEach((event) => { - if ( - event.process?.executable && - event.event?.action && - FILTER_FORKS_EXECS.includes(event.event.action) - ) { - processData.executable.push([event.process.executable, `(${event.event.action})`]); - } - }); - - processData.end = process.getEndTime(); - processData.entryLeader = getDetailPanelProcessLeader(details?.process?.entry_leader); - processData.sessionLeader = getDetailPanelProcessLeader(details?.process?.session_leader); - processData.groupLeader = getDetailPanelProcessLeader(details?.process?.group_leader); - processData.parent = getDetailPanelProcessLeader(details?.process?.parent); - - return processData; -}; +import { EuiTabProps } from '../../types'; export const getSelectedTabContent = (tabs: EuiTabProps[], selectedTabId: string) => { const selectedTab = tabs.find((tab) => tab.id === selectedTabId); diff --git a/x-pack/plugins/session_view/public/components/session_view_detail_panel/index.tsx b/x-pack/plugins/session_view/public/components/session_view_detail_panel/index.tsx index 130d15ca4df30..a22ad026c4395 100644 --- a/x-pack/plugins/session_view/public/components/session_view_detail_panel/index.tsx +++ b/x-pack/plugins/session_view/public/components/session_view_detail_panel/index.tsx @@ -9,7 +9,7 @@ import { EuiTabs, EuiTab, EuiNotificationBadge } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; import { EuiTabProps } from '../../types'; import { Process, ProcessEvent } from '../../../common/types/process_tree'; -import { getDetailPanelProcess, getSelectedTabContent } from './helpers'; +import { getSelectedTabContent } from './helpers'; import { DetailPanelProcessTab } from '../detail_panel_process_tab'; import { DetailPanelHostTab } from '../detail_panel_host_tab'; import { useStyles } from './styles'; @@ -35,7 +35,6 @@ export const SessionViewDetailPanel = ({ onShowAlertDetails, }: SessionViewDetailPanelDeps) => { const [selectedTabId, setSelectedTabId] = useState('process'); - const processDetail = useMemo(() => getDetailPanelProcess(selectedProcess), [selectedProcess]); const alertsCount = useMemo(() => { if (!alerts) { @@ -54,7 +53,7 @@ export const SessionViewDetailPanel = ({ name: i18n.translate('xpack.sessionView.detailsPanel.process', { defaultMessage: 'Process', }), - content: , + content: , }, { id: 'host', @@ -85,12 +84,11 @@ export const SessionViewDetailPanel = ({ ]; }, [ alerts, + selectedProcess, alertsCount, - processDetail, - selectedProcess?.events, + onJumpToEvent, onShowAlertDetails, investigatedAlertId, - onJumpToEvent, ]); const onSelectedTabChanged = useCallback((id: string) => { diff --git a/x-pack/plugins/data_enhanced/public/search/index.ts b/x-pack/plugins/session_view/public/constants.ts similarity index 91% rename from x-pack/plugins/data_enhanced/public/search/index.ts rename to x-pack/plugins/session_view/public/constants.ts index 84e70f41d6746..2f7306bf3e4a8 100644 --- a/x-pack/plugins/data_enhanced/public/search/index.ts +++ b/x-pack/plugins/session_view/public/constants.ts @@ -5,4 +5,4 @@ * 2.0. */ -export * from './ui'; +export const DASH = '-'; diff --git a/x-pack/plugins/session_view/public/types.ts b/x-pack/plugins/session_view/public/types.ts index 8e5b9a7ed83f2..1f90ae05b0791 100644 --- a/x-pack/plugins/session_view/public/types.ts +++ b/x-pack/plugins/session_view/public/types.ts @@ -6,7 +6,6 @@ */ import { ReactNode } from 'react'; import { CoreStart } from '@kbn/core/public'; -import { Teletype } from '../common/types/process_tree'; export type SessionViewServices = CoreStart; @@ -43,14 +42,14 @@ export interface DetailPanelProcess { id: string; start: string; end: string; - exit_code?: number; + exitCode: string; userName: string; groupName: string; - args: string[]; + args: string; executable: string[][]; - working_directory: string; - tty?: Teletype; - pid?: number; + workingDirectory: string; + interactive: string; + pid: string; entryLeader: DetailPanelProcessLeader; sessionLeader: DetailPanelProcessLeader; groupLeader: DetailPanelProcessLeader; @@ -61,17 +60,34 @@ export interface DetailPanelProcessLeader { id: string; name: string; start: string; - end?: string; - exit_code?: number; + end: string; + exitCode: string; userName: string; groupName: string; - working_directory: string; - tty?: Teletype; - args: string[]; - pid?: number; + workingDirectory: string; + interactive: string; + args: string; + pid: string; entryMetaType: string; entryMetaSourceIp: string; - executable: string; + executable: string[][]; +} + +export interface DetailPanelHost { + architecture: string; + hostname: string; + id: string; + ip: string; + mac: string; + name: string; + os: { + family: string; + full: string; + kernel: string; + name: string; + platform: string; + version: string; + }; } export interface SessionViewStart { diff --git a/x-pack/plugins/session_view/public/utils/data_or_dash.test.ts b/x-pack/plugins/session_view/public/utils/data_or_dash.test.ts index 12ef44cf1d708..c4950bb8d20b0 100644 --- a/x-pack/plugins/session_view/public/utils/data_or_dash.test.ts +++ b/x-pack/plugins/session_view/public/utils/data_or_dash.test.ts @@ -5,11 +5,11 @@ * 2.0. */ +import { DASH } from '../constants'; import { dataOrDash } from './data_or_dash'; const TEST_STRING = '123'; const TEST_NUMBER = 123; -const DASH = '-'; describe('dataOrDash(data)', () => { it('works for a valid string', () => { diff --git a/x-pack/plugins/session_view/public/utils/data_or_dash.ts b/x-pack/plugins/session_view/public/utils/data_or_dash.ts index ff6c2fb9bc1ff..15c82b47220d2 100644 --- a/x-pack/plugins/session_view/public/utils/data_or_dash.ts +++ b/x-pack/plugins/session_view/public/utils/data_or_dash.ts @@ -5,6 +5,8 @@ * 2.0. */ +import { DASH } from '../constants'; + /** * Returns a dash ('-') if data is undefined, and empty string, or a NaN. * @@ -15,7 +17,7 @@ */ export const dataOrDash = (data: string | number | undefined): string | number => { if (data === undefined || data === '' || (typeof data === 'number' && isNaN(data))) { - return '-'; + return DASH; } return data; diff --git a/x-pack/plugins/synthetics/common/constants/index.ts b/x-pack/plugins/synthetics/common/constants/index.ts index c7649d73b8af3..b85cfb0a0d9b6 100644 --- a/x-pack/plugins/synthetics/common/constants/index.ts +++ b/x-pack/plugins/synthetics/common/constants/index.ts @@ -13,4 +13,3 @@ export * from './settings_defaults'; export { QUERY } from './query'; export * from './ui'; export * from './rest_api'; -export const DEFAULT_NAMESPACE_STRING = 'default'; diff --git a/x-pack/plugins/synthetics/common/constants/monitor_defaults.ts b/x-pack/plugins/synthetics/common/constants/monitor_defaults.ts new file mode 100644 index 0000000000000..e7f79fc2086a2 --- /dev/null +++ b/x-pack/plugins/synthetics/common/constants/monitor_defaults.ts @@ -0,0 +1,167 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ +import { + BrowserAdvancedFields, + BrowserSimpleFields, + CommonFields, + DataStream, + HTTPAdvancedFields, + HTTPMethod, + HTTPSimpleFields, + ICMPSimpleFields, + Mode, + MonitorDefaults, + ResponseBodyIndexPolicy, + ScheduleUnit, + ScreenshotOption, + TCPAdvancedFields, + TCPSimpleFields, + TLSFields, + TLSVersion, + VerificationMode, +} from '../runtime_types/monitor_management'; +import { ConfigKey } from './monitor_management'; + +export const DEFAULT_NAMESPACE_STRING = 'default'; + +export const DEFAULT_COMMON_FIELDS: CommonFields = { + [ConfigKey.MONITOR_TYPE]: DataStream.HTTP, + [ConfigKey.ENABLED]: true, + [ConfigKey.SCHEDULE]: { + number: '3', + unit: ScheduleUnit.MINUTES, + }, + [ConfigKey.APM_SERVICE_NAME]: '', + [ConfigKey.TAGS]: [], + [ConfigKey.TIMEOUT]: '16', + [ConfigKey.NAME]: '', + [ConfigKey.LOCATIONS]: [], + [ConfigKey.NAMESPACE]: DEFAULT_NAMESPACE_STRING, +}; + +export const DEFAULT_BROWSER_ADVANCED_FIELDS: BrowserAdvancedFields = { + [ConfigKey.SCREENSHOTS]: ScreenshotOption.ON, + [ConfigKey.SYNTHETICS_ARGS]: [], + [ConfigKey.JOURNEY_FILTERS_MATCH]: '', + [ConfigKey.JOURNEY_FILTERS_TAGS]: [], + [ConfigKey.IGNORE_HTTPS_ERRORS]: false, + [ConfigKey.IS_THROTTLING_ENABLED]: true, + [ConfigKey.DOWNLOAD_SPEED]: '5', + [ConfigKey.UPLOAD_SPEED]: '3', + [ConfigKey.LATENCY]: '20', + [ConfigKey.THROTTLING_CONFIG]: '5d/3u/20l', +}; + +export const DEFAULT_BROWSER_SIMPLE_FIELDS: BrowserSimpleFields = { + ...DEFAULT_COMMON_FIELDS, + [ConfigKey.SCHEDULE]: { + unit: ScheduleUnit.MINUTES, + number: '10', + }, + [ConfigKey.METADATA]: { + script_source: { + is_generated_script: false, + file_name: '', + }, + is_zip_url_tls_enabled: false, + }, + [ConfigKey.MONITOR_TYPE]: DataStream.BROWSER, + [ConfigKey.SOURCE_INLINE]: '', + [ConfigKey.SOURCE_ZIP_URL]: '', + [ConfigKey.SOURCE_ZIP_USERNAME]: '', + [ConfigKey.SOURCE_ZIP_PASSWORD]: '', + [ConfigKey.SOURCE_ZIP_FOLDER]: '', + [ConfigKey.SOURCE_ZIP_PROXY_URL]: '', + [ConfigKey.PARAMS]: '', + [ConfigKey.ZIP_URL_TLS_CERTIFICATE_AUTHORITIES]: undefined, + [ConfigKey.ZIP_URL_TLS_CERTIFICATE]: undefined, + [ConfigKey.ZIP_URL_TLS_KEY]: undefined, + [ConfigKey.ZIP_URL_TLS_KEY_PASSPHRASE]: undefined, + [ConfigKey.ZIP_URL_TLS_VERIFICATION_MODE]: undefined, + [ConfigKey.ZIP_URL_TLS_VERSION]: undefined, + [ConfigKey.URLS]: undefined, + [ConfigKey.PORT]: undefined, +}; + +export const DEFAULT_HTTP_SIMPLE_FIELDS: HTTPSimpleFields = { + ...DEFAULT_COMMON_FIELDS, + [ConfigKey.METADATA]: { + is_tls_enabled: false, + }, + [ConfigKey.URLS]: '', + [ConfigKey.MAX_REDIRECTS]: '0', + [ConfigKey.MONITOR_TYPE]: DataStream.HTTP, +}; + +export const DEFAULT_HTTP_ADVANCED_FIELDS: HTTPAdvancedFields = { + [ConfigKey.PASSWORD]: '', + [ConfigKey.PROXY_URL]: '', + [ConfigKey.RESPONSE_BODY_CHECK_NEGATIVE]: [], + [ConfigKey.RESPONSE_BODY_CHECK_POSITIVE]: [], + [ConfigKey.RESPONSE_BODY_INDEX]: ResponseBodyIndexPolicy.ON_ERROR, + [ConfigKey.RESPONSE_HEADERS_CHECK]: {}, + [ConfigKey.RESPONSE_HEADERS_INDEX]: true, + [ConfigKey.RESPONSE_STATUS_CHECK]: [], + [ConfigKey.REQUEST_BODY_CHECK]: { + value: '', + type: Mode.PLAINTEXT, + }, + [ConfigKey.REQUEST_HEADERS_CHECK]: {}, + [ConfigKey.REQUEST_METHOD_CHECK]: HTTPMethod.GET, + [ConfigKey.USERNAME]: '', +}; + +export const DEFAULT_ICMP_SIMPLE_FIELDS: ICMPSimpleFields = { + ...DEFAULT_COMMON_FIELDS, + [ConfigKey.HOSTS]: '', + [ConfigKey.MONITOR_TYPE]: DataStream.ICMP, + [ConfigKey.WAIT]: '1', +}; + +export const DEFAULT_TCP_SIMPLE_FIELDS: TCPSimpleFields = { + ...DEFAULT_COMMON_FIELDS, + [ConfigKey.METADATA]: { + is_tls_enabled: false, + }, + [ConfigKey.HOSTS]: '', + [ConfigKey.MONITOR_TYPE]: DataStream.TCP, +}; + +export const DEFAULT_TCP_ADVANCED_FIELDS: TCPAdvancedFields = { + [ConfigKey.PROXY_URL]: '', + [ConfigKey.PROXY_USE_LOCAL_RESOLVER]: false, + [ConfigKey.RESPONSE_RECEIVE_CHECK]: '', + [ConfigKey.REQUEST_SEND_CHECK]: '', +}; + +export const DEFAULT_TLS_FIELDS: TLSFields = { + [ConfigKey.TLS_CERTIFICATE_AUTHORITIES]: '', + [ConfigKey.TLS_CERTIFICATE]: '', + [ConfigKey.TLS_KEY]: '', + [ConfigKey.TLS_KEY_PASSPHRASE]: '', + [ConfigKey.TLS_VERIFICATION_MODE]: VerificationMode.FULL, + [ConfigKey.TLS_VERSION]: [TLSVersion.ONE_ONE, TLSVersion.ONE_TWO, TLSVersion.ONE_THREE], +}; + +export const DEFAULT_FIELDS: MonitorDefaults = { + [DataStream.HTTP]: { + ...DEFAULT_HTTP_SIMPLE_FIELDS, + ...DEFAULT_HTTP_ADVANCED_FIELDS, + ...DEFAULT_TLS_FIELDS, + }, + [DataStream.TCP]: { + ...DEFAULT_TCP_SIMPLE_FIELDS, + ...DEFAULT_TCP_ADVANCED_FIELDS, + ...DEFAULT_TLS_FIELDS, + }, + [DataStream.ICMP]: DEFAULT_ICMP_SIMPLE_FIELDS, + [DataStream.BROWSER]: { + ...DEFAULT_BROWSER_SIMPLE_FIELDS, + ...DEFAULT_BROWSER_ADVANCED_FIELDS, + ...DEFAULT_TLS_FIELDS, + }, +}; diff --git a/x-pack/plugins/synthetics/common/constants/plugin.ts b/x-pack/plugins/synthetics/common/constants/plugin.ts index 619e68b93109c..c0a6ed02477f5 100644 --- a/x-pack/plugins/synthetics/common/constants/plugin.ts +++ b/x-pack/plugins/synthetics/common/constants/plugin.ts @@ -21,4 +21,7 @@ export const PLUGIN = { TITLE: i18n.translate('xpack.synthetics.uptimeFeatureCatalogueTitle', { defaultMessage: 'Uptime', }), + SYNTHETICS: i18n.translate('xpack.synthetics.syntheticsFeatureCatalogueTitle', { + defaultMessage: 'Synthetics', + }), }; diff --git a/x-pack/plugins/synthetics/common/runtime_types/monitor_management/monitor_types.ts b/x-pack/plugins/synthetics/common/runtime_types/monitor_management/monitor_types.ts index c093705e858d8..0e96b8b9de6e2 100644 --- a/x-pack/plugins/synthetics/common/runtime_types/monitor_management/monitor_types.ts +++ b/x-pack/plugins/synthetics/common/runtime_types/monitor_management/monitor_types.ts @@ -10,6 +10,7 @@ import { secretKeys } from '../../constants/monitor_management'; import { ConfigKey } from './config_key'; import { MonitorServiceLocationsCodec, ServiceLocationErrors } from './locations'; import { + DataStream, DataStreamCodec, ModeCodec, ResponseBodyIndexPolicyCodec, @@ -308,6 +309,15 @@ export type EncryptedSyntheticsMonitorWithId = t.TypeOf< typeof EncryptedSyntheticsMonitorWithIdCodec >; +export const MonitorDefaultsCodec = t.interface({ + [DataStream.HTTP]: HTTPFieldsCodec, + [DataStream.TCP]: TCPFieldsCodec, + [DataStream.ICMP]: ICMPSimpleFieldsCodec, + [DataStream.BROWSER]: BrowserFieldsCodec, +}); + +export type MonitorDefaults = t.TypeOf; + export const MonitorManagementListResultCodec = t.type({ monitors: t.array( t.interface({ diff --git a/x-pack/plugins/synthetics/public/apps/synthetics/render_app.tsx b/x-pack/plugins/synthetics/public/apps/synthetics/render_app.tsx new file mode 100644 index 0000000000000..c4b05ea7a2e0c --- /dev/null +++ b/x-pack/plugins/synthetics/public/apps/synthetics/render_app.tsx @@ -0,0 +1,26 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React from 'react'; +import ReactDOM from 'react-dom'; +import { AppMountParameters, CoreStart } from '@kbn/core/public'; +import { ClientPluginsSetup, ClientPluginsStart } from '../../plugin'; +import { SyntheticsApp } from '../synthetics_app'; + +export function renderApp( + core: CoreStart, + plugins: ClientPluginsSetup, + startPlugins: ClientPluginsStart, + appMountParameters: AppMountParameters, + isDev: boolean +) { + ReactDOM.render(, appMountParameters.element); + + return () => { + ReactDOM.unmountComponentAtNode(appMountParameters.element); + }; +} diff --git a/x-pack/plugins/data_enhanced/public/search/sessions_mgmt/components/actions/index.tsx b/x-pack/plugins/synthetics/public/apps/synthetics_app.tsx similarity index 71% rename from x-pack/plugins/data_enhanced/public/search/sessions_mgmt/components/actions/index.tsx rename to x-pack/plugins/synthetics/public/apps/synthetics_app.tsx index cecd50125e90e..92531041157a7 100644 --- a/x-pack/plugins/data_enhanced/public/search/sessions_mgmt/components/actions/index.tsx +++ b/x-pack/plugins/synthetics/public/apps/synthetics_app.tsx @@ -4,6 +4,8 @@ * 2.0; you may not use this file except in compliance with the Elastic License * 2.0. */ +import React from 'react'; -export { PopoverActionsMenu } from './popover_actions'; -export * from './types'; +export const SyntheticsApp = () => { + return
Synthetics App
; +}; diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/common/default_values.ts b/x-pack/plugins/synthetics/public/components/fleet_package/common/default_values.ts deleted file mode 100644 index 54c6969833cf1..0000000000000 --- a/x-pack/plugins/synthetics/public/components/fleet_package/common/default_values.ts +++ /dev/null @@ -1,25 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import { DEFAULT_NAMESPACE_STRING } from '../../../../common/constants'; -import { CommonFields, ConfigKey, ScheduleUnit, DataStream } from '../types'; - -export const defaultValues: CommonFields = { - [ConfigKey.MONITOR_TYPE]: DataStream.HTTP, - [ConfigKey.LOCATIONS]: [], - [ConfigKey.ENABLED]: true, - [ConfigKey.SCHEDULE]: { - number: '3', - unit: ScheduleUnit.MINUTES, - }, - [ConfigKey.APM_SERVICE_NAME]: '', - [ConfigKey.TAGS]: [], - [ConfigKey.TIMEOUT]: '16', - [ConfigKey.NAME]: '', - [ConfigKey.LOCATIONS]: [], - [ConfigKey.NAMESPACE]: DEFAULT_NAMESPACE_STRING, -}; diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/tls/default_values.ts b/x-pack/plugins/synthetics/public/components/fleet_package/tls/default_values.ts deleted file mode 100644 index 18f291ce20f35..0000000000000 --- a/x-pack/plugins/synthetics/public/components/fleet_package/tls/default_values.ts +++ /dev/null @@ -1,17 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import { TLSFields, ConfigKey, VerificationMode, TLSVersion } from '../types'; - -export const defaultValues: TLSFields = { - [ConfigKey.TLS_CERTIFICATE_AUTHORITIES]: '', - [ConfigKey.TLS_CERTIFICATE]: '', - [ConfigKey.TLS_KEY]: '', - [ConfigKey.TLS_KEY_PASSPHRASE]: '', - [ConfigKey.TLS_VERIFICATION_MODE]: VerificationMode.FULL, - [ConfigKey.TLS_VERSION]: [TLSVersion.ONE_ONE, TLSVersion.ONE_TWO, TLSVersion.ONE_THREE], -}; diff --git a/x-pack/plugins/synthetics/public/icons/heartbeat_white.svg b/x-pack/plugins/synthetics/public/icons/heartbeat_white.svg deleted file mode 100644 index 866206f32f5a1..0000000000000 --- a/x-pack/plugins/synthetics/public/icons/heartbeat_white.svg +++ /dev/null @@ -1,11 +0,0 @@ - - - - \ No newline at end of file diff --git a/x-pack/plugins/synthetics/public/index.ts b/x-pack/plugins/synthetics/public/index.ts index 86170e9bc863a..cc0ad290e6f0a 100644 --- a/x-pack/plugins/synthetics/public/index.ts +++ b/x-pack/plugins/synthetics/public/index.ts @@ -6,7 +6,7 @@ */ import { PluginInitializerContext } from '@kbn/core/public'; -import { UptimePlugin } from './apps/plugin'; +import { UptimePlugin } from './plugin'; export const plugin = (initializerContext: PluginInitializerContext) => new UptimePlugin(initializerContext); diff --git a/x-pack/plugins/synthetics/public/apps/__snapshots__/uptime_page_template.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/app/__snapshots__/uptime_page_template.test.tsx.snap similarity index 100% rename from x-pack/plugins/synthetics/public/apps/__snapshots__/uptime_page_template.test.tsx.snap rename to x-pack/plugins/synthetics/public/legacy_uptime/app/__snapshots__/uptime_page_template.test.tsx.snap diff --git a/x-pack/plugins/synthetics/public/apps/render_app.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/app/render_app.tsx similarity index 95% rename from x-pack/plugins/synthetics/public/apps/render_app.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/app/render_app.tsx index 36ac093f23d0a..efb35813201ae 100644 --- a/x-pack/plugins/synthetics/public/apps/render_app.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/app/render_app.tsx @@ -14,9 +14,9 @@ import { DEFAULT_DARK_MODE, DEFAULT_TIMEPICKER_QUICK_RANGES, INTEGRATED_SOLUTIONS, -} from '../../common/constants'; +} from '../../../common/constants'; import { UptimeApp, UptimeAppProps } from './uptime_app'; -import { ClientPluginsSetup, ClientPluginsStart } from './plugin'; +import { ClientPluginsSetup, ClientPluginsStart } from '../../plugin'; export function renderApp( core: CoreStart, diff --git a/x-pack/plugins/synthetics/public/apps/uptime_app.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/app/uptime_app.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/apps/uptime_app.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/app/uptime_app.tsx index 9887fa81393bc..8d694bfe81aed 100644 --- a/x-pack/plugins/synthetics/public/apps/uptime_app.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/app/uptime_app.tsx @@ -18,7 +18,7 @@ import { } from '@kbn/kibana-react-plugin/public'; import { EuiThemeProvider } from '@kbn/kibana-react-plugin/common'; import { InspectorContextProvider } from '@kbn/observability-plugin/public'; -import { ClientPluginsSetup, ClientPluginsStart } from './plugin'; +import { ClientPluginsSetup, ClientPluginsStart } from '../../plugin'; import { UMUpdateBadge } from '../lib/lib'; import { UptimeRefreshContextProvider, diff --git a/x-pack/plugins/synthetics/public/apps/uptime_overview_fetcher.ts b/x-pack/plugins/synthetics/public/legacy_uptime/app/uptime_overview_fetcher.ts similarity index 100% rename from x-pack/plugins/synthetics/public/apps/uptime_overview_fetcher.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/app/uptime_overview_fetcher.ts diff --git a/x-pack/plugins/synthetics/public/apps/uptime_page_template.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/app/uptime_page_template.test.tsx similarity index 96% rename from x-pack/plugins/synthetics/public/apps/uptime_page_template.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/app/uptime_page_template.test.tsx index 26a40074c7530..38105052f352e 100644 --- a/x-pack/plugins/synthetics/public/apps/uptime_page_template.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/app/uptime_page_template.test.tsx @@ -10,7 +10,7 @@ import React from 'react'; import 'jest-styled-components'; import { render } from '../lib/helper/rtl_helpers'; import { UptimePageTemplateComponent } from './uptime_page_template'; -import { OVERVIEW_ROUTE } from '../../common/constants'; +import { OVERVIEW_ROUTE } from '../../../common/constants'; import { useBreakpoints } from '../hooks/use_breakpoints'; jest.mock('../hooks/use_breakpoints', () => { diff --git a/x-pack/plugins/synthetics/public/apps/uptime_page_template.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/app/uptime_page_template.tsx similarity index 95% rename from x-pack/plugins/synthetics/public/apps/uptime_page_template.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/app/uptime_page_template.tsx index e359916de1d22..08ebd5f06a69b 100644 --- a/x-pack/plugins/synthetics/public/apps/uptime_page_template.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/app/uptime_page_template.tsx @@ -10,8 +10,8 @@ import styled from 'styled-components'; import { EuiPageHeaderProps, EuiPageTemplateProps } from '@elastic/eui'; import { useKibana } from '@kbn/kibana-react-plugin/public'; import { useInspectorContext } from '@kbn/observability-plugin/public'; -import { CERTIFICATES_ROUTE, OVERVIEW_ROUTE } from '../../common/constants'; -import { ClientPluginsStart } from './plugin'; +import { CERTIFICATES_ROUTE, OVERVIEW_ROUTE } from '../../../common/constants'; +import { ClientPluginsStart } from '../../plugin'; import { useNoDataConfig } from './use_no_data_config'; import { EmptyStateLoading } from '../components/overview/empty_state/empty_state_loading'; import { EmptyStateError } from '../components/overview/empty_state/empty_state_error'; diff --git a/x-pack/plugins/synthetics/public/apps/use_no_data_config.ts b/x-pack/plugins/synthetics/public/legacy_uptime/app/use_no_data_config.ts similarity index 97% rename from x-pack/plugins/synthetics/public/apps/use_no_data_config.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/app/use_no_data_config.ts index 8898e42548748..c485c498e6fa7 100644 --- a/x-pack/plugins/synthetics/public/apps/use_no_data_config.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/app/use_no_data_config.ts @@ -10,7 +10,7 @@ import { useContext } from 'react'; import { useSelector } from 'react-redux'; import { KibanaPageTemplateProps, useKibana } from '@kbn/kibana-react-plugin/public'; import { UptimeSettingsContext } from '../contexts'; -import { ClientPluginsStart } from './plugin'; +import { ClientPluginsStart } from '../../plugin'; import { indexStatusSelector } from '../state/selectors'; export function useNoDataConfig(): KibanaPageTemplateProps['noDataConfig'] { diff --git a/x-pack/plugins/synthetics/public/components/certificates/__snapshots__/cert_monitors.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/__snapshots__/cert_monitors.test.tsx.snap similarity index 100% rename from x-pack/plugins/synthetics/public/components/certificates/__snapshots__/cert_monitors.test.tsx.snap rename to x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/__snapshots__/cert_monitors.test.tsx.snap diff --git a/x-pack/plugins/synthetics/public/components/certificates/__snapshots__/cert_search.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/__snapshots__/cert_search.test.tsx.snap similarity index 100% rename from x-pack/plugins/synthetics/public/components/certificates/__snapshots__/cert_search.test.tsx.snap rename to x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/__snapshots__/cert_search.test.tsx.snap diff --git a/x-pack/plugins/synthetics/public/components/certificates/__snapshots__/cert_status.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/__snapshots__/cert_status.test.tsx.snap similarity index 100% rename from x-pack/plugins/synthetics/public/components/certificates/__snapshots__/cert_status.test.tsx.snap rename to x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/__snapshots__/cert_status.test.tsx.snap diff --git a/x-pack/plugins/synthetics/public/components/certificates/cert_monitors.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/cert_monitors.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/certificates/cert_monitors.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/cert_monitors.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/certificates/cert_monitors.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/cert_monitors.tsx similarity index 93% rename from x-pack/plugins/synthetics/public/components/certificates/cert_monitors.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/cert_monitors.tsx index 30b8b572c783f..0688aae060fba 100644 --- a/x-pack/plugins/synthetics/public/components/certificates/cert_monitors.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/cert_monitors.tsx @@ -7,7 +7,7 @@ import React from 'react'; import { EuiToolTip } from '@elastic/eui'; -import { CertMonitor } from '../../../common/runtime_types'; +import { CertMonitor } from '../../../../common/runtime_types'; import { MonitorPageLink } from '../common/monitor_page_link'; interface Props { diff --git a/x-pack/plugins/synthetics/public/components/certificates/cert_refresh_btn.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/cert_refresh_btn.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/certificates/cert_refresh_btn.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/cert_refresh_btn.tsx diff --git a/x-pack/plugins/synthetics/public/components/certificates/cert_search.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/cert_search.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/certificates/cert_search.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/cert_search.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/certificates/cert_search.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/cert_search.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/certificates/cert_search.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/cert_search.tsx diff --git a/x-pack/plugins/synthetics/public/components/certificates/cert_status.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/cert_status.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/certificates/cert_status.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/cert_status.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/certificates/cert_status.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/cert_status.tsx similarity index 95% rename from x-pack/plugins/synthetics/public/components/certificates/cert_status.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/cert_status.tsx index 7ade37b33d622..ec11fc240d6a1 100644 --- a/x-pack/plugins/synthetics/public/components/certificates/cert_status.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/cert_status.tsx @@ -11,10 +11,10 @@ import styled from 'styled-components'; import { EuiHealth, EuiText } from '@elastic/eui'; import { FormattedMessage } from '@kbn/i18n-react'; import { useSelector } from 'react-redux'; -import { Cert } from '../../../common/runtime_types'; +import { Cert } from '../../../../common/runtime_types'; import { useCertStatus } from '../../hooks'; import * as labels from './translations'; -import { CERT_STATUS } from '../../../common/constants'; +import { CERT_STATUS } from '../../../../common/constants'; import { selectDynamicSettings } from '../../state/selectors'; interface Props { diff --git a/x-pack/plugins/synthetics/public/components/certificates/certificate_title.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/certificate_title.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/certificates/certificate_title.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/certificate_title.tsx diff --git a/x-pack/plugins/synthetics/public/components/certificates/certificates_list.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/certificates_list.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/certificates/certificates_list.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/certificates_list.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/certificates/certificates_list.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/certificates_list.tsx similarity index 97% rename from x-pack/plugins/synthetics/public/components/certificates/certificates_list.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/certificates_list.tsx index 44d314b52356f..381ee9cd5b792 100644 --- a/x-pack/plugins/synthetics/public/components/certificates/certificates_list.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/certificates_list.tsx @@ -11,7 +11,7 @@ import { Direction, EuiBasicTable } from '@elastic/eui'; import { CertStatus } from './cert_status'; import { CertMonitors } from './cert_monitors'; import * as labels from './translations'; -import { Cert, CertMonitor, CertResult } from '../../../common/runtime_types'; +import { Cert, CertMonitor, CertResult } from '../../../../common/runtime_types'; import { FingerprintCol } from './fingerprint_col'; import { LOADING_CERTIFICATES, NO_CERTS_AVAILABLE } from './translations'; diff --git a/x-pack/plugins/synthetics/public/components/certificates/fingerprint_col.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/fingerprint_col.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/certificates/fingerprint_col.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/fingerprint_col.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/certificates/fingerprint_col.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/fingerprint_col.tsx similarity index 96% rename from x-pack/plugins/synthetics/public/components/certificates/fingerprint_col.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/fingerprint_col.tsx index fa29c0b7d1e43..dac9f239eb104 100644 --- a/x-pack/plugins/synthetics/public/components/certificates/fingerprint_col.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/fingerprint_col.tsx @@ -8,7 +8,7 @@ import React from 'react'; import { EuiButtonEmpty, EuiButtonIcon, EuiCopy, EuiToolTip } from '@elastic/eui'; import styled from 'styled-components'; -import { Cert } from '../../../common/runtime_types'; +import { Cert } from '../../../../common/runtime_types'; import { COPY_FINGERPRINT } from './translations'; const EmptyButton = styled(EuiButtonEmpty)` diff --git a/x-pack/plugins/synthetics/public/components/certificates/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/index.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/certificates/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/index.ts diff --git a/x-pack/plugins/synthetics/public/components/certificates/translations.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/translations.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/certificates/translations.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/translations.ts diff --git a/x-pack/plugins/synthetics/public/components/certificates/use_cert_search.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/use_cert_search.ts similarity index 91% rename from x-pack/plugins/synthetics/public/components/certificates/use_cert_search.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/use_cert_search.ts index 47facebe4401f..4a13a7fc68d15 100644 --- a/x-pack/plugins/synthetics/public/components/certificates/use_cert_search.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/certificates/use_cert_search.ts @@ -9,7 +9,7 @@ import { useSelector } from 'react-redux'; import { useContext } from 'react'; import { createEsParams, useEsSearch } from '@kbn/observability-plugin/public'; -import { CertResult, GetCertsParams, Ping } from '../../../common/runtime_types'; +import { CertResult, GetCertsParams, Ping } from '../../../../common/runtime_types'; import { selectDynamicSettings } from '../../state/selectors'; import { @@ -20,7 +20,7 @@ import { DEFAULT_TO, getCertsRequestBody, processCertsResult, -} from '../../../common/requests/get_certs_request_body'; +} from '../../../../common/requests/get_certs_request_body'; import { UptimeRefreshContext } from '../../contexts'; export const useCertSearch = ({ diff --git a/x-pack/plugins/synthetics/public/components/common/__snapshots__/location_link.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/__snapshots__/location_link.test.tsx.snap similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/__snapshots__/location_link.test.tsx.snap rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/__snapshots__/location_link.test.tsx.snap diff --git a/x-pack/plugins/synthetics/public/components/common/__snapshots__/monitor_page_link.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/__snapshots__/monitor_page_link.test.tsx.snap similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/__snapshots__/monitor_page_link.test.tsx.snap rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/__snapshots__/monitor_page_link.test.tsx.snap diff --git a/x-pack/plugins/synthetics/public/components/common/__snapshots__/monitor_tags.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/__snapshots__/monitor_tags.test.tsx.snap similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/__snapshots__/monitor_tags.test.tsx.snap rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/__snapshots__/monitor_tags.test.tsx.snap diff --git a/x-pack/plugins/synthetics/public/components/common/alerts/uptime_edit_alert_flyout.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/alerts/uptime_edit_alert_flyout.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/alerts/uptime_edit_alert_flyout.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/alerts/uptime_edit_alert_flyout.tsx diff --git a/x-pack/plugins/synthetics/public/components/common/charts/__snapshots__/chart_empty_state.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/__snapshots__/chart_empty_state.test.tsx.snap similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/charts/__snapshots__/chart_empty_state.test.tsx.snap rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/__snapshots__/chart_empty_state.test.tsx.snap diff --git a/x-pack/plugins/synthetics/public/components/common/charts/__snapshots__/chart_wrapper.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/__snapshots__/chart_wrapper.test.tsx.snap similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/charts/__snapshots__/chart_wrapper.test.tsx.snap rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/__snapshots__/chart_wrapper.test.tsx.snap diff --git a/x-pack/plugins/synthetics/public/components/common/charts/__snapshots__/donut_chart.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/__snapshots__/donut_chart.test.tsx.snap similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/charts/__snapshots__/donut_chart.test.tsx.snap rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/__snapshots__/donut_chart.test.tsx.snap diff --git a/x-pack/plugins/synthetics/public/components/common/charts/__snapshots__/donut_chart_legend_row.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/__snapshots__/donut_chart_legend_row.test.tsx.snap similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/charts/__snapshots__/donut_chart_legend_row.test.tsx.snap rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/__snapshots__/donut_chart_legend_row.test.tsx.snap diff --git a/x-pack/plugins/synthetics/public/components/common/charts/__snapshots__/monitor_bar_series.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/__snapshots__/monitor_bar_series.test.tsx.snap similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/charts/__snapshots__/monitor_bar_series.test.tsx.snap rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/__snapshots__/monitor_bar_series.test.tsx.snap diff --git a/x-pack/plugins/synthetics/public/components/common/charts/annotation_tooltip.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/annotation_tooltip.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/charts/annotation_tooltip.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/annotation_tooltip.tsx diff --git a/x-pack/plugins/synthetics/public/components/common/charts/chart_empty_state.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/chart_empty_state.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/charts/chart_empty_state.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/chart_empty_state.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/common/charts/chart_empty_state.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/chart_empty_state.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/charts/chart_empty_state.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/chart_empty_state.tsx diff --git a/x-pack/plugins/synthetics/public/components/common/charts/chart_wrapper.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/chart_wrapper.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/charts/chart_wrapper.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/chart_wrapper.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/common/charts/chart_wrapper/chart_wrapper.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/chart_wrapper/chart_wrapper.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/charts/chart_wrapper/chart_wrapper.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/chart_wrapper/chart_wrapper.tsx diff --git a/x-pack/plugins/synthetics/public/components/common/charts/chart_wrapper/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/chart_wrapper/index.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/charts/chart_wrapper/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/chart_wrapper/index.ts diff --git a/x-pack/plugins/synthetics/public/components/common/charts/donut_chart.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/donut_chart.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/charts/donut_chart.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/donut_chart.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/common/charts/donut_chart.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/donut_chart.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/charts/donut_chart.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/donut_chart.tsx diff --git a/x-pack/plugins/synthetics/public/components/common/charts/donut_chart_legend.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/donut_chart_legend.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/charts/donut_chart_legend.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/donut_chart_legend.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/common/charts/donut_chart_legend.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/donut_chart_legend.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/charts/donut_chart_legend.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/donut_chart_legend.tsx diff --git a/x-pack/plugins/synthetics/public/components/common/charts/donut_chart_legend_row.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/donut_chart_legend_row.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/charts/donut_chart_legend_row.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/donut_chart_legend_row.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/common/charts/donut_chart_legend_row.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/donut_chart_legend_row.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/charts/donut_chart_legend_row.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/donut_chart_legend_row.tsx diff --git a/x-pack/plugins/synthetics/public/components/common/charts/duration_chart.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/duration_chart.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/common/charts/duration_chart.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/duration_chart.tsx index 2d82fbf1368b8..eb591fd538d98 100644 --- a/x-pack/plugins/synthetics/public/components/common/charts/duration_chart.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/duration_chart.tsx @@ -20,7 +20,7 @@ import { } from '@elastic/charts'; import { useSelector } from 'react-redux'; import { getChartDateLabel } from '../../../lib/helper'; -import { LocationDurationLine } from '../../../../common/types'; +import { LocationDurationLine } from '../../../../../common/types'; import { DurationLineSeriesList } from './duration_line_series_list'; import { ChartWrapper } from './chart_wrapper'; import { useUrlParams } from '../../../hooks'; diff --git a/x-pack/plugins/synthetics/public/components/common/charts/duration_charts.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/duration_charts.test.tsx similarity index 97% rename from x-pack/plugins/synthetics/public/components/common/charts/duration_charts.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/duration_charts.test.tsx index fee4143df11f9..fc24e723528c9 100644 --- a/x-pack/plugins/synthetics/public/components/common/charts/duration_charts.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/duration_charts.test.tsx @@ -8,7 +8,7 @@ import React from 'react'; import DateMath from '@kbn/datemath'; import { DurationChartComponent } from './duration_chart'; -import { MonitorDurationResult } from '../../../../common/types'; +import { MonitorDurationResult } from '../../../../../common/types'; import { render } from '../../../lib/helper/rtl_helpers'; describe('MonitorCharts component', () => { diff --git a/x-pack/plugins/synthetics/public/components/common/charts/duration_line_bar_list.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/duration_line_bar_list.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/charts/duration_line_bar_list.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/duration_line_bar_list.tsx diff --git a/x-pack/plugins/synthetics/public/components/common/charts/duration_line_series_list.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/duration_line_series_list.tsx similarity index 95% rename from x-pack/plugins/synthetics/public/components/common/charts/duration_line_series_list.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/duration_line_series_list.tsx index bc744be163223..3f8c2abb9fc2c 100644 --- a/x-pack/plugins/synthetics/public/components/common/charts/duration_line_series_list.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/duration_line_series_list.tsx @@ -7,7 +7,7 @@ import React from 'react'; import { LineSeries, CurveType, Fit, ScaleType } from '@elastic/charts'; -import { LocationDurationLine } from '../../../../common/types'; +import { LocationDurationLine } from '../../../../../common/types'; import { microToMilli, microToSec } from '../../../lib/formatting'; import { MS_LABEL, SEC_LABEL } from '../translations'; diff --git a/x-pack/plugins/synthetics/public/components/common/charts/get_tick_format.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/get_tick_format.test.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/charts/get_tick_format.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/get_tick_format.test.ts diff --git a/x-pack/plugins/synthetics/public/components/common/charts/get_tick_format.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/get_tick_format.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/charts/get_tick_format.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/get_tick_format.ts diff --git a/x-pack/plugins/synthetics/public/components/common/charts/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/index.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/charts/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/index.ts diff --git a/x-pack/plugins/synthetics/public/components/common/charts/monitor_bar_series.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/monitor_bar_series.test.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/common/charts/monitor_bar_series.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/monitor_bar_series.test.tsx index 792b357b3baba..e8a2afbd8af23 100644 --- a/x-pack/plugins/synthetics/public/components/common/charts/monitor_bar_series.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/monitor_bar_series.test.tsx @@ -8,7 +8,7 @@ import React from 'react'; import { MonitorBarSeries, MonitorBarSeriesProps } from './monitor_bar_series'; import { renderWithRouter, shallowWithRouter, MountWithReduxProvider } from '../../../lib'; -import { HistogramPoint } from '../../../../common/runtime_types'; +import { HistogramPoint } from '../../../../../common/runtime_types'; describe('MonitorBarSeries component', () => { let props: MonitorBarSeriesProps; diff --git a/x-pack/plugins/synthetics/public/components/common/charts/monitor_bar_series.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/monitor_bar_series.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/common/charts/monitor_bar_series.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/monitor_bar_series.tsx index 6bb52a025154f..35b2b830d91bd 100644 --- a/x-pack/plugins/synthetics/public/components/common/charts/monitor_bar_series.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/monitor_bar_series.tsx @@ -22,7 +22,7 @@ import React, { useContext } from 'react'; import moment from 'moment'; import { FormattedMessage } from '@kbn/i18n-react'; import { EuiText, EuiToolTip } from '@elastic/eui'; -import { HistogramPoint } from '../../../../common/runtime_types'; +import { HistogramPoint } from '../../../../../common/runtime_types'; import { getChartDateLabel, seriesHasDownValues } from '../../../lib/helper'; import { useUrlParams } from '../../../hooks'; import { UptimeThemeContext } from '../../../contexts'; diff --git a/x-pack/plugins/synthetics/public/components/common/charts/ping_histogram.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/ping_histogram.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/charts/ping_histogram.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/ping_histogram.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/common/charts/ping_histogram.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/ping_histogram.tsx similarity index 99% rename from x-pack/plugins/synthetics/public/components/common/charts/ping_histogram.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/ping_histogram.tsx index 95b5791bced8a..c3f9f5086ec9b 100644 --- a/x-pack/plugins/synthetics/public/components/common/charts/ping_histogram.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/ping_histogram.tsx @@ -28,7 +28,7 @@ import { createExploratoryViewUrl } from '@kbn/observability-plugin/public'; import { getChartDateLabel } from '../../../lib/helper'; import { ChartWrapper } from './chart_wrapper'; import { UptimeThemeContext } from '../../../contexts'; -import { HistogramResult } from '../../../../common/runtime_types'; +import { HistogramResult } from '../../../../../common/runtime_types'; import { useMonitorId, useUrlParams } from '../../../hooks'; import { ChartEmptyState } from './chart_empty_state'; import { getDateRangeFromChartElement } from './utils'; diff --git a/x-pack/plugins/synthetics/public/components/common/charts/utils.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/utils.test.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/charts/utils.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/utils.test.ts diff --git a/x-pack/plugins/synthetics/public/components/common/charts/utils.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/utils.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/charts/utils.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/charts/utils.ts diff --git a/x-pack/plugins/synthetics/public/components/common/header/action_menu.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/header/action_menu.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/header/action_menu.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/header/action_menu.tsx diff --git a/x-pack/plugins/synthetics/public/components/common/header/action_menu_content.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/header/action_menu_content.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/header/action_menu_content.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/header/action_menu_content.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/common/header/action_menu_content.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/header/action_menu_content.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/common/header/action_menu_content.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/header/action_menu_content.tsx index 311c76c87a845..1fb150bd9e70e 100644 --- a/x-pack/plugins/synthetics/public/components/common/header/action_menu_content.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/header/action_menu_content.tsx @@ -16,7 +16,7 @@ import { useKibana } from '@kbn/kibana-react-plugin/public'; import { useUptimeSettingsContext } from '../../../contexts/uptime_settings_context'; import { useGetUrlParams } from '../../../hooks'; import { ToggleAlertFlyoutButton } from '../../overview/alerts/alerts_containers'; -import { MONITOR_ROUTE, SETTINGS_ROUTE } from '../../../../common/constants'; +import { MONITOR_ROUTE, SETTINGS_ROUTE } from '../../../../../common/constants'; import { stringifyUrlParams } from '../../../lib/helper/stringify_url_params'; import { InspectorHeaderLink } from './inspector_header_link'; import { monitorStatusSelector } from '../../../state/selectors'; diff --git a/x-pack/plugins/synthetics/public/components/common/header/inspector_header_link.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/header/inspector_header_link.tsx similarity index 95% rename from x-pack/plugins/synthetics/public/components/common/header/inspector_header_link.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/header/inspector_header_link.tsx index aa3e53be500cd..a7c8c3790a50c 100644 --- a/x-pack/plugins/synthetics/public/components/common/header/inspector_header_link.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/header/inspector_header_link.tsx @@ -10,7 +10,7 @@ import { i18n } from '@kbn/i18n'; import React from 'react'; import { useKibana } from '@kbn/kibana-react-plugin/public'; import { enableInspectEsQueries, useInspectorContext } from '@kbn/observability-plugin/public'; -import { ClientPluginsStart } from '../../../apps/plugin'; +import { ClientPluginsStart } from '../../../../plugin'; import { useUptimeSettingsContext } from '../../../contexts/uptime_settings_context'; export function InspectorHeaderLink() { diff --git a/x-pack/plugins/synthetics/public/components/common/header/manage_monitors_btn.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/header/manage_monitors_btn.tsx similarity index 95% rename from x-pack/plugins/synthetics/public/components/common/header/manage_monitors_btn.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/header/manage_monitors_btn.tsx index 0e7215c0f5a03..2d0ac2654b71f 100644 --- a/x-pack/plugins/synthetics/public/components/common/header/manage_monitors_btn.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/header/manage_monitors_btn.tsx @@ -13,9 +13,9 @@ import { useHistory } from 'react-router-dom'; import useLocalStorage from 'react-use/lib/useLocalStorage'; import { useKibana } from '@kbn/kibana-react-plugin/public'; -import { MONITOR_MANAGEMENT_ROUTE } from '../../../../common/constants'; +import { MONITOR_MANAGEMENT_ROUTE } from '../../../../../common/constants'; import { PUBLIC_BETA_DESCRIPTION } from '../../../pages/monitor_management/service_allowed_wrapper'; -import { ClientPluginsSetup } from '../../../apps/plugin'; +import { ClientPluginsSetup } from '../../../../plugin'; import { useUptimeSettingsContext } from '../../../contexts/uptime_settings_context'; export const ManageMonitorsBtn = () => { diff --git a/x-pack/plugins/synthetics/public/components/common/header/page_tabs.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/header/page_tabs.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/header/page_tabs.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/header/page_tabs.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/common/header/page_tabs.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/header/page_tabs.tsx similarity index 99% rename from x-pack/plugins/synthetics/public/components/common/header/page_tabs.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/header/page_tabs.tsx index 1210dbb0f2290..9711a9d7acb9e 100644 --- a/x-pack/plugins/synthetics/public/components/common/header/page_tabs.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/header/page_tabs.tsx @@ -10,7 +10,7 @@ import React, { useEffect, useState } from 'react'; import { EuiTabs, EuiTab } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; import { useHistory, useRouteMatch } from 'react-router-dom'; -import { CERTIFICATES_ROUTE, OVERVIEW_ROUTE } from '../../../../common/constants'; +import { CERTIFICATES_ROUTE, OVERVIEW_ROUTE } from '../../../../../common/constants'; import { useGetUrlParams } from '../../../hooks'; import { stringifyUrlParams } from '../../../lib/helper/stringify_url_params'; diff --git a/x-pack/plugins/synthetics/public/components/common/higher_order/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/higher_order/index.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/higher_order/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/higher_order/index.ts diff --git a/x-pack/plugins/synthetics/public/components/common/higher_order/responsive_wrapper.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/higher_order/responsive_wrapper.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/higher_order/responsive_wrapper.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/higher_order/responsive_wrapper.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/common/higher_order/responsive_wrapper.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/higher_order/responsive_wrapper.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/higher_order/responsive_wrapper.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/higher_order/responsive_wrapper.tsx diff --git a/x-pack/plugins/synthetics/public/components/common/location_link.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/location_link.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/location_link.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/location_link.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/common/location_link.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/location_link.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/location_link.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/location_link.tsx diff --git a/x-pack/plugins/synthetics/public/components/common/monitor_page_link.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/monitor_page_link.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/monitor_page_link.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/monitor_page_link.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/common/monitor_page_link.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/monitor_page_link.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/monitor_page_link.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/monitor_page_link.tsx diff --git a/x-pack/plugins/synthetics/public/components/common/monitor_tags.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/monitor_tags.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/monitor_tags.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/monitor_tags.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/common/monitor_tags.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/monitor_tags.tsx similarity index 94% rename from x-pack/plugins/synthetics/public/components/common/monitor_tags.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/monitor_tags.tsx index e8e8a61e7b303..14e185e3e9318 100644 --- a/x-pack/plugins/synthetics/public/components/common/monitor_tags.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/monitor_tags.tsx @@ -10,13 +10,13 @@ import { EuiBadge, EuiBadgeGroup, EuiLink } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; import { useHistory } from 'react-router-dom'; import { useKibana } from '@kbn/kibana-react-plugin/public'; -import { Ping } from '../../../common/runtime_types/ping'; -import { MonitorSummary } from '../../../common/runtime_types/monitor'; +import { Ping } from '../../../../common/runtime_types/ping'; +import { MonitorSummary } from '../../../../common/runtime_types/monitor'; import { useFilterUpdate } from '../../hooks/use_filter_update'; import { useGetUrlParams } from '../../hooks'; import { parseCurrentFilters } from '../overview/monitor_list/columns/monitor_name_col'; import { EXPAND_TAGS_LABEL } from '../overview/monitor_list/columns/translations'; -import { OVERVIEW_ROUTE } from '../../../common/constants'; +import { OVERVIEW_ROUTE } from '../../../../common/constants'; interface Props { ping?: Ping | null; diff --git a/x-pack/plugins/synthetics/public/components/common/react_router_helpers/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/react_router_helpers/index.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/react_router_helpers/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/react_router_helpers/index.ts diff --git a/x-pack/plugins/synthetics/public/components/common/react_router_helpers/link_events.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/react_router_helpers/link_events.test.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/react_router_helpers/link_events.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/react_router_helpers/link_events.test.ts diff --git a/x-pack/plugins/synthetics/public/components/common/react_router_helpers/link_events.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/react_router_helpers/link_events.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/react_router_helpers/link_events.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/react_router_helpers/link_events.ts diff --git a/x-pack/plugins/synthetics/public/components/common/react_router_helpers/link_for_eui.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/react_router_helpers/link_for_eui.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/react_router_helpers/link_for_eui.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/react_router_helpers/link_for_eui.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/common/react_router_helpers/link_for_eui.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/react_router_helpers/link_for_eui.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/react_router_helpers/link_for_eui.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/react_router_helpers/link_for_eui.tsx diff --git a/x-pack/plugins/synthetics/public/components/common/step_detail_link.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/step_detail_link.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/step_detail_link.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/step_detail_link.tsx diff --git a/x-pack/plugins/synthetics/public/components/common/translations.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/translations.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/translations.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/translations.ts diff --git a/x-pack/plugins/synthetics/public/components/common/uptime_date_picker.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/uptime_date_picker.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/common/uptime_date_picker.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/uptime_date_picker.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/common/uptime_date_picker.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/uptime_date_picker.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/common/uptime_date_picker.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/common/uptime_date_picker.tsx index f509f9b53114b..ff01b9cb352ee 100644 --- a/x-pack/plugins/synthetics/public/components/common/uptime_date_picker.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/common/uptime_date_picker.tsx @@ -8,7 +8,7 @@ import React, { useContext, useEffect } from 'react'; import { EuiSuperDatePicker } from '@elastic/eui'; import { useUrlParams } from '../../hooks'; -import { CLIENT_DEFAULTS } from '../../../common/constants'; +import { CLIENT_DEFAULTS } from '../../../../common/constants'; import { UptimeRefreshContext, UptimeSettingsContext, diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/browser/advanced_fields.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/browser/advanced_fields.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/browser/advanced_fields.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/browser/advanced_fields.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/browser/advanced_fields.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/browser/advanced_fields.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/browser/advanced_fields.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/browser/advanced_fields.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/browser/formatters.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/browser/formatters.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/browser/formatters.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/browser/formatters.ts diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/browser/normalizers.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/browser/normalizers.test.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/browser/normalizers.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/browser/normalizers.test.ts diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/browser/normalizers.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/browser/normalizers.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/browser/normalizers.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/browser/normalizers.ts diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/browser/script_recorder_fields.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/browser/script_recorder_fields.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/browser/script_recorder_fields.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/browser/script_recorder_fields.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/browser/script_recorder_fields.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/browser/script_recorder_fields.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/browser/script_recorder_fields.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/browser/script_recorder_fields.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/browser/simple_fields.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/browser/simple_fields.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/browser/simple_fields.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/browser/simple_fields.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/browser/source_field.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/browser/source_field.test.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/fleet_package/browser/source_field.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/browser/source_field.test.tsx index ae5db0662dd85..97001df29a69e 100644 --- a/x-pack/plugins/synthetics/public/components/fleet_package/browser/source_field.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/browser/source_field.test.tsx @@ -8,7 +8,7 @@ import 'jest-canvas-mock'; import React from 'react'; import { fireEvent, screen, waitFor } from '@testing-library/react'; -import { ConfigKey } from '../../../../common/runtime_types'; +import { ConfigKey } from '../../../../../common/runtime_types'; import { render } from '../../../lib/helper/rtl_helpers'; import { IPolicyConfigContextProvider } from '../contexts/policy_config_context'; import { SourceField, defaultValues } from './source_field'; diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/browser/source_field.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/browser/source_field.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/browser/source_field.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/browser/source_field.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/browser/throttling_fields.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/browser/throttling_fields.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/browser/throttling_fields.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/browser/throttling_fields.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/browser/throttling_fields.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/browser/throttling_fields.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/browser/throttling_fields.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/browser/throttling_fields.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/browser/uploader.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/browser/uploader.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/browser/uploader.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/browser/uploader.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/browser/zip_url_tls_fields.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/browser/zip_url_tls_fields.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/browser/zip_url_tls_fields.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/browser/zip_url_tls_fields.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/browser/zip_url_tls_fields.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/browser/zip_url_tls_fields.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/browser/zip_url_tls_fields.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/browser/zip_url_tls_fields.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/code_editor.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/code_editor.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/code_editor.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/code_editor.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/combo_box.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/combo_box.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/combo_box.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/combo_box.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/combo_box.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/combo_box.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/combo_box.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/combo_box.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/common/common_fields.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/common/common_fields.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/common/common_fields.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/common/common_fields.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/common/described_form_group_with_wrap.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/common/described_form_group_with_wrap.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/common/described_form_group_with_wrap.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/common/described_form_group_with_wrap.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/common/enabled.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/common/enabled.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/common/enabled.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/common/enabled.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/common/formatters.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/common/formatters.test.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/common/formatters.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/common/formatters.test.ts diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/common/formatters.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/common/formatters.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/common/formatters.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/common/formatters.ts diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/common/normalizers.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/common/normalizers.test.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/common/normalizers.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/common/normalizers.test.ts diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/common/normalizers.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/common/normalizers.ts similarity index 88% rename from x-pack/plugins/synthetics/public/components/fleet_package/common/normalizers.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/common/normalizers.ts index 8f1b7ad230d9c..0119b415faed8 100644 --- a/x-pack/plugins/synthetics/public/components/fleet_package/common/normalizers.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/common/normalizers.ts @@ -7,9 +7,11 @@ import { NewPackagePolicyInput } from '@kbn/fleet-plugin/common'; import { CommonFields, ConfigKey, DataStream } from '../types'; -import { defaultValues as commonDefaultValues } from './default_values'; -import { DEFAULT_NAMESPACE_STRING } from '../../../../common/constants'; -import { defaultConfig } from '../contexts'; +import { + DEFAULT_COMMON_FIELDS, + DEFAULT_NAMESPACE_STRING, + DEFAULT_FIELDS, +} from '../../../../../common/constants/monitor_defaults'; // TO DO: create a standard input format that all fields resolve to export type Normalizer = (fields: NewPackagePolicyInput['vars']) => unknown; @@ -46,15 +48,15 @@ export function getCronNormalizer(key: string, defaultValues: Fields): N } export const getCommonNormalizer = (key: ConfigKey) => { - return getNormalizer(key, commonDefaultValues); + return getNormalizer(key, DEFAULT_COMMON_FIELDS); }; export const getCommonjsonToJavascriptNormalizer = (key: ConfigKey) => { - return getJsonToJavascriptNormalizer(key, commonDefaultValues); + return getJsonToJavascriptNormalizer(key, DEFAULT_COMMON_FIELDS); }; export const getCommonCronToSecondsNormalizer = (key: ConfigKey) => { - return getCronNormalizer(key, commonDefaultValues); + return getCronNormalizer(key, DEFAULT_COMMON_FIELDS); }; export const commonNormalizers: CommonNormalizerMap = { @@ -76,7 +78,7 @@ export const commonNormalizers: CommonNormalizerMap = { number, }; } else { - return defaultConfig[type][ConfigKey.SCHEDULE]; + return DEFAULT_FIELDS[type][ConfigKey.SCHEDULE]; } }, [ConfigKey.APM_SERVICE_NAME]: getCommonNormalizer(ConfigKey.APM_SERVICE_NAME), diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/common/simple_fields_wrapper.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/common/simple_fields_wrapper.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/common/simple_fields_wrapper.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/common/simple_fields_wrapper.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/common/tls_options.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/common/tls_options.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/common/tls_options.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/common/tls_options.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/contexts/browser_context.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/browser_context.tsx similarity index 57% rename from x-pack/plugins/synthetics/public/components/fleet_package/contexts/browser_context.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/browser_context.tsx index f7b67488e4bcc..e89e4dcd1d5bd 100644 --- a/x-pack/plugins/synthetics/public/components/fleet_package/contexts/browser_context.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/browser_context.tsx @@ -6,8 +6,8 @@ */ import React, { createContext, useContext, useMemo, useState } from 'react'; -import { BrowserSimpleFields, ConfigKey, DataStream, ScheduleUnit } from '../types'; -import { defaultValues as commonDefaultValues } from '../common/default_values'; +import { BrowserSimpleFields } from '../types'; +import { DEFAULT_BROWSER_SIMPLE_FIELDS } from '../../../../../common/constants/monitor_defaults'; interface BrowserSimpleFieldsContext { setFields: React.Dispatch>; @@ -20,36 +20,7 @@ interface BrowserSimpleFieldsContextProvider { defaultValues?: BrowserSimpleFields; } -export const initialValues: BrowserSimpleFields = { - ...commonDefaultValues, - [ConfigKey.SCHEDULE]: { - unit: ScheduleUnit.MINUTES, - number: '10', - }, - [ConfigKey.METADATA]: { - script_source: { - is_generated_script: false, - file_name: '', - }, - is_zip_url_tls_enabled: false, - }, - [ConfigKey.MONITOR_TYPE]: DataStream.BROWSER, - [ConfigKey.SOURCE_ZIP_URL]: '', - [ConfigKey.SOURCE_ZIP_USERNAME]: '', - [ConfigKey.SOURCE_ZIP_PASSWORD]: '', - [ConfigKey.SOURCE_ZIP_FOLDER]: '', - [ConfigKey.SOURCE_ZIP_PROXY_URL]: '', - [ConfigKey.SOURCE_INLINE]: '', - [ConfigKey.PARAMS]: '', - [ConfigKey.ZIP_URL_TLS_CERTIFICATE_AUTHORITIES]: undefined, - [ConfigKey.ZIP_URL_TLS_CERTIFICATE]: undefined, - [ConfigKey.ZIP_URL_TLS_KEY]: undefined, - [ConfigKey.ZIP_URL_TLS_KEY_PASSPHRASE]: undefined, - [ConfigKey.ZIP_URL_TLS_VERIFICATION_MODE]: undefined, - [ConfigKey.ZIP_URL_TLS_VERSION]: undefined, - [ConfigKey.URLS]: undefined, - [ConfigKey.PORT]: undefined, -}; +export const initialValues: BrowserSimpleFields = DEFAULT_BROWSER_SIMPLE_FIELDS; const defaultContext: BrowserSimpleFieldsContext = { setFields: (_fields: React.SetStateAction) => { diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/contexts/browser_context_advanced.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/browser_context_advanced.tsx similarity index 75% rename from x-pack/plugins/synthetics/public/components/fleet_package/contexts/browser_context_advanced.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/browser_context_advanced.tsx index 3ddd7953a6310..d81e1dc631ee2 100644 --- a/x-pack/plugins/synthetics/public/components/fleet_package/contexts/browser_context_advanced.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/browser_context_advanced.tsx @@ -6,7 +6,8 @@ */ import React, { createContext, useContext, useMemo, useState } from 'react'; -import { BrowserAdvancedFields, ConfigKey, ScreenshotOption } from '../types'; +import { BrowserAdvancedFields } from '../types'; +import { DEFAULT_BROWSER_ADVANCED_FIELDS } from '../../../../../common/constants/monitor_defaults'; interface BrowserAdvancedFieldsContext { setFields: React.Dispatch>; @@ -19,18 +20,7 @@ interface BrowserAdvancedFieldsContextProvider { defaultValues?: BrowserAdvancedFields; } -export const initialValues: BrowserAdvancedFields = { - [ConfigKey.SCREENSHOTS]: ScreenshotOption.ON, - [ConfigKey.SYNTHETICS_ARGS]: [], - [ConfigKey.JOURNEY_FILTERS_MATCH]: '', - [ConfigKey.JOURNEY_FILTERS_TAGS]: [], - [ConfigKey.IGNORE_HTTPS_ERRORS]: false, - [ConfigKey.IS_THROTTLING_ENABLED]: true, - [ConfigKey.DOWNLOAD_SPEED]: '5', - [ConfigKey.UPLOAD_SPEED]: '3', - [ConfigKey.LATENCY]: '20', - [ConfigKey.THROTTLING_CONFIG]: '5d/3u/20l', -}; +export const initialValues: BrowserAdvancedFields = DEFAULT_BROWSER_ADVANCED_FIELDS; const defaultContext: BrowserAdvancedFieldsContext = { setFields: (_fields: React.SetStateAction) => { diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/contexts/browser_provider.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/browser_provider.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/contexts/browser_provider.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/browser_provider.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/contexts/http_context.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/http_context.tsx similarity index 79% rename from x-pack/plugins/synthetics/public/components/fleet_package/contexts/http_context.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/http_context.tsx index a4a0c7bb16aa8..d45dfc01f0de6 100644 --- a/x-pack/plugins/synthetics/public/components/fleet_package/contexts/http_context.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/http_context.tsx @@ -6,8 +6,8 @@ */ import React, { createContext, useContext, useMemo, useState } from 'react'; -import { HTTPSimpleFields, ConfigKey, DataStream } from '../types'; -import { defaultValues as commonDefaultValues } from '../common/default_values'; +import { HTTPSimpleFields } from '../types'; +import { DEFAULT_HTTP_SIMPLE_FIELDS } from '../../../../../common/constants/monitor_defaults'; interface HTTPSimpleFieldsContext { setFields: React.Dispatch>; @@ -20,15 +20,7 @@ interface HTTPSimpleFieldsContextProvider { defaultValues?: HTTPSimpleFields; } -export const initialValues: HTTPSimpleFields = { - ...commonDefaultValues, - [ConfigKey.METADATA]: { - is_tls_enabled: false, - }, - [ConfigKey.URLS]: '', - [ConfigKey.MAX_REDIRECTS]: '0', - [ConfigKey.MONITOR_TYPE]: DataStream.HTTP, -}; +export const initialValues: HTTPSimpleFields = DEFAULT_HTTP_SIMPLE_FIELDS; const defaultContext: HTTPSimpleFieldsContext = { setFields: (_fields: React.SetStateAction) => { diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/contexts/http_context_advanced.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/http_context_advanced.tsx similarity index 67% rename from x-pack/plugins/synthetics/public/components/fleet_package/contexts/http_context_advanced.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/http_context_advanced.tsx index 4d64bd3cf1ad4..549f314bc3d3a 100644 --- a/x-pack/plugins/synthetics/public/components/fleet_package/contexts/http_context_advanced.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/http_context_advanced.tsx @@ -6,7 +6,8 @@ */ import React, { createContext, useContext, useMemo, useState } from 'react'; -import { HTTPAdvancedFields, ConfigKey, Mode, ResponseBodyIndexPolicy, HTTPMethod } from '../types'; +import { HTTPAdvancedFields } from '../types'; +import { DEFAULT_HTTP_ADVANCED_FIELDS } from '../../../../../common/constants/monitor_defaults'; interface HTTPAdvancedFieldsContext { setFields: React.Dispatch>; @@ -19,23 +20,7 @@ interface HTTPAdvancedFieldsContextProvider { defaultValues?: HTTPAdvancedFields; } -export const initialValues: HTTPAdvancedFields = { - [ConfigKey.PASSWORD]: '', - [ConfigKey.PROXY_URL]: '', - [ConfigKey.RESPONSE_BODY_CHECK_NEGATIVE]: [], - [ConfigKey.RESPONSE_BODY_CHECK_POSITIVE]: [], - [ConfigKey.RESPONSE_BODY_INDEX]: ResponseBodyIndexPolicy.ON_ERROR, - [ConfigKey.RESPONSE_HEADERS_CHECK]: {}, - [ConfigKey.RESPONSE_HEADERS_INDEX]: true, - [ConfigKey.RESPONSE_STATUS_CHECK]: [], - [ConfigKey.REQUEST_BODY_CHECK]: { - value: '', - type: Mode.PLAINTEXT, - }, - [ConfigKey.REQUEST_HEADERS_CHECK]: {}, - [ConfigKey.REQUEST_METHOD_CHECK]: HTTPMethod.GET, - [ConfigKey.USERNAME]: '', -}; +export const initialValues: HTTPAdvancedFields = DEFAULT_HTTP_ADVANCED_FIELDS; export const defaultContext: HTTPAdvancedFieldsContext = { setFields: (_fields: React.SetStateAction) => { diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/contexts/http_provider.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/http_provider.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/contexts/http_provider.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/http_provider.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/contexts/icmp_context.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/icmp_context.tsx similarity index 82% rename from x-pack/plugins/synthetics/public/components/fleet_package/contexts/icmp_context.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/icmp_context.tsx index f0547e621afc4..4e7667650ff10 100644 --- a/x-pack/plugins/synthetics/public/components/fleet_package/contexts/icmp_context.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/icmp_context.tsx @@ -6,8 +6,8 @@ */ import React, { createContext, useContext, useMemo, useState } from 'react'; -import { ICMPSimpleFields, ConfigKey, DataStream } from '../types'; -import { defaultValues as commonDefaultValues } from '../common/default_values'; +import { ICMPSimpleFields } from '../types'; +import { DEFAULT_ICMP_SIMPLE_FIELDS } from '../../../../../common/constants/monitor_defaults'; interface ICMPSimpleFieldsContext { setFields: React.Dispatch>; @@ -20,12 +20,7 @@ interface ICMPSimpleFieldsContextProvider { defaultValues?: ICMPSimpleFields; } -export const initialValues: ICMPSimpleFields = { - ...commonDefaultValues, - [ConfigKey.HOSTS]: '', - [ConfigKey.MONITOR_TYPE]: DataStream.ICMP, - [ConfigKey.WAIT]: '1', -}; +export const initialValues: ICMPSimpleFields = DEFAULT_ICMP_SIMPLE_FIELDS; const defaultContext: ICMPSimpleFieldsContext = { setFields: (_fields: React.SetStateAction) => { diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/contexts/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/index.ts similarity index 65% rename from x-pack/plugins/synthetics/public/components/fleet_package/contexts/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/index.ts index 3f392c42983b6..a80e295e8bc40 100644 --- a/x-pack/plugins/synthetics/public/components/fleet_package/contexts/index.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/index.ts @@ -4,16 +4,6 @@ * 2.0; you may not use this file except in compliance with the Elastic License * 2.0. */ -import { DataStream, PolicyConfig } from '../types'; -import { initialValues as defaultHTTPSimpleFields } from './http_context'; -import { initialValues as defaultHTTPAdvancedFields } from './http_context_advanced'; -import { initialValues as defaultTCPSimpleFields } from './tcp_context'; -import { initialValues as defaultICMPSimpleFields } from './icmp_context'; -import { initialValues as defaultTCPAdvancedFields } from './tcp_context_advanced'; -import { initialValues as defaultBrowserSimpleFields } from './browser_context'; -import { initialValues as defaultBrowserAdvancedFields } from './browser_context_advanced'; -import { initialValues as defaultTLSFields } from './tls_fields_context'; - export type { IPolicyConfigContextProvider } from './policy_config_context'; export { PolicyConfigContext, @@ -74,22 +64,3 @@ export { HTTPContextProvider } from './http_provider'; export { TCPContextProvider } from './tcp_provider'; export { BrowserContextProvider } from './browser_provider'; export { SyntheticsProviders } from './synthetics_context_providers'; - -export const defaultConfig: PolicyConfig = { - [DataStream.HTTP]: { - ...defaultHTTPSimpleFields, - ...defaultHTTPAdvancedFields, - ...defaultTLSFields, - }, - [DataStream.TCP]: { - ...defaultTCPSimpleFields, - ...defaultTCPAdvancedFields, - ...defaultTLSFields, - }, - [DataStream.ICMP]: defaultICMPSimpleFields, - [DataStream.BROWSER]: { - ...defaultBrowserSimpleFields, - ...defaultBrowserAdvancedFields, - ...defaultTLSFields, - }, -}; diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/contexts/policy_config_context.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/policy_config_context.tsx similarity index 97% rename from x-pack/plugins/synthetics/public/components/fleet_package/contexts/policy_config_context.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/policy_config_context.tsx index 5d47b4e9d0984..49f83d9577661 100644 --- a/x-pack/plugins/synthetics/public/components/fleet_package/contexts/policy_config_context.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/policy_config_context.tsx @@ -6,13 +6,13 @@ */ import React, { createContext, useContext, useMemo, useState } from 'react'; -import { DEFAULT_NAMESPACE_STRING } from '../../../../common/constants'; +import { DEFAULT_NAMESPACE_STRING } from '../../../../../common/constants/monitor_defaults'; import { ScheduleUnit, MonitorServiceLocations, ThrottlingOptions, DEFAULT_THROTTLING, -} from '../../../../common/runtime_types'; +} from '../../../../../common/runtime_types'; import { DataStream } from '../types'; interface IPolicyConfigContext { diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/contexts/synthetics_context_providers.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/synthetics_context_providers.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/contexts/synthetics_context_providers.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/synthetics_context_providers.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/contexts/tcp_context.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/tcp_context.tsx similarity index 80% rename from x-pack/plugins/synthetics/public/components/fleet_package/contexts/tcp_context.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/tcp_context.tsx index 38a15c3e39453..9b3e1052100e9 100644 --- a/x-pack/plugins/synthetics/public/components/fleet_package/contexts/tcp_context.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/tcp_context.tsx @@ -6,8 +6,8 @@ */ import React, { createContext, useContext, useMemo, useState } from 'react'; -import { TCPSimpleFields, ConfigKey, DataStream } from '../types'; -import { defaultValues as commonDefaultValues } from '../common/default_values'; +import { TCPSimpleFields } from '../types'; +import { DEFAULT_TCP_SIMPLE_FIELDS } from '../../../../../common/constants/monitor_defaults'; interface TCPSimpleFieldsContext { setFields: React.Dispatch>; @@ -20,14 +20,7 @@ interface TCPSimpleFieldsContextProvider { defaultValues?: TCPSimpleFields; } -export const initialValues: TCPSimpleFields = { - ...commonDefaultValues, - [ConfigKey.METADATA]: { - is_tls_enabled: false, - }, - [ConfigKey.HOSTS]: '', - [ConfigKey.MONITOR_TYPE]: DataStream.TCP, -}; +export const initialValues: TCPSimpleFields = DEFAULT_TCP_SIMPLE_FIELDS; const defaultContext: TCPSimpleFieldsContext = { setFields: (_fields: React.SetStateAction) => { diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/contexts/tcp_context_advanced.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/tcp_context_advanced.tsx similarity index 84% rename from x-pack/plugins/synthetics/public/components/fleet_package/contexts/tcp_context_advanced.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/tcp_context_advanced.tsx index 7fe29f7648841..8d1174ed96bc6 100644 --- a/x-pack/plugins/synthetics/public/components/fleet_package/contexts/tcp_context_advanced.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/tcp_context_advanced.tsx @@ -6,7 +6,8 @@ */ import React, { createContext, useContext, useMemo, useState } from 'react'; -import { TCPAdvancedFields, ConfigKey } from '../types'; +import { TCPAdvancedFields } from '../types'; +import { DEFAULT_TCP_ADVANCED_FIELDS } from '../../../../../common/constants/monitor_defaults'; interface TCPAdvancedFieldsContext { setFields: React.Dispatch>; @@ -19,12 +20,7 @@ interface TCPAdvancedFieldsContextProvider { defaultValues?: TCPAdvancedFields; } -export const initialValues: TCPAdvancedFields = { - [ConfigKey.PROXY_URL]: '', - [ConfigKey.PROXY_USE_LOCAL_RESOLVER]: false, - [ConfigKey.RESPONSE_RECEIVE_CHECK]: '', - [ConfigKey.REQUEST_SEND_CHECK]: '', -}; +export const initialValues: TCPAdvancedFields = DEFAULT_TCP_ADVANCED_FIELDS; const defaultContext: TCPAdvancedFieldsContext = { setFields: (_fields: React.SetStateAction) => { diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/contexts/tcp_provider.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/tcp_provider.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/contexts/tcp_provider.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/tcp_provider.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/contexts/tls_fields_context.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/tls_fields_context.tsx similarity index 90% rename from x-pack/plugins/synthetics/public/components/fleet_package/contexts/tls_fields_context.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/tls_fields_context.tsx index a76655a235c4f..14ec64bf640b7 100644 --- a/x-pack/plugins/synthetics/public/components/fleet_package/contexts/tls_fields_context.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/contexts/tls_fields_context.tsx @@ -7,7 +7,7 @@ import React, { createContext, useContext, useMemo, useState } from 'react'; import { TLSFields } from '../types'; -import { defaultValues as tlsDefaultValues } from '../tls/default_values'; +import { DEFAULT_TLS_FIELDS } from '../../../../../common/constants/monitor_defaults'; interface TLSFieldsContext { setFields: React.Dispatch>; @@ -20,7 +20,7 @@ interface TLSFieldsContextProvider { defaultValues?: TLSFields; } -export const initialValues: TLSFields = tlsDefaultValues; +export const initialValues: TLSFields = DEFAULT_TLS_FIELDS; const defaultContext: TLSFieldsContext = { setFields: (_fields: React.SetStateAction) => { diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/custom_fields.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/custom_fields.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/custom_fields.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/custom_fields.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/custom_fields.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/custom_fields.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/custom_fields.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/custom_fields.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/header_field.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/header_field.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/header_field.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/header_field.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/header_field.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/header_field.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/header_field.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/header_field.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/helpers/context_helpers.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/helpers/context_helpers.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/helpers/context_helpers.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/helpers/context_helpers.ts diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/helpers/formatters.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/helpers/formatters.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/helpers/formatters.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/helpers/formatters.ts diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/helpers/normalizers.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/helpers/normalizers.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/helpers/normalizers.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/helpers/normalizers.ts diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/hooks/use_policy.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/hooks/use_policy.ts similarity index 84% rename from x-pack/plugins/synthetics/public/components/fleet_package/hooks/use_policy.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/hooks/use_policy.ts index 2fc33de1bab39..9f43cbb238a79 100644 --- a/x-pack/plugins/synthetics/public/components/fleet_package/hooks/use_policy.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/hooks/use_policy.ts @@ -25,34 +25,10 @@ import { useTLSFieldsContext, useBrowserSimpleFieldsContext, useBrowserAdvancedFieldsContext, - defaultHTTPAdvancedFields, - defaultHTTPSimpleFields, - defaultICMPSimpleFields, - defaultTCPSimpleFields, - defaultTCPAdvancedFields, - defaultBrowserSimpleFields, - defaultBrowserAdvancedFields, - defaultTLSFields, } from '../contexts'; +import { DEFAULT_FIELDS } from '../../../../../common/constants/monitor_defaults'; -export const defaultConfig: PolicyConfig = { - [DataStream.HTTP]: { - ...defaultHTTPSimpleFields, - ...defaultHTTPAdvancedFields, - ...defaultTLSFields, - }, - [DataStream.TCP]: { - ...defaultTCPSimpleFields, - ...defaultTCPAdvancedFields, - ...defaultTLSFields, - }, - [DataStream.ICMP]: defaultICMPSimpleFields, - [DataStream.BROWSER]: { - ...defaultBrowserSimpleFields, - ...defaultBrowserAdvancedFields, - ...defaultTLSFields, - }, -}; +export const defaultConfig: PolicyConfig = DEFAULT_FIELDS; export const usePolicy = (fleetPolicyName: string = '') => { const { diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/hooks/use_update_policy.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/hooks/use_update_policy.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/hooks/use_update_policy.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/hooks/use_update_policy.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/hooks/use_update_policy.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/hooks/use_update_policy.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/hooks/use_update_policy.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/hooks/use_update_policy.ts diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/http/advanced_fields.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/http/advanced_fields.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/http/advanced_fields.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/http/advanced_fields.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/http/advanced_fields.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/http/advanced_fields.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/http/advanced_fields.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/http/advanced_fields.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/http/formatters.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/http/formatters.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/http/formatters.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/http/formatters.ts diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/http/normalizers.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/http/normalizers.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/http/normalizers.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/http/normalizers.ts diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/http/simple_fields.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/http/simple_fields.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/http/simple_fields.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/http/simple_fields.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/icmp/advanced_fields.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/icmp/advanced_fields.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/icmp/advanced_fields.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/icmp/advanced_fields.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/icmp/advanced_fields.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/icmp/advanced_fields.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/icmp/advanced_fields.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/icmp/advanced_fields.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/icmp/formatters.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/icmp/formatters.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/icmp/formatters.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/icmp/formatters.ts diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/icmp/normalizers.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/icmp/normalizers.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/icmp/normalizers.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/icmp/normalizers.ts diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/icmp/simple_fields.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/icmp/simple_fields.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/icmp/simple_fields.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/icmp/simple_fields.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/index.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/index.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/index.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/index.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/index_response_body_field.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/index_response_body_field.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/index_response_body_field.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/index_response_body_field.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/index_response_body_field.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/index_response_body_field.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/index_response_body_field.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/index_response_body_field.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/key_value_field.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/key_value_field.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/key_value_field.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/key_value_field.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/key_value_field.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/key_value_field.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/key_value_field.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/key_value_field.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/lazy_synthetics_custom_assets_extension.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/lazy_synthetics_custom_assets_extension.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/lazy_synthetics_custom_assets_extension.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/lazy_synthetics_custom_assets_extension.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/lazy_synthetics_policy_create_extension.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/lazy_synthetics_policy_create_extension.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/lazy_synthetics_policy_create_extension.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/lazy_synthetics_policy_create_extension.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/lazy_synthetics_policy_edit_extension.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/lazy_synthetics_policy_edit_extension.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/lazy_synthetics_policy_edit_extension.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/lazy_synthetics_policy_edit_extension.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/optional_label.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/optional_label.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/optional_label.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/optional_label.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/request_body_field.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/request_body_field.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/request_body_field.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/request_body_field.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/request_body_field.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/request_body_field.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/request_body_field.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/request_body_field.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/schedule_field.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/schedule_field.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/schedule_field.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/schedule_field.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/schedule_field.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/schedule_field.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/schedule_field.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/schedule_field.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/synthetics_custom_assets_extension.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/synthetics_custom_assets_extension.tsx similarity index 90% rename from x-pack/plugins/synthetics/public/components/fleet_package/synthetics_custom_assets_extension.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/synthetics_custom_assets_extension.tsx index c21acee549986..64d1be74e71fd 100644 --- a/x-pack/plugins/synthetics/public/components/fleet_package/synthetics_custom_assets_extension.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/synthetics_custom_assets_extension.tsx @@ -14,8 +14,8 @@ import { CustomAssetsAccordion, } from '@kbn/fleet-plugin/public'; import { useKibana } from '@kbn/kibana-react-plugin/public'; -import { ClientPluginsStart } from '../../apps/plugin'; -import { PLUGIN } from '../../../common/constants/plugin'; +import { ClientPluginsStart } from '../../../plugin'; +import { PLUGIN } from '../../../../common/constants/plugin'; export const SyntheticsCustomAssetsExtension: PackageAssetsComponent = () => { const { http } = useKibana().services; diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/synthetics_policy_create_extension.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/synthetics_policy_create_extension.tsx similarity index 76% rename from x-pack/plugins/synthetics/public/components/fleet_package/synthetics_policy_create_extension.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/synthetics_policy_create_extension.tsx index e93cc20e4d2ad..6247619f6a3b6 100644 --- a/x-pack/plugins/synthetics/public/components/fleet_package/synthetics_policy_create_extension.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/synthetics_policy_create_extension.tsx @@ -10,40 +10,14 @@ import { PackagePolicyCreateExtensionComponentProps } from '@kbn/fleet-plugin/pu import { useTrackPageview } from '@kbn/observability-plugin/public'; import { DataStream } from './types'; import { PolicyConfig } from './types'; -import { - usePolicyConfigContext, - defaultHTTPSimpleFields, - defaultHTTPAdvancedFields, - defaultTCPSimpleFields, - defaultTCPAdvancedFields, - defaultICMPSimpleFields, - defaultBrowserSimpleFields, - defaultBrowserAdvancedFields, - defaultTLSFields, -} from './contexts'; +import { usePolicyConfigContext } from './contexts'; +import { DEFAULT_FIELDS } from '../../../../common/constants/monitor_defaults'; import { CustomFields } from './custom_fields'; import { useUpdatePolicy } from './hooks/use_update_policy'; import { usePolicy } from './hooks/use_policy'; import { validate } from './validation'; -export const defaultConfig: PolicyConfig = { - [DataStream.HTTP]: { - ...defaultHTTPSimpleFields, - ...defaultHTTPAdvancedFields, - ...defaultTLSFields, - }, - [DataStream.TCP]: { - ...defaultTCPSimpleFields, - ...defaultTCPAdvancedFields, - ...defaultTLSFields, - }, - [DataStream.ICMP]: defaultICMPSimpleFields, - [DataStream.BROWSER]: { - ...defaultBrowserSimpleFields, - ...defaultBrowserAdvancedFields, - ...defaultTLSFields, - }, -}; +export const defaultConfig: PolicyConfig = DEFAULT_FIELDS; /** * Exports Synthetics-specific package policy instructions diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/synthetics_policy_create_extension_wrapper.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/synthetics_policy_create_extension_wrapper.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/synthetics_policy_create_extension_wrapper.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/synthetics_policy_create_extension_wrapper.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/synthetics_policy_create_extension_wrapper.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/synthetics_policy_create_extension_wrapper.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/synthetics_policy_create_extension_wrapper.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/synthetics_policy_create_extension_wrapper.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/synthetics_policy_edit_extension.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/synthetics_policy_edit_extension.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/synthetics_policy_edit_extension.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/synthetics_policy_edit_extension.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/synthetics_policy_edit_extension_wrapper.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/synthetics_policy_edit_extension_wrapper.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/synthetics_policy_edit_extension_wrapper.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/synthetics_policy_edit_extension_wrapper.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/synthetics_policy_edit_extension_wrapper.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/synthetics_policy_edit_extension_wrapper.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/synthetics_policy_edit_extension_wrapper.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/synthetics_policy_edit_extension_wrapper.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/tcp/advanced_fields.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/tcp/advanced_fields.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/tcp/advanced_fields.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/tcp/advanced_fields.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/tcp/advanced_fields.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/tcp/advanced_fields.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/tcp/advanced_fields.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/tcp/advanced_fields.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/tcp/formatters.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/tcp/formatters.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/tcp/formatters.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/tcp/formatters.ts diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/tcp/normalizers.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/tcp/normalizers.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/tcp/normalizers.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/tcp/normalizers.ts diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/tcp/simple_fields.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/tcp/simple_fields.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/tcp/simple_fields.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/tcp/simple_fields.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/tls/formatters.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/tls/formatters.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/tls/formatters.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/tls/formatters.ts diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/tls/normalizers.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/tls/normalizers.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/tls/normalizers.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/tls/normalizers.ts diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/tls_fields.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/tls_fields.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/tls_fields.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/tls_fields.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/tls_fields.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/tls_fields.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/tls_fields.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/tls_fields.tsx diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/types.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/types.tsx similarity index 85% rename from x-pack/plugins/synthetics/public/components/fleet_package/types.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/types.tsx index d3df3a1926887..0a5de311c5cb3 100644 --- a/x-pack/plugins/synthetics/public/components/fleet_package/types.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/types.tsx @@ -16,9 +16,9 @@ import { ThrottlingConfigKey, ThrottlingSuffix, ThrottlingSuffixType, -} from '../../../common/runtime_types'; -export * from '../../../common/runtime_types/monitor_management'; -export * from '../../../common/types/monitor_validation'; +} from '../../../../common/runtime_types'; +export * from '../../../../common/runtime_types/monitor_management'; +export * from '../../../../common/types/monitor_validation'; export interface PolicyConfig { [DataStream.HTTP]: HTTPFields; diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/validation.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/validation.test.ts similarity index 98% rename from x-pack/plugins/synthetics/public/components/fleet_package/validation.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/validation.test.ts index 3495b163b9845..b2cca04b44d1b 100644 --- a/x-pack/plugins/synthetics/public/components/fleet_package/validation.test.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/validation.test.ts @@ -12,7 +12,7 @@ import { BrowserFields, MonitorFields, ScheduleUnit, -} from '../../../common/runtime_types'; +} from '../../../../common/runtime_types'; import { validate } from './validation'; describe('[Monitor Management] validation', () => { diff --git a/x-pack/plugins/synthetics/public/components/fleet_package/validation.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/validation.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/fleet_package/validation.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/fleet_package/validation.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/__snapshots__/monitor_charts.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/__snapshots__/monitor_charts.test.tsx.snap similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/__snapshots__/monitor_charts.test.tsx.snap rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/__snapshots__/monitor_charts.test.tsx.snap diff --git a/x-pack/plugins/synthetics/public/components/monitor/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/index.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/index.ts diff --git a/x-pack/plugins/synthetics/public/components/monitor/ml/__snapshots__/confirm_delete.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/__snapshots__/confirm_delete.test.tsx.snap similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ml/__snapshots__/confirm_delete.test.tsx.snap rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/__snapshots__/confirm_delete.test.tsx.snap diff --git a/x-pack/plugins/synthetics/public/components/monitor/ml/__snapshots__/ml_integerations.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/__snapshots__/ml_integerations.test.tsx.snap similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ml/__snapshots__/ml_integerations.test.tsx.snap rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/__snapshots__/ml_integerations.test.tsx.snap diff --git a/x-pack/plugins/synthetics/public/components/monitor/ml/confirm_alert_delete.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/confirm_alert_delete.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ml/confirm_alert_delete.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/confirm_alert_delete.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/ml/confirm_delete.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/confirm_delete.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ml/confirm_delete.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/confirm_delete.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/ml/confirm_delete.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/confirm_delete.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ml/confirm_delete.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/confirm_delete.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/ml/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/index.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ml/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/index.ts diff --git a/x-pack/plugins/synthetics/public/components/monitor/ml/license_info.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/license_info.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ml/license_info.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/license_info.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/ml/license_info.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/license_info.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ml/license_info.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/license_info.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/ml/manage_ml_job.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/manage_ml_job.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/monitor/ml/manage_ml_job.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/manage_ml_job.tsx index 435eb7e4f9001..f6b8198a24699 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/ml/manage_ml_job.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/manage_ml_job.tsx @@ -10,7 +10,7 @@ import React, { useCallback, useContext, useState } from 'react'; import { EuiButton, EuiContextMenu, EuiIcon, EuiPopover } from '@elastic/eui'; import { useSelector, useDispatch } from 'react-redux'; import { useKibana } from '@kbn/kibana-react-plugin/public'; -import { CLIENT_ALERT_TYPES } from '../../../../common/constants/alerts'; +import { CLIENT_ALERT_TYPES } from '../../../../../common/constants/alerts'; import { canDeleteMLJobSelector, hasMLJobSelector, diff --git a/x-pack/plugins/synthetics/public/components/monitor/ml/ml_flyout.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/ml_flyout.test.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/monitor/ml/ml_flyout.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/ml_flyout.test.tsx index 8669bc180f42f..6a0bda2c5fb04 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/ml/ml_flyout.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/ml_flyout.test.tsx @@ -8,7 +8,7 @@ import React from 'react'; import { MLFlyoutView } from './ml_flyout'; import { UptimeSettingsContext } from '../../../contexts'; -import { CLIENT_DEFAULTS } from '../../../../common/constants'; +import { CLIENT_DEFAULTS } from '../../../../../common/constants'; import * as redux from 'react-redux'; import { render, forNearestButton } from '../../../lib/helper/rtl_helpers'; import * as labels from './translations'; diff --git a/x-pack/plugins/synthetics/public/components/monitor/ml/ml_flyout.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/ml_flyout.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ml/ml_flyout.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/ml_flyout.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/ml/ml_flyout_container.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/ml_flyout_container.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/monitor/ml/ml_flyout_container.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/ml_flyout_container.tsx index 482e3f70b3180..49eaef7b176ac 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/ml/ml_flyout_container.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/ml_flyout_container.tsx @@ -31,7 +31,7 @@ import { useGetUrlParams } from '../../../hooks'; import { getDynamicSettings } from '../../../state/actions/dynamic_settings'; import { useMonitorId } from '../../../hooks'; import { kibanaService } from '../../../state/kibana_service'; -import { CLIENT_ALERT_TYPES } from '../../../../common/constants/alerts'; +import { CLIENT_ALERT_TYPES } from '../../../../../common/constants/alerts'; interface Props { onClose: () => void; diff --git a/x-pack/plugins/synthetics/public/components/monitor/ml/ml_integeration.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/ml_integeration.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/monitor/ml/ml_integeration.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/ml_integeration.tsx index 6396f99e4d62c..675554906694b 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/ml/ml_integeration.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/ml_integeration.tsx @@ -22,7 +22,7 @@ import { UptimeRefreshContext } from '../../../contexts'; import * as labels from './translations'; import { ManageMLJobComponent } from './manage_ml_job'; import { useMonitorId } from '../../../hooks'; -import { getMLJobId } from '../../../../common/lib'; +import { getMLJobId } from '../../../../../common/lib'; export const MLIntegrationComponent = () => { const [isMlFlyoutOpen, setIsMlFlyoutOpen] = useState(false); diff --git a/x-pack/plugins/synthetics/public/components/monitor/ml/ml_integerations.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/ml_integerations.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ml/ml_integerations.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/ml_integerations.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/ml/ml_job_link.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/ml_job_link.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ml/ml_job_link.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/ml_job_link.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/ml/ml_job_link.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/ml_job_link.tsx similarity index 96% rename from x-pack/plugins/synthetics/public/components/monitor/ml/ml_job_link.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/ml_job_link.tsx index e14f37f617aac..2e9d771e11150 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/ml/ml_job_link.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/ml_job_link.tsx @@ -9,7 +9,7 @@ import React from 'react'; import url from 'url'; import { EuiButtonEmpty } from '@elastic/eui'; import rison, { RisonValue } from 'rison-node'; -import { getMLJobId } from '../../../../common/lib'; +import { getMLJobId } from '../../../../../common/lib'; interface Props { monitorId: string; diff --git a/x-pack/plugins/synthetics/public/components/monitor/ml/ml_manage_job.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/ml_manage_job.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ml/ml_manage_job.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/ml_manage_job.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/ml/translations.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/translations.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ml/translations.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/translations.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/ml/use_anomaly_alert.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/use_anomaly_alert.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ml/use_anomaly_alert.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ml/use_anomaly_alert.ts diff --git a/x-pack/plugins/synthetics/public/components/monitor/monitor_charts.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/monitor_charts.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/monitor_charts.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/monitor_charts.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/monitor_charts.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/monitor_charts.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/monitor_charts.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/monitor_charts.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/monitor_duration/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/monitor_duration/index.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/monitor_duration/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/monitor_duration/index.ts diff --git a/x-pack/plugins/synthetics/public/components/monitor/monitor_duration/monitor_duration.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/monitor_duration/monitor_duration.tsx similarity index 97% rename from x-pack/plugins/synthetics/public/components/monitor/monitor_duration/monitor_duration.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/monitor_duration/monitor_duration.tsx index 6d8615226f79b..822a476f5225a 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/monitor_duration/monitor_duration.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/monitor_duration/monitor_duration.tsx @@ -8,7 +8,7 @@ import React from 'react'; import { FormattedMessage } from '@kbn/i18n-react'; import { EuiFlexGroup, EuiFlexItem, EuiPanel, EuiTitle, EuiSpacer } from '@elastic/eui'; -import { LocationDurationLine } from '../../../../common/types'; +import { LocationDurationLine } from '../../../../../common/types'; import { MLIntegrationComponent } from '../ml/ml_integeration'; import { AnomalyRecords } from '../../../state/actions'; import { DurationChartComponent } from '../../common/charts'; diff --git a/x-pack/plugins/synthetics/public/components/monitor/monitor_duration/monitor_duration_container.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/monitor_duration/monitor_duration_container.tsx similarity index 96% rename from x-pack/plugins/synthetics/public/components/monitor/monitor_duration/monitor_duration_container.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/monitor_duration/monitor_duration_container.tsx index 8b88c8d59a47c..63f95fd966544 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/monitor_duration/monitor_duration_container.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/monitor_duration/monitor_duration_container.tsx @@ -23,8 +23,8 @@ import { } from '../../../state/selectors'; import { UptimeRefreshContext } from '../../../contexts'; import { MonitorDurationComponent } from './monitor_duration'; -import { MonitorIdParam } from '../../../../common/types'; -import { getMLJobId } from '../../../../common/lib'; +import { MonitorIdParam } from '../../../../../common/types'; +import { getMLJobId } from '../../../../../common/lib'; import { useUptimeSettingsContext } from '../../../contexts/uptime_settings_context'; export const MonitorDuration: React.FC = ({ monitorId }) => { diff --git a/x-pack/plugins/synthetics/public/components/monitor/monitor_title.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/monitor_title.test.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/monitor/monitor_title.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/monitor_title.test.tsx index 726ad235f7f49..f9e3572ead511 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/monitor_title.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/monitor_title.test.tsx @@ -10,7 +10,7 @@ import moment from 'moment'; import { screen } from '@testing-library/react'; import { render } from '../../lib/helper/rtl_helpers'; import * as reactRouterDom from 'react-router-dom'; -import { Ping } from '../../../common/runtime_types'; +import { Ping } from '../../../../common/runtime_types'; import { MonitorPageTitle, MonitorPageTitleContent } from './monitor_title'; jest.mock('react-router-dom', () => { diff --git a/x-pack/plugins/synthetics/public/components/monitor/monitor_title.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/monitor_title.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/monitor/monitor_title.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/monitor_title.tsx index 0d77179cd99ee..ce343ac1f6bd7 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/monitor_title.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/monitor_title.tsx @@ -12,7 +12,7 @@ import { useSelector } from 'react-redux'; import { useMonitorId } from '../../hooks'; import { monitorStatusSelector } from '../../state/selectors'; import { EnableMonitorAlert } from '../overview/monitor_list/columns/enable_alert'; -import { Ping } from '../../../common/runtime_types/ping'; +import { Ping } from '../../../../common/runtime_types/ping'; import { useBreadcrumbs } from '../../hooks/use_breadcrumbs'; const isAutogeneratedId = (id: string) => { diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_histogram/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_histogram/index.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ping_histogram/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_histogram/index.ts diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_histogram/ping_histogram_container.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_histogram/ping_histogram_container.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ping_histogram/ping_histogram_container.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_histogram/ping_histogram_container.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_list/__snapshots__/expanded_row.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/__snapshots__/expanded_row.test.tsx.snap similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ping_list/__snapshots__/expanded_row.test.tsx.snap rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/__snapshots__/expanded_row.test.tsx.snap diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_list/__snapshots__/ping_headers.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/__snapshots__/ping_headers.test.tsx.snap similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ping_list/__snapshots__/ping_headers.test.tsx.snap rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/__snapshots__/ping_headers.test.tsx.snap diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/expand_row.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/expand_row.test.tsx similarity index 94% rename from x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/expand_row.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/expand_row.test.tsx index e3ac1f2e17125..06b43744a2ac2 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/expand_row.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/expand_row.test.tsx @@ -8,12 +8,12 @@ import React from 'react'; import { screen } from '@testing-library/react'; -import { makePing } from '../../../../../common/runtime_types'; +import { makePing } from '../../../../../../common/runtime_types'; import { render } from '../../../../lib/helper/rtl_helpers'; import { ExpandRowColumn } from './expand_row'; -import { Ping } from '../../../../../common/runtime_types/ping'; +import { Ping } from '../../../../../../common/runtime_types/ping'; describe('ExpandRowColumn', () => { const defaultPing = makePing({ diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/expand_row.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/expand_row.tsx similarity index 96% rename from x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/expand_row.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/expand_row.tsx index 1c18668741292..3e5104357463f 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/expand_row.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/expand_row.tsx @@ -8,7 +8,7 @@ import React from 'react'; import { i18n } from '@kbn/i18n'; import { EuiButtonIcon } from '@elastic/eui'; -import { Ping } from '../../../../../common/runtime_types/ping'; +import { Ping } from '../../../../../../common/runtime_types/ping'; import { PingListExpandedRowComponent } from '../expanded_row'; export const toggleDetails = ( diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/failed_step.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/failed_step.tsx similarity index 88% rename from x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/failed_step.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/failed_step.tsx index 38f51a2bafebb..da3b93bd0e09d 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/failed_step.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/failed_step.tsx @@ -6,7 +6,7 @@ */ import React from 'react'; -import { FailedStepsApiResponse } from '../../../../../common/runtime_types/ping/synthetics'; +import { FailedStepsApiResponse } from '../../../../../../common/runtime_types/ping/synthetics'; interface Props { checkGroup?: string; diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/ping_error.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/ping_error.tsx similarity index 91% rename from x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/ping_error.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/ping_error.tsx index db7dc46fc9043..beb29b4201438 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/ping_error.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/ping_error.tsx @@ -7,7 +7,7 @@ import React from 'react'; import styled from 'styled-components'; -import { Ping } from '../../../../../common/runtime_types/ping'; +import { Ping } from '../../../../../../common/runtime_types/ping'; const StyledSpan = styled.span` display: -webkit-box; diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/ping_status.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/ping_status.tsx similarity index 93% rename from x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/ping_status.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/ping_status.tsx index 6c33018126983..6d46803da22fd 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/ping_status.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/ping_status.tsx @@ -9,8 +9,8 @@ import React, { useContext } from 'react'; import { i18n } from '@kbn/i18n'; import moment from 'moment'; import { EuiBadge, EuiSpacer, EuiText } from '@elastic/eui'; -import { Ping } from '../../../../../common/runtime_types/ping'; -import { MONITOR_TYPES, STATUS } from '../../../../../common/constants'; +import { Ping } from '../../../../../../common/runtime_types/ping'; +import { MONITOR_TYPES, STATUS } from '../../../../../../common/constants'; import { UptimeThemeContext } from '../../../../contexts'; import { STATUS_COMPLETE_LABEL, diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/ping_timestamp/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/ping_timestamp/index.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/ping_timestamp/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/ping_timestamp/index.ts diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/ping_timestamp/no_image_available.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/ping_timestamp/no_image_available.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/ping_timestamp/no_image_available.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/ping_timestamp/no_image_available.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/ping_timestamp/no_image_available.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/ping_timestamp/no_image_available.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/ping_timestamp/no_image_available.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/ping_timestamp/no_image_available.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/ping_timestamp/no_image_display.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/ping_timestamp/no_image_display.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/ping_timestamp/no_image_display.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/ping_timestamp/no_image_display.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/ping_timestamp/no_image_display.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/ping_timestamp/no_image_display.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/ping_timestamp/no_image_display.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/ping_timestamp/no_image_display.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/ping_timestamp/ping_timestamp.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/ping_timestamp/ping_timestamp.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/ping_timestamp/ping_timestamp.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/ping_timestamp/ping_timestamp.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/ping_timestamp/ping_timestamp.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/ping_timestamp/ping_timestamp.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/ping_timestamp/ping_timestamp.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/ping_timestamp/ping_timestamp.tsx index 4083df8c98a1a..3bc443426d523 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/ping_timestamp/ping_timestamp.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/ping_timestamp/ping_timestamp.tsx @@ -16,7 +16,7 @@ import { isScreenshotRef, ScreenshotImageBlob, ScreenshotRefImageData, -} from '../../../../../../common/runtime_types'; +} from '../../../../../../../common/runtime_types'; import { getJourneyScreenshot } from '../../../../../state/api/journey'; import { UptimeSettingsContext } from '../../../../../contexts'; diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/ping_timestamp/step_image_caption.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/ping_timestamp/step_image_caption.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/ping_timestamp/step_image_caption.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/ping_timestamp/step_image_caption.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/ping_timestamp/step_image_caption.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/ping_timestamp/step_image_caption.tsx similarity index 97% rename from x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/ping_timestamp/step_image_caption.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/ping_timestamp/step_image_caption.tsx index eb0d8c30ae53d..1003b51319136 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/ping_timestamp/step_image_caption.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/ping_timestamp/step_image_caption.tsx @@ -9,7 +9,7 @@ import React, { MouseEvent, useEffect } from 'react'; import { EuiButtonEmpty, EuiFlexGroup, EuiFlexItem, EuiText, useEuiTheme } from '@elastic/eui'; import { euiStyled } from '@kbn/kibana-react-plugin/common'; -import { ScreenshotRefImageData } from '../../../../../../common/runtime_types'; +import { ScreenshotRefImageData } from '../../../../../../../common/runtime_types'; import { useBreakpoints } from '../../../../../hooks'; import { nextAriaLabel, prevAriaLabel } from './translations'; diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/ping_timestamp/step_image_popover.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/ping_timestamp/step_image_popover.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/ping_timestamp/step_image_popover.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/ping_timestamp/step_image_popover.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/ping_timestamp/step_image_popover.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/ping_timestamp/step_image_popover.tsx similarity index 97% rename from x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/ping_timestamp/step_image_popover.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/ping_timestamp/step_image_popover.tsx index 73c43da98bfc4..1d97e3e4e248a 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/ping_timestamp/step_image_popover.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/ping_timestamp/step_image_popover.tsx @@ -8,7 +8,7 @@ import { EuiImage, EuiLoadingSpinner, EuiPopover } from '@elastic/eui'; import React from 'react'; import styled from 'styled-components'; -import { ScreenshotRefImageData } from '../../../../../../common/runtime_types/ping/synthetics'; +import { ScreenshotRefImageData } from '../../../../../../../common/runtime_types/ping/synthetics'; import { fullSizeImageAlt } from './translations'; import { useCompositeImage } from '../../../../../hooks/use_composite_image'; diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/ping_timestamp/translations.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/ping_timestamp/translations.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/ping_timestamp/translations.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/ping_timestamp/translations.ts diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/response_code.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/response_code.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ping_list/columns/response_code.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/columns/response_code.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_list/doc_link_body.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/doc_link_body.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ping_list/doc_link_body.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/doc_link_body.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_list/doc_link_body.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/doc_link_body.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ping_list/doc_link_body.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/doc_link_body.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_list/expanded_row.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/expanded_row.test.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/monitor/ping_list/expanded_row.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/expanded_row.test.tsx index f87501a79e964..d65536bf75c4a 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/ping_list/expanded_row.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/expanded_row.test.tsx @@ -8,7 +8,7 @@ import { mountWithIntl, renderWithIntl, shallowWithIntl } from '@kbn/test-jest-helpers'; import React from 'react'; import { PingListExpandedRowComponent } from './expanded_row'; -import { Ping } from '../../../../common/runtime_types'; +import { Ping } from '../../../../../common/runtime_types'; import { DocLinkForBody } from './doc_link_body'; describe('PingListExpandedRow', () => { diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_list/expanded_row.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/expanded_row.tsx similarity index 97% rename from x-pack/plugins/synthetics/public/components/monitor/ping_list/expanded_row.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/expanded_row.tsx index 3e14136ac3533..0d27d7cbb92b9 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/ping_list/expanded_row.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/expanded_row.tsx @@ -18,7 +18,7 @@ import { } from '@elastic/eui'; import React from 'react'; import { i18n } from '@kbn/i18n'; -import { Ping, HttpResponseBody } from '../../../../common/runtime_types'; +import { Ping, HttpResponseBody } from '../../../../../common/runtime_types'; import { DocLinkForBody } from './doc_link_body'; import { PingRedirects } from './ping_redirects'; import { PingHeaders } from './headers'; diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_list/headers.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/headers.tsx similarity index 94% rename from x-pack/plugins/synthetics/public/components/monitor/ping_list/headers.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/headers.tsx index edc8119dd59d3..bff0e91f2cd05 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/ping_list/headers.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/headers.tsx @@ -8,7 +8,7 @@ import React from 'react'; import { EuiAccordion, EuiDescriptionList, EuiSpacer, EuiText } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; -import { PingHeaders as HeadersProp } from '../../../../common/runtime_types'; +import { PingHeaders as HeadersProp } from '../../../../../common/runtime_types'; interface Props { headers: HeadersProp; diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_list/index.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/index.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ping_list/index.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/index.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_list/location_name.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/location_name.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ping_list/location_name.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/location_name.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_list/ping_headers.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/ping_headers.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ping_list/ping_headers.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/ping_headers.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_list/ping_list.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/ping_list.test.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/monitor/ping_list/ping_list.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/ping_list.test.tsx index bfcf359ac0525..ddb33e4dd5fea 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/ping_list/ping_list.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/ping_list.test.tsx @@ -7,7 +7,7 @@ import React from 'react'; import { formatDuration, PingList } from './ping_list'; -import { Ping, PingsResponse } from '../../../../common/runtime_types'; +import { Ping, PingsResponse } from '../../../../../common/runtime_types'; import { ExpandedRowMap } from '../../overview/monitor_list/types'; import { rowShouldExpand, toggleDetails } from './columns/expand_row'; import * as pingListHook from './use_pings'; diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_list/ping_list.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/ping_list.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ping_list/ping_list.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/ping_list.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_list/ping_list_header.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/ping_list_header.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ping_list/ping_list_header.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/ping_list_header.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_list/ping_list_table.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/ping_list_table.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/monitor/ping_list/ping_list_table.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/ping_list_table.tsx index da464b7e1a083..1dbda32925161 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/ping_list/ping_list_table.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/ping_list_table.tsx @@ -12,11 +12,11 @@ import moment from 'moment'; import { useHistory } from 'react-router-dom'; import { useDispatch } from 'react-redux'; import * as I18LABELS from './translations'; -import { FailedStepsApiResponse, Ping } from '../../../../common/runtime_types'; +import { FailedStepsApiResponse, Ping } from '../../../../../common/runtime_types'; import { PingStatusColumn } from './columns/ping_status'; import { ERROR_LABEL, LOCATION_LABEL, RES_CODE_LABEL, TIMESTAMP_LABEL } from './translations'; import { LocationName } from './location_name'; -import { MONITOR_TYPES } from '../../../../common/constants'; +import { MONITOR_TYPES } from '../../../../../common/constants'; import { PingTimestamp } from './columns/ping_timestamp'; import { getShortTimeStamp } from '../../overview/monitor_list/columns/monitor_status_column'; import { PingErrorCol } from './columns/ping_error'; diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_list/ping_redirects.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/ping_redirects.tsx similarity index 97% rename from x-pack/plugins/synthetics/public/components/monitor/ping_list/ping_redirects.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/ping_redirects.tsx index 37e5961305a60..365a52e8f54fe 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/ping_list/ping_redirects.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/ping_redirects.tsx @@ -9,7 +9,7 @@ import React from 'react'; import { i18n } from '@kbn/i18n'; import styled from 'styled-components'; import { EuiListGroup, EuiListGroupItemProps, EuiPanel, EuiSpacer, EuiText } from '@elastic/eui'; -import { Ping } from '../../../../common/runtime_types/ping'; +import { Ping } from '../../../../../common/runtime_types/ping'; const ListGroup = styled(EuiListGroup)` &&& { diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_list/response_code.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/response_code.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ping_list/response_code.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/response_code.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_list/translations.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/translations.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/ping_list/translations.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/translations.ts diff --git a/x-pack/plugins/synthetics/public/components/monitor/ping_list/use_pings.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/use_pings.ts similarity index 94% rename from x-pack/plugins/synthetics/public/components/monitor/ping_list/use_pings.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/use_pings.ts index 94669b4aeb8e8..6306e8357018c 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/ping_list/use_pings.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/ping_list/use_pings.ts @@ -9,13 +9,13 @@ import { useDispatch, useSelector } from 'react-redux'; import { useCallback, useContext, useEffect } from 'react'; import { useFetcher } from '@kbn/observability-plugin/public'; import { selectPingList } from '../../../state/selectors'; -import { GetPingsParams, Ping } from '../../../../common/runtime_types/ping'; +import { GetPingsParams, Ping } from '../../../../../common/runtime_types/ping'; import { getPings as getPingsAction } from '../../../state/actions'; import { useGetUrlParams, useMonitorId } from '../../../hooks'; import { UptimeRefreshContext, UptimeSettingsContext } from '../../../contexts'; import { fetchJourneysFailedSteps } from '../../../state/api/journey'; import { useSelectedFilters } from '../../../hooks/use_selected_filters'; -import { MONITOR_TYPES } from '../../../../common/constants'; +import { MONITOR_TYPES } from '../../../../../common/constants'; interface Props { pageSize: number; diff --git a/x-pack/plugins/synthetics/public/components/monitor/status_details/__snapshots__/monitor_status.bar.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/__snapshots__/monitor_status.bar.test.tsx.snap similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/status_details/__snapshots__/monitor_status.bar.test.tsx.snap rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/__snapshots__/monitor_status.bar.test.tsx.snap diff --git a/x-pack/plugins/synthetics/public/components/monitor/status_details/__snapshots__/ssl_certificate.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/__snapshots__/ssl_certificate.test.tsx.snap similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/status_details/__snapshots__/ssl_certificate.test.tsx.snap rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/__snapshots__/ssl_certificate.test.tsx.snap diff --git a/x-pack/plugins/synthetics/public/components/monitor/status_details/__snapshots__/status_by_location.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/__snapshots__/status_by_location.test.tsx.snap similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/status_details/__snapshots__/status_by_location.test.tsx.snap rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/__snapshots__/status_by_location.test.tsx.snap diff --git a/x-pack/plugins/synthetics/public/components/monitor/status_details/availability_reporting/__snapshots__/tag_label.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/availability_reporting/__snapshots__/tag_label.test.tsx.snap similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/status_details/availability_reporting/__snapshots__/tag_label.test.tsx.snap rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/availability_reporting/__snapshots__/tag_label.test.tsx.snap diff --git a/x-pack/plugins/synthetics/public/components/monitor/status_details/availability_reporting/availability_reporting.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/availability_reporting/availability_reporting.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/status_details/availability_reporting/availability_reporting.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/availability_reporting/availability_reporting.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/status_details/availability_reporting/availability_reporting.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/availability_reporting/availability_reporting.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/status_details/availability_reporting/availability_reporting.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/availability_reporting/availability_reporting.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/status_details/availability_reporting/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/availability_reporting/index.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/status_details/availability_reporting/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/availability_reporting/index.ts diff --git a/x-pack/plugins/synthetics/public/components/monitor/status_details/availability_reporting/location_status_tags.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/availability_reporting/location_status_tags.test.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/monitor/status_details/availability_reporting/location_status_tags.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/availability_reporting/location_status_tags.test.tsx index e43df25779ab9..48862695b2089 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/status_details/availability_reporting/location_status_tags.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/availability_reporting/location_status_tags.test.tsx @@ -6,7 +6,7 @@ */ import React from 'react'; -import { MonitorLocation } from '../../../../../common/runtime_types/monitor'; +import { MonitorLocation } from '../../../../../../common/runtime_types/monitor'; import { LocationStatusTags } from '.'; import { mockMoment } from '../../../../lib/helper/test_helpers'; import { render } from '../../../../lib/helper/rtl_helpers'; diff --git a/x-pack/plugins/synthetics/public/components/monitor/status_details/availability_reporting/location_status_tags.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/availability_reporting/location_status_tags.tsx similarity index 95% rename from x-pack/plugins/synthetics/public/components/monitor/status_details/availability_reporting/location_status_tags.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/availability_reporting/location_status_tags.tsx index 53be56d16b9fe..b50b84235dad7 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/status_details/availability_reporting/location_status_tags.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/availability_reporting/location_status_tags.tsx @@ -9,8 +9,8 @@ import React, { useContext } from 'react'; import moment from 'moment'; import styled from 'styled-components'; import { UptimeThemeContext } from '../../../../contexts'; -import { MonitorLocation } from '../../../../../common/runtime_types'; -import { SHORT_TIMESPAN_LOCALE, SHORT_TS_LOCALE } from '../../../../../common/constants'; +import { MonitorLocation } from '../../../../../../common/runtime_types'; +import { SHORT_TIMESPAN_LOCALE, SHORT_TS_LOCALE } from '../../../../../../common/constants'; import { AvailabilityReporting } from '..'; import { getShortTimeStamp } from '../../../overview/monitor_list/columns/monitor_status_column'; diff --git a/x-pack/plugins/synthetics/public/components/monitor/status_details/availability_reporting/tag_label.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/availability_reporting/tag_label.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/status_details/availability_reporting/tag_label.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/availability_reporting/tag_label.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/status_details/availability_reporting/tag_label.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/availability_reporting/tag_label.tsx similarity index 92% rename from x-pack/plugins/synthetics/public/components/monitor/status_details/availability_reporting/tag_label.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/availability_reporting/tag_label.tsx index 6bf73b9609e58..8b920848cdc53 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/status_details/availability_reporting/tag_label.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/availability_reporting/tag_label.tsx @@ -9,7 +9,7 @@ import React from 'react'; import styled from 'styled-components'; import { EuiBadge } from '@elastic/eui'; import { StatusTag } from './location_status_tags'; -import { STATUS } from '../../../../../common/constants'; +import { STATUS } from '../../../../../../common/constants'; const BadgeItem = styled.div` white-space: nowrap; diff --git a/x-pack/plugins/synthetics/public/components/monitor/status_details/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/index.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/status_details/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/index.ts diff --git a/x-pack/plugins/synthetics/public/components/monitor/status_details/location_availability/location_availability.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/location_availability/location_availability.test.tsx similarity index 96% rename from x-pack/plugins/synthetics/public/components/monitor/status_details/location_availability/location_availability.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/location_availability/location_availability.test.tsx index 855b8ef0c9767..a09e3530d5081 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/status_details/location_availability/location_availability.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/location_availability/location_availability.test.tsx @@ -9,7 +9,7 @@ import React from 'react'; import { screen } from '@testing-library/react'; import { render } from '../../../../lib/helper/rtl_helpers'; import { LocationAvailability } from './location_availability'; -import { MonitorLocations } from '../../../../../common/runtime_types'; +import { MonitorLocations } from '../../../../../../common/runtime_types'; // Note For shallow test, we need absolute time strings describe('LocationAvailability component', () => { diff --git a/x-pack/plugins/synthetics/public/components/monitor/status_details/location_availability/location_availability.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/location_availability/location_availability.tsx similarity index 94% rename from x-pack/plugins/synthetics/public/components/monitor/status_details/location_availability/location_availability.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/location_availability/location_availability.tsx index c851369d63e9e..f7634c77eb017 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/status_details/location_availability/location_availability.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/location_availability/location_availability.tsx @@ -9,7 +9,7 @@ import React from 'react'; import styled from 'styled-components'; import { EuiFlexGroup, EuiFlexItem, EuiErrorBoundary, EuiTitle } from '@elastic/eui'; import { LocationStatusTags } from '../availability_reporting'; -import { MonitorLocations } from '../../../../../common/runtime_types'; +import { MonitorLocations } from '../../../../../../common/runtime_types'; import { MonitoringFrom } from '../translations'; const EuiFlexItemTags = styled(EuiFlexItem)` diff --git a/x-pack/plugins/synthetics/public/components/monitor/status_details/monitor_status.bar.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/monitor_status.bar.test.tsx similarity index 96% rename from x-pack/plugins/synthetics/public/components/monitor/status_details/monitor_status.bar.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/monitor_status.bar.test.tsx index af3c47b9caf30..640d207fbb138 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/status_details/monitor_status.bar.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/monitor_status.bar.test.tsx @@ -8,7 +8,7 @@ import moment from 'moment'; import React from 'react'; import { MonitorStatusBar } from './status_bar'; -import { Ping } from '../../../../common/runtime_types'; +import { Ping } from '../../../../../common/runtime_types'; import * as redux from 'react-redux'; import { renderWithRouter } from '../../../lib'; import { createMemoryHistory } from 'history'; diff --git a/x-pack/plugins/synthetics/public/components/monitor/status_details/ssl_certificate.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/ssl_certificate.test.tsx similarity index 95% rename from x-pack/plugins/synthetics/public/components/monitor/status_details/ssl_certificate.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/ssl_certificate.test.tsx index 03ce292e63621..3951ced34c0f9 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/status_details/ssl_certificate.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/ssl_certificate.test.tsx @@ -8,11 +8,11 @@ import React from 'react'; import moment from 'moment'; import { EuiIcon } from '@elastic/eui'; -import { Tls } from '../../../../common/runtime_types'; +import { Tls } from '../../../../../common/runtime_types'; import { MonitorSSLCertificate } from './status_bar'; import * as redux from 'react-redux'; import { mountWithRouter, renderWithRouter, shallowWithRouter } from '../../../lib'; -import { DYNAMIC_SETTINGS_DEFAULTS } from '../../../../common/constants'; +import { DYNAMIC_SETTINGS_DEFAULTS } from '../../../../../common/constants'; describe('SSL Certificate component', () => { let monitorTls: Tls; diff --git a/x-pack/plugins/synthetics/public/components/monitor/status_details/status_bar/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/status_bar/index.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/status_details/status_bar/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/status_bar/index.ts diff --git a/x-pack/plugins/synthetics/public/components/monitor/status_details/status_bar/monitor_redirects.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/status_bar/monitor_redirects.tsx similarity index 96% rename from x-pack/plugins/synthetics/public/components/monitor/status_details/status_bar/monitor_redirects.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/status_bar/monitor_redirects.tsx index f59f01e6aef33..2f1dba51bb933 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/status_details/status_bar/monitor_redirects.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/status_bar/monitor_redirects.tsx @@ -9,7 +9,7 @@ import React, { useState } from 'react'; import { i18n } from '@kbn/i18n'; import { EuiPopover } from '@elastic/eui'; import styled from 'styled-components'; -import { Ping } from '../../../../../common/runtime_types'; +import { Ping } from '../../../../../../common/runtime_types'; import { PingRedirects } from '../../ping_list/ping_redirects'; import { MonListDescription, MonListTitle } from './status_bar'; diff --git a/x-pack/plugins/synthetics/public/components/monitor/status_details/status_bar/ssl_certificate.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/status_bar/ssl_certificate.tsx similarity index 91% rename from x-pack/plugins/synthetics/public/components/monitor/status_details/status_bar/ssl_certificate.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/status_bar/ssl_certificate.tsx index 13be917075aca..5d421cbd4a448 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/status_details/status_bar/ssl_certificate.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/status_bar/ssl_certificate.tsx @@ -9,8 +9,8 @@ import React from 'react'; import { Link } from 'react-router-dom'; import { EuiSpacer } from '@elastic/eui'; import { FormattedMessage } from '@kbn/i18n-react'; -import { Tls, X509Expiry } from '../../../../../common/runtime_types'; -import { CERTIFICATES_ROUTE } from '../../../../../common/constants'; +import { Tls, X509Expiry } from '../../../../../../common/runtime_types'; +import { CERTIFICATES_ROUTE } from '../../../../../../common/constants'; import { MonListDescription, MonListTitle } from './status_bar'; import { CertStatusColumn } from '../../../overview/monitor_list/columns/cert_status_column'; diff --git a/x-pack/plugins/synthetics/public/components/monitor/status_details/status_bar/status_bar.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/status_bar/status_bar.test.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/status_details/status_bar/status_bar.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/status_bar/status_bar.test.ts diff --git a/x-pack/plugins/synthetics/public/components/monitor/status_details/status_bar/status_bar.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/status_bar/status_bar.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/monitor/status_details/status_bar/status_bar.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/status_bar/status_bar.tsx index 9746a6c676ab5..7ca855bc0a697 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/status_details/status_bar/status_bar.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/status_bar/status_bar.tsx @@ -22,7 +22,7 @@ import { StatusByLocations } from './status_by_location'; import { useStatusBar } from './use_status_bar'; import { MonitorIDLabel, OverallAvailability } from '../translations'; import { TAGS_LABEL, URL_LABEL } from '../../../common/translations'; -import { MonitorLocations } from '../../../../../common/runtime_types/monitor'; +import { MonitorLocations } from '../../../../../../common/runtime_types/monitor'; import { formatAvailabilityValue } from '../availability_reporting/availability_reporting'; import { MonitorRedirects } from './monitor_redirects'; import { MonitorTags } from '../../../common/monitor_tags'; diff --git a/x-pack/plugins/synthetics/public/components/monitor/status_details/status_bar/status_by_location.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/status_bar/status_by_location.tsx similarity index 96% rename from x-pack/plugins/synthetics/public/components/monitor/status_details/status_bar/status_by_location.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/status_bar/status_by_location.tsx index 60cd231a401c0..3296e784d621a 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/status_details/status_bar/status_by_location.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/status_bar/status_by_location.tsx @@ -8,7 +8,7 @@ import React from 'react'; import { EuiTitle } from '@elastic/eui'; import { FormattedMessage } from '@kbn/i18n-react'; -import { MonitorLocation } from '../../../../../common/runtime_types'; +import { MonitorLocation } from '../../../../../../common/runtime_types'; interface StatusByLocationsProps { locations: MonitorLocation[]; diff --git a/x-pack/plugins/synthetics/public/components/monitor/status_details/status_bar/use_status_bar.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/status_bar/use_status_bar.ts similarity index 90% rename from x-pack/plugins/synthetics/public/components/monitor/status_details/status_bar/use_status_bar.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/status_bar/use_status_bar.ts index 058227d1db1eb..57de00af67081 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/status_details/status_bar/use_status_bar.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/status_bar/use_status_bar.ts @@ -12,8 +12,8 @@ import { useGetUrlParams, useMonitorId } from '../../../../hooks'; import { monitorLocationsSelector, monitorStatusSelector } from '../../../../state/selectors'; import { AppState } from '../../../../state'; import { getMonitorStatusAction } from '../../../../state/actions'; -import { Ping } from '../../../../../common/runtime_types/ping'; -import { MonitorLocations } from '../../../../../common/runtime_types/monitor'; +import { Ping } from '../../../../../../common/runtime_types/ping'; +import { MonitorLocations } from '../../../../../../common/runtime_types/monitor'; interface MonitorStatusBarProps { monitorId: string; diff --git a/x-pack/plugins/synthetics/public/components/monitor/status_details/status_by_location.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/status_by_location.test.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/monitor/status_details/status_by_location.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/status_by_location.test.tsx index 9b58b0deb8ecc..0b3b08cba8343 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/status_details/status_by_location.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/status_by_location.test.tsx @@ -7,7 +7,7 @@ import React from 'react'; import { renderWithIntl, shallowWithIntl } from '@kbn/test-jest-helpers'; -import { MonitorLocation } from '../../../../common/runtime_types'; +import { MonitorLocation } from '../../../../../common/runtime_types'; import { StatusByLocations } from '.'; describe('StatusByLocation component', () => { diff --git a/x-pack/plugins/synthetics/public/components/monitor/status_details/status_details.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/status_details.tsx similarity index 96% rename from x-pack/plugins/synthetics/public/components/monitor/status_details/status_details.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/status_details.tsx index 5b20e83f0ec85..0c9c347fc8c80 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/status_details/status_details.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/status_details.tsx @@ -10,7 +10,7 @@ import { EuiFlexGroup, EuiFlexItem, EuiPanel } from '@elastic/eui'; import styled from 'styled-components'; import { LocationAvailability } from './location_availability/location_availability'; import { UptimeRefreshContext } from '../../../contexts'; -import { MonitorLocations } from '../../../../common/runtime_types'; +import { MonitorLocations } from '../../../../../common/runtime_types'; import { MonitorStatusBar } from './status_bar'; interface MonitorStatusDetailsProps { diff --git a/x-pack/plugins/synthetics/public/components/monitor/status_details/status_details_container.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/status_details_container.tsx similarity index 95% rename from x-pack/plugins/synthetics/public/components/monitor/status_details/status_details_container.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/status_details_container.tsx index 1fb138da9e84b..7affbde63ba02 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/status_details/status_details_container.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/status_details_container.tsx @@ -13,7 +13,7 @@ import { getMonitorLocationsAction } from '../../../state/actions/monitor'; import { MonitorStatusDetailsComponent } from '.'; import { UptimeRefreshContext } from '../../../contexts'; import { AppState } from '../../../state'; -import { MonitorIdParam } from '../../../../common/types'; +import { MonitorIdParam } from '../../../../../common/types'; export const MonitorStatusDetails: React.FC = ({ monitorId }) => { const { lastRefresh } = useContext(UptimeRefreshContext); diff --git a/x-pack/plugins/synthetics/public/components/monitor/status_details/translations.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/translations.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/status_details/translations.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/status_details/translations.ts diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/step_detail_container.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/step_detail_container.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/step_detail_container.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/step_detail_container.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/step_page_nav.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/step_page_nav.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/step_page_nav.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/step_page_nav.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/step_page_title.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/step_page_title.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/step_page_title.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/step_page_title.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/use_monitor_breadcrumb.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/use_monitor_breadcrumb.tsx similarity index 96% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/use_monitor_breadcrumb.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/use_monitor_breadcrumb.tsx index 0d7b5894799c7..013516bb754bf 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/use_monitor_breadcrumb.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/use_monitor_breadcrumb.tsx @@ -10,7 +10,7 @@ import { i18n } from '@kbn/i18n'; import { useKibana } from '@kbn/kibana-react-plugin/public'; import { useBreadcrumbs } from '../../../../hooks/use_breadcrumbs'; import { JourneyState } from '../../../../state/reducers/journey'; -import { PLUGIN } from '../../../../../common/constants/plugin'; +import { PLUGIN } from '../../../../../../common/constants/plugin'; import { getShortTimeStamp } from '../../../overview/monitor_list/columns/monitor_status_column'; interface ActiveStep { diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/use_monitor_breadcrumbs.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/use_monitor_breadcrumbs.test.tsx similarity index 97% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/use_monitor_breadcrumbs.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/use_monitor_breadcrumbs.test.tsx index a46fad2733bb2..2ae975803b524 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/use_monitor_breadcrumbs.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/use_monitor_breadcrumbs.test.tsx @@ -11,8 +11,8 @@ import { Route } from 'react-router-dom'; import { of } from 'rxjs'; import { render } from '../../../../lib/helper/rtl_helpers'; import { useMonitorBreadcrumb } from './use_monitor_breadcrumb'; -import { OVERVIEW_ROUTE } from '../../../../../common/constants'; -import { Ping } from '../../../../../common/runtime_types/ping'; +import { OVERVIEW_ROUTE } from '../../../../../../common/constants'; +import { Ping } from '../../../../../../common/runtime_types/ping'; import { JourneyState } from '../../../../state/reducers/journey'; import { chromeServiceMock, uiSettingsServiceMock } from '@kbn/core/public/mocks'; diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/use_step_waterfall_metrics.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/use_step_waterfall_metrics.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/use_step_waterfall_metrics.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/use_step_waterfall_metrics.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/use_step_waterfall_metrics.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/use_step_waterfall_metrics.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/use_step_waterfall_metrics.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/use_step_waterfall_metrics.ts diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/waterfall/data_formatting.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/waterfall/data_formatting.test.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/waterfall/data_formatting.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/waterfall/data_formatting.test.ts diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/waterfall/data_formatting.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/waterfall/data_formatting.ts similarity index 99% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/waterfall/data_formatting.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/waterfall/data_formatting.ts index fa3db4d01fe9b..7323668dc3d52 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/waterfall/data_formatting.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/waterfall/data_formatting.ts @@ -23,7 +23,7 @@ import { LegendItems, } from './types'; import { WaterfallData, WaterfallMetadata } from '../../waterfall'; -import { NetworkEvent } from '../../../../../../common/runtime_types'; +import { NetworkEvent } from '../../../../../../../common/runtime_types'; export const extractItems = (data: NetworkEvent[]): NetworkItems => { // NOTE: This happens client side as the "payload" property is mapped diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/waterfall/types.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/waterfall/types.ts similarity index 98% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/waterfall/types.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/waterfall/types.ts index 19ae847ee3adb..c396bec47e0e6 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/waterfall/types.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/waterfall/types.ts @@ -6,7 +6,7 @@ */ import { i18n } from '@kbn/i18n'; -import { NetworkEvent } from '../../../../../../common/runtime_types'; +import { NetworkEvent } from '../../../../../../../common/runtime_types'; export enum Timings { Blocked = 'blocked', diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/waterfall/waterfall_chart_container.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/waterfall/waterfall_chart_container.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/waterfall/waterfall_chart_container.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/waterfall/waterfall_chart_container.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/waterfall/waterfall_chart_container.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/waterfall/waterfall_chart_container.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/waterfall/waterfall_chart_container.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/waterfall/waterfall_chart_container.tsx index b31af8e31d33a..95c42d505fbf2 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/waterfall/waterfall_chart_container.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/waterfall/waterfall_chart_container.tsx @@ -15,7 +15,7 @@ import { networkEventsSelector } from '../../../../../state/selectors'; import { WaterfallChartWrapper } from './waterfall_chart_wrapper'; import { extractItems } from './data_formatting'; import { useStepWaterfallMetrics } from '../use_step_waterfall_metrics'; -import { JourneyStep } from '../../../../../../common/runtime_types'; +import { JourneyStep } from '../../../../../../../common/runtime_types'; export const NO_DATA_TEXT = i18n.translate( 'xpack.synthetics.synthetics.stepDetail.waterfallNoData', diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/waterfall/waterfall_chart_wrapper.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/waterfall/waterfall_chart_wrapper.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/waterfall/waterfall_chart_wrapper.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/waterfall/waterfall_chart_wrapper.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/waterfall/waterfall_chart_wrapper.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/waterfall/waterfall_chart_wrapper.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/waterfall/waterfall_chart_wrapper.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/waterfall/waterfall_chart_wrapper.tsx index 4b50f86e6ee3b..0849832107aeb 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/waterfall/waterfall_chart_wrapper.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/waterfall/waterfall_chart_wrapper.tsx @@ -15,7 +15,7 @@ import { WaterfallFilter } from './waterfall_filter'; import { WaterfallFlyout } from './waterfall_flyout'; import { WaterfallSidebarItem } from './waterfall_sidebar_item'; import { MarkerItems } from '../../waterfall/context/waterfall_chart'; -import { JourneyStep } from '../../../../../../common/runtime_types'; +import { JourneyStep } from '../../../../../../../common/runtime_types'; export const renderLegendItem: RenderItem = (item) => { return ( diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/waterfall/waterfall_filter.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/waterfall/waterfall_filter.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/waterfall/waterfall_filter.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/waterfall/waterfall_filter.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/waterfall/waterfall_filter.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/waterfall/waterfall_filter.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/waterfall/waterfall_filter.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/waterfall/waterfall_filter.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/waterfall/waterfall_flyout.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/waterfall/waterfall_flyout.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/waterfall/waterfall_flyout.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/waterfall/waterfall_flyout.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/waterfall/waterfall_flyout.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/waterfall/waterfall_flyout.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/waterfall/waterfall_flyout.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/waterfall/waterfall_flyout.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/waterfall/waterfall_sidebar_item.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/waterfall/waterfall_sidebar_item.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/waterfall/waterfall_sidebar_item.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/waterfall/waterfall_sidebar_item.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/waterfall/waterfall_sidebar_item.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/waterfall/waterfall_sidebar_item.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/step_detail/waterfall/waterfall_sidebar_item.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/step_detail/waterfall/waterfall_sidebar_item.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/translations.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/translations.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/translations.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/translations.ts diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/README.md b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/README.md similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/README.md rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/README.md diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/constants.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/constants.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/constants.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/constants.ts diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/legend.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/legend.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/legend.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/legend.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/middle_truncated_text.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/middle_truncated_text.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/middle_truncated_text.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/middle_truncated_text.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/middle_truncated_text.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/middle_truncated_text.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/middle_truncated_text.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/middle_truncated_text.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/network_requests_total.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/network_requests_total.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/network_requests_total.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/network_requests_total.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/network_requests_total.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/network_requests_total.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/network_requests_total.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/network_requests_total.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/sidebar.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/sidebar.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/sidebar.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/sidebar.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/styles.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/styles.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/styles.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/styles.ts diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/translations.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/translations.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/translations.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/translations.ts diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/use_bar_charts.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/use_bar_charts.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/use_bar_charts.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/use_bar_charts.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/use_bar_charts.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/use_bar_charts.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/use_bar_charts.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/use_bar_charts.ts diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/use_flyout.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/use_flyout.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/use_flyout.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/use_flyout.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/use_flyout.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/use_flyout.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/use_flyout.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/use_flyout.ts diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/waterfall.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/waterfall.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/waterfall.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/waterfall.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/waterfall_bar_chart.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/waterfall_bar_chart.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/waterfall_bar_chart.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/waterfall_bar_chart.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/waterfall_chart.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/waterfall_chart.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/waterfall_chart.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/waterfall_chart.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/waterfall_chart_fixed_axis.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/waterfall_chart_fixed_axis.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/waterfall_chart_fixed_axis.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/waterfall_chart_fixed_axis.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/waterfall_flyout_table.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/waterfall_flyout_table.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/waterfall_flyout_table.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/waterfall_flyout_table.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/waterfall_marker_icon.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/waterfall_marker_icon.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/waterfall_marker_icon.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/waterfall_marker_icon.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/waterfall_marker_icon.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/waterfall_marker_icon.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/waterfall_marker_icon.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/waterfall_marker_icon.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/waterfall_marker_test_helper.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/waterfall_marker_test_helper.tsx similarity index 95% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/waterfall_marker_test_helper.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/waterfall_marker_test_helper.tsx index 696e6d4fa022f..691a74361d074 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/waterfall_marker_test_helper.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/waterfall_marker_test_helper.tsx @@ -8,7 +8,7 @@ import React from 'react'; import { UptimeStartupPluginsContext } from '../../../../../contexts'; import { WaterfallContext } from '../context/waterfall_chart'; -import { JourneyStep } from '../../../../../../common/runtime_types'; +import { JourneyStep } from '../../../../../../../common/runtime_types'; const EmbeddableMock = ({ title, diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/waterfall_marker_trend.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/waterfall_marker_trend.test.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/waterfall_marker_trend.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/waterfall_marker_trend.test.tsx index b797cf1f3b63e..aeca7940ef773 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/waterfall_marker_trend.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/waterfall_marker_trend.test.tsx @@ -9,7 +9,7 @@ import React from 'react'; import { render } from '../../../../../lib/helper/rtl_helpers'; import { WaterfallMarkerTrend } from './waterfall_marker_trend'; import moment from 'moment'; -import { JourneyStep } from '../../../../../../common/runtime_types'; +import { JourneyStep } from '../../../../../../../common/runtime_types'; import { TestWrapper } from './waterfall_marker_test_helper'; describe('', () => { diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/waterfall_marker_trend.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/waterfall_marker_trend.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/waterfall_marker_trend.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/waterfall_marker_trend.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/waterfall_markers.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/waterfall_markers.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/waterfall_markers.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/waterfall_markers.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/waterfall_tooltip_content.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/waterfall_tooltip_content.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/waterfall_tooltip_content.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/waterfall_tooltip_content.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/waterfall_tooltip_content.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/waterfall_tooltip_content.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/components/waterfall_tooltip_content.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/components/waterfall_tooltip_content.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/context/waterfall_chart.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/context/waterfall_chart.tsx similarity index 97% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/context/waterfall_chart.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/context/waterfall_chart.tsx index d495b7432bce7..fd38fbbfb6bb6 100644 --- a/x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/context/waterfall_chart.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/context/waterfall_chart.tsx @@ -9,7 +9,7 @@ import React, { createContext, useContext, Context } from 'react'; import { WaterfallData, WaterfallDataEntry, WaterfallMetadata } from '../types'; import { OnSidebarClick, OnElementClick, OnProjectionClick } from '../components/use_flyout'; import { SidebarItems } from '../../step_detail/waterfall/types'; -import { JourneyStep } from '../../../../../../common/runtime_types'; +import { JourneyStep } from '../../../../../../../common/runtime_types'; export type MarkerItems = Array<{ id: diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/index.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/index.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/index.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/index.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/types.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/types.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor/synthetics/waterfall/types.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor/synthetics/waterfall/types.ts diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/action_bar/action_bar.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/action_bar/action_bar.test.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/monitor_management/action_bar/action_bar.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/action_bar/action_bar.test.tsx index 64b7984b00b40..e903f4d23424b 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/action_bar/action_bar.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/action_bar/action_bar.test.tsx @@ -15,7 +15,7 @@ import { HTTPFields, ScheduleUnit, SyntheticsMonitor, -} from '../../../../common/runtime_types'; +} from '../../../../../common/runtime_types'; import { ActionBar } from './action_bar'; describe('', () => { diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/action_bar/action_bar.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/action_bar/action_bar.tsx similarity index 97% rename from x-pack/plugins/synthetics/public/components/monitor_management/action_bar/action_bar.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/action_bar/action_bar.tsx index a3eec01438876..80e614eb4d77f 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/action_bar/action_bar.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/action_bar/action_bar.tsx @@ -21,11 +21,11 @@ import { useSelector } from 'react-redux'; import { FETCH_STATUS, useFetcher } from '@kbn/observability-plugin/public'; import { euiStyled } from '@kbn/kibana-react-plugin/common'; -import { MONITOR_MANAGEMENT_ROUTE } from '../../../../common/constants'; +import { MONITOR_MANAGEMENT_ROUTE } from '../../../../../common/constants'; import { UptimeSettingsContext } from '../../../contexts'; import { setMonitor } from '../../../state/api'; -import { SyntheticsMonitor } from '../../../../common/runtime_types'; +import { SyntheticsMonitor } from '../../../../../common/runtime_types'; import { TestRun } from '../test_now_mode/test_now_mode'; import { monitorManagementListSelector } from '../../../state/selectors'; @@ -65,7 +65,7 @@ export const ActionBar = ({ } return setMonitor({ monitor, - id: monitorId ? Buffer.from(monitorId, 'base64').toString('utf8') : undefined, + id: monitorId, }); }, [monitor, monitorId, isValid, isSaving]); diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/action_bar/action_bar_errors.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/action_bar/action_bar_errors.test.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/monitor_management/action_bar/action_bar_errors.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/action_bar/action_bar_errors.test.tsx index b92357f3ecc14..bb40077dab78d 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/action_bar/action_bar_errors.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/action_bar/action_bar_errors.test.tsx @@ -15,7 +15,7 @@ import { HTTPFields, ScheduleUnit, SyntheticsMonitor, -} from '../../../../common/runtime_types'; +} from '../../../../../common/runtime_types'; import { spyOnUseFetcher } from '../../../lib/helper/spy_use_fetcher'; import * as kibana from '../../../state/kibana_service'; import { ActionBar } from './action_bar'; diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/action_bar/action_bar_portal.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/action_bar/action_bar_portal.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor_management/action_bar/action_bar_portal.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/action_bar/action_bar_portal.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/add_monitor_btn.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/add_monitor_btn.tsx similarity index 99% rename from x-pack/plugins/synthetics/public/components/monitor_management/add_monitor_btn.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/add_monitor_btn.tsx index 3532659f04af2..90bec2d28f988 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/add_monitor_btn.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/add_monitor_btn.tsx @@ -11,7 +11,7 @@ import { EuiButton, EuiFlexItem, EuiFlexGroup, EuiToolTip, EuiSwitch } from '@el import { useHistory } from 'react-router-dom'; import { useKibana } from '@kbn/kibana-react-plugin/public'; import { kibanaService } from '../../state/kibana_service'; -import { MONITOR_ADD_ROUTE } from '../../../common/constants'; +import { MONITOR_ADD_ROUTE } from '../../../../common/constants'; import { useEnablement } from './hooks/use_enablement'; import { useSyntheticsServiceAllowed } from './hooks/use_service_allowed'; diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/content/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/content/index.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor_management/content/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/content/index.ts diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/edit_monitor_config.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/edit_monitor_config.tsx similarity index 96% rename from x-pack/plugins/synthetics/public/components/monitor_management/edit_monitor_config.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/edit_monitor_config.tsx index 28e0bb105e29a..245f058c48d94 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/edit_monitor_config.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/edit_monitor_config.tsx @@ -14,11 +14,11 @@ import { DataStream, ScheduleUnit, ThrottlingOptions, -} from '../../../common/runtime_types'; +} from '../../../../common/runtime_types'; import { SyntheticsProviders } from '../fleet_package/contexts'; import { PolicyConfig } from '../fleet_package/types'; import { MonitorConfig } from './monitor_config/monitor_config'; -import { DEFAULT_NAMESPACE_STRING } from '../../../common/constants'; +import { DEFAULT_NAMESPACE_STRING } from '../../../../common/constants/monitor_defaults'; interface Props { monitor: MonitorFields; diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/hooks/use_enablement.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/hooks/use_enablement.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor_management/hooks/use_enablement.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/hooks/use_enablement.ts diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/hooks/use_format_monitor.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/hooks/use_format_monitor.ts similarity index 94% rename from x-pack/plugins/synthetics/public/components/monitor_management/hooks/use_format_monitor.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/hooks/use_format_monitor.ts index 49d467d7b8799..5d600a10daf39 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/hooks/use_format_monitor.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/hooks/use_format_monitor.ts @@ -6,8 +6,8 @@ */ import { useEffect, useRef, useState } from 'react'; -import { ConfigKey, DataStream, MonitorFields } from '../../../../common/runtime_types'; -import { Validation } from '../../../../common/types'; +import { ConfigKey, DataStream, MonitorFields } from '../../../../../common/runtime_types'; +import { Validation } from '../../../../../common/types'; interface Props { monitorType: DataStream; diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/hooks/use_inline_errors.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/hooks/use_inline_errors.test.tsx similarity index 97% rename from x-pack/plugins/synthetics/public/components/monitor_management/hooks/use_inline_errors.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/hooks/use_inline_errors.test.tsx index fe20dc3ea6c9d..ebc9b55556d40 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/hooks/use_inline_errors.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/hooks/use_inline_errors.test.tsx @@ -8,7 +8,7 @@ import { renderHook } from '@testing-library/react-hooks'; import { MockRedux } from '../../../lib/helper/rtl_helpers'; import { useInlineErrors } from './use_inline_errors'; -import { DEFAULT_THROTTLING } from '../../../../common/runtime_types'; +import { DEFAULT_THROTTLING } from '../../../../../common/runtime_types'; import * as obsvPlugin from '@kbn/observability-plugin/public/hooks/use_es_search'; function mockNow(date: string | number | Date) { diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/hooks/use_inline_errors.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/hooks/use_inline_errors.ts similarity index 92% rename from x-pack/plugins/synthetics/public/components/monitor_management/hooks/use_inline_errors.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/hooks/use_inline_errors.ts index adc07853a93cd..9970622ca416b 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/hooks/use_inline_errors.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/hooks/use_inline_errors.ts @@ -10,11 +10,11 @@ import moment from 'moment'; import { useMemo } from 'react'; import { useEsSearch } from '@kbn/observability-plugin/public'; import { monitorManagementListSelector } from '../../../state/selectors'; -import { Ping } from '../../../../common/runtime_types'; -import { EXCLUDE_RUN_ONCE_FILTER } from '../../../../common/constants/client_defaults'; +import { Ping } from '../../../../../common/runtime_types'; +import { EXCLUDE_RUN_ONCE_FILTER } from '../../../../../common/constants/client_defaults'; import { useUptimeRefreshContext } from '../../../contexts/uptime_refresh_context'; import { useInlineErrorsCount } from './use_inline_errors_count'; -import { SYNTHETICS_INDEX_PATTERN } from '../../../../common/constants'; +import { SYNTHETICS_INDEX_PATTERN } from '../../../../../common/constants'; const sortFieldMap: Record = { ['name.keyword']: 'monitor.name', diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/hooks/use_inline_errors_count.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/hooks/use_inline_errors_count.test.tsx similarity index 97% rename from x-pack/plugins/synthetics/public/components/monitor_management/hooks/use_inline_errors_count.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/hooks/use_inline_errors_count.test.tsx index 7ad0d58488e99..b1dbb41880e65 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/hooks/use_inline_errors_count.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/hooks/use_inline_errors_count.test.tsx @@ -9,7 +9,7 @@ import { renderHook } from '@testing-library/react-hooks'; import { MockRedux } from '../../../lib/helper/rtl_helpers'; import { useInlineErrorsCount } from './use_inline_errors_count'; import * as obsvPlugin from '@kbn/observability-plugin/public/hooks/use_es_search'; -import { DEFAULT_THROTTLING } from '../../../../common/runtime_types'; +import { DEFAULT_THROTTLING } from '../../../../../common/runtime_types'; function mockNow(date: string | number | Date) { const fakeNow = new Date(date).getTime(); diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/hooks/use_inline_errors_count.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/hooks/use_inline_errors_count.ts similarity index 94% rename from x-pack/plugins/synthetics/public/components/monitor_management/hooks/use_inline_errors_count.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/hooks/use_inline_errors_count.ts index 64b37d371cac5..dc69346e6c9a5 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/hooks/use_inline_errors_count.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/hooks/use_inline_errors_count.ts @@ -11,7 +11,7 @@ import { useEsSearch } from '@kbn/observability-plugin/public'; import { monitorManagementListSelector } from '../../../state/selectors'; import { useUptimeRefreshContext } from '../../../contexts/uptime_refresh_context'; import { getInlineErrorFilters } from './use_inline_errors'; -import { SYNTHETICS_INDEX_PATTERN } from '../../../../common/constants'; +import { SYNTHETICS_INDEX_PATTERN } from '../../../../../common/constants'; export function useInlineErrorsCount() { const monitorList = useSelector(monitorManagementListSelector); diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/hooks/use_invalid_monitors.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/hooks/use_invalid_monitors.tsx similarity index 90% rename from x-pack/plugins/synthetics/public/components/monitor_management/hooks/use_invalid_monitors.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/hooks/use_invalid_monitors.tsx index cf63e7c4cd9e6..38e45e9a839d3 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/hooks/use_invalid_monitors.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/hooks/use_invalid_monitors.tsx @@ -8,8 +8,8 @@ import moment from 'moment'; import { useKibana } from '@kbn/kibana-react-plugin/public'; import { useFetcher } from '@kbn/observability-plugin/public'; -import { Ping, SyntheticsMonitor } from '../../../../common/runtime_types'; -import { syntheticsMonitorType } from '../../../../common/types/saved_objects'; +import { Ping, SyntheticsMonitor } from '../../../../../common/runtime_types'; +import { syntheticsMonitorType } from '../../../../../common/types/saved_objects'; export const useInvalidMonitors = (errorSummaries?: Ping[]) => { const { savedObjects } = useKibana().services; diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/hooks/use_locations.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/hooks/use_locations.test.tsx similarity index 96% rename from x-pack/plugins/synthetics/public/components/monitor_management/hooks/use_locations.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/hooks/use_locations.test.tsx index 46b8981b74a0f..020dea1209dff 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/hooks/use_locations.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/hooks/use_locations.test.tsx @@ -14,7 +14,7 @@ import { useLocations } from './use_locations'; import * as reactRedux from 'react-redux'; import { getServiceLocations } from '../../../state/actions'; -import { DEFAULT_THROTTLING } from '../../../../common/runtime_types'; +import { DEFAULT_THROTTLING } from '../../../../../common/runtime_types'; describe('useExpViewTimeRange', function () { const dispatch = jest.fn(); diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/hooks/use_locations.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/hooks/use_locations.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor_management/hooks/use_locations.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/hooks/use_locations.ts diff --git a/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/hooks/use_monitor_list.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/hooks/use_monitor_list.ts new file mode 100644 index 0000000000000..e0899571f38b8 --- /dev/null +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/hooks/use_monitor_list.ts @@ -0,0 +1,67 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { useEffect, useReducer, Reducer } from 'react'; +import { useDispatch } from 'react-redux'; +import { useParams } from 'react-router-dom'; +import { getMonitors } from '../../../state/actions'; +import { ConfigKey } from '../../../../../common/constants/monitor_management'; +import { MonitorManagementListPageState } from '../monitor_list/monitor_list'; + +export function useMonitorList() { + const dispatch = useDispatch(); + + const [pageState, dispatchPageAction] = useReducer( + monitorManagementPageReducer, + { + pageIndex: 1, // saved objects page index is base 1 + pageSize: 10, + sortOrder: 'asc', + sortField: `${ConfigKey.NAME}.keyword`, + } + ); + + const { pageIndex, pageSize, sortField, sortOrder } = pageState as MonitorManagementListPageState; + + const { type: viewType } = useParams<{ type: 'all' | 'invalid' }>(); + + useEffect(() => { + if (viewType === 'all') { + dispatch(getMonitors({ page: pageIndex, perPage: pageSize, sortOrder, sortField })); + } + }, [dispatch, pageIndex, pageSize, sortField, sortOrder, viewType, pageState]); + + return { + pageState, + dispatchPageAction, + viewType, + }; +} + +export type MonitorManagementPageAction = + | { + type: 'update'; + payload: MonitorManagementListPageState; + } + | { type: 'refresh' }; + +const monitorManagementPageReducer: Reducer< + MonitorManagementListPageState, + MonitorManagementPageAction +> = (state: MonitorManagementListPageState, action: MonitorManagementPageAction) => { + switch (action.type) { + case 'update': + return { + ...state, + ...action.payload, + }; + case 'refresh': + return { ...state }; + default: + throw new Error(`Action "${(action as MonitorManagementPageAction)?.type}" not recognizable`); + } +}; diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/hooks/use_run_once_errors.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/hooks/use_run_once_errors.ts similarity index 97% rename from x-pack/plugins/synthetics/public/components/monitor_management/hooks/use_run_once_errors.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/hooks/use_run_once_errors.ts index 204096f7e0181..916ca8c00b972 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/hooks/use_run_once_errors.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/hooks/use_run_once_errors.ts @@ -7,7 +7,7 @@ import { useEffect, useMemo, useState } from 'react'; import { i18n } from '@kbn/i18n'; -import { Locations, ServiceLocationErrors } from '../../../../common/runtime_types'; +import { Locations, ServiceLocationErrors } from '../../../../../common/runtime_types'; export function useRunOnceErrors({ testRunId, diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/hooks/use_service_allowed.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/hooks/use_service_allowed.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor_management/hooks/use_service_allowed.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/hooks/use_service_allowed.ts diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/loader/loader.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/loader/loader.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor_management/loader/loader.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/loader/loader.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/loader/loader.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/loader/loader.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor_management/loader/loader.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/loader/loader.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/mocks/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/mocks/index.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor_management/mocks/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/mocks/index.ts diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/mocks/locations.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/mocks/locations.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor_management/mocks/locations.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/mocks/locations.ts diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_config/locations.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_config/locations.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor_management/monitor_config/locations.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_config/locations.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_config/locations.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_config/locations.tsx similarity index 97% rename from x-pack/plugins/synthetics/public/components/monitor_management/monitor_config/locations.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_config/locations.tsx index fff6e11890f11..029503196b6a3 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_config/locations.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_config/locations.tsx @@ -10,7 +10,7 @@ import { useSelector } from 'react-redux'; import { i18n } from '@kbn/i18n'; import { EuiCheckboxGroup, EuiFormRow } from '@elastic/eui'; import { monitorManagementListSelector } from '../../../state/selectors'; -import { MonitorServiceLocations } from '../../../../common/runtime_types'; +import { MonitorServiceLocations } from '../../../../../common/runtime_types'; interface Props { selectedLocations: MonitorServiceLocations; diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_config/monitor_advanced_fields.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_config/monitor_advanced_fields.tsx similarity index 96% rename from x-pack/plugins/synthetics/public/components/monitor_management/monitor_config/monitor_advanced_fields.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_config/monitor_advanced_fields.tsx index 086efe36ff113..c4b57f66c227d 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_config/monitor_advanced_fields.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_config/monitor_advanced_fields.tsx @@ -8,8 +8,8 @@ import { EuiFieldText, EuiFormRow, EuiLink, EuiSpacer } from '@elastic/eui'; import { FormattedMessage } from '@kbn/i18n-react'; import React, { memo } from 'react'; import { useKibana } from '@kbn/kibana-react-plugin/public'; -import { ConfigKey } from '../../../../common/runtime_types'; -import type { Validation } from '../../../../common/types'; +import { ConfigKey } from '../../../../../common/runtime_types'; +import type { Validation } from '../../../../../common/types'; import { DescribedFormGroupWithWrap } from '../../fleet_package/common/described_form_group_with_wrap'; import { usePolicyConfigContext } from '../../fleet_package/contexts'; diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_config/monitor_config.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_config/monitor_config.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor_management/monitor_config/monitor_config.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_config/monitor_config.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_config/monitor_config.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_config/monitor_config.tsx similarity index 94% rename from x-pack/plugins/synthetics/public/components/monitor_management/monitor_config/monitor_config.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_config/monitor_config.tsx index 8b62b7cde145f..3e85c932bf700 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_config/monitor_config.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_config/monitor_config.tsx @@ -17,7 +17,7 @@ import { } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; import { v4 as uuidv4 } from 'uuid'; -import { defaultConfig, usePolicyConfigContext } from '../../fleet_package/contexts'; +import { usePolicyConfigContext } from '../../fleet_package/contexts'; import { usePolicy } from '../../fleet_package/hooks/use_policy'; import { validate } from '../validation'; @@ -25,7 +25,8 @@ import { ActionBarPortal } from '../action_bar/action_bar_portal'; import { useFormatMonitor } from '../hooks/use_format_monitor'; import { MonitorFields } from './monitor_fields'; import { TestNowMode, TestRun } from '../test_now_mode/test_now_mode'; -import { MonitorFields as MonitorFieldsType } from '../../../../common/runtime_types'; +import { MonitorFields as MonitorFieldsType } from '../../../../../common/runtime_types'; +import { DEFAULT_FIELDS } from '../../../../../common/constants/monitor_defaults'; export const MonitorConfig = ({ isEdit = false }: { isEdit: boolean }) => { const { monitorType } = usePolicyConfigContext(); @@ -41,7 +42,7 @@ export const MonitorConfig = ({ isEdit = false }: { isEdit: boolean }) => { monitorType, validate, config: policyConfig[monitorType], - defaultConfig: defaultConfig[monitorType], + defaultConfig: DEFAULT_FIELDS[monitorType], }); const [hasBeenSubmitted, setHasBeenSubmitted] = useState(false); diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_config/monitor_fields.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_config/monitor_fields.test.tsx similarity index 97% rename from x-pack/plugins/synthetics/public/components/monitor_management/monitor_config/monitor_fields.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_config/monitor_fields.test.tsx index 7320410ae52eb..b4e97ba724393 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_config/monitor_fields.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_config/monitor_fields.test.tsx @@ -9,7 +9,7 @@ import { fireEvent } from '@testing-library/react'; import userEvent from '@testing-library/user-event'; import React from 'react'; -import { ConfigKey, DataStream, HTTPFields } from '../../../../common/runtime_types'; +import { ConfigKey, DataStream, HTTPFields } from '../../../../../common/runtime_types'; import { render } from '../../../lib/helper/rtl_helpers'; import { BrowserContextProvider, diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_config/monitor_fields.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_config/monitor_fields.tsx similarity index 96% rename from x-pack/plugins/synthetics/public/components/monitor_management/monitor_config/monitor_fields.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_config/monitor_fields.tsx index 655bb5cecac85..eb109dd5d1063 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_config/monitor_fields.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_config/monitor_fields.tsx @@ -7,7 +7,7 @@ import React, { useMemo, useState } from 'react'; import { EuiForm } from '@elastic/eui'; -import { ConfigKey, DataStream } from '../../../../common/runtime_types'; +import { ConfigKey, DataStream } from '../../../../../common/runtime_types'; import { usePolicyConfigContext } from '../../fleet_package/contexts'; import { CustomFields } from '../../fleet_package/custom_fields'; diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_config/monitor_name_location.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_config/monitor_name_location.tsx similarity index 95% rename from x-pack/plugins/synthetics/public/components/monitor_management/monitor_config/monitor_name_location.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_config/monitor_name_location.tsx index e49a9b3e04833..0f7206f65992f 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_config/monitor_name_location.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_config/monitor_name_location.tsx @@ -9,8 +9,8 @@ import React, { useEffect, useState } from 'react'; import { i18n } from '@kbn/i18n'; import { FormattedMessage } from '@kbn/i18n-react'; import { EuiFormRow, EuiFieldText } from '@elastic/eui'; -import { ConfigKey } from '../../../../common/runtime_types'; -import { Validation } from '../../../../common/types'; +import { ConfigKey } from '../../../../../common/runtime_types'; +import { Validation } from '../../../../../common/types'; import { usePolicyConfigContext } from '../../fleet_package/contexts'; import { ServiceLocations } from './locations'; import { useMonitorName } from './use_monitor_name'; diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_config/use_monitor_name.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_config/use_monitor_name.test.tsx similarity index 87% rename from x-pack/plugins/synthetics/public/components/monitor_management/monitor_config/use_monitor_name.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_config/use_monitor_name.test.tsx index ccfc1312cbf25..04879cd0da65b 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_config/use_monitor_name.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_config/use_monitor_name.test.tsx @@ -9,7 +9,16 @@ import { defaultCore, WrappedHelper } from '../../../lib/helper/rtl_helpers'; import { renderHook } from '@testing-library/react-hooks'; import { useMonitorName } from './use_monitor_name'; -import * as hooks from '../../../hooks/use_monitor'; +import * as reactRouter from 'react-router-dom'; + +const mockRouter = { + ...reactRouter, +}; + +jest.mock('react-router-dom', () => ({ + ...jest.requireActual('react-router-dom'), + useParams: jest.fn().mockReturnValue({}), +})); describe('useMonitorName', () => { it('returns expected results', () => { @@ -56,7 +65,7 @@ describe('useMonitorName', () => { }, }); - jest.spyOn(hooks, 'useMonitorId').mockReturnValue('test-id'); + jest.spyOn(mockRouter, 'useParams').mockReturnValue({ monitorId: 'test-id' }); const { result, waitForNextUpdate } = renderHook(() => useMonitorName({ search: 'Test' }), { wrapper: WrappedHelper, diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_config/use_monitor_name.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_config/use_monitor_name.ts similarity index 90% rename from x-pack/plugins/synthetics/public/components/monitor_management/monitor_config/use_monitor_name.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_config/use_monitor_name.ts index 200a9599b405e..e8d3848856a2b 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_config/use_monitor_name.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_config/use_monitor_name.ts @@ -8,8 +8,8 @@ import { useEffect, useState } from 'react'; import { useFetcher } from '@kbn/observability-plugin/public'; import { useKibana } from '@kbn/kibana-react-plugin/public'; -import { syntheticsMonitorType } from '../../../../common/types/saved_objects'; -import { useMonitorId } from '../../../hooks'; +import { useParams } from 'react-router-dom'; +import { syntheticsMonitorType } from '../../../../../common/types/saved_objects'; interface AggsResponse { monitorNames: { @@ -22,7 +22,7 @@ interface AggsResponse { export const useMonitorName = ({ search = '' }: { search?: string }) => { const [values, setValues] = useState([]); - const monitorId = useMonitorId(); + const { monitorId } = useParams<{ monitorId: string }>(); const { savedObjects } = useKibana().services; diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/actions.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/actions.test.tsx similarity index 94% rename from x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/actions.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/actions.test.tsx index f60d54e9cb4f6..af2e54503d0b1 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/actions.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/actions.test.tsx @@ -19,7 +19,7 @@ describe('', () => { expect(screen.getByLabelText('Edit monitor')).toHaveAttribute( 'href', - '/app/uptime/edit-monitor/dGVzdC1pZA==' + '/app/uptime/edit-monitor/test-id' ); }); }); diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/actions.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/actions.tsx similarity index 91% rename from x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/actions.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/actions.tsx index c290e58dc6225..ddd0d0cc0a63e 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/actions.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/actions.tsx @@ -12,7 +12,7 @@ import moment from 'moment'; import { UptimeSettingsContext } from '../../../contexts'; import { DeleteMonitor } from './delete_monitor'; import { InlineError } from './inline_error'; -import { MonitorManagementListResult, Ping } from '../../../../common/runtime_types'; +import { MonitorManagementListResult, Ping } from '../../../../../common/runtime_types'; interface Props { id: string; @@ -45,7 +45,7 @@ export const Actions = ({ id, name, onUpdate, isDisabled, errorSummaries, monito diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/all_monitors.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/all_monitors.tsx similarity index 95% rename from x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/all_monitors.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/all_monitors.tsx index 550d3b487a4ae..ac6fab66bbb1e 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/all_monitors.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/all_monitors.tsx @@ -10,7 +10,7 @@ import { useSelector } from 'react-redux'; import { MonitorManagementList, MonitorManagementListPageState } from './monitor_list'; import { monitorManagementListSelector } from '../../../state/selectors'; import { MonitorManagementList as MonitorManagementListState } from '../../../state/reducers/monitor_management'; -import { Ping } from '../../../../common/runtime_types'; +import { Ping } from '../../../../../common/runtime_types'; interface Props { pageState: MonitorManagementListPageState; diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/delete_monitor.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/delete_monitor.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/delete_monitor.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/delete_monitor.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/delete_monitor.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/delete_monitor.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/delete_monitor.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/delete_monitor.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/enablement_empty_state.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/enablement_empty_state.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/enablement_empty_state.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/enablement_empty_state.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/inline_error.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/inline_error.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/inline_error.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/inline_error.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/inline_error.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/inline_error.tsx similarity index 96% rename from x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/inline_error.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/inline_error.tsx index d9f47802e6c28..7ba74def660c9 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/inline_error.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/inline_error.tsx @@ -8,7 +8,7 @@ import React, { useState } from 'react'; import { EuiButtonIcon, EuiToolTip } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; -import { Ping } from '../../../../common/runtime_types'; +import { Ping } from '../../../../../common/runtime_types'; import { StdErrorPopover } from './stderr_logs_popover'; export const InlineError = ({ errorSummary }: { errorSummary: Ping }) => { diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/invalid_monitors.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/invalid_monitors.tsx similarity index 97% rename from x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/invalid_monitors.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/invalid_monitors.tsx index 342b9c6547b1b..5dea7b7ee06fd 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/invalid_monitors.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/invalid_monitors.tsx @@ -13,7 +13,7 @@ import { MonitorManagementListResult, Ping, DEFAULT_THROTTLING, -} from '../../../../common/runtime_types'; +} from '../../../../../common/runtime_types'; interface Props { loading: boolean; diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/list_tabs.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/list_tabs.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/list_tabs.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/list_tabs.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/list_tabs.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/list_tabs.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/list_tabs.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/list_tabs.tsx index 15012751af3e5..e2da72effa560 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/list_tabs.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/list_tabs.tsx @@ -18,7 +18,7 @@ import React, { useState, Fragment, useEffect } from 'react'; import { useHistory, useParams } from 'react-router-dom'; import { useUptimeRefreshContext } from '../../../contexts/uptime_refresh_context'; import { MonitorManagementListPageState } from './monitor_list'; -import { ConfigKey } from '../../../../common/runtime_types'; +import { ConfigKey } from '../../../../../common/runtime_types'; export const MonitorListTabs = ({ invalidTotal, diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/monitor_async_error.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/monitor_async_error.test.tsx similarity index 97% rename from x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/monitor_async_error.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/monitor_async_error.test.tsx index da89876cc9b0b..2592aabf9eb09 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/monitor_async_error.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/monitor_async_error.test.tsx @@ -7,7 +7,7 @@ import { screen } from '@testing-library/react'; import React from 'react'; -import { DEFAULT_THROTTLING } from '../../../../common/runtime_types'; +import { DEFAULT_THROTTLING } from '../../../../../common/runtime_types'; import { render } from '../../../lib/helper/rtl_helpers'; import { MonitorManagementList as MonitorManagementListState } from '../../../state/reducers/monitor_management'; import { MonitorAsyncError } from './monitor_async_error'; diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/monitor_async_error.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/monitor_async_error.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/monitor_async_error.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/monitor_async_error.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/monitor_enabled.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/monitor_enabled.test.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/monitor_enabled.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/monitor_enabled.test.tsx index d7e04f0e6140f..9d30d985f09d9 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/monitor_enabled.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/monitor_enabled.test.tsx @@ -8,7 +8,7 @@ import React from 'react'; import { screen } from '@testing-library/react'; import userEvent from '@testing-library/user-event'; -import { ConfigKey, DataStream, SyntheticsMonitor } from '../../../../common/runtime_types'; +import { ConfigKey, DataStream, SyntheticsMonitor } from '../../../../../common/runtime_types'; import { render } from '../../../lib/helper/rtl_helpers'; import { FETCH_STATUS } from '@kbn/observability-plugin/public'; import { spyOnUseFetcher } from '../../../lib/helper/spy_use_fetcher'; diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/monitor_enabled.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/monitor_enabled.tsx similarity index 99% rename from x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/monitor_enabled.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/monitor_enabled.tsx index 6bbad58767b20..4b00f96077548 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/monitor_enabled.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/monitor_enabled.tsx @@ -10,7 +10,7 @@ import { i18n } from '@kbn/i18n'; import React, { useEffect, useState } from 'react'; import { useKibana } from '@kbn/kibana-react-plugin/public'; import { FETCH_STATUS, useFetcher } from '@kbn/observability-plugin/public'; -import { ConfigKey, EncryptedSyntheticsMonitor } from '../../../../common/runtime_types'; +import { ConfigKey, EncryptedSyntheticsMonitor } from '../../../../../common/runtime_types'; import { setMonitor } from '../../../state/api'; interface Props { diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/monitor_list.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/monitor_list.test.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/monitor_list.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/monitor_list.test.tsx index a641f7a76f3a7..5c13b34366d59 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/monitor_list.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/monitor_list.test.tsx @@ -14,7 +14,7 @@ import { HTTPFields, ScheduleUnit, DEFAULT_THROTTLING, -} from '../../../../common/runtime_types'; +} from '../../../../../common/runtime_types'; import { render } from '../../../lib/helper/rtl_helpers'; import { MonitorManagementList as MonitorManagementListState } from '../../../state/reducers/monitor_management'; import { MonitorManagementList, MonitorManagementListPageState } from './monitor_list'; diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/monitor_list.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/monitor_list.tsx similarity index 97% rename from x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/monitor_list.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/monitor_list.tsx index 6dade5a1e4186..fbd21fe09c1ec 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/monitor_list.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/monitor_list.tsx @@ -25,7 +25,7 @@ import { ServiceLocations, EncryptedSyntheticsMonitorWithId, TCPSimpleFields, -} from '../../../../common/runtime_types'; +} from '../../../../../common/runtime_types'; import { UptimeSettingsContext } from '../../../contexts'; import { useBreakpoints } from '../../../hooks'; import { MonitorManagementList as MonitorManagementListState } from '../../../state/reducers/monitor_management'; @@ -120,11 +120,7 @@ export const MonitorManagementList = ({ }), sortable: true, render: (name: string, { id }: EncryptedSyntheticsMonitorWithId) => ( - - {name} - + {name} ), }, { diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/monitor_list_container.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/monitor_list_container.tsx similarity index 61% rename from x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/monitor_list_container.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/monitor_list_container.tsx index 92b61cf1d744d..727f4f6dee72b 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/monitor_list_container.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/monitor_list_container.tsx @@ -5,32 +5,29 @@ * 2.0. */ -import React, { useEffect, useReducer, useCallback, Reducer } from 'react'; -import { useDispatch, useSelector } from 'react-redux'; +import React, { useCallback, Dispatch } from 'react'; +import { useSelector } from 'react-redux'; import { useParams } from 'react-router-dom'; import { useTrackPageview } from '@kbn/observability-plugin/public'; -import { ConfigKey } from '../../../../common/runtime_types'; -import { getMonitors } from '../../../state/actions'; import { monitorManagementListSelector } from '../../../state/selectors'; -import { MonitorManagementListPageState } from './monitor_list'; import { MonitorAsyncError } from './monitor_async_error'; import { useInlineErrors } from '../hooks/use_inline_errors'; import { MonitorListTabs } from './list_tabs'; import { AllMonitors } from './all_monitors'; import { InvalidMonitors } from './invalid_monitors'; import { useInvalidMonitors } from '../hooks/use_invalid_monitors'; +import { MonitorManagementListPageState } from './monitor_list'; +import { MonitorManagementPageAction } from '../hooks/use_monitor_list'; -export const MonitorListContainer: React.FC = () => { - const [pageState, dispatchPageAction] = useReducer( - monitorManagementPageReducer, - { - pageIndex: 1, // saved objects page index is base 1 - pageSize: 10, - sortOrder: 'asc', - sortField: `${ConfigKey.NAME}.keyword`, - } - ); - +export const MonitorListContainer = ({ + isEnabled, + pageState, + dispatchPageAction, +}: { + isEnabled?: boolean; + pageState: MonitorManagementListPageState; + dispatchPageAction: Dispatch; +}) => { const onPageStateChange = useCallback( (state) => { dispatchPageAction({ type: 'update', payload: state }); @@ -45,11 +42,8 @@ export const MonitorListContainer: React.FC = () => { useTrackPageview({ app: 'uptime', path: 'manage-monitors' }); useTrackPageview({ app: 'uptime', path: 'manage-monitors', delay: 15000 }); - const dispatch = useDispatch(); const monitorList = useSelector(monitorManagementListSelector); - const { pageIndex, pageSize, sortField, sortOrder } = pageState as MonitorManagementListPageState; - const { type: viewType } = useParams<{ type: 'all' | 'invalid' }>(); const { errorSummaries, loading, count } = useInlineErrors({ onlyInvalidMonitors: viewType === 'invalid', @@ -57,14 +51,12 @@ export const MonitorListContainer: React.FC = () => { sortOrder: pageState.sortOrder, }); - useEffect(() => { - if (viewType === 'all') { - dispatch(getMonitors({ page: pageIndex, perPage: pageSize, sortField, sortOrder })); - } - }, [dispatch, pageState, pageIndex, pageSize, sortField, sortOrder, viewType]); - const { data: monitorSavedObjects, loading: objectsLoading } = useInvalidMonitors(errorSummaries); + if (!isEnabled && monitorList.list.total === 0) { + return null; + } + return ( <> @@ -95,27 +87,3 @@ export const MonitorListContainer: React.FC = () => { ); }; - -type MonitorManagementPageAction = - | { - type: 'update'; - payload: MonitorManagementListPageState; - } - | { type: 'refresh' }; - -const monitorManagementPageReducer: Reducer< - MonitorManagementListPageState, - MonitorManagementPageAction -> = (state: MonitorManagementListPageState, action: MonitorManagementPageAction) => { - switch (action.type) { - case 'update': - return { - ...state, - ...action.payload, - }; - case 'refresh': - return { ...state }; - default: - throw new Error(`Action "${(action as MonitorManagementPageAction)?.type}" not recognizable`); - } -}; diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/monitor_locations.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/monitor_locations.tsx similarity index 94% rename from x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/monitor_locations.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/monitor_locations.tsx index 940e6260d864c..5f9ad96bca464 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/monitor_locations.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/monitor_locations.tsx @@ -7,7 +7,7 @@ import React, { useState } from 'react'; import { EuiBadge, EuiBadgeGroup } from '@elastic/eui'; -import { ServiceLocations, ServiceLocation } from '../../../../common/runtime_types'; +import { ServiceLocations, ServiceLocation } from '../../../../../common/runtime_types'; import { EXPAND_LOCATIONS_LABEL } from '../../overview/monitor_list/columns/translations'; import { useLocations } from '../hooks/use_locations'; diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/stderr_logs_popover.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/stderr_logs_popover.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/stderr_logs_popover.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/stderr_logs_popover.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/tags.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/tags.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor_management/monitor_list/tags.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/monitor_list/tags.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/show_sync_errors.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/show_sync_errors.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/monitor_management/show_sync_errors.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/show_sync_errors.tsx index 0ce1fdd0d768e..0fde06c764c08 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/show_sync_errors.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/show_sync_errors.tsx @@ -9,7 +9,7 @@ import React from 'react'; import { i18n } from '@kbn/i18n'; import { toMountPoint } from '@kbn/kibana-react-plugin/public'; import { kibanaService } from '../../state/kibana_service'; -import { ServiceLocationErrors, ServiceLocations } from '../../../common/runtime_types'; +import { ServiceLocationErrors, ServiceLocations } from '../../../../common/runtime_types'; export const showSyncErrors = (errors: ServiceLocationErrors, locations: ServiceLocations) => { Object.values(errors).forEach((location) => { diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/test_now_mode/browser/browser_test_results.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/test_now_mode/browser/browser_test_results.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor_management/test_now_mode/browser/browser_test_results.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/test_now_mode/browser/browser_test_results.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/test_now_mode/browser/browser_test_results.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/test_now_mode/browser/browser_test_results.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor_management/test_now_mode/browser/browser_test_results.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/test_now_mode/browser/browser_test_results.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/test_now_mode/browser/use_browser_run_once_monitors.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/test_now_mode/browser/use_browser_run_once_monitors.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor_management/test_now_mode/browser/use_browser_run_once_monitors.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/test_now_mode/browser/use_browser_run_once_monitors.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/test_now_mode/browser/use_browser_run_once_monitors.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/test_now_mode/browser/use_browser_run_once_monitors.ts similarity index 98% rename from x-pack/plugins/synthetics/public/components/monitor_management/test_now_mode/browser/use_browser_run_once_monitors.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/test_now_mode/browser/use_browser_run_once_monitors.ts index 68f96b5d7b487..034fad5b9a8d0 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/test_now_mode/browser/use_browser_run_once_monitors.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/test_now_mode/browser/use_browser_run_once_monitors.ts @@ -6,11 +6,11 @@ */ import { useEffect, useState, useRef } from 'react'; import { createEsParams, useEsSearch, useFetcher } from '@kbn/observability-plugin/public'; -import { JourneyStep } from '../../../../../common/runtime_types'; +import { JourneyStep } from '../../../../../../common/runtime_types'; import { useTickTick } from '../use_tick_tick'; import { fetchJourneySteps } from '../../../../state/api/journey'; import { isStepEnd } from '../../../synthetics/check_steps/steps_list'; -import { SYNTHETICS_INDEX_PATTERN } from '../../../../../common/constants'; +import { SYNTHETICS_INDEX_PATTERN } from '../../../../../../common/constants'; export interface CheckGroupResult { checkGroupId: string; diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/test_now_mode/simple/simple_test_results.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/test_now_mode/simple/simple_test_results.test.tsx similarity index 99% rename from x-pack/plugins/synthetics/public/components/monitor_management/test_now_mode/simple/simple_test_results.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/test_now_mode/simple/simple_test_results.test.tsx index 6ef4daf9fbdf3..c0bab63b1c11d 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/test_now_mode/simple/simple_test_results.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/test_now_mode/simple/simple_test_results.test.tsx @@ -11,7 +11,7 @@ import { render } from '../../../../lib/helper/rtl_helpers'; import { SimpleTestResults } from './simple_test_results'; import { kibanaService } from '../../../../state/kibana_service'; import * as runOnceHooks from './use_simple_run_once_monitors'; -import { Ping } from '../../../../../common/runtime_types'; +import { Ping } from '../../../../../../common/runtime_types'; describe('SimpleTestResults', function () { const onDone = jest.fn(); diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/test_now_mode/simple/simple_test_results.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/test_now_mode/simple/simple_test_results.tsx similarity index 96% rename from x-pack/plugins/synthetics/public/components/monitor_management/test_now_mode/simple/simple_test_results.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/test_now_mode/simple/simple_test_results.tsx index b1ac899a8951e..580c936272b59 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/test_now_mode/simple/simple_test_results.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/test_now_mode/simple/simple_test_results.tsx @@ -6,7 +6,7 @@ */ import React, { useEffect, useState } from 'react'; import { useSimpleRunOnceMonitors } from './use_simple_run_once_monitors'; -import { Ping } from '../../../../../common/runtime_types'; +import { Ping } from '../../../../../../common/runtime_types'; import { PingListTable } from '../../../monitor/ping_list/ping_list_table'; import { TestResultHeader } from '../test_result_header'; diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/test_now_mode/simple/use_simple_run_once_monitors.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/test_now_mode/simple/use_simple_run_once_monitors.ts similarity index 94% rename from x-pack/plugins/synthetics/public/components/monitor_management/test_now_mode/simple/use_simple_run_once_monitors.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/test_now_mode/simple/use_simple_run_once_monitors.ts index 3ca3691aef22c..f0282aaad47a2 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/test_now_mode/simple/use_simple_run_once_monitors.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/test_now_mode/simple/use_simple_run_once_monitors.ts @@ -7,9 +7,9 @@ import { useMemo, useRef } from 'react'; import { createEsParams, useEsSearch } from '@kbn/observability-plugin/public'; -import { Ping } from '../../../../../common/runtime_types'; +import { Ping } from '../../../../../../common/runtime_types'; import { useTickTick } from '../use_tick_tick'; -import { SYNTHETICS_INDEX_PATTERN } from '../../../../../common/constants'; +import { SYNTHETICS_INDEX_PATTERN } from '../../../../../../common/constants'; export const useSimpleRunOnceMonitors = ({ configId, diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/test_now_mode/test_now_mode.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/test_now_mode/test_now_mode.test.tsx similarity index 95% rename from x-pack/plugins/synthetics/public/components/monitor_management/test_now_mode/test_now_mode.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/test_now_mode/test_now_mode.test.tsx index da06b41d16530..b040f7a27da33 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/test_now_mode/test_now_mode.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/test_now_mode/test_now_mode.test.tsx @@ -10,7 +10,7 @@ import { screen } from '@testing-library/react'; import { render } from '../../../lib/helper/rtl_helpers'; import { TestNowMode } from './test_now_mode'; import { kibanaService } from '../../../state/kibana_service'; -import { Locations, MonitorFields } from '../../../../common/runtime_types'; +import { Locations, MonitorFields } from '../../../../../common/runtime_types'; import * as runOnceErrorHooks from '../hooks/use_run_once_errors'; describe('TestNowMode', function () { diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/test_now_mode/test_now_mode.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/test_now_mode/test_now_mode.tsx similarity index 96% rename from x-pack/plugins/synthetics/public/components/monitor_management/test_now_mode/test_now_mode.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/test_now_mode/test_now_mode.tsx index e89298c9aa46b..25a2f7d02a5fe 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/test_now_mode/test_now_mode.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/test_now_mode/test_now_mode.tsx @@ -18,7 +18,11 @@ import { import { useFetcher } from '@kbn/observability-plugin/public'; import { useRunOnceErrors } from '../hooks/use_run_once_errors'; import { TestRunResult } from './test_run_results'; -import { Locations, MonitorFields, ServiceLocationErrors } from '../../../../common/runtime_types'; +import { + Locations, + MonitorFields, + ServiceLocationErrors, +} from '../../../../../common/runtime_types'; import { runOnceMonitor } from '../../../state/api'; import { kibanaService } from '../../../state/kibana_service'; diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/test_now_mode/test_result_header.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/test_now_mode/test_result_header.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor_management/test_now_mode/test_result_header.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/test_now_mode/test_result_header.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/test_now_mode/test_result_header.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/test_now_mode/test_result_header.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/monitor_management/test_now_mode/test_result_header.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/test_now_mode/test_result_header.tsx index 62c1971d87ed1..4cd4df567882d 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/test_now_mode/test_result_header.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/test_now_mode/test_result_header.tsx @@ -17,7 +17,7 @@ import { import { i18n } from '@kbn/i18n'; import * as React from 'react'; import { formatDuration } from '../../monitor/ping_list/ping_list'; -import { JourneyStep, Ping } from '../../../../common/runtime_types'; +import { JourneyStep, Ping } from '../../../../../common/runtime_types'; import { useUptimeSettingsContext } from '../../../contexts/uptime_settings_context'; interface Props { diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/test_now_mode/test_run_results.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/test_now_mode/test_run_results.tsx similarity index 93% rename from x-pack/plugins/synthetics/public/components/monitor_management/test_now_mode/test_run_results.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/test_now_mode/test_run_results.tsx index b1a6d0aba8cfc..6e9ef292ad6b2 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/test_now_mode/test_run_results.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/test_now_mode/test_run_results.tsx @@ -6,7 +6,7 @@ */ import * as React from 'react'; -import { SyntheticsMonitor } from '../../../../common/runtime_types'; +import { SyntheticsMonitor } from '../../../../../common/runtime_types'; import { BrowserTestRunResult } from './browser/browser_test_results'; import { SimpleTestResults } from './simple/simple_test_results'; diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/test_now_mode/use_tick_tick.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/test_now_mode/use_tick_tick.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/monitor_management/test_now_mode/use_tick_tick.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/test_now_mode/use_tick_tick.ts diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/validation.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/validation.test.ts similarity index 99% rename from x-pack/plugins/synthetics/public/components/monitor_management/validation.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/validation.test.ts index 6fa57eb5cd964..ce7c08a45dbaf 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/validation.test.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/validation.test.ts @@ -13,7 +13,7 @@ import { MonitorFields, ScheduleUnit, ServiceLocations, -} from '../../../common/runtime_types'; +} from '../../../../common/runtime_types'; import { validate, validateCommon } from './validation'; describe('[Monitor Management] validation', () => { diff --git a/x-pack/plugins/synthetics/public/components/monitor_management/validation.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/validation.ts similarity index 98% rename from x-pack/plugins/synthetics/public/components/monitor_management/validation.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/validation.ts index 78b0b8ba82b68..0975d00b38098 100644 --- a/x-pack/plugins/synthetics/public/components/monitor_management/validation.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/monitor_management/validation.ts @@ -11,8 +11,8 @@ import { ScheduleUnit, MonitorFields, isServiceLocationInvalid, -} from '../../../common/runtime_types'; -import { Validation } from '../../../common/types'; +} from '../../../../common/runtime_types'; +import { Validation } from '../../../../common/types'; export const digitsOnly = /^[0-9]*$/g; export const includesValidPort = /[^\:]+:[0-9]{1,5}$/g; diff --git a/x-pack/plugins/synthetics/public/components/overview/__snapshots__/snapshot_heading.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/__snapshots__/snapshot_heading.test.tsx.snap similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/__snapshots__/snapshot_heading.test.tsx.snap rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/__snapshots__/snapshot_heading.test.tsx.snap diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/alert_expression_popover.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/alert_expression_popover.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/alerts/alert_expression_popover.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/alert_expression_popover.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/alert_field_number.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/alert_field_number.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/alerts/alert_field_number.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/alert_field_number.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/alert_field_number.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/alert_field_number.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/alerts/alert_field_number.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/alert_field_number.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/alert_query_bar/query_bar.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/alert_query_bar/query_bar.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/alerts/alert_query_bar/query_bar.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/alert_query_bar/query_bar.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/alert_tls.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/alert_tls.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/alerts/alert_tls.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/alert_tls.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/alerts_containers/alert_monitor_status.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/alerts_containers/alert_monitor_status.tsx similarity index 95% rename from x-pack/plugins/synthetics/public/components/overview/alerts/alerts_containers/alert_monitor_status.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/alerts_containers/alert_monitor_status.tsx index 09b116c5bbc45..54a8010e30a1c 100644 --- a/x-pack/plugins/synthetics/public/components/overview/alerts/alerts_containers/alert_monitor_status.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/alerts_containers/alert_monitor_status.tsx @@ -14,10 +14,10 @@ import { setSearchTextAction } from '../../../../state/actions'; import { AtomicStatusCheckParamsType, GetMonitorAvailabilityParamsType, -} from '../../../../../common/runtime_types'; +} from '../../../../../../common/runtime_types'; import { useSnapShotCount } from './use_snap_shot'; -import { FILTER_FIELDS } from '../../../../../common/constants'; +import { FILTER_FIELDS } from '../../../../../../common/constants'; const { TYPE, TAGS, LOCATION, PORT } = FILTER_FIELDS; diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/alerts_containers/alert_tls.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/alerts_containers/alert_tls.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/alerts/alerts_containers/alert_tls.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/alerts_containers/alert_tls.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/alerts_containers/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/alerts_containers/index.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/alerts/alerts_containers/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/alerts_containers/index.ts diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/alerts_containers/toggle_alert_flyout_button.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/alerts_containers/toggle_alert_flyout_button.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/alerts/alerts_containers/toggle_alert_flyout_button.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/alerts_containers/toggle_alert_flyout_button.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/alerts_containers/uptime_alerts_flyout_wrapper.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/alerts_containers/uptime_alerts_flyout_wrapper.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/alerts/alerts_containers/uptime_alerts_flyout_wrapper.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/alerts_containers/uptime_alerts_flyout_wrapper.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/alerts_containers/use_snap_shot.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/alerts_containers/use_snap_shot.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/alerts/alerts_containers/use_snap_shot.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/alerts_containers/use_snap_shot.ts diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/anomaly_alert/anomaly_alert.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/anomaly_alert/anomaly_alert.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/alerts/anomaly_alert/anomaly_alert.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/anomaly_alert/anomaly_alert.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/anomaly_alert/select_severity.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/anomaly_alert/select_severity.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/alerts/anomaly_alert/select_severity.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/anomaly_alert/select_severity.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/anomaly_alert/translations.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/anomaly_alert/translations.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/alerts/anomaly_alert/translations.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/anomaly_alert/translations.ts diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/index.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/alerts/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/index.ts diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/monitor_expressions/__snapshots__/down_number_select.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_expressions/__snapshots__/down_number_select.test.tsx.snap similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/alerts/monitor_expressions/__snapshots__/down_number_select.test.tsx.snap rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_expressions/__snapshots__/down_number_select.test.tsx.snap diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/monitor_expressions/__snapshots__/time_expression_select.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_expressions/__snapshots__/time_expression_select.test.tsx.snap similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/alerts/monitor_expressions/__snapshots__/time_expression_select.test.tsx.snap rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_expressions/__snapshots__/time_expression_select.test.tsx.snap diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/monitor_expressions/availability_expression_select.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_expressions/availability_expression_select.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/alerts/monitor_expressions/availability_expression_select.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_expressions/availability_expression_select.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/monitor_expressions/down_number_select.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_expressions/down_number_select.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/alerts/monitor_expressions/down_number_select.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_expressions/down_number_select.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/monitor_expressions/down_number_select.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_expressions/down_number_select.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/alerts/monitor_expressions/down_number_select.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_expressions/down_number_select.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/monitor_expressions/filters_expression_select.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_expressions/filters_expression_select.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/alerts/monitor_expressions/filters_expression_select.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_expressions/filters_expression_select.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/monitor_expressions/filters_expression_select.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_expressions/filters_expression_select.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/overview/alerts/monitor_expressions/filters_expression_select.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_expressions/filters_expression_select.tsx index 3720179838899..12b28352a503e 100644 --- a/x-pack/plugins/synthetics/public/components/overview/alerts/monitor_expressions/filters_expression_select.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_expressions/filters_expression_select.tsx @@ -11,7 +11,7 @@ import { FieldValueSuggestions } from '@kbn/observability-plugin/public'; import { filterLabels } from '../../filter_group/translations'; import { alertFilterLabels, filterAriaLabels } from './translations'; import { useUptimeDataView } from '../../../../contexts/uptime_data_view_context'; -import { FILTER_FIELDS } from '../../../../../common/constants'; +import { FILTER_FIELDS } from '../../../../../../common/constants'; import { useGetUrlParams } from '../../../../hooks'; export interface FilterExpressionsSelectProps { diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/monitor_expressions/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_expressions/index.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/alerts/monitor_expressions/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_expressions/index.ts diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/monitor_expressions/status_expression_select.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_expressions/status_expression_select.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/alerts/monitor_expressions/status_expression_select.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_expressions/status_expression_select.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/monitor_expressions/time_expression_select.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_expressions/time_expression_select.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/alerts/monitor_expressions/time_expression_select.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_expressions/time_expression_select.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/monitor_expressions/time_expression_select.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_expressions/time_expression_select.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/alerts/monitor_expressions/time_expression_select.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_expressions/time_expression_select.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/monitor_expressions/time_unit_selectable.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_expressions/time_unit_selectable.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/alerts/monitor_expressions/time_unit_selectable.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_expressions/time_unit_selectable.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/monitor_expressions/translations.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_expressions/translations.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/alerts/monitor_expressions/translations.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_expressions/translations.ts diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/monitor_status_alert/add_filter_btn.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_status_alert/add_filter_btn.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/alerts/monitor_status_alert/add_filter_btn.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_status_alert/add_filter_btn.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/monitor_status_alert/add_filter_btn.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_status_alert/add_filter_btn.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/alerts/monitor_status_alert/add_filter_btn.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_status_alert/add_filter_btn.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/monitor_status_alert/alert_monitor_status.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_status_alert/alert_monitor_status.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/alerts/monitor_status_alert/alert_monitor_status.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_status_alert/alert_monitor_status.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/monitor_status_alert/alert_monitor_status.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_status_alert/alert_monitor_status.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/overview/alerts/monitor_status_alert/alert_monitor_status.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_status_alert/alert_monitor_status.tsx index 1fa06458e3a8b..80958e3bdd767 100644 --- a/x-pack/plugins/synthetics/public/components/overview/alerts/monitor_status_alert/alert_monitor_status.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_status_alert/alert_monitor_status.tsx @@ -14,7 +14,7 @@ import { OldAlertCallOut } from './old_alert_call_out'; import { AvailabilityExpressionSelect } from '../monitor_expressions/availability_expression_select'; import { AlertQueryBar } from '../alert_query_bar/query_bar'; import { useGetUrlParams } from '../../../../hooks'; -import { FILTER_FIELDS } from '../../../../../common/constants'; +import { FILTER_FIELDS } from '../../../../../../common/constants'; export interface AlertMonitorStatusProps { ruleParams: { [key: string]: any }; diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/monitor_status_alert/old_alert_call_out.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_status_alert/old_alert_call_out.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/alerts/monitor_status_alert/old_alert_call_out.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_status_alert/old_alert_call_out.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/monitor_status_alert/old_alert_callout.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_status_alert/old_alert_callout.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/alerts/monitor_status_alert/old_alert_callout.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/monitor_status_alert/old_alert_callout.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/settings_message_expression_popover.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/settings_message_expression_popover.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/alerts/settings_message_expression_popover.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/settings_message_expression_popover.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/toggle_alert_flyout_button.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/toggle_alert_flyout_button.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/alerts/toggle_alert_flyout_button.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/toggle_alert_flyout_button.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/toggle_alert_flyout_button.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/toggle_alert_flyout_button.tsx similarity index 97% rename from x-pack/plugins/synthetics/public/components/overview/alerts/toggle_alert_flyout_button.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/toggle_alert_flyout_button.tsx index 894c3df70a405..86b745c7d227f 100644 --- a/x-pack/plugins/synthetics/public/components/overview/alerts/toggle_alert_flyout_button.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/toggle_alert_flyout_button.tsx @@ -17,8 +17,8 @@ import React, { useState } from 'react'; import { i18n } from '@kbn/i18n'; import { FormattedMessage } from '@kbn/i18n-react'; import { useKibana } from '@kbn/kibana-react-plugin/public'; -import { CLIENT_ALERT_TYPES } from '../../../../common/constants/alerts'; -import { ClientPluginsStart } from '../../../apps/plugin'; +import { CLIENT_ALERT_TYPES } from '../../../../../common/constants/alerts'; +import { ClientPluginsStart } from '../../../../plugin'; import { ToggleFlyoutTranslations } from './translations'; import { ToggleAlertFlyoutButtonProps } from './alerts_containers'; diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/translations.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/translations.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/alerts/translations.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/translations.ts diff --git a/x-pack/plugins/synthetics/public/components/overview/alerts/uptime_alerts_flyout_wrapper.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/uptime_alerts_flyout_wrapper.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/alerts/uptime_alerts_flyout_wrapper.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/alerts/uptime_alerts_flyout_wrapper.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/empty_state/empty_state_error.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/empty_state/empty_state_error.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/empty_state/empty_state_error.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/empty_state/empty_state_error.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/empty_state/empty_state_loading.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/empty_state/empty_state_loading.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/empty_state/empty_state_loading.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/empty_state/empty_state_loading.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/empty_state/use_has_data.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/empty_state/use_has_data.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/empty_state/use_has_data.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/empty_state/use_has_data.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/filter_group/filter_group.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/filter_group/filter_group.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/filter_group/filter_group.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/filter_group/filter_group.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/filter_group/filter_group.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/filter_group/filter_group.tsx similarity index 96% rename from x-pack/plugins/synthetics/public/components/overview/filter_group/filter_group.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/filter_group/filter_group.tsx index 8a0ac4cbe81b1..16ab92a6862c2 100644 --- a/x-pack/plugins/synthetics/public/components/overview/filter_group/filter_group.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/filter_group/filter_group.tsx @@ -15,7 +15,7 @@ import { useSelectedFilters } from '../../../hooks/use_selected_filters'; import { SelectedFilters } from './selected_filters'; import { useUptimeDataView } from '../../../contexts/uptime_data_view_context'; import { useGetUrlParams } from '../../../hooks'; -import { EXCLUDE_RUN_ONCE_FILTER } from '../../../../common/constants/client_defaults'; +import { EXCLUDE_RUN_ONCE_FILTER } from '../../../../../common/constants/client_defaults'; const Container = styled(EuiFilterGroup)` margin-bottom: 10px; diff --git a/x-pack/plugins/synthetics/public/components/overview/filter_group/selected_filters.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/filter_group/selected_filters.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/filter_group/selected_filters.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/filter_group/selected_filters.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/filter_group/translations.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/filter_group/translations.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/filter_group/translations.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/filter_group/translations.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/index.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/index.ts diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/__snapshots__/filter_status_button.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/__snapshots__/filter_status_button.test.tsx.snap similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/__snapshots__/filter_status_button.test.tsx.snap rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/__snapshots__/filter_status_button.test.tsx.snap diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/__snapshots__/status_filter.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/__snapshots__/status_filter.test.tsx.snap similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/__snapshots__/status_filter.test.tsx.snap rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/__snapshots__/status_filter.test.tsx.snap diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/cert_status_column.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/cert_status_column.tsx similarity index 93% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/cert_status_column.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/cert_status_column.tsx index 790342b593398..5d24b7d969984 100644 --- a/x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/cert_status_column.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/cert_status_column.tsx @@ -9,10 +9,10 @@ import React from 'react'; import moment from 'moment'; import styled from 'styled-components'; import { EuiIcon, EuiText, EuiToolTip } from '@elastic/eui'; -import { X509Expiry } from '../../../../../common/runtime_types'; +import { X509Expiry } from '../../../../../../common/runtime_types'; import { useCertStatus } from '../../../../hooks'; import { EXPIRED, EXPIRES, EXPIRES_SOON } from '../../../certificates/translations'; -import { CERT_STATUS } from '../../../../../common/constants'; +import { CERT_STATUS } from '../../../../../../common/constants'; interface Props { expiry: X509Expiry; diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/define_connectors.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/define_connectors.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/define_connectors.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/define_connectors.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/define_connectors.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/define_connectors.tsx similarity index 97% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/define_connectors.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/define_connectors.tsx index f5ac702d5060b..5bb676178d9a7 100644 --- a/x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/define_connectors.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/define_connectors.tsx @@ -9,7 +9,7 @@ import React, { useState } from 'react'; import { EuiSwitch, EuiPopover, EuiText, EuiFormRow } from '@elastic/eui'; import { FormattedMessage } from '@kbn/i18n-react'; import { ReactRouterEuiLink } from '../../../common/react_router_helpers'; -import { SETTINGS_ROUTE } from '../../../../../common/constants'; +import { SETTINGS_ROUTE } from '../../../../../../common/constants'; import { ENABLE_STATUS_ALERT } from './translations'; interface Props { diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/enable_alert.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/enable_alert.test.tsx similarity index 95% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/enable_alert.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/enable_alert.test.tsx index c5dff902cfb14..416dd8e963e9b 100644 --- a/x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/enable_alert.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/enable_alert.test.tsx @@ -9,8 +9,8 @@ import React from 'react'; import { EnableMonitorAlert } from './enable_alert'; import { fireEvent } from '@testing-library/dom'; -import { DYNAMIC_SETTINGS_DEFAULTS } from '../../../../../common/constants'; -import { makePing } from '../../../../../common/runtime_types/ping'; +import { DYNAMIC_SETTINGS_DEFAULTS } from '../../../../../../common/constants'; +import { makePing } from '../../../../../../common/runtime_types/ping'; import { render } from '../../../../lib/helper/rtl_helpers'; import { DISABLE_STATUS_ALERT, ENABLE_STATUS_ALERT } from './translations'; import { mockState } from '../../../../lib/__mocks__/uptime_store.mock'; diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/enable_alert.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/enable_alert.tsx similarity index 96% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/enable_alert.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/enable_alert.tsx index 3bc23592c4e64..b52aacd5abb6e 100644 --- a/x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/enable_alert.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/enable_alert.tsx @@ -18,10 +18,10 @@ import { isAlertDeletedSelector, newAlertSelector, } from '../../../../state/alerts/alerts'; -import { MONITOR_ROUTE } from '../../../../../common/constants'; +import { MONITOR_ROUTE } from '../../../../../../common/constants'; import { DefineAlertConnectors } from './define_connectors'; import { DISABLE_STATUS_ALERT, ENABLE_STATUS_ALERT } from './translations'; -import { Ping } from '../../../../../common/runtime_types/ping'; +import { Ping } from '../../../../../../common/runtime_types/ping'; interface Props { monitorId: string; diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/monitor_name_col.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/monitor_name_col.tsx similarity index 96% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/monitor_name_col.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/monitor_name_col.tsx index 130ccbd7081c3..00590f46b51f1 100644 --- a/x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/monitor_name_col.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/monitor_name_col.tsx @@ -11,7 +11,7 @@ import { EuiButtonEmpty, EuiText } from '@elastic/eui'; import { MonitorPageLink } from '../../../common/monitor_page_link'; import { useGetUrlParams } from '../../../../hooks'; import { stringifyUrlParams } from '../../../../lib/helper/stringify_url_params'; -import { MonitorSummary } from '../../../../../common/runtime_types/monitor'; +import { MonitorSummary } from '../../../../../../common/runtime_types/monitor'; import { useFilterUpdate } from '../../../../hooks/use_filter_update'; interface Props { diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/monitor_status_column.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/monitor_status_column.test.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/monitor_status_column.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/monitor_status_column.test.tsx index a6c837ca13a7f..a69ebb3d349fd 100644 --- a/x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/monitor_status_column.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/monitor_status_column.test.tsx @@ -7,8 +7,8 @@ import React from 'react'; import { getLocationStatus, MonitorListStatusColumn } from './monitor_status_column'; -import { Ping } from '../../../../../common/runtime_types'; -import { STATUS } from '../../../../../common/constants'; +import { Ping } from '../../../../../../common/runtime_types'; +import { STATUS } from '../../../../../../common/constants'; import { EuiThemeProvider } from '@kbn/kibana-react-plugin/common'; import { mockDate, mockMoment } from '../../../../lib/helper/test_helpers'; import { render } from '../../../../lib/helper/rtl_helpers'; diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/monitor_status_column.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/monitor_status_column.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/monitor_status_column.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/monitor_status_column.tsx index 6fb3a463ebf77..7f64c1199c2b0 100644 --- a/x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/monitor_status_column.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/monitor_status_column.tsx @@ -23,13 +23,13 @@ import { euiStyled } from '@kbn/kibana-react-plugin/common'; import { kibanaService } from '../../../../state/kibana_service'; import { useRunOnceErrors } from '../../../monitor_management/hooks/use_run_once_errors'; import { parseTimestamp } from '../parse_timestamp'; -import { DataStream, Ping, PingError } from '../../../../../common/runtime_types'; +import { DataStream, Ping, PingError } from '../../../../../../common/runtime_types'; import { STATUS, SHORT_TIMESPAN_LOCALE, UNNAMED_LOCATION, SHORT_TS_LOCALE, -} from '../../../../../common/constants'; +} from '../../../../../../common/constants'; import { STATUS_DOWN_LABEL, STATUS_UP_LABEL } from '../../../common/translations'; import { MonitorProgress } from './progress/monitor_progress'; diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/progress/browser_monitor_progress.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/progress/browser_monitor_progress.tsx similarity index 93% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/progress/browser_monitor_progress.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/progress/browser_monitor_progress.tsx index b92916bd7b72b..0692af54b9bf4 100644 --- a/x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/progress/browser_monitor_progress.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/progress/browser_monitor_progress.tsx @@ -7,8 +7,8 @@ import { EuiBadge, EuiProgress } from '@elastic/eui'; import React, { useEffect, useRef, useState } from 'react'; -import { scheduleToMilli } from '../../../../../../common/lib/schedule_to_time'; -import { SyntheticsMonitorSchedule } from '../../../../../../common/runtime_types'; +import { scheduleToMilli } from '../../../../../../../common/lib/schedule_to_time'; +import { SyntheticsMonitorSchedule } from '../../../../../../../common/runtime_types'; import { useBrowserRunOnceMonitors } from '../../../../monitor_management/test_now_mode/browser/use_browser_run_once_monitors'; import { IN_PROGRESS_LABEL, diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/progress/monitor_progress.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/progress/monitor_progress.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/progress/monitor_progress.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/progress/monitor_progress.tsx index b03d278f09d45..ebc28310930ad 100644 --- a/x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/progress/monitor_progress.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/progress/monitor_progress.tsx @@ -9,7 +9,7 @@ import React, { useEffect } from 'react'; import { useSelector } from 'react-redux'; import { SimpleMonitorProgress } from './simple_monitor_progress'; import { BrowserMonitorProgress } from './browser_monitor_progress'; -import { DataStream, SyntheticsMonitorSchedule } from '../../../../../../common/runtime_types'; +import { DataStream, SyntheticsMonitorSchedule } from '../../../../../../../common/runtime_types'; import { useUpdatedMonitor } from './use_updated_monitor'; import { refreshedMonitorSelector } from '../../../../../state/reducers/monitor_list'; diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/progress/simple_monitor_progress.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/progress/simple_monitor_progress.tsx similarity index 92% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/progress/simple_monitor_progress.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/progress/simple_monitor_progress.tsx index f93bcadd58519..bbc96eeda397b 100644 --- a/x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/progress/simple_monitor_progress.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/progress/simple_monitor_progress.tsx @@ -7,8 +7,8 @@ import { EuiBadge, EuiProgress } from '@elastic/eui'; import React, { useEffect, useRef, useState } from 'react'; -import { scheduleToMilli } from '../../../../../../common/lib/schedule_to_time'; -import { SyntheticsMonitorSchedule } from '../../../../../../common/runtime_types'; +import { scheduleToMilli } from '../../../../../../../common/lib/schedule_to_time'; +import { SyntheticsMonitorSchedule } from '../../../../../../../common/runtime_types'; import { useSimpleRunOnceMonitors } from '../../../../monitor_management/test_now_mode/simple/use_simple_run_once_monitors'; import { IN_PROGRESS_LABEL } from '../../../../monitor_management/test_now_mode/test_result_header'; diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/progress/use_updated_monitor.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/progress/use_updated_monitor.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/progress/use_updated_monitor.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/progress/use_updated_monitor.ts diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/status_badge.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/status_badge.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/status_badge.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/status_badge.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/status_badge.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/status_badge.tsx similarity index 93% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/status_badge.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/status_badge.tsx index fe2c7730275db..0328242ffc036 100644 --- a/x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/status_badge.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/status_badge.tsx @@ -7,10 +7,10 @@ import { EuiBadge, EuiToolTip } from '@elastic/eui'; import React, { useContext, useState } from 'react'; -import { STATUS } from '../../../../../common/constants'; +import { STATUS } from '../../../../../../common/constants'; import { getHealthMessage } from './monitor_status_column'; import { UptimeThemeContext } from '../../../../contexts'; -import { PingError } from '../../../../../common/runtime_types'; +import { PingError } from '../../../../../../common/runtime_types'; import { getInlineErrorLabel } from '../../../monitor_management/monitor_list/inline_error'; import { StdErrorPopover } from '../../../monitor_management/monitor_list/stderr_logs_popover'; diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/test_now_col.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/test_now_col.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/test_now_col.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/test_now_col.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/translations.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/translations.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/columns/translations.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/columns/translations.ts diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/filter_status_button.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/filter_status_button.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/filter_status_button.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/filter_status_button.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/filter_status_button.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/filter_status_button.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/filter_status_button.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/filter_status_button.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/index.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/index.ts diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list.test.tsx similarity index 99% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list.test.tsx index 495facf9c2cc8..d0026b1c5f0ba 100644 --- a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list.test.tsx @@ -14,7 +14,7 @@ import { makePing, Ping, MonitorSummary, -} from '../../../../common/runtime_types'; +} from '../../../../../common/runtime_types'; import { MonitorListComponent } from './monitor_list'; import moment from 'moment'; import { IHttpFetchError, ResponseErrorBody } from '@kbn/core/public'; diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list.tsx index bf33bc52ffb68..c5a38067965c3 100644 --- a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list.tsx @@ -18,8 +18,8 @@ import { getBreakpoint, } from '@elastic/eui'; import { euiStyled } from '@kbn/kibana-react-plugin/common'; -import { X509Expiry } from '../../../../common/runtime_types'; -import { MonitorSummary } from '../../../../common/runtime_types'; +import { X509Expiry } from '../../../../../common/runtime_types'; +import { MonitorSummary } from '../../../../../common/runtime_types'; import { MonitorListStatusColumn } from './columns/monitor_status_column'; import { ExpandedRowMap } from './types'; import { MonitorBarSeries } from '../../common/charts'; diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_container.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_container.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_container.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_container.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/__snapshots__/integration_group.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/__snapshots__/integration_group.test.tsx.snap similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/__snapshots__/integration_group.test.tsx.snap rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/__snapshots__/integration_group.test.tsx.snap diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/__snapshots__/integration_link.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/__snapshots__/integration_link.test.tsx.snap similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/__snapshots__/integration_link.test.tsx.snap rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/__snapshots__/integration_link.test.tsx.snap diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/__snapshots__/monitor_list_drawer.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/__snapshots__/monitor_list_drawer.test.tsx.snap similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/__snapshots__/monitor_list_drawer.test.tsx.snap rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/__snapshots__/monitor_list_drawer.test.tsx.snap diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/__snapshots__/most_recent_error.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/__snapshots__/most_recent_error.test.tsx.snap similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/__snapshots__/most_recent_error.test.tsx.snap rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/__snapshots__/most_recent_error.test.tsx.snap diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/actions_popover/actions_popover.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/actions_popover/actions_popover.tsx similarity index 96% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/actions_popover/actions_popover.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/actions_popover/actions_popover.tsx index eee1c461fb1cb..9a8b660cb41bb 100644 --- a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/actions_popover/actions_popover.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/actions_popover/actions_popover.tsx @@ -9,7 +9,7 @@ import { i18n } from '@kbn/i18n'; import React from 'react'; import { EuiPopover, EuiButton } from '@elastic/eui'; import { IntegrationGroup } from './integration_group'; -import { MonitorSummary } from '../../../../../../common/runtime_types'; +import { MonitorSummary } from '../../../../../../../common/runtime_types'; import { toggleIntegrationsPopover, PopoverState } from '../../../../../state/actions'; export interface ActionsPopoverProps { diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/actions_popover/actions_popover_container.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/actions_popover/actions_popover_container.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/actions_popover/actions_popover_container.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/actions_popover/actions_popover_container.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/actions_popover/integration_group.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/actions_popover/integration_group.tsx similarity index 99% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/actions_popover/integration_group.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/actions_popover/integration_group.tsx index 97d1e8da61a7f..51d24978026e4 100644 --- a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/actions_popover/integration_group.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/actions_popover/integration_group.tsx @@ -19,7 +19,7 @@ import { getLoggingIpHref, getLoggingKubernetesHref, } from '../../../../../lib/helper'; -import { MonitorSummary } from '../../../../../../common/runtime_types'; +import { MonitorSummary } from '../../../../../../../common/runtime_types'; import { UptimeSettingsContext } from '../../../../../contexts'; interface IntegrationGroupProps { diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/actions_popover/integration_link.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/actions_popover/integration_link.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/actions_popover/integration_link.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/actions_popover/integration_link.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/data.json b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/data.json similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/data.json rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/data.json diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/enabled_alerts.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/enabled_alerts.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/enabled_alerts.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/enabled_alerts.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/index.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/index.ts diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/integration_group.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/integration_group.test.tsx similarity index 97% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/integration_group.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/integration_group.test.tsx index 5f50285063541..ee58d2f78d31a 100644 --- a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/integration_group.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/integration_group.test.tsx @@ -6,7 +6,7 @@ */ import React from 'react'; -import { MonitorSummary, makePing } from '../../../../../common/runtime_types'; +import { MonitorSummary, makePing } from '../../../../../../common/runtime_types'; import { shallowWithIntl } from '@kbn/test-jest-helpers'; import { IntegrationGroup, extractSummaryValues } from './actions_popover/integration_group'; diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/integration_link.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/integration_link.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/integration_link.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/integration_link.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/list_drawer_container.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/list_drawer_container.tsx similarity index 96% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/list_drawer_container.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/list_drawer_container.tsx index 2b97f53f21356..a0708712c8cd3 100644 --- a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/list_drawer_container.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/list_drawer_container.tsx @@ -12,7 +12,7 @@ import { monitorDetailsLoadingSelector, monitorDetailsSelector } from '../../../ import { getMonitorDetailsAction } from '../../../../state/actions/monitor'; import { MonitorListDrawerComponent } from './monitor_list_drawer'; import { useGetUrlParams } from '../../../../hooks'; -import { MonitorSummary } from '../../../../../common/runtime_types'; +import { MonitorSummary } from '../../../../../../common/runtime_types'; import { alertsSelector } from '../../../../state/alerts/alerts'; import { UptimeRefreshContext } from '../../../../contexts'; diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/monitor_list_drawer.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/monitor_list_drawer.test.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/monitor_list_drawer.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/monitor_list_drawer.test.tsx index 240697af470b0..78a70d14fa271 100644 --- a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/monitor_list_drawer.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/monitor_list_drawer.test.tsx @@ -7,7 +7,7 @@ import React from 'react'; import { MonitorListDrawerComponent } from './monitor_list_drawer'; -import { MonitorDetails, MonitorSummary, makePing } from '../../../../../common/runtime_types'; +import { MonitorDetails, MonitorSummary, makePing } from '../../../../../../common/runtime_types'; import { shallowWithRouter } from '../../../../lib'; describe('MonitorListDrawer component', () => { diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/monitor_list_drawer.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/monitor_list_drawer.tsx similarity index 96% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/monitor_list_drawer.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/monitor_list_drawer.tsx index 092614b870bda..81648bee153cd 100644 --- a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/monitor_list_drawer.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/monitor_list_drawer.tsx @@ -11,7 +11,7 @@ import { EuiFlexGroup, EuiFlexItem, EuiSpacer } from '@elastic/eui'; import { Rule } from '@kbn/triggers-actions-ui-plugin/public'; import { MostRecentError } from './most_recent_error'; import { MonitorStatusList } from './monitor_status_list'; -import { MonitorDetails, MonitorSummary } from '../../../../../common/runtime_types'; +import { MonitorDetails, MonitorSummary } from '../../../../../../common/runtime_types'; import { ActionsPopover } from './actions_popover/actions_popover_container'; import { EnabledAlerts } from './enabled_alerts'; import { MonitorUrl } from './monitor_url'; diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/monitor_status_list.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/monitor_status_list.test.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/monitor_status_list.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/monitor_status_list.test.tsx index ad9347ab84763..f1a9d1b2629a6 100644 --- a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/monitor_status_list.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/monitor_status_list.test.tsx @@ -7,7 +7,7 @@ import React from 'react'; import { MonitorStatusList } from './monitor_status_list'; -import { Ping } from '../../../../../common/runtime_types'; +import { Ping } from '../../../../../../common/runtime_types'; import { mockMoment } from '../../../../lib/helper/test_helpers'; import { render } from '../../../../lib/helper/rtl_helpers'; diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/monitor_status_list.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/monitor_status_list.tsx similarity index 94% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/monitor_status_list.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/monitor_status_list.tsx index 1207798a34023..753ae0b1390db 100644 --- a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/monitor_status_list.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/monitor_status_list.tsx @@ -10,8 +10,8 @@ import { EuiCallOut, EuiFlexGroup, EuiFlexItem, EuiSpacer } from '@elastic/eui'; import { FormattedMessage } from '@kbn/i18n-react'; import { LocationLink } from '../../../common/location_link'; import { MonitorStatusRow } from './monitor_status_row'; -import { Ping } from '../../../../../common/runtime_types'; -import { STATUS, UNNAMED_LOCATION } from '../../../../../common/constants'; +import { Ping } from '../../../../../../common/runtime_types'; +import { STATUS, UNNAMED_LOCATION } from '../../../../../../common/constants'; interface MonitorStatusListProps { /** diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/monitor_status_row.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/monitor_status_row.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/monitor_status_row.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/monitor_status_row.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/monitor_status_row.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/monitor_status_row.tsx similarity index 95% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/monitor_status_row.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/monitor_status_row.tsx index 4bfe079e73a3f..7804b9bc94b5e 100644 --- a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/monitor_status_row.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/monitor_status_row.tsx @@ -8,7 +8,7 @@ import React from 'react'; import { i18n } from '@kbn/i18n'; import { EuiBadge, EuiSpacer } from '@elastic/eui'; -import { UNNAMED_LOCATION, STATUS } from '../../../../../common/constants'; +import { UNNAMED_LOCATION, STATUS } from '../../../../../../common/constants'; import { getHealthMessage } from '../columns/monitor_status_column'; interface MonitorStatusRowProps { diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/monitor_url.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/monitor_url.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/monitor_url.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/monitor_url.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/most_recent_error.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/most_recent_error.test.tsx similarity index 95% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/most_recent_error.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/most_recent_error.test.tsx index 111a8a18ccad5..e3b36645ba7f3 100644 --- a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/most_recent_error.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/most_recent_error.test.tsx @@ -10,7 +10,7 @@ import React from 'react'; import moment from 'moment'; import { BrowserRouter as Router } from 'react-router-dom'; import { MostRecentError } from './most_recent_error'; -import { MonitorDetails, PingError } from '../../../../../common/runtime_types'; +import { MonitorDetails, PingError } from '../../../../../../common/runtime_types'; describe('MostRecentError component', () => { let monitorDetails: MonitorDetails; diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/most_recent_error.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/most_recent_error.tsx similarity index 96% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/most_recent_error.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/most_recent_error.tsx index 0b7c270c1b636..00484b8c40070 100644 --- a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/most_recent_error.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/most_recent_error.tsx @@ -16,7 +16,7 @@ import { i18n } from '@kbn/i18n'; import { MonitorPageLink } from '../../../common/monitor_page_link'; import { useGetUrlParams } from '../../../../hooks'; import { stringifyUrlParams } from '../../../../lib/helper/stringify_url_params'; -import { PingError } from '../../../../../common/runtime_types'; +import { PingError } from '../../../../../../common/runtime_types'; interface MostRecentErrorProps { /** diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/most_recent_run.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/most_recent_run.tsx similarity index 93% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/most_recent_run.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/most_recent_run.tsx index 32fff166a228e..06bb51c959404 100644 --- a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_drawer/most_recent_run.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_drawer/most_recent_run.tsx @@ -14,7 +14,7 @@ import { } from '@elastic/eui'; import moment from 'moment'; import { i18n } from '@kbn/i18n'; -import { MonitorSummary } from '../../../../../common/runtime_types'; +import { MonitorSummary } from '../../../../../../common/runtime_types'; interface Props { summary: MonitorSummary; diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_header.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_header.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_header.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_header.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_page_size_select.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_page_size_select.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_page_size_select.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_page_size_select.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_page_size_select.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_page_size_select.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/monitor_list_page_size_select.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/monitor_list_page_size_select.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/no_items_meesage.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/no_items_meesage.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/no_items_meesage.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/no_items_meesage.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/no_items_message.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/no_items_message.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/no_items_message.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/no_items_message.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/overview_page_link.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/overview_page_link.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/overview_page_link.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/overview_page_link.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/parse_timestamp.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/parse_timestamp.test.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/parse_timestamp.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/parse_timestamp.test.ts diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/parse_timestamp.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/parse_timestamp.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/parse_timestamp.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/parse_timestamp.ts diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/status_filter.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/status_filter.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/status_filter.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/status_filter.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/status_filter.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/status_filter.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/status_filter.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/status_filter.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/translations.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/translations.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/translations.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/translations.ts diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/troubleshoot_popover.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/troubleshoot_popover.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/troubleshoot_popover.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/troubleshoot_popover.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/types.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/types.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/types.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/types.ts diff --git a/x-pack/plugins/synthetics/public/components/overview/monitor_list/use_monitor_histogram.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/use_monitor_histogram.ts similarity index 94% rename from x-pack/plugins/synthetics/public/components/overview/monitor_list/use_monitor_histogram.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/use_monitor_histogram.ts index 8a6fb5a174856..1a9b7b73732af 100644 --- a/x-pack/plugins/synthetics/public/components/overview/monitor_list/use_monitor_histogram.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/monitor_list/use_monitor_histogram.ts @@ -13,12 +13,12 @@ import { Histogram, HistogramPoint, MonitorSummary, -} from '../../../../common/runtime_types/monitor'; +} from '../../../../../common/runtime_types/monitor'; import { useGetUrlParams } from '../../../hooks'; import { UptimeRefreshContext } from '../../../contexts'; import { esKuerySelector } from '../../../state/selectors'; -import { getHistogramInterval } from '../../../../common/lib/get_histogram_interval'; -import { Ping } from '../../../../common/runtime_types'; +import { getHistogramInterval } from '../../../../../common/lib/get_histogram_interval'; +import { Ping } from '../../../../../common/runtime_types'; export const useMonitorHistogram = ({ items }: { items: MonitorSummary[] }) => { const { dateRangeStart, dateRangeEnd, statusFilter } = useGetUrlParams(); diff --git a/x-pack/plugins/synthetics/public/components/overview/query_bar/query_bar.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/query_bar/query_bar.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/query_bar/query_bar.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/query_bar/query_bar.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/query_bar/translations.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/query_bar/translations.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/query_bar/translations.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/query_bar/translations.ts diff --git a/x-pack/plugins/synthetics/public/components/overview/query_bar/use_query_bar.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/query_bar/use_query_bar.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/query_bar/use_query_bar.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/query_bar/use_query_bar.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/query_bar/use_query_bar.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/query_bar/use_query_bar.ts similarity index 98% rename from x-pack/plugins/synthetics/public/components/overview/query_bar/use_query_bar.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/query_bar/use_query_bar.ts index 30658081183d5..75351e5872f35 100644 --- a/x-pack/plugins/synthetics/public/components/overview/query_bar/use_query_bar.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/query_bar/use_query_bar.ts @@ -17,7 +17,7 @@ import { useUrlParams, } from '../../../hooks'; import { setEsKueryString } from '../../../state/actions'; -import { UptimePluginServices } from '../../../apps/plugin'; +import { UptimePluginServices } from '../../../../plugin'; export enum SyntaxType { text = 'text', diff --git a/x-pack/plugins/synthetics/public/components/overview/snapshot/__snapshots__/snapshot.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/snapshot/__snapshots__/snapshot.test.tsx.snap similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/snapshot/__snapshots__/snapshot.test.tsx.snap rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/snapshot/__snapshots__/snapshot.test.tsx.snap diff --git a/x-pack/plugins/synthetics/public/components/overview/snapshot/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/snapshot/index.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/snapshot/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/snapshot/index.ts diff --git a/x-pack/plugins/synthetics/public/components/overview/snapshot/snapshot.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/snapshot/snapshot.test.tsx similarity index 91% rename from x-pack/plugins/synthetics/public/components/overview/snapshot/snapshot.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/snapshot/snapshot.test.tsx index 3cea8199544d4..322db8908cca7 100644 --- a/x-pack/plugins/synthetics/public/components/overview/snapshot/snapshot.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/snapshot/snapshot.test.tsx @@ -8,7 +8,7 @@ import React from 'react'; import { shallowWithIntl } from '@kbn/test-jest-helpers'; import { SnapshotComponent } from './snapshot'; -import { Snapshot } from '../../../../common/runtime_types/snapshot'; +import { Snapshot } from '../../../../../common/runtime_types/snapshot'; import * as hook from './use_snap_shot'; describe('Snapshot component', () => { diff --git a/x-pack/plugins/synthetics/public/components/overview/snapshot/snapshot.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/snapshot/snapshot.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/snapshot/snapshot.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/snapshot/snapshot.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/snapshot/snapshot_heading.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/snapshot/snapshot_heading.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/snapshot/snapshot_heading.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/snapshot/snapshot_heading.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/snapshot/use_snap_shot.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/snapshot/use_snap_shot.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/snapshot/use_snap_shot.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/snapshot/use_snap_shot.ts diff --git a/x-pack/plugins/synthetics/public/components/overview/snapshot_heading.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/snapshot_heading.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/snapshot_heading.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/snapshot_heading.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/status_panel.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/status_panel.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/status_panel.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/status_panel.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/synthetics_callout.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/synthetics_callout.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/synthetics_callout.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/synthetics_callout.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/overview/synthetics_callout.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/overview/synthetics_callout.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/overview/synthetics_callout.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/overview/synthetics_callout.tsx diff --git a/x-pack/plugins/synthetics/public/components/settings/__snapshots__/certificate_form.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/settings/__snapshots__/certificate_form.test.tsx.snap similarity index 100% rename from x-pack/plugins/synthetics/public/components/settings/__snapshots__/certificate_form.test.tsx.snap rename to x-pack/plugins/synthetics/public/legacy_uptime/components/settings/__snapshots__/certificate_form.test.tsx.snap diff --git a/x-pack/plugins/synthetics/public/components/settings/__snapshots__/indices_form.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/components/settings/__snapshots__/indices_form.test.tsx.snap similarity index 100% rename from x-pack/plugins/synthetics/public/components/settings/__snapshots__/indices_form.test.tsx.snap rename to x-pack/plugins/synthetics/public/legacy_uptime/components/settings/__snapshots__/indices_form.test.tsx.snap diff --git a/x-pack/plugins/synthetics/public/components/settings/add_connector_flyout.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/settings/add_connector_flyout.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/settings/add_connector_flyout.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/settings/add_connector_flyout.tsx diff --git a/x-pack/plugins/synthetics/public/components/settings/alert_defaults_form.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/settings/alert_defaults_form.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/settings/alert_defaults_form.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/settings/alert_defaults_form.tsx diff --git a/x-pack/plugins/synthetics/public/components/settings/certificate_form.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/settings/certificate_form.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/settings/certificate_form.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/settings/certificate_form.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/settings/certificate_form.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/settings/certificate_form.tsx similarity index 97% rename from x-pack/plugins/synthetics/public/components/settings/certificate_form.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/settings/certificate_form.tsx index 2deecc8809074..dc44a7074c33f 100644 --- a/x-pack/plugins/synthetics/public/components/settings/certificate_form.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/settings/certificate_form.tsx @@ -18,8 +18,8 @@ import { EuiFlexGroup, EuiFlexItem, } from '@elastic/eui'; -import { DYNAMIC_SETTINGS_DEFAULTS } from '../../../common/constants'; -import { DefaultEmail, DynamicSettings } from '../../../common/runtime_types'; +import { DYNAMIC_SETTINGS_DEFAULTS } from '../../../../common/constants'; +import { DefaultEmail, DynamicSettings } from '../../../../common/runtime_types'; import { SettingsFormProps } from '../../pages/settings'; import { certificateFormTranslations } from './translations'; diff --git a/x-pack/plugins/synthetics/public/components/settings/default_email.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/settings/default_email.tsx similarity index 95% rename from x-pack/plugins/synthetics/public/components/settings/default_email.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/settings/default_email.tsx index 5a777fa644f82..5ba6278664c61 100644 --- a/x-pack/plugins/synthetics/public/components/settings/default_email.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/settings/default_email.tsx @@ -12,8 +12,8 @@ import { EuiDescribedFormGroup } from '@elastic/eui'; import { useKibana } from '@kbn/kibana-react-plugin/public'; import { OnFieldChangeType } from './certificate_form'; import { connectorsSelector } from '../../state/alerts/alerts'; -import { DefaultEmail as DefaultEmailType } from '../../../common/runtime_types'; -import { UptimePluginServices } from '../../apps/plugin'; +import { DefaultEmail as DefaultEmailType } from '../../../../common/runtime_types'; +import { UptimePluginServices } from '../../../plugin'; import { SettingsPageFieldErrors } from '../../pages/settings'; export function DefaultEmail({ diff --git a/x-pack/plugins/synthetics/public/components/settings/indices_form.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/settings/indices_form.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/settings/indices_form.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/settings/indices_form.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/settings/indices_form.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/settings/indices_form.tsx similarity index 97% rename from x-pack/plugins/synthetics/public/components/settings/indices_form.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/settings/indices_form.tsx index f11626f231eae..4fe2917fbd357 100644 --- a/x-pack/plugins/synthetics/public/components/settings/indices_form.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/settings/indices_form.tsx @@ -15,7 +15,7 @@ import { EuiTitle, EuiSpacer, } from '@elastic/eui'; -import { DYNAMIC_SETTINGS_DEFAULTS } from '../../../common/constants'; +import { DYNAMIC_SETTINGS_DEFAULTS } from '../../../../common/constants'; import { SettingsFormProps } from '../../pages/settings'; export const IndicesForm: React.FC = ({ diff --git a/x-pack/plugins/synthetics/public/components/settings/settings_actions.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/settings/settings_actions.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/settings/settings_actions.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/settings/settings_actions.tsx diff --git a/x-pack/plugins/synthetics/public/components/settings/settings_bottom_bar.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/settings/settings_bottom_bar.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/settings/settings_bottom_bar.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/settings/settings_bottom_bar.tsx diff --git a/x-pack/plugins/synthetics/public/components/settings/translations.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/settings/translations.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/settings/translations.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/settings/translations.ts diff --git a/x-pack/plugins/synthetics/public/components/settings/types.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/settings/types.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/settings/types.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/settings/types.ts diff --git a/x-pack/plugins/synthetics/public/components/settings/use_settings_errors.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/settings/use_settings_errors.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/settings/use_settings_errors.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/settings/use_settings_errors.ts diff --git a/x-pack/plugins/synthetics/public/components/synthetics/check_steps/stderr_logs.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/stderr_logs.tsx similarity index 97% rename from x-pack/plugins/synthetics/public/components/synthetics/check_steps/stderr_logs.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/stderr_logs.tsx index 6192ee3866913..d127b67efc8e6 100644 --- a/x-pack/plugins/synthetics/public/components/synthetics/check_steps/stderr_logs.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/stderr_logs.tsx @@ -26,9 +26,9 @@ import { useSelector } from 'react-redux'; import { useKibana } from '@kbn/kibana-react-plugin/public'; import { useFetcher } from '@kbn/observability-plugin/public'; import { useStdErrorLogs } from './use_std_error_logs'; -import { ClientPluginsStart } from '../../../apps/plugin'; +import { ClientPluginsStart } from '../../../../plugin'; import { selectDynamicSettings } from '../../../state/selectors'; -import { Ping } from '../../../../common/runtime_types'; +import { Ping } from '../../../../../common/runtime_types'; export const StdErrorLogs = ({ configId, diff --git a/x-pack/plugins/synthetics/public/components/synthetics/check_steps/step_duration.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/step_duration.tsx similarity index 97% rename from x-pack/plugins/synthetics/public/components/synthetics/check_steps/step_duration.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/step_duration.tsx index 92a4ab24433f8..f0e05c2072782 100644 --- a/x-pack/plugins/synthetics/public/components/synthetics/check_steps/step_duration.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/step_duration.tsx @@ -11,7 +11,7 @@ import * as React from 'react'; import { EuiButtonEmpty, EuiPopover, EuiText } from '@elastic/eui'; import { useMemo } from 'react'; import { i18n } from '@kbn/i18n'; -import { JourneyStep } from '../../../../common/runtime_types'; +import { JourneyStep } from '../../../../../common/runtime_types'; import { StepFieldTrend } from './step_field_trend'; import { microToSec } from '../../../lib/formatting'; diff --git a/x-pack/plugins/synthetics/public/components/synthetics/check_steps/step_expanded_row/screenshot_link.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/step_expanded_row/screenshot_link.tsx similarity index 95% rename from x-pack/plugins/synthetics/public/components/synthetics/check_steps/step_expanded_row/screenshot_link.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/step_expanded_row/screenshot_link.tsx index d4d2536e47851..2ef6c7718f7bc 100644 --- a/x-pack/plugins/synthetics/public/components/synthetics/check_steps/step_expanded_row/screenshot_link.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/step_expanded_row/screenshot_link.tsx @@ -9,7 +9,7 @@ import React from 'react'; import { FormattedMessage } from '@kbn/i18n-react'; import { euiStyled } from '@kbn/kibana-react-plugin/common'; import { ReactRouterEuiLink } from '../../../common/react_router_helpers'; -import { Ping } from '../../../../../common/runtime_types/ping/ping'; +import { Ping } from '../../../../../../common/runtime_types/ping/ping'; const LabelLink = euiStyled.div` margin-bottom: ${(props) => props.theme.eui.paddingSizes.xs}; diff --git a/x-pack/plugins/synthetics/public/components/synthetics/check_steps/step_expanded_row/step_screenshots.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/step_expanded_row/step_screenshots.tsx similarity index 95% rename from x-pack/plugins/synthetics/public/components/synthetics/check_steps/step_expanded_row/step_screenshots.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/step_expanded_row/step_screenshots.tsx index 0277a47804fc6..d0db4a99a495e 100644 --- a/x-pack/plugins/synthetics/public/components/synthetics/check_steps/step_expanded_row/step_screenshots.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/step_expanded_row/step_screenshots.tsx @@ -12,8 +12,8 @@ import { FormattedMessage } from '@kbn/i18n-react'; import { euiStyled } from '@kbn/kibana-react-plugin/common'; import { useFetcher } from '@kbn/observability-plugin/public'; import { StepScreenshotDisplay } from '../../step_screenshot_display'; -import { JourneyStep } from '../../../../../common/runtime_types/ping/synthetics'; -import { Ping } from '../../../../../common/runtime_types/ping/ping'; +import { JourneyStep } from '../../../../../../common/runtime_types/ping/synthetics'; +import { Ping } from '../../../../../../common/runtime_types/ping/ping'; import { fetchLastSuccessfulCheck } from '../../../../state/api/journey'; import { ScreenshotLink } from './screenshot_link'; import { getShortTimeStamp } from '../../../overview/monitor_list/columns/monitor_status_column'; diff --git a/x-pack/plugins/synthetics/public/components/synthetics/check_steps/step_field_trend.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/step_field_trend.test.tsx similarity index 97% rename from x-pack/plugins/synthetics/public/components/synthetics/check_steps/step_field_trend.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/step_field_trend.test.tsx index 165208c032705..741d00fcc072d 100644 --- a/x-pack/plugins/synthetics/public/components/synthetics/check_steps/step_field_trend.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/step_field_trend.test.tsx @@ -8,7 +8,7 @@ import React from 'react'; import { getLast48Intervals, StepFieldTrend } from './step_field_trend'; import { render } from '../../../lib/helper/rtl_helpers'; -import { JourneyStep } from '../../../../common/runtime_types'; +import { JourneyStep } from '../../../../../common/runtime_types'; const step: JourneyStep = { _id: 'docID', diff --git a/x-pack/plugins/synthetics/public/components/synthetics/check_steps/step_field_trend.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/step_field_trend.tsx similarity index 97% rename from x-pack/plugins/synthetics/public/components/synthetics/check_steps/step_field_trend.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/step_field_trend.tsx index cd1b9df222e58..e03656ed562dc 100644 --- a/x-pack/plugins/synthetics/public/components/synthetics/check_steps/step_field_trend.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/step_field_trend.tsx @@ -13,7 +13,7 @@ import { useSelector } from 'react-redux'; import { AllSeries, createExploratoryViewUrl } from '@kbn/observability-plugin/public'; import { euiStyled } from '@kbn/kibana-react-plugin/common'; import { useKibana } from '@kbn/kibana-react-plugin/public'; -import { JourneyStep } from '../../../../common/runtime_types'; +import { JourneyStep } from '../../../../../common/runtime_types'; import { useUptimeStartPlugins } from '../../../contexts/uptime_startup_plugins_context'; import { selectDynamicSettings } from '../../../state/selectors'; diff --git a/x-pack/plugins/synthetics/public/components/synthetics/check_steps/step_image.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/step_image.tsx similarity index 92% rename from x-pack/plugins/synthetics/public/components/synthetics/check_steps/step_image.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/step_image.tsx index 06410e79a22a2..f1280cfe368b1 100644 --- a/x-pack/plugins/synthetics/public/components/synthetics/check_steps/step_image.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/step_image.tsx @@ -7,7 +7,7 @@ import React from 'react'; import { EuiFlexGroup, EuiFlexItem, EuiText } from '@elastic/eui'; -import { JourneyStep } from '../../../../common/runtime_types/ping/synthetics'; +import { JourneyStep } from '../../../../../common/runtime_types/ping/synthetics'; import { PingTimestamp } from '../../monitor/ping_list/columns/ping_timestamp'; interface Props { diff --git a/x-pack/plugins/synthetics/public/components/synthetics/check_steps/steps_list.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/steps_list.test.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/synthetics/check_steps/steps_list.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/steps_list.test.tsx index 61535833822da..1a792dfa9f8d3 100644 --- a/x-pack/plugins/synthetics/public/components/synthetics/check_steps/steps_list.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/steps_list.test.tsx @@ -6,7 +6,7 @@ */ import React from 'react'; -import { JourneyStep } from '../../../../common/runtime_types/ping'; +import { JourneyStep } from '../../../../../common/runtime_types/ping'; import { StepsList } from './steps_list'; import { render, forDesktopOnly, forMobileOnly } from '../../../lib/helper/rtl_helpers'; import { VIEW_PERFORMANCE } from '../../monitor/synthetics/translations'; diff --git a/x-pack/plugins/synthetics/public/components/synthetics/check_steps/steps_list.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/steps_list.tsx similarity index 99% rename from x-pack/plugins/synthetics/public/components/synthetics/check_steps/steps_list.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/steps_list.tsx index 957c25225a614..d02b7ac0e51da 100644 --- a/x-pack/plugins/synthetics/public/components/synthetics/check_steps/steps_list.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/steps_list.tsx @@ -17,7 +17,7 @@ import { import { i18n } from '@kbn/i18n'; import React, { MouseEvent, useState } from 'react'; import styled from 'styled-components'; -import { JourneyStep } from '../../../../common/runtime_types'; +import { JourneyStep } from '../../../../../common/runtime_types'; import { STATUS_LABEL } from '../../monitor/ping_list/translations'; import { COLLAPSE_LABEL, EXPAND_LABEL, STEP_NAME_LABEL } from '../translations'; import { StatusBadge } from '../status_badge'; diff --git a/x-pack/plugins/synthetics/public/components/synthetics/check_steps/use_check_steps.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/use_check_steps.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/synthetics/check_steps/use_check_steps.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/use_check_steps.ts diff --git a/x-pack/plugins/synthetics/public/components/synthetics/check_steps/use_expanded_row.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/use_expanded_row.test.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/synthetics/check_steps/use_expanded_row.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/use_expanded_row.test.tsx index c16522804eed6..6d1dc3f80fe60 100644 --- a/x-pack/plugins/synthetics/public/components/synthetics/check_steps/use_expanded_row.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/use_expanded_row.test.tsx @@ -13,8 +13,8 @@ import { createMemoryHistory } from 'history'; import { EuiButtonIcon } from '@elastic/eui'; import { getExpandedStepCallback, useExpandedRow } from './use_expanded_row'; import { render } from '../../../lib/helper/rtl_helpers'; -import { JourneyStep } from '../../../../common/runtime_types'; -import { SYNTHETIC_CHECK_STEPS_ROUTE } from '../../../../common/constants'; +import { JourneyStep } from '../../../../../common/runtime_types'; +import { SYNTHETIC_CHECK_STEPS_ROUTE } from '../../../../../common/constants'; import { COLLAPSE_LABEL, EXPAND_LABEL } from '../translations'; import { act } from 'react-dom/test-utils'; diff --git a/x-pack/plugins/synthetics/public/components/synthetics/check_steps/use_expanded_row.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/use_expanded_row.tsx similarity index 97% rename from x-pack/plugins/synthetics/public/components/synthetics/check_steps/use_expanded_row.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/use_expanded_row.tsx index 1b3a641033dd7..51fe965c55fbc 100644 --- a/x-pack/plugins/synthetics/public/components/synthetics/check_steps/use_expanded_row.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/use_expanded_row.tsx @@ -8,7 +8,7 @@ import React, { useEffect, useState, useCallback } from 'react'; import { useParams } from 'react-router-dom'; import { ExecutedStep } from '../executed_step'; -import { JourneyStep } from '../../../../common/runtime_types/ping'; +import { JourneyStep } from '../../../../../common/runtime_types/ping'; interface HookProps { loading: boolean; diff --git a/x-pack/plugins/synthetics/public/components/synthetics/check_steps/use_std_error_logs.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/use_std_error_logs.ts similarity index 96% rename from x-pack/plugins/synthetics/public/components/synthetics/check_steps/use_std_error_logs.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/use_std_error_logs.ts index 11dfdcdcc434e..d6abd2445a9a7 100644 --- a/x-pack/plugins/synthetics/public/components/synthetics/check_steps/use_std_error_logs.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/check_steps/use_std_error_logs.ts @@ -8,7 +8,7 @@ import { useSelector } from 'react-redux'; import { createEsParams, useEsSearch } from '@kbn/observability-plugin/public'; import { selectDynamicSettings } from '../../../state/selectors'; -import { Ping } from '../../../../common/runtime_types'; +import { Ping } from '../../../../../common/runtime_types'; export const useStdErrorLogs = ({ configId, diff --git a/x-pack/plugins/synthetics/public/components/synthetics/code_block_accordion.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/code_block_accordion.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/synthetics/code_block_accordion.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/code_block_accordion.tsx diff --git a/x-pack/plugins/synthetics/public/components/synthetics/console_event.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/console_event.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/synthetics/console_event.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/console_event.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/synthetics/console_event.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/console_event.tsx similarity index 93% rename from x-pack/plugins/synthetics/public/components/synthetics/console_event.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/console_event.tsx index a9cde922e8926..aeceef2477e28 100644 --- a/x-pack/plugins/synthetics/public/components/synthetics/console_event.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/console_event.tsx @@ -8,7 +8,7 @@ import { EuiFlexItem, EuiFlexGroup } from '@elastic/eui'; import React, { useContext, FC } from 'react'; import { UptimeThemeContext } from '../../contexts'; -import { JourneyStep } from '../../../common/runtime_types/ping'; +import { JourneyStep } from '../../../../common/runtime_types/ping'; interface Props { event: JourneyStep; diff --git a/x-pack/plugins/synthetics/public/components/synthetics/console_output_event_list.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/console_output_event_list.test.tsx similarity index 96% rename from x-pack/plugins/synthetics/public/components/synthetics/console_output_event_list.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/console_output_event_list.test.tsx index d35e526208ae9..9e63ff070c752 100644 --- a/x-pack/plugins/synthetics/public/components/synthetics/console_output_event_list.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/console_output_event_list.test.tsx @@ -6,7 +6,7 @@ */ import React from 'react'; -import { JourneyStep } from '../../../common/runtime_types/ping/synthetics'; +import { JourneyStep } from '../../../../common/runtime_types/ping/synthetics'; import { render } from '../../lib/helper/rtl_helpers'; import { ConsoleOutputEventList } from './console_output_event_list'; diff --git a/x-pack/plugins/synthetics/public/components/synthetics/console_output_event_list.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/console_output_event_list.tsx similarity index 95% rename from x-pack/plugins/synthetics/public/components/synthetics/console_output_event_list.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/console_output_event_list.tsx index 4bf33663d920a..1019532e0a610 100644 --- a/x-pack/plugins/synthetics/public/components/synthetics/console_output_event_list.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/console_output_event_list.tsx @@ -9,7 +9,7 @@ import { EuiCodeBlock, EuiSpacer, EuiTitle } from '@elastic/eui'; import { FormattedMessage } from '@kbn/i18n-react'; import React, { FC } from 'react'; import { ConsoleEvent } from './console_event'; -import { JourneyStep } from '../../../common/runtime_types/ping'; +import { JourneyStep } from '../../../../common/runtime_types/ping'; import { JourneyState } from '../../state/reducers/journey'; interface Props { diff --git a/x-pack/plugins/synthetics/public/components/synthetics/empty_journey.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/empty_journey.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/synthetics/empty_journey.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/empty_journey.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/synthetics/empty_journey.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/empty_journey.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/synthetics/empty_journey.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/empty_journey.tsx diff --git a/x-pack/plugins/synthetics/public/components/synthetics/executed_step.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/executed_step.test.tsx similarity index 97% rename from x-pack/plugins/synthetics/public/components/synthetics/executed_step.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/executed_step.test.tsx index 81d506bd05413..8231fc5808506 100644 --- a/x-pack/plugins/synthetics/public/components/synthetics/executed_step.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/executed_step.test.tsx @@ -8,7 +8,7 @@ import React from 'react'; import { ExecutedStep } from './executed_step'; import { render } from '../../lib/helper/rtl_helpers'; -import { JourneyStep } from '../../../common/runtime_types/ping'; +import { JourneyStep } from '../../../../common/runtime_types/ping'; describe('ExecutedStep', () => { let step: JourneyStep; diff --git a/x-pack/plugins/synthetics/public/components/synthetics/executed_step.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/executed_step.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/components/synthetics/executed_step.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/executed_step.tsx index f3021894ec5ff..063dd9db0eae3 100644 --- a/x-pack/plugins/synthetics/public/components/synthetics/executed_step.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/executed_step.tsx @@ -10,7 +10,7 @@ import React, { FC } from 'react'; import { i18n } from '@kbn/i18n'; import { euiStyled } from '@kbn/kibana-react-plugin/common'; import { CodeBlockAccordion } from './code_block_accordion'; -import { JourneyStep } from '../../../common/runtime_types/ping'; +import { JourneyStep } from '../../../../common/runtime_types/ping'; import { StepScreenshots } from './check_steps/step_expanded_row/step_screenshots'; const CODE_BLOCK_OVERFLOW_HEIGHT = 360; diff --git a/x-pack/plugins/synthetics/public/components/synthetics/status_badge.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/status_badge.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/synthetics/status_badge.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/status_badge.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/synthetics/status_badge.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/status_badge.tsx similarity index 97% rename from x-pack/plugins/synthetics/public/components/synthetics/status_badge.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/status_badge.tsx index be9eb6178deae..4eba0f4b6a288 100644 --- a/x-pack/plugins/synthetics/public/components/synthetics/status_badge.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/status_badge.tsx @@ -8,7 +8,7 @@ import { EuiBadge, EuiFlexGroup, EuiFlexItem, EuiText } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; import React, { useContext, FC } from 'react'; -import { UptimeAppColors } from '../../apps/uptime_app'; +import { UptimeAppColors } from '../../app/uptime_app'; import { UptimeThemeContext } from '../../contexts'; interface StatusBadgeProps { diff --git a/x-pack/plugins/synthetics/public/components/synthetics/step_screenshot_display.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/step_screenshot_display.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/components/synthetics/step_screenshot_display.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/step_screenshot_display.test.tsx diff --git a/x-pack/plugins/synthetics/public/components/synthetics/step_screenshot_display.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/step_screenshot_display.tsx similarity index 99% rename from x-pack/plugins/synthetics/public/components/synthetics/step_screenshot_display.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/step_screenshot_display.tsx index bc3cda6cd93bc..b5a82eac7bad1 100644 --- a/x-pack/plugins/synthetics/public/components/synthetics/step_screenshot_display.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/step_screenshot_display.tsx @@ -22,7 +22,7 @@ import { useFetcher } from '@kbn/observability-plugin/public'; import { isScreenshotRef as isAScreenshotRef, ScreenshotRefImageData, -} from '../../../common/runtime_types'; +} from '../../../../common/runtime_types'; import { UptimeRefreshContext, UptimeSettingsContext, UptimeThemeContext } from '../../contexts'; import { getJourneyScreenshot } from '../../state/api/journey'; import { useCompositeImage } from '../../hooks'; diff --git a/x-pack/plugins/synthetics/public/components/synthetics/translations.ts b/x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/translations.ts similarity index 100% rename from x-pack/plugins/synthetics/public/components/synthetics/translations.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/components/synthetics/translations.ts diff --git a/x-pack/plugins/synthetics/public/contexts/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/contexts/index.ts similarity index 100% rename from x-pack/plugins/synthetics/public/contexts/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/contexts/index.ts diff --git a/x-pack/plugins/synthetics/public/contexts/uptime_data_view_context.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/contexts/uptime_data_view_context.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/contexts/uptime_data_view_context.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/contexts/uptime_data_view_context.tsx diff --git a/x-pack/plugins/synthetics/public/contexts/uptime_refresh_context.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/contexts/uptime_refresh_context.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/contexts/uptime_refresh_context.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/contexts/uptime_refresh_context.tsx diff --git a/x-pack/plugins/synthetics/public/contexts/uptime_settings_context.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/contexts/uptime_settings_context.tsx similarity index 94% rename from x-pack/plugins/synthetics/public/contexts/uptime_settings_context.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/contexts/uptime_settings_context.tsx index 4fda00db57bd7..d192f7327879c 100644 --- a/x-pack/plugins/synthetics/public/contexts/uptime_settings_context.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/contexts/uptime_settings_context.tsx @@ -6,8 +6,8 @@ */ import React, { createContext, useContext, useMemo } from 'react'; -import { UptimeAppProps } from '../apps/uptime_app'; -import { CLIENT_DEFAULTS, CONTEXT_DEFAULTS } from '../../common/constants'; +import { UptimeAppProps } from '../app/uptime_app'; +import { CLIENT_DEFAULTS, CONTEXT_DEFAULTS } from '../../../common/constants'; import { CommonlyUsedRange } from '../components/common/uptime_date_picker'; import { useGetUrlParams } from '../hooks'; diff --git a/x-pack/plugins/synthetics/public/contexts/uptime_startup_plugins_context.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/contexts/uptime_startup_plugins_context.tsx similarity index 92% rename from x-pack/plugins/synthetics/public/contexts/uptime_startup_plugins_context.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/contexts/uptime_startup_plugins_context.tsx index 8fbc8ae749c81..76754a52a3dfb 100644 --- a/x-pack/plugins/synthetics/public/contexts/uptime_startup_plugins_context.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/contexts/uptime_startup_plugins_context.tsx @@ -6,7 +6,7 @@ */ import React, { createContext, useContext } from 'react'; -import { ClientPluginsStart } from '../apps/plugin'; +import { ClientPluginsStart } from '../../plugin'; export const UptimeStartupPluginsContext = createContext>({}); diff --git a/x-pack/plugins/synthetics/public/contexts/uptime_theme_context.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/contexts/uptime_theme_context.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/contexts/uptime_theme_context.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/contexts/uptime_theme_context.tsx index 2d25cf6e84e1b..b37856b03e87e 100644 --- a/x-pack/plugins/synthetics/public/contexts/uptime_theme_context.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/contexts/uptime_theme_context.tsx @@ -9,7 +9,7 @@ import { euiLightVars, euiDarkVars } from '@kbn/ui-theme'; import React, { createContext, useMemo } from 'react'; import { EUI_CHARTS_THEME_DARK, EUI_CHARTS_THEME_LIGHT } from '@elastic/eui/dist/eui_charts_theme'; import { DARK_THEME, LIGHT_THEME, PartialTheme, Theme } from '@elastic/charts'; -import { UptimeAppColors } from '../apps/uptime_app'; +import { UptimeAppColors } from '../app/uptime_app'; export interface UptimeThemeContextValues { colors: UptimeAppColors; diff --git a/x-pack/plugins/synthetics/public/hooks/__snapshots__/use_url_params.test.tsx.snap b/x-pack/plugins/synthetics/public/legacy_uptime/hooks/__snapshots__/use_url_params.test.tsx.snap similarity index 100% rename from x-pack/plugins/synthetics/public/hooks/__snapshots__/use_url_params.test.tsx.snap rename to x-pack/plugins/synthetics/public/legacy_uptime/hooks/__snapshots__/use_url_params.test.tsx.snap diff --git a/x-pack/plugins/synthetics/public/hooks/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/hooks/index.ts similarity index 100% rename from x-pack/plugins/synthetics/public/hooks/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/hooks/index.ts diff --git a/x-pack/plugins/synthetics/public/hooks/update_kuery_string.ts b/x-pack/plugins/synthetics/public/legacy_uptime/hooks/update_kuery_string.ts similarity index 99% rename from x-pack/plugins/synthetics/public/hooks/update_kuery_string.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/hooks/update_kuery_string.ts index a8884279f49ba..007dfd12427f3 100644 --- a/x-pack/plugins/synthetics/public/hooks/update_kuery_string.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/hooks/update_kuery_string.ts @@ -7,7 +7,7 @@ import { fromKueryExpression, toElasticsearchQuery } from '@kbn/es-query'; import { DataView } from '@kbn/data-views-plugin/public'; -import { combineFiltersAndUserSearch, stringifyKueries } from '../../common/lib'; +import { combineFiltersAndUserSearch, stringifyKueries } from '../../../common/lib'; const getKueryString = (urlFilters: string, excludedFilters?: string): string => { let kueryString = ''; diff --git a/x-pack/plugins/synthetics/public/hooks/use_breadcrumbs.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_breadcrumbs.test.tsx similarity index 97% rename from x-pack/plugins/synthetics/public/hooks/use_breadcrumbs.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_breadcrumbs.test.tsx index e5b1a28ba72c6..35b5a1aa0994c 100644 --- a/x-pack/plugins/synthetics/public/hooks/use_breadcrumbs.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_breadcrumbs.test.tsx @@ -9,7 +9,7 @@ import { ChromeBreadcrumb } from '@kbn/core/public'; import React from 'react'; import { Route } from 'react-router-dom'; import { mountWithRouter } from '../lib'; -import { OVERVIEW_ROUTE } from '../../common/constants'; +import { OVERVIEW_ROUTE } from '../../../common/constants'; import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public'; import { UptimeUrlParams, getSupportedUrlParams, MountWithReduxProvider } from '../lib/helper'; import { makeBaseBreadcrumb, useBreadcrumbs } from './use_breadcrumbs'; diff --git a/x-pack/plugins/synthetics/public/hooks/use_breadcrumbs.ts b/x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_breadcrumbs.ts similarity index 97% rename from x-pack/plugins/synthetics/public/hooks/use_breadcrumbs.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_breadcrumbs.ts index cac62a79d92bf..26e9d2d0fd285 100644 --- a/x-pack/plugins/synthetics/public/hooks/use_breadcrumbs.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_breadcrumbs.ts @@ -13,7 +13,7 @@ import { useKibana } from '@kbn/kibana-react-plugin/public'; import { UptimeUrlParams } from '../lib/helper'; import { stringifyUrlParams } from '../lib/helper/stringify_url_params'; import { useUrlParams } from '.'; -import { PLUGIN } from '../../common/constants/plugin'; +import { PLUGIN } from '../../../common/constants/plugin'; const EMPTY_QUERY = '?'; diff --git a/x-pack/plugins/synthetics/public/hooks/use_breakpoints.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_breakpoints.test.ts similarity index 100% rename from x-pack/plugins/synthetics/public/hooks/use_breakpoints.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_breakpoints.test.ts diff --git a/x-pack/plugins/synthetics/public/hooks/use_breakpoints.ts b/x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_breakpoints.ts similarity index 100% rename from x-pack/plugins/synthetics/public/hooks/use_breakpoints.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_breakpoints.ts diff --git a/x-pack/plugins/synthetics/public/hooks/use_cert_status.ts b/x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_cert_status.ts similarity index 95% rename from x-pack/plugins/synthetics/public/hooks/use_cert_status.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_cert_status.ts index d82948632543b..934d72b71de6e 100644 --- a/x-pack/plugins/synthetics/public/hooks/use_cert_status.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_cert_status.ts @@ -8,7 +8,7 @@ import moment from 'moment'; import { useSelector } from 'react-redux'; import { selectDynamicSettings } from '../state/selectors'; -import { CERT_STATUS } from '../../common/constants'; +import { CERT_STATUS } from '../../../common/constants'; export const useCertStatus = (expiryDate?: string, issueDate?: string) => { const dss = useSelector(selectDynamicSettings); diff --git a/x-pack/plugins/synthetics/public/hooks/use_chart_theme.ts b/x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_chart_theme.ts similarity index 100% rename from x-pack/plugins/synthetics/public/hooks/use_chart_theme.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_chart_theme.ts diff --git a/x-pack/plugins/synthetics/public/hooks/use_composite_image.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_composite_image.test.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/hooks/use_composite_image.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_composite_image.test.tsx index 9e2cb1e498b73..50fc366f50dbe 100644 --- a/x-pack/plugins/synthetics/public/hooks/use_composite_image.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_composite_image.test.tsx @@ -7,7 +7,7 @@ import * as redux from 'react-redux'; import { renderHook } from '@testing-library/react-hooks'; -import { ScreenshotRefImageData } from '../../common/runtime_types'; +import { ScreenshotRefImageData } from '../../../common/runtime_types'; import { ScreenshotBlockCache } from '../state/reducers/synthetics'; import { shouldCompose, useCompositeImage } from './use_composite_image'; import * as compose from '../lib/helper/compose_screenshot_images'; diff --git a/x-pack/plugins/synthetics/public/hooks/use_composite_image.ts b/x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_composite_image.ts similarity index 97% rename from x-pack/plugins/synthetics/public/hooks/use_composite_image.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_composite_image.ts index 3af1e798d43e1..ca783bdd290c4 100644 --- a/x-pack/plugins/synthetics/public/hooks/use_composite_image.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_composite_image.ts @@ -8,7 +8,7 @@ import { useDispatch, useSelector } from 'react-redux'; import React from 'react'; import { composeScreenshotRef } from '../lib/helper/compose_screenshot_images'; -import { ScreenshotRefImageData } from '../../common/runtime_types/ping/synthetics'; +import { ScreenshotRefImageData } from '../../../common/runtime_types/ping/synthetics'; import { fetchBlocksAction, isPendingBlock, diff --git a/x-pack/plugins/synthetics/public/hooks/use_filter_update.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_filter_update.test.ts similarity index 100% rename from x-pack/plugins/synthetics/public/hooks/use_filter_update.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_filter_update.test.ts diff --git a/x-pack/plugins/synthetics/public/hooks/use_filter_update.ts b/x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_filter_update.ts similarity index 100% rename from x-pack/plugins/synthetics/public/hooks/use_filter_update.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_filter_update.ts diff --git a/x-pack/plugins/synthetics/public/hooks/use_init_app.ts b/x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_init_app.ts similarity index 100% rename from x-pack/plugins/synthetics/public/hooks/use_init_app.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_init_app.ts diff --git a/x-pack/plugins/synthetics/public/hooks/use_mapping_check.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_mapping_check.test.ts similarity index 100% rename from x-pack/plugins/synthetics/public/hooks/use_mapping_check.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_mapping_check.test.ts diff --git a/x-pack/plugins/synthetics/public/hooks/use_mapping_check.ts b/x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_mapping_check.ts similarity index 94% rename from x-pack/plugins/synthetics/public/hooks/use_mapping_check.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_mapping_check.ts index d8a7e0fac4065..dfda2900c7904 100644 --- a/x-pack/plugins/synthetics/public/hooks/use_mapping_check.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_mapping_check.ts @@ -7,7 +7,7 @@ import { useEffect } from 'react'; import { useHistory } from 'react-router-dom'; -import { MAPPING_ERROR_ROUTE } from '../../common/constants'; +import { MAPPING_ERROR_ROUTE } from '../../../common/constants'; interface EsBadRequestError { body?: { diff --git a/x-pack/plugins/synthetics/public/hooks/use_monitor.ts b/x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_monitor.ts similarity index 100% rename from x-pack/plugins/synthetics/public/hooks/use_monitor.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_monitor.ts diff --git a/x-pack/plugins/synthetics/public/hooks/use_overview_filter_check.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_overview_filter_check.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/hooks/use_overview_filter_check.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_overview_filter_check.test.tsx diff --git a/x-pack/plugins/synthetics/public/hooks/use_overview_filter_check.ts b/x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_overview_filter_check.ts similarity index 100% rename from x-pack/plugins/synthetics/public/hooks/use_overview_filter_check.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_overview_filter_check.ts diff --git a/x-pack/plugins/synthetics/public/hooks/use_search_text.ts b/x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_search_text.ts similarity index 100% rename from x-pack/plugins/synthetics/public/hooks/use_search_text.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_search_text.ts diff --git a/x-pack/plugins/synthetics/public/hooks/use_selected_filters.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_selected_filters.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/hooks/use_selected_filters.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_selected_filters.test.tsx diff --git a/x-pack/plugins/synthetics/public/hooks/use_selected_filters.ts b/x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_selected_filters.ts similarity index 97% rename from x-pack/plugins/synthetics/public/hooks/use_selected_filters.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_selected_filters.ts index b10760aa85ed3..03904a2d67421 100644 --- a/x-pack/plugins/synthetics/public/hooks/use_selected_filters.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_selected_filters.ts @@ -9,7 +9,7 @@ import { useMemo } from 'react'; import { useRouteMatch } from 'react-router-dom'; import { useGetUrlParams } from './use_url_params'; import { filterLabels } from '../components/overview/filter_group/translations'; -import { FILTER_FIELDS, MONITOR_ROUTE } from '../../common/constants'; +import { FILTER_FIELDS, MONITOR_ROUTE } from '../../../common/constants'; import { parseFiltersMap } from './use_filter_update'; type FilterType = string[]; diff --git a/x-pack/plugins/synthetics/public/hooks/use_telemetry.ts b/x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_telemetry.ts similarity index 96% rename from x-pack/plugins/synthetics/public/hooks/use_telemetry.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_telemetry.ts index d6e1a3ae28516..78062bb1ff7eb 100644 --- a/x-pack/plugins/synthetics/public/hooks/use_telemetry.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_telemetry.ts @@ -8,7 +8,7 @@ import { useEffect } from 'react'; import { useGetUrlParams } from './use_url_params'; import { apiService } from '../state/api/utils'; -import { API_URLS } from '../../common/constants'; +import { API_URLS } from '../../../common/constants'; export enum UptimePage { Overview = 'Overview', diff --git a/x-pack/plugins/synthetics/public/hooks/use_url_params.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_url_params.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/hooks/use_url_params.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_url_params.test.tsx diff --git a/x-pack/plugins/synthetics/public/hooks/use_url_params.ts b/x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_url_params.ts similarity index 100% rename from x-pack/plugins/synthetics/public/hooks/use_url_params.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/hooks/use_url_params.ts diff --git a/x-pack/plugins/synthetics/public/lib/__mocks__/screenshot_ref.mock.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/__mocks__/screenshot_ref.mock.ts similarity index 93% rename from x-pack/plugins/synthetics/public/lib/__mocks__/screenshot_ref.mock.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/__mocks__/screenshot_ref.mock.ts index a95aa77371b23..c812a9c67b38d 100644 --- a/x-pack/plugins/synthetics/public/lib/__mocks__/screenshot_ref.mock.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/lib/__mocks__/screenshot_ref.mock.ts @@ -5,7 +5,7 @@ * 2.0. */ -import { ScreenshotRefImageData } from '../../../common/runtime_types'; +import { ScreenshotRefImageData } from '../../../../common/runtime_types'; export const mockRef: ScreenshotRefImageData = { maxSteps: 1, diff --git a/x-pack/plugins/synthetics/public/lib/__mocks__/uptime_plugin_start_mock.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/__mocks__/uptime_plugin_start_mock.ts similarity index 100% rename from x-pack/plugins/synthetics/public/lib/__mocks__/uptime_plugin_start_mock.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/__mocks__/uptime_plugin_start_mock.ts diff --git a/x-pack/plugins/synthetics/public/lib/__mocks__/uptime_store.mock.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/__mocks__/uptime_store.mock.ts similarity index 94% rename from x-pack/plugins/synthetics/public/lib/__mocks__/uptime_store.mock.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/__mocks__/uptime_store.mock.ts index 01a11fd809fe8..18a8885b1dcdb 100644 --- a/x-pack/plugins/synthetics/public/lib/__mocks__/uptime_store.mock.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/lib/__mocks__/uptime_store.mock.ts @@ -5,8 +5,8 @@ * 2.0. */ -import { DYNAMIC_SETTINGS_DEFAULTS } from '../../../common/constants'; -import { DEFAULT_THROTTLING } from '../../../common/runtime_types'; +import { DYNAMIC_SETTINGS_DEFAULTS } from '../../../../common/constants'; +import { DEFAULT_THROTTLING } from '../../../../common/runtime_types'; import { AppState } from '../../state'; /** diff --git a/x-pack/plugins/synthetics/public/lib/__mocks__/use_composite_image.mock.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/__mocks__/use_composite_image.mock.ts similarity index 86% rename from x-pack/plugins/synthetics/public/lib/__mocks__/use_composite_image.mock.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/__mocks__/use_composite_image.mock.ts index c4ab83ae6ee5d..64bc0776b8207 100644 --- a/x-pack/plugins/synthetics/public/lib/__mocks__/use_composite_image.mock.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/lib/__mocks__/use_composite_image.mock.ts @@ -5,7 +5,7 @@ * 2.0. */ -import { ScreenshotRefImageData } from '../../../common/runtime_types/ping/synthetics'; +import { ScreenshotRefImageData } from '../../../../common/runtime_types/ping/synthetics'; import * as composeScreenshotImages from '../../hooks/use_composite_image'; jest diff --git a/x-pack/plugins/synthetics/public/lib/__mocks__/ut_router_history.mock.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/__mocks__/ut_router_history.mock.ts similarity index 100% rename from x-pack/plugins/synthetics/public/lib/__mocks__/ut_router_history.mock.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/__mocks__/ut_router_history.mock.ts diff --git a/x-pack/plugins/synthetics/public/lib/adapters/framework/capabilities_adapter.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/adapters/framework/capabilities_adapter.ts similarity index 100% rename from x-pack/plugins/synthetics/public/lib/adapters/framework/capabilities_adapter.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/adapters/framework/capabilities_adapter.ts diff --git a/x-pack/plugins/synthetics/public/lib/alert_types/alert_messages.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/alert_messages.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/lib/alert_types/alert_messages.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/alert_messages.tsx diff --git a/x-pack/plugins/synthetics/public/lib/alert_types/common.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/common.ts similarity index 100% rename from x-pack/plugins/synthetics/public/lib/alert_types/common.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/common.ts diff --git a/x-pack/plugins/synthetics/public/lib/alert_types/duration_anomaly.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/duration_anomaly.tsx similarity index 86% rename from x-pack/plugins/synthetics/public/lib/alert_types/duration_anomaly.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/duration_anomaly.tsx index 79b2b28652497..c866ca4c76956 100644 --- a/x-pack/plugins/synthetics/public/lib/alert_types/duration_anomaly.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/duration_anomaly.tsx @@ -12,9 +12,9 @@ import { ALERT_END, ALERT_STATUS, ALERT_STATUS_ACTIVE, ALERT_REASON } from '@kbn import { ObservabilityRuleTypeModel } from '@kbn/observability-plugin/public'; import { AlertTypeInitializer } from '.'; -import { getMonitorRouteFromMonitorId } from '../../../common/utils/get_monitor_url'; -import { CLIENT_ALERT_TYPES } from '../../../common/constants/alerts'; -import { DurationAnomalyTranslations } from '../../../common/translations'; +import { getMonitorRouteFromMonitorId } from '../../../../common/utils/get_monitor_url'; +import { CLIENT_ALERT_TYPES } from '../../../../common/constants/alerts'; +import { DurationAnomalyTranslations } from '../../../../common/translations'; const { defaultActionMessage, description } = DurationAnomalyTranslations; const DurationAnomalyAlert = React.lazy(() => import('./lazy_wrapper/duration_anomaly')); diff --git a/x-pack/plugins/synthetics/public/lib/alert_types/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/index.ts similarity index 95% rename from x-pack/plugins/synthetics/public/lib/alert_types/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/index.ts index 7217e0a083e6b..a4eef4c4b19b2 100644 --- a/x-pack/plugins/synthetics/public/lib/alert_types/index.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/index.ts @@ -11,7 +11,7 @@ import { RuleTypeModel } from '@kbn/triggers-actions-ui-plugin/public'; import { initMonitorStatusAlertType } from './monitor_status'; import { initTlsAlertType } from './tls'; import { initTlsLegacyAlertType } from './tls_legacy'; -import { ClientPluginsStart } from '../../apps/plugin'; +import { ClientPluginsStart } from '../../../plugin'; import { initDurationAnomalyAlertType } from './duration_anomaly'; export type AlertTypeInitializer = (dependenies: { diff --git a/x-pack/plugins/synthetics/public/lib/alert_types/lazy_wrapper/duration_anomaly.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/lazy_wrapper/duration_anomaly.tsx similarity index 95% rename from x-pack/plugins/synthetics/public/lib/alert_types/lazy_wrapper/duration_anomaly.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/lazy_wrapper/duration_anomaly.tsx index bb1f84a45114d..44c10f615543e 100644 --- a/x-pack/plugins/synthetics/public/lib/alert_types/lazy_wrapper/duration_anomaly.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/lazy_wrapper/duration_anomaly.tsx @@ -11,7 +11,7 @@ import { CoreStart } from '@kbn/core/public'; import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public'; import { store } from '../../../state'; import { AnomalyAlertComponent } from '../../../components/overview/alerts/anomaly_alert/anomaly_alert'; -import { ClientPluginsStart } from '../../../apps/plugin'; +import { ClientPluginsStart } from '../../../../plugin'; import { kibanaService } from '../../../state/kibana_service'; interface Props { diff --git a/x-pack/plugins/synthetics/public/lib/alert_types/lazy_wrapper/monitor_status.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/lazy_wrapper/monitor_status.tsx similarity index 95% rename from x-pack/plugins/synthetics/public/lib/alert_types/lazy_wrapper/monitor_status.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/lazy_wrapper/monitor_status.tsx index 10aa71fa533e3..dd41ab29ed080 100644 --- a/x-pack/plugins/synthetics/public/lib/alert_types/lazy_wrapper/monitor_status.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/lazy_wrapper/monitor_status.tsx @@ -10,7 +10,7 @@ import { Provider as ReduxProvider } from 'react-redux'; import { CoreStart } from '@kbn/core/public'; import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public'; import { store } from '../../../state'; -import { ClientPluginsStart } from '../../../apps/plugin'; +import { ClientPluginsStart } from '../../../../plugin'; import { kibanaService } from '../../../state/kibana_service'; import { AlertMonitorStatus } from '../../../components/overview/alerts/alerts_containers/alert_monitor_status'; import { UptimeDataViewContextProvider } from '../../../contexts/uptime_data_view_context'; diff --git a/x-pack/plugins/synthetics/public/lib/alert_types/lazy_wrapper/tls_alert.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/lazy_wrapper/tls_alert.tsx similarity index 94% rename from x-pack/plugins/synthetics/public/lib/alert_types/lazy_wrapper/tls_alert.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/lazy_wrapper/tls_alert.tsx index f4136a079c8b0..2d1b8c9898475 100644 --- a/x-pack/plugins/synthetics/public/lib/alert_types/lazy_wrapper/tls_alert.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/lazy_wrapper/tls_alert.tsx @@ -10,7 +10,7 @@ import { Provider as ReduxProvider } from 'react-redux'; import { CoreStart } from '@kbn/core/public'; import { KibanaContextProvider } from '@kbn/kibana-react-plugin/public'; import { store } from '../../../state'; -import { ClientPluginsStart } from '../../../apps/plugin'; +import { ClientPluginsStart } from '../../../../plugin'; import { AlertTls } from '../../../components/overview/alerts/alerts_containers/alert_tls'; import { kibanaService } from '../../../state/kibana_service'; diff --git a/x-pack/plugins/synthetics/public/lib/alert_types/lazy_wrapper/validate_monitor_status.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/lazy_wrapper/validate_monitor_status.ts similarity index 97% rename from x-pack/plugins/synthetics/public/lib/alert_types/lazy_wrapper/validate_monitor_status.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/lazy_wrapper/validate_monitor_status.ts index 881afb0d8eb52..68e88fdd8bf86 100644 --- a/x-pack/plugins/synthetics/public/lib/alert_types/lazy_wrapper/validate_monitor_status.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/lazy_wrapper/validate_monitor_status.ts @@ -12,7 +12,7 @@ import { AtomicStatusCheckParamsType, MonitorAvailabilityType, StatusCheckParamsType, -} from '../../../../common/runtime_types/alerts'; +} from '../../../../../common/runtime_types/alerts'; export function validateMonitorStatusParams(ruleParams: any): ValidationResult { const errors: Record = {}; diff --git a/x-pack/plugins/synthetics/public/lib/alert_types/monitor_status.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/monitor_status.test.ts similarity index 100% rename from x-pack/plugins/synthetics/public/lib/alert_types/monitor_status.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/monitor_status.test.ts diff --git a/x-pack/plugins/synthetics/public/lib/alert_types/monitor_status.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/monitor_status.tsx similarity index 89% rename from x-pack/plugins/synthetics/public/lib/alert_types/monitor_status.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/monitor_status.tsx index 99d8e22f11cdb..0361e6408e43b 100644 --- a/x-pack/plugins/synthetics/public/lib/alert_types/monitor_status.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/monitor_status.tsx @@ -19,9 +19,9 @@ import { import { ObservabilityRuleTypeModel } from '@kbn/observability-plugin/public'; import { ValidationResult } from '@kbn/triggers-actions-ui-plugin/public'; import { AlertTypeInitializer } from '.'; -import { getMonitorRouteFromMonitorId } from '../../../common/utils/get_monitor_url'; -import { MonitorStatusTranslations } from '../../../common/translations'; -import { CLIENT_ALERT_TYPES } from '../../../common/constants/alerts'; +import { getMonitorRouteFromMonitorId } from '../../../../common/utils/get_monitor_url'; +import { MonitorStatusTranslations } from '../../../../common/translations'; +import { CLIENT_ALERT_TYPES } from '../../../../common/constants/alerts'; const { defaultActionMessage, description } = MonitorStatusTranslations; diff --git a/x-pack/plugins/synthetics/public/lib/alert_types/tls.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/tls.tsx similarity index 85% rename from x-pack/plugins/synthetics/public/lib/alert_types/tls.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/tls.tsx index 1ecfaefaa1797..2c1238028ccf5 100644 --- a/x-pack/plugins/synthetics/public/lib/alert_types/tls.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/tls.tsx @@ -8,11 +8,11 @@ import React from 'react'; import { ALERT_REASON } from '@kbn/rule-data-utils'; import { ObservabilityRuleTypeModel } from '@kbn/observability-plugin/public'; -import { CLIENT_ALERT_TYPES } from '../../../common/constants/alerts'; -import { TlsTranslations } from '../../../common/translations'; +import { CLIENT_ALERT_TYPES } from '../../../../common/constants/alerts'; +import { TlsTranslations } from '../../../../common/translations'; import { AlertTypeInitializer } from '.'; -import { CERTIFICATES_ROUTE } from '../../../common/constants/ui'; +import { CERTIFICATES_ROUTE } from '../../../../common/constants/ui'; const { defaultActionMessage, description } = TlsTranslations; const TLSAlert = React.lazy(() => import('./lazy_wrapper/tls_alert')); diff --git a/x-pack/plugins/synthetics/public/lib/alert_types/tls_legacy.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/tls_legacy.tsx similarity index 88% rename from x-pack/plugins/synthetics/public/lib/alert_types/tls_legacy.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/tls_legacy.tsx index cce2e3d011bfa..221bfaeb3375c 100644 --- a/x-pack/plugins/synthetics/public/lib/alert_types/tls_legacy.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/tls_legacy.tsx @@ -7,8 +7,8 @@ import React from 'react'; import { RuleTypeModel } from '@kbn/triggers-actions-ui-plugin/public'; -import { CLIENT_ALERT_TYPES } from '../../../common/constants/alerts'; -import { TlsTranslationsLegacy } from '../../../common/translations'; +import { CLIENT_ALERT_TYPES } from '../../../../common/constants/alerts'; +import { TlsTranslationsLegacy } from '../../../../common/translations'; import { AlertTypeInitializer } from '.'; const { defaultActionMessage, description } = TlsTranslationsLegacy; diff --git a/x-pack/plugins/synthetics/public/lib/formatting.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/formatting.ts similarity index 100% rename from x-pack/plugins/synthetics/public/lib/formatting.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/formatting.ts diff --git a/x-pack/plugins/synthetics/public/lib/helper/charts/get_chart_date_label.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/charts/get_chart_date_label.ts similarity index 95% rename from x-pack/plugins/synthetics/public/lib/helper/charts/get_chart_date_label.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/charts/get_chart_date_label.ts index 4852e6ceade11..f7b8d315577f9 100644 --- a/x-pack/plugins/synthetics/public/lib/helper/charts/get_chart_date_label.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/charts/get_chart_date_label.ts @@ -7,7 +7,7 @@ import { isWithinCurrentDate } from './is_within_current_date'; import { getLabelFormat } from './get_label_format'; -import { CHART_FORMAT_LIMITS } from '../../../../common/constants'; +import { CHART_FORMAT_LIMITS } from '../../../../../common/constants'; /** * Generates an appropriate date formatting string intended for the y-axis diff --git a/x-pack/plugins/synthetics/public/lib/helper/charts/get_label_format.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/charts/get_label_format.test.ts similarity index 100% rename from x-pack/plugins/synthetics/public/lib/helper/charts/get_label_format.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/charts/get_label_format.test.ts diff --git a/x-pack/plugins/synthetics/public/lib/helper/charts/get_label_format.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/charts/get_label_format.ts similarity index 95% rename from x-pack/plugins/synthetics/public/lib/helper/charts/get_label_format.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/charts/get_label_format.ts index 3444e05b59127..298786cebaeb8 100644 --- a/x-pack/plugins/synthetics/public/lib/helper/charts/get_label_format.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/charts/get_label_format.ts @@ -5,7 +5,7 @@ * 2.0. */ -import { CHART_FORMAT_LIMITS } from '../../../../common/constants'; +import { CHART_FORMAT_LIMITS } from '../../../../../common/constants'; const { EIGHT_MINUTES, FOUR_YEARS, THIRTY_SIX_HOURS, THREE_WEEKS, SIX_MONTHS, NINE_DAYS } = CHART_FORMAT_LIMITS; diff --git a/x-pack/plugins/synthetics/public/lib/helper/charts/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/charts/index.ts similarity index 100% rename from x-pack/plugins/synthetics/public/lib/helper/charts/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/charts/index.ts diff --git a/x-pack/plugins/synthetics/public/lib/helper/charts/is_within_current_date.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/charts/is_within_current_date.test.ts similarity index 100% rename from x-pack/plugins/synthetics/public/lib/helper/charts/is_within_current_date.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/charts/is_within_current_date.test.ts diff --git a/x-pack/plugins/synthetics/public/lib/helper/charts/is_within_current_date.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/charts/is_within_current_date.ts similarity index 100% rename from x-pack/plugins/synthetics/public/lib/helper/charts/is_within_current_date.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/charts/is_within_current_date.ts diff --git a/x-pack/plugins/synthetics/public/lib/helper/compose_screenshot_images.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/compose_screenshot_images.test.ts similarity index 96% rename from x-pack/plugins/synthetics/public/lib/helper/compose_screenshot_images.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/compose_screenshot_images.test.ts index 0bf809d4e7a40..c749433bb84e0 100644 --- a/x-pack/plugins/synthetics/public/lib/helper/compose_screenshot_images.test.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/compose_screenshot_images.test.ts @@ -5,7 +5,7 @@ * 2.0. */ -import { ScreenshotRefImageData } from '../../../common/runtime_types/ping/synthetics'; +import { ScreenshotRefImageData } from '../../../../common/runtime_types/ping/synthetics'; import { composeScreenshotRef } from './compose_screenshot_images'; describe('composeScreenshotRef', () => { diff --git a/x-pack/plugins/synthetics/public/lib/helper/compose_screenshot_images.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/compose_screenshot_images.ts similarity index 97% rename from x-pack/plugins/synthetics/public/lib/helper/compose_screenshot_images.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/compose_screenshot_images.ts index 60cd248c1487a..86c7a001b95ab 100644 --- a/x-pack/plugins/synthetics/public/lib/helper/compose_screenshot_images.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/compose_screenshot_images.ts @@ -8,7 +8,7 @@ import { isScreenshotBlockDoc, ScreenshotRefImageData, -} from '../../../common/runtime_types/ping/synthetics'; +} from '../../../../common/runtime_types/ping/synthetics'; import { ScreenshotBlockCache } from '../../state/reducers/synthetics'; /** diff --git a/x-pack/plugins/synthetics/public/lib/helper/convert_measurements.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/convert_measurements.test.ts similarity index 100% rename from x-pack/plugins/synthetics/public/lib/helper/convert_measurements.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/convert_measurements.test.ts diff --git a/x-pack/plugins/synthetics/public/lib/helper/convert_measurements.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/convert_measurements.ts similarity index 100% rename from x-pack/plugins/synthetics/public/lib/helper/convert_measurements.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/convert_measurements.ts diff --git a/x-pack/plugins/synthetics/public/lib/helper/enzyme_helpers.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/enzyme_helpers.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/lib/helper/enzyme_helpers.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/enzyme_helpers.tsx diff --git a/x-pack/plugins/synthetics/public/lib/helper/get_title.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/get_title.ts similarity index 100% rename from x-pack/plugins/synthetics/public/lib/helper/get_title.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/get_title.ts diff --git a/x-pack/plugins/synthetics/public/lib/helper/helper_with_redux.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/helper_with_redux.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/lib/helper/helper_with_redux.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/helper_with_redux.tsx diff --git a/x-pack/plugins/synthetics/public/lib/helper/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/index.ts similarity index 100% rename from x-pack/plugins/synthetics/public/lib/helper/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/index.ts diff --git a/x-pack/plugins/synthetics/public/lib/helper/observability_integration/add_base_path.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/observability_integration/add_base_path.ts similarity index 100% rename from x-pack/plugins/synthetics/public/lib/helper/observability_integration/add_base_path.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/observability_integration/add_base_path.ts diff --git a/x-pack/plugins/synthetics/public/lib/helper/observability_integration/build_href.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/observability_integration/build_href.ts similarity index 95% rename from x-pack/plugins/synthetics/public/lib/helper/observability_integration/build_href.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/observability_integration/build_href.ts index 491219bae5152..93e08b92fbafc 100644 --- a/x-pack/plugins/synthetics/public/lib/helper/observability_integration/build_href.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/observability_integration/build_href.ts @@ -5,7 +5,7 @@ * 2.0. */ -import { Ping } from '../../../../common/runtime_types'; +import { Ping } from '../../../../../common/runtime_types'; /** * Builds URLs to the designated features by extracting values from the provided diff --git a/x-pack/plugins/synthetics/public/lib/helper/observability_integration/get_apm_href.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/observability_integration/get_apm_href.test.ts similarity index 96% rename from x-pack/plugins/synthetics/public/lib/helper/observability_integration/get_apm_href.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/observability_integration/get_apm_href.test.ts index db946fb246964..146fc498b3dcc 100644 --- a/x-pack/plugins/synthetics/public/lib/helper/observability_integration/get_apm_href.test.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/observability_integration/get_apm_href.test.ts @@ -6,7 +6,7 @@ */ import { getLegacyApmHref } from './get_apm_href'; -import { MonitorSummary, makePing } from '../../../../common/runtime_types'; +import { MonitorSummary, makePing } from '../../../../../common/runtime_types'; describe('getLegacyApmHref', () => { let summary: MonitorSummary; diff --git a/x-pack/plugins/synthetics/public/lib/helper/observability_integration/get_apm_href.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/observability_integration/get_apm_href.ts similarity index 91% rename from x-pack/plugins/synthetics/public/lib/helper/observability_integration/get_apm_href.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/observability_integration/get_apm_href.ts index fc5785ceecba1..f05f1ccb2de4f 100644 --- a/x-pack/plugins/synthetics/public/lib/helper/observability_integration/get_apm_href.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/observability_integration/get_apm_href.ts @@ -6,7 +6,7 @@ */ import { addBasePath } from './add_base_path'; -import { MonitorSummary } from '../../../../common/runtime_types'; +import { MonitorSummary } from '../../../../../common/runtime_types'; export const getLegacyApmHref = ( summary: MonitorSummary, diff --git a/x-pack/plugins/synthetics/public/lib/helper/observability_integration/get_infra_href.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/observability_integration/get_infra_href.test.ts similarity index 98% rename from x-pack/plugins/synthetics/public/lib/helper/observability_integration/get_infra_href.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/observability_integration/get_infra_href.test.ts index 9a7cc6e7940ed..970ac86f3777d 100644 --- a/x-pack/plugins/synthetics/public/lib/helper/observability_integration/get_infra_href.test.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/observability_integration/get_infra_href.test.ts @@ -6,7 +6,7 @@ */ import { getInfraContainerHref, getInfraKubernetesHref, getInfraIpHref } from './get_infra_href'; -import { MonitorSummary, makePing, Ping } from '../../../../common/runtime_types'; +import { MonitorSummary, makePing, Ping } from '../../../../../common/runtime_types'; describe('getInfraHref', () => { let summary: MonitorSummary; diff --git a/x-pack/plugins/synthetics/public/lib/helper/observability_integration/get_infra_href.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/observability_integration/get_infra_href.ts similarity index 96% rename from x-pack/plugins/synthetics/public/lib/helper/observability_integration/get_infra_href.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/observability_integration/get_infra_href.ts index 1603ef9cf170a..e1cf922983d21 100644 --- a/x-pack/plugins/synthetics/public/lib/helper/observability_integration/get_infra_href.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/observability_integration/get_infra_href.ts @@ -5,7 +5,7 @@ * 2.0. */ -import { MonitorSummary, Ping } from '../../../../common/runtime_types'; +import { MonitorSummary, Ping } from '../../../../../common/runtime_types'; import { addBasePath } from './add_base_path'; import { buildHref } from './build_href'; diff --git a/x-pack/plugins/synthetics/public/lib/helper/observability_integration/get_logging_href.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/observability_integration/get_logging_href.test.ts similarity index 98% rename from x-pack/plugins/synthetics/public/lib/helper/observability_integration/get_logging_href.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/observability_integration/get_logging_href.test.ts index 3c778400fae71..791d19a7949c2 100644 --- a/x-pack/plugins/synthetics/public/lib/helper/observability_integration/get_logging_href.test.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/observability_integration/get_logging_href.test.ts @@ -10,7 +10,7 @@ import { getLoggingKubernetesHref, getLoggingIpHref, } from './get_logging_href'; -import { MonitorSummary, makePing } from '../../../../common/runtime_types'; +import { MonitorSummary, makePing } from '../../../../../common/runtime_types'; describe('getLoggingHref', () => { let summary: MonitorSummary; diff --git a/x-pack/plugins/synthetics/public/lib/helper/observability_integration/get_logging_href.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/observability_integration/get_logging_href.ts similarity index 96% rename from x-pack/plugins/synthetics/public/lib/helper/observability_integration/get_logging_href.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/observability_integration/get_logging_href.ts index a3e6108b7efe8..947c50f1f0320 100644 --- a/x-pack/plugins/synthetics/public/lib/helper/observability_integration/get_logging_href.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/observability_integration/get_logging_href.ts @@ -5,7 +5,7 @@ * 2.0. */ -import { MonitorSummary, Ping } from '../../../../common/runtime_types'; +import { MonitorSummary, Ping } from '../../../../../common/runtime_types'; import { addBasePath } from './add_base_path'; import { buildHref } from './build_href'; diff --git a/x-pack/plugins/synthetics/public/lib/helper/observability_integration/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/observability_integration/index.ts similarity index 100% rename from x-pack/plugins/synthetics/public/lib/helper/observability_integration/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/observability_integration/index.ts diff --git a/x-pack/plugins/synthetics/public/lib/helper/parse_search.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/parse_search.test.ts similarity index 100% rename from x-pack/plugins/synthetics/public/lib/helper/parse_search.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/parse_search.test.ts diff --git a/x-pack/plugins/synthetics/public/lib/helper/parse_search.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/parse_search.ts similarity index 100% rename from x-pack/plugins/synthetics/public/lib/helper/parse_search.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/parse_search.ts diff --git a/x-pack/plugins/synthetics/public/lib/helper/rtl_helpers.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/rtl_helpers.tsx similarity index 99% rename from x-pack/plugins/synthetics/public/lib/helper/rtl_helpers.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/rtl_helpers.tsx index 913f5e249c688..db55ee3805ef1 100644 --- a/x-pack/plugins/synthetics/public/lib/helper/rtl_helpers.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/rtl_helpers.tsx @@ -31,7 +31,7 @@ import { mockState } from '../__mocks__/uptime_store.mock'; import { MountWithReduxProvider } from './helper_with_redux'; import { AppState } from '../../state'; import { stringifyUrlParams } from './stringify_url_params'; -import { ClientPluginsStart } from '../../apps/plugin'; +import { ClientPluginsStart } from '../../../plugin'; import { UptimeRefreshContextProvider, UptimeStartupPluginsContextProvider } from '../../contexts'; import { kibanaService } from '../../state/kibana_service'; diff --git a/x-pack/plugins/synthetics/public/lib/helper/series_has_down_values.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/series_has_down_values.test.ts similarity index 100% rename from x-pack/plugins/synthetics/public/lib/helper/series_has_down_values.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/series_has_down_values.test.ts diff --git a/x-pack/plugins/synthetics/public/lib/helper/series_has_down_values.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/series_has_down_values.ts similarity index 85% rename from x-pack/plugins/synthetics/public/lib/helper/series_has_down_values.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/series_has_down_values.ts index 7090da1430bc5..d5ff1fc4e0715 100644 --- a/x-pack/plugins/synthetics/public/lib/helper/series_has_down_values.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/series_has_down_values.ts @@ -5,7 +5,7 @@ * 2.0. */ -import { HistogramPoint } from '../../../common/runtime_types'; +import { HistogramPoint } from '../../../../common/runtime_types'; export const seriesHasDownValues = (series: HistogramPoint[] | null): boolean => { return series ? series.some((point) => !!point.down) : false; diff --git a/x-pack/plugins/synthetics/public/lib/helper/spy_use_fetcher.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/spy_use_fetcher.ts similarity index 100% rename from x-pack/plugins/synthetics/public/lib/helper/spy_use_fetcher.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/spy_use_fetcher.ts diff --git a/x-pack/plugins/synthetics/public/lib/helper/stringify_url_params.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/stringify_url_params.test.ts similarity index 100% rename from x-pack/plugins/synthetics/public/lib/helper/stringify_url_params.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/stringify_url_params.test.ts diff --git a/x-pack/plugins/synthetics/public/lib/helper/stringify_url_params.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/stringify_url_params.ts similarity index 96% rename from x-pack/plugins/synthetics/public/lib/helper/stringify_url_params.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/stringify_url_params.ts index edfa8e62d6137..2bb5f9a3c13e3 100644 --- a/x-pack/plugins/synthetics/public/lib/helper/stringify_url_params.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/stringify_url_params.ts @@ -7,7 +7,7 @@ import { stringify } from 'query-string'; import { UptimeUrlParams } from './url_params'; -import { CLIENT_DEFAULTS } from '../../../common/constants'; +import { CLIENT_DEFAULTS } from '../../../../common/constants'; const { AUTOREFRESH_INTERVAL, diff --git a/x-pack/plugins/synthetics/public/lib/helper/test_helpers.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/test_helpers.ts similarity index 100% rename from x-pack/plugins/synthetics/public/lib/helper/test_helpers.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/test_helpers.ts diff --git a/x-pack/plugins/synthetics/public/lib/helper/url_params/__snapshots__/get_supported_url_params.test.ts.snap b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/url_params/__snapshots__/get_supported_url_params.test.ts.snap similarity index 100% rename from x-pack/plugins/synthetics/public/lib/helper/url_params/__snapshots__/get_supported_url_params.test.ts.snap rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/url_params/__snapshots__/get_supported_url_params.test.ts.snap diff --git a/x-pack/plugins/synthetics/public/lib/helper/url_params/get_supported_url_params.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/url_params/get_supported_url_params.test.ts similarity index 97% rename from x-pack/plugins/synthetics/public/lib/helper/url_params/get_supported_url_params.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/url_params/get_supported_url_params.test.ts index 4771d864e0bf8..14b1ce22f9bee 100644 --- a/x-pack/plugins/synthetics/public/lib/helper/url_params/get_supported_url_params.test.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/url_params/get_supported_url_params.test.ts @@ -7,7 +7,7 @@ import DateMath from '@kbn/datemath'; import { getSupportedUrlParams } from './get_supported_url_params'; -import { CLIENT_DEFAULTS } from '../../../../common/constants'; +import { CLIENT_DEFAULTS } from '../../../../../common/constants'; describe('getSupportedUrlParams', () => { let dateMathSpy: any; diff --git a/x-pack/plugins/synthetics/public/lib/helper/url_params/get_supported_url_params.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/url_params/get_supported_url_params.ts similarity index 97% rename from x-pack/plugins/synthetics/public/lib/helper/url_params/get_supported_url_params.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/url_params/get_supported_url_params.ts index 727f18b39c764..703b2257ee176 100644 --- a/x-pack/plugins/synthetics/public/lib/helper/url_params/get_supported_url_params.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/url_params/get_supported_url_params.ts @@ -7,7 +7,7 @@ import { parseIsPaused } from './parse_is_paused'; import { parseUrlInt } from './parse_url_int'; -import { CLIENT_DEFAULTS } from '../../../../common/constants'; +import { CLIENT_DEFAULTS } from '../../../../../common/constants'; import { parseAbsoluteDate } from './parse_absolute_date'; export interface UptimeUrlParams { diff --git a/x-pack/plugins/synthetics/public/lib/helper/url_params/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/url_params/index.ts similarity index 100% rename from x-pack/plugins/synthetics/public/lib/helper/url_params/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/url_params/index.ts diff --git a/x-pack/plugins/synthetics/public/lib/helper/url_params/parse_absolute_date.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/url_params/parse_absolute_date.test.ts similarity index 100% rename from x-pack/plugins/synthetics/public/lib/helper/url_params/parse_absolute_date.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/url_params/parse_absolute_date.test.ts diff --git a/x-pack/plugins/synthetics/public/lib/helper/url_params/parse_absolute_date.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/url_params/parse_absolute_date.ts similarity index 100% rename from x-pack/plugins/synthetics/public/lib/helper/url_params/parse_absolute_date.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/url_params/parse_absolute_date.ts diff --git a/x-pack/plugins/synthetics/public/lib/helper/url_params/parse_is_paused.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/url_params/parse_is_paused.test.ts similarity index 100% rename from x-pack/plugins/synthetics/public/lib/helper/url_params/parse_is_paused.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/url_params/parse_is_paused.test.ts diff --git a/x-pack/plugins/synthetics/public/lib/helper/url_params/parse_is_paused.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/url_params/parse_is_paused.ts similarity index 100% rename from x-pack/plugins/synthetics/public/lib/helper/url_params/parse_is_paused.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/url_params/parse_is_paused.ts diff --git a/x-pack/plugins/synthetics/public/lib/helper/url_params/parse_url_int.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/url_params/parse_url_int.test.ts similarity index 100% rename from x-pack/plugins/synthetics/public/lib/helper/url_params/parse_url_int.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/url_params/parse_url_int.test.ts diff --git a/x-pack/plugins/synthetics/public/lib/helper/url_params/parse_url_int.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/url_params/parse_url_int.ts similarity index 100% rename from x-pack/plugins/synthetics/public/lib/helper/url_params/parse_url_int.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/helper/url_params/parse_url_int.ts diff --git a/x-pack/plugins/synthetics/public/lib/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/index.ts similarity index 100% rename from x-pack/plugins/synthetics/public/lib/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/index.ts diff --git a/x-pack/plugins/synthetics/public/badge.ts b/x-pack/plugins/synthetics/public/legacy_uptime/lib/lib.ts similarity index 83% rename from x-pack/plugins/synthetics/public/badge.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/lib/lib.ts index a42eaa58a7943..a846cdeb99fb6 100644 --- a/x-pack/plugins/synthetics/public/badge.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/lib/lib.ts @@ -6,4 +6,4 @@ */ import { ChromeBadge } from '@kbn/core/public'; -export type UMBadge = ChromeBadge | undefined; +export type UMUpdateBadge = (badge?: ChromeBadge) => void; diff --git a/x-pack/plugins/synthetics/public/pages/certificates.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/pages/certificates.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/pages/certificates.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/pages/certificates.test.tsx diff --git a/x-pack/plugins/synthetics/public/pages/certificates.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/pages/certificates.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/pages/certificates.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/pages/certificates.tsx diff --git a/x-pack/plugins/synthetics/public/pages/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/pages/index.ts similarity index 100% rename from x-pack/plugins/synthetics/public/pages/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/pages/index.ts diff --git a/x-pack/plugins/synthetics/public/pages/mapping_error.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/pages/mapping_error.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/pages/mapping_error.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/pages/mapping_error.tsx diff --git a/x-pack/plugins/synthetics/public/pages/monitor.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/pages/monitor.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/pages/monitor.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/pages/monitor.test.tsx diff --git a/x-pack/plugins/synthetics/public/pages/monitor.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/pages/monitor.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/pages/monitor.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/pages/monitor.tsx diff --git a/x-pack/plugins/synthetics/public/pages/monitor_management/action_bar_portal_node.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/pages/monitor_management/action_bar_portal_node.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/pages/monitor_management/action_bar_portal_node.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/pages/monitor_management/action_bar_portal_node.tsx diff --git a/x-pack/plugins/synthetics/public/pages/monitor_management/add_monitor.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/pages/monitor_management/add_monitor.tsx similarity index 97% rename from x-pack/plugins/synthetics/public/pages/monitor_management/add_monitor.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/pages/monitor_management/add_monitor.tsx index 40283f1331086..5979c7ed4767a 100644 --- a/x-pack/plugins/synthetics/public/pages/monitor_management/add_monitor.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/pages/monitor_management/add_monitor.tsx @@ -8,7 +8,7 @@ import React from 'react'; import { i18n } from '@kbn/i18n'; import { useTrackPageview } from '@kbn/observability-plugin/public'; -import { ScheduleUnit } from '../../../common/runtime_types'; +import { ScheduleUnit } from '../../../../common/runtime_types'; import { SyntheticsProviders } from '../../components/fleet_package/contexts'; import { Loader } from '../../components/monitor_management/loader/loader'; import { MonitorConfig } from '../../components/monitor_management/monitor_config/monitor_config'; diff --git a/x-pack/plugins/synthetics/public/pages/monitor_management/bottom_bar.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/pages/monitor_management/bottom_bar.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/pages/monitor_management/bottom_bar.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/pages/monitor_management/bottom_bar.tsx diff --git a/x-pack/plugins/synthetics/public/pages/monitor_management/content.ts b/x-pack/plugins/synthetics/public/legacy_uptime/pages/monitor_management/content.ts similarity index 100% rename from x-pack/plugins/synthetics/public/pages/monitor_management/content.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/pages/monitor_management/content.ts diff --git a/x-pack/plugins/synthetics/public/pages/monitor_management/edit_monitor.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/pages/monitor_management/edit_monitor.tsx similarity index 92% rename from x-pack/plugins/synthetics/public/pages/monitor_management/edit_monitor.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/pages/monitor_management/edit_monitor.tsx index 5c8c85d7c616d..d0397de8be960 100644 --- a/x-pack/plugins/synthetics/public/pages/monitor_management/edit_monitor.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/pages/monitor_management/edit_monitor.tsx @@ -8,11 +8,11 @@ import React from 'react'; import { useParams } from 'react-router-dom'; import { useTrackPageview, FETCH_STATUS, useFetcher } from '@kbn/observability-plugin/public'; -import { MonitorFields } from '../../../common/runtime_types'; +import { MonitorFields } from '../../../../common/runtime_types'; import { EditMonitorConfig } from '../../components/monitor_management/edit_monitor_config'; import { Loader } from '../../components/monitor_management/loader/loader'; import { getMonitor } from '../../state/api'; -import { DecryptedSyntheticsMonitorSavedObject } from '../../../common/types'; +import { DecryptedSyntheticsMonitorSavedObject } from '../../../../common/types'; import { useLocations } from '../../components/monitor_management/hooks/use_locations'; import { useMonitorManagementBreadcrumbs } from './use_monitor_management_breadcrumbs'; import { @@ -31,7 +31,7 @@ export const EditMonitorPage: React.FC = () => { const { data, status } = useFetcher< Promise >(() => { - return getMonitor({ id: Buffer.from(monitorId, 'base64').toString('utf8') }); + return getMonitor({ id: monitorId }); }, [monitorId]); const monitor = data?.attributes as MonitorFields; diff --git a/x-pack/plugins/synthetics/public/pages/monitor_management/monitor_management.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/pages/monitor_management/monitor_management.tsx similarity index 84% rename from x-pack/plugins/synthetics/public/pages/monitor_management/monitor_management.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/pages/monitor_management/monitor_management.tsx index 52453e66d858a..ba243388c8a3b 100644 --- a/x-pack/plugins/synthetics/public/pages/monitor_management/monitor_management.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/pages/monitor_management/monitor_management.tsx @@ -7,11 +7,9 @@ import React, { useEffect, useRef, useState } from 'react'; import { i18n } from '@kbn/i18n'; -import { useDispatch, useSelector } from 'react-redux'; +import { useSelector } from 'react-redux'; import { EuiCallOut, EuiButton, EuiSpacer, EuiLink } from '@elastic/eui'; import { useTrackPageview } from '@kbn/observability-plugin/public'; -import { ConfigKey } from '../../../common/runtime_types'; -import { getMonitors } from '../../state/actions'; import { monitorManagementListSelector } from '../../state/selectors'; import { useMonitorManagementBreadcrumbs } from './use_monitor_management_breadcrumbs'; import { MonitorListContainer } from '../../components/monitor_management/monitor_list/monitor_list_container'; @@ -20,12 +18,12 @@ import { useEnablement } from '../../components/monitor_management/hooks/use_ena import { useLocations } from '../../components/monitor_management/hooks/use_locations'; import { Loader } from '../../components/monitor_management/loader/loader'; import { ERROR_HEADING_LABEL } from './content'; +import { useMonitorList } from '../../components/monitor_management/hooks/use_monitor_list'; export const MonitorManagementPage: React.FC = () => { useTrackPageview({ app: 'uptime', path: 'manage-monitors' }); useTrackPageview({ app: 'uptime', path: 'manage-monitors', delay: 15000 }); useMonitorManagementBreadcrumbs(); - const dispatch = useDispatch(); const [shouldFocusEnablementButton, setShouldFocusEnablementButton] = useState(false); const { @@ -40,19 +38,6 @@ export const MonitorManagementPage: React.FC = () => { const isEnabledRef = useRef(isEnabled); - useEffect(() => { - if (monitorList.total === null) { - dispatch( - getMonitors({ - page: 1, // saved objects page index is base 1 - perPage: 10, - sortOrder: 'asc', - sortField: `${ConfigKey.NAME}.keyword`, - }) - ); - } - }, [dispatch, monitorList.total]); - useEffect(() => { if (!isEnabled && isEnabledRef.current === true) { /* shift focus to enable button when enable toggle disappears. Prevent @@ -62,10 +47,14 @@ export const MonitorManagementPage: React.FC = () => { isEnabledRef.current = Boolean(isEnabled); }, [isEnabled]); + const { pageState, dispatchPageAction } = useMonitorList(); + + const showEmptyState = isEnabled !== undefined && monitorList.total === 0; + return ( <> { ) : null} - {isEnabled || (!isEnabled && monitorList.total) ? : null} + - {isEnabled !== undefined && monitorList.total === 0 && ( - - )} + {showEmptyState && } ); }; diff --git a/x-pack/plugins/synthetics/public/pages/monitor_management/service_allowed_wrapper.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/pages/monitor_management/service_allowed_wrapper.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/pages/monitor_management/service_allowed_wrapper.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/pages/monitor_management/service_allowed_wrapper.test.tsx diff --git a/x-pack/plugins/synthetics/public/pages/monitor_management/service_allowed_wrapper.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/pages/monitor_management/service_allowed_wrapper.tsx similarity index 86% rename from x-pack/plugins/synthetics/public/pages/monitor_management/service_allowed_wrapper.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/pages/monitor_management/service_allowed_wrapper.tsx index cda0e8a6cdbe9..ff74fd97f0b34 100644 --- a/x-pack/plugins/synthetics/public/pages/monitor_management/service_allowed_wrapper.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/pages/monitor_management/service_allowed_wrapper.tsx @@ -13,15 +13,6 @@ import { useSyntheticsServiceAllowed } from '../../components/monitor_management export const ServiceAllowedWrapper: React.FC = ({ children }) => { const { isAllowed, signupUrl, loading } = useSyntheticsServiceAllowed(); - if (loading) { - return ( - } - title={

{LOADING_MONITOR_MANAGEMENT_LABEL}

} - /> - ); - } - // checking for explicit false if (isAllowed === false) { return ( @@ -37,7 +28,17 @@ export const ServiceAllowedWrapper: React.FC = ({ children }) => { ); } - return <>{children}; + return ( + <> + {loading && ( + } + title={

{LOADING_MONITOR_MANAGEMENT_LABEL}

} + /> + )} +
{children}
+ + ); }; const REQUEST_ACCESS_LABEL = i18n.translate('xpack.synthetics.monitorManagement.requestAccess', { diff --git a/x-pack/plugins/synthetics/public/pages/monitor_management/use_monitor_management_breadcrumbs.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/pages/monitor_management/use_monitor_management_breadcrumbs.tsx similarity index 92% rename from x-pack/plugins/synthetics/public/pages/monitor_management/use_monitor_management_breadcrumbs.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/pages/monitor_management/use_monitor_management_breadcrumbs.tsx index 03d07a122c730..2c7a4fe7a8259 100644 --- a/x-pack/plugins/synthetics/public/pages/monitor_management/use_monitor_management_breadcrumbs.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/pages/monitor_management/use_monitor_management_breadcrumbs.tsx @@ -7,8 +7,8 @@ import { i18n } from '@kbn/i18n'; import { useKibana } from '@kbn/kibana-react-plugin/public'; import { useBreadcrumbs } from '../../hooks/use_breadcrumbs'; -import { MONITOR_MANAGEMENT_ROUTE } from '../../../common/constants'; -import { PLUGIN } from '../../../common/constants/plugin'; +import { MONITOR_MANAGEMENT_ROUTE } from '../../../../common/constants'; +import { PLUGIN } from '../../../../common/constants/plugin'; export const useMonitorManagementBreadcrumbs = ({ isAddMonitor, diff --git a/x-pack/plugins/synthetics/public/pages/not_found.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/pages/not_found.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/pages/not_found.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/pages/not_found.test.tsx diff --git a/x-pack/plugins/synthetics/public/pages/not_found.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/pages/not_found.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/pages/not_found.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/pages/not_found.tsx diff --git a/x-pack/plugins/synthetics/public/pages/overview.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/pages/overview.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/pages/overview.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/pages/overview.test.tsx diff --git a/x-pack/plugins/synthetics/public/pages/overview.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/pages/overview.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/pages/overview.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/pages/overview.tsx diff --git a/x-pack/plugins/synthetics/public/pages/settings.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/pages/settings.test.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/pages/settings.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/pages/settings.test.tsx diff --git a/x-pack/plugins/synthetics/public/pages/settings.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/pages/settings.tsx similarity index 97% rename from x-pack/plugins/synthetics/public/pages/settings.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/pages/settings.tsx index a12b615bb703d..6726a10ab8747 100644 --- a/x-pack/plugins/synthetics/public/pages/settings.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/pages/settings.tsx @@ -11,7 +11,7 @@ import { useDispatch, useSelector } from 'react-redux'; import { useKibana } from '@kbn/kibana-react-plugin/public'; import { selectDynamicSettings } from '../state/selectors'; import { getDynamicSettings, setDynamicSettings } from '../state/actions/dynamic_settings'; -import { DynamicSettings } from '../../common/runtime_types'; +import { DynamicSettings } from '../../../common/runtime_types'; import { useBreadcrumbs } from '../hooks/use_breadcrumbs'; import { IndicesForm } from '../components/settings/indices_form'; import { @@ -23,7 +23,7 @@ import * as Translations from './translations'; import { VALUE_MUST_BE_GREATER_THAN_ZERO, VALUE_MUST_BE_AN_INTEGER, -} from '../../common/translations'; +} from '../../../common/translations'; import { AlertDefaultsForm } from '../components/settings/alert_defaults_form'; import { SettingsActionBarPortal } from '../components/settings/settings_bottom_bar'; import { useSettingsErrors } from '../components/settings/use_settings_errors'; diff --git a/x-pack/plugins/synthetics/public/pages/synthetics/checks_navigation.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/pages/synthetics/checks_navigation.tsx similarity index 96% rename from x-pack/plugins/synthetics/public/pages/synthetics/checks_navigation.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/pages/synthetics/checks_navigation.tsx index 6dcef302506e4..ee33191c3799e 100644 --- a/x-pack/plugins/synthetics/public/pages/synthetics/checks_navigation.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/pages/synthetics/checks_navigation.tsx @@ -10,7 +10,7 @@ import { EuiButtonEmpty, EuiFlexGroup, EuiFlexItem, EuiText } from '@elastic/eui import { FormattedMessage } from '@kbn/i18n-react'; import { useHistory } from 'react-router-dom'; import moment from 'moment'; -import { SyntheticsJourneyApiResponse } from '../../../common/runtime_types/ping'; +import { SyntheticsJourneyApiResponse } from '../../../../common/runtime_types/ping'; import { getShortTimeStamp } from '../../components/overview/monitor_list/columns/monitor_status_column'; import { useBreakpoints } from '../../hooks/use_breakpoints'; diff --git a/x-pack/plugins/synthetics/public/pages/synthetics/step_detail_page.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/pages/synthetics/step_detail_page.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/pages/synthetics/step_detail_page.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/pages/synthetics/step_detail_page.tsx index 2ded527f7bb57..7caa521e434f4 100644 --- a/x-pack/plugins/synthetics/public/pages/synthetics/step_detail_page.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/pages/synthetics/step_detail_page.tsx @@ -14,7 +14,7 @@ import { useInitApp } from '../../hooks/use_init_app'; import { StepDetailContainer } from '../../components/monitor/synthetics/step_detail/step_detail_container'; import { journeySelector } from '../../state/selectors'; import { JourneyState } from '../../state/reducers/journey'; -import { JourneyStep } from '../../../common/runtime_types/ping/synthetics'; +import { JourneyStep } from '../../../../common/runtime_types/ping/synthetics'; import { StepPageNavigation } from '../../components/monitor/synthetics/step_detail/step_page_nav'; import { StepPageTitleContent } from '../../components/monitor/synthetics/step_detail/step_page_title'; import { getJourneySteps } from '../../state/actions/journey'; diff --git a/x-pack/plugins/synthetics/public/pages/synthetics/synthetics_checks.test.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/pages/synthetics/synthetics_checks.test.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/pages/synthetics/synthetics_checks.test.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/pages/synthetics/synthetics_checks.test.tsx index 290cdd453bd3c..312c10886c572 100644 --- a/x-pack/plugins/synthetics/public/pages/synthetics/synthetics_checks.test.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/pages/synthetics/synthetics_checks.test.tsx @@ -14,7 +14,7 @@ import { } from './synthetics_checks'; import { fetchJourneySteps } from '../../state/api/journey'; import { createMemoryHistory } from 'history'; -import { SYNTHETIC_CHECK_STEPS_ROUTE } from '../../../common/constants'; +import { SYNTHETIC_CHECK_STEPS_ROUTE } from '../../../../common/constants'; jest.mock('../../state/api/journey', () => ({ fetchJourneySteps: jest.fn(), diff --git a/x-pack/plugins/synthetics/public/pages/synthetics/synthetics_checks.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/pages/synthetics/synthetics_checks.tsx similarity index 100% rename from x-pack/plugins/synthetics/public/pages/synthetics/synthetics_checks.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/pages/synthetics/synthetics_checks.tsx diff --git a/x-pack/plugins/synthetics/public/pages/translations.ts b/x-pack/plugins/synthetics/public/legacy_uptime/pages/translations.ts similarity index 100% rename from x-pack/plugins/synthetics/public/pages/translations.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/pages/translations.ts diff --git a/x-pack/plugins/synthetics/public/routes.tsx b/x-pack/plugins/synthetics/public/legacy_uptime/routes.tsx similarity index 98% rename from x-pack/plugins/synthetics/public/routes.tsx rename to x-pack/plugins/synthetics/public/legacy_uptime/routes.tsx index 0c43b99467f3b..1b8706ad4cb00 100644 --- a/x-pack/plugins/synthetics/public/routes.tsx +++ b/x-pack/plugins/synthetics/public/legacy_uptime/routes.tsx @@ -23,7 +23,7 @@ import { SETTINGS_ROUTE, STEP_DETAIL_ROUTE, SYNTHETIC_CHECK_STEPS_ROUTE, -} from '../common/constants'; +} from '../../common/constants'; import { MappingErrorPage, MonitorPage, @@ -53,7 +53,7 @@ import { StepDetailPageHeader, StepDetailPageRightSideItem, } from './pages/synthetics/step_detail_page'; -import { UptimePageTemplateComponent } from './apps/uptime_page_template'; +import { UptimePageTemplateComponent } from './app/uptime_page_template'; import { apiService } from './state/api/utils'; import { AddMonitorBtn } from './components/monitor_management/add_monitor_btn'; import { SettingsBottomBar } from './components/settings/settings_bottom_bar'; diff --git a/x-pack/plugins/synthetics/public/state/actions/alerts.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/actions/alerts.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/actions/alerts.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/actions/alerts.ts diff --git a/x-pack/plugins/synthetics/public/state/actions/dynamic_settings.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/actions/dynamic_settings.ts similarity index 92% rename from x-pack/plugins/synthetics/public/state/actions/dynamic_settings.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/actions/dynamic_settings.ts index 7b7939688010f..6be8cc4547559 100644 --- a/x-pack/plugins/synthetics/public/state/actions/dynamic_settings.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/actions/dynamic_settings.ts @@ -6,7 +6,7 @@ */ import { createAction } from 'redux-actions'; -import { DynamicSettings } from '../../../common/runtime_types'; +import { DynamicSettings } from '../../../../common/runtime_types'; export const getDynamicSettings = createAction('GET_DYNAMIC_SETTINGS'); export const getDynamicSettingsSuccess = createAction( diff --git a/x-pack/plugins/synthetics/public/state/actions/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/actions/index.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/actions/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/actions/index.ts diff --git a/x-pack/plugins/synthetics/public/state/actions/index_status.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/actions/index_status.ts similarity index 84% rename from x-pack/plugins/synthetics/public/state/actions/index_status.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/actions/index_status.ts index 306565c1f507f..2de91a82c6762 100644 --- a/x-pack/plugins/synthetics/public/state/actions/index_status.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/actions/index_status.ts @@ -6,6 +6,6 @@ */ import { createAsyncAction } from './utils'; -import { StatesIndexStatus } from '../../../common/runtime_types'; +import { StatesIndexStatus } from '../../../../common/runtime_types'; export const indexStatusAction = createAsyncAction('GET INDEX STATUS'); diff --git a/x-pack/plugins/synthetics/public/state/actions/journey.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/actions/journey.ts similarity index 91% rename from x-pack/plugins/synthetics/public/state/actions/journey.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/actions/journey.ts index bc03c443331c1..c9833ee25f95d 100644 --- a/x-pack/plugins/synthetics/public/state/actions/journey.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/actions/journey.ts @@ -6,7 +6,7 @@ */ import { createAction } from 'redux-actions'; -import { SyntheticsJourneyApiResponse } from '../../../common/runtime_types'; +import { SyntheticsJourneyApiResponse } from '../../../../common/runtime_types'; export interface FetchJourneyStepsParams { checkGroup: string; diff --git a/x-pack/plugins/synthetics/public/state/actions/ml_anomaly.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/actions/ml_anomaly.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/actions/ml_anomaly.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/actions/ml_anomaly.ts diff --git a/x-pack/plugins/synthetics/public/state/actions/monitor.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/actions/monitor.ts similarity index 89% rename from x-pack/plugins/synthetics/public/state/actions/monitor.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/actions/monitor.ts index f9dcd4bd57538..5fd74737d96a7 100644 --- a/x-pack/plugins/synthetics/public/state/actions/monitor.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/actions/monitor.ts @@ -7,8 +7,8 @@ import { createAction } from 'redux-actions'; import { MonitorDetailsActionPayload } from './types'; -import { PingError } from '../../../common/runtime_types'; -import { MonitorLocations } from '../../../common/runtime_types'; +import { PingError } from '../../../../common/runtime_types'; +import { MonitorLocations } from '../../../../common/runtime_types'; import { QueryParams } from './types'; import { createAsyncAction } from './utils'; diff --git a/x-pack/plugins/synthetics/public/state/actions/monitor_duration.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/actions/monitor_duration.ts similarity index 92% rename from x-pack/plugins/synthetics/public/state/actions/monitor_duration.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/actions/monitor_duration.ts index 1dd88c663cec5..52583e79f9ec3 100644 --- a/x-pack/plugins/synthetics/public/state/actions/monitor_duration.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/actions/monitor_duration.ts @@ -8,7 +8,7 @@ import { createAction } from 'redux-actions'; import { IHttpFetchError } from '@kbn/core/public'; import { QueryParams } from './types'; -import { MonitorDurationResult } from '../../../common/types'; +import { MonitorDurationResult } from '../../../../common/types'; type MonitorQueryParams = QueryParams & { monitorId: string }; diff --git a/x-pack/plugins/synthetics/public/state/actions/monitor_list.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/actions/monitor_list.ts similarity index 91% rename from x-pack/plugins/synthetics/public/state/actions/monitor_list.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/actions/monitor_list.ts index b86853dcfbefe..c123ca95a5acd 100644 --- a/x-pack/plugins/synthetics/public/state/actions/monitor_list.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/actions/monitor_list.ts @@ -6,7 +6,10 @@ */ import { createAction } from 'redux-actions'; -import { FetchMonitorStatesQueryArgs, MonitorSummariesResult } from '../../../common/runtime_types'; +import { + FetchMonitorStatesQueryArgs, + MonitorSummariesResult, +} from '../../../../common/runtime_types'; import { createAsyncAction } from './utils'; import { TestNowResponse } from '../api'; diff --git a/x-pack/plugins/synthetics/public/state/actions/monitor_management.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/actions/monitor_management.ts similarity index 94% rename from x-pack/plugins/synthetics/public/state/actions/monitor_management.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/actions/monitor_management.ts index 278f8fe9a4b99..79bec6f3e1b65 100644 --- a/x-pack/plugins/synthetics/public/state/actions/monitor_management.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/actions/monitor_management.ts @@ -11,9 +11,9 @@ import { ServiceLocations, ThrottlingOptions, FetchMonitorManagementListQueryArgs, -} from '../../../common/runtime_types'; +} from '../../../../common/runtime_types'; import { createAsyncAction } from './utils'; -import { SyntheticsServiceAllowed } from '../../../common/types'; +import { SyntheticsServiceAllowed } from '../../../../common/types'; export const getMonitors = createAction( 'GET_MONITOR_MANAGEMENT_LIST' diff --git a/x-pack/plugins/synthetics/public/state/actions/monitor_status.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/actions/monitor_status.ts similarity index 91% rename from x-pack/plugins/synthetics/public/state/actions/monitor_status.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/actions/monitor_status.ts index 3928cd539a5c0..e9fcf67a7b678 100644 --- a/x-pack/plugins/synthetics/public/state/actions/monitor_status.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/actions/monitor_status.ts @@ -7,7 +7,7 @@ import { createAction } from 'redux-actions'; import { QueryParams } from './types'; -import { Ping } from '../../../common/runtime_types'; +import { Ping } from '../../../../common/runtime_types'; export const getMonitorStatusAction = createAction('GET_MONITOR_STATUS'); export const getMonitorStatusActionSuccess = createAction('GET_MONITOR_STATUS_SUCCESS'); diff --git a/x-pack/plugins/synthetics/public/state/actions/network_events.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/actions/network_events.ts similarity index 91% rename from x-pack/plugins/synthetics/public/state/actions/network_events.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/actions/network_events.ts index f078888d6eae8..1467289abe1e8 100644 --- a/x-pack/plugins/synthetics/public/state/actions/network_events.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/actions/network_events.ts @@ -6,7 +6,7 @@ */ import { createAction } from 'redux-actions'; -import { SyntheticsNetworkEventsApiResponse } from '../../../common/runtime_types'; +import { SyntheticsNetworkEventsApiResponse } from '../../../../common/runtime_types'; export interface FetchNetworkEventsParams { checkGroup: string; diff --git a/x-pack/plugins/synthetics/public/state/actions/ping.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/actions/ping.ts similarity index 95% rename from x-pack/plugins/synthetics/public/state/actions/ping.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/actions/ping.ts index 6b997ba184b0b..73be085a86e03 100644 --- a/x-pack/plugins/synthetics/public/state/actions/ping.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/actions/ping.ts @@ -11,7 +11,7 @@ import { HistogramResult, PingsResponse, GetPingsParams, -} from '../../../common/runtime_types'; +} from '../../../../common/runtime_types'; import { createAsyncAction } from './utils'; export const clearPings = createAction('CLEAR PINGS'); diff --git a/x-pack/plugins/synthetics/public/state/actions/selected_filters.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/actions/selected_filters.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/actions/selected_filters.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/actions/selected_filters.ts diff --git a/x-pack/plugins/synthetics/public/state/actions/snapshot.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/actions/snapshot.ts similarity index 88% rename from x-pack/plugins/synthetics/public/state/actions/snapshot.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/actions/snapshot.ts index b1ff299600943..a495c917223a2 100644 --- a/x-pack/plugins/synthetics/public/state/actions/snapshot.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/actions/snapshot.ts @@ -5,7 +5,7 @@ * 2.0. */ -import { Snapshot } from '../../../common/runtime_types'; +import { Snapshot } from '../../../../common/runtime_types'; import { createAsyncAction } from './utils'; import { SnapShotQueryParams } from '../api'; diff --git a/x-pack/plugins/synthetics/public/state/actions/types.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/actions/types.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/actions/types.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/actions/types.ts diff --git a/x-pack/plugins/synthetics/public/state/actions/ui.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/actions/ui.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/actions/ui.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/actions/ui.ts diff --git a/x-pack/plugins/synthetics/public/state/actions/utils.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/actions/utils.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/actions/utils.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/actions/utils.ts diff --git a/x-pack/plugins/synthetics/public/state/alerts/alerts.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/alerts/alerts.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/alerts/alerts.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/alerts/alerts.ts diff --git a/x-pack/plugins/synthetics/public/state/api/__snapshots__/snapshot.test.ts.snap b/x-pack/plugins/synthetics/public/legacy_uptime/state/api/__snapshots__/snapshot.test.ts.snap similarity index 100% rename from x-pack/plugins/synthetics/public/state/api/__snapshots__/snapshot.test.ts.snap rename to x-pack/plugins/synthetics/public/legacy_uptime/state/api/__snapshots__/snapshot.test.ts.snap diff --git a/x-pack/plugins/synthetics/public/state/api/alert_actions.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/api/alert_actions.test.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/api/alert_actions.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/api/alert_actions.test.ts diff --git a/x-pack/plugins/synthetics/public/state/api/alert_actions.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/api/alert_actions.ts similarity index 96% rename from x-pack/plugins/synthetics/public/state/api/alert_actions.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/api/alert_actions.ts index 2a76239ce183a..eabfe42691e8d 100644 --- a/x-pack/plugins/synthetics/public/state/api/alert_actions.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/api/alert_actions.ts @@ -18,11 +18,11 @@ import { // eslint-disable-next-line @kbn/eslint/no-restricted-paths } from '@kbn/actions-plugin/server'; import { NewAlertParams } from './alerts'; -import { ACTION_GROUP_DEFINITIONS } from '../../../common/constants/alerts'; -import { MonitorStatusTranslations } from '../../../common/translations'; +import { ACTION_GROUP_DEFINITIONS } from '../../../../common/constants/alerts'; +import { MonitorStatusTranslations } from '../../../../common/translations'; import { ActionTypeId } from '../../components/settings/types'; -import { Ping } from '../../../common/runtime_types/ping'; -import { DefaultEmail } from '../../../common/runtime_types'; +import { Ping } from '../../../../common/runtime_types/ping'; +import { DefaultEmail } from '../../../../common/runtime_types'; export const SLACK_ACTION_ID: ActionTypeId = '.slack'; export const PAGER_DUTY_ACTION_ID: ActionTypeId = '.pagerduty'; diff --git a/x-pack/plugins/synthetics/public/state/api/alerts.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/api/alerts.ts similarity index 93% rename from x-pack/plugins/synthetics/public/state/api/alerts.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/api/alerts.ts index 1b97422cc67a5..2d5d47578a57b 100644 --- a/x-pack/plugins/synthetics/public/state/api/alerts.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/api/alerts.ts @@ -7,17 +7,17 @@ import type { ActionType, AsApiContract, Rule } from '@kbn/triggers-actions-ui-plugin/public'; import { RuleTypeParams } from '@kbn/alerting-plugin/common'; -import { CLIENT_ALERT_TYPES } from '../../../common/constants/alerts'; +import { CLIENT_ALERT_TYPES } from '../../../../common/constants/alerts'; import { apiService } from './utils'; import { ActionConnector } from '../alerts/alerts'; import { AlertsResult, MonitorIdParam } from '../actions/types'; -import { API_URLS } from '../../../common/constants'; -import { AtomicStatusCheckParams } from '../../../common/runtime_types/alerts'; +import { API_URLS } from '../../../../common/constants'; +import { AtomicStatusCheckParams } from '../../../../common/runtime_types/alerts'; import { populateAlertActions, RuleAction } from './alert_actions'; -import { Ping } from '../../../common/runtime_types/ping'; -import { DefaultEmail } from '../../../common/runtime_types'; +import { Ping } from '../../../../common/runtime_types/ping'; +import { DefaultEmail } from '../../../../common/runtime_types'; const UPTIME_AUTO_ALERT = 'UPTIME_AUTO'; diff --git a/x-pack/plugins/synthetics/public/state/api/dynamic_settings.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/api/dynamic_settings.ts similarity index 89% rename from x-pack/plugins/synthetics/public/state/api/dynamic_settings.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/api/dynamic_settings.ts index a7bacfbba3462..e3c14adf1de74 100644 --- a/x-pack/plugins/synthetics/public/state/api/dynamic_settings.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/api/dynamic_settings.ts @@ -10,9 +10,9 @@ import { DynamicSettings, DynamicSettingsSaveResponse, DynamicSettingsSaveType, -} from '../../../common/runtime_types'; +} from '../../../../common/runtime_types'; import { apiService } from './utils'; -import { API_URLS } from '../../../common/constants'; +import { API_URLS } from '../../../../common/constants'; const apiPath = API_URLS.DYNAMIC_SETTINGS; diff --git a/x-pack/plugins/synthetics/public/state/api/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/api/index.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/api/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/api/index.ts diff --git a/x-pack/plugins/synthetics/public/state/api/index_status.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/api/index_status.ts similarity index 85% rename from x-pack/plugins/synthetics/public/state/api/index_status.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/api/index_status.ts index c6d8f96403eeb..857915deb9023 100644 --- a/x-pack/plugins/synthetics/public/state/api/index_status.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/api/index_status.ts @@ -5,8 +5,8 @@ * 2.0. */ -import { API_URLS } from '../../../common/constants'; -import { StatesIndexStatus, StatesIndexStatusType } from '../../../common/runtime_types'; +import { API_URLS } from '../../../../common/constants'; +import { StatesIndexStatus, StatesIndexStatusType } from '../../../../common/runtime_types'; import { apiService } from './utils'; export const fetchIndexStatus = async (): Promise => { diff --git a/x-pack/plugins/synthetics/public/state/api/journey.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/api/journey.ts similarity index 92% rename from x-pack/plugins/synthetics/public/state/api/journey.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/api/journey.ts index 958ef5e474fee..64a156eb26ed5 100644 --- a/x-pack/plugins/synthetics/public/state/api/journey.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/api/journey.ts @@ -7,7 +7,7 @@ import { apiService } from './utils'; import { FetchJourneyStepsParams } from '../actions/journey'; -import { Ping, PingType } from '../../../common/runtime_types/ping/ping'; +import { Ping, PingType } from '../../../../common/runtime_types/ping/ping'; import { FailedStepsApiResponse, FailedStepsApiResponseType, @@ -16,8 +16,8 @@ import { ScreenshotRefImageData, SyntheticsJourneyApiResponse, SyntheticsJourneyApiResponseType, -} from '../../../common/runtime_types/ping/synthetics'; -import { API_URLS } from '../../../common/constants'; +} from '../../../../common/runtime_types/ping/synthetics'; +import { API_URLS } from '../../../../common/constants'; export async function fetchScreenshotBlockSet(params: string[]): Promise { return apiService.post(API_URLS.JOURNEY_SCREENSHOT_BLOCKS, { diff --git a/x-pack/plugins/synthetics/public/state/api/ml_anomaly.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/api/ml_anomaly.ts similarity index 95% rename from x-pack/plugins/synthetics/public/state/api/ml_anomaly.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/api/ml_anomaly.ts index e7655f37d3f01..18ce74d9823bb 100644 --- a/x-pack/plugins/synthetics/public/state/api/ml_anomaly.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/api/ml_anomaly.ts @@ -14,14 +14,14 @@ import { import { extractErrorMessage } from '@kbn/ml-plugin/common'; import { apiService } from './utils'; import { AnomalyRecords, AnomalyRecordsParams } from '../actions'; -import { API_URLS, ML_MODULE_ID } from '../../../common/constants'; +import { API_URLS, ML_MODULE_ID } from '../../../../common/constants'; import { CreateMLJobSuccess, DeleteJobResults, HeartbeatIndicesParam, MonitorIdParam, } from '../actions/types'; -import { getJobPrefix, getMLJobId } from '../../../common/lib/ml'; +import { getJobPrefix, getMLJobId } from '../../../../common/lib/ml'; export const getMLCapabilities = async (): Promise => { return await apiService.get(API_URLS.ML_CAPABILITIES); diff --git a/x-pack/plugins/synthetics/public/state/api/monitor.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/api/monitor.ts similarity index 92% rename from x-pack/plugins/synthetics/public/state/api/monitor.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/api/monitor.ts index ef04b38f37469..5dfb200444134 100644 --- a/x-pack/plugins/synthetics/public/state/api/monitor.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/api/monitor.ts @@ -6,10 +6,10 @@ */ import { BaseParams } from './types'; -import { MonitorDetailsType, MonitorLocationsType } from '../../../common/runtime_types'; +import { MonitorDetailsType, MonitorLocationsType } from '../../../../common/runtime_types'; import { QueryParams } from '../actions/types'; import { apiService } from './utils'; -import { API_URLS } from '../../../common/constants'; +import { API_URLS } from '../../../../common/constants'; interface ApiRequest { monitorId: string; diff --git a/x-pack/plugins/synthetics/public/state/api/monitor_duration.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/api/monitor_duration.ts similarity index 91% rename from x-pack/plugins/synthetics/public/state/api/monitor_duration.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/api/monitor_duration.ts index c8010e18d0868..3fc046170757c 100644 --- a/x-pack/plugins/synthetics/public/state/api/monitor_duration.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/api/monitor_duration.ts @@ -7,7 +7,7 @@ import { BaseParams } from './types'; import { apiService } from './utils'; -import { API_URLS } from '../../../common/constants'; +import { API_URLS } from '../../../../common/constants'; export const fetchMonitorDuration = async ({ monitorId, dateStart, dateEnd }: BaseParams) => { const queryParams = { diff --git a/x-pack/plugins/synthetics/public/state/api/monitor_list.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/api/monitor_list.ts similarity index 85% rename from x-pack/plugins/synthetics/public/state/api/monitor_list.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/api/monitor_list.ts index 860a46d3e3abc..e328132abe465 100644 --- a/x-pack/plugins/synthetics/public/state/api/monitor_list.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/api/monitor_list.ts @@ -5,13 +5,13 @@ * 2.0. */ -import { API_URLS } from '../../../common/constants'; +import { API_URLS } from '../../../../common/constants'; import { apiService } from './utils'; import { FetchMonitorStatesQueryArgs, MonitorSummariesResult, MonitorSummariesResultType, -} from '../../../common/runtime_types'; +} from '../../../../common/runtime_types'; export const fetchMonitorList = async ( params: FetchMonitorStatesQueryArgs diff --git a/x-pack/plugins/synthetics/public/state/api/monitor_management.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/api/monitor_management.ts similarity index 96% rename from x-pack/plugins/synthetics/public/state/api/monitor_management.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/api/monitor_management.ts index a776d33b8147b..c38fff649048b 100644 --- a/x-pack/plugins/synthetics/public/state/api/monitor_management.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/api/monitor_management.ts @@ -5,7 +5,7 @@ * 2.0. */ -import { API_URLS } from '../../../common/constants'; +import { API_URLS } from '../../../../common/constants'; import { FetchMonitorManagementListQueryArgs, MonitorManagementListResultCodec, @@ -20,11 +20,11 @@ import { ThrottlingOptions, Locations, SyntheticsMonitorSchedule, -} from '../../../common/runtime_types'; +} from '../../../../common/runtime_types'; import { DecryptedSyntheticsMonitorSavedObject, SyntheticsServiceAllowed, -} from '../../../common/types'; +} from '../../../../common/types'; import { apiService } from './utils'; export const setMonitor = async ({ diff --git a/x-pack/plugins/synthetics/public/state/api/monitor_status.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/api/monitor_status.ts similarity index 84% rename from x-pack/plugins/synthetics/public/state/api/monitor_status.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/api/monitor_status.ts index 9c4e7e3eaf5d3..10534c18b7d38 100644 --- a/x-pack/plugins/synthetics/public/state/api/monitor_status.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/api/monitor_status.ts @@ -6,8 +6,8 @@ */ import { QueryParams } from '../actions/types'; -import { Ping } from '../../../common/runtime_types'; -import { API_URLS } from '../../../common/constants'; +import { Ping } from '../../../../common/runtime_types'; +import { API_URLS } from '../../../../common/constants'; import { apiService } from './utils'; export const fetchMonitorStatus = async ({ diff --git a/x-pack/plugins/synthetics/public/state/api/network_events.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/api/network_events.ts similarity index 89% rename from x-pack/plugins/synthetics/public/state/api/network_events.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/api/network_events.ts index d9b3d518444a3..82dcd572ad624 100644 --- a/x-pack/plugins/synthetics/public/state/api/network_events.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/api/network_events.ts @@ -10,8 +10,8 @@ import { FetchNetworkEventsParams } from '../actions/network_events'; import { SyntheticsNetworkEventsApiResponse, SyntheticsNetworkEventsApiResponseType, -} from '../../../common/runtime_types'; -import { API_URLS } from '../../../common/constants'; +} from '../../../../common/runtime_types'; +import { API_URLS } from '../../../../common/constants'; export async function fetchNetworkEvents( params: FetchNetworkEventsParams diff --git a/x-pack/plugins/synthetics/public/state/api/ping.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/api/ping.ts similarity index 90% rename from x-pack/plugins/synthetics/public/state/api/ping.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/api/ping.ts index e4fc5cc620b55..969102a8d77c6 100644 --- a/x-pack/plugins/synthetics/public/state/api/ping.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/api/ping.ts @@ -12,9 +12,9 @@ import { GetPingsParams, GetPingHistogramParams, HistogramResult, -} from '../../../common/runtime_types'; +} from '../../../../common/runtime_types'; import { apiService } from './utils'; -import { API_URLS } from '../../../common/constants'; +import { API_URLS } from '../../../../common/constants'; export const fetchPings: APIFn = async ({ dateRange: { from, to }, diff --git a/x-pack/plugins/synthetics/public/state/api/snapshot.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/api/snapshot.test.ts similarity index 97% rename from x-pack/plugins/synthetics/public/state/api/snapshot.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/api/snapshot.test.ts index 20a0a0d7a477c..97578deeb6fb7 100644 --- a/x-pack/plugins/synthetics/public/state/api/snapshot.test.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/api/snapshot.test.ts @@ -8,7 +8,7 @@ import { HttpFetchError } from '@kbn/core/public'; import { fetchSnapshotCount } from './snapshot'; import { apiService } from './utils'; -import { API_URLS } from '../../../common/constants'; +import { API_URLS } from '../../../../common/constants'; describe('snapshot API', () => { let fetchMock: jest.SpyInstance>; diff --git a/x-pack/plugins/synthetics/public/state/api/snapshot.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/api/snapshot.ts similarity index 85% rename from x-pack/plugins/synthetics/public/state/api/snapshot.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/api/snapshot.ts index d8f38128e3202..7734a0cec79b2 100644 --- a/x-pack/plugins/synthetics/public/state/api/snapshot.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/api/snapshot.ts @@ -5,9 +5,9 @@ * 2.0. */ -import { SnapshotType, Snapshot } from '../../../common/runtime_types'; +import { SnapshotType, Snapshot } from '../../../../common/runtime_types'; import { apiService } from './utils'; -import { API_URLS } from '../../../common/constants'; +import { API_URLS } from '../../../../common/constants'; export interface SnapShotQueryParams { dateRangeStart: string; diff --git a/x-pack/plugins/synthetics/public/state/api/types.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/api/types.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/api/types.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/api/types.ts diff --git a/x-pack/plugins/synthetics/public/state/api/utils.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/api/utils.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/api/utils.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/api/utils.ts diff --git a/x-pack/plugins/synthetics/public/state/certificates/certificates.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/certificates/certificates.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/certificates/certificates.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/certificates/certificates.ts diff --git a/x-pack/plugins/synthetics/public/state/effects/alerts.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/effects/alerts.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/effects/alerts.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/effects/alerts.ts diff --git a/x-pack/plugins/synthetics/public/state/effects/dynamic_settings.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/effects/dynamic_settings.ts similarity index 96% rename from x-pack/plugins/synthetics/public/state/effects/dynamic_settings.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/effects/dynamic_settings.ts index 04cdb13f5612c..1200633976c6f 100644 --- a/x-pack/plugins/synthetics/public/state/effects/dynamic_settings.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/effects/dynamic_settings.ts @@ -21,7 +21,7 @@ import { getDynamicSettings as getDynamicSettingsAPI, setDynamicSettings as setDynamicSettingsAPI, } from '../api'; -import { DynamicSettings } from '../../../common/runtime_types'; +import { DynamicSettings } from '../../../../common/runtime_types'; import { kibanaService } from '../kibana_service'; export function* fetchDynamicSettingsEffect() { diff --git a/x-pack/plugins/synthetics/public/state/effects/fetch_effect.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/effects/fetch_effect.test.ts similarity index 97% rename from x-pack/plugins/synthetics/public/state/effects/fetch_effect.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/effects/fetch_effect.test.ts index 5216260714cc8..4a19cfae58f6a 100644 --- a/x-pack/plugins/synthetics/public/state/effects/fetch_effect.test.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/effects/fetch_effect.test.ts @@ -9,7 +9,7 @@ import { call, put } from 'redux-saga/effects'; import { fetchEffectFactory } from './fetch_effect'; import { indexStatusAction } from '../actions'; import { HttpFetchError } from '@kbn/core/public'; -import { StatesIndexStatus } from '../../../common/runtime_types'; +import { StatesIndexStatus } from '../../../../common/runtime_types'; import { fetchIndexStatus } from '../api'; describe('fetch saga effect factory', () => { diff --git a/x-pack/plugins/synthetics/public/state/effects/fetch_effect.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/effects/fetch_effect.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/effects/fetch_effect.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/effects/fetch_effect.ts diff --git a/x-pack/plugins/synthetics/public/state/effects/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/effects/index.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/effects/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/effects/index.ts diff --git a/x-pack/plugins/synthetics/public/state/effects/index_status.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/effects/index_status.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/effects/index_status.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/effects/index_status.ts diff --git a/x-pack/plugins/synthetics/public/state/effects/journey.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/effects/journey.test.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/effects/journey.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/effects/journey.test.ts diff --git a/x-pack/plugins/synthetics/public/state/effects/journey.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/effects/journey.ts similarity index 93% rename from x-pack/plugins/synthetics/public/state/effects/journey.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/effects/journey.ts index f7c1e23742e69..14d3ce91a32de 100644 --- a/x-pack/plugins/synthetics/public/state/effects/journey.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/effects/journey.ts @@ -14,7 +14,7 @@ import { FetchJourneyStepsParams, } from '../actions/journey'; import { fetchJourneySteps } from '../api/journey'; -import type { SyntheticsJourneyApiResponse } from '../../../common/runtime_types'; +import type { SyntheticsJourneyApiResponse } from '../../../../common/runtime_types'; const inFlightStepRequests: Record = {}; diff --git a/x-pack/plugins/synthetics/public/state/effects/ml_anomaly.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/effects/ml_anomaly.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/effects/ml_anomaly.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/effects/ml_anomaly.ts diff --git a/x-pack/plugins/synthetics/public/state/effects/monitor.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/effects/monitor.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/effects/monitor.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/effects/monitor.ts diff --git a/x-pack/plugins/synthetics/public/state/effects/monitor_duration.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/effects/monitor_duration.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/effects/monitor_duration.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/effects/monitor_duration.ts diff --git a/x-pack/plugins/synthetics/public/state/effects/monitor_list.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/effects/monitor_list.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/effects/monitor_list.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/effects/monitor_list.ts diff --git a/x-pack/plugins/synthetics/public/state/effects/monitor_management.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/effects/monitor_management.ts similarity index 98% rename from x-pack/plugins/synthetics/public/state/effects/monitor_management.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/effects/monitor_management.ts index 60a6676721784..b5ee599b0a4f9 100644 --- a/x-pack/plugins/synthetics/public/state/effects/monitor_management.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/effects/monitor_management.ts @@ -35,7 +35,7 @@ import { import { fetchEffectFactory } from './fetch_effect'; export function* fetchMonitorManagementEffect() { - yield takeLatest( + yield takeLeading( getMonitors, fetchEffectFactory(fetchMonitorManagementList, getMonitorsSuccess, getMonitorsFailure) ); @@ -47,7 +47,7 @@ export function* fetchMonitorManagementEffect() { getServiceLocationsFailure ) ); - yield takeLatest( + yield takeLeading( getSyntheticsEnablement, fetchEffectFactory( fetchGetSyntheticsEnablement, diff --git a/x-pack/plugins/synthetics/public/state/effects/monitor_status.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/effects/monitor_status.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/effects/monitor_status.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/effects/monitor_status.ts diff --git a/x-pack/plugins/synthetics/public/state/effects/network_events.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/effects/network_events.ts similarity index 98% rename from x-pack/plugins/synthetics/public/state/effects/network_events.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/effects/network_events.ts index 75ea3d4467eb4..8c74e753c162c 100644 --- a/x-pack/plugins/synthetics/public/state/effects/network_events.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/effects/network_events.ts @@ -14,7 +14,7 @@ import { FetchNetworkEventsParams, } from '../actions/network_events'; import { fetchNetworkEvents } from '../api/network_events'; -import type { SyntheticsNetworkEventsApiResponse } from '../../../common/runtime_types'; +import type { SyntheticsNetworkEventsApiResponse } from '../../../../common/runtime_types'; export function* fetchNetworkEventsEffect() { yield takeLatest( diff --git a/x-pack/plugins/synthetics/public/state/effects/ping.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/effects/ping.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/effects/ping.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/effects/ping.ts diff --git a/x-pack/plugins/synthetics/public/state/effects/synthetic_journey_blocks.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/effects/synthetic_journey_blocks.ts similarity index 96% rename from x-pack/plugins/synthetics/public/state/effects/synthetic_journey_blocks.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/effects/synthetic_journey_blocks.ts index 829048747ddf7..6ffbeb6978f75 100644 --- a/x-pack/plugins/synthetics/public/state/effects/synthetic_journey_blocks.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/effects/synthetic_journey_blocks.ts @@ -7,7 +7,7 @@ import { Action } from 'redux-actions'; import { call, fork, put, select, takeEvery, throttle } from 'redux-saga/effects'; -import { ScreenshotBlockDoc } from '../../../common/runtime_types/ping/synthetics'; +import { ScreenshotBlockDoc } from '../../../../common/runtime_types/ping/synthetics'; import { fetchScreenshotBlockSet } from '../api/journey'; import { fetchBlocksAction, diff --git a/x-pack/plugins/synthetics/public/state/effects/test_now_runs.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/effects/test_now_runs.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/effects/test_now_runs.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/effects/test_now_runs.ts diff --git a/x-pack/plugins/synthetics/public/state/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/index.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/index.ts diff --git a/x-pack/plugins/synthetics/public/state/kibana_service.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/kibana_service.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/kibana_service.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/kibana_service.ts diff --git a/x-pack/plugins/synthetics/public/state/reducers/dynamic_settings.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/dynamic_settings.ts similarity index 96% rename from x-pack/plugins/synthetics/public/state/reducers/dynamic_settings.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/dynamic_settings.ts index 93f30c77f5536..d7c20b8edf7a3 100644 --- a/x-pack/plugins/synthetics/public/state/reducers/dynamic_settings.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/dynamic_settings.ts @@ -14,7 +14,7 @@ import { setDynamicSettingsSuccess, setDynamicSettingsFail, } from '../actions/dynamic_settings'; -import { DynamicSettings } from '../../../common/runtime_types'; +import { DynamicSettings } from '../../../../common/runtime_types'; export interface DynamicSettingsState { settings?: DynamicSettings; diff --git a/x-pack/plugins/synthetics/public/state/reducers/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/index.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/reducers/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/index.ts diff --git a/x-pack/plugins/synthetics/public/state/reducers/index_status.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/index_status.ts similarity index 92% rename from x-pack/plugins/synthetics/public/state/reducers/index_status.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/index_status.ts index 7c3aecd98f706..29ea59cabb9e5 100644 --- a/x-pack/plugins/synthetics/public/state/reducers/index_status.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/index_status.ts @@ -9,7 +9,7 @@ import { handleActions } from 'redux-actions'; import { indexStatusAction } from '../actions'; import { asyncInitState, handleAsyncAction } from './utils'; import { AsyncInitState } from './types'; -import { StatesIndexStatus } from '../../../common/runtime_types'; +import { StatesIndexStatus } from '../../../../common/runtime_types'; export interface IndexStatusState { indexStatus: AsyncInitState; diff --git a/x-pack/plugins/synthetics/public/state/reducers/journey.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/journey.ts similarity index 98% rename from x-pack/plugins/synthetics/public/state/reducers/journey.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/journey.ts index 98bbd93a24e0c..ae781b5839593 100644 --- a/x-pack/plugins/synthetics/public/state/reducers/journey.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/journey.ts @@ -6,7 +6,7 @@ */ import { handleActions, Action } from 'redux-actions'; -import { JourneyStep, SyntheticsJourneyApiResponse } from '../../../common/runtime_types'; +import { JourneyStep, SyntheticsJourneyApiResponse } from '../../../../common/runtime_types'; import { pruneJourneyState } from '../actions/journey'; import { FetchJourneyStepsParams, diff --git a/x-pack/plugins/synthetics/public/state/reducers/ml_anomaly.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/ml_anomaly.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/reducers/ml_anomaly.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/ml_anomaly.ts diff --git a/x-pack/plugins/synthetics/public/state/reducers/monitor.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/monitor.ts similarity index 96% rename from x-pack/plugins/synthetics/public/state/reducers/monitor.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/monitor.ts index 3c5be59ea9dda..23f2aac045b29 100644 --- a/x-pack/plugins/synthetics/public/state/reducers/monitor.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/monitor.ts @@ -13,7 +13,7 @@ import { getMonitorLocationsActionSuccess, getMonitorLocationsActionFail, } from '../actions/monitor'; -import { MonitorLocations } from '../../../common/runtime_types'; +import { MonitorLocations } from '../../../../common/runtime_types'; type MonitorLocationsList = Map; diff --git a/x-pack/plugins/synthetics/public/state/reducers/monitor_duration.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/monitor_duration.ts similarity index 95% rename from x-pack/plugins/synthetics/public/state/reducers/monitor_duration.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/monitor_duration.ts index 51eae6049b309..71fa50b75f5d6 100644 --- a/x-pack/plugins/synthetics/public/state/reducers/monitor_duration.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/monitor_duration.ts @@ -11,7 +11,7 @@ import { getMonitorDurationActionSuccess, getMonitorDurationActionFail, } from '../actions'; -import { MonitorDurationResult } from '../../../common/types'; +import { MonitorDurationResult } from '../../../../common/types'; export interface MonitorDuration { durationLines: MonitorDurationResult | null; diff --git a/x-pack/plugins/synthetics/public/state/reducers/monitor_list.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/monitor_list.ts similarity index 97% rename from x-pack/plugins/synthetics/public/state/reducers/monitor_list.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/monitor_list.ts index 3630842cb9f8f..6e325a699a114 100644 --- a/x-pack/plugins/synthetics/public/state/reducers/monitor_list.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/monitor_list.ts @@ -15,7 +15,7 @@ import { clearRefreshedMonitorId, setUpdatingMonitorId, } from '../actions'; -import { MonitorSummariesResult } from '../../../common/runtime_types'; +import { MonitorSummariesResult } from '../../../../common/runtime_types'; import { AppState } from '..'; import { TestNowResponse } from '../api'; diff --git a/x-pack/plugins/synthetics/public/state/reducers/monitor_management.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/monitor_management.ts similarity index 98% rename from x-pack/plugins/synthetics/public/state/reducers/monitor_management.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/monitor_management.ts index d60de74c1f54c..18c247a655275 100644 --- a/x-pack/plugins/synthetics/public/state/reducers/monitor_management.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/monitor_management.ts @@ -31,8 +31,8 @@ import { ServiceLocations, ThrottlingOptions, DEFAULT_THROTTLING, -} from '../../../common/runtime_types'; -import { SyntheticsServiceAllowed } from '../../../common/types'; +} from '../../../../common/runtime_types'; +import { SyntheticsServiceAllowed } from '../../../../common/types'; export interface MonitorManagementList { error: Record<'monitorList' | 'serviceLocations' | 'enablement', Error | null>; diff --git a/x-pack/plugins/synthetics/public/state/reducers/monitor_status.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/monitor_status.test.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/reducers/monitor_status.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/monitor_status.test.ts diff --git a/x-pack/plugins/synthetics/public/state/reducers/monitor_status.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/monitor_status.ts similarity index 96% rename from x-pack/plugins/synthetics/public/state/reducers/monitor_status.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/monitor_status.ts index b27de0d944a8e..cd32a410503a3 100644 --- a/x-pack/plugins/synthetics/public/state/reducers/monitor_status.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/monitor_status.ts @@ -11,7 +11,7 @@ import { getMonitorStatusActionSuccess, getMonitorStatusActionFail, } from '../actions'; -import { Ping } from '../../../common/runtime_types'; +import { Ping } from '../../../../common/runtime_types'; import { QueryParams } from '../actions/types'; export interface MonitorStatusState { diff --git a/x-pack/plugins/synthetics/public/state/reducers/network_events.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/network_events.ts similarity index 99% rename from x-pack/plugins/synthetics/public/state/reducers/network_events.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/network_events.ts index e58a8f75c7fa3..0abe4aeb2c7be 100644 --- a/x-pack/plugins/synthetics/public/state/reducers/network_events.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/network_events.ts @@ -6,7 +6,7 @@ */ import { handleActions, Action } from 'redux-actions'; -import { NetworkEvent, SyntheticsNetworkEventsApiResponse } from '../../../common/runtime_types'; +import { NetworkEvent, SyntheticsNetworkEventsApiResponse } from '../../../../common/runtime_types'; import { FetchNetworkEventsParams, FetchNetworkEventsFailPayload, diff --git a/x-pack/plugins/synthetics/public/state/reducers/ping.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/ping.ts similarity index 94% rename from x-pack/plugins/synthetics/public/state/reducers/ping.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/ping.ts index a91734d77b4ab..f156a5596a84e 100644 --- a/x-pack/plugins/synthetics/public/state/reducers/ping.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/ping.ts @@ -7,7 +7,7 @@ import { handleActions, Action } from 'redux-actions'; import { getPingHistogram } from '../actions'; -import { HistogramResult } from '../../../common/runtime_types'; +import { HistogramResult } from '../../../../common/runtime_types'; export interface PingState { pingHistogram: HistogramResult | null; diff --git a/x-pack/plugins/synthetics/public/state/reducers/ping_list.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/ping_list.ts similarity index 94% rename from x-pack/plugins/synthetics/public/state/reducers/ping_list.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/ping_list.ts index 09d9347cedd3b..4403c2484dedb 100644 --- a/x-pack/plugins/synthetics/public/state/reducers/ping_list.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/ping_list.ts @@ -6,7 +6,7 @@ */ import { handleActions, Action } from 'redux-actions'; -import { PingsResponse } from '../../../common/runtime_types'; +import { PingsResponse } from '../../../../common/runtime_types'; import { clearPings, getPings, getPingsSuccess, getPingsFail } from '../actions'; export interface PingListState { diff --git a/x-pack/plugins/synthetics/public/state/reducers/selected_filters.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/selected_filters.test.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/reducers/selected_filters.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/selected_filters.test.ts diff --git a/x-pack/plugins/synthetics/public/state/reducers/selected_filters.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/selected_filters.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/reducers/selected_filters.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/selected_filters.ts diff --git a/x-pack/plugins/synthetics/public/state/reducers/synthetics.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/synthetics.test.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/reducers/synthetics.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/synthetics.test.ts diff --git a/x-pack/plugins/synthetics/public/state/reducers/synthetics.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/synthetics.ts similarity index 99% rename from x-pack/plugins/synthetics/public/state/reducers/synthetics.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/synthetics.ts index 1e97c3972444b..2a0cf7188a9e8 100644 --- a/x-pack/plugins/synthetics/public/state/reducers/synthetics.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/synthetics.ts @@ -9,7 +9,7 @@ import { createAction, handleActions, Action } from 'redux-actions'; import { isScreenshotBlockDoc, ScreenshotBlockDoc, -} from '../../../common/runtime_types/ping/synthetics'; +} from '../../../../common/runtime_types/ping/synthetics'; export interface PendingBlock { status: 'pending' | 'loading'; diff --git a/x-pack/plugins/synthetics/public/state/reducers/test_now_runs.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/test_now_runs.ts similarity index 98% rename from x-pack/plugins/synthetics/public/state/reducers/test_now_runs.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/test_now_runs.ts index d081039e4d901..ffe49ff017259 100644 --- a/x-pack/plugins/synthetics/public/state/reducers/test_now_runs.ts +++ b/x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/test_now_runs.ts @@ -13,7 +13,7 @@ import { ScheduleUnit, ServiceLocationErrors, SyntheticsMonitorSchedule, -} from '../../../common/runtime_types'; +} from '../../../../common/runtime_types'; import { clearTestNowMonitorAction, testNowMonitorAction } from '../actions'; import { TestNowResponse } from '../api'; import { AppState } from '..'; diff --git a/x-pack/plugins/synthetics/public/state/reducers/types.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/types.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/reducers/types.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/types.ts diff --git a/x-pack/plugins/synthetics/public/state/reducers/ui.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/ui.test.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/reducers/ui.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/ui.test.ts diff --git a/x-pack/plugins/synthetics/public/state/reducers/ui.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/ui.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/reducers/ui.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/ui.ts diff --git a/x-pack/plugins/synthetics/public/state/reducers/utils.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/utils.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/reducers/utils.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/reducers/utils.ts diff --git a/x-pack/plugins/synthetics/public/state/selectors/index.test.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/selectors/index.test.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/selectors/index.test.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/selectors/index.test.ts diff --git a/x-pack/plugins/synthetics/public/state/selectors/index.ts b/x-pack/plugins/synthetics/public/legacy_uptime/state/selectors/index.ts similarity index 100% rename from x-pack/plugins/synthetics/public/state/selectors/index.ts rename to x-pack/plugins/synthetics/public/legacy_uptime/state/selectors/index.ts diff --git a/x-pack/plugins/synthetics/public/apps/plugin.ts b/x-pack/plugins/synthetics/public/plugin.ts similarity index 83% rename from x-pack/plugins/synthetics/public/apps/plugin.ts rename to x-pack/plugins/synthetics/public/plugin.ts index 7f1a773376688..88238b1bfbf37 100644 --- a/x-pack/plugins/synthetics/public/apps/plugin.ts +++ b/x-pack/plugins/synthetics/public/plugin.ts @@ -39,14 +39,17 @@ import { Start as InspectorPluginStart } from '@kbn/inspector-plugin/public'; import { CasesUiStart } from '@kbn/cases-plugin/public'; import { CloudSetup } from '@kbn/cloud-plugin/public'; import { DataViewsPublicPluginStart } from '@kbn/data-views-plugin/public'; -import { PLUGIN } from '../../common/constants/plugin'; +import { PLUGIN } from '../common/constants/plugin'; import { LazySyntheticsPolicyCreateExtension, LazySyntheticsPolicyEditExtension, -} from '../components/fleet_package'; -import { LazySyntheticsCustomAssetsExtension } from '../components/fleet_package/lazy_synthetics_custom_assets_extension'; -import { uptimeOverviewNavigatorParams } from './locators/overview'; -import { alertTypeInitializers, legacyAlertTypeInitializers } from '../lib/alert_types'; +} from './legacy_uptime/components/fleet_package'; +import { LazySyntheticsCustomAssetsExtension } from './legacy_uptime/components/fleet_package/lazy_synthetics_custom_assets_extension'; +import { uptimeOverviewNavigatorParams } from './apps/locators/overview'; +import { + alertTypeInitializers, + legacyAlertTypeInitializers, +} from './legacy_uptime/lib/alert_types'; export interface ClientPluginsSetup { home?: HomePublicPluginSetup; @@ -100,7 +103,7 @@ export class UptimePlugin } const getUptimeDataHelper = async () => { const [coreStart] = await core.getStartServices(); - const { UptimeDataHelper } = await import('./uptime_overview_fetcher'); + const { UptimeDataHelper } = await import('./legacy_uptime/app/uptime_overview_fetcher'); return UptimeDataHelper(coreStart); }; @@ -186,27 +189,29 @@ export class UptimePlugin }); }); + const appKeywords = [ + 'Synthetics', + 'pings', + 'checks', + 'availability', + 'response duration', + 'response time', + 'outside in', + 'reachability', + 'reachable', + 'digital', + 'performance', + 'web performance', + 'web perf', + ]; + core.application.register({ id: PLUGIN.ID, euiIconType: 'logoObservability', order: 8400, title: PLUGIN.TITLE, category: DEFAULT_APP_CATEGORIES.observability, - keywords: [ - 'Synthetics', - 'pings', - 'checks', - 'availability', - 'response duration', - 'response time', - 'outside in', - 'reachability', - 'reachable', - 'digital', - 'performance', - 'web performance', - 'web perf', - ], + keywords: appKeywords, deepLinks: [ { id: 'Down monitors', title: 'Down monitors', path: '/?statusFilter=down' }, { id: 'Certificates', title: 'TLS Certificates', path: '/certificates' }, @@ -215,7 +220,24 @@ export class UptimePlugin mount: async (params: AppMountParameters) => { const [coreStart, corePlugins] = await core.getStartServices(); - const { renderApp } = await import('./render_app'); + const { renderApp } = await import('./legacy_uptime/app/render_app'); + return renderApp(coreStart, plugins, corePlugins, params, this.initContext.env.mode.dev); + }, + }); + + // Register the Synthetics UI plugin + core.application.register({ + id: 'synthetics', + euiIconType: 'logoObservability', + order: 8400, + title: PLUGIN.SYNTHETICS, + category: DEFAULT_APP_CATEGORIES.observability, + keywords: appKeywords, + deepLinks: [], + mount: async (params: AppMountParameters) => { + const [coreStart, corePlugins] = await core.getStartServices(); + + const { renderApp } = await import('./apps/synthetics/render_app'); return renderApp(coreStart, plugins, corePlugins, params, this.initContext.env.mode.dev); }, }); diff --git a/x-pack/plugins/synthetics/server/kibana.index.ts b/x-pack/plugins/synthetics/server/kibana.index.ts index 2791640115469..14ac9edd5ff2f 100644 --- a/x-pack/plugins/synthetics/server/kibana.index.ts +++ b/x-pack/plugins/synthetics/server/kibana.index.ts @@ -44,7 +44,7 @@ export const initServerWithKibana = ( name: PLUGIN.NAME, order: 1000, category: DEFAULT_APP_CATEGORIES.observability, - app: ['uptime', 'kibana'], + app: ['uptime', 'kibana', 'synthetics'], catalogue: ['uptime'], management: { insightsAndAlerting: ['triggersActions'], @@ -52,7 +52,7 @@ export const initServerWithKibana = ( alerting: UPTIME_RULE_TYPES, privileges: { all: { - app: ['uptime', 'kibana'], + app: ['uptime', 'kibana', 'synthetics'], catalogue: ['uptime'], api: ['uptime-read', 'uptime-write', 'lists-all'], savedObject: { @@ -73,7 +73,7 @@ export const initServerWithKibana = ( ui: ['save', 'configureSettings', 'show', 'alerting:save'], }, read: { - app: ['uptime', 'kibana'], + app: ['uptime', 'kibana', 'synthetics'], catalogue: ['uptime'], api: ['uptime-read', 'lists-read'], savedObject: { diff --git a/x-pack/plugins/synthetics/server/lib/synthetics_service/formatters/browser.ts b/x-pack/plugins/synthetics/server/lib/synthetics_service/formatters/browser.ts index 616d764c50abb..876827e453adf 100644 --- a/x-pack/plugins/synthetics/server/lib/synthetics_service/formatters/browser.ts +++ b/x-pack/plugins/synthetics/server/lib/synthetics_service/formatters/browser.ts @@ -10,6 +10,21 @@ import { BrowserFields, ConfigKey } from '../../../../common/runtime_types/monit export type BrowserFormatMap = Record; +const throttlingFormatter: Formatter = (fields) => { + if (!fields[ConfigKey.IS_THROTTLING_ENABLED]) return false; + + const getThrottlingValue = (v: string | undefined, suffix: 'd' | 'u' | 'l') => + v !== '' && v !== undefined ? `${v}${suffix}` : null; + + return [ + getThrottlingValue(fields[ConfigKey.DOWNLOAD_SPEED], 'd'), + getThrottlingValue(fields[ConfigKey.UPLOAD_SPEED], 'u'), + getThrottlingValue(fields[ConfigKey.LATENCY], 'l'), + ] + .filter((v) => v !== null) + .join('/'); +}; + export const browserFormatters: BrowserFormatMap = { [ConfigKey.METADATA]: (fields) => objectFormatter(fields[ConfigKey.METADATA]), [ConfigKey.URLS]: null, @@ -31,12 +46,7 @@ export const browserFormatters: BrowserFormatMap = { [ConfigKey.ZIP_URL_TLS_KEY_PASSPHRASE]: null, [ConfigKey.ZIP_URL_TLS_VERIFICATION_MODE]: null, [ConfigKey.IS_THROTTLING_ENABLED]: null, - [ConfigKey.THROTTLING_CONFIG]: (fields) => { - if (fields[ConfigKey.IS_THROTTLING_ENABLED] === false) { - return false; - } - return fields[ConfigKey.THROTTLING_CONFIG] ?? false; - }, + [ConfigKey.THROTTLING_CONFIG]: (fields) => throttlingFormatter(fields), [ConfigKey.DOWNLOAD_SPEED]: null, [ConfigKey.UPLOAD_SPEED]: null, [ConfigKey.LATENCY]: null, diff --git a/x-pack/plugins/synthetics/server/lib/synthetics_service/formatters/convert_to_data_stream.ts b/x-pack/plugins/synthetics/server/lib/synthetics_service/formatters/convert_to_data_stream.ts index 7d518b189afef..52ae921c78643 100644 --- a/x-pack/plugins/synthetics/server/lib/synthetics_service/formatters/convert_to_data_stream.ts +++ b/x-pack/plugins/synthetics/server/lib/synthetics_service/formatters/convert_to_data_stream.ts @@ -5,7 +5,7 @@ * 2.0. */ -import { DEFAULT_NAMESPACE_STRING } from '../../../../common/constants'; +import { DEFAULT_NAMESPACE_STRING } from '../../../../common/constants/monitor_defaults'; import { DataStream, MonitorFields } from '../../../../common/runtime_types'; interface DataStreamConfig { diff --git a/x-pack/plugins/synthetics/tsconfig.json b/x-pack/plugins/synthetics/tsconfig.json index 17088fe6f1fd9..023c98c66a4a5 100644 --- a/x-pack/plugins/synthetics/tsconfig.json +++ b/x-pack/plugins/synthetics/tsconfig.json @@ -10,7 +10,7 @@ "common/**/*", "scripts/**/*", "public/**/*", - "public/components/monitor/status_details/location_map/embeddables/low_poly_layer.json", + "public/legacy_uptime/components/monitor/status_details/location_map/embeddables/low_poly_layer.json", "server/**/*", "server/lib/requests/__fixtures__/monitor_charts_mock.json", "../../../typings/**/*" diff --git a/x-pack/plugins/task_manager/server/task_events.test.ts b/x-pack/plugins/task_manager/server/task_events.test.ts index 607453b7ea92f..9c6b9f9cdede8 100644 --- a/x-pack/plugins/task_manager/server/task_events.test.ts +++ b/x-pack/plugins/task_manager/server/task_events.test.ts @@ -11,17 +11,28 @@ const DelayIterations = 4; const DelayMillis = 250; const DelayTotal = DelayIterations * DelayMillis; -async function nonBlockingDelay(millis: number) { +async function basicNonBlockingDelay(millis: number) { await new Promise((resolve) => setTimeout(resolve, millis)); } +async function nonBlockingDelay(millis: number) { + // can't just use basicNonBlockingDelay because: + // https://github.com/nodejs/node/issues/26578 + const end = Date.now() + millis; + + while (Date.now() <= end) { + await basicNonBlockingDelay(millis); + } +} + async function blockingDelay(millis: number) { // get task in async queue await nonBlockingDelay(0); const end = Date.now() + millis; + // eslint-disable-next-line no-empty - while (Date.now() < end) {} + while (Date.now() <= end) {} } async function nonBlockingTask() { @@ -45,8 +56,7 @@ describe('task_events', () => { expect(result.eventLoopBlockMs).toBe(undefined); }); - // FLAKY: https://github.com/elastic/kibana/issues/128441 - describe.skip('startTaskTimerWithEventLoopMonitoring', () => { + describe('startTaskTimerWithEventLoopMonitoring', () => { test('non-blocking', async () => { const stopTaskTimer = startTaskTimerWithEventLoopMonitoring({ monitor: true, diff --git a/x-pack/plugins/telemetry_collection_xpack/schema/xpack_plugins.json b/x-pack/plugins/telemetry_collection_xpack/schema/xpack_plugins.json index 0ac826d27ea7b..aac8d2e40f650 100644 --- a/x-pack/plugins/telemetry_collection_xpack/schema/xpack_plugins.json +++ b/x-pack/plugins/telemetry_collection_xpack/schema/xpack_plugins.json @@ -4557,19 +4557,6 @@ } } }, - "search-session": { - "properties": { - "transientCount": { - "type": "long" - }, - "persistedCount": { - "type": "long" - }, - "totalCount": { - "type": "long" - } - } - }, "discoverEnhanced": { "properties": { "exploreDataInChartActionEnabled": { @@ -12825,98 +12812,6 @@ } } }, - "task_manager": { - "properties": { - "ephemeral_tasks_enabled": { - "type": "boolean" - }, - "ephemeral_request_capacity": { - "type": "short" - }, - "ephemeral_stats": { - "properties": { - "status": { - "type": "keyword" - }, - "queued_tasks": { - "properties": { - "p50": { - "type": "long" - }, - "p90": { - "type": "long" - }, - "p95": { - "type": "long" - }, - "p99": { - "type": "long" - } - } - }, - "load": { - "properties": { - "p50": { - "type": "long" - }, - "p90": { - "type": "long" - }, - "p95": { - "type": "long" - }, - "p99": { - "type": "long" - } - } - }, - "executions_per_cycle": { - "properties": { - "p50": { - "type": "long" - }, - "p90": { - "type": "long" - }, - "p95": { - "type": "long" - }, - "p99": { - "type": "long" - } - } - } - } - }, - "task_type_exclusion": { - "type": "array", - "items": { - "type": "keyword" - } - }, - "failed_tasks": { - "type": "long" - } - } - }, - "upgrade-assistant-telemetry": { - "properties": { - "features": { - "properties": { - "deprecation_logging": { - "properties": { - "enabled": { - "type": "boolean", - "_meta": { - "description": "Whether user has enabled Elasticsearch deprecation logging" - } - } - } - } - } - } - } - }, "uptime": { "properties": { "last_24_hours": { @@ -13057,6 +12952,98 @@ } } } + }, + "task_manager": { + "properties": { + "ephemeral_tasks_enabled": { + "type": "boolean" + }, + "ephemeral_request_capacity": { + "type": "short" + }, + "ephemeral_stats": { + "properties": { + "status": { + "type": "keyword" + }, + "queued_tasks": { + "properties": { + "p50": { + "type": "long" + }, + "p90": { + "type": "long" + }, + "p95": { + "type": "long" + }, + "p99": { + "type": "long" + } + } + }, + "load": { + "properties": { + "p50": { + "type": "long" + }, + "p90": { + "type": "long" + }, + "p95": { + "type": "long" + }, + "p99": { + "type": "long" + } + } + }, + "executions_per_cycle": { + "properties": { + "p50": { + "type": "long" + }, + "p90": { + "type": "long" + }, + "p95": { + "type": "long" + }, + "p99": { + "type": "long" + } + } + } + } + }, + "task_type_exclusion": { + "type": "array", + "items": { + "type": "keyword" + } + }, + "failed_tasks": { + "type": "long" + } + } + }, + "upgrade-assistant-telemetry": { + "properties": { + "features": { + "properties": { + "deprecation_logging": { + "properties": { + "enabled": { + "type": "boolean", + "_meta": { + "description": "Whether user has enabled Elasticsearch deprecation logging" + } + } + } + } + } + } + } } } } diff --git a/x-pack/plugins/timelines/kibana.json b/x-pack/plugins/timelines/kibana.json index 11adf42b3a6b4..77a5dcc699bdc 100644 --- a/x-pack/plugins/timelines/kibana.json +++ b/x-pack/plugins/timelines/kibana.json @@ -10,6 +10,6 @@ "extraPublicDirs": ["common"], "server": true, "ui": true, - "requiredPlugins": ["alerting", "cases", "data", "dataEnhanced", "kibanaReact", "kibanaUtils"], + "requiredPlugins": ["alerting", "cases", "data", "kibanaReact", "kibanaUtils"], "optionalPlugins": ["security"] } diff --git a/x-pack/plugins/timelines/tsconfig.json b/x-pack/plugins/timelines/tsconfig.json index 9677c0e64dd88..3063c1acda545 100644 --- a/x-pack/plugins/timelines/tsconfig.json +++ b/x-pack/plugins/timelines/tsconfig.json @@ -20,7 +20,6 @@ { "path": "../../../src/core/tsconfig.json" }, { "path": "../../../src/plugins/data/tsconfig.json" }, { "path": "../../../src/plugins/home/tsconfig.json" }, - { "path": "../data_enhanced/tsconfig.json" }, { "path": "../features/tsconfig.json" }, { "path": "../cases/tsconfig.json" }, { "path": "../licensing/tsconfig.json" }, diff --git a/x-pack/plugins/translations/translations/fr-FR.json b/x-pack/plugins/translations/translations/fr-FR.json index c1ff631000ee0..9bc497a66f473 100644 --- a/x-pack/plugins/translations/translations/fr-FR.json +++ b/x-pack/plugins/translations/translations/fr-FR.json @@ -440,7 +440,6 @@ "xpack.lens.indexPattern.dateHistogram.autoAdvancedExplanation": "L'intervalle suit cette logique :", "xpack.lens.indexPattern.dateHistogram.autoBasicExplanation": "L'histogramme des dates automatique divise un champ de données en groupes par intervalle.", "xpack.lens.indexPattern.dateHistogram.autoBoundHeader": "Intervalle cible mesuré", - "xpack.lens.indexPattern.dateHistogram.autoHelpText": "Fonctionnement", "xpack.lens.indexPattern.dateHistogram.autoInterval": "Personnaliser l'intervalle de temps", "xpack.lens.indexPattern.dateHistogram.autoIntervalHeader": "Intervalle utilisé", "xpack.lens.indexPattern.dateHistogram.autoLongerExplanation": "Pour choisir l'intervalle, Lens divise la plage temporelle spécifiée par le paramètre {targetBarSetting}. Lens calcule le meilleur intervalle pour vos données. Par exemple 30m, 1h et 12. Le nombre maximal de barres est défini par la valeur {maxBarSetting}.", @@ -573,7 +572,6 @@ "xpack.lens.indexPattern.moving_average.signature": "indicateur : nombre, [window] : nombre", "xpack.lens.indexPattern.movingAverage": "Moyenne mobile", "xpack.lens.indexPattern.movingAverage.basicExplanation": "La moyenne mobile fait glisser une fenêtre sur les données et affiche la valeur moyenne. La moyenne mobile est prise en charge uniquement par les histogrammes des dates.", - "xpack.lens.indexPattern.movingAverage.helpText": "Fonctionnement", "xpack.lens.indexPattern.movingAverage.limitations": "La première valeur de moyenne mobile commence au deuxième élément.", "xpack.lens.indexPattern.movingAverage.longerExplanation": "Pour calculer la moyenne mobile, Lens utilise la moyenne de la fenêtre et applique une politique d'omission pour les blancs. Pour les valeurs manquantes, le groupe est ignoré, et le calcul est effectué sur la valeur suivante.", "xpack.lens.indexPattern.movingAverage.tableExplanation": "Par exemple, avec les données [1, 2, 3, 4, 5, 6, 7, 8, 9, 10], vous pouvez calculer une moyenne mobile simple avec une taille de fenêtre de 5 :", @@ -811,7 +809,6 @@ "xpack.lens.shared.axisNameLabel": "Titre de l'axe", "xpack.lens.shared.chartValueLabelVisibilityLabel": "Étiquettes", "xpack.lens.shared.curveLabel": "Options visuelles", - "xpack.lens.shared.legend.filterForValueButtonAriaLabel": "Filtre pour la valeur", "xpack.lens.shared.legend.filterOptionsLegend": "{legendDataLabel}, options de filtre", "xpack.lens.shared.legend.filterOutValueButtonAriaLabel": "Filtrer la valeur", "xpack.lens.shared.legendAlignmentLabel": "Alignement", @@ -2621,6 +2618,107 @@ "data.searchSessions.sessionService.sessionObjectFetchError": "Échec de récupération des informations de la session de recherche", "data.triggers.applyFilterDescription": "Lorsque le filtre Kibana est appliqué. Peut être un filtre simple ou un filtre de plage.", "data.triggers.applyFilterTitle": "Appliquer le filtre", + "data.mgmt.searchSessions.actionDelete": "Supprimer", + "data.mgmt.searchSessions.actionExtend": "Étendre", + "data.mgmt.searchSessions.actionRename": "Modifier le nom", + "data.mgmt.searchSessions.actions.tooltip.moreActions": "Plus d'actions", + "data.mgmt.searchSessions.api.deleted": "La session de recherche a été supprimée.", + "data.mgmt.searchSessions.api.deletedError": "Impossible de supprimer la session de recherche !", + "data.mgmt.searchSessions.api.extended": "La session de recherche a été étendue.", + "data.mgmt.searchSessions.api.extendError": "Impossible d'étendre la session de recherche !", + "data.mgmt.searchSessions.api.fetchError": "Impossible d'actualiser la page !", + "data.mgmt.searchSessions.api.fetchTimeout": "La récupération des informations de la session de recherche a expiré après {timeout} secondes", + "data.mgmt.searchSessions.api.rename": "La session de recherche a été renommée", + "data.mgmt.searchSessions.api.renameError": "Impossible de renommer la session de recherche", + "data.mgmt.searchSessions.appTitle": "Sessions de recherche", + "data.mgmt.searchSessions.ariaLabel.moreActions": "Plus d'actions", + "data.mgmt.searchSessions.cancelModal.cancelButton": "Annuler", + "data.mgmt.searchSessions.cancelModal.deleteButton": "Supprimer", + "data.mgmt.searchSessions.cancelModal.message": "La suppression de la session de recherche \"{name}\" supprime tous les résultats mis en cache.", + "data.mgmt.searchSessions.cancelModal.title": "Supprimer la session de recherche", + "data.mgmt.searchSessions.extendModal.dontExtendButton": "Annuler", + "data.mgmt.searchSessions.extendModal.extendButton": "Étendre l'expiration", + "data.mgmt.searchSessions.extendModal.extendMessage": "L'expiration de la session de recherche \"{name}\" sera étendue jusqu'à {newExpires}.", + "data.mgmt.searchSessions.extendModal.title": "Étendre l'expiration de la session de recherche", + "data.mgmt.searchSessions.flyoutTitle": "Inspecter", + "data.mgmt.searchSessions.main.backgroundSessionsDocsLinkText": "Documentation", + "data.mgmt.searchSessions.main.sectionDescription": "Gérez vos sessions de recherche enregistrées.", + "data.mgmt.searchSessions.main.sectionTitle": "Sessions de recherche", + "data.mgmt.searchSessions.renameModal.cancelButton": "Annuler", + "data.mgmt.searchSessions.renameModal.renameButton": "Enregistrer", + "data.mgmt.searchSessions.renameModal.searchSessionNameInputLabel": "Nom de la session de recherche", + "data.mgmt.searchSessions.renameModal.title": "Modifier le nom de la session de recherche", + "data.mgmt.searchSessions.search.filterApp": "Application", + "data.mgmt.searchSessions.search.filterStatus": "Statut", + "data.mgmt.searchSessions.search.tools.refresh": "Actualiser", + "data.mgmt.searchSessions.status.expireDateUnknown": "inconnu", + "data.mgmt.searchSessions.status.expiresOn": "Expire le {expireDate}", + "data.mgmt.searchSessions.status.expiresSoonInDays": "Expire dans {numDays} jours", + "data.mgmt.searchSessions.status.expiresSoonInDaysTooltip": "{numDays} jours", + "data.mgmt.searchSessions.status.expiresSoonInHours": "Cette session expire dans {numHours} heures", + "data.mgmt.searchSessions.status.expiresSoonInHoursTooltip": "{numHours} heures", + "data.mgmt.searchSessions.status.label.cancelled": "Annulé", + "data.mgmt.searchSessions.status.label.complete": "Terminé", + "data.mgmt.searchSessions.status.label.error": "Erreur", + "data.mgmt.searchSessions.status.label.expired": "Expiré", + "data.mgmt.searchSessions.status.label.inProgress": "En cours", + "data.mgmt.searchSessions.status.message.cancelled": "Annulé par l'utilisateur", + "data.mgmt.searchSessions.status.message.createdOn": "Expire le {expireDate}", + "data.mgmt.searchSessions.status.message.error": "Erreur : {error}", + "data.mgmt.searchSessions.status.message.expiredOn": "Expiré le {expireDate}", + "data.mgmt.searchSessions.table.headerExpiration": "Expiration", + "data.mgmt.searchSessions.table.headerName": "Nom", + "data.mgmt.searchSessions.table.headerStarted": "Créé", + "data.mgmt.searchSessions.table.headerStatus": "Statut", + "data.mgmt.searchSessions.table.headerType": "Application", + "data.mgmt.searchSessions.table.notRestorableWarning": "La session de recherche va être de nouveau exécutée. Vous pouvez ensuite l'enregistrer pour une utilisation ultérieure.", + "data.mgmt.searchSessions.table.numSearches": "# recherches", + "data.mgmt.searchSessions.table.versionIncompatibleWarning": "Cette session de recherche a été créée dans une instance Kibana exécutant une version différente. Il se peut qu'elle ne soit pas correctement restaurée.", + "data.mgmt.searchSessions.table.mlAppName": "Machine Learning", + "data.search.statusError": "Recherche terminée avec un statut {errorCode}", + "data.search.statusThrow": "Le statut de la recherche a généré un statut d'erreur {message} ({errorCode})", + "data.searchSessionIndicator.cancelButtonText": "Arrêter la session", + "data.searchSessionIndicator.canceledDescriptionText": "Vous visualisez des données incomplètes", + "data.searchSessionIndicator.canceledIconAriaLabel": "La session de recherche s'est arrêtée", + "data.searchSessionIndicator.canceledTitleText": "La session de recherche s'est arrêtée", + "data.searchSessionIndicator.canceledTooltipText": "La session de recherche s'est arrêtée", + "data.searchSessionIndicator.canceledWhenText": "Arrêtée {when}", + "data.searchSessionIndicator.continueInBackgroundButtonText": "Enregistrer la session", + "data.searchSessionIndicator.disabledDueToDisabledGloballyMessage": "Vous ne disposez pas d'autorisations pour gérer les sessions de recherche", + "data.searchSessionIndicator.disabledDueToTimeoutMessage": "Les résultats de la session de recherche ont expiré.", + "data.searchSessionIndicator.loadingInTheBackgroundDescriptionText": "Vous pouvez retourner aux résultats terminés à partir de la page Gestion", + "data.searchSessionIndicator.loadingInTheBackgroundIconAriaLabel": "Session enregistrée en cours", + "data.searchSessionIndicator.loadingInTheBackgroundIconTooltipText": "Session enregistrée en cours", + "data.searchSessionIndicator.loadingInTheBackgroundTitleText": "Session enregistrée en cours", + "data.searchSessionIndicator.loadingInTheBackgroundWhenText": "Débuté {when}", + "data.searchSessionIndicator.loadingResultsDescription": "Enregistrer votre session, poursuivre votre travail et retourner aux résultats terminés", + "data.searchSessionIndicator.loadingResultsIconAriaLabel": "Chargement de la session de recherche", + "data.searchSessionIndicator.loadingResultsIconTooltipText": "Chargement de la session de recherche", + "data.searchSessionIndicator.loadingResultsTitle": "Votre recherche prend un certain temps…", + "data.searchSessionIndicator.loadingResultsWhenText": "Débuté {when}", + "data.searchSessionIndicator.restoredDescriptionText": "Vous affichez des données mises en cache d'une plage temporelle spécifique. La modification de la plage temporelle ou des filtres entraînera la réexécution de la session", + "data.searchSessionIndicator.restoredResultsIconAriaLabel": "Session enregistrée restaurée", + "data.searchSessionIndicator.restoredResultsTooltipText": "Session de recherche restaurée", + "data.searchSessionIndicator.restoredTitleText": "Session de recherche restaurée", + "data.searchSessionIndicator.restoredWhenText": "Terminé {when}", + "data.searchSessionIndicator.resultLoadedInTheBackgroundDescriptionText": "Vous pouvez retourner à ces résultats à partir de la page de gestion", + "data.searchSessionIndicator.resultLoadedInTheBackgroundIconAriaLabel": "Session enregistrée terminée", + "data.searchSessionIndicator.resultLoadedInTheBackgroundIconTooltipText": "Session enregistrée terminée", + "data.searchSessionIndicator.resultLoadedInTheBackgroundTitleText": "Session de recherche enregistrée", + "data.searchSessionIndicator.resultLoadedInTheBackgroundWhenText": "Terminé {when}", + "data.searchSessionIndicator.resultsLoadedDescriptionText": "Enregistrer votre session pour y revenir ultérieurement", + "data.searchSessionIndicator.resultsLoadedIconAriaLabel": "Session de recherche terminée", + "data.searchSessionIndicator.resultsLoadedIconTooltipText": "Session de recherche terminée", + "data.searchSessionIndicator.resultsLoadedText": "Session de recherche terminée", + "data.searchSessionIndicator.resultsLoadedWhenText": "Terminé {when}", + "data.searchSessionIndicator.saveButtonText": "Enregistrer la session", + "data.searchSessionIndicator.viewSearchSessionsLinkText": "Gérer les sessions", + "data.searchSessionName.ariaLabelText": "Nom de la session de recherche", + "data.searchSessionName.editAriaLabelText": "Modifier le nom de la session de recherche", + "data.searchSessionName.placeholderText": "Entrer un nom pour la session de recherche", + "data.searchSessionName.saveButtonText": "Enregistrer", + "data.sessions.management.flyoutText": "Configuration de cette session de recherche", + "data.sessions.management.flyoutTitle": "Inspecter la session de recherche", "dataViews.deprecations.scriptedFields.manualStepOneMessage": "Accédez à Gestion de la Suite > Kibana > Vues de données.", "dataViews.deprecations.scriptedFields.manualStepTwoMessage": "Mettez à jour les vues de données {numberOfIndexPatternsWithScriptedFields} qui ont des champs scriptés pour qu’elles utilisent des champs d’exécution. Dans la plupart des cas, pour migrer des scripts existants, vous devrez remplacer \"return ;\" par \"emit();\". Vues de données avec au moins un champ scripté : {allTitles}", "dataViews.deprecations.scriptedFieldsMessage": "Vous avez {numberOfIndexPatternsWithScriptedFields} vues de données ({titlesPreview}...) qui utilisent des champs scriptés. Les champs scriptés sont déclassés et seront supprimés à l’avenir. Utilisez plutôt des champs d’exécution.", @@ -2633,6 +2731,121 @@ "dataViews.unableWriteLabel": "Impossible d’écrire la vue de données ! Actualisez la page pour obtenir la dernière version de cette vue de données.", "devTools.badge.betaLabel": "Bêta", "devTools.badge.betaTooltipText": "Cette fonctionnalité pourra considérablement changer dans les futures versions", + "unifiedSearch.search.unableToGetSavedQueryToastTitle": "Impossible de charger la requête enregistrée {savedQueryId}", + "unifiedSearch.noDataPopover.content": "Cette plage temporelle ne contient pas de données. Étendez ou ajustez la plage temporelle pour obtenir plus de champs et pouvoir créer des graphiques.", + "unifiedSearch.noDataPopover.dismissAction": "Ne plus afficher", + "unifiedSearch.noDataPopover.subtitle": "Conseil", + "unifiedSearch.noDataPopover.title": "Ensemble de données vide", + "unifiedSearch.query.queryBar.clearInputLabel": "Effacer l'entrée", + "unifiedSearch.query.queryBar.comboboxAriaLabel": "Rechercher et filtrer la page {pageType}", + "unifiedSearch.query.queryBar.kqlFullLanguageName": "Langage de requête Kibana", + "unifiedSearch.query.queryBar.kqlLanguageName": "KQL", + "unifiedSearch.query.queryBar.KQLNestedQuerySyntaxInfoDocLinkText": "documents", + "unifiedSearch.query.queryBar.KQLNestedQuerySyntaxInfoOptOutText": "Ne plus afficher", + "unifiedSearch.query.queryBar.KQLNestedQuerySyntaxInfoText": "Il semblerait que votre requête porte sur un champ imbriqué. Selon le résultat visé, il existe plusieurs façons de construire une syntaxe KQL pour des requêtes imbriquées. Apprenez-en plus avec notre {link}.", + "unifiedSearch.query.queryBar.KQLNestedQuerySyntaxInfoTitle": "Syntaxe de requête imbriquée KQL", + "unifiedSearch.query.queryBar.kqlOffLabel": "Désactivé", + "unifiedSearch.query.queryBar.kqlOnLabel": "Activé", + "unifiedSearch.query.queryBar.languageSwitcher.toText": "Passer au langage de requête Kibana pour la recherche", + "unifiedSearch.query.queryBar.luceneLanguageName": "Lucene", + "unifiedSearch.query.queryBar.searchInputAriaLabel": "Commencer à taper pour rechercher et filtrer la page {pageType}", + "unifiedSearch.query.queryBar.searchInputPlaceholder": "Recherche", + "unifiedSearch.query.queryBar.syntaxOptionsDescription": "{docsLink} (KQL) offre une syntaxe de requête simplifiée et la prise en charge des champs scriptés. KQL offre également une fonctionnalité de saisie semi-automatique. Si vous désactivez KQL, {nonKqlModeHelpText}.", + "unifiedSearch.query.queryBar.syntaxOptionsDescription.nonKqlModeHelpText": "Kibana utilise Lucene.", + "unifiedSearch.search.searchBar.savedQueryDescriptionLabelText": "Description", + "unifiedSearch.search.searchBar.savedQueryDescriptionText": "Enregistrez le texte et les filtres de la requête que vous souhaitez réutiliser.", + "unifiedSearch.search.searchBar.savedQueryForm.titleConflictText": "Ce nom est en conflit avec une requête enregistrée existante.", + "unifiedSearch.search.searchBar.savedQueryFormCancelButtonText": "Annuler", + "unifiedSearch.search.searchBar.savedQueryFormSaveButtonText": "Enregistrer", + "unifiedSearch.search.searchBar.savedQueryFormTitle": "Enregistrer la requête", + "unifiedSearch.search.searchBar.savedQueryIncludeFiltersLabelText": "Inclure les filtres", + "unifiedSearch.search.searchBar.savedQueryIncludeTimeFilterLabelText": "Inclure le filtre temporel", + "unifiedSearch.search.searchBar.savedQueryNameHelpText": "Un nom est requis. Le nom ne peut pas contenir d'espace vide au début ou à la fin. Le nom doit être unique.", + "unifiedSearch.search.searchBar.savedQueryNameLabelText": "Nom", + "unifiedSearch.search.searchBar.savedQueryNoSavedQueriesText": "Aucune requête enregistrée.", + "unifiedSearch.search.searchBar.savedQueryPopoverButtonText": "Voir les requêtes enregistrées", + "unifiedSearch.search.searchBar.savedQueryPopoverClearButtonAriaLabel": "Effacer la requête enregistrée en cours", + "unifiedSearch.search.searchBar.savedQueryPopoverClearButtonText": "Effacer", + "unifiedSearch.search.searchBar.savedQueryPopoverConfirmDeletionCancelButtonText": "Annuler", + "unifiedSearch.search.searchBar.savedQueryPopoverConfirmDeletionConfirmButtonText": "Supprimer", + "unifiedSearch.search.searchBar.savedQueryPopoverConfirmDeletionTitle": "Supprimer \"{savedQueryName}\" ?", + "unifiedSearch.search.searchBar.savedQueryPopoverDeleteButtonAriaLabel": "Supprimer la requête enregistrée {savedQueryName}", + "unifiedSearch.search.searchBar.savedQueryPopoverSaveAsNewButtonAriaLabel": "Enregistrer en tant que nouvelle requête enregistrée", + "unifiedSearch.search.searchBar.savedQueryPopoverSaveAsNewButtonText": "Enregistrer en tant que nouvelle", + "unifiedSearch.search.searchBar.savedQueryPopoverSaveButtonAriaLabel": "Enregistrer une nouvelle requête enregistrée", + "unifiedSearch.search.searchBar.savedQueryPopoverSaveButtonText": "Enregistrer la requête en cours", + "unifiedSearch.search.searchBar.savedQueryPopoverSaveChangesButtonAriaLabel": "Enregistrer les modifications apportées à {title}", + "unifiedSearch.search.searchBar.savedQueryPopoverSaveChangesButtonText": "Enregistrer les modifications", + "unifiedSearch.search.searchBar.savedQueryPopoverSavedQueryListItemButtonAriaLabel": "Bouton de requête enregistrée {savedQueryName}", + "unifiedSearch.search.searchBar.savedQueryPopoverSavedQueryListItemDescriptionAriaLabel": "Description de {savedQueryName}", + "unifiedSearch.search.searchBar.savedQueryPopoverSavedQueryListItemSelectedButtonAriaLabel": "Bouton de requête enregistrée {savedQueryName} sélectionné. Appuyez pour effacer les modifications.", + "unifiedSearch.search.searchBar.savedQueryPopoverTitleText": "Requêtes enregistrées", + "unifiedSearch.query.queryBar.syntaxOptionsTitle": "Options de syntaxe", + "unifiedSearch.filter.applyFilterActionTitle": "Appliquer le filtre à la vue en cours", + "unifiedSearch.filter.applyFilters.popupHeader": "Sélectionner les filtres à appliquer", + "unifiedSearch.filter.applyFiltersPopup.cancelButtonLabel": "Annuler", + "unifiedSearch.filter.applyFiltersPopup.saveButtonLabel": "Appliquer", + "unifiedSearch.filter.filterBar.addFilterButtonLabel": "Ajouter un filtre", + "unifiedSearch.filter.filterBar.deleteFilterButtonLabel": "Supprimer", + "unifiedSearch.filter.filterBar.disabledFilterPrefix": "Désactivé", + "unifiedSearch.filter.filterBar.disableFilterButtonLabel": "Désactiver temporairement", + "unifiedSearch.filter.filterBar.editFilterButtonLabel": "Modifier le filtre", + "unifiedSearch.filter.filterBar.enableFilterButtonLabel": "Réactiver", + "unifiedSearch.filter.filterBar.excludeFilterButtonLabel": "Exclure les résultats", + "unifiedSearch.filter.filterBar.filterItemBadgeAriaLabel": "Actions de filtrage", + "unifiedSearch.filter.filterBar.filterItemBadgeIconAriaLabel": "Supprimer {filter}", + "unifiedSearch.filter.filterBar.includeFilterButtonLabel": "Inclure les résultats", + "unifiedSearch.filter.filterBar.indexPatternSelectPlaceholder": "Sélectionner un modèle d'indexation", + "unifiedSearch.filter.filterBar.labelErrorInfo": "Modèle d'indexation {indexPattern} introuvable", + "unifiedSearch.filter.filterBar.labelErrorText": "Erreur", + "unifiedSearch.filter.filterBar.labelWarningInfo": "Le champ {fieldName} n'existe pas dans la vue en cours.", + "unifiedSearch.filter.filterBar.labelWarningText": "Avertissement", + "unifiedSearch.filter.filterBar.moreFilterActionsMessage": "Filtre : {innerText}. Sélectionner pour plus d’actions de filtrage.", + "unifiedSearch.filter.filterBar.negatedFilterPrefix": "NON ", + "unifiedSearch.filter.filterBar.pinFilterButtonLabel": "Épingler dans toutes les applications", + "unifiedSearch.filter.filterBar.pinnedFilterPrefix": "Épinglé", + "unifiedSearch.filter.filterBar.unpinFilterButtonLabel": "Désépingler", + "unifiedSearch.filter.filterEditor.cancelButtonLabel": "Annuler", + "unifiedSearch.filter.filterEditor.createCustomLabelInputLabel": "Étiquette personnalisée", + "unifiedSearch.filter.filterEditor.createCustomLabelSwitchLabel": "Créer une étiquette personnalisée ?", + "unifiedSearch.filter.filterEditor.doesNotExistOperatorOptionLabel": "n'existe pas", + "unifiedSearch.filter.filterEditor.editFilterPopupTitle": "Modifier le filtre", + "unifiedSearch.filter.filterEditor.editFilterValuesButtonLabel": "Modifier les valeurs du filtre", + "unifiedSearch.filter.filterEditor.editQueryDslButtonLabel": "Modifier en tant que Query DSL", + "unifiedSearch.filter.filterEditor.existsOperatorOptionLabel": "existe", + "unifiedSearch.filter.filterEditor.falseOptionLabel": "false", + "unifiedSearch.filter.filterEditor.fieldSelectLabel": "Champ", + "unifiedSearch.filter.filterEditor.fieldSelectPlaceholder": "Sélectionner d'abord un champ", + "unifiedSearch.filter.filterEditor.indexPatternSelectLabel": "Modèle d'indexation", + "unifiedSearch.filter.filterEditor.isBetweenOperatorOptionLabel": "est entre", + "unifiedSearch.filter.filterEditor.isNotBetweenOperatorOptionLabel": "n'est pas entre", + "unifiedSearch.filter.filterEditor.isNotOneOfOperatorOptionLabel": "n'est pas l'une des options suivantes", + "unifiedSearch.filter.filterEditor.isNotOperatorOptionLabel": "n'est pas", + "unifiedSearch.filter.filterEditor.isOneOfOperatorOptionLabel": "est l'une des options suivantes", + "unifiedSearch.filter.filterEditor.isOperatorOptionLabel": "est", + "unifiedSearch.filter.filterEditor.operatorSelectLabel": "Opérateur", + "unifiedSearch.filter.filterEditor.operatorSelectPlaceholderSelect": "Sélectionner", + "unifiedSearch.filter.filterEditor.operatorSelectPlaceholderWaiting": "En attente", + "unifiedSearch.filter.filterEditor.queryDslLabel": "Query DSL d'Elasticsearch", + "unifiedSearch.filter.filterEditor.rangeEndInputPlaceholder": "Fin de la plage", + "unifiedSearch.filter.filterEditor.rangeInputLabel": "Plage", + "unifiedSearch.filter.filterEditor.rangeStartInputPlaceholder": "Début de la plage", + "unifiedSearch.filter.filterEditor.saveButtonLabel": "Enregistrer", + "unifiedSearch.filter.filterEditor.trueOptionLabel": "vrai", + "unifiedSearch.filter.filterEditor.valueInputLabel": "Valeur", + "unifiedSearch.filter.filterEditor.valueInputPlaceholder": "Saisir une valeur", + "unifiedSearch.filter.filterEditor.valueSelectPlaceholder": "Sélectionner une valeur", + "unifiedSearch.filter.filterEditor.valuesSelectLabel": "Valeurs", + "unifiedSearch.filter.filterEditor.valuesSelectPlaceholder": "Sélectionner des valeurs", + "unifiedSearch.filter.options.changeAllFiltersButtonLabel": "Changer tous les filtres", + "unifiedSearch.filter.options.deleteAllFiltersButtonLabel": "Tout supprimer", + "unifiedSearch.filter.options.disableAllFiltersButtonLabel": "Tout désactiver", + "unifiedSearch.filter.options.enableAllFiltersButtonLabel": "Tout activer", + "unifiedSearch.filter.options.invertDisabledFiltersButtonLabel": "Inverser l’activation/désactivation", + "unifiedSearch.filter.options.invertNegatedFiltersButtonLabel": "Inverser l'inclusion", + "unifiedSearch.filter.options.pinAllFiltersButtonLabel": "Tout épingler", + "unifiedSearch.filter.options.unpinAllFiltersButtonLabel": "Tout désépingler", + "unifiedSearch.filter.searchBar.changeAllFiltersTitle": "Changer tous les filtres", "devTools.badge.readOnly.text": "Lecture seule", "devTools.badge.readOnly.tooltip": "Enregistrement impossible", "devTools.breadcrumb.homeLabel": "Outils de développement", @@ -3365,11 +3578,11 @@ "expressionXY.axisTitlesVisibilityConfig.yLeft.help": "Spécifie si le titre de l'axe Y de gauche est visible ou non.", "expressionXY.axisTitlesVisibilityConfig.yRight.help": "Spécifie si le titre de l'axe Y de droite est visible ou non.", "expressionXY.dataLayer.accessors.help": "Les colonnes à afficher sur l’axe y.", - "expressionXY.dataLayer.columnToLabel.help": "Paires clé-valeur JSON de l’ID de colonne pour l’étiquette", + "expressionXY.layer.columnToLabel.help": "Paires clé-valeur JSON de l’ID de colonne pour l’étiquette", "expressionXY.dataLayer.help": "Configurer un calque dans le graphique xy", "expressionXY.dataLayer.hide.help": "Afficher/masquer l’axe", "expressionXY.dataLayer.isHistogram.help": "Disposer le graphique sous forme d’histogramme ou non", - "expressionXY.dataLayer.layerId.help": "ID du calque", + "expressionXY.layers.layerId.help": "ID du calque", "expressionXY.dataLayer.palette.help": "Palette", "expressionXY.dataLayer.seriesType.help": "Type de graphique à afficher.", "expressionXY.dataLayer.splitAccessor.help": "Colonne selon laquelle effectuer la division", @@ -3400,9 +3613,7 @@ "expressionXY.legendConfig.showSingleSeries.help": "Spécifie si une légende comportant une seule entrée doit être affichée", "expressionXY.legendConfig.verticalAlignment.help": "Spécifie l'alignement vertical de la légende lorsqu'elle est affichée à l'intérieur du graphique.", "expressionXY.referenceLineLayer.accessors.help": "Les colonnes à afficher sur l’axe y.", - "expressionXY.referenceLineLayer.columnToLabel.help": "Paires clé-valeur JSON de l’ID de colonne pour l’étiquette", "expressionXY.referenceLineLayer.help": "Configurer une ligne de référence dans le graphique xy", - "expressionXY.referenceLineLayer.layerId.help": "ID du calque", "expressionXY.referenceLineLayer.yConfig.help": "Configuration supplémentaire pour les axes y", "expressionXY.tickLabelsConfig.help": "Configurer l’aspect des étiquettes de coche du graphique xy", "expressionXY.tickLabelsConfig.x.help": "Spécifie si les étiquettes de graduation de l'axe X sont visibles ou non.", @@ -3433,7 +3644,7 @@ "expressionXY.xyVis.help": "Graphique X/Y", "expressionXY.xyVis.hideEndzones.help": "Masquer les marqueurs de zone de fin pour les données partielles", "expressionXY.xyVis.labelsOrientation.help": "Définit la rotation des étiquettes des axes", - "expressionXY.xyVis.layers.help": "Calques de série visuelle", + "expressionXY.layeredXyVis.layers.help": "Calques de série visuelle", "expressionXY.xyVis.legend.help": "Configurez la légende du graphique.", "expressionXY.xyVis.logDatatable.breakDown": "Répartir par", "expressionXY.xyVis.logDatatable.metric": "Axe vertical", @@ -7279,7 +7490,6 @@ "xpack.apm.filter.environment.allLabel": "Tous", "xpack.apm.filter.environment.label": "Environnement", "xpack.apm.filter.environment.notDefinedLabel": "Non défini", - "xpack.apm.filter.environment.selectEnvironmentLabel": "Sélectionner l'environnement", "xpack.apm.fleet_integration.settings.advancedOptionsLavel": "Options avancées", "xpack.apm.fleet_integration.settings.agentAuthorization.anonymousAllowAgentHelpText": "Noms d'agents autorisés pour l'accès anonyme.", "xpack.apm.fleet_integration.settings.agentAuthorization.anonymousAllowAgentLabel": "Agents autorisés", @@ -7506,7 +7716,6 @@ "xpack.apm.propertiesTable.tabs.metadataLabel": "Métadonnées", "xpack.apm.propertiesTable.tabs.timelineLabel": "Chronologie", "xpack.apm.searchInput.filter": "Filtrer…", - "xpack.apm.selectCustomOptionText": "Ajouter \\{searchValue\\} en tant que nouvelle option", "xpack.apm.selectPlaceholder": "Sélectionner une option :", "xpack.apm.serviceDependencies.breakdownChartTitle": "Temps consacré par dépendance", "xpack.apm.serviceDetails.dependenciesTabLabel": "Dépendances", @@ -10077,107 +10286,6 @@ "xpack.dashboard.drilldown.goToDashboard": "Accéder au tableau de bord", "xpack.dashboard.FlyoutCreateDrilldownAction.displayName": "Créer une recherche", "xpack.dashboard.panel.openFlyoutEditDrilldown.displayName": "Gérer les recherches", - "xpack.data.mgmt.searchSessions.actionDelete": "Supprimer", - "xpack.data.mgmt.searchSessions.actionExtend": "Étendre", - "xpack.data.mgmt.searchSessions.actionRename": "Modifier le nom", - "xpack.data.mgmt.searchSessions.actions.tooltip.moreActions": "Plus d'actions", - "xpack.data.mgmt.searchSessions.api.deleted": "La session de recherche a été supprimée.", - "xpack.data.mgmt.searchSessions.api.deletedError": "Impossible de supprimer la session de recherche !", - "xpack.data.mgmt.searchSessions.api.extended": "La session de recherche a été étendue.", - "xpack.data.mgmt.searchSessions.api.extendError": "Impossible d'étendre la session de recherche !", - "xpack.data.mgmt.searchSessions.api.fetchError": "Impossible d'actualiser la page !", - "xpack.data.mgmt.searchSessions.api.fetchTimeout": "La récupération des informations de la session de recherche a expiré après {timeout} secondes", - "xpack.data.mgmt.searchSessions.api.rename": "La session de recherche a été renommée", - "xpack.data.mgmt.searchSessions.api.renameError": "Impossible de renommer la session de recherche", - "xpack.data.mgmt.searchSessions.appTitle": "Sessions de recherche", - "xpack.data.mgmt.searchSessions.ariaLabel.moreActions": "Plus d'actions", - "xpack.data.mgmt.searchSessions.cancelModal.cancelButton": "Annuler", - "xpack.data.mgmt.searchSessions.cancelModal.deleteButton": "Supprimer", - "xpack.data.mgmt.searchSessions.cancelModal.message": "La suppression de la session de recherche \"{name}\" supprime tous les résultats mis en cache.", - "xpack.data.mgmt.searchSessions.cancelModal.title": "Supprimer la session de recherche", - "xpack.data.mgmt.searchSessions.extendModal.dontExtendButton": "Annuler", - "xpack.data.mgmt.searchSessions.extendModal.extendButton": "Étendre l'expiration", - "xpack.data.mgmt.searchSessions.extendModal.extendMessage": "L'expiration de la session de recherche \"{name}\" sera étendue jusqu'à {newExpires}.", - "xpack.data.mgmt.searchSessions.extendModal.title": "Étendre l'expiration de la session de recherche", - "xpack.data.mgmt.searchSessions.flyoutTitle": "Inspecter", - "xpack.data.mgmt.searchSessions.main.backgroundSessionsDocsLinkText": "Documentation", - "xpack.data.mgmt.searchSessions.main.sectionDescription": "Gérez vos sessions de recherche enregistrées.", - "xpack.data.mgmt.searchSessions.main.sectionTitle": "Sessions de recherche", - "xpack.data.mgmt.searchSessions.renameModal.cancelButton": "Annuler", - "xpack.data.mgmt.searchSessions.renameModal.renameButton": "Enregistrer", - "xpack.data.mgmt.searchSessions.renameModal.searchSessionNameInputLabel": "Nom de la session de recherche", - "xpack.data.mgmt.searchSessions.renameModal.title": "Modifier le nom de la session de recherche", - "xpack.data.mgmt.searchSessions.search.filterApp": "Application", - "xpack.data.mgmt.searchSessions.search.filterStatus": "Statut", - "xpack.data.mgmt.searchSessions.search.tools.refresh": "Actualiser", - "xpack.data.mgmt.searchSessions.status.expireDateUnknown": "inconnu", - "xpack.data.mgmt.searchSessions.status.expiresOn": "Expire le {expireDate}", - "xpack.data.mgmt.searchSessions.status.expiresSoonInDays": "Expire dans {numDays} jours", - "xpack.data.mgmt.searchSessions.status.expiresSoonInDaysTooltip": "{numDays} jours", - "xpack.data.mgmt.searchSessions.status.expiresSoonInHours": "Cette session expire dans {numHours} heures", - "xpack.data.mgmt.searchSessions.status.expiresSoonInHoursTooltip": "{numHours} heures", - "xpack.data.mgmt.searchSessions.status.label.cancelled": "Annulé", - "xpack.data.mgmt.searchSessions.status.label.complete": "Terminé", - "xpack.data.mgmt.searchSessions.status.label.error": "Erreur", - "xpack.data.mgmt.searchSessions.status.label.expired": "Expiré", - "xpack.data.mgmt.searchSessions.status.label.inProgress": "En cours", - "xpack.data.mgmt.searchSessions.status.message.cancelled": "Annulé par l'utilisateur", - "xpack.data.mgmt.searchSessions.status.message.createdOn": "Expire le {expireDate}", - "xpack.data.mgmt.searchSessions.status.message.error": "Erreur : {error}", - "xpack.data.mgmt.searchSessions.status.message.expiredOn": "Expiré le {expireDate}", - "xpack.data.mgmt.searchSessions.table.headerExpiration": "Expiration", - "xpack.data.mgmt.searchSessions.table.headerName": "Nom", - "xpack.data.mgmt.searchSessions.table.headerStarted": "Créé", - "xpack.data.mgmt.searchSessions.table.headerStatus": "Statut", - "xpack.data.mgmt.searchSessions.table.headerType": "Application", - "xpack.data.mgmt.searchSessions.table.mlAppName": "Machine Learning", - "xpack.data.mgmt.searchSessions.table.notRestorableWarning": "La session de recherche va être de nouveau exécutée. Vous pouvez ensuite l'enregistrer pour une utilisation ultérieure.", - "xpack.data.mgmt.searchSessions.table.numSearches": "# recherches", - "xpack.data.mgmt.searchSessions.table.versionIncompatibleWarning": "Cette session de recherche a été créée dans une instance Kibana exécutant une version différente. Il se peut qu'elle ne soit pas correctement restaurée.", - "xpack.data.search.statusError": "Recherche terminée avec un statut {errorCode}", - "xpack.data.search.statusThrow": "Le statut de la recherche a généré un statut d'erreur {message} ({errorCode})", - "xpack.data.searchSessionIndicator.cancelButtonText": "Arrêter la session", - "xpack.data.searchSessionIndicator.canceledDescriptionText": "Vous visualisez des données incomplètes", - "xpack.data.searchSessionIndicator.canceledIconAriaLabel": "La session de recherche s'est arrêtée", - "xpack.data.searchSessionIndicator.canceledTitleText": "La session de recherche s'est arrêtée", - "xpack.data.searchSessionIndicator.canceledTooltipText": "La session de recherche s'est arrêtée", - "xpack.data.searchSessionIndicator.canceledWhenText": "Arrêtée {when}", - "xpack.data.searchSessionIndicator.continueInBackgroundButtonText": "Enregistrer la session", - "xpack.data.searchSessionIndicator.disabledDueToDisabledGloballyMessage": "Vous ne disposez pas d'autorisations pour gérer les sessions de recherche", - "xpack.data.searchSessionIndicator.disabledDueToTimeoutMessage": "Les résultats de la session de recherche ont expiré.", - "xpack.data.searchSessionIndicator.loadingInTheBackgroundDescriptionText": "Vous pouvez retourner aux résultats terminés à partir de la page Gestion", - "xpack.data.searchSessionIndicator.loadingInTheBackgroundIconAriaLabel": "Session enregistrée en cours", - "xpack.data.searchSessionIndicator.loadingInTheBackgroundIconTooltipText": "Session enregistrée en cours", - "xpack.data.searchSessionIndicator.loadingInTheBackgroundTitleText": "Session enregistrée en cours", - "xpack.data.searchSessionIndicator.loadingInTheBackgroundWhenText": "Débuté {when}", - "xpack.data.searchSessionIndicator.loadingResultsDescription": "Enregistrer votre session, poursuivre votre travail et retourner aux résultats terminés", - "xpack.data.searchSessionIndicator.loadingResultsIconAriaLabel": "Chargement de la session de recherche", - "xpack.data.searchSessionIndicator.loadingResultsIconTooltipText": "Chargement de la session de recherche", - "xpack.data.searchSessionIndicator.loadingResultsTitle": "Votre recherche prend un certain temps…", - "xpack.data.searchSessionIndicator.loadingResultsWhenText": "Débuté {when}", - "xpack.data.searchSessionIndicator.restoredDescriptionText": "Vous affichez des données mises en cache d'une plage temporelle spécifique. La modification de la plage temporelle ou des filtres entraînera la réexécution de la session", - "xpack.data.searchSessionIndicator.restoredResultsIconAriaLabel": "Session enregistrée restaurée", - "xpack.data.searchSessionIndicator.restoredResultsTooltipText": "Session de recherche restaurée", - "xpack.data.searchSessionIndicator.restoredTitleText": "Session de recherche restaurée", - "xpack.data.searchSessionIndicator.restoredWhenText": "Terminé {when}", - "xpack.data.searchSessionIndicator.resultLoadedInTheBackgroundDescriptionText": "Vous pouvez retourner à ces résultats à partir de la page de gestion", - "xpack.data.searchSessionIndicator.resultLoadedInTheBackgroundIconAriaLabel": "Session enregistrée terminée", - "xpack.data.searchSessionIndicator.resultLoadedInTheBackgroundIconTooltipText": "Session enregistrée terminée", - "xpack.data.searchSessionIndicator.resultLoadedInTheBackgroundTitleText": "Session de recherche enregistrée", - "xpack.data.searchSessionIndicator.resultLoadedInTheBackgroundWhenText": "Terminé {when}", - "xpack.data.searchSessionIndicator.resultsLoadedDescriptionText": "Enregistrer votre session pour y revenir ultérieurement", - "xpack.data.searchSessionIndicator.resultsLoadedIconAriaLabel": "Session de recherche terminée", - "xpack.data.searchSessionIndicator.resultsLoadedIconTooltipText": "Session de recherche terminée", - "xpack.data.searchSessionIndicator.resultsLoadedText": "Session de recherche terminée", - "xpack.data.searchSessionIndicator.resultsLoadedWhenText": "Terminé {when}", - "xpack.data.searchSessionIndicator.saveButtonText": "Enregistrer la session", - "xpack.data.searchSessionIndicator.viewSearchSessionsLinkText": "Gérer les sessions", - "xpack.data.searchSessionName.ariaLabelText": "Nom de la session de recherche", - "xpack.data.searchSessionName.editAriaLabelText": "Modifier le nom de la session de recherche", - "xpack.data.searchSessionName.placeholderText": "Entrer un nom pour la session de recherche", - "xpack.data.searchSessionName.saveButtonText": "Enregistrer", - "xpack.data.sessions.management.flyoutText": "Configuration de cette session de recherche", - "xpack.data.sessions.management.flyoutTitle": "Inspecter la session de recherche", "xpack.dataVisualizer.addCombinedFieldsLabel": "Ajouter un champ combiné", "xpack.dataVisualizer.choroplethMap.topValuesCount": "Compte des valeurs les plus élevées pour {fieldName}", "xpack.dataVisualizer.chrome.help.appName": "Data Visualizer (Visualiseur de données)", @@ -11812,7 +11920,6 @@ "xpack.enterpriseSearch.workplaceSearch.groups.newGroup.action": "Gérer le groupe", "xpack.enterpriseSearch.workplaceSearch.groups.newGroupSavedSuccess": "{groupName} créé avec succès", "xpack.enterpriseSearch.workplaceSearch.groups.noSourcesMessage": "Aucune source de contenu organisationnelle", - "xpack.enterpriseSearch.workplaceSearch.groups.noUsersMessage": "Aucun utilisateur", "xpack.enterpriseSearch.workplaceSearch.groups.overview.confirmRemoveButtonText": "Supprimer {name}", "xpack.enterpriseSearch.workplaceSearch.groups.overview.confirmRemoveDescription": "Votre groupe sera supprimé de Workplace Search. Voulez-vous vraiment supprimer {name} ?", "xpack.enterpriseSearch.workplaceSearch.groups.overview.confirmTitleText": "Confirmer", @@ -21658,12 +21765,6 @@ "xpack.observability.noDataConfig.beatsCard.title": "Ajouter des intégrations", "xpack.observability.noDataConfig.solutionName": "Observabilité", "xpack.observability.notAvailable": "S. O.", - "xpack.observability.overview.alert.allTypes": "Tous les types", - "xpack.observability.overview.alert.appLink": "Afficher toutes les alertes", - "xpack.observability.overview.alert.errorMessage": "Une erreur s’est produite lors du chargement des données d’alerte. Réessayez plus tard.", - "xpack.observability.overview.alert.errorTitle": "Impossible de charger les données d’alerte.", - "xpack.observability.overview.alerts.appLink": "Afficher les alertes", - "xpack.observability.overview.alerts.muted": "Muet", "xpack.observability.overview.alerts.title": "Alertes", "xpack.observability.overview.apm.appLink": "Afficher l’inventaire des services", "xpack.observability.overview.apm.services": "Services", @@ -21971,9 +22072,6 @@ "xpack.osquery.liveQueryDetails.viewLiveQueriesHistoryTitle": "Afficher l'historique des recherches en direct", "xpack.osquery.liveQueryForm.form.saveForLaterButtonLabel": "Enregistrer pour plus tard", "xpack.osquery.liveQueryForm.form.submitButtonLabel": "Envoyer", - "xpack.osquery.liveQueryForm.steps.agentsStepHeading": "Sélectionner les agents", - "xpack.osquery.liveQueryForm.steps.queryStepHeading": "Entrer la recherche", - "xpack.osquery.liveQueryForm.steps.resultsStepHeading": "Vérifier les résultats", "xpack.osquery.liveQueryResults.table.agentColumnTitle": "agent", "xpack.osquery.liveQueryResults.table.fieldMappedLabel": "Le champ est mappé à", "xpack.osquery.newLiveQuery.pageTitle": "Nouvelle recherche en direct", diff --git a/x-pack/plugins/translations/translations/ja-JP.json b/x-pack/plugins/translations/translations/ja-JP.json index a5432066aa7ce..9c22df3fdabb2 100644 --- a/x-pack/plugins/translations/translations/ja-JP.json +++ b/x-pack/plugins/translations/translations/ja-JP.json @@ -442,7 +442,6 @@ "xpack.lens.indexPattern.dateHistogram.autoAdvancedExplanation": "間隔は次のロジックに従います。", "xpack.lens.indexPattern.dateHistogram.autoBasicExplanation": "自動日付ヒストグラムは、間隔でデータフィールドをバケットに分割します。", "xpack.lens.indexPattern.dateHistogram.autoBoundHeader": "対象間隔の測定", - "xpack.lens.indexPattern.dateHistogram.autoHelpText": "仕組み", "xpack.lens.indexPattern.dateHistogram.autoInterval": "時間範囲のカスタマイズ", "xpack.lens.indexPattern.dateHistogram.autoIntervalHeader": "使用される間隔", "xpack.lens.indexPattern.dateHistogram.autoLongerExplanation": "間隔を選択するには、Lensは指定された時間範囲を{targetBarSetting}設定で除算します。Lensはデータに最適な間隔を計算します。たとえば、30分、1時間、12です。棒の最大数は{maxBarSetting}値で設定します。", @@ -575,7 +574,6 @@ "xpack.lens.indexPattern.moving_average.signature": "メトリック：数値、[window]：数値", "xpack.lens.indexPattern.movingAverage": "移動平均", "xpack.lens.indexPattern.movingAverage.basicExplanation": "移動平均はデータ全体でウィンドウをスライドし、平均値を表示します。移動平均は日付ヒストグラムでのみサポートされています。", - "xpack.lens.indexPattern.movingAverage.helpText": "仕組み", "xpack.lens.indexPattern.movingAverage.limitations": "最初の移動平均値は2番目の項目から開始します。", "xpack.lens.indexPattern.movingAverage.longerExplanation": "移動平均を計算するには、Lensはウィンドウの平均値を使用し、ギャップのスキップポリシーを適用します。 見つからない値がある場合、バケットがスキップされます。次の値に対して計算が実行されます。", "xpack.lens.indexPattern.movingAverage.tableExplanation": "たとえば、データ[1, 2, 3, 4, 5, 6, 7, 8, 9, 10]がある場合、ウィンドウサイズ5でシンプルな移動平均を計算できます。", @@ -1012,7 +1010,6 @@ "xpack.lens.xyChart.verticalRightAxisLabel": "縦右軸", "xpack.lens.xySuggestions.asPercentageTitle": "割合（%）", "xpack.lens.xySuggestions.barChartTitle": "棒グラフ", - "xpack.lens.xySuggestions.dateSuggestion": "{xTitle}の上の {yTitle}", "xpack.lens.xySuggestions.emptyAxisTitle": "（空）", "xpack.lens.xySuggestions.flipTitle": "反転", "xpack.lens.xySuggestions.lineChartTitle": "折れ線グラフ", @@ -2719,6 +2716,110 @@ "dataViews.deprecations.scriptedFields.manualStepTwoMessage": "ランタイムフィールドを使用するには、スクリプト化されたフィールドがある{numberOfIndexPatternsWithScriptedFields}データビューを更新します。ほとんどの場合、既存のスクリプトを移行するには、「return ;」から「emit();」に変更する必要があります。1つ以上のスクリプト化されたフィールドがあるデータビュー：{allTitles}", "dataViews.deprecations.scriptedFieldsMessage": "スクリプト化されたフィールドを使用する{numberOfIndexPatternsWithScriptedFields}データビュー（{titlesPreview}...）があります。スクリプト化されたフィールドは廃止予定であり、今後は削除されます。ランタイムフィールドを使用してください。", "dataViews.deprecations.scriptedFieldsTitle": "スクリプト化されたフィールドを使用しているデータビューが見つかりました。", + "data.mgmt.searchSessions.actionDelete": "削除", + "data.mgmt.searchSessions.actionExtend": "延長", + "data.mgmt.searchSessions.actionRename": "名前を編集", + "data.mgmt.searchSessions.actions.tooltip.moreActions": "さらにアクションを表示", + "data.mgmt.searchSessions.api.deleted": "検索セッションが削除されました。", + "data.mgmt.searchSessions.api.deletedError": "検索セッションを削除できませんでした。", + "data.mgmt.searchSessions.api.extended": "検索セッションが延長されました。", + "data.mgmt.searchSessions.api.extendError": "検索セッションを延長できませんでした。", + "data.mgmt.searchSessions.api.fetchError": "ページを更新できませんでした。", + "data.mgmt.searchSessions.api.fetchTimeout": "{timeout}秒後に検索セッション情報の取得がタイムアウトしました", + "data.mgmt.searchSessions.api.rename": "検索セッション名が変更されました", + "data.mgmt.searchSessions.api.renameError": "検索セッション名を変更できませんでした", + "data.mgmt.searchSessions.appTitle": "検索セッション", + "data.mgmt.searchSessions.ariaLabel.moreActions": "さらにアクションを表示", + "data.mgmt.searchSessions.cancelModal.cancelButton": "キャンセル", + "data.mgmt.searchSessions.cancelModal.deleteButton": "削除", + "data.mgmt.searchSessions.cancelModal.message": "検索セッション'{name}'を削除すると、キャッシュに保存されているすべての結果が削除されます。", + "data.mgmt.searchSessions.cancelModal.title": "検索セッションの削除", + "data.mgmt.searchSessions.extendModal.dontExtendButton": "キャンセル", + "data.mgmt.searchSessions.extendModal.extendButton": "有効期限を延長", + "data.mgmt.searchSessions.extendModal.extendMessage": "検索セッション'{name}'の有効期限が{newExpires}まで延長されます。", + "data.mgmt.searchSessions.extendModal.title": "検索セッションの有効期限を延長", + "data.mgmt.searchSessions.flyoutTitle": "検査", + "data.mgmt.searchSessions.main.backgroundSessionsDocsLinkText": "ドキュメント", + "data.mgmt.searchSessions.main.sectionDescription": "保存された検索セッションを管理します。", + "data.mgmt.searchSessions.main.sectionTitle": "検索セッション", + "data.mgmt.searchSessions.renameModal.cancelButton": "キャンセル", + "data.mgmt.searchSessions.renameModal.renameButton": "保存", + "data.mgmt.searchSessions.renameModal.searchSessionNameInputLabel": "検索セッション名", + "data.mgmt.searchSessions.renameModal.title": "検索セッション名を編集", + "data.mgmt.searchSessions.search.filterApp": "アプリ", + "data.mgmt.searchSessions.search.filterStatus": "ステータス", + "data.mgmt.searchSessions.search.tools.refresh": "更新", + "data.mgmt.searchSessions.status.expireDateUnknown": "不明", + "data.mgmt.searchSessions.status.expiresOn": "有効期限：{expireDate}", + "data.mgmt.searchSessions.status.expiresSoonInDays": "{numDays}日後に期限切れ", + "data.mgmt.searchSessions.status.expiresSoonInDaysTooltip": "{numDays}日", + "data.mgmt.searchSessions.status.expiresSoonInHours": "このセッションは{numHours}時間後に期限切れになります", + "data.mgmt.searchSessions.status.expiresSoonInHoursTooltip": "{numHours}時間", + "data.mgmt.searchSessions.status.label.cancelled": "キャンセル済み", + "data.mgmt.searchSessions.status.label.complete": "完了", + "data.mgmt.searchSessions.status.label.error": "エラー", + "data.mgmt.searchSessions.status.label.expired": "期限切れ", + "data.mgmt.searchSessions.status.label.inProgress": "進行中", + "data.mgmt.searchSessions.status.message.cancelled": "ユーザーがキャンセル", + "data.mgmt.searchSessions.status.message.createdOn": "有効期限：{expireDate}", + "data.mgmt.searchSessions.status.message.error": "エラー：{error}", + "data.mgmt.searchSessions.status.message.expiredOn": "有効期限：{expireDate}", + "data.mgmt.searchSessions.table.headerExpiration": "有効期限", + "data.mgmt.searchSessions.table.headerName": "名前", + "data.mgmt.searchSessions.table.headerStarted": "作成済み", + "data.mgmt.searchSessions.table.headerStatus": "ステータス", + "data.mgmt.searchSessions.table.headerType": "アプリ", + "data.mgmt.searchSessions.table.notRestorableWarning": "検索セッションはもう一度実行されます。今後使用するために保存できます。", + "data.mgmt.searchSessions.table.numSearches": "# 検索", + "data.mgmt.searchSessions.table.versionIncompatibleWarning": "この検索は別のバージョンを実行しているKibanaインスタンスで作成されました。正常に復元されない可能性があります。", + "data.search.statusError": "検索は{errorCode}ステータスで完了しました", + "data.search.statusThrow": "検索ステータスはエラー{message}（{errorCode}）ステータスを返しました", + "data.searchSessionIndicator.cancelButtonText": "セッションの停止", + "data.searchSessionIndicator.canceledDescriptionText": "不完全なデータを表示しています。", + "data.searchSessionIndicator.canceledIconAriaLabel": "検索セッションが停止しました", + "data.searchSessionIndicator.canceledTitleText": "検索セッションが停止しました", + "data.searchSessionIndicator.canceledTooltipText": "検索セッションが停止しました", + "data.searchSessionIndicator.canceledWhenText": "停止：{when}", + "data.searchSessionIndicator.continueInBackgroundButtonText": "セッションの保存", + "data.searchSessionIndicator.disabledDueToDisabledGloballyMessage": "検索セッションを管理するアクセス権がありません", + "data.searchSessionIndicator.disabledDueToTimeoutMessage": "検索セッション結果が期限切れです。", + "data.searchSessionIndicator.loadingInTheBackgroundDescriptionText": "管理から完了した結果に戻ることができます。", + "data.searchSessionIndicator.loadingInTheBackgroundIconAriaLabel": "保存されたセッションを実行中です", + "data.searchSessionIndicator.loadingInTheBackgroundIconTooltipText": "保存されたセッションを実行中です", + "data.searchSessionIndicator.loadingInTheBackgroundTitleText": "保存されたセッションを実行中です", + "data.searchSessionIndicator.loadingInTheBackgroundWhenText": "開始：{when}", + "data.searchSessionIndicator.loadingResultsDescription": "セッションを保存して作業を続け、完了した結果に戻ってください。", + "data.searchSessionIndicator.loadingResultsIconAriaLabel": "検索セッションを読み込んでいます", + "data.searchSessionIndicator.loadingResultsIconTooltipText": "検索セッションを読み込んでいます", + "data.searchSessionIndicator.loadingResultsTitle": "検索に少し時間がかかっています...", + "data.searchSessionIndicator.loadingResultsWhenText": "開始：{when}", + "data.searchSessionIndicator.restoredDescriptionText": "特定の時間範囲からキャッシュに保存されたデータを表示しています。時間範囲またはフィルターを変更すると、セッションが再実行されます。", + "data.searchSessionIndicator.restoredResultsIconAriaLabel": "保存されたセッションが復元されました", + "data.searchSessionIndicator.restoredResultsTooltipText": "検索セッションが復元されました", + "data.searchSessionIndicator.restoredTitleText": "検索セッションが復元されました", + "data.searchSessionIndicator.restoredWhenText": "完了：{when}", + "data.searchSessionIndicator.resultLoadedInTheBackgroundDescriptionText": "管理からこれらの結果に戻ることができます。", + "data.searchSessionIndicator.resultLoadedInTheBackgroundIconAriaLabel": "保存されたセッションが完了しました", + "data.searchSessionIndicator.resultLoadedInTheBackgroundIconTooltipText": "保存されたセッションが完了しました", + "data.searchSessionIndicator.resultLoadedInTheBackgroundTitleText": "検索セッションが保存されました", + "data.searchSessionIndicator.resultLoadedInTheBackgroundWhenText": "完了：{when}", + "data.searchSessionIndicator.resultsLoadedDescriptionText": "セッションを保存して、後から戻ります。", + "data.searchSessionIndicator.resultsLoadedIconAriaLabel": "検索セッションが完了しました", + "data.searchSessionIndicator.resultsLoadedIconTooltipText": "検索セッションが完了しました", + "data.searchSessionIndicator.resultsLoadedText": "検索セッションが完了しました", + "data.searchSessionIndicator.resultsLoadedWhenText": "完了：{when}", + "data.searchSessionIndicator.saveButtonText": "セッションの保存", + "data.searchSessionIndicator.viewSearchSessionsLinkText": "セッションの管理", + "data.searchSessionName.ariaLabelText": "検索セッション名", + "data.searchSessionName.editAriaLabelText": "検索セッション名を編集", + "data.searchSessionName.placeholderText": "検索セッションの名前を入力", + "data.searchSessionName.saveButtonText": "保存", + "data.sessions.management.flyoutText": "この検索セッションの構成", + "data.sessions.management.flyoutTitle": "検索セッションの検査", + "dataViews.deprecations.scriptedFields.manualStepOneMessage": "［スタック管理］>［Kibana］>［インデックスパターン］に移動します。", + "dataViews.deprecations.scriptedFields.manualStepTwoMessage": "ランタイムフィールドを使用するには、スクリプト化されたフィールドがある{numberOfIndexPatternsWithScriptedFields}インデックスパターンを更新します。ほとんどの場合、既存のスクリプトを移行するには、「return ;」から「emit();」に変更する必要があります。1つ以上のスクリプト化されたフィールドがあるインデックスパターン：{allTitles}", + "dataViews.deprecations.scriptedFieldsMessage": "スクリプト化されたフィールドを使用する{numberOfIndexPatternsWithScriptedFields}インデックスパターン（{titlesPreview}...）があります。スクリプト化されたフィールドは廃止予定であり、今後は削除されます。ランタイムフィールドを使用してください。", + "dataViews.deprecations.scriptedFieldsTitle": "スクリプト化されたフィールドを使用しているインデックスパターンが見つかりました", "dataViews.ensureDefaultIndexPattern.bannerLabel": "Kibanaでデータの可視化と閲覧を行うには、Elasticsearchからデータを取得するためのインデックスパターンの作成が必要です。", "dataViews.fetchFieldErrorTitle": "データビューのフィールド取得中にエラーが発生 {title}（ID：{id}）", "dataViews.functions.dataViewLoad.help": "データビューを読み込みます", @@ -3463,11 +3564,11 @@ "expressionXY.axisTitlesVisibilityConfig.yLeft.help": "左y軸のタイトルを表示するかどうかを指定します。", "expressionXY.axisTitlesVisibilityConfig.yRight.help": "右y軸のタイトルを表示するかどうかを指定します。", "expressionXY.dataLayer.accessors.help": "y軸に表示する列。", - "expressionXY.dataLayer.columnToLabel.help": "ラベリングする列IDのJSONキー値のペア", + "expressionXY.layer.columnToLabel.help": "ラベリングする列IDのJSONキー値のペア", "expressionXY.dataLayer.help": "xyグラフでレイヤーを構成", "expressionXY.dataLayer.hide.help": "軸を表示/非表示", "expressionXY.dataLayer.isHistogram.help": "グラフをヒストグラムとしてレイアウトするかどうか", - "expressionXY.dataLayer.layerId.help": "レイヤーID", + "expressionXY.layers.layerId.help": "レイヤーID", "expressionXY.dataLayer.palette.help": "パレット", "expressionXY.dataLayer.seriesType.help": "表示するグラフのタイプ。", "expressionXY.dataLayer.splitAccessor.help": "分割の基準となる列", @@ -3498,9 +3599,7 @@ "expressionXY.legendConfig.showSingleSeries.help": "エントリが1件の凡例を表示するかどうかを指定します", "expressionXY.legendConfig.verticalAlignment.help": "凡例がグラフ内に表示されるときに凡例の縦の配置を指定します。", "expressionXY.referenceLineLayer.accessors.help": "y軸に表示する列。", - "expressionXY.referenceLineLayer.columnToLabel.help": "ラベリングする列IDのJSONキー値のペア", "expressionXY.referenceLineLayer.help": "xyグラフで基準線を構成", - "expressionXY.referenceLineLayer.layerId.help": "レイヤーID", "expressionXY.referenceLineLayer.yConfig.help": "y軸の詳細構成", "expressionXY.tickLabelsConfig.help": "xyグラフのティックラベルの表示を構成", "expressionXY.tickLabelsConfig.x.help": "x軸の目盛ラベルを表示するかどうかを指定します。", @@ -3531,7 +3630,7 @@ "expressionXY.xyVis.help": "X/Y チャート", "expressionXY.xyVis.hideEndzones.help": "部分データの終了ゾーンマーカーを非表示", "expressionXY.xyVis.labelsOrientation.help": "軸ラベルの回転を定義します", - "expressionXY.xyVis.layers.help": "視覚的な系列のレイヤー", + "expressionXY.layeredXyVis.layers.help": "視覚的な系列のレイヤー", "expressionXY.xyVis.legend.help": "チャートの凡例を構成します。", "expressionXY.xyVis.logDatatable.breakDown": "内訳の基準", "expressionXY.xyVis.logDatatable.metric": "縦軸", @@ -7379,7 +7478,6 @@ "xpack.apm.filter.environment.allLabel": "すべて", "xpack.apm.filter.environment.label": "環境", "xpack.apm.filter.environment.notDefinedLabel": "未定義", - "xpack.apm.filter.environment.selectEnvironmentLabel": "環境を選択", "xpack.apm.fleet_integration.settings.advancedOptionsLavel": "高度なオプション", "xpack.apm.fleet_integration.settings.agentAuthorization.anonymousAllowAgentHelpText": "匿名アクセスの許可されたエージェント名。", "xpack.apm.fleet_integration.settings.agentAuthorization.anonymousAllowAgentLabel": "許可されたエージェント", @@ -7604,7 +7702,6 @@ "xpack.apm.propertiesTable.tabs.metadataLabel": "メタデータ", "xpack.apm.propertiesTable.tabs.timelineLabel": "Timeline", "xpack.apm.searchInput.filter": "フィルター...", - "xpack.apm.selectCustomOptionText": "\\{searchValue\\}を新しいオプションとして追加", "xpack.apm.selectPlaceholder": "オプションを選択：", "xpack.apm.serviceDependencies.breakdownChartTitle": "依存関係にかかった時間", "xpack.apm.serviceDetails.dependenciesTabLabel": "依存関係", @@ -10189,107 +10286,6 @@ "xpack.dashboard.drilldown.goToDashboard": "ダッシュボードに移動", "xpack.dashboard.FlyoutCreateDrilldownAction.displayName": "ドリルダウンを作成", "xpack.dashboard.panel.openFlyoutEditDrilldown.displayName": "ドリルダウンを管理", - "xpack.data.mgmt.searchSessions.actionDelete": "削除", - "xpack.data.mgmt.searchSessions.actionExtend": "延長", - "xpack.data.mgmt.searchSessions.actionRename": "名前を編集", - "xpack.data.mgmt.searchSessions.actions.tooltip.moreActions": "さらにアクションを表示", - "xpack.data.mgmt.searchSessions.api.deleted": "検索セッションが削除されました。", - "xpack.data.mgmt.searchSessions.api.deletedError": "検索セッションを削除できませんでした。", - "xpack.data.mgmt.searchSessions.api.extended": "検索セッションが延長されました。", - "xpack.data.mgmt.searchSessions.api.extendError": "検索セッションを延長できませんでした。", - "xpack.data.mgmt.searchSessions.api.fetchError": "ページを更新できませんでした。", - "xpack.data.mgmt.searchSessions.api.fetchTimeout": "{timeout}秒後に検索セッション情報の取得がタイムアウトしました", - "xpack.data.mgmt.searchSessions.api.rename": "検索セッション名が変更されました", - "xpack.data.mgmt.searchSessions.api.renameError": "検索セッション名を変更できませんでした", - "xpack.data.mgmt.searchSessions.appTitle": "検索セッション", - "xpack.data.mgmt.searchSessions.ariaLabel.moreActions": "さらにアクションを表示", - "xpack.data.mgmt.searchSessions.cancelModal.cancelButton": "キャンセル", - "xpack.data.mgmt.searchSessions.cancelModal.deleteButton": "削除", - "xpack.data.mgmt.searchSessions.cancelModal.message": "検索セッション'{name}'を削除すると、キャッシュに保存されているすべての結果が削除されます。", - "xpack.data.mgmt.searchSessions.cancelModal.title": "検索セッションの削除", - "xpack.data.mgmt.searchSessions.extendModal.dontExtendButton": "キャンセル", - "xpack.data.mgmt.searchSessions.extendModal.extendButton": "有効期限を延長", - "xpack.data.mgmt.searchSessions.extendModal.extendMessage": "検索セッション'{name}'の有効期限が{newExpires}まで延長されます。", - "xpack.data.mgmt.searchSessions.extendModal.title": "検索セッションの有効期限を延長", - "xpack.data.mgmt.searchSessions.flyoutTitle": "検査", - "xpack.data.mgmt.searchSessions.main.backgroundSessionsDocsLinkText": "ドキュメント", - "xpack.data.mgmt.searchSessions.main.sectionDescription": "保存された検索セッションを管理します。", - "xpack.data.mgmt.searchSessions.main.sectionTitle": "検索セッション", - "xpack.data.mgmt.searchSessions.renameModal.cancelButton": "キャンセル", - "xpack.data.mgmt.searchSessions.renameModal.renameButton": "保存", - "xpack.data.mgmt.searchSessions.renameModal.searchSessionNameInputLabel": "検索セッション名", - "xpack.data.mgmt.searchSessions.renameModal.title": "検索セッション名を編集", - "xpack.data.mgmt.searchSessions.search.filterApp": "アプリ", - "xpack.data.mgmt.searchSessions.search.filterStatus": "ステータス", - "xpack.data.mgmt.searchSessions.search.tools.refresh": "更新", - "xpack.data.mgmt.searchSessions.status.expireDateUnknown": "不明", - "xpack.data.mgmt.searchSessions.status.expiresOn": "有効期限：{expireDate}", - "xpack.data.mgmt.searchSessions.status.expiresSoonInDays": "{numDays}日後に期限切れ", - "xpack.data.mgmt.searchSessions.status.expiresSoonInDaysTooltip": "{numDays}日", - "xpack.data.mgmt.searchSessions.status.expiresSoonInHours": "このセッションは{numHours}時間後に期限切れになります", - "xpack.data.mgmt.searchSessions.status.expiresSoonInHoursTooltip": "{numHours}時間", - "xpack.data.mgmt.searchSessions.status.label.cancelled": "キャンセル済み", - "xpack.data.mgmt.searchSessions.status.label.complete": "完了", - "xpack.data.mgmt.searchSessions.status.label.error": "エラー", - "xpack.data.mgmt.searchSessions.status.label.expired": "期限切れ", - "xpack.data.mgmt.searchSessions.status.label.inProgress": "進行中", - "xpack.data.mgmt.searchSessions.status.message.cancelled": "ユーザーがキャンセル", - "xpack.data.mgmt.searchSessions.status.message.createdOn": "有効期限：{expireDate}", - "xpack.data.mgmt.searchSessions.status.message.error": "エラー：{error}", - "xpack.data.mgmt.searchSessions.status.message.expiredOn": "有効期限：{expireDate}", - "xpack.data.mgmt.searchSessions.table.headerExpiration": "有効期限", - "xpack.data.mgmt.searchSessions.table.headerName": "名前", - "xpack.data.mgmt.searchSessions.table.headerStarted": "作成済み", - "xpack.data.mgmt.searchSessions.table.headerStatus": "ステータス", - "xpack.data.mgmt.searchSessions.table.headerType": "アプリ", - "xpack.data.mgmt.searchSessions.table.mlAppName": "機械学習", - "xpack.data.mgmt.searchSessions.table.notRestorableWarning": "検索セッションはもう一度実行されます。今後使用するために保存できます。", - "xpack.data.mgmt.searchSessions.table.numSearches": "# 検索", - "xpack.data.mgmt.searchSessions.table.versionIncompatibleWarning": "この検索は別のバージョンを実行しているKibanaインスタンスで作成されました。正常に復元されない可能性があります。", - "xpack.data.search.statusError": "検索は{errorCode}ステータスで完了しました", - "xpack.data.search.statusThrow": "検索ステータスはエラー{message}（{errorCode}）ステータスを返しました", - "xpack.data.searchSessionIndicator.cancelButtonText": "セッションの停止", - "xpack.data.searchSessionIndicator.canceledDescriptionText": "不完全なデータを表示しています。", - "xpack.data.searchSessionIndicator.canceledIconAriaLabel": "検索セッションが停止しました", - "xpack.data.searchSessionIndicator.canceledTitleText": "検索セッションが停止しました", - "xpack.data.searchSessionIndicator.canceledTooltipText": "検索セッションが停止しました", - "xpack.data.searchSessionIndicator.canceledWhenText": "停止：{when}", - "xpack.data.searchSessionIndicator.continueInBackgroundButtonText": "セッションの保存", - "xpack.data.searchSessionIndicator.disabledDueToDisabledGloballyMessage": "検索セッションを管理するアクセス権がありません", - "xpack.data.searchSessionIndicator.disabledDueToTimeoutMessage": "検索セッション結果が期限切れです。", - "xpack.data.searchSessionIndicator.loadingInTheBackgroundDescriptionText": "管理から完了した結果に戻ることができます。", - "xpack.data.searchSessionIndicator.loadingInTheBackgroundIconAriaLabel": "保存されたセッションを実行中です", - "xpack.data.searchSessionIndicator.loadingInTheBackgroundIconTooltipText": "保存されたセッションを実行中です", - "xpack.data.searchSessionIndicator.loadingInTheBackgroundTitleText": "保存されたセッションを実行中です", - "xpack.data.searchSessionIndicator.loadingInTheBackgroundWhenText": "開始：{when}", - "xpack.data.searchSessionIndicator.loadingResultsDescription": "セッションを保存して作業を続け、完了した結果に戻ってください。", - "xpack.data.searchSessionIndicator.loadingResultsIconAriaLabel": "検索セッションを読み込んでいます", - "xpack.data.searchSessionIndicator.loadingResultsIconTooltipText": "検索セッションを読み込んでいます", - "xpack.data.searchSessionIndicator.loadingResultsTitle": "検索に少し時間がかかっています...", - "xpack.data.searchSessionIndicator.loadingResultsWhenText": "開始：{when}", - "xpack.data.searchSessionIndicator.restoredDescriptionText": "特定の時間範囲からキャッシュに保存されたデータを表示しています。時間範囲またはフィルターを変更すると、セッションが再実行されます。", - "xpack.data.searchSessionIndicator.restoredResultsIconAriaLabel": "保存されたセッションが復元されました", - "xpack.data.searchSessionIndicator.restoredResultsTooltipText": "検索セッションが復元されました", - "xpack.data.searchSessionIndicator.restoredTitleText": "検索セッションが復元されました", - "xpack.data.searchSessionIndicator.restoredWhenText": "完了：{when}", - "xpack.data.searchSessionIndicator.resultLoadedInTheBackgroundDescriptionText": "管理からこれらの結果に戻ることができます。", - "xpack.data.searchSessionIndicator.resultLoadedInTheBackgroundIconAriaLabel": "保存されたセッションが完了しました", - "xpack.data.searchSessionIndicator.resultLoadedInTheBackgroundIconTooltipText": "保存されたセッションが完了しました", - "xpack.data.searchSessionIndicator.resultLoadedInTheBackgroundTitleText": "検索セッションが保存されました", - "xpack.data.searchSessionIndicator.resultLoadedInTheBackgroundWhenText": "完了：{when}", - "xpack.data.searchSessionIndicator.resultsLoadedDescriptionText": "セッションを保存して、後から戻ります。", - "xpack.data.searchSessionIndicator.resultsLoadedIconAriaLabel": "検索セッションが完了しました", - "xpack.data.searchSessionIndicator.resultsLoadedIconTooltipText": "検索セッションが完了しました", - "xpack.data.searchSessionIndicator.resultsLoadedText": "検索セッションが完了しました", - "xpack.data.searchSessionIndicator.resultsLoadedWhenText": "完了：{when}", - "xpack.data.searchSessionIndicator.saveButtonText": "セッションの保存", - "xpack.data.searchSessionIndicator.viewSearchSessionsLinkText": "セッションの管理", - "xpack.data.searchSessionName.ariaLabelText": "検索セッション名", - "xpack.data.searchSessionName.editAriaLabelText": "検索セッション名を編集", - "xpack.data.searchSessionName.placeholderText": "検索セッションの名前を入力", - "xpack.data.searchSessionName.saveButtonText": "保存", - "xpack.data.sessions.management.flyoutText": "この検索セッションの構成", - "xpack.data.sessions.management.flyoutTitle": "検索セッションの検査", "xpack.dataVisualizer.addCombinedFieldsLabel": "結合されたフィールドを追加", "xpack.dataVisualizer.choroplethMap.topValuesCount": "{fieldName}の上位の値件数", "xpack.dataVisualizer.chrome.help.appName": "データビジュアライザー", @@ -11925,7 +11921,6 @@ "xpack.enterpriseSearch.workplaceSearch.groups.newGroup.action": "グループを管理", "xpack.enterpriseSearch.workplaceSearch.groups.newGroupSavedSuccess": "{groupName}が正常に作成されました", "xpack.enterpriseSearch.workplaceSearch.groups.noSourcesMessage": "組織コンテンツソースがありません", - "xpack.enterpriseSearch.workplaceSearch.groups.noUsersMessage": "ユーザーがありません", "xpack.enterpriseSearch.workplaceSearch.groups.overview.confirmRemoveButtonText": "{name}を削除", "xpack.enterpriseSearch.workplaceSearch.groups.overview.confirmRemoveDescription": "グループはWorkplace Searchから削除されます。{name}を削除してよろしいですか？", "xpack.enterpriseSearch.workplaceSearch.groups.overview.confirmTitleText": "確認", @@ -19969,13 +19964,10 @@ "xpack.ml.trainedModels.testModelsFlyout.headerLabel": "学習済みモデルのテスト", "xpack.ml.trainedModels.testModelsFlyout.inferenceError": "エラーが発生しました", "xpack.ml.trainedModels.testModelsFlyout.langIdent.inputText": "入力テキスト", - "xpack.ml.trainedModels.testModelsFlyout.langIdent.markupTab": "アウトプット", "xpack.ml.trainedModels.testModelsFlyout.langIdent.output.language_title": "言語", "xpack.ml.trainedModels.testModelsFlyout.langIdent.output.probability_title": "確率", "xpack.ml.trainedModels.testModelsFlyout.langIdent.output.title": "これは{lang}のようになります", "xpack.ml.trainedModels.testModelsFlyout.langIdent.output.titleUnknown": "不明な言語コード：{code}", - "xpack.ml.trainedModels.testModelsFlyout.langIdent.rawOutput": "元の出力", - "xpack.ml.trainedModels.testModelsFlyout.langIdent.runButton": "テスト", "xpack.ml.trainedModels.testModelsFlyout.ner.output.probabilityTitle": "確率", "xpack.ml.trainedModels.testModelsFlyout.ner.output.typeTitle": "型", "xpack.ml.trainedModelsBreadcrumbs.nodeOverviewLabel": "ノード", @@ -21815,12 +21807,6 @@ "xpack.observability.noDataConfig.beatsCard.title": "統合の追加", "xpack.observability.noDataConfig.solutionName": "Observability", "xpack.observability.notAvailable": "N/A", - "xpack.observability.overview.alert.allTypes": "すべてのタイプ", - "xpack.observability.overview.alert.appLink": "すべてのアラートを表示", - "xpack.observability.overview.alert.errorMessage": "アラートデータの読み込みエラーが発生しました。しばらくたってから再試行してください。", - "xpack.observability.overview.alert.errorTitle": "アラートデータを読み込めませんでした", - "xpack.observability.overview.alerts.appLink": "アラートを表示", - "xpack.observability.overview.alerts.muted": "ミュート", "xpack.observability.overview.alerts.title": "アラート", "xpack.observability.overview.apm.appLink": "サービスインベントリを表示", "xpack.observability.overview.apm.services": "サービス", @@ -22127,9 +22113,6 @@ "xpack.osquery.liveQueryDetails.viewLiveQueriesHistoryTitle": "ライブクエリ履歴を表示", "xpack.osquery.liveQueryForm.form.saveForLaterButtonLabel": "後で使用するために保存する", "xpack.osquery.liveQueryForm.form.submitButtonLabel": "送信", - "xpack.osquery.liveQueryForm.steps.agentsStepHeading": "エージェントを選択", - "xpack.osquery.liveQueryForm.steps.queryStepHeading": "クエリを入力", - "xpack.osquery.liveQueryForm.steps.resultsStepHeading": "結果を確認", "xpack.osquery.liveQueryResults.table.agentColumnTitle": "エージェント", "xpack.osquery.liveQueryResults.table.fieldMappedLabel": "フィールドは以下にマッピングされています", "xpack.osquery.newLiveQuery.pageTitle": "新しいライブクエリ", diff --git a/x-pack/plugins/translations/translations/zh-CN.json b/x-pack/plugins/translations/translations/zh-CN.json index d7fd5949c51c5..6c6a5d60ed320 100644 --- a/x-pack/plugins/translations/translations/zh-CN.json +++ b/x-pack/plugins/translations/translations/zh-CN.json @@ -447,7 +447,6 @@ "xpack.lens.indexPattern.dateHistogram.autoAdvancedExplanation": "时间间隔遵循以下逻辑：", "xpack.lens.indexPattern.dateHistogram.autoBasicExplanation": "自动日期直方图按时间间隔将数据字段拆分为桶。", "xpack.lens.indexPattern.dateHistogram.autoBoundHeader": "已度量目标时间间隔", - "xpack.lens.indexPattern.dateHistogram.autoHelpText": "运作方式", "xpack.lens.indexPattern.dateHistogram.autoInterval": "定制时间间隔", "xpack.lens.indexPattern.dateHistogram.autoIntervalHeader": "已用时间间隔", "xpack.lens.indexPattern.dateHistogram.autoLongerExplanation": "要选择时间间隔，Lens 按 {targetBarSetting} 设置分割指定的时间范围。Lens 为您的数据计算最佳时间间隔。例如 30m、1h 和 12。最大条形数由 {maxBarSetting} 值设置。", @@ -580,7 +579,6 @@ "xpack.lens.indexPattern.moving_average.signature": "指标：数字，[window]：数字", "xpack.lens.indexPattern.movingAverage": "移动平均值", "xpack.lens.indexPattern.movingAverage.basicExplanation": "移动平均值在数据上滑动时间窗并显示平均值。仅日期直方图支持移动平均值。", - "xpack.lens.indexPattern.movingAverage.helpText": "运作方式", "xpack.lens.indexPattern.movingAverage.limitations": "第一个移动平均值开始于第二项。", "xpack.lens.indexPattern.movingAverage.longerExplanation": "要计算移动平均值，Lens 使用时间窗的平均值，并为缺口应用跳过策略。 对于缺失值，将跳过桶，计算将基于下一个值执行。", "xpack.lens.indexPattern.movingAverage.tableExplanation": "例如，如果数据为 [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]，则可以使用时间窗大小 5 计算简单移动平均值：", @@ -2722,6 +2720,110 @@ "data.searchSessions.sessionService.sessionObjectFetchError": "无法提取搜索会话信息", "data.triggers.applyFilterDescription": "应用 kibana 筛选时。可能是单个值或范围筛选。", "data.triggers.applyFilterTitle": "应用筛选", + "data.mgmt.searchSessions.actionDelete": "删除", + "data.mgmt.searchSessions.actionExtend": "延长", + "data.mgmt.searchSessions.actionRename": "编辑名称", + "data.mgmt.searchSessions.actions.tooltip.moreActions": "更多操作", + "data.mgmt.searchSessions.api.deleted": "搜索会话已删除。", + "data.mgmt.searchSessions.api.deletedError": "无法删除搜索会话！", + "data.mgmt.searchSessions.api.extended": "搜索会话已延长。", + "data.mgmt.searchSessions.api.extendError": "无法延长搜索会话！", + "data.mgmt.searchSessions.api.fetchError": "无法刷新页面！", + "data.mgmt.searchSessions.api.fetchTimeout": "获取搜索会话信息在 {timeout} 秒后已超时", + "data.mgmt.searchSessions.api.rename": "搜索会话已重命名", + "data.mgmt.searchSessions.api.renameError": "无法重命名搜索会话", + "data.mgmt.searchSessions.appTitle": "搜索会话", + "data.mgmt.searchSessions.ariaLabel.moreActions": "更多操作", + "data.mgmt.searchSessions.cancelModal.cancelButton": "取消", + "data.mgmt.searchSessions.cancelModal.deleteButton": "删除", + "data.mgmt.searchSessions.cancelModal.message": "删除搜索会话“{name}”将会删除所有缓存的结果。", + "data.mgmt.searchSessions.cancelModal.title": "删除搜索会话", + "data.mgmt.searchSessions.extendModal.dontExtendButton": "取消", + "data.mgmt.searchSessions.extendModal.extendButton": "延长过期时间", + "data.mgmt.searchSessions.extendModal.extendMessage": "搜索会话“{name}”过期时间将延长至 {newExpires}。", + "data.mgmt.searchSessions.extendModal.title": "延长搜索会话过期时间", + "data.mgmt.searchSessions.flyoutTitle": "检查", + "data.mgmt.searchSessions.main.backgroundSessionsDocsLinkText": "文档", + "data.mgmt.searchSessions.main.sectionDescription": "管理已保存搜索会话。", + "data.mgmt.searchSessions.main.sectionTitle": "搜索会话", + "data.mgmt.searchSessions.renameModal.cancelButton": "取消", + "data.mgmt.searchSessions.renameModal.renameButton": "保存", + "data.mgmt.searchSessions.renameModal.searchSessionNameInputLabel": "搜索会话名称", + "data.mgmt.searchSessions.renameModal.title": "编辑搜索会话名称", + "data.mgmt.searchSessions.search.filterApp": "应用", + "data.mgmt.searchSessions.search.filterStatus": "状态", + "data.mgmt.searchSessions.search.tools.refresh": "刷新", + "data.mgmt.searchSessions.status.expireDateUnknown": "未知", + "data.mgmt.searchSessions.status.expiresOn": "于 {expireDate}过期", + "data.mgmt.searchSessions.status.expiresSoonInDays": "将于 {numDays} 天后过期", + "data.mgmt.searchSessions.status.expiresSoonInDaysTooltip": "{numDays} 天", + "data.mgmt.searchSessions.status.expiresSoonInHours": "此会话将于 {numHours} 小时后过期", + "data.mgmt.searchSessions.status.expiresSoonInHoursTooltip": "{numHours} 小时", + "data.mgmt.searchSessions.status.label.cancelled": "已取消", + "data.mgmt.searchSessions.status.label.complete": "已完成", + "data.mgmt.searchSessions.status.label.error": "错误", + "data.mgmt.searchSessions.status.label.expired": "已过期", + "data.mgmt.searchSessions.status.label.inProgress": "进行中", + "data.mgmt.searchSessions.status.message.cancelled": "用户已取消", + "data.mgmt.searchSessions.status.message.createdOn": "于 {expireDate}过期", + "data.mgmt.searchSessions.status.message.error": "错误：{error}", + "data.mgmt.searchSessions.status.message.expiredOn": "已于 {expireDate}过期", + "data.mgmt.searchSessions.table.headerExpiration": "到期", + "data.mgmt.searchSessions.table.headerName": "名称", + "data.mgmt.searchSessions.table.headerStarted": "创建时间", + "data.mgmt.searchSessions.table.headerStatus": "状态", + "data.mgmt.searchSessions.table.headerType": "应用", + "data.mgmt.searchSessions.table.notRestorableWarning": "搜索会话将重新执行。然后，您可以将其保存，供未来使用。", + "data.mgmt.searchSessions.table.numSearches": "搜索数", + "data.mgmt.searchSessions.table.versionIncompatibleWarning": "此搜索会话在运行不同版本的 Kibana 实例中已创建。其可能不会正确还原。", + "data.search.statusError": "搜索完成，状态为 {errorCode}", + "data.search.statusThrow": "搜索状态引发错误 {message} ({errorCode}) 状态", + "data.searchSessionIndicator.cancelButtonText": "停止会话", + "data.searchSessionIndicator.canceledDescriptionText": "您正查看不完整的数据", + "data.searchSessionIndicator.canceledIconAriaLabel": "搜索会话已停止", + "data.searchSessionIndicator.canceledTitleText": "搜索会话已停止", + "data.searchSessionIndicator.canceledTooltipText": "搜索会话已停止", + "data.searchSessionIndicator.canceledWhenText": "已于 {when} 停止", + "data.searchSessionIndicator.continueInBackgroundButtonText": "保存会话", + "data.searchSessionIndicator.disabledDueToDisabledGloballyMessage": "您无权管理搜索会话", + "data.searchSessionIndicator.disabledDueToTimeoutMessage": "搜索会话结果已过期。", + "data.searchSessionIndicator.loadingInTheBackgroundDescriptionText": "可以从“管理”中返回至完成的结果", + "data.searchSessionIndicator.loadingInTheBackgroundIconAriaLabel": "已保存会话正在进行中", + "data.searchSessionIndicator.loadingInTheBackgroundIconTooltipText": "已保存会话正在进行中", + "data.searchSessionIndicator.loadingInTheBackgroundTitleText": "已保存会话正在进行中", + "data.searchSessionIndicator.loadingInTheBackgroundWhenText": "已于 {when} 启动", + "data.searchSessionIndicator.loadingResultsDescription": "保存您的会话，继续您的工作，然后返回到完成的结果", + "data.searchSessionIndicator.loadingResultsIconAriaLabel": "搜索会话正在加载", + "data.searchSessionIndicator.loadingResultsIconTooltipText": "搜索会话正在加载", + "data.searchSessionIndicator.loadingResultsTitle": "您的搜索将需要一些时间......", + "data.searchSessionIndicator.loadingResultsWhenText": "已于 {when} 启动", + "data.searchSessionIndicator.restoredDescriptionText": "您在查看特定时间范围的缓存数据。更改时间范围或筛选将会重新运行会话", + "data.searchSessionIndicator.restoredResultsIconAriaLabel": "已保存会话已还原", + "data.searchSessionIndicator.restoredResultsTooltipText": "搜索会话已还原", + "data.searchSessionIndicator.restoredTitleText": "搜索会话已还原", + "data.searchSessionIndicator.restoredWhenText": "已于 {when} 完成", + "data.searchSessionIndicator.resultLoadedInTheBackgroundDescriptionText": "可以从“管理”中返回到这些结果", + "data.searchSessionIndicator.resultLoadedInTheBackgroundIconAriaLabel": "已保存会话已完成", + "data.searchSessionIndicator.resultLoadedInTheBackgroundIconTooltipText": "已保存会话已完成", + "data.searchSessionIndicator.resultLoadedInTheBackgroundTitleText": "搜索会话已保存", + "data.searchSessionIndicator.resultLoadedInTheBackgroundWhenText": "已于 {when} 完成", + "data.searchSessionIndicator.resultsLoadedDescriptionText": "保存您的会话，之后可返回", + "data.searchSessionIndicator.resultsLoadedIconAriaLabel": "搜索会话已完成", + "data.searchSessionIndicator.resultsLoadedIconTooltipText": "搜索会话已完成", + "data.searchSessionIndicator.resultsLoadedText": "搜索会话已完成", + "data.searchSessionIndicator.resultsLoadedWhenText": "已于 {when} 完成", + "data.searchSessionIndicator.saveButtonText": "保存会话", + "data.searchSessionIndicator.viewSearchSessionsLinkText": "管理会话", + "data.searchSessionName.ariaLabelText": "搜索会话名称", + "data.searchSessionName.editAriaLabelText": "编辑搜索会话名称", + "data.searchSessionName.placeholderText": "为搜索会话输入名称", + "data.searchSessionName.saveButtonText": "保存", + "data.sessions.management.flyoutText": "此搜索会话的配置", + "data.sessions.management.flyoutTitle": "检查搜索会话", + "dataViews.deprecations.scriptedFields.manualStepOneMessage": "导航到“堆栈管理”>“Kibana”>“索引模式”。", + "dataViews.deprecations.scriptedFields.manualStepTwoMessage": "更新 {numberOfIndexPatternsWithScriptedFields} 个具有脚本字段的索引模式以改为使用运行时字段。多数情况下，要迁移现有脚本，您需要将“return ;”更改为“emit();”。至少有一个脚本字段的索引模式：{allTitles}", + "dataViews.deprecations.scriptedFieldsMessage": "您具有 {numberOfIndexPatternsWithScriptedFields} 个使用脚本字段的索引模式 ({titlesPreview}...)。脚本字段已过时，将在未来移除。请改为使用运行时脚本。", + "dataViews.deprecations.scriptedFieldsTitle": "找到使用脚本字段的索引模式", "dataViews.deprecations.scriptedFields.manualStepOneMessage": "导航到“堆栈管理”>“Kibana”>“数据视图”。", "dataViews.deprecations.scriptedFields.manualStepTwoMessage": "更新 {numberOfIndexPatternsWithScriptedFields} 个具有脚本字段的数据视图以改为使用运行时字段。多数情况下，要迁移现有脚本，您需要将“return ;”更改为“emit();”。至少有一个脚本字段的数据视图：{allTitles}", "dataViews.deprecations.scriptedFieldsMessage": "您具有 {numberOfIndexPatternsWithScriptedFields} 个使用脚本字段的数据视图 ({titlesPreview}...)。脚本字段已过时，将在未来移除。请改为使用运行时脚本。", @@ -3473,11 +3575,11 @@ "expressionXY.axisTitlesVisibilityConfig.yLeft.help": "指定左侧 y 轴的标题是否可见。", "expressionXY.axisTitlesVisibilityConfig.yRight.help": "指定右侧 y 轴的标题是否可见。", "expressionXY.dataLayer.accessors.help": "要在 y 轴上显示的列。", - "expressionXY.dataLayer.columnToLabel.help": "要标记的列 ID 的 JSON 键值对", + "expressionXY.layer.columnToLabel.help": "要标记的列 ID 的 JSON 键值对", "expressionXY.dataLayer.help": "配置 xy 图表中的图层", "expressionXY.dataLayer.hide.help": "显示/隐藏轴", "expressionXY.dataLayer.isHistogram.help": "是否将图表布局为直方图", - "expressionXY.dataLayer.layerId.help": "图层 ID", + "expressionXY.layers.layerId.help": "图层 ID", "expressionXY.dataLayer.palette.help": "调色板", "expressionXY.dataLayer.seriesType.help": "要显示的图表的类型。", "expressionXY.dataLayer.splitAccessor.help": "拆分要依据的列", @@ -3508,9 +3610,7 @@ "expressionXY.legendConfig.showSingleSeries.help": "指定是否应显示只包含一个条目的图例", "expressionXY.legendConfig.verticalAlignment.help": "指定图例显示在图表内时垂直对齐。", "expressionXY.referenceLineLayer.accessors.help": "要在 y 轴上显示的列。", - "expressionXY.referenceLineLayer.columnToLabel.help": "要标记的列 ID 的 JSON 键值对", "expressionXY.referenceLineLayer.help": "配置 xy 图表中的参考线", - "expressionXY.referenceLineLayer.layerId.help": "图层 ID", "expressionXY.referenceLineLayer.yConfig.help": "y 轴的其他配置", "expressionXY.tickLabelsConfig.help": "配置 xy 图表的刻度标签外观", "expressionXY.tickLabelsConfig.x.help": "指定 x 轴的刻度标签是否可见。", @@ -3541,7 +3641,7 @@ "expressionXY.xyVis.help": "X/Y 图表", "expressionXY.xyVis.hideEndzones.help": "隐藏部分数据的末日区域标记", "expressionXY.xyVis.labelsOrientation.help": "定义轴标签的旋转", - "expressionXY.xyVis.layers.help": "可视序列的图层", + "expressionXY.layeredXyVis.layers.help": "可视序列的图层", "expressionXY.xyVis.legend.help": "配置图表图例。", "expressionXY.xyVis.logDatatable.breakDown": "细分方式", "expressionXY.xyVis.logDatatable.metric": "垂直轴", @@ -7396,7 +7496,6 @@ "xpack.apm.filter.environment.allLabel": "全部", "xpack.apm.filter.environment.label": "环境", "xpack.apm.filter.environment.notDefinedLabel": "未定义", - "xpack.apm.filter.environment.selectEnvironmentLabel": "选择环境", "xpack.apm.fleet_integration.settings.advancedOptionsLavel": "高级选项", "xpack.apm.fleet_integration.settings.agentAuthorization.anonymousAllowAgentHelpText": "允许进行匿名访问的代理名称。", "xpack.apm.fleet_integration.settings.agentAuthorization.anonymousAllowAgentLabel": "允许的代理", @@ -7623,7 +7722,6 @@ "xpack.apm.propertiesTable.tabs.metadataLabel": "元数据", "xpack.apm.propertiesTable.tabs.timelineLabel": "时间线", "xpack.apm.searchInput.filter": "筛选...", - "xpack.apm.selectCustomOptionText": "将 \\{searchValue\\} 添加为新选项", "xpack.apm.selectPlaceholder": "选择选项：", "xpack.apm.serviceDependencies.breakdownChartTitle": "依赖项花费的时间", "xpack.apm.serviceDetails.dependenciesTabLabel": "依赖项", @@ -10210,107 +10308,6 @@ "xpack.dashboard.drilldown.goToDashboard": "前往仪表板", "xpack.dashboard.FlyoutCreateDrilldownAction.displayName": "创建向下钻取", "xpack.dashboard.panel.openFlyoutEditDrilldown.displayName": "管理向下钻取", - "xpack.data.mgmt.searchSessions.actionDelete": "删除", - "xpack.data.mgmt.searchSessions.actionExtend": "延长", - "xpack.data.mgmt.searchSessions.actionRename": "编辑名称", - "xpack.data.mgmt.searchSessions.actions.tooltip.moreActions": "更多操作", - "xpack.data.mgmt.searchSessions.api.deleted": "搜索会话已删除。", - "xpack.data.mgmt.searchSessions.api.deletedError": "无法删除搜索会话！", - "xpack.data.mgmt.searchSessions.api.extended": "搜索会话已延长。", - "xpack.data.mgmt.searchSessions.api.extendError": "无法延长搜索会话！", - "xpack.data.mgmt.searchSessions.api.fetchError": "无法刷新页面！", - "xpack.data.mgmt.searchSessions.api.fetchTimeout": "获取搜索会话信息在 {timeout} 秒后已超时", - "xpack.data.mgmt.searchSessions.api.rename": "搜索会话已重命名", - "xpack.data.mgmt.searchSessions.api.renameError": "无法重命名搜索会话", - "xpack.data.mgmt.searchSessions.appTitle": "搜索会话", - "xpack.data.mgmt.searchSessions.ariaLabel.moreActions": "更多操作", - "xpack.data.mgmt.searchSessions.cancelModal.cancelButton": "取消", - "xpack.data.mgmt.searchSessions.cancelModal.deleteButton": "删除", - "xpack.data.mgmt.searchSessions.cancelModal.message": "删除搜索会话“{name}”将会删除所有缓存的结果。", - "xpack.data.mgmt.searchSessions.cancelModal.title": "删除搜索会话", - "xpack.data.mgmt.searchSessions.extendModal.dontExtendButton": "取消", - "xpack.data.mgmt.searchSessions.extendModal.extendButton": "延长过期时间", - "xpack.data.mgmt.searchSessions.extendModal.extendMessage": "搜索会话“{name}”过期时间将延长至 {newExpires}。", - "xpack.data.mgmt.searchSessions.extendModal.title": "延长搜索会话过期时间", - "xpack.data.mgmt.searchSessions.flyoutTitle": "检查", - "xpack.data.mgmt.searchSessions.main.backgroundSessionsDocsLinkText": "文档", - "xpack.data.mgmt.searchSessions.main.sectionDescription": "管理已保存搜索会话。", - "xpack.data.mgmt.searchSessions.main.sectionTitle": "搜索会话", - "xpack.data.mgmt.searchSessions.renameModal.cancelButton": "取消", - "xpack.data.mgmt.searchSessions.renameModal.renameButton": "保存", - "xpack.data.mgmt.searchSessions.renameModal.searchSessionNameInputLabel": "搜索会话名称", - "xpack.data.mgmt.searchSessions.renameModal.title": "编辑搜索会话名称", - "xpack.data.mgmt.searchSessions.search.filterApp": "应用", - "xpack.data.mgmt.searchSessions.search.filterStatus": "状态", - "xpack.data.mgmt.searchSessions.search.tools.refresh": "刷新", - "xpack.data.mgmt.searchSessions.status.expireDateUnknown": "未知", - "xpack.data.mgmt.searchSessions.status.expiresOn": "于 {expireDate}过期", - "xpack.data.mgmt.searchSessions.status.expiresSoonInDays": "将于 {numDays} 天后过期", - "xpack.data.mgmt.searchSessions.status.expiresSoonInDaysTooltip": "{numDays} 天", - "xpack.data.mgmt.searchSessions.status.expiresSoonInHours": "此会话将于 {numHours} 小时后过期", - "xpack.data.mgmt.searchSessions.status.expiresSoonInHoursTooltip": "{numHours} 小时", - "xpack.data.mgmt.searchSessions.status.label.cancelled": "已取消", - "xpack.data.mgmt.searchSessions.status.label.complete": "已完成", - "xpack.data.mgmt.searchSessions.status.label.error": "错误", - "xpack.data.mgmt.searchSessions.status.label.expired": "已过期", - "xpack.data.mgmt.searchSessions.status.label.inProgress": "进行中", - "xpack.data.mgmt.searchSessions.status.message.cancelled": "用户已取消", - "xpack.data.mgmt.searchSessions.status.message.createdOn": "于 {expireDate}过期", - "xpack.data.mgmt.searchSessions.status.message.error": "错误：{error}", - "xpack.data.mgmt.searchSessions.status.message.expiredOn": "已于 {expireDate}过期", - "xpack.data.mgmt.searchSessions.table.headerExpiration": "到期", - "xpack.data.mgmt.searchSessions.table.headerName": "名称", - "xpack.data.mgmt.searchSessions.table.headerStarted": "创建时间", - "xpack.data.mgmt.searchSessions.table.headerStatus": "状态", - "xpack.data.mgmt.searchSessions.table.headerType": "应用", - "xpack.data.mgmt.searchSessions.table.mlAppName": "Machine Learning", - "xpack.data.mgmt.searchSessions.table.notRestorableWarning": "搜索会话将重新执行。然后，您可以将其保存，供未来使用。", - "xpack.data.mgmt.searchSessions.table.numSearches": "搜索数", - "xpack.data.mgmt.searchSessions.table.versionIncompatibleWarning": "此搜索会话在运行不同版本的 Kibana 实例中已创建。其可能不会正确还原。", - "xpack.data.search.statusError": "搜索完成，状态为 {errorCode}", - "xpack.data.search.statusThrow": "搜索状态引发错误 {message} ({errorCode}) 状态", - "xpack.data.searchSessionIndicator.cancelButtonText": "停止会话", - "xpack.data.searchSessionIndicator.canceledDescriptionText": "您正查看不完整的数据", - "xpack.data.searchSessionIndicator.canceledIconAriaLabel": "搜索会话已停止", - "xpack.data.searchSessionIndicator.canceledTitleText": "搜索会话已停止", - "xpack.data.searchSessionIndicator.canceledTooltipText": "搜索会话已停止", - "xpack.data.searchSessionIndicator.canceledWhenText": "已于 {when} 停止", - "xpack.data.searchSessionIndicator.continueInBackgroundButtonText": "保存会话", - "xpack.data.searchSessionIndicator.disabledDueToDisabledGloballyMessage": "您无权管理搜索会话", - "xpack.data.searchSessionIndicator.disabledDueToTimeoutMessage": "搜索会话结果已过期。", - "xpack.data.searchSessionIndicator.loadingInTheBackgroundDescriptionText": "可以从“管理”中返回至完成的结果", - "xpack.data.searchSessionIndicator.loadingInTheBackgroundIconAriaLabel": "已保存会话正在进行中", - "xpack.data.searchSessionIndicator.loadingInTheBackgroundIconTooltipText": "已保存会话正在进行中", - "xpack.data.searchSessionIndicator.loadingInTheBackgroundTitleText": "已保存会话正在进行中", - "xpack.data.searchSessionIndicator.loadingInTheBackgroundWhenText": "已于 {when} 启动", - "xpack.data.searchSessionIndicator.loadingResultsDescription": "保存您的会话，继续您的工作，然后返回到完成的结果", - "xpack.data.searchSessionIndicator.loadingResultsIconAriaLabel": "搜索会话正在加载", - "xpack.data.searchSessionIndicator.loadingResultsIconTooltipText": "搜索会话正在加载", - "xpack.data.searchSessionIndicator.loadingResultsTitle": "您的搜索将需要一些时间......", - "xpack.data.searchSessionIndicator.loadingResultsWhenText": "已于 {when} 启动", - "xpack.data.searchSessionIndicator.restoredDescriptionText": "您在查看特定时间范围的缓存数据。更改时间范围或筛选将会重新运行会话", - "xpack.data.searchSessionIndicator.restoredResultsIconAriaLabel": "已保存会话已还原", - "xpack.data.searchSessionIndicator.restoredResultsTooltipText": "搜索会话已还原", - "xpack.data.searchSessionIndicator.restoredTitleText": "搜索会话已还原", - "xpack.data.searchSessionIndicator.restoredWhenText": "已于 {when} 完成", - "xpack.data.searchSessionIndicator.resultLoadedInTheBackgroundDescriptionText": "可以从“管理”中返回到这些结果", - "xpack.data.searchSessionIndicator.resultLoadedInTheBackgroundIconAriaLabel": "已保存会话已完成", - "xpack.data.searchSessionIndicator.resultLoadedInTheBackgroundIconTooltipText": "已保存会话已完成", - "xpack.data.searchSessionIndicator.resultLoadedInTheBackgroundTitleText": "搜索会话已保存", - "xpack.data.searchSessionIndicator.resultLoadedInTheBackgroundWhenText": "已于 {when} 完成", - "xpack.data.searchSessionIndicator.resultsLoadedDescriptionText": "保存您的会话，之后可返回", - "xpack.data.searchSessionIndicator.resultsLoadedIconAriaLabel": "搜索会话已完成", - "xpack.data.searchSessionIndicator.resultsLoadedIconTooltipText": "搜索会话已完成", - "xpack.data.searchSessionIndicator.resultsLoadedText": "搜索会话已完成", - "xpack.data.searchSessionIndicator.resultsLoadedWhenText": "已于 {when} 完成", - "xpack.data.searchSessionIndicator.saveButtonText": "保存会话", - "xpack.data.searchSessionIndicator.viewSearchSessionsLinkText": "管理会话", - "xpack.data.searchSessionName.ariaLabelText": "搜索会话名称", - "xpack.data.searchSessionName.editAriaLabelText": "编辑搜索会话名称", - "xpack.data.searchSessionName.placeholderText": "为搜索会话输入名称", - "xpack.data.searchSessionName.saveButtonText": "保存", - "xpack.data.sessions.management.flyoutText": "此搜索会话的配置", - "xpack.data.sessions.management.flyoutTitle": "检查搜索会话", "xpack.dataVisualizer.addCombinedFieldsLabel": "添加组合字段", "xpack.dataVisualizer.choroplethMap.topValuesCount": "{fieldName} 的排名最前值计数", "xpack.dataVisualizer.chrome.help.appName": "数据可视化工具", @@ -11947,7 +11944,6 @@ "xpack.enterpriseSearch.workplaceSearch.groups.newGroup.action": "管理组", "xpack.enterpriseSearch.workplaceSearch.groups.newGroupSavedSuccess": "已成功创建 {groupName}", "xpack.enterpriseSearch.workplaceSearch.groups.noSourcesMessage": "无组织内容源", - "xpack.enterpriseSearch.workplaceSearch.groups.noUsersMessage": "无用户", "xpack.enterpriseSearch.workplaceSearch.groups.overview.confirmRemoveButtonText": "删除 {name}", "xpack.enterpriseSearch.workplaceSearch.groups.overview.confirmRemoveDescription": "您的组将从 Workplace Search 中删除。确定要移除 {name}？", "xpack.enterpriseSearch.workplaceSearch.groups.overview.confirmTitleText": "确认", @@ -19999,13 +19995,10 @@ "xpack.ml.trainedModels.testModelsFlyout.headerLabel": "测试已训练模型", "xpack.ml.trainedModels.testModelsFlyout.inferenceError": "发生错误", "xpack.ml.trainedModels.testModelsFlyout.langIdent.inputText": "输入文本", - "xpack.ml.trainedModels.testModelsFlyout.langIdent.markupTab": "输出", "xpack.ml.trainedModels.testModelsFlyout.langIdent.output.language_title": "语言", "xpack.ml.trainedModels.testModelsFlyout.langIdent.output.probability_title": "可能性", "xpack.ml.trainedModels.testModelsFlyout.langIdent.output.title": "这像是 {lang}", "xpack.ml.trainedModels.testModelsFlyout.langIdent.output.titleUnknown": "语言代码未知：{code}", - "xpack.ml.trainedModels.testModelsFlyout.langIdent.rawOutput": "原始输出", - "xpack.ml.trainedModels.testModelsFlyout.langIdent.runButton": "测试", "xpack.ml.trainedModels.testModelsFlyout.ner.output.probabilityTitle": "可能性", "xpack.ml.trainedModels.testModelsFlyout.ner.output.typeTitle": "类型", "xpack.ml.trainedModelsBreadcrumbs.nodeOverviewLabel": "节点", @@ -21847,12 +21840,6 @@ "xpack.observability.noDataConfig.beatsCard.title": "添加集成", "xpack.observability.noDataConfig.solutionName": "Observability", "xpack.observability.notAvailable": "不可用", - "xpack.observability.overview.alert.allTypes": "所有类型", - "xpack.observability.overview.alert.appLink": "显示所有告警", - "xpack.observability.overview.alert.errorMessage": "加载告警数据时出现错误。请稍后重试。", - "xpack.observability.overview.alert.errorTitle": "我们无法加载告警数据", - "xpack.observability.overview.alerts.appLink": "显示告警", - "xpack.observability.overview.alerts.muted": "已静音", "xpack.observability.overview.alerts.title": "告警", "xpack.observability.overview.apm.appLink": "显示服务库存", "xpack.observability.overview.apm.services": "服务", @@ -22158,9 +22145,6 @@ "xpack.osquery.liveQueryDetails.viewLiveQueriesHistoryTitle": "查看实时查询历史记录", "xpack.osquery.liveQueryForm.form.saveForLaterButtonLabel": "保存，以后继续", "xpack.osquery.liveQueryForm.form.submitButtonLabel": "提交", - "xpack.osquery.liveQueryForm.steps.agentsStepHeading": "选择代理", - "xpack.osquery.liveQueryForm.steps.queryStepHeading": "输入查询", - "xpack.osquery.liveQueryForm.steps.resultsStepHeading": "检查结果", "xpack.osquery.liveQueryResults.table.agentColumnTitle": "代理", "xpack.osquery.liveQueryResults.table.fieldMappedLabel": "字段已映射到", "xpack.osquery.newLiveQuery.pageTitle": "新建实时查询", diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/common/components/execution_duration_chart.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/common/components/execution_duration_chart.tsx index 08fabc3fba2fd..140dae9dc14a5 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/sections/common/components/execution_duration_chart.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/common/components/execution_duration_chart.tsx @@ -38,7 +38,7 @@ const NUM_EXECUTIONS_OPTIONS = [120, 60, 30, 15].map((value) => ({ text: i18n.translate( 'xpack.triggersActionsUI.sections.executionDurationChart.numberOfExecutionsOption', { - defaultMessage: '{value} executions', + defaultMessage: '{value} runs', values: { value, }, @@ -70,7 +70,7 @@ export const ExecutionDurationChart: React.FunctionComponent = ({

@@ -84,7 +84,7 @@ export const ExecutionDurationChart: React.FunctionComponent = ({ aria-label={i18n.translate( 'xpack.triggersActionsUI.sections.executionDurationChart.selectNumberOfExecutionDurationsLabel', { - defaultMessage: 'Select number of executions', + defaultMessage: 'Select number of runs', } )} onChange={onChange} @@ -161,7 +161,7 @@ export const ExecutionDurationChart: React.FunctionComponent = ({

diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule.tsx index 6ee16ea08ae65..9d62fc2f8e37a 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule.tsx @@ -122,7 +122,7 @@ export function RuleComponent({ { id: EVENT_LOG_LIST_TAB, name: i18n.translate('xpack.triggersActionsUI.sections.ruleDetails.rule.eventLogTabText', { - defaultMessage: 'Execution history', + defaultMessage: 'Run history', }), 'data-test-subj': 'eventLogListTab', content: suspendedComponentWithProps( diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_form/rule_form.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_form/rule_form.tsx index d765fa225ef0c..1bca80a08c936 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_form/rule_form.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rule_form/rule_form.tsx @@ -488,7 +488,7 @@ export const RuleForm = ({ > )} diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rules_list.test.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rules_list.test.tsx index 05e00eaaab7a9..52c6e2d3ed149 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rules_list.test.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rules_list.test.tsx @@ -467,7 +467,7 @@ describe('rules_list component with items', () => { jest.runAllTimers(); wrapper.update(); - expect(wrapper.find('.euiToolTipPopover').text()).toBe('Start time of the last execution.'); + expect(wrapper.find('.euiToolTipPopover').text()).toBe('Start time of the last run.'); wrapper .find('[data-test-subj="rulesTableCell-lastExecutionDateTooltip"]') diff --git a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rules_list.tsx b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rules_list.tsx index e12ee75c609f8..b1255600b68de 100644 --- a/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rules_list.tsx +++ b/x-pack/plugins/triggers_actions_ui/public/application/sections/rules_list/components/rules_list.tsx @@ -428,7 +428,7 @@ export const RulesList: React.FunctionComponent = () => { content={i18n.translate( 'xpack.triggersActionsUI.sections.rulesList.rulesListTable.columns.ruleExecutionPercentileTooltip', { - defaultMessage: `{percentileOrdinal} percentile of this rule's past {sampleLimit} execution durations (mm:ss).`, + defaultMessage: `{percentileOrdinal} percentile of this rule's past {sampleLimit} run durations (mm:ss).`, values: { percentileOrdinal: percentileOrdinals[selectedPercentile!], sampleLimit: MONITORING_HISTORY_LIMIT, @@ -615,7 +615,7 @@ export const RulesList: React.FunctionComponent = () => { content={i18n.translate( 'xpack.triggersActionsUI.sections.rulesList.rulesListTable.columns.lastExecutionDateTitle', { - defaultMessage: 'Start time of the last execution.', + defaultMessage: 'Start time of the last run.', } )} > @@ -771,7 +771,7 @@ export const RulesList: React.FunctionComponent = () => { content={i18n.translate( 'xpack.triggersActionsUI.sections.rulesList.rulesListTable.columns.successRatioTitle', { - defaultMessage: 'How often this rule executes successfully.', + defaultMessage: 'How often this rule runs successfully.', } )} > diff --git a/x-pack/plugins/triggers_actions_ui/public/index.ts b/x-pack/plugins/triggers_actions_ui/public/index.ts index 94fe718363e2b..1e109b96ae5c9 100644 --- a/x-pack/plugins/triggers_actions_ui/public/index.ts +++ b/x-pack/plugins/triggers_actions_ui/public/index.ts @@ -30,6 +30,7 @@ export type { RuleTypeParams, AsApiContract, RuleTableItem, + AlertsTableConfigurationRegistryContract, } from './types'; export { diff --git a/x-pack/test/alerting_api_integration/security_and_spaces/tests/actions/builtin_action_types/servicenow_itom.ts b/x-pack/test/alerting_api_integration/security_and_spaces/tests/actions/builtin_action_types/servicenow_itom.ts index 9dcc3ef05266e..c685fff8abfc6 100644 --- a/x-pack/test/alerting_api_integration/security_and_spaces/tests/actions/builtin_action_types/servicenow_itom.ts +++ b/x-pack/test/alerting_api_integration/security_and_spaces/tests/actions/builtin_action_types/servicenow_itom.ts @@ -7,6 +7,7 @@ import httpProxy from 'http-proxy'; import expect from '@kbn/expect'; +import { asyncForEach } from '@kbn/std'; import getPort from 'get-port'; import http from 'http'; @@ -19,14 +20,7 @@ export default function serviceNowITOMTest({ getService }: FtrProviderContext) { const supertest = getService('supertest'); const configService = getService('config'); - const mockServiceNow = { - config: { - apiUrl: 'www.servicenowisinkibanaactions.com', - }, - secrets: { - password: 'elastic', - username: 'changeme', - }, + const mockServiceNowCommon = { params: { subAction: 'addEvent', subActionParams: { @@ -44,6 +38,30 @@ export default function serviceNowITOMTest({ getService }: FtrProviderContext) { }, }, }; + const mockServiceNowBasic = { + ...mockServiceNowCommon, + config: { + apiUrl: 'www.servicenowisinkibanaactions.com', + }, + secrets: { + password: 'elastic', + username: 'changeme', + }, + }; + const mockServiceNowOAuth = { + ...mockServiceNowCommon, + config: { + apiUrl: 'www.servicenowisinkibanaactions.com', + isOAuth: true, + clientId: 'abc', + userIdentifierValue: 'elastic', + jwtKeyId: 'def', + }, + secrets: { + clientSecret: 'xyz', + privateKey: '-----BEGIN RSA PRIVATE KEY-----\nddddddd\n-----END RSA PRIVATE KEY-----', + }, + }; describe('ServiceNow ITOM', () => { let simulatedActionId = ''; @@ -76,7 +94,7 @@ export default function serviceNowITOMTest({ getService }: FtrProviderContext) { }); describe('ServiceNow ITOM - Action Creation', () => { - it('should return 200 when creating a servicenow action successfully', async () => { + it('should return 200 when creating a servicenow Basic Auth connector successfully', async () => { const { body: createdAction } = await supertest .post('/api/actions/connector') .set('kbn-xsrf', 'foo') @@ -86,7 +104,7 @@ export default function serviceNowITOMTest({ getService }: FtrProviderContext) { config: { apiUrl: serviceNowSimulatorURL, }, - secrets: mockServiceNow.secrets, + secrets: mockServiceNowBasic.secrets, }) .expect(200); @@ -99,6 +117,10 @@ export default function serviceNowITOMTest({ getService }: FtrProviderContext) { is_missing_secrets: false, config: { apiUrl: serviceNowSimulatorURL, + isOAuth: false, + clientId: null, + jwtKeyId: null, + userIdentifierValue: null, }, }); @@ -115,11 +137,67 @@ export default function serviceNowITOMTest({ getService }: FtrProviderContext) { is_missing_secrets: false, config: { apiUrl: serviceNowSimulatorURL, + isOAuth: false, + clientId: null, + jwtKeyId: null, + userIdentifierValue: null, }, }); }); - it('should respond with a 400 Bad Request when creating a servicenow action with no apiUrl', async () => { + it('should return 200 when creating a servicenow OAuth connector successfully', async () => { + const { body: createdConnector } = await supertest + .post('/api/actions/connector') + .set('kbn-xsrf', 'foo') + .send({ + name: 'A servicenow action', + connector_type_id: '.servicenow-itom', + config: { + ...mockServiceNowOAuth.config, + apiUrl: serviceNowSimulatorURL, + }, + secrets: mockServiceNowOAuth.secrets, + }) + .expect(200); + + expect(createdConnector).to.eql({ + id: createdConnector.id, + is_preconfigured: false, + is_deprecated: false, + name: 'A servicenow action', + connector_type_id: '.servicenow-itom', + is_missing_secrets: false, + config: { + apiUrl: serviceNowSimulatorURL, + isOAuth: true, + clientId: mockServiceNowOAuth.config.clientId, + jwtKeyId: mockServiceNowOAuth.config.jwtKeyId, + userIdentifierValue: mockServiceNowOAuth.config.userIdentifierValue, + }, + }); + + const { body: fetchedConnector } = await supertest + .get(`/api/actions/connector/${createdConnector.id}`) + .expect(200); + + expect(fetchedConnector).to.eql({ + id: fetchedConnector.id, + is_preconfigured: false, + is_deprecated: false, + name: 'A servicenow action', + connector_type_id: '.servicenow-itom', + is_missing_secrets: false, + config: { + apiUrl: serviceNowSimulatorURL, + isOAuth: true, + clientId: mockServiceNowOAuth.config.clientId, + jwtKeyId: mockServiceNowOAuth.config.jwtKeyId, + userIdentifierValue: mockServiceNowOAuth.config.userIdentifierValue, + }, + }); + }); + + it('should respond with a 400 Bad Request when creating a servicenow Basic Auth connector with no apiUrl', async () => { await supertest .post('/api/actions/connector') .set('kbn-xsrf', 'foo') @@ -139,7 +217,30 @@ export default function serviceNowITOMTest({ getService }: FtrProviderContext) { }); }); - it('should respond with a 400 Bad Request when creating a servicenow action with a not present in allowedHosts apiUrl', async () => { + it('should respond with a 400 Bad Request when creating a servicenow OAuth connector with no apiUrl', async () => { + await supertest + .post('/api/actions/connector') + .set('kbn-xsrf', 'foo') + .send({ + name: 'A servicenow action', + connector_type_id: '.servicenow-itom', + config: { + isOAuth: true, + }, + secrets: mockServiceNowOAuth.secrets, + }) + .expect(400) + .then((resp: any) => { + expect(resp.body).to.eql({ + statusCode: 400, + error: 'Bad Request', + message: + 'error validating action type config: [apiUrl]: expected value of type [string] but got [undefined]', + }); + }); + }); + + it('should respond with a 400 Bad Request when creating a servicenow connector with a not present in allowedHosts apiUrl', async () => { await supertest .post('/api/actions/connector') .set('kbn-xsrf', 'foo') @@ -149,7 +250,7 @@ export default function serviceNowITOMTest({ getService }: FtrProviderContext) { config: { apiUrl: 'http://servicenow.mynonexistent.com', }, - secrets: mockServiceNow.secrets, + secrets: mockServiceNowBasic.secrets, }) .expect(400) .then((resp: any) => { @@ -162,7 +263,29 @@ export default function serviceNowITOMTest({ getService }: FtrProviderContext) { }); }); - it('should respond with a 400 Bad Request when creating a servicenow action without secrets', async () => { + it('should respond with a 400 Bad Request when creating a servicenow Basic Auth connector without secrets', async () => { + await supertest + .post('/api/actions/connector') + .set('kbn-xsrf', 'foo') + .send({ + name: 'A servicenow action', + connector_type_id: '.servicenow-itom', + config: { + apiUrl: serviceNowSimulatorURL, + }, + }) + .expect(400) + .then((resp: any) => { + expect(resp.body).to.eql({ + statusCode: 400, + error: 'Bad Request', + message: + 'error validating action type secrets: Either basic auth or OAuth credentials must be specified', + }); + }); + }); + + it('should respond with a 400 Bad Request when creating a servicenow OAuth connector without secrets', async () => { await supertest .post('/api/actions/connector') .set('kbn-xsrf', 'foo') @@ -170,6 +293,7 @@ export default function serviceNowITOMTest({ getService }: FtrProviderContext) { name: 'A servicenow action', connector_type_id: '.servicenow-itom', config: { + ...mockServiceNowOAuth.config, apiUrl: serviceNowSimulatorURL, }, }) @@ -179,10 +303,84 @@ export default function serviceNowITOMTest({ getService }: FtrProviderContext) { statusCode: 400, error: 'Bad Request', message: - 'error validating action type secrets: [password]: expected value of type [string] but got [undefined]', + 'error validating action type secrets: Either basic auth or OAuth credentials must be specified', }); }); }); + + it('should respond with a 400 Bad Request when creating a servicenow OAuth connector with missing fields', async () => { + const badConfigs = [ + { + config: { + ...mockServiceNowOAuth.config, + apiUrl: serviceNowSimulatorURL, + clientId: null, + }, + secrets: mockServiceNowOAuth.secrets, + errorMessage: `error validating action type config: clientId must be provided when isOAuth = true`, + }, + { + config: { + ...mockServiceNowOAuth.config, + apiUrl: serviceNowSimulatorURL, + userIdentifierValue: null, + }, + secrets: mockServiceNowOAuth.secrets, + errorMessage: `error validating action type config: userIdentifierValue must be provided when isOAuth = true`, + }, + { + config: { + ...mockServiceNowOAuth.config, + apiUrl: serviceNowSimulatorURL, + jwtKeyId: null, + }, + secrets: mockServiceNowOAuth.secrets, + errorMessage: `error validating action type config: jwtKeyId must be provided when isOAuth = true`, + }, + { + config: { + ...mockServiceNowOAuth.config, + apiUrl: serviceNowSimulatorURL, + }, + secrets: { + ...mockServiceNowOAuth.secrets, + clientSecret: null, + }, + errorMessage: `error validating action type secrets: clientSecret and privateKey must both be specified`, + }, + { + config: { + ...mockServiceNowOAuth.config, + apiUrl: serviceNowSimulatorURL, + }, + secrets: { + ...mockServiceNowOAuth.secrets, + privateKey: null, + }, + errorMessage: `error validating action type secrets: clientSecret and privateKey must both be specified`, + }, + ]; + + await asyncForEach(badConfigs, async (badConfig) => { + await supertest + .post('/api/actions/connector') + .set('kbn-xsrf', 'foo') + .send({ + name: 'A servicenow action', + connector_type_id: '.servicenow-itom', + config: badConfig.config, + secrets: badConfig.secrets, + }) + .expect(400) + .then((resp: any) => { + expect(resp.body).to.eql({ + statusCode: 400, + error: 'Bad Request', + message: badConfig.errorMessage, + }); + }); + }); + }); }); describe('ServiceNow ITOM - Executor', () => { @@ -196,7 +394,7 @@ export default function serviceNowITOMTest({ getService }: FtrProviderContext) { config: { apiUrl: serviceNowSimulatorURL, }, - secrets: mockServiceNow.secrets, + secrets: mockServiceNowBasic.secrets, }); simulatedActionId = body.id; }); @@ -284,7 +482,7 @@ export default function serviceNowITOMTest({ getService }: FtrProviderContext) { .post(`/api/actions/connector/${simulatedActionId}/_execute`) .set('kbn-xsrf', 'foo') .send({ - params: mockServiceNow.params, + params: mockServiceNowBasic.params, }) .expect(200); expect(result.status).to.eql('ok'); diff --git a/x-pack/test/alerting_api_integration/security_and_spaces/tests/actions/builtin_action_types/servicenow_itsm.ts b/x-pack/test/alerting_api_integration/security_and_spaces/tests/actions/builtin_action_types/servicenow_itsm.ts index 4cc65d7103a58..0f81753bbc731 100644 --- a/x-pack/test/alerting_api_integration/security_and_spaces/tests/actions/builtin_action_types/servicenow_itsm.ts +++ b/x-pack/test/alerting_api_integration/security_and_spaces/tests/actions/builtin_action_types/servicenow_itsm.ts @@ -7,6 +7,7 @@ import httpProxy from 'http-proxy'; import expect from '@kbn/expect'; +import { asyncForEach } from '@kbn/std'; import getPort from 'get-port'; import http from 'http'; @@ -19,15 +20,7 @@ export default function serviceNowITSMTest({ getService }: FtrProviderContext) { const supertest = getService('supertest'); const configService = getService('config'); - const mockServiceNow = { - config: { - apiUrl: 'www.servicenowisinkibanaactions.com', - usesTableApi: false, - }, - secrets: { - password: 'elastic', - username: 'changeme', - }, + const mockServiceNowCommon = { params: { subAction: 'pushToService', subActionParams: { @@ -51,6 +44,33 @@ export default function serviceNowITSMTest({ getService }: FtrProviderContext) { }, }; + const mockServiceNowBasic = { + ...mockServiceNowCommon, + config: { + apiUrl: 'www.servicenowisinkibanaactions.com', + usesTableApi: false, + }, + secrets: { + password: 'elastic', + username: 'changeme', + }, + }; + const mockServiceNowOAuth = { + ...mockServiceNowCommon, + config: { + apiUrl: 'www.servicenowisinkibanaactions.com', + usesTableApi: false, + isOAuth: true, + clientId: 'abc', + userIdentifierValue: 'elastic', + jwtKeyId: 'def', + }, + secrets: { + clientSecret: 'xyz', + privateKey: '-----BEGIN RSA PRIVATE KEY-----\nddddddd\n-----END RSA PRIVATE KEY-----', + }, + }; + describe('ServiceNow ITSM', () => { let simulatedActionId = ''; let serviceNowSimulatorURL: string = ''; @@ -82,7 +102,7 @@ export default function serviceNowITSMTest({ getService }: FtrProviderContext) { }); describe('ServiceNow ITSM - Action Creation', () => { - it('should return 200 when creating a servicenow action successfully', async () => { + it('should return 200 when creating a servicenow Basic Auth connector successfully', async () => { const { body: createdAction } = await supertest .post('/api/actions/connector') .set('kbn-xsrf', 'foo') @@ -93,7 +113,7 @@ export default function serviceNowITSMTest({ getService }: FtrProviderContext) { apiUrl: serviceNowSimulatorURL, usesTableApi: false, }, - secrets: mockServiceNow.secrets, + secrets: mockServiceNowBasic.secrets, }) .expect(200); @@ -107,6 +127,10 @@ export default function serviceNowITSMTest({ getService }: FtrProviderContext) { config: { apiUrl: serviceNowSimulatorURL, usesTableApi: false, + isOAuth: false, + clientId: null, + jwtKeyId: null, + userIdentifierValue: null, }, }); @@ -124,6 +148,64 @@ export default function serviceNowITSMTest({ getService }: FtrProviderContext) { config: { apiUrl: serviceNowSimulatorURL, usesTableApi: false, + isOAuth: false, + clientId: null, + jwtKeyId: null, + userIdentifierValue: null, + }, + }); + }); + + it('should return 200 when creating a servicenow OAuth connector successfully', async () => { + const { body: createdConnector } = await supertest + .post('/api/actions/connector') + .set('kbn-xsrf', 'foo') + .send({ + name: 'A servicenow action', + connector_type_id: '.servicenow', + config: { + ...mockServiceNowOAuth.config, + apiUrl: serviceNowSimulatorURL, + }, + secrets: mockServiceNowOAuth.secrets, + }) + .expect(200); + + expect(createdConnector).to.eql({ + id: createdConnector.id, + is_preconfigured: false, + is_deprecated: false, + name: 'A servicenow action', + connector_type_id: '.servicenow', + is_missing_secrets: false, + config: { + apiUrl: serviceNowSimulatorURL, + usesTableApi: false, + isOAuth: true, + clientId: mockServiceNowOAuth.config.clientId, + jwtKeyId: mockServiceNowOAuth.config.jwtKeyId, + userIdentifierValue: mockServiceNowOAuth.config.userIdentifierValue, + }, + }); + + const { body: fetchedConnector } = await supertest + .get(`/api/actions/connector/${createdConnector.id}`) + .expect(200); + + expect(fetchedConnector).to.eql({ + id: fetchedConnector.id, + is_preconfigured: false, + is_deprecated: false, + name: 'A servicenow action', + connector_type_id: '.servicenow', + is_missing_secrets: false, + config: { + apiUrl: serviceNowSimulatorURL, + usesTableApi: false, + isOAuth: true, + clientId: mockServiceNowOAuth.config.clientId, + jwtKeyId: mockServiceNowOAuth.config.jwtKeyId, + userIdentifierValue: mockServiceNowOAuth.config.userIdentifierValue, }, }); }); @@ -138,7 +220,7 @@ export default function serviceNowITSMTest({ getService }: FtrProviderContext) { config: { apiUrl: serviceNowSimulatorURL, }, - secrets: mockServiceNow.secrets, + secrets: mockServiceNowBasic.secrets, }) .expect(200); @@ -149,7 +231,7 @@ export default function serviceNowITSMTest({ getService }: FtrProviderContext) { expect(fetchedAction.config.usesTableApi).to.be(true); }); - it('should respond with a 400 Bad Request when creating a servicenow action with no apiUrl', async () => { + it('should respond with a 400 Bad Request when creating a servicenow Basic Auth connector with no apiUrl', async () => { await supertest .post('/api/actions/connector') .set('kbn-xsrf', 'foo') @@ -169,7 +251,30 @@ export default function serviceNowITSMTest({ getService }: FtrProviderContext) { }); }); - it('should respond with a 400 Bad Request when creating a servicenow action with a not present in allowedHosts apiUrl', async () => { + it('should respond with a 400 Bad Request when creating a servicenow OAuth connector with no apiUrl', async () => { + await supertest + .post('/api/actions/connector') + .set('kbn-xsrf', 'foo') + .send({ + name: 'A servicenow action', + connector_type_id: '.servicenow', + config: { + isOAuth: true, + }, + secrets: mockServiceNowOAuth.secrets, + }) + .expect(400) + .then((resp: any) => { + expect(resp.body).to.eql({ + statusCode: 400, + error: 'Bad Request', + message: + 'error validating action type config: [apiUrl]: expected value of type [string] but got [undefined]', + }); + }); + }); + + it('should respond with a 400 Bad Request when creating a servicenow connector with a not present in allowedHosts apiUrl', async () => { await supertest .post('/api/actions/connector') .set('kbn-xsrf', 'foo') @@ -179,7 +284,7 @@ export default function serviceNowITSMTest({ getService }: FtrProviderContext) { config: { apiUrl: 'http://servicenow.mynonexistent.com', }, - secrets: mockServiceNow.secrets, + secrets: mockServiceNowBasic.secrets, }) .expect(400) .then((resp: any) => { @@ -192,7 +297,7 @@ export default function serviceNowITSMTest({ getService }: FtrProviderContext) { }); }); - it('should respond with a 400 Bad Request when creating a servicenow action without secrets', async () => { + it('should respond with a 400 Bad Request when creating a servicenow Basic Auth connector without secrets', async () => { await supertest .post('/api/actions/connector') .set('kbn-xsrf', 'foo') @@ -209,10 +314,107 @@ export default function serviceNowITSMTest({ getService }: FtrProviderContext) { statusCode: 400, error: 'Bad Request', message: - 'error validating action type secrets: [password]: expected value of type [string] but got [undefined]', + 'error validating action type secrets: Either basic auth or OAuth credentials must be specified', }); }); }); + + it('should respond with a 400 Bad Request when creating a servicenow OAuth connector without secrets', async () => { + await supertest + .post('/api/actions/connector') + .set('kbn-xsrf', 'foo') + .send({ + name: 'A servicenow action', + connector_type_id: '.servicenow', + config: { + ...mockServiceNowOAuth.config, + apiUrl: serviceNowSimulatorURL, + }, + }) + .expect(400) + .then((resp: any) => { + expect(resp.body).to.eql({ + statusCode: 400, + error: 'Bad Request', + message: + 'error validating action type secrets: Either basic auth or OAuth credentials must be specified', + }); + }); + }); + + it('should respond with a 400 Bad Request when creating a servicenow OAuth connector with missing fields', async () => { + const badConfigs = [ + { + config: { + ...mockServiceNowOAuth.config, + apiUrl: serviceNowSimulatorURL, + clientId: null, + }, + secrets: mockServiceNowOAuth.secrets, + errorMessage: `error validating action type config: clientId must be provided when isOAuth = true`, + }, + { + config: { + ...mockServiceNowOAuth.config, + apiUrl: serviceNowSimulatorURL, + userIdentifierValue: null, + }, + secrets: mockServiceNowOAuth.secrets, + errorMessage: `error validating action type config: userIdentifierValue must be provided when isOAuth = true`, + }, + { + config: { + ...mockServiceNowOAuth.config, + apiUrl: serviceNowSimulatorURL, + jwtKeyId: null, + }, + secrets: mockServiceNowOAuth.secrets, + errorMessage: `error validating action type config: jwtKeyId must be provided when isOAuth = true`, + }, + { + config: { + ...mockServiceNowOAuth.config, + apiUrl: serviceNowSimulatorURL, + }, + secrets: { + ...mockServiceNowOAuth.secrets, + clientSecret: null, + }, + errorMessage: `error validating action type secrets: clientSecret and privateKey must both be specified`, + }, + { + config: { + ...mockServiceNowOAuth.config, + apiUrl: serviceNowSimulatorURL, + }, + secrets: { + ...mockServiceNowOAuth.secrets, + privateKey: null, + }, + errorMessage: `error validating action type secrets: clientSecret and privateKey must both be specified`, + }, + ]; + + await asyncForEach(badConfigs, async (badConfig) => { + await supertest + .post('/api/actions/connector') + .set('kbn-xsrf', 'foo') + .send({ + name: 'A servicenow action', + connector_type_id: '.servicenow', + config: badConfig.config, + secrets: badConfig.secrets, + }) + .expect(400) + .then((resp: any) => { + expect(resp.body).to.eql({ + statusCode: 400, + error: 'Bad Request', + message: badConfig.errorMessage, + }); + }); + }); + }); }); describe('ServiceNow ITSM - Executor', () => { @@ -227,7 +429,7 @@ export default function serviceNowITSMTest({ getService }: FtrProviderContext) { apiUrl: serviceNowSimulatorURL, usesTableApi: false, }, - secrets: mockServiceNow.secrets, + secrets: mockServiceNowBasic.secrets, }); simulatedActionId = body.id; }); @@ -289,7 +491,7 @@ export default function serviceNowITSMTest({ getService }: FtrProviderContext) { .set('kbn-xsrf', 'foo') .send({ params: { - ...mockServiceNow.params, + ...mockServiceNowBasic.params, subActionParams: { savedObjectId: 'success', }, @@ -312,10 +514,10 @@ export default function serviceNowITSMTest({ getService }: FtrProviderContext) { .set('kbn-xsrf', 'foo') .send({ params: { - ...mockServiceNow.params, + ...mockServiceNowBasic.params, subActionParams: { incident: { - ...mockServiceNow.params.subActionParams.incident, + ...mockServiceNowBasic.params.subActionParams.incident, short_description: 'success', }, comments: [{ comment: 'boo' }], @@ -339,10 +541,10 @@ export default function serviceNowITSMTest({ getService }: FtrProviderContext) { .set('kbn-xsrf', 'foo') .send({ params: { - ...mockServiceNow.params, + ...mockServiceNowBasic.params, subActionParams: { incident: { - ...mockServiceNow.params.subActionParams.incident, + ...mockServiceNowBasic.params.subActionParams.incident, short_description: 'success', }, comments: [{ commentId: 'success' }], @@ -393,9 +595,9 @@ export default function serviceNowITSMTest({ getService }: FtrProviderContext) { .set('kbn-xsrf', 'foo') .send({ params: { - ...mockServiceNow.params, + ...mockServiceNowBasic.params, subActionParams: { - incident: mockServiceNow.params.subActionParams.incident, + incident: mockServiceNowBasic.params.subActionParams.incident, comments: [], }, }, @@ -429,7 +631,7 @@ export default function serviceNowITSMTest({ getService }: FtrProviderContext) { apiUrl: serviceNowSimulatorURL, usesTableApi: true, }, - secrets: mockServiceNow.secrets, + secrets: mockServiceNowBasic.secrets, }); simulatedActionId = body.id; }); @@ -440,9 +642,9 @@ export default function serviceNowITSMTest({ getService }: FtrProviderContext) { .set('kbn-xsrf', 'foo') .send({ params: { - ...mockServiceNow.params, + ...mockServiceNowBasic.params, subActionParams: { - incident: mockServiceNow.params.subActionParams.incident, + incident: mockServiceNowBasic.params.subActionParams.incident, comments: [], }, }, diff --git a/x-pack/test/alerting_api_integration/security_and_spaces/tests/actions/builtin_action_types/servicenow_sir.ts b/x-pack/test/alerting_api_integration/security_and_spaces/tests/actions/builtin_action_types/servicenow_sir.ts index 305bbef7cf70a..0f5640f7edd3e 100644 --- a/x-pack/test/alerting_api_integration/security_and_spaces/tests/actions/builtin_action_types/servicenow_sir.ts +++ b/x-pack/test/alerting_api_integration/security_and_spaces/tests/actions/builtin_action_types/servicenow_sir.ts @@ -7,6 +7,7 @@ import httpProxy from 'http-proxy'; import expect from '@kbn/expect'; +import { asyncForEach } from '@kbn/std'; import getPort from 'get-port'; import http from 'http'; @@ -19,7 +20,7 @@ export default function serviceNowSIRTest({ getService }: FtrProviderContext) { const supertest = getService('supertest'); const configService = getService('config'); - const mockServiceNow = { + const mockServiceNowCommon = { config: { apiUrl: 'www.servicenowisinkibanaactions.com', usesTableApi: false, @@ -55,6 +56,33 @@ export default function serviceNowSIRTest({ getService }: FtrProviderContext) { }, }; + const mockServiceNowBasic = { + ...mockServiceNowCommon, + config: { + apiUrl: 'www.servicenowisinkibanaactions.com', + usesTableApi: false, + }, + secrets: { + password: 'elastic', + username: 'changeme', + }, + }; + const mockServiceNowOAuth = { + ...mockServiceNowCommon, + config: { + apiUrl: 'www.servicenowisinkibanaactions.com', + usesTableApi: false, + isOAuth: true, + clientId: 'abc', + userIdentifierValue: 'elastic', + jwtKeyId: 'def', + }, + secrets: { + clientSecret: 'xyz', + privateKey: '-----BEGIN RSA PRIVATE KEY-----\nddddddd\n-----END RSA PRIVATE KEY-----', + }, + }; + describe('ServiceNow SIR', () => { let simulatedActionId = ''; let serviceNowSimulatorURL: string = ''; @@ -86,7 +114,7 @@ export default function serviceNowSIRTest({ getService }: FtrProviderContext) { }); describe('ServiceNow SIR - Action Creation', () => { - it('should return 200 when creating a servicenow action successfully', async () => { + it('should return 200 when creating a servicenow Basic Auth connector successfully', async () => { const { body: createdAction } = await supertest .post('/api/actions/connector') .set('kbn-xsrf', 'foo') @@ -97,7 +125,7 @@ export default function serviceNowSIRTest({ getService }: FtrProviderContext) { apiUrl: serviceNowSimulatorURL, usesTableApi: false, }, - secrets: mockServiceNow.secrets, + secrets: mockServiceNowBasic.secrets, }) .expect(200); @@ -111,6 +139,10 @@ export default function serviceNowSIRTest({ getService }: FtrProviderContext) { config: { apiUrl: serviceNowSimulatorURL, usesTableApi: false, + isOAuth: false, + clientId: null, + jwtKeyId: null, + userIdentifierValue: null, }, }); @@ -128,6 +160,64 @@ export default function serviceNowSIRTest({ getService }: FtrProviderContext) { config: { apiUrl: serviceNowSimulatorURL, usesTableApi: false, + isOAuth: false, + clientId: null, + jwtKeyId: null, + userIdentifierValue: null, + }, + }); + }); + + it('should return 200 when creating a servicenow OAuth connector successfully', async () => { + const { body: createdConnector } = await supertest + .post('/api/actions/connector') + .set('kbn-xsrf', 'foo') + .send({ + name: 'A servicenow action', + connector_type_id: '.servicenow-sir', + config: { + ...mockServiceNowOAuth.config, + apiUrl: serviceNowSimulatorURL, + }, + secrets: mockServiceNowOAuth.secrets, + }) + .expect(200); + + expect(createdConnector).to.eql({ + id: createdConnector.id, + is_preconfigured: false, + is_deprecated: false, + name: 'A servicenow action', + connector_type_id: '.servicenow-sir', + is_missing_secrets: false, + config: { + apiUrl: serviceNowSimulatorURL, + usesTableApi: false, + isOAuth: true, + clientId: mockServiceNowOAuth.config.clientId, + jwtKeyId: mockServiceNowOAuth.config.jwtKeyId, + userIdentifierValue: mockServiceNowOAuth.config.userIdentifierValue, + }, + }); + + const { body: fetchedConnector } = await supertest + .get(`/api/actions/connector/${createdConnector.id}`) + .expect(200); + + expect(fetchedConnector).to.eql({ + id: fetchedConnector.id, + is_preconfigured: false, + is_deprecated: false, + name: 'A servicenow action', + connector_type_id: '.servicenow-sir', + is_missing_secrets: false, + config: { + apiUrl: serviceNowSimulatorURL, + usesTableApi: false, + isOAuth: true, + clientId: mockServiceNowOAuth.config.clientId, + jwtKeyId: mockServiceNowOAuth.config.jwtKeyId, + userIdentifierValue: mockServiceNowOAuth.config.userIdentifierValue, }, }); }); @@ -142,7 +232,7 @@ export default function serviceNowSIRTest({ getService }: FtrProviderContext) { config: { apiUrl: serviceNowSimulatorURL, }, - secrets: mockServiceNow.secrets, + secrets: mockServiceNowBasic.secrets, }) .expect(200); @@ -153,7 +243,7 @@ export default function serviceNowSIRTest({ getService }: FtrProviderContext) { expect(fetchedAction.config.usesTableApi).to.be(true); }); - it('should respond with a 400 Bad Request when creating a servicenow action with no apiUrl', async () => { + it('should respond with a 400 Bad Request when creating a servicenow Basic Auth connector with no apiUrl', async () => { await supertest .post('/api/actions/connector') .set('kbn-xsrf', 'foo') @@ -173,7 +263,30 @@ export default function serviceNowSIRTest({ getService }: FtrProviderContext) { }); }); - it('should respond with a 400 Bad Request when creating a servicenow action with a not present in allowedHosts apiUrl', async () => { + it('should respond with a 400 Bad Request when creating a servicenow OAuth connector with no apiUrl', async () => { + await supertest + .post('/api/actions/connector') + .set('kbn-xsrf', 'foo') + .send({ + name: 'A servicenow action', + connector_type_id: '.servicenow-sir', + config: { + isOAuth: true, + }, + secrets: mockServiceNowOAuth.secrets, + }) + .expect(400) + .then((resp: any) => { + expect(resp.body).to.eql({ + statusCode: 400, + error: 'Bad Request', + message: + 'error validating action type config: [apiUrl]: expected value of type [string] but got [undefined]', + }); + }); + }); + + it('should respond with a 400 Bad Request when creating a servicenow connector with a not present in allowedHosts apiUrl', async () => { await supertest .post('/api/actions/connector') .set('kbn-xsrf', 'foo') @@ -183,7 +296,7 @@ export default function serviceNowSIRTest({ getService }: FtrProviderContext) { config: { apiUrl: 'http://servicenow.mynonexistent.com', }, - secrets: mockServiceNow.secrets, + secrets: mockServiceNowBasic.secrets, }) .expect(400) .then((resp: any) => { @@ -196,7 +309,7 @@ export default function serviceNowSIRTest({ getService }: FtrProviderContext) { }); }); - it('should respond with a 400 Bad Request when creating a servicenow action without secrets', async () => { + it('should respond with a 400 Bad Request when creating a servicenow Basic Auth connector without secrets', async () => { await supertest .post('/api/actions/connector') .set('kbn-xsrf', 'foo') @@ -213,10 +326,107 @@ export default function serviceNowSIRTest({ getService }: FtrProviderContext) { statusCode: 400, error: 'Bad Request', message: - 'error validating action type secrets: [password]: expected value of type [string] but got [undefined]', + 'error validating action type secrets: Either basic auth or OAuth credentials must be specified', }); }); }); + + it('should respond with a 400 Bad Request when creating a servicenow OAuth connector without secrets', async () => { + await supertest + .post('/api/actions/connector') + .set('kbn-xsrf', 'foo') + .send({ + name: 'A servicenow action', + connector_type_id: '.servicenow-sir', + config: { + ...mockServiceNowOAuth.config, + apiUrl: serviceNowSimulatorURL, + }, + }) + .expect(400) + .then((resp: any) => { + expect(resp.body).to.eql({ + statusCode: 400, + error: 'Bad Request', + message: + 'error validating action type secrets: Either basic auth or OAuth credentials must be specified', + }); + }); + }); + + it('should respond with a 400 Bad Request when creating a servicenow OAuth connector with missing fields', async () => { + const badConfigs = [ + { + config: { + ...mockServiceNowOAuth.config, + apiUrl: serviceNowSimulatorURL, + clientId: null, + }, + secrets: mockServiceNowOAuth.secrets, + errorMessage: `error validating action type config: clientId must be provided when isOAuth = true`, + }, + { + config: { + ...mockServiceNowOAuth.config, + apiUrl: serviceNowSimulatorURL, + userIdentifierValue: null, + }, + secrets: mockServiceNowOAuth.secrets, + errorMessage: `error validating action type config: userIdentifierValue must be provided when isOAuth = true`, + }, + { + config: { + ...mockServiceNowOAuth.config, + apiUrl: serviceNowSimulatorURL, + jwtKeyId: null, + }, + secrets: mockServiceNowOAuth.secrets, + errorMessage: `error validating action type config: jwtKeyId must be provided when isOAuth = true`, + }, + { + config: { + ...mockServiceNowOAuth.config, + apiUrl: serviceNowSimulatorURL, + }, + secrets: { + ...mockServiceNowOAuth.secrets, + clientSecret: null, + }, + errorMessage: `error validating action type secrets: clientSecret and privateKey must both be specified`, + }, + { + config: { + ...mockServiceNowOAuth.config, + apiUrl: serviceNowSimulatorURL, + }, + secrets: { + ...mockServiceNowOAuth.secrets, + privateKey: null, + }, + errorMessage: `error validating action type secrets: clientSecret and privateKey must both be specified`, + }, + ]; + + await asyncForEach(badConfigs, async (badConfig) => { + await supertest + .post('/api/actions/connector') + .set('kbn-xsrf', 'foo') + .send({ + name: 'A servicenow action', + connector_type_id: '.servicenow-sir', + config: badConfig.config, + secrets: badConfig.secrets, + }) + .expect(400) + .then((resp: any) => { + expect(resp.body).to.eql({ + statusCode: 400, + error: 'Bad Request', + message: badConfig.errorMessage, + }); + }); + }); + }); }); describe('ServiceNow SIR - Executor', () => { @@ -230,8 +440,9 @@ export default function serviceNowSIRTest({ getService }: FtrProviderContext) { config: { apiUrl: serviceNowSimulatorURL, usesTableApi: false, + isOAuth: false, }, - secrets: mockServiceNow.secrets, + secrets: mockServiceNowBasic.secrets, }); simulatedActionId = body.id; }); @@ -293,7 +504,7 @@ export default function serviceNowSIRTest({ getService }: FtrProviderContext) { .set('kbn-xsrf', 'foo') .send({ params: { - ...mockServiceNow.params, + ...mockServiceNowBasic.params, subActionParams: { savedObjectId: 'success', }, @@ -316,10 +527,10 @@ export default function serviceNowSIRTest({ getService }: FtrProviderContext) { .set('kbn-xsrf', 'foo') .send({ params: { - ...mockServiceNow.params, + ...mockServiceNowBasic.params, subActionParams: { incident: { - ...mockServiceNow.params.subActionParams.incident, + ...mockServiceNowBasic.params.subActionParams.incident, short_description: 'success', }, comments: [{ comment: 'boo' }], @@ -343,10 +554,10 @@ export default function serviceNowSIRTest({ getService }: FtrProviderContext) { .set('kbn-xsrf', 'foo') .send({ params: { - ...mockServiceNow.params, + ...mockServiceNowBasic.params, subActionParams: { incident: { - ...mockServiceNow.params.subActionParams.incident, + ...mockServiceNowBasic.params.subActionParams.incident, short_description: 'success', }, comments: [{ commentId: 'success' }], @@ -397,9 +608,9 @@ export default function serviceNowSIRTest({ getService }: FtrProviderContext) { .set('kbn-xsrf', 'foo') .send({ params: { - ...mockServiceNow.params, + ...mockServiceNowBasic.params, subActionParams: { - incident: mockServiceNow.params.subActionParams.incident, + incident: mockServiceNowBasic.params.subActionParams.incident, comments: [], }, }, @@ -433,7 +644,7 @@ export default function serviceNowSIRTest({ getService }: FtrProviderContext) { apiUrl: serviceNowSimulatorURL, usesTableApi: true, }, - secrets: mockServiceNow.secrets, + secrets: mockServiceNowBasic.secrets, }); simulatedActionId = body.id; }); @@ -444,9 +655,9 @@ export default function serviceNowSIRTest({ getService }: FtrProviderContext) { .set('kbn-xsrf', 'foo') .send({ params: { - ...mockServiceNow.params, + ...mockServiceNowBasic.params, subActionParams: { - incident: mockServiceNow.params.subActionParams.incident, + incident: mockServiceNowBasic.params.subActionParams.incident, comments: [], }, }, diff --git a/x-pack/test/alerting_api_integration/security_and_spaces/tests/actions/execute.ts b/x-pack/test/alerting_api_integration/security_and_spaces/tests/actions/execute.ts index 321d14683ee2f..c8433ac60575f 100644 --- a/x-pack/test/alerting_api_integration/security_and_spaces/tests/actions/execute.ts +++ b/x-pack/test/alerting_api_integration/security_and_spaces/tests/actions/execute.ts @@ -6,7 +6,7 @@ */ import expect from '@kbn/expect'; -import { IValidatedEvent } from '@kbn/event-log-plugin/server'; +import { IValidatedEvent, nanosToMillis } from '@kbn/event-log-plugin/server'; import { UserAtSpaceScenarios } from '../../scenarios'; import { ESTestIndexTool, @@ -17,8 +17,6 @@ import { } from '../../../common/lib'; import { FtrProviderContext } from '../../../common/ftr_provider_context'; -const NANOS_IN_MILLIS = 1000 * 1000; - // eslint-disable-next-line import/no-default-export export default function ({ getService }: FtrProviderContext) { const supertest = getService('supertest'); @@ -538,14 +536,12 @@ export default function ({ getService }: FtrProviderContext) { const executeEventEnd = Date.parse(executeEvent?.event?.end || 'undefined'); const dateNow = Date.now(); - expect(typeof duration).to.be('number'); + expect(typeof duration).to.be('string'); expect(executeEventStart).to.be.ok(); expect(startExecuteEventStart).to.equal(executeEventStart); expect(executeEventEnd).to.be.ok(); - const durationDiff = Math.abs( - Math.round(duration! / NANOS_IN_MILLIS) - (executeEventEnd - executeEventStart) - ); + const durationDiff = Math.abs(nanosToMillis(duration!) - (executeEventEnd - executeEventStart)); // account for rounding errors expect(durationDiff < 1).to.equal(true); diff --git a/x-pack/test/alerting_api_integration/security_and_spaces/tests/alerting/alerts.ts b/x-pack/test/alerting_api_integration/security_and_spaces/tests/alerting/alerts.ts index 601efa34341cb..407d6467296e4 100644 --- a/x-pack/test/alerting_api_integration/security_and_spaces/tests/alerting/alerts.ts +++ b/x-pack/test/alerting_api_integration/security_and_spaces/tests/alerting/alerts.ts @@ -8,7 +8,7 @@ import expect from '@kbn/expect'; import { omit } from 'lodash'; import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; -import { IValidatedEvent } from '@kbn/event-log-plugin/server'; +import { IValidatedEvent, nanosToMillis } from '@kbn/event-log-plugin/server'; import { TaskRunning, TaskRunningStage } from '@kbn/task-manager-plugin/server/task_running'; import { ConcreteTaskInstance } from '@kbn/task-manager-plugin/server'; import { UserAtSpaceScenarios, Superuser } from '../../scenarios'; @@ -25,8 +25,6 @@ import { getEventLog, } from '../../../common/lib'; -const NANOS_IN_MILLIS = 1000 * 1000; - // eslint-disable-next-line import/no-default-export export default function alertTests({ getService }: FtrProviderContext) { const supertest = getService('supertest'); @@ -1303,13 +1301,11 @@ instanceStateValue: true const eventEnd = Date.parse(event?.event?.end || 'undefined'); const dateNow = Date.now(); - expect(typeof duration).to.be('number'); + expect(typeof duration).to.be('string'); expect(eventStart).to.be.ok(); expect(eventEnd).to.be.ok(); - const durationDiff = Math.abs( - Math.round(duration! / NANOS_IN_MILLIS) - (eventEnd - eventStart) - ); + const durationDiff = Math.abs(nanosToMillis(duration!) - (eventEnd - eventStart)); // account for rounding errors expect(durationDiff < 1).to.equal(true); diff --git a/x-pack/test/alerting_api_integration/spaces_only/tests/actions/execute.ts b/x-pack/test/alerting_api_integration/spaces_only/tests/actions/execute.ts index 06e077f4b9de4..24c6427fdf2f6 100644 --- a/x-pack/test/alerting_api_integration/spaces_only/tests/actions/execute.ts +++ b/x-pack/test/alerting_api_integration/spaces_only/tests/actions/execute.ts @@ -6,7 +6,7 @@ */ import type { Client } from '@elastic/elasticsearch'; import expect from '@kbn/expect'; -import { IValidatedEvent } from '@kbn/event-log-plugin/server'; +import { IValidatedEvent, nanosToMillis } from '@kbn/event-log-plugin/server'; import { Spaces } from '../../scenarios'; import { ESTestIndexTool, @@ -17,8 +17,6 @@ import { } from '../../../common/lib'; import { FtrProviderContext } from '../../../common/ftr_provider_context'; -const NANOS_IN_MILLIS = 1000 * 1000; - // eslint-disable-next-line import/no-default-export export default function ({ getService }: FtrProviderContext) { const supertest = getService('supertest'); @@ -372,14 +370,12 @@ export default function ({ getService }: FtrProviderContext) { const executeEventEnd = Date.parse(executeEvent?.event?.end || 'undefined'); const dateNow = Date.now(); - expect(typeof duration).to.be('number'); + expect(typeof duration).to.be('string'); expect(executeEventStart).to.be.ok(); expect(startExecuteEventStart).to.equal(executeEventStart); expect(executeEventEnd).to.be.ok(); - const durationDiff = Math.abs( - Math.round(duration! / NANOS_IN_MILLIS) - (executeEventEnd - executeEventStart) - ); + const durationDiff = Math.abs(nanosToMillis(duration!) - (executeEventEnd - executeEventStart)); // account for rounding errors expect(durationDiff < 1).to.equal(true); diff --git a/x-pack/test/alerting_api_integration/spaces_only/tests/actions/migrations.ts b/x-pack/test/alerting_api_integration/spaces_only/tests/actions/migrations.ts index 7b28161c18238..4f23a5ff3a727 100644 --- a/x-pack/test/alerting_api_integration/spaces_only/tests/actions/migrations.ts +++ b/x-pack/test/alerting_api_integration/spaces_only/tests/actions/migrations.ts @@ -6,6 +6,7 @@ */ import expect from '@kbn/expect'; +import { asyncForEach } from '@kbn/std'; import { getUrlPrefix } from '../../../common/lib'; import { FtrProviderContext } from '../../../common/ftr_provider_context'; @@ -83,6 +84,23 @@ export default function createGetTests({ getService }: FtrProviderContext) { expect(connectorWithoutService.body.config.service).to.eql('other'); }); + it('8.3.0 migrates service now connectors to have `isOAuth` property', async () => { + const serviceNowConnectorIds = [ + '7d04bc30-c4c0-11ec-ae29-917aa31a5b75', + '8a9331b0-c4c0-11ec-ae29-917aa31a5b75', + '6d3a1250-c4c0-11ec-ae29-917aa31a5b75', + ]; + + await asyncForEach(serviceNowConnectorIds, async (serviceNowConnectorId) => { + const connectorResponse = await supertest.get( + `${getUrlPrefix(``)}/api/actions/action/${serviceNowConnectorId}` + ); + + expect(connectorResponse.status).to.eql(200); + expect(connectorResponse.body.config.isOAuth).to.eql(false); + }); + }); + it('decryption error during migration', async () => { const badEmailConnector = await supertest.get( `${getUrlPrefix(``)}/api/actions/connector/0f8f2810-0a59-11ec-9a7c-fd0c2b83ff7d` diff --git a/x-pack/test/alerting_api_integration/spaces_only/tests/alerting/event_log.ts b/x-pack/test/alerting_api_integration/spaces_only/tests/alerting/event_log.ts index 5777b4978894f..bc382e5d733dd 100644 --- a/x-pack/test/alerting_api_integration/spaces_only/tests/alerting/event_log.ts +++ b/x-pack/test/alerting_api_integration/spaces_only/tests/alerting/event_log.ts @@ -7,7 +7,7 @@ import expect from '@kbn/expect'; import uuid from 'uuid'; -import { IValidatedEvent } from '@kbn/event-log-plugin/server'; +import { IValidatedEvent, nanosToMillis } from '@kbn/event-log-plugin/server'; import { Spaces } from '../../scenarios'; import { getUrlPrefix, @@ -18,8 +18,6 @@ import { } from '../../../common/lib'; import { FtrProviderContext } from '../../../common/ftr_provider_context'; -const NANOS_IN_MILLIS = 1000 * 1000; - // eslint-disable-next-line import/no-default-export export default function eventLogTests({ getService }: FtrProviderContext) { const supertest = getService('supertest'); @@ -403,10 +401,12 @@ export default function eventLogTests({ getService }: FtrProviderContext) { expect(event?.kibana?.alert?.rule?.execution?.metrics?.number_of_searches).to.be( numSearches ); - const esSearchDuration = - event?.kibana?.alert?.rule?.execution?.metrics?.es_search_duration_ms; - const totalSearchDuration = - event?.kibana?.alert?.rule?.execution?.metrics?.total_search_duration_ms; + const esSearchDuration = Number( + event?.kibana?.alert?.rule?.execution?.metrics?.es_search_duration_ms + ); + const totalSearchDuration = Number( + event?.kibana?.alert?.rule?.execution?.metrics?.total_search_duration_ms + ); expect(esSearchDuration).not.to.be(undefined); expect(totalSearchDuration).not.to.be(undefined); @@ -861,15 +861,13 @@ export function validateEvent(event: IValidatedEvent, params: ValidateEventLogPa const dateNow = Date.now(); if (duration !== undefined) { - expect(typeof duration).to.be('number'); + expect(typeof duration).to.be('string'); expect(eventStart).to.be.ok(); if (shouldHaveEventEnd !== false) { expect(eventEnd).to.be.ok(); - const durationDiff = Math.abs( - Math.round(duration! / NANOS_IN_MILLIS) - (eventEnd - eventStart) - ); + const durationDiff = Math.abs(nanosToMillis(duration!) - (eventEnd - eventStart)); // account for rounding errors expect(durationDiff < 1).to.equal(true); diff --git a/x-pack/test/alerting_api_integration/spaces_only/tests/alerting/event_log_alerts.ts b/x-pack/test/alerting_api_integration/spaces_only/tests/alerting/event_log_alerts.ts index c65ffb1bef5ac..46da0e597e66a 100644 --- a/x-pack/test/alerting_api_integration/spaces_only/tests/alerting/event_log_alerts.ts +++ b/x-pack/test/alerting_api_integration/spaces_only/tests/alerting/event_log_alerts.ts @@ -6,7 +6,7 @@ */ import expect from '@kbn/expect'; -import { IValidatedEvent } from '@kbn/event-log-plugin/server'; +import { IValidatedEvent, nanosToMillis } from '@kbn/event-log-plugin/server'; import { Spaces } from '../../scenarios'; import { getUrlPrefix, getTestRuleData, ObjectRemover, getEventLog } from '../../../common/lib'; import { FtrProviderContext } from '../../../common/ftr_provider_context'; @@ -91,7 +91,7 @@ export default function eventLogAlertTests({ getService }: FtrProviderContext) { const currentAlertSpan: { alertId?: string; start?: string; - durationToDate?: number; + durationToDate?: string; } = {}; for (let i = 0; i < instanceEvents.length; ++i) { switch (instanceEvents[i]?.event?.action) { @@ -102,7 +102,7 @@ export default function eventLogAlertTests({ getService }: FtrProviderContext) { currentAlertSpan.alertId = instanceEvents[i]?.kibana?.alerting?.instance_id; currentAlertSpan.start = instanceEvents[i]?.event?.start; - currentAlertSpan.durationToDate = instanceEvents[i]?.event?.duration; + currentAlertSpan.durationToDate = `${instanceEvents[i]?.event?.duration}`; break; case 'active-instance': @@ -110,12 +110,13 @@ export default function eventLogAlertTests({ getService }: FtrProviderContext) { expect(instanceEvents[i]?.event?.start).to.equal(currentAlertSpan.start); expect(instanceEvents[i]?.event?.end).to.be(undefined); - if (instanceEvents[i]?.event?.duration! !== 0) { - expect(instanceEvents[i]?.event?.duration! > currentAlertSpan.durationToDate!).to.be( - true - ); + if (instanceEvents[i]?.event?.duration! !== '0') { + expect( + BigInt(instanceEvents[i]?.event?.duration!) > + BigInt(currentAlertSpan.durationToDate!) + ).to.be(true); } - currentAlertSpan.durationToDate = instanceEvents[i]?.event?.duration; + currentAlertSpan.durationToDate = `${instanceEvents[i]?.event?.duration}`; break; case 'recovered-instance': @@ -125,7 +126,7 @@ export default function eventLogAlertTests({ getService }: FtrProviderContext) { expect( new Date(instanceEvents[i]?.event?.end!).valueOf() - new Date(instanceEvents[i]?.event?.start!).valueOf() - ).to.equal(instanceEvents[i]?.event?.duration! / 1000 / 1000); + ).to.equal(nanosToMillis(instanceEvents[i]?.event?.duration!)); break; } } diff --git a/x-pack/test/apm_api_integration/tests/suggestions/suggestions.spec.ts b/x-pack/test/apm_api_integration/tests/suggestions/suggestions.spec.ts index 74bdc860bfba3..692cd1c0cf7f1 100644 --- a/x-pack/test/apm_api_integration/tests/suggestions/suggestions.spec.ts +++ b/x-pack/test/apm_api_integration/tests/suggestions/suggestions.spec.ts @@ -9,12 +9,14 @@ import { SERVICE_NAME, TRANSACTION_TYPE, } from '@kbn/apm-plugin/common/elasticsearch_fieldnames'; +import archives_metadata from '../../common/fixtures/es_archiver/archives_metadata'; import { FtrProviderContext } from '../../common/ftr_provider_context'; export default function suggestionsTests({ getService }: FtrProviderContext) { const registry = getService('registry'); const apmApiClient = getService('apmApiClient'); const archiveName = 'apm_8.0.0'; + const { start, end } = archives_metadata[archiveName]; registry.when( 'suggestions when data is loaded', @@ -25,7 +27,7 @@ export default function suggestionsTests({ getService }: FtrProviderContext) { it('returns all environments', async () => { const { body } = await apmApiClient.readUser({ endpoint: 'GET /internal/apm/suggestions', - params: { query: { field: SERVICE_ENVIRONMENT, string: '' } }, + params: { query: { fieldName: SERVICE_ENVIRONMENT, fieldValue: '', start, end } }, }); expectSnapshot(body).toMatchInline(` @@ -43,7 +45,7 @@ export default function suggestionsTests({ getService }: FtrProviderContext) { it('returns items matching the string parameter', async () => { const { body } = await apmApiClient.readUser({ endpoint: 'GET /internal/apm/suggestions', - params: { query: { field: SERVICE_ENVIRONMENT, string: 'pr' } }, + params: { query: { fieldName: SERVICE_ENVIRONMENT, fieldValue: 'pr', start, end } }, }); expectSnapshot(body).toMatchInline(` @@ -62,7 +64,7 @@ export default function suggestionsTests({ getService }: FtrProviderContext) { it('returns all services', async () => { const { body } = await apmApiClient.readUser({ endpoint: 'GET /internal/apm/suggestions', - params: { query: { field: SERVICE_NAME, string: '' } }, + params: { query: { fieldName: SERVICE_NAME, fieldValue: '', start, end } }, }); expectSnapshot(body).toMatchInline(` @@ -86,7 +88,7 @@ export default function suggestionsTests({ getService }: FtrProviderContext) { it('returns items matching the string parameter', async () => { const { body } = await apmApiClient.readUser({ endpoint: 'GET /internal/apm/suggestions', - params: { query: { field: SERVICE_NAME, string: 'aud' } }, + params: { query: { fieldName: SERVICE_NAME, fieldValue: 'aud', start, end } }, }); expectSnapshot(body).toMatchInline(` @@ -105,7 +107,7 @@ export default function suggestionsTests({ getService }: FtrProviderContext) { it('returns all transaction types', async () => { const { body } = await apmApiClient.readUser({ endpoint: 'GET /internal/apm/suggestions', - params: { query: { field: TRANSACTION_TYPE, string: '' } }, + params: { query: { fieldName: TRANSACTION_TYPE, fieldValue: '', start, end } }, }); expectSnapshot(body).toMatchInline(` @@ -125,7 +127,7 @@ export default function suggestionsTests({ getService }: FtrProviderContext) { it('returns items matching the string parameter', async () => { const { body } = await apmApiClient.readUser({ endpoint: 'GET /internal/apm/suggestions', - params: { query: { field: TRANSACTION_TYPE, string: 'w' } }, + params: { query: { fieldName: TRANSACTION_TYPE, fieldValue: 'w', start, end } }, }); expectSnapshot(body).toMatchInline(` diff --git a/x-pack/test/cases_api_integration/common/lib/utils.ts b/x-pack/test/cases_api_integration/common/lib/utils.ts index 7714c85b11d9a..bb8f31abefd47 100644 --- a/x-pack/test/cases_api_integration/common/lib/utils.ts +++ b/x-pack/test/cases_api_integration/common/lib/utils.ts @@ -48,9 +48,10 @@ import { ConnectorMappings, CasesByAlertId, CaseResolveResponse, - CaseMetricsResponse, + SingleCaseMetricsResponse, BulkCreateCommentRequest, CommentType, + CasesMetricsResponse, } from '@kbn/cases-plugin/common/api'; import { getCaseUserActionUrl } from '@kbn/cases-plugin/common/api/helpers'; import { SignalHit } from '@kbn/security-solution-plugin/server/lib/detection_engine/signals/types'; @@ -217,6 +218,23 @@ export const getServiceNowConnector = () => ({ }, }); +export const getServiceNowOAuthConnector = () => ({ + name: 'ServiceNow OAuth Connector', + connector_type_id: '.servicenow', + secrets: { + clientSecret: 'xyz', + privateKey: '-----BEGIN RSA PRIVATE KEY-----\nddddddd\n-----END RSA PRIVATE KEY-----', + }, + config: { + apiUrl: 'http://some.non.existent.com', + usesTableApi: false, + isOAuth: true, + clientId: 'abc', + userIdentifierValue: 'elastic', + jwtKeyId: 'def', + }, +}); + export const getJiraConnector = () => ({ name: 'Jira Connector', connector_type_id: '.jira', @@ -262,7 +280,7 @@ export const getResilientConnector = () => ({ }); export const getServiceNowSIRConnector = () => ({ - name: 'ServiceNow Connector', + name: 'ServiceNow SIR Connector', connector_type_id: '.servicenow-sir', secrets: { username: 'admin', @@ -995,7 +1013,7 @@ export const getCaseMetrics = async ({ features: string[]; expectedHttpCode?: number; auth?: { user: User; space: string | null }; -}): Promise => { +}): Promise => { const { body: metricsResponse } = await supertest .get(`${getSpaceUrlPrefix(auth?.space)}${CASES_URL}/metrics/${caseId}`) .query({ features: JSON.stringify(features) }) @@ -1250,3 +1268,25 @@ export const calculateDuration = (closedAt: string | null, createdAt: string | n return Math.floor(Math.abs((closedAtMillis - createdAtMillis) / 1000)); }; + +export const getCasesMetrics = async ({ + supertest, + features, + query = {}, + expectedHttpCode = 200, + auth = { user: superUser, space: null }, +}: { + supertest: SuperTest.SuperTest; + features: string[]; + query?: Record; + expectedHttpCode?: number; + auth?: { user: User; space: string | null }; +}): Promise => { + const { body: metricsResponse } = await supertest + .get(`${getSpaceUrlPrefix(auth?.space)}${CASES_URL}/metrics`) + .query({ features: JSON.stringify(features), ...query }) + .auth(auth.user.username, auth.user.password) + .expect(expectedHttpCode); + + return metricsResponse; +}; diff --git a/x-pack/test/cases_api_integration/security_and_spaces/tests/common/index.ts b/x-pack/test/cases_api_integration/security_and_spaces/tests/common/index.ts index 25f39164f7c28..93bb948265ba0 100644 --- a/x-pack/test/cases_api_integration/security_and_spaces/tests/common/index.ts +++ b/x-pack/test/cases_api_integration/security_and_spaces/tests/common/index.ts @@ -37,6 +37,7 @@ export default ({ loadTestFile }: FtrProviderContext): void => { loadTestFile(require.resolve('./metrics/get_case_metrics_alerts')); loadTestFile(require.resolve('./metrics/get_case_metrics_actions')); loadTestFile(require.resolve('./metrics/get_case_metrics_connectors')); + loadTestFile(require.resolve('./metrics/get_cases_metrics')); /** * Internal routes diff --git a/x-pack/test/cases_api_integration/security_and_spaces/tests/common/metrics/get_cases_metrics.ts b/x-pack/test/cases_api_integration/security_and_spaces/tests/common/metrics/get_cases_metrics.ts new file mode 100644 index 0000000000000..c1abfada39dd2 --- /dev/null +++ b/x-pack/test/cases_api_integration/security_and_spaces/tests/common/metrics/get_cases_metrics.ts @@ -0,0 +1,233 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import expect from '@kbn/expect'; +import { CaseStatuses } from '@kbn/cases-plugin/common/api'; +import { + secOnly, + obsOnlyRead, + secOnlyRead, + noKibanaPrivileges, + superUser, + globalRead, + obsSecRead, + obsSec, +} from '../../../../common/lib/authentication/users'; +import { FtrProviderContext } from '../../../../common/ftr_provider_context'; +import { + createCase, + deleteAllCaseItems, + getCasesMetrics, + updateCase, +} from '../../../../common/lib/utils'; +import { getPostCaseRequest } from '../../../../common/lib/mock'; + +// eslint-disable-next-line import/no-default-export +export default ({ getService }: FtrProviderContext): void => { + const es = getService('es'); + const supertest = getService('supertest'); + const supertestWithoutAuth = getService('supertestWithoutAuth'); + const kibanaServer = getService('kibanaServer'); + + describe('all cases metrics', () => { + describe('MTTR', () => { + it('responses with zero if there are no cases', async () => { + const metrics = await getCasesMetrics({ + supertest, + features: ['mttr'], + }); + + expect(metrics).to.eql({ mttr: 0 }); + }); + + it('responses with zero if there are only open case and in-progress cases', async () => { + await createCase(supertest, getPostCaseRequest()); + const theCase = await createCase(supertest, getPostCaseRequest()); + + await updateCase({ + supertest, + params: { + cases: [ + { + id: theCase.id, + version: theCase.version, + status: CaseStatuses['in-progress'], + }, + ], + }, + }); + + const metrics = await getCasesMetrics({ + supertest, + features: ['mttr'], + }); + + expect(metrics).to.eql({ mttr: 0 }); + }); + + describe('closed and open cases from kbn archive', () => { + before(async () => { + await kibanaServer.importExport.load( + 'x-pack/test/functional/fixtures/kbn_archiver/cases/8.3.0/all_cases_metrics.json' + ); + }); + + after(async () => { + await kibanaServer.importExport.unload( + 'x-pack/test/functional/fixtures/kbn_archiver/cases/8.3.0/all_cases_metrics.json' + ); + await deleteAllCaseItems(es); + }); + + it('should calculate the mttr correctly across all cases', async () => { + const metrics = await getCasesMetrics({ + supertest, + features: ['mttr'], + }); + + expect(metrics).to.eql({ mttr: 220 }); + }); + + it('should respects the range parameters', async () => { + const metrics = await getCasesMetrics({ + supertest, + features: ['mttr'], + query: { + from: '2022-04-28', + to: '2022-04-29', + }, + }); + + expect(metrics).to.eql({ mttr: 90 }); + }); + }); + }); + + describe('rbac', () => { + before(async () => { + await kibanaServer.importExport.load( + 'x-pack/test/functional/fixtures/kbn_archiver/cases/8.3.0/all_cases_metrics.json', + { space: 'space1' } + ); + }); + + after(async () => { + await kibanaServer.importExport.unload( + 'x-pack/test/functional/fixtures/kbn_archiver/cases/8.3.0/all_cases_metrics.json', + { space: 'space1' } + ); + await deleteAllCaseItems(es); + }); + + it('should calculate the mttr correctly only for the cases the user has access to', async () => { + for (const scenario of [ + { + user: globalRead, + expectedMetrics: { mttr: 220 }, + owners: ['securitySolutionFixture', 'observabilityFixture'], + }, + { + user: superUser, + expectedMetrics: { mttr: 220 }, + owners: ['securitySolutionFixture', 'observabilityFixture'], + }, + { + user: secOnlyRead, + expectedMetrics: { mttr: 250 }, + owners: ['securitySolutionFixture'], + }, + { user: obsOnlyRead, expectedMetrics: { mttr: 160 }, owners: ['observabilityFixture'] }, + { + user: obsSecRead, + expectedMetrics: { mttr: 220 }, + owners: ['securitySolutionFixture', 'observabilityFixture'], + }, + ]) { + const metrics = await getCasesMetrics({ + supertest: supertestWithoutAuth, + features: ['mttr'], + auth: { + user: scenario.user, + space: 'space1', + }, + }); + + expect(metrics).to.eql(scenario.expectedMetrics); + } + }); + + for (const scenario of [ + { user: noKibanaPrivileges, space: 'space1' }, + { user: secOnly, space: 'space2' }, + ]) { + it(`User ${scenario.user.username} with role(s) ${scenario.user.roles.join()} and space ${ + scenario.space + } - should NOT read a case`, async () => { + // user should not be able to read cases at the appropriate space + await getCasesMetrics({ + supertest: supertestWithoutAuth, + features: ['mttr'], + auth: { + user: scenario.user, + space: scenario.space, + }, + expectedHttpCode: 403, + }); + }); + } + + it('should respect the owner filter when having permissions', async () => { + const metrics = await getCasesMetrics({ + supertest: supertestWithoutAuth, + features: ['mttr'], + query: { + owner: 'securitySolutionFixture', + }, + auth: { + user: obsSec, + space: 'space1', + }, + }); + + expect(metrics).to.eql({ mttr: 250 }); + }); + + it('should return the correct cases when trying to exploit RBAC through the owner query parameter', async () => { + const metrics = await getCasesMetrics({ + supertest: supertestWithoutAuth, + features: ['mttr'], + query: { + owner: ['securitySolutionFixture', 'observabilityFixture'], + }, + auth: { + user: secOnly, + space: 'space1', + }, + }); + + expect(metrics).to.eql({ mttr: 250 }); + }); + + it('should respect the owner filter when using range queries', async () => { + const metrics = await getCasesMetrics({ + supertest: supertestWithoutAuth, + features: ['mttr'], + query: { + from: '2022-04-20', + to: '2022-04-30', + }, + auth: { + user: secOnly, + space: 'space1', + }, + }); + + expect(metrics).to.eql({ mttr: 250 }); + }); + }); + }); +}; diff --git a/x-pack/test/cases_api_integration/security_and_spaces/tests/trial/configure/get_connectors.ts b/x-pack/test/cases_api_integration/security_and_spaces/tests/trial/configure/get_connectors.ts index 26df77bfbc924..de72e0f343026 100644 --- a/x-pack/test/cases_api_integration/security_and_spaces/tests/trial/configure/get_connectors.ts +++ b/x-pack/test/cases_api_integration/security_and_spaces/tests/trial/configure/get_connectors.ts @@ -11,6 +11,7 @@ import { FtrProviderContext } from '../../../../../common/ftr_provider_context'; import { ObjectRemover as ActionsRemover } from '../../../../../alerting_api_integration/common/lib'; import { getServiceNowConnector, + getServiceNowOAuthConnector, getJiraConnector, getResilientConnector, createConnector, @@ -31,6 +32,10 @@ export default ({ getService }: FtrProviderContext): void => { it('should return the correct connectors', async () => { const snConnector = await createConnector({ supertest, req: getServiceNowConnector() }); + const snOAuthConnector = await createConnector({ + supertest, + req: getServiceNowOAuthConnector(), + }); const emailConnector = await createConnector({ supertest, req: getEmailConnector() }); const jiraConnector = await createConnector({ supertest, req: getJiraConnector() }); const resilientConnector = await createConnector({ supertest, req: getResilientConnector() }); @@ -38,13 +43,15 @@ export default ({ getService }: FtrProviderContext): void => { actionsRemover.add('default', sir.id, 'action', 'actions'); actionsRemover.add('default', snConnector.id, 'action', 'actions'); + actionsRemover.add('default', snOAuthConnector.id, 'action', 'actions'); actionsRemover.add('default', emailConnector.id, 'action', 'actions'); actionsRemover.add('default', jiraConnector.id, 'action', 'actions'); actionsRemover.add('default', resilientConnector.id, 'action', 'actions'); const connectors = await getCaseConnectors({ supertest }); + const sortedConnectors = connectors.sort((a, b) => a.name.localeCompare(b.name)); - expect(connectors).to.eql([ + expect(sortedConnectors).to.eql([ { id: jiraConnector.id, actionTypeId: '.jira', @@ -90,6 +97,27 @@ export default ({ getService }: FtrProviderContext): void => { config: { apiUrl: 'http://some.non.existent.com', usesTableApi: false, + isOAuth: false, + clientId: null, + jwtKeyId: null, + userIdentifierValue: null, + }, + isPreconfigured: false, + isDeprecated: false, + isMissingSecrets: false, + referencedByCount: 0, + }, + { + id: snOAuthConnector.id, + actionTypeId: '.servicenow', + name: 'ServiceNow OAuth Connector', + config: { + apiUrl: 'http://some.non.existent.com', + usesTableApi: false, + isOAuth: true, + clientId: 'abc', + userIdentifierValue: 'elastic', + jwtKeyId: 'def', }, isPreconfigured: false, isDeprecated: false, @@ -99,10 +127,14 @@ export default ({ getService }: FtrProviderContext): void => { { id: sir.id, actionTypeId: '.servicenow-sir', - name: 'ServiceNow Connector', + name: 'ServiceNow SIR Connector', config: { apiUrl: 'http://some.non.existent.com', usesTableApi: false, + isOAuth: false, + clientId: null, + jwtKeyId: null, + userIdentifierValue: null, }, isPreconfigured: false, isDeprecated: false, diff --git a/x-pack/test/cases_api_integration/spaces_only/tests/common/index.ts b/x-pack/test/cases_api_integration/spaces_only/tests/common/index.ts index 0b18a56bdcd11..a180d46d45edb 100644 --- a/x-pack/test/cases_api_integration/spaces_only/tests/common/index.ts +++ b/x-pack/test/cases_api_integration/spaces_only/tests/common/index.ts @@ -29,6 +29,8 @@ export default ({ loadTestFile }: FtrProviderContext): void => { loadTestFile(require.resolve('./configure/get_configure')); loadTestFile(require.resolve('./configure/patch_configure')); loadTestFile(require.resolve('./configure/post_configure')); + loadTestFile(require.resolve('./configure/post_configure')); + loadTestFile(require.resolve('./metrics/get_cases_metrics')); /** * Internal routes diff --git a/x-pack/test/cases_api_integration/spaces_only/tests/common/metrics/get_cases_metrics.ts b/x-pack/test/cases_api_integration/spaces_only/tests/common/metrics/get_cases_metrics.ts new file mode 100644 index 0000000000000..66fb3f4343e58 --- /dev/null +++ b/x-pack/test/cases_api_integration/spaces_only/tests/common/metrics/get_cases_metrics.ts @@ -0,0 +1,73 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import expect from '@kbn/expect'; + +import { FtrProviderContext } from '../../../../common/ftr_provider_context'; +import { + deleteAllCaseItems, + getAuthWithSuperUser, + getCasesMetrics, +} from '../../../../common/lib/utils'; + +// eslint-disable-next-line import/no-default-export +export default ({ getService }: FtrProviderContext): void => { + const es = getService('es'); + const supertest = getService('supertest'); + const kibanaServer = getService('kibanaServer'); + const authSpace1 = getAuthWithSuperUser(); + + describe('all cases metrics', () => { + before(async () => { + await kibanaServer.importExport.load( + 'x-pack/test/functional/fixtures/kbn_archiver/cases/8.3.0/all_cases_metrics.json', + { space: 'space1' } + ); + + await kibanaServer.importExport.load( + 'x-pack/test/functional/fixtures/kbn_archiver/cases/8.3.0/all_cases_metrics.json', + { space: 'space2' } + ); + }); + + after(async () => { + await kibanaServer.importExport.unload( + 'x-pack/test/functional/fixtures/kbn_archiver/cases/8.3.0/all_cases_metrics.json', + { space: 'space1' } + ); + + await kibanaServer.importExport.unload( + 'x-pack/test/functional/fixtures/kbn_archiver/cases/8.3.0/all_cases_metrics.json', + { space: 'space2' } + ); + await deleteAllCaseItems(es); + }); + + describe('MTTR', () => { + it('should calculate the mttr correctly on space 1', async () => { + const metrics = await getCasesMetrics({ + supertest, + features: ['mttr'], + auth: authSpace1, + }); + + expect(metrics).to.eql({ mttr: 220 }); + }); + + it('should calculate the mttr correctly on space 2', async () => { + const authSpace2 = getAuthWithSuperUser('space2'); + const metrics = await getCasesMetrics({ + supertest, + features: ['mttr'], + auth: authSpace2, + }); + + expect(metrics).to.eql({ mttr: 220 }); + }); + }); + }); +}; diff --git a/x-pack/test/cases_api_integration/spaces_only/tests/trial/configure/get_connectors.ts b/x-pack/test/cases_api_integration/spaces_only/tests/trial/configure/get_connectors.ts index c4115b5c4902d..0ca47597e7b6b 100644 --- a/x-pack/test/cases_api_integration/spaces_only/tests/trial/configure/get_connectors.ts +++ b/x-pack/test/cases_api_integration/spaces_only/tests/trial/configure/get_connectors.ts @@ -11,6 +11,7 @@ import { FtrProviderContext } from '../../../../../common/ftr_provider_context'; import { ObjectRemover as ActionsRemover } from '../../../../../alerting_api_integration/common/lib'; import { getServiceNowConnector, + getServiceNowOAuthConnector, getJiraConnector, getResilientConnector, createConnector, @@ -39,7 +40,11 @@ export default ({ getService }: FtrProviderContext): void => { req: getServiceNowConnector(), auth: authSpace1, }); - + const snOAuthConnector = await createConnector({ + supertest, + req: getServiceNowOAuthConnector(), + auth: authSpace1, + }); const emailConnector = await createConnector({ supertest, req: getEmailConnector(), @@ -66,13 +71,15 @@ export default ({ getService }: FtrProviderContext): void => { actionsRemover.add(space, sir.id, 'action', 'actions'); actionsRemover.add(space, snConnector.id, 'action', 'actions'); + actionsRemover.add(space, snOAuthConnector.id, 'action', 'actions'); actionsRemover.add(space, emailConnector.id, 'action', 'actions'); actionsRemover.add(space, jiraConnector.id, 'action', 'actions'); actionsRemover.add(space, resilientConnector.id, 'action', 'actions'); const connectors = await getCaseConnectors({ supertest, auth: authSpace1 }); + const sortedConnectors = connectors.sort((a, b) => a.name.localeCompare(b.name)); - expect(connectors).to.eql([ + expect(sortedConnectors).to.eql([ { id: jiraConnector.id, actionTypeId: '.jira', @@ -118,6 +125,27 @@ export default ({ getService }: FtrProviderContext): void => { config: { apiUrl: 'http://some.non.existent.com', usesTableApi: false, + isOAuth: false, + clientId: null, + jwtKeyId: null, + userIdentifierValue: null, + }, + isPreconfigured: false, + isDeprecated: false, + isMissingSecrets: false, + referencedByCount: 0, + }, + { + id: snOAuthConnector.id, + actionTypeId: '.servicenow', + name: 'ServiceNow OAuth Connector', + config: { + apiUrl: 'http://some.non.existent.com', + usesTableApi: false, + isOAuth: true, + clientId: 'abc', + userIdentifierValue: 'elastic', + jwtKeyId: 'def', }, isPreconfigured: false, isDeprecated: false, @@ -127,10 +155,14 @@ export default ({ getService }: FtrProviderContext): void => { { id: sir.id, actionTypeId: '.servicenow-sir', - name: 'ServiceNow Connector', + name: 'ServiceNow SIR Connector', config: { apiUrl: 'http://some.non.existent.com', usesTableApi: false, + isOAuth: false, + clientId: null, + jwtKeyId: null, + userIdentifierValue: null, }, isPreconfigured: false, isDeprecated: false, @@ -147,6 +179,12 @@ export default ({ getService }: FtrProviderContext): void => { auth: authSpace1, }); + const snOAuthConnector = await createConnector({ + supertest, + req: getServiceNowOAuthConnector(), + auth: authSpace1, + }); + const emailConnector = await createConnector({ supertest, req: getEmailConnector(), @@ -173,6 +211,7 @@ export default ({ getService }: FtrProviderContext): void => { actionsRemover.add(space, sir.id, 'action', 'actions'); actionsRemover.add(space, snConnector.id, 'action', 'actions'); + actionsRemover.add(space, snOAuthConnector.id, 'action', 'actions'); actionsRemover.add(space, emailConnector.id, 'action', 'actions'); actionsRemover.add(space, jiraConnector.id, 'action', 'actions'); actionsRemover.add(space, resilientConnector.id, 'action', 'actions'); diff --git a/x-pack/test/functional/apps/apm/correlations/latency_correlations.ts b/x-pack/test/functional/apps/apm/correlations/latency_correlations.ts index 22b553d006303..5cba074eedbec 100644 --- a/x-pack/test/functional/apps/apm/correlations/latency_correlations.ts +++ b/x-pack/test/functional/apps/apm/correlations/latency_correlations.ts @@ -70,7 +70,6 @@ export default function ({ getPageObjects, getService }: FtrProviderContext) { await retry.try(async () => { const apmMainContainerText = await testSubjects.getVisibleTextAll('apmMainContainer'); const apmMainContainerTextItems = apmMainContainerText[0].split('\n'); - expect(apmMainContainerTextItems).to.not.contain('No services found'); expect(apmMainContainerTextItems).to.contain('opbeans-go'); diff --git a/x-pack/test/functional/apps/canvas/feature_controls/canvas_security.ts b/x-pack/test/functional/apps/canvas/feature_controls/canvas_security.ts index 1497c85b91bad..d1a500be98ff8 100644 --- a/x-pack/test/functional/apps/canvas/feature_controls/canvas_security.ts +++ b/x-pack/test/functional/apps/canvas/feature_controls/canvas_security.ts @@ -94,7 +94,7 @@ export default function ({ getPageObjects, getService }: FtrProviderContext) { it(`allows a workpad to be edited`, async () => { await PageObjects.common.navigateToActualUrl( 'canvas', - 'workpad/workpad-1705f884-6224-47de-ba49-ca224fe6ec31', + '/workpad/workpad-1705f884-6224-47de-ba49-ca224fe6ec31', { ensureCurrentUrl: true, shouldLoginIfPrompted: false, @@ -171,7 +171,7 @@ export default function ({ getPageObjects, getService }: FtrProviderContext) { it(`does not allow a workpad to be edited`, async () => { await PageObjects.common.navigateToActualUrl( 'canvas', - 'workpad/workpad-1705f884-6224-47de-ba49-ca224fe6ec31', + '/workpad/workpad-1705f884-6224-47de-ba49-ca224fe6ec31', { ensureCurrentUrl: true, shouldLoginIfPrompted: false, diff --git a/x-pack/test/functional/apps/canvas/feature_controls/canvas_spaces.ts b/x-pack/test/functional/apps/canvas/feature_controls/canvas_spaces.ts index 5060ac60eceae..e030cdbf5f624 100644 --- a/x-pack/test/functional/apps/canvas/feature_controls/canvas_spaces.ts +++ b/x-pack/test/functional/apps/canvas/feature_controls/canvas_spaces.ts @@ -80,7 +80,7 @@ export default function ({ getPageObjects, getService }: FtrProviderContext) { it(`allows a workpad to be edited`, async () => { await PageObjects.common.navigateToActualUrl( 'canvas', - 'workpad/workpad-1705f884-6224-47de-ba49-ca224fe6ec31', + '/workpad/workpad-1705f884-6224-47de-ba49-ca224fe6ec31', { ensureCurrentUrl: true, shouldLoginIfPrompted: false, diff --git a/x-pack/test/functional/apps/canvas/smoke_test.js b/x-pack/test/functional/apps/canvas/smoke_test.js index 053c58e88cde1..dff3cb7ce30a6 100644 --- a/x-pack/test/functional/apps/canvas/smoke_test.js +++ b/x-pack/test/functional/apps/canvas/smoke_test.js @@ -48,9 +48,9 @@ export default function canvasSmokeTest({ getService, getPageObjects }) { await retry.try(async () => { const url = await browser.getCurrentUrl(); - // remove all the search params, just compare the route - const hashRoute = new URL(url).hash.split('?')[0]; - expect(hashRoute).to.equal(`#/workpad/${testWorkpadId}/page/1`); + const path = new URL(url).pathname; + + expect(path).to.equal(`/app/canvas/workpad/${testWorkpadId}/page/1`); }); }); diff --git a/x-pack/test/functional/apps/graph/feature_controls/graph_security.ts b/x-pack/test/functional/apps/graph/feature_controls/graph_security.ts index 9179373cf610c..a1f0e3db2c187 100644 --- a/x-pack/test/functional/apps/graph/feature_controls/graph_security.ts +++ b/x-pack/test/functional/apps/graph/feature_controls/graph_security.ts @@ -16,8 +16,7 @@ export default function ({ getPageObjects, getService }: FtrProviderContext) { const appsMenu = getService('appsMenu'); const globalNav = getService('globalNav'); - // FLAKY https://github.com/elastic/kibana/issues/109564 - describe.skip('security', () => { + describe('security', () => { before(async () => { await esArchiver.load('x-pack/test/functional/es_archives/empty_kibana'); // ensure we're logged out so we can login as the appropriate users diff --git a/x-pack/test/functional/apps/uptime/feature_controls/uptime_security.ts b/x-pack/test/functional/apps/uptime/feature_controls/uptime_security.ts index 4d4acbe6242ba..b90337c3648b2 100644 --- a/x-pack/test/functional/apps/uptime/feature_controls/uptime_security.ts +++ b/x-pack/test/functional/apps/uptime/feature_controls/uptime_security.ts @@ -71,6 +71,7 @@ export default function ({ getPageObjects, getService }: FtrProviderContext) { 'Overview', 'Alerts', 'Uptime', + 'Synthetics', 'Stack Management', ]); }); @@ -123,7 +124,7 @@ export default function ({ getPageObjects, getService }: FtrProviderContext) { it('shows uptime navlink', async () => { const navLinks = (await appsMenu.readLinks()).map((link) => link.text); - expect(navLinks).to.eql(['Overview', 'Alerts', 'Uptime', 'Stack Management']); + expect(navLinks).to.eql(['Overview', 'Alerts', 'Uptime', 'Synthetics', 'Stack Management']); }); it('can navigate to Uptime app', async () => { diff --git a/x-pack/test/functional/es_archives/actions/data.json b/x-pack/test/functional/es_archives/actions/data.json index 79e7920872ab0..75206672358db 100644 --- a/x-pack/test/functional/es_archives/actions/data.json +++ b/x-pack/test/functional/es_archives/actions/data.json @@ -205,4 +205,96 @@ "updated_at": "2021-08-31T12:43:37.117Z" } } +} + +{ + "type": "doc", + "value": { + "id": "action:7d04bc30-c4c0-11ec-ae29-917aa31a5b75", + "index": ".kibana_1", + "source": { + "action": { + "actionTypeId" : ".servicenow-sir", + "name" : "test servicenow SecOps", + "isMissingSecrets" : false, + "config" : { + "apiUrl": "https://devtestsecops.service-now.com", + "usesTableApi": false + }, + "secrets" : "kPp4tl4ueQ2ZNWSfATR3dFrbxd+NNBo4MY8izS6GJf358Lmeg/YaYjb2rIymrbPktR6HnPBRaVyXWlRTvBGstRicJc0LJHZbx3wNJlTRIj4UFlVqZLGQWQ/GcSqFLSZ1JQbKwgAvyfLtF6BhjAhGYEovK3/OLUNzGc3gvUOOHBiPWjiAY8A=" + }, + "migrationVersion": { + "action": "8.0.0" + }, + "coreMigrationVersion" : "8.2.0", + "references": [ + ], + "namespaces": [ + "default" + ], + "type": "action", + "updated_at": "2022-04-25T17:52:35.201Z" + } + } +} + +{ + "type": "doc", + "value": { + "id": "action:8a9331b0-c4c0-11ec-ae29-917aa31a5b75", + "index": ".kibana_1", + "source": { + "action": { + "actionTypeId" : ".servicenow-itom", + "name" : "test servicenow ITOM", + "isMissingSecrets" : false, + "config" : { + "apiUrl": "https://devtestsecops.service-now.com" + }, + "secrets" : "yYThM4vbrSTIg5IjKWE+eMDrxzL7UO0JQIyh6FvEMgqoNREUxRrIavSo25v+DXQIX1DyfsvjjKg97pNPlZhvS3siCwDZZafSFrwkCKDl+S4KHORgIMX+slilcQeuEnzwit7bFxcY7Y/AcNF8Ks6jO0Gs1UR58ibSPUALXoK2VOlJnHSgtvE=" + }, + "migrationVersion": { + "action": "8.0.0" + }, + "coreMigrationVersion" : "8.2.0", + "references": [ + ], + "namespaces": [ + "default" + ], + "type": "action", + "updated_at": "2022-04-25T17:52:35.201Z" + } + } +} + +{ + "type": "doc", + "value": { + "id": "action:6d3a1250-c4c0-11ec-ae29-917aa31a5b75", + "index": ".kibana_1", + "source": { + "action": { + "actionTypeId" : ".servicenow", + "name" : "test servicenow ITSM", + "isMissingSecrets" : false, + "config" : { + "usesTableApi": false, + "apiUrl": "https://devtestsecops.service-now.com" + }, + "secrets" : "zfXUDtG0CyJkJUKnQ8rSqo75hb6ZhbRUWkV1NiFEjApM87b72Rcqz3Fv+sbm8eBDOO1Fdd9CVyK+Bfly4ZwVCgL2lR0qIbPzz34q36r267dnGVsaERyJIVv2WPy+EGdiRZKgfpy4XFbMNT1R3gyIsUkd4TT+McqGfVTont2XTFIpMW2A9y8=" + }, + "migrationVersion": { + "action": "8.0.0" + }, + "coreMigrationVersion" : "8.2.0", + "references": [ + ], + "namespaces": [ + "default" + ], + "type": "action", + "updated_at": "2022-04-25T17:52:35.201Z" + } + } } \ No newline at end of file diff --git a/x-pack/test/functional/fixtures/kbn_archiver/cases/8.3.0/all_cases_metrics.json b/x-pack/test/functional/fixtures/kbn_archiver/cases/8.3.0/all_cases_metrics.json new file mode 100644 index 0000000000000..f677d7624692c --- /dev/null +++ b/x-pack/test/functional/fixtures/kbn_archiver/cases/8.3.0/all_cases_metrics.json @@ -0,0 +1,182 @@ +{ + "attributes": { + "closed_at": "2022-04-29T13:24:44.448Z", + "closed_by": { + "email": null, + "full_name": null, + "username": "elastic" + }, + "connector": { + "fields": [], + "name": "none", + "type": ".none" + }, + "created_at": "2022-04-28T13:24:24.011Z", + "created_by": { + "email": null, + "full_name": null, + "username": "elastic" + }, + "description": "test mttr", + "duration": 20, + "external_service": null, + "owner": "securitySolutionFixture", + "settings": { + "syncAlerts": true + }, + "status": "closed", + "tags": [], + "title": "test mttr", + "updated_at": "2022-04-29T13:24:44.448Z", + "updated_by": { + "email": null, + "full_name": null, + "username": "elastic" + } + }, + "coreMigrationVersion": "8.3.0", + "id": "af948570-c7bf-11ec-9771-d5eef9232089", + "migrationVersion": { + "cases": "8.3.0" + }, + "references": [], + "type": "cases", + "updated_at": "2022-04-29T13:24:44.449Z", + "version": "WzE0NjgsMV0=" +} + +{ + "attributes": { + "closed_at": "2022-04-30T13:32:00.448Z", + "closed_by": { + "email": null, + "full_name": null, + "username": "elastic" + }, + "connector": { + "fields": [], + "name": "none", + "type": ".none" + }, + "created_at": "2022-04-30T13:24:00.011Z", + "created_by": { + "email": null, + "full_name": null, + "username": "elastic" + }, + "description": "test mttr", + "duration": 480, + "external_service": null, + "owner": "securitySolutionFixture", + "settings": { + "syncAlerts": true + }, + "status": "closed", + "tags": [], + "title": "test mttr", + "updated_at": "2022-04-29T13:24:44.448Z", + "updated_by": { + "email": null, + "full_name": null, + "username": "elastic" + } + }, + "coreMigrationVersion": "8.3.0", + "id": "bf948570-c7bf-11ec-9771-d5eef9232089", + "migrationVersion": { + "cases": "8.3.0" + }, + "references": [], + "type": "cases", + "updated_at": "2022-04-29T13:24:44.449Z", + "version": "WzE0NjgsMV0=" +} + +{ + "attributes": { + "closed_at": "2022-04-29T13:32:00.448Z", + "closed_by": { + "email": null, + "full_name": null, + "username": "elastic" + }, + "connector": { + "fields": [], + "name": "none", + "type": ".none" + }, + "created_at": "2022-04-29T13:24:00.011Z", + "created_by": { + "email": null, + "full_name": null, + "username": "elastic" + }, + "description": "test mttr", + "duration": 160, + "external_service": null, + "owner": "observabilityFixture", + "settings": { + "syncAlerts": true + }, + "status": "closed", + "tags": [], + "title": "test mttr", + "updated_at": "2022-04-29T13:24:44.448Z", + "updated_by": { + "email": null, + "full_name": null, + "username": "elastic" + } + }, + "coreMigrationVersion": "8.3.0", + "id": "cf948570-c7bf-11ec-9771-d5eef9232089", + "migrationVersion": { + "cases": "8.3.0" + }, + "references": [], + "type": "cases", + "updated_at": "2022-04-29T13:24:44.449Z", + "version": "WzE0NjgsMV0=" +} + +{ + "attributes": { + "closed_at": null, + "closed_by": null, + "connector": { + "fields": null, + "name": "none", + "type": ".none" + }, + "created_at": "2022-03-20T10:16:56.252Z", + "created_by": { + "email": "", + "full_name": "", + "username": "elastic" + }, + "description": "test 2", + "external_service": null, + "owner": "securitySolutionFixture", + "settings": { + "syncAlerts": false + }, + "status": "open", + "tags": [], + "title": "stack", + "updated_at": "2022-03-29T10:33:09.754Z", + "updated_by": { + "email": "", + "full_name": "", + "username": "elastic" + } + }, + "coreMigrationVersion": "8.3.0", + "id": "df948570-c7bf-11ec-9771-d5eef9232089", + "migrationVersion": { + "cases": "8.3.0" + }, + "references": [], + "type": "cases", + "updated_at": "2022-04-29T13:24:44.449Z", + "version": "WzE0NjgsMV0=" +} diff --git a/x-pack/test/functional/page_objects/lens_page.ts b/x-pack/test/functional/page_objects/lens_page.ts index 9751c7185213e..d38264150cfa5 100644 --- a/x-pack/test/functional/page_objects/lens_page.ts +++ b/x-pack/test/functional/page_objects/lens_page.ts @@ -655,7 +655,7 @@ export function LensPageProvider({ getService, getPageObjects }: FtrProviderCont }, async editDimensionLabel(label: string) { - await testSubjects.setValue('indexPattern-label-edit', label, { clearWithKeyboard: true }); + await testSubjects.setValue('column-label-edit', label, { clearWithKeyboard: true }); }, async editDimensionFormat(format: string) { const formatInput = await testSubjects.find('indexPattern-dimension-format'); diff --git a/x-pack/test/plugin_functional/plugins/timelines_test/kibana.json b/x-pack/test/plugin_functional/plugins/timelines_test/kibana.json index f96e8b2bbcc23..1960c49839566 100644 --- a/x-pack/test/plugin_functional/plugins/timelines_test/kibana.json +++ b/x-pack/test/plugin_functional/plugins/timelines_test/kibana.json @@ -4,7 +4,7 @@ "version": "1.0.0", "kibanaVersion": "kibana", "configPath": ["xpack", "timelinesTest"], - "requiredPlugins": ["timelines", "data", "dataEnhanced"], + "requiredPlugins": ["timelines", "data"], "requiredBundles": ["kibanaReact"], "server": false, "ui": true diff --git a/x-pack/test/security_solution_endpoint/apps/endpoint/endpoint_list.ts b/x-pack/test/security_solution_endpoint/apps/endpoint/endpoint_list.ts index 368783b0efd1c..48dc450737229 100644 --- a/x-pack/test/security_solution_endpoint/apps/endpoint/endpoint_list.ts +++ b/x-pack/test/security_solution_endpoint/apps/endpoint/endpoint_list.ts @@ -34,29 +34,29 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => { 'Last active', 'Actions', ], - ['Host-9fafsc3tqe', 'x', 'x', 'Warning', 'Windows', '10.231.117.28', '7.17.12', 'x', ''], [ 'Host-ku5jy6j0pw', 'x', 'x', - 'Warning', + 'Unsupported', 'Windows', - '10.246.87.11, 10.145.117.106,10.109.242.136', + '10.12.215.130, 10.130.188.228,10.19.102.141', '7.0.13', 'x', '', ], [ - 'Host-o07wj6uaa5', + 'Host-ntr4rkj24m', 'x', 'x', - 'Failure', + 'Success', 'Windows', - '10.82.134.220, 10.47.25.170', - '7.11.13', + '10.36.46.252, 10.222.152.110', + '7.4.13', 'x', '', ], + ['Host-q9qenwrl9k', 'x', 'x', 'Warning', 'Windows', '10.206.226.90', '7.11.10', 'x', ''], ]; const formattedTableData = async () => { @@ -209,9 +209,9 @@ export default ({ getPageObjects, getService }: FtrProviderContext) => { 'Host-ku5jy6j0pw', 'x', 'x', - 'Warning', + 'Unsupported', 'Windows', - '10.246.87.11, 10.145.117.106,10.109.242.136', + '10.12.215.130, 10.130.188.228,10.19.102.141', '7.0.13', 'x', '', diff --git a/x-pack/test/tsconfig.json b/x-pack/test/tsconfig.json index d6bdf8cfaa6fd..8c6a1cb88c0ba 100644 --- a/x-pack/test/tsconfig.json +++ b/x-pack/test/tsconfig.json @@ -58,7 +58,6 @@ { "path": "../plugins/global_search/tsconfig.json" }, { "path": "../plugins/global_search_providers/tsconfig.json" }, { "path": "../plugins/features/tsconfig.json" }, - { "path": "../plugins/data_enhanced/tsconfig.json" }, { "path": "../plugins/drilldowns/url_drilldown/tsconfig.json" }, { "path": "../plugins/embeddable_enhanced/tsconfig.json" }, { "path": "../plugins/encrypted_saved_objects/tsconfig.json" }, diff --git a/yarn.lock b/yarn.lock index 49406dc42e27f..426588b11a9c4 100644 --- a/yarn.lock +++ b/yarn.lock @@ -9884,9 +9884,9 @@ caniuse-api@^3.0.0: lodash.uniq "^4.5.0" caniuse-lite@^1.0.0, caniuse-lite@^1.0.30001097, caniuse-lite@^1.0.30001109, caniuse-lite@^1.0.30001125, caniuse-lite@^1.0.30001286: - version "1.0.30001309" - resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30001309.tgz#e0ee78b9bec0704f67304b00ff3c5c0c768a9f62" - integrity sha512-Pl8vfigmBXXq+/yUz1jUwULeq9xhMJznzdc/xwl4WclDAuebcTHVefpz8lE/bMI+UN7TOkSSe7B7RnZd6+dzjA== + version "1.0.30001335" + resolved "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001335.tgz" + integrity sha512-ddP1Tgm7z2iIxu6QTtbZUv6HJxSaV/PZeSrWFZtbY4JZ69tOeNhBCl3HyRQgeNZKE5AOn1kpV7fhljigy0Ty3w== canvg@^3.0.9: version "3.0.9" @@ -13009,10 +13009,10 @@ elastic-apm-http-client@11.0.1: semver "^6.3.0" stream-chopper "^3.0.1" -elastic-apm-node@^3.31.0: - version "3.31.0" - resolved "https://registry.yarnpkg.com/elastic-apm-node/-/elastic-apm-node-3.31.0.tgz#6e0bf622d922c95ff0127a263babcdeaeea71457" - integrity sha512-0OulazfhkXYbOaGkHncqjwOfxtcvzsDyzUKr6Y1k95HwKrjf1Vi+xPutZv4p/WfDdO+JadphI0U2Uu5ncGB2iA== +elastic-apm-node@^3.32.0: + version "3.32.0" + resolved "https://registry.yarnpkg.com/elastic-apm-node/-/elastic-apm-node-3.32.0.tgz#fdad3c03aabc4e7994b4155b031f68d9774af49a" + integrity sha512-6vOe1FZv5toCouuyfiXZuWNE1+1fim9zvsv7H56BKRYa7xQ3X1fxq7QAP2gLd/Z9zvSDLGNXS4DPE1eqX1A1Jw== dependencies: "@elastic/ecs-pino-format" "^1.2.0" after-all-results "^2.0.0" @@ -16133,11 +16133,6 @@ highlight.js@^10.1.1, highlight.js@^10.4.1, highlight.js@~10.4.0: resolved "https://registry.yarnpkg.com/highlight.js/-/highlight.js-10.4.1.tgz#d48fbcf4a9971c4361b3f95f302747afe19dbad0" integrity sha512-yR5lWvNz7c85OhVAEAeFhVCc/GV4C30Fjzc/rCP0aCWzc1UUOPUk55dK/qdwTZHBvMZo+eZ2jpk62ndX/xMFlg== -history-extra@^5.0.1: - version "5.0.1" - resolved "https://registry.yarnpkg.com/history-extra/-/history-extra-5.0.1.tgz#95a2e59dda526c4241d0ae1b124a77a5e4675ce8" - integrity sha512-6XV1L1lHgporVWgppa/Kq+Fnz4lhBew7iMxYCTfzVmoEywsAKJnTjdw1zOd+EGLHGYp0/V8jSVMEgqx4QbHLTw== - history@^4.9.0: version "4.9.0" resolved "https://registry.yarnpkg.com/history/-/history-4.9.0.tgz#84587c2068039ead8af769e9d6a6860a14fa1bca"