From 5cd7358834d52985034863d49a4def1f6c6d970a Mon Sep 17 00:00:00 2001 From: Ravi Kesarwani <64450378+ravikesarwani@users.noreply.github.com> Date: Tue, 3 Aug 2021 10:30:55 -0400 Subject: [PATCH 01/63] Update SM doc for alert per object (#107420) Update stack monitoring doc to account for alert notification now being send for each node, index, or cluster based on the rule type, instead of always per cluster (PR# 102544) --- docs/user/monitoring/kibana-alerts.asciidoc | 27 ++++++++------------- 1 file changed, 10 insertions(+), 17 deletions(-) diff --git a/docs/user/monitoring/kibana-alerts.asciidoc b/docs/user/monitoring/kibana-alerts.asciidoc index 837248e0cf41d..beaae1fdb71b6 100644 --- a/docs/user/monitoring/kibana-alerts.asciidoc +++ b/docs/user/monitoring/kibana-alerts.asciidoc @@ -32,17 +32,15 @@ To review and modify all available rules, click *Enter setup mode* on the This rule checks for {es} nodes that run a consistently high CPU load. By default, the condition is set at 85% or more averaged over the last 5 minutes. -The rule is grouped across all the nodes of the cluster by running checks on a -schedule time of 1 minute with a re-notify interval of 1 day. +The default rule checks on a schedule time of 1 minute with a re-notify interval of 1 day. [discrete] [[kibana-alerts-disk-usage-threshold]] == Disk usage threshold This rule checks for {es} nodes that are nearly at disk capacity. By default, -the condition is set at 80% or more averaged over the last 5 minutes. The rule -is grouped across all the nodes of the cluster by running checks on a schedule -time of 1 minute with a re-notify interval of 1 day. +the condition is set at 80% or more averaged over the last 5 minutes. The default rule +checks on a schedule time of 1 minute with a re-notify interval of 1 day. [discrete] [[kibana-alerts-jvm-memory-threshold]] @@ -50,16 +48,14 @@ time of 1 minute with a re-notify interval of 1 day. This rule checks for {es} nodes that use a high amount of JVM memory. By default, the condition is set at 85% or more averaged over the last 5 minutes. -The rule is grouped across all the nodes of the cluster by running checks on a -schedule time of 1 minute with a re-notify interval of 1 day. +The default rule checks on a schedule time of 1 minute with a re-notify interval of 1 day. [discrete] [[kibana-alerts-missing-monitoring-data]] == Missing monitoring data This rule checks for {es} nodes that stop sending monitoring data. By default, -the condition is set to missing for 15 minutes looking back 1 day. The rule is -grouped across all the {es} nodes of the cluster by running checks on a schedule +the condition is set to missing for 15 minutes looking back 1 day. The default rule checks on a schedule time of 1 minute with a re-notify interval of 6 hours. [discrete] @@ -67,9 +63,8 @@ time of 1 minute with a re-notify interval of 6 hours. == Thread pool rejections (search/write) This rule checks for {es} nodes that experience thread pool rejections. By -default, the condition is set at 300 or more over the last 5 minutes. The rule -is grouped across all the nodes of the cluster by running checks on a schedule -time of 1 minute with a re-notify interval of 1 day. Thresholds can be set +default, the condition is set at 300 or more over the last 5 minutes. The default rule +checks on a schedule time of 1 minute with a re-notify interval of 1 day. Thresholds can be set independently for `search` and `write` type rejections. [discrete] @@ -78,8 +73,7 @@ independently for `search` and `write` type rejections. This rule checks for read exceptions on any of the replicated {es} clusters. The condition is met if 1 or more read exceptions are detected in the last hour. The -rule is grouped across all replicated clusters by running checks on a schedule -time of 1 minute with a re-notify interval of 6 hours. +default rule checks on a schedule time of 1 minute with a re-notify interval of 6 hours. [discrete] [[kibana-alerts-large-shard-size]] @@ -87,9 +81,8 @@ time of 1 minute with a re-notify interval of 6 hours. This rule checks for a large average shard size (across associated primaries) on any of the specified index patterns in an {es} cluster. The condition is met if -an index's average shard size is 55gb or higher in the last 5 minutes. The rule -is grouped across all indices that match the default pattern of `-.*` by running -checks on a schedule time of 1 minute with a re-notify interval of 12 hours. +an index's average shard size is 55gb or higher in the last 5 minutes. The default rule +matches the pattern of `-.*` by running checks on a schedule time of 1 minute with a re-notify interval of 12 hours. [discrete] [[kibana-alerts-cluster-alerts]] From 48a97f6d18ddbfbcf218237bb7060cbc46ad9728 Mon Sep 17 00:00:00 2001 From: Mark Hopkin Date: Tue, 3 Aug 2021 16:16:17 +0100 Subject: [PATCH 02/63] [Fleet] Agent policy search, support simple text filter. (#107306) * feat: fall back to simple search on parse error * fix: simplify query * lint: fix docs Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> --- .../fleet/server/services/agent_policy.ts | 22 ++++++++++++++++--- .../fleet/server/services/saved_object.ts | 6 ++--- 2 files changed, 22 insertions(+), 6 deletions(-) diff --git a/x-pack/plugins/fleet/server/services/agent_policy.ts b/x-pack/plugins/fleet/server/services/agent_policy.ts index 6881e0872606d..e3ecdcda20d2a 100644 --- a/x-pack/plugins/fleet/server/services/agent_policy.ts +++ b/x-pack/plugins/fleet/server/services/agent_policy.ts @@ -333,14 +333,30 @@ class AgentPolicyService { withPackagePolicies = false, } = options; - const agentPoliciesSO = await soClient.find({ + const baseFindParams = { type: SAVED_OBJECT_TYPE, sortField, sortOrder, page, perPage, - filter: kuery ? normalizeKuery(SAVED_OBJECT_TYPE, kuery) : undefined, - }); + }; + const filter = kuery ? normalizeKuery(SAVED_OBJECT_TYPE, kuery) : undefined; + let agentPoliciesSO; + try { + agentPoliciesSO = await soClient.find({ ...baseFindParams, filter }); + } catch (e) { + const isBadRequest = e.output?.statusCode === 400; + const isKQLSyntaxError = e.message?.startsWith('KQLSyntaxError'); + if (isBadRequest && !isKQLSyntaxError) { + // fall back to simple search if the kuery is just a search term i.e not KQL + agentPoliciesSO = await soClient.find({ + ...baseFindParams, + search: kuery, + }); + } else { + throw e; + } + } const agentPolicies = await Promise.all( agentPoliciesSO.saved_objects.map(async (agentPolicySO) => { diff --git a/x-pack/plugins/fleet/server/services/saved_object.ts b/x-pack/plugins/fleet/server/services/saved_object.ts index bdecffb843e8e..244de5f88ba1b 100644 --- a/x-pack/plugins/fleet/server/services/saved_object.ts +++ b/x-pack/plugins/fleet/server/services/saved_object.ts @@ -19,9 +19,9 @@ export function escapeSearchQueryPhrase(val: string): string { return `"${val.replace(/["]/g, '"')}"`; } -// Adds `.attribute` to any kuery strings that are missing it, this comes from -// internal SO structure. Kuery strings that come from UI will typicall have -// `.attribute` hidden to simplify UX, so this normalizes any kuery string for +// Adds `.attributes` to any kuery strings that are missing it, this comes from +// internal SO structure. Kuery strings that come from UI will typically have +// `.attributes` hidden to simplify UX, so this normalizes any kuery string for // filtering SOs export const normalizeKuery = (savedObjectType: string, kuery: string): string => { return kuery.replace( From 3d8a2cfcf15bd9e39ff9c15998d2a4bc83d6dfff Mon Sep 17 00:00:00 2001 From: Spencer Date: Tue, 3 Aug 2021 08:37:10 -0700 Subject: [PATCH 03/63] [cli-dev-mode] get values from completed state subjects (#107428) Co-authored-by: spalger Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> --- packages/kbn-cli-dev-mode/src/cli_dev_mode.ts | 30 ++++++++++++++----- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/packages/kbn-cli-dev-mode/src/cli_dev_mode.ts b/packages/kbn-cli-dev-mode/src/cli_dev_mode.ts index 4b1bbb43ba888..a681f1ff2e4cd 100644 --- a/packages/kbn-cli-dev-mode/src/cli_dev_mode.ts +++ b/packages/kbn-cli-dev-mode/src/cli_dev_mode.ts @@ -77,8 +77,11 @@ export interface CliDevModeOptions { cache: boolean; } -const firstAllTrue = (...sources: Array>) => - Rx.combineLatest(sources).pipe( +const getValue$ = (source: Rx.BehaviorSubject): Rx.Observable => + source.isStopped ? Rx.of(source.getValue()) : source; + +const firstAllTrue = (...sources: Array>) => + Rx.combineLatest(sources.map(getValue$)).pipe( filter((values) => values.every((v) => v === true)), take(1), mapTo(undefined) @@ -198,11 +201,24 @@ export class CliDevMode { ? Rx.EMPTY : Rx.timer(1000).pipe( tap(() => { - this.log.warn( - 'please hold', - !optimizerReady$.getValue() - ? 'optimizer is still bundling so requests have been paused' - : 'server is not ready so requests have been paused' + if (!optimizerReady$.getValue()) { + this.log.warn( + 'please hold', + 'optimizer is still bundling so requests have been paused' + ); + return; + } + + if (!serverReady$.getValue()) { + this.log.warn( + 'please hold', + 'Kibana server is not ready so requests have been paused' + ); + return; + } + + throw new Error( + 'user is waiting for over 1 second and neither serverReady$ or optimizerReady$ is false' ); }) ) From 899a6f3f11d7f32b08f296064cfca2167b1ed385 Mon Sep 17 00:00:00 2001 From: Stacey Gammon Date: Tue, 3 Aug 2021 11:58:03 -0400 Subject: [PATCH 04/63] Fix the API docs bug, where optional functions on interfaces were losing their children. (#107236) * Fix the bug and update tests * update api docs * Fix tests --- api_docs/actions.json | 36 +- api_docs/actions.mdx | 2 +- api_docs/alerting.json | 146 +- api_docs/alerting.mdx | 2 +- api_docs/apm.json | 71 +- api_docs/apm.mdx | 2 +- api_docs/bfetch.json | 193 +- api_docs/bfetch.mdx | 2 +- api_docs/cases.json | 257 +- api_docs/cases.mdx | 2 +- api_docs/charts.json | 126 +- api_docs/charts.mdx | 2 +- api_docs/core.json | 1185 ++++-- api_docs/core.mdx | 2 +- api_docs/core_application.json | 108 +- api_docs/core_application.mdx | 2 +- api_docs/core_chrome.json | 19 +- api_docs/core_chrome.mdx | 2 +- api_docs/core_http.json | 3206 ++++++++++----- api_docs/core_http.mdx | 2 +- api_docs/core_saved_objects.json | 1157 ++---- api_docs/core_saved_objects.mdx | 2 +- api_docs/dashboard.json | 47 +- api_docs/dashboard.mdx | 2 +- api_docs/data.json | 3457 ++++++++++++++--- api_docs/data.mdx | 2 +- api_docs/data_autocomplete.json | 22 + api_docs/data_autocomplete.mdx | 2 +- api_docs/data_field_formats.json | 26 + api_docs/data_field_formats.mdx | 2 +- api_docs/data_index_patterns.json | 364 +- api_docs/data_index_patterns.mdx | 2 +- api_docs/data_query.json | 232 +- api_docs/data_query.mdx | 2 +- api_docs/data_search.json | 887 ++++- api_docs/data_search.mdx | 2 +- api_docs/data_ui.json | 73 +- api_docs/data_ui.mdx | 2 +- api_docs/data_visualizer.json | 58 + api_docs/data_visualizer.mdx | 2 +- api_docs/deprecations_by_api.mdx | 9 +- api_docs/deprecations_by_plugin.mdx | 63 - api_docs/dev_tools.json | 13 +- api_docs/discover.json | 61 +- api_docs/discover.mdx | 2 +- api_docs/embeddable.json | 294 +- api_docs/embeddable.mdx | 2 +- api_docs/encrypted_saved_objects.json | 74 +- api_docs/encrypted_saved_objects.mdx | 2 +- api_docs/es_ui_shared.json | 77 +- api_docs/es_ui_shared.mdx | 2 +- api_docs/expression_repeat_image.json | 2 + api_docs/expression_shape.json | 8 +- api_docs/expressions.json | 1196 ++++-- api_docs/expressions.mdx | 2 +- api_docs/features.json | 18 +- api_docs/features.mdx | 2 +- api_docs/file_upload.json | 75 +- api_docs/fleet.json | 352 +- api_docs/fleet.mdx | 2 +- api_docs/global_search.json | 17 +- api_docs/home.json | 109 +- api_docs/home.mdx | 2 +- api_docs/index_pattern_field_editor.json | 72 +- api_docs/index_pattern_field_editor.mdx | 2 +- api_docs/infra.json | 17 +- api_docs/inspector.json | 52 +- api_docs/inspector.mdx | 2 +- api_docs/kibana_legacy.json | 70 +- api_docs/kibana_legacy.mdx | 2 +- api_docs/kibana_react.json | 173 +- api_docs/kibana_react.mdx | 2 +- api_docs/kibana_utils.json | 1318 +++++-- api_docs/kibana_utils.mdx | 2 +- api_docs/lens.json | 61 +- api_docs/lens.mdx | 2 +- api_docs/licensing.json | 55 +- api_docs/licensing.mdx | 2 +- api_docs/lists.json | 8 +- api_docs/management.json | 9 +- api_docs/maps.json | 201 +- api_docs/maps.mdx | 2 +- api_docs/maps_ems.json | 4 +- api_docs/ml.json | 18 + api_docs/ml.mdx | 2 +- api_docs/monitoring.json | 39 +- api_docs/observability.json | 99 +- api_docs/observability.mdx | 2 +- api_docs/presentation_util.json | 158 +- api_docs/presentation_util.mdx | 2 +- api_docs/reporting.json | 132 +- api_docs/reporting.mdx | 2 +- api_docs/rule_registry.json | 69 +- api_docs/rule_registry.mdx | 2 +- api_docs/runtime_fields.json | 13 +- api_docs/saved_objects.json | 253 +- api_docs/saved_objects.mdx | 2 +- api_docs/saved_objects_management.json | 38 +- api_docs/saved_objects_tagging_oss.json | 40 +- api_docs/saved_objects_tagging_oss.mdx | 2 +- api_docs/screenshot_mode.json | 4 +- api_docs/security.json | 82 +- api_docs/security_oss.json | 9 +- api_docs/security_solution.json | 490 ++- api_docs/security_solution.mdx | 2 +- api_docs/share.json | 122 +- api_docs/share.mdx | 2 +- api_docs/spaces.json | 93 +- api_docs/spaces.mdx | 2 +- api_docs/spaces_oss.json | 103 +- api_docs/spaces_oss.mdx | 2 +- api_docs/task_manager.json | 22 + api_docs/task_manager.mdx | 2 +- api_docs/telemetry.json | 36 +- api_docs/telemetry_collection_manager.json | 111 +- api_docs/telemetry_collection_manager.mdx | 2 +- api_docs/telemetry_management_section.json | 12 +- api_docs/timelines.json | 606 ++- api_docs/timelines.mdx | 2 +- api_docs/triggers_actions_ui.json | 172 +- api_docs/triggers_actions_ui.mdx | 2 +- api_docs/ui_actions_enhanced.json | 22 +- api_docs/url_forwarding.json | 12 +- api_docs/usage_collection.json | 210 +- api_docs/usage_collection.mdx | 2 +- api_docs/vis_type_timeseries.json | 19 +- api_docs/visualizations.json | 190 +- api_docs/visualizations.mdx | 2 +- .../buid_api_declaration.test.ts | 2 +- .../build_api_declaration.ts | 44 +- .../build_function_dec.ts | 23 +- .../build_function_type_dec.ts | 60 + .../build_variable_dec.ts | 2 +- .../api_docs/mdx/split_apis_by_folder.test.ts | 4 +- .../src/plugin_a/public/classes.ts | 18 +- .../__fixtures__/src/plugin_a/public/types.ts | 8 + .../src/api_docs/tests/api_doc_suite.test.ts | 109 +- .../api_docs/tests/snapshots/plugin_a.json | 491 ++- .../tests/snapshots/plugin_a_foo.json | 2 + 139 files changed, 14830 insertions(+), 5291 deletions(-) create mode 100644 packages/kbn-docs-utils/src/api_docs/build_api_declarations/build_function_type_dec.ts diff --git a/api_docs/actions.json b/api_docs/actions.json index 9e511bce4ca3a..450b0f0e7f632 100644 --- a/api_docs/actions.json +++ b/api_docs/actions.json @@ -214,8 +214,8 @@ ], "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "actions", @@ -1838,6 +1838,22 @@ ], "path": "x-pack/plugins/actions/common/rewrite_request_case.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "actions", + "id": "def-common.requested", + "type": "Object", + "tags": [], + "label": "requested", + "description": [], + "signature": [ + "{ [K in keyof T as CamelToSnake>>]: T[K]; }" + ], + "path": "x-pack/plugins/actions/common/rewrite_request_case.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -1868,6 +1884,22 @@ ], "path": "x-pack/plugins/actions/common/rewrite_request_case.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "actions", + "id": "def-common.responded", + "type": "Uncategorized", + "tags": [], + "label": "responded", + "description": [], + "signature": [ + "T" + ], + "path": "x-pack/plugins/actions/common/rewrite_request_case.ts", + "deprecated": false + } + ], "initialIsOpen": false } ], diff --git a/api_docs/actions.mdx b/api_docs/actions.mdx index 1020fa063d1c0..a713c7da04e0f 100644 --- a/api_docs/actions.mdx +++ b/api_docs/actions.mdx @@ -18,7 +18,7 @@ import actionsObj from './actions.json'; | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 117 | 0 | 117 | 7 | +| 119 | 0 | 119 | 7 | ## Server diff --git a/api_docs/alerting.json b/api_docs/alerting.json index 8e956c5cb36d3..bd245c1ae0b64 100644 --- a/api_docs/alerting.json +++ b/api_docs/alerting.json @@ -29,6 +29,48 @@ ], "path": "x-pack/plugins/alerting/public/alert_navigation_registry/types.ts", "deprecated": false, + "returnComment": [ + "A URL that is meant to be relative to your application id, or a state object that your application uses to render\nthe rule. This information is intended to be used with cores NavigateToApp function, along with the application id that was\noriginally registered to {@link PluginSetupContract.registerNavigation}." + ], + "children": [ + { + "parentPluginId": "alerting", + "id": "def-public.alert", + "type": "Object", + "tags": [], + "label": "alert", + "description": [], + "signature": [ + "{ enabled: boolean; id: string; name: string; params: never; actions: ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.AlertAction", + "text": "AlertAction" + }, + "[]; throttle: string | null; tags: string[]; alertTypeId: string; consumer: string; schedule: ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.IntervalSchedule", + "text": "IntervalSchedule" + }, + "; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; muteAll: boolean; mutedInstanceIds: string[]; executionStatus: ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.AlertExecutionStatus", + "text": "AlertExecutionStatus" + }, + "; }" + ], + "path": "x-pack/plugins/alerting/public/alert_navigation_registry/types.ts", + "deprecated": false + } + ], "initialIsOpen": false } ], @@ -67,35 +109,42 @@ ], "path": "x-pack/plugins/alerting/public/plugin.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "alerting", - "id": "def-public.applicationId", + "id": "def-public.PluginSetupContract.registerNavigation.$1", "type": "string", "tags": [], "label": "applicationId", "description": [ "The application id that the user should be navigated to, to view a particular alert in a custom way." ], + "signature": [ + "string" + ], "path": "x-pack/plugins/alerting/public/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "alerting", - "id": "def-public.ruleType", + "id": "def-public.PluginSetupContract.registerNavigation.$2", "type": "string", "tags": [], "label": "ruleType", "description": [ "The rule type that has been registered with Alerting.Server.PluginSetupContract.registerType. If\nno such rule with that id exists, a warning is output to the console log. It used to throw an error, but that was temporarily moved\nbecause it was causing flaky test failures with https://github.com/elastic/kibana/issues/59229 and needs to be\ninvestigated more." ], + "signature": [ + "string" + ], "path": "x-pack/plugins/alerting/public/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "alerting", - "id": "def-public.handler", + "id": "def-public.PluginSetupContract.registerNavigation.$3", "type": "Function", "tags": [], "label": "handler", @@ -103,21 +152,20 @@ "The navigation handler should return either a relative URL, or a state object. This information can be used,\nin conjunction with the consumer id, to navigate the user to a custom URL to view a rule's details." ], "signature": [ - "(alert: Pick<", { "pluginId": "alerting", - "scope": "common", + "scope": "public", "docId": "kibAlertingPluginApi", - "section": "def-common.Alert", - "text": "Alert" - }, - ", \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"throttle\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">) => string | ", - "JsonObject" + "section": "def-public.AlertNavigationHandler", + "text": "AlertNavigationHandler" + } ], "path": "x-pack/plugins/alerting/public/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "alerting", @@ -141,23 +189,26 @@ ], "path": "x-pack/plugins/alerting/public/plugin.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "alerting", - "id": "def-public.applicationId", + "id": "def-public.PluginSetupContract.registerDefaultNavigation.$1", "type": "string", "tags": [], "label": "applicationId", "description": [ "The application id that the user should be navigated to, to view a particular alert in a custom way." ], + "signature": [ + "string" + ], "path": "x-pack/plugins/alerting/public/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "alerting", - "id": "def-public.handler", + "id": "def-public.PluginSetupContract.registerDefaultNavigation.$2", "type": "Function", "tags": [], "label": "handler", @@ -165,21 +216,20 @@ "The navigation handler should return either a relative URL, or a state object. This information can be used,\nin conjunction with the consumer id, to navigate the user to a custom URL to view a rule's details." ], "signature": [ - "(alert: Pick<", { "pluginId": "alerting", - "scope": "common", + "scope": "public", "docId": "kibAlertingPluginApi", - "section": "def-common.Alert", - "text": "Alert" - }, - ", \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"throttle\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">) => string | ", - "JsonObject" + "section": "def-public.AlertNavigationHandler", + "text": "AlertNavigationHandler" + } ], "path": "x-pack/plugins/alerting/public/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "lifecycle": "setup", @@ -223,19 +273,23 @@ ], "path": "x-pack/plugins/alerting/public/plugin.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "alerting", - "id": "def-public.alertId", + "id": "def-public.PluginStartContract.getNavigation.$1", "type": "string", "tags": [], "label": "alertId", "description": [], + "signature": [ + "string" + ], "path": "x-pack/plugins/alerting/public/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "lifecycle": "start", @@ -955,8 +1009,8 @@ ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "alerting", @@ -995,8 +1049,8 @@ ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "alerting", @@ -1010,8 +1064,8 @@ ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -1102,19 +1156,23 @@ ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "alerting", - "id": "def-server.id", + "id": "def-server.AlertServices.alertInstanceFactory.$1", "type": "string", "tags": [], "label": "id", "description": [], + "signature": [ + "string" + ], "path": "x-pack/plugins/alerting/server/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -1660,8 +1718,8 @@ ], "path": "x-pack/plugins/alerting/server/plugin.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false diff --git a/api_docs/alerting.mdx b/api_docs/alerting.mdx index 252a3b45c6c12..6ef427d452ec4 100644 --- a/api_docs/alerting.mdx +++ b/api_docs/alerting.mdx @@ -18,7 +18,7 @@ import alertingObj from './alerting.json'; | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 242 | 0 | 234 | 16 | +| 243 | 0 | 235 | 16 | ## Client diff --git a/api_docs/apm.json b/api_docs/apm.json index 3aa6d7709309c..db8eb663da613 100644 --- a/api_docs/apm.json +++ b/api_docs/apm.json @@ -3928,8 +3928,8 @@ ], "path": "x-pack/plugins/apm/server/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "apm", @@ -3959,32 +3959,67 @@ ], "path": "x-pack/plugins/apm/server/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "apm", - "id": "def-server.params", + "id": "def-server.APMPluginSetup.createApmEventClient.$1.params", "type": "Object", "tags": [], "label": "params", "description": [], - "signature": [ - "{ debug?: boolean | undefined; request: ", + "path": "x-pack/plugins/apm/server/types.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" + "parentPluginId": "apm", + "id": "def-server.APMPluginSetup.createApmEventClient.$1.params.debug", + "type": "CompoundType", + "tags": [], + "label": "debug", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/apm/server/types.ts", + "deprecated": false }, - "; context: ", - "ApmPluginRequestHandlerContext", - "; }" - ], - "path": "x-pack/plugins/apm/server/types.ts", - "deprecated": false + { + "parentPluginId": "apm", + "id": "def-server.APMPluginSetup.createApmEventClient.$1.params.request", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "x-pack/plugins/apm/server/types.ts", + "deprecated": false + }, + { + "parentPluginId": "apm", + "id": "def-server.APMPluginSetup.createApmEventClient.$1.params.context", + "type": "Object", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "ApmPluginRequestHandlerContext" + ], + "path": "x-pack/plugins/apm/server/types.ts", + "deprecated": false + } + ] } - ] + ], + "returnComment": [] } ], "lifecycle": "setup", diff --git a/api_docs/apm.mdx b/api_docs/apm.mdx index b2aabfd4b4214..c241ea2376f26 100644 --- a/api_docs/apm.mdx +++ b/api_docs/apm.mdx @@ -18,7 +18,7 @@ Contact APM UI for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 39 | 0 | 39 | 30 | +| 42 | 0 | 42 | 30 | ## Client diff --git a/api_docs/bfetch.json b/api_docs/bfetch.json index d5ed18b9fdab0..2e42ea6066eee 100644 --- a/api_docs/bfetch.json +++ b/api_docs/bfetch.json @@ -56,6 +56,35 @@ ], "path": "src/plugins/bfetch/public/batching/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "bfetch", + "id": "def-public.payload", + "type": "Uncategorized", + "tags": [], + "label": "payload", + "description": [], + "signature": [ + "Payload" + ], + "path": "src/plugins/bfetch/public/batching/types.ts", + "deprecated": false + }, + { + "parentPluginId": "bfetch", + "id": "def-public.signal", + "type": "Object", + "tags": [], + "label": "signal", + "description": [], + "signature": [ + "AbortSignal | undefined" + ], + "path": "src/plugins/bfetch/public/batching/types.ts", + "deprecated": false + } + ], "initialIsOpen": false } ], @@ -86,11 +115,10 @@ ], "path": "src/plugins/bfetch/public/plugin.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "bfetch", - "id": "def-public.params", + "id": "def-public.BfetchPublicContract.fetchStreaming.$1", "type": "Object", "tags": [], "label": "params", @@ -99,9 +127,11 @@ "FetchStreamingParams" ], "path": "src/plugins/bfetch/public/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "bfetch", @@ -125,11 +155,10 @@ ], "path": "src/plugins/bfetch/public/plugin.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "bfetch", - "id": "def-public.params", + "id": "def-public.BfetchPublicContract.batchedFunction.$1", "type": "Object", "tags": [], "label": "params", @@ -139,9 +168,11 @@ "" ], "path": "src/plugins/bfetch/public/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "lifecycle": "start", @@ -184,11 +215,10 @@ ], "path": "src/plugins/bfetch/server/plugin.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "bfetch", - "id": "def-server.data", + "id": "def-server.BatchProcessingRouteParams.onBatchItem.$1", "type": "Uncategorized", "tags": [], "label": "data", @@ -197,9 +227,11 @@ "BatchItemData" ], "path": "src/plugins/bfetch/server/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -241,6 +273,48 @@ ], "path": "src/plugins/bfetch/server/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "bfetch", + "id": "def-server.context", + "type": "Object", + "tags": [], + "label": "context", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.RequestHandlerContext", + "text": "RequestHandlerContext" + } + ], + "path": "src/plugins/bfetch/server/types.ts", + "deprecated": false + }, + { + "parentPluginId": "bfetch", + "id": "def-server.request", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "src/plugins/bfetch/server/types.ts", + "deprecated": false + } + ], "initialIsOpen": false } ], @@ -283,21 +357,24 @@ ], "path": "src/plugins/bfetch/server/plugin.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "bfetch", - "id": "def-server.path", + "id": "def-server.BfetchServerSetup.addBatchProcessingRoute.$1", "type": "string", "tags": [], "label": "path", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/bfetch/server/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "bfetch", - "id": "def-server.handler", + "id": "def-server.BfetchServerSetup.addBatchProcessingRoute.$2", "type": "Function", "tags": [], "label": "handler", @@ -322,9 +399,11 @@ "" ], "path": "src/plugins/bfetch/server/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "bfetch", @@ -354,21 +433,24 @@ ], "path": "src/plugins/bfetch/server/plugin.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "bfetch", - "id": "def-server.path", + "id": "def-server.BfetchServerSetup.addStreamingResponseRoute.$1", "type": "string", "tags": [], "label": "path", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/bfetch/server/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "bfetch", - "id": "def-server.params", + "id": "def-server.BfetchServerSetup.addStreamingResponseRoute.$2", "type": "Function", "tags": [], "label": "params", @@ -393,9 +475,11 @@ "" ], "path": "src/plugins/bfetch/server/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "bfetch", @@ -625,42 +709,30 @@ ], "path": "src/plugins/bfetch/server/plugin.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "bfetch", - "id": "def-server.streamHandler", + "id": "def-server.BfetchServerSetup.createStreamingRequestHandler.$1", "type": "Function", "tags": [], "label": "streamHandler", "description": [], "signature": [ - "(context: ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.RequestHandlerContext", - "text": "RequestHandlerContext" - }, - ", request: ", - { - "pluginId": "core", + "pluginId": "bfetch", "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" + "docId": "kibBfetchPluginApi", + "section": "def-server.StreamingRequestHandler", + "text": "StreamingRequestHandler" }, - ") => ", - "Observable", - " | Promise<", - "Observable", - ">" + "" ], "path": "src/plugins/bfetch/server/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "lifecycle": "setup", @@ -1118,22 +1190,23 @@ ], "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "bfetch", - "id": "def-common.args", + "id": "def-common.BatchedFunctionParams.onCall.$1", "type": "Uncategorized", "tags": [], "label": "args", "description": [], "signature": [ - "Func extends (...args: infer P) => any ? P : never" + "Parameters" ], "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "bfetch", @@ -1147,11 +1220,10 @@ ], "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "bfetch", - "id": "def-common.items", + "id": "def-common.BatchedFunctionParams.onBatch.$1", "type": "Array", "tags": [], "label": "items", @@ -1160,9 +1232,11 @@ "BatchEntry[]" ], "path": "src/plugins/bfetch/common/buffer/create_batched_function.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "bfetch", @@ -1393,11 +1467,10 @@ ], "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "bfetch", - "id": "def-common.items", + "id": "def-common.ItemBufferParams.onFlush.$1", "type": "Array", "tags": [], "label": "items", @@ -1406,9 +1479,11 @@ "Item[]" ], "path": "src/plugins/bfetch/common/buffer/item_buffer.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false diff --git a/api_docs/bfetch.mdx b/api_docs/bfetch.mdx index 113cf589fde00..d7f42be45a29a 100644 --- a/api_docs/bfetch.mdx +++ b/api_docs/bfetch.mdx @@ -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 | |-------------------|-----------|------------------------|-----------------| -| 73 | 1 | 62 | 2 | +| 77 | 1 | 66 | 2 | ## Client diff --git a/api_docs/cases.json b/api_docs/cases.json index e2dd6ffe5fd69..09c05ba433a52 100644 --- a/api_docs/cases.json +++ b/api_docs/cases.json @@ -444,11 +444,10 @@ ], "path": "x-pack/plugins/cases/public/components/all_cases/selector_modal/index.tsx", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "cases", - "id": "def-public.theCase", + "id": "def-public.AllCasesSelectorModalProps.onRowClick.$1", "type": "CompoundType", "tags": [], "label": "theCase", @@ -472,9 +471,11 @@ " | undefined" ], "path": "x-pack/plugins/cases/public/components/all_cases/selector_modal/index.tsx", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "cases", @@ -495,7 +496,30 @@ ") => void) | undefined" ], "path": "x-pack/plugins/cases/public/components/all_cases/selector_modal/index.tsx", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-public.AllCasesSelectorModalProps.updateCase.$1", + "type": "Object", + "tags": [], + "label": "newCase", + "description": [], + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.Case", + "text": "Case" + } + ], + "path": "x-pack/plugins/cases/public/components/all_cases/selector_modal/index.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "cases", @@ -550,7 +574,30 @@ ") => void) | undefined" ], "path": "x-pack/plugins/cases/public/components/case_view/index.tsx", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-public.CaseViewProps.onCaseDataSuccess.$1", + "type": "Object", + "tags": [], + "label": "data", + "description": [], + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.Case", + "text": "Case" + } + ], + "path": "x-pack/plugins/cases/public/components/case_view/index.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "cases", @@ -643,7 +690,44 @@ ", postComment: (args: PostComment) => Promise) => Promise) | undefined" ], "path": "x-pack/plugins/cases/public/components/create/index.tsx", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-public.CreateCaseProps.afterCaseCreated.$1", + "type": "Object", + "tags": [], + "label": "theCase", + "description": [], + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.Case", + "text": "Case" + } + ], + "path": "x-pack/plugins/cases/public/components/create/index.tsx", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "cases", + "id": "def-public.CreateCaseProps.afterCaseCreated.$2", + "type": "Function", + "tags": [], + "label": "postComment", + "description": [], + "signature": [ + "(args: PostComment) => Promise" + ], + "path": "x-pack/plugins/cases/public/components/create/index.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "cases", @@ -703,8 +787,8 @@ ], "path": "x-pack/plugins/cases/public/components/create/index.tsx", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "cases", @@ -726,11 +810,10 @@ ], "path": "x-pack/plugins/cases/public/components/create/index.tsx", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "cases", - "id": "def-public.theCase", + "id": "def-public.CreateCaseProps.onSuccess.$1", "type": "Object", "tags": [], "label": "theCase", @@ -745,9 +828,11 @@ } ], "path": "x-pack/plugins/cases/public/components/create/index.tsx", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "cases", @@ -911,13 +996,10 @@ ], "path": "x-pack/plugins/cases/public/types.ts", "deprecated": false, - "returnComment": [ - "A react component that displays all cases" - ], "children": [ { "parentPluginId": "cases", - "id": "def-public.props", + "id": "def-public.CasesUiStart.getAllCases.$1", "type": "Object", "tags": [], "label": "props", @@ -934,8 +1016,12 @@ } ], "path": "x-pack/plugins/cases/public/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } + ], + "returnComment": [ + "A react component that displays all cases" ] }, { @@ -968,13 +1054,10 @@ ], "path": "x-pack/plugins/cases/public/types.ts", "deprecated": false, - "returnComment": [ - "A react component that is a modal for selecting a case" - ], "children": [ { "parentPluginId": "cases", - "id": "def-public.props", + "id": "def-public.CasesUiStart.getAllCasesSelectorModal.$1", "type": "Object", "tags": [], "label": "props", @@ -991,8 +1074,12 @@ } ], "path": "x-pack/plugins/cases/public/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } + ], + "returnComment": [ + "A react component that is a modal for selecting a case" ] }, { @@ -1025,13 +1112,10 @@ ], "path": "x-pack/plugins/cases/public/types.ts", "deprecated": false, - "returnComment": [ - "A react component for viewing a specific case" - ], "children": [ { "parentPluginId": "cases", - "id": "def-public.props", + "id": "def-public.CasesUiStart.getCaseView.$1", "type": "Object", "tags": [], "label": "props", @@ -1048,8 +1132,12 @@ } ], "path": "x-pack/plugins/cases/public/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } + ], + "returnComment": [ + "A react component for viewing a specific case" ] }, { @@ -1082,13 +1170,10 @@ ], "path": "x-pack/plugins/cases/public/types.ts", "deprecated": false, - "returnComment": [ - "A react component for configuring a specific case" - ], "children": [ { "parentPluginId": "cases", - "id": "def-public.props", + "id": "def-public.CasesUiStart.getConfigureCases.$1", "type": "Object", "tags": [], "label": "props", @@ -1105,8 +1190,12 @@ } ], "path": "x-pack/plugins/cases/public/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } + ], + "returnComment": [ + "A react component for configuring a specific case" ] }, { @@ -1139,13 +1228,10 @@ ], "path": "x-pack/plugins/cases/public/types.ts", "deprecated": false, - "returnComment": [ - "A react component for creating a new case" - ], "children": [ { "parentPluginId": "cases", - "id": "def-public.props", + "id": "def-public.CasesUiStart.getCreateCase.$1", "type": "Object", "tags": [], "label": "props", @@ -1162,8 +1248,12 @@ } ], "path": "x-pack/plugins/cases/public/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } + ], + "returnComment": [ + "A react component for creating a new case" ] }, { @@ -1196,13 +1286,10 @@ ], "path": "x-pack/plugins/cases/public/types.ts", "deprecated": false, - "returnComment": [ - "A react component for showing recent cases" - ], "children": [ { "parentPluginId": "cases", - "id": "def-public.props", + "id": "def-public.CasesUiStart.getRecentCases.$1", "type": "Object", "tags": [], "label": "props", @@ -1219,8 +1306,12 @@ } ], "path": "x-pack/plugins/cases/public/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } + ], + "returnComment": [ + "A react component for showing recent cases" ] } ], @@ -3941,7 +4032,52 @@ "((caseId: string, caseConnectorId: string, subCaseId?: string | undefined) => void) | undefined" ], "path": "x-pack/plugins/cases/common/ui/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.UpdateByKey.fetchCaseUserActions.$1", + "type": "string", + "tags": [], + "label": "caseId", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/cases/common/ui/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "cases", + "id": "def-common.UpdateByKey.fetchCaseUserActions.$2", + "type": "string", + "tags": [], + "label": "caseConnectorId", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/cases/common/ui/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "cases", + "id": "def-common.UpdateByKey.fetchCaseUserActions.$3", + "type": "string", + "tags": [], + "label": "subCaseId", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/cases/common/ui/types.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] }, { "parentPluginId": "cases", @@ -3962,7 +4098,30 @@ ") => void) | undefined" ], "path": "x-pack/plugins/cases/common/ui/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "cases", + "id": "def-common.UpdateByKey.updateCase.$1", + "type": "Object", + "tags": [], + "label": "newCase", + "description": [], + "signature": [ + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.Case", + "text": "Case" + } + ], + "path": "x-pack/plugins/cases/common/ui/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "cases", @@ -3994,7 +4153,9 @@ "(() => void) | undefined" ], "path": "x-pack/plugins/cases/common/ui/types.ts", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "cases", @@ -4007,7 +4168,9 @@ "(() => void) | undefined" ], "path": "x-pack/plugins/cases/common/ui/types.ts", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false diff --git a/api_docs/cases.mdx b/api_docs/cases.mdx index 4358b94d4bf6f..f70eb15482103 100644 --- a/api_docs/cases.mdx +++ b/api_docs/cases.mdx @@ -18,7 +18,7 @@ Contact [Security Solution Threat Hunting](https://github.com/orgs/elastic/teams | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 451 | 0 | 409 | 14 | +| 459 | 0 | 417 | 14 | ## Client diff --git a/api_docs/charts.json b/api_docs/charts.json index ca9c53e55a0d3..177a63556d59b 100644 --- a/api_docs/charts.json +++ b/api_docs/charts.json @@ -1354,11 +1354,10 @@ ], "path": "src/plugins/charts/public/services/palettes/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "charts", - "id": "def-public.state", + "id": "def-public.PaletteDefinition.toExpression.$1", "type": "Uncategorized", "tags": [], "label": "state", @@ -1369,9 +1368,11 @@ "T | undefined" ], "path": "src/plugins/charts/public/services/palettes/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "charts", @@ -1403,11 +1404,10 @@ ], "path": "src/plugins/charts/public/services/palettes/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "charts", - "id": "def-public.series", + "id": "def-public.PaletteDefinition.getCategoricalColor.$1", "type": "Array", "tags": [], "label": "series", @@ -1425,11 +1425,12 @@ "[]" ], "path": "src/plugins/charts/public/services/palettes/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "charts", - "id": "def-public.chartConfiguration", + "id": "def-public.PaletteDefinition.getCategoricalColor.$2", "type": "Object", "tags": [], "label": "chartConfiguration", @@ -1445,11 +1446,12 @@ " | undefined" ], "path": "src/plugins/charts/public/services/palettes/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": false }, { "parentPluginId": "charts", - "id": "def-public.state", + "id": "def-public.PaletteDefinition.getCategoricalColor.$3", "type": "Uncategorized", "tags": [], "label": "state", @@ -1460,9 +1462,11 @@ "T | undefined" ], "path": "src/plugins/charts/public/services/palettes/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "charts", @@ -1478,21 +1482,24 @@ ], "path": "src/plugins/charts/public/services/palettes/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "charts", - "id": "def-public.size", + "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 + "deprecated": false, + "isRequired": true }, { "parentPluginId": "charts", - "id": "def-public.state", + "id": "def-public.PaletteDefinition.getCategoricalColors.$2", "type": "Uncategorized", "tags": [], "label": "state", @@ -1501,9 +1508,11 @@ "T | undefined" ], "path": "src/plugins/charts/public/services/palettes/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "charts", @@ -1533,7 +1542,70 @@ "((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 + "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.minmax", + "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.minmax.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.minmax.max", + "type": "number", + "tags": [], + "label": "max", + "description": [], + "path": "src/plugins/charts/public/services/palettes/types.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -1627,19 +1699,23 @@ ], "path": "src/plugins/charts/public/services/palettes/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "charts", - "id": "def-public.name", + "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 + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "charts", @@ -1661,8 +1737,8 @@ ], "path": "src/plugins/charts/public/services/palettes/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false diff --git a/api_docs/charts.mdx b/api_docs/charts.mdx index 5a8c7838f7d9a..55490f4c3d3c5 100644 --- a/api_docs/charts.mdx +++ b/api_docs/charts.mdx @@ -18,7 +18,7 @@ Contact [Kibana App](https://github.com/orgs/elastic/teams/kibana-app) for quest | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 190 | 2 | 159 | 1 | +| 195 | 2 | 164 | 1 | ## Client diff --git a/api_docs/core.json b/api_docs/core.json index 9ca4fa24806dd..eb40f8706ca4a 100644 --- a/api_docs/core.json +++ b/api_docs/core.json @@ -1453,8 +1453,8 @@ ], "path": "src/core/public/deprecations/deprecations_service.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "core", @@ -1472,19 +1472,23 @@ ], "path": "src/core/public/deprecations/deprecations_service.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-public.domainId", + "id": "def-public.DeprecationsServiceStart.getDeprecations.$1", "type": "string", "tags": [], "label": "domainId", "description": [], + "signature": [ + "string" + ], "path": "src/core/public/deprecations/deprecations_service.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -1502,11 +1506,10 @@ ], "path": "src/core/public/deprecations/deprecations_service.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-public.details", + "id": "def-public.DeprecationsServiceStart.isDeprecationResolvable.$1", "type": "Object", "tags": [], "label": "details", @@ -1515,9 +1518,11 @@ "DomainDeprecationDetails" ], "path": "src/core/public/deprecations/deprecations_service.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -1543,11 +1548,10 @@ ], "path": "src/core/public/deprecations/deprecations_service.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-public.details", + "id": "def-public.DeprecationsServiceStart.resolveDeprecation.$1", "type": "Object", "tags": [], "label": "details", @@ -1556,9 +1560,11 @@ "DomainDeprecationDetails" ], "path": "src/core/public/deprecations/deprecations_service.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -1784,11 +1790,10 @@ ], "path": "src/core/public/execution_context/execution_context_service.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-public.context", + "id": "def-public.ExecutionContextServiceStart.create.$1", "type": "Object", "tags": [], "label": "context", @@ -1797,9 +1802,11 @@ "KibanaExecutionContext" ], "path": "src/core/public/execution_context/execution_context_service.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -1868,11 +1875,10 @@ ], "path": "src/core/public/fatal_errors/fatal_errors_service.tsx", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-public.error", + "id": "def-public.FatalErrorsSetup.add.$1", "type": "CompoundType", "tags": [], "label": "error", @@ -1883,11 +1889,12 @@ "string | Error" ], "path": "src/core/public/fatal_errors/fatal_errors_service.tsx", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "core", - "id": "def-public.source", + "id": "def-public.FatalErrorsSetup.add.$2", "type": "string", "tags": [], "label": "source", @@ -1898,9 +1905,11 @@ "string | undefined" ], "path": "src/core/public/fatal_errors/fatal_errors_service.tsx", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -1926,8 +1935,8 @@ ], "path": "src/core/public/fatal_errors/fatal_errors_service.tsx", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -1958,22 +1967,34 @@ ], "path": "src/core/public/i18n/i18n_service.tsx", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-public.__0", + "id": "def-public.I18nStart.Context.$1.children", "type": "Object", "tags": [], - "label": "__0", + "label": "{ children }", "description": [], - "signature": [ - "{ children: React.ReactNode; }" - ], "path": "src/core/public/i18n/i18n_service.tsx", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.I18nStart.Context.$1.children.children", + "type": "CompoundType", + "tags": [], + "label": "children", + "description": [], + "signature": [ + "string | number | boolean | {} | React.ReactElement React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)> | React.ReactNodeArray | React.ReactPortal | null | undefined" + ], + "path": "src/core/public/i18n/i18n_service.tsx", + "deprecated": false + } + ] } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -2000,8 +2021,8 @@ ], "path": "src/core/public/execution_context/execution_context_container.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "core", @@ -2017,8 +2038,8 @@ ], "path": "src/core/public/execution_context/execution_context_container.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -2106,21 +2127,24 @@ ], "path": "src/core/public/ui_settings/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-public.key", + "id": "def-public.IUiSettingsClient.get.$1", "type": "string", "tags": [], "label": "key", "description": [], + "signature": [ + "string" + ], "path": "src/core/public/ui_settings/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "core", - "id": "def-public.defaultOverride", + "id": "def-public.IUiSettingsClient.get.$2", "type": "Uncategorized", "tags": [], "label": "defaultOverride", @@ -2129,9 +2153,11 @@ "T | undefined" ], "path": "src/core/public/ui_settings/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -2149,21 +2175,24 @@ ], "path": "src/core/public/ui_settings/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-public.key", + "id": "def-public.IUiSettingsClient.get$.$1", "type": "string", "tags": [], "label": "key", "description": [], + "signature": [ + "string" + ], "path": "src/core/public/ui_settings/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "core", - "id": "def-public.defaultOverride", + "id": "def-public.IUiSettingsClient.get$.$2", "type": "Uncategorized", "tags": [], "label": "defaultOverride", @@ -2172,9 +2201,11 @@ "T | undefined" ], "path": "src/core/public/ui_settings/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -2194,8 +2225,8 @@ ], "path": "src/core/public/ui_settings/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "core", @@ -2211,21 +2242,24 @@ ], "path": "src/core/public/ui_settings/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-public.key", + "id": "def-public.IUiSettingsClient.set.$1", "type": "string", "tags": [], "label": "key", "description": [], + "signature": [ + "string" + ], "path": "src/core/public/ui_settings/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "core", - "id": "def-public.value", + "id": "def-public.IUiSettingsClient.set.$2", "type": "Any", "tags": [], "label": "value", @@ -2234,9 +2268,11 @@ "any" ], "path": "src/core/public/ui_settings/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -2252,19 +2288,23 @@ ], "path": "src/core/public/ui_settings/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-public.key", + "id": "def-public.IUiSettingsClient.remove.$1", "type": "string", "tags": [], "label": "key", "description": [], + "signature": [ + "string" + ], "path": "src/core/public/ui_settings/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -2280,19 +2320,23 @@ ], "path": "src/core/public/ui_settings/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-public.key", + "id": "def-public.IUiSettingsClient.isDeclared.$1", "type": "string", "tags": [], "label": "key", "description": [], + "signature": [ + "string" + ], "path": "src/core/public/ui_settings/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -2308,19 +2352,23 @@ ], "path": "src/core/public/ui_settings/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-public.key", + "id": "def-public.IUiSettingsClient.isDefault.$1", "type": "string", "tags": [], "label": "key", "description": [], + "signature": [ + "string" + ], "path": "src/core/public/ui_settings/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -2336,19 +2384,23 @@ ], "path": "src/core/public/ui_settings/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-public.key", + "id": "def-public.IUiSettingsClient.isCustom.$1", "type": "string", "tags": [], "label": "key", "description": [], + "signature": [ + "string" + ], "path": "src/core/public/ui_settings/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -2364,19 +2416,23 @@ ], "path": "src/core/public/ui_settings/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-public.key", + "id": "def-public.IUiSettingsClient.isOverridden.$1", "type": "string", "tags": [], "label": "key", "description": [], + "signature": [ + "string" + ], "path": "src/core/public/ui_settings/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -2394,8 +2450,8 @@ ], "path": "src/core/public/ui_settings/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "core", @@ -2413,8 +2469,8 @@ ], "path": "src/core/public/ui_settings/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -3753,7 +3809,23 @@ } ], "path": "src/core/public/overlays/flyout/flyout_service.tsx", - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.element", + "type": "Uncategorized", + "tags": [], + "label": "element", + "description": [], + "signature": [ + "T" + ], + "path": "src/core/public/types.ts", + "deprecated": false + } + ] }, { "parentPluginId": "core", @@ -3834,7 +3906,23 @@ } ], "path": "src/core/public/overlays/modal/modal_service.tsx", - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.element", + "type": "Uncategorized", + "tags": [], + "label": "element", + "description": [], + "signature": [ + "T" + ], + "path": "src/core/public/types.ts", + "deprecated": false + } + ] }, { "parentPluginId": "core", @@ -6444,6 +6532,26 @@ ], "path": "src/core/public/types.ts", "deprecated": false, + "returnComment": [ + "a {@link UnmountCallback} that unmount the element on call." + ], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.element", + "type": "Uncategorized", + "tags": [], + "label": "element", + "description": [ + "the container element to render into" + ], + "signature": [ + "T" + ], + "path": "src/core/public/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -6484,6 +6592,29 @@ ], "path": "src/core/public/plugins/plugin.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.core", + "type": "Object", + "tags": [], + "label": "core", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.PluginInitializerContext", + "text": "PluginInitializerContext" + }, + "" + ], + "path": "src/core/public/plugins/plugin.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -6640,6 +6771,8 @@ ], "path": "src/core/public/index.ts", "deprecated": false, + "returnComment": [], + "children": [], "initialIsOpen": false }, { @@ -7085,6 +7218,8 @@ ], "path": "src/core/public/types.ts", "deprecated": false, + "returnComment": [], + "children": [], "initialIsOpen": false }, { @@ -7944,24 +8079,7 @@ "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", "deprecated": true, "removeBy": "7.16", - "references": [ - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/server/types.ts" - }, - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/server/types.ts" - }, - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/target/types/server/types.d.ts" - }, - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/target/types/server/types.d.ts" - } - ], + "references": [], "children": [ { "parentPluginId": "core", @@ -8150,121 +8268,8 @@ "path": "src/core/server/elasticsearch/legacy/scoped_cluster_client.ts", "deprecated": true, "removeBy": "7.16", - "references": [ - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/server/routes/api/data_streams/register_delete_route.ts" - }, - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/server/routes/api/indices/register_clear_cache_route.ts" - }, - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/server/routes/api/indices/register_close_route.ts" - }, - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/server/routes/api/indices/register_flush_route.ts" - }, - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/server/routes/api/indices/register_forcemerge_route.ts" - }, - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/server/routes/api/indices/register_list_route.ts" - }, - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/server/routes/api/indices/register_open_route.ts" - }, - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/server/routes/api/indices/register_refresh_route.ts" - }, - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/server/routes/api/indices/register_reload_route.ts" - }, - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/server/routes/api/indices/register_delete_route.ts" - }, - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/server/routes/api/indices/register_freeze_route.ts" - }, - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/server/routes/api/indices/register_unfreeze_route.ts" - }, - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/server/routes/api/templates/register_get_routes.ts" - }, - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/server/routes/api/templates/register_get_routes.ts" - }, - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/server/routes/api/templates/register_delete_route.ts" - }, - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/server/routes/api/templates/register_create_route.ts" - }, - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/server/routes/api/templates/register_update_route.ts" - }, - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/server/routes/api/templates/register_simulate_route.ts" - }, - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/server/routes/api/mapping/register_mapping_route.ts" - }, - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/server/routes/api/settings/register_load_route.ts" - }, - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/server/routes/api/settings/register_update_route.ts" - }, - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/server/routes/api/stats/register_stats_route.ts" - }, - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/server/routes/api/component_templates/get.ts" - }, - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/server/routes/api/component_templates/get.ts" - }, - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/server/routes/api/component_templates/create.ts" - }, - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/server/routes/api/component_templates/update.ts" - }, - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/server/routes/api/component_templates/delete.ts" - }, - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/server/routes/api/component_templates/privileges.ts" - } - ], - "children": [ + "references": [], + "children": [ { "parentPluginId": "core", "id": "def-server.LegacyScopedClusterClient.callAsCurrentUser.$1", @@ -10377,11 +10382,10 @@ ], "path": "src/core/server/deprecations/deprecations_service.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.deprecationContext", + "id": "def-server.DeprecationsServiceSetup.registerDeprecations.$1", "type": "Object", "tags": [], "label": "deprecationContext", @@ -10396,9 +10400,11 @@ } ], "path": "src/core/server/deprecations/deprecations_service.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -10607,23 +10613,26 @@ ], "path": "src/core/server/elasticsearch/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.type", + "id": "def-server.ElasticsearchServicePreboot.createClient.$1", "type": "string", "tags": [], "label": "type", "description": [ "Unique identifier of the client" ], + "signature": [ + "string" + ], "path": "src/core/server/elasticsearch/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.clientConfig", + "id": "def-server.ElasticsearchServicePreboot.createClient.$2", "type": "Object", "tags": [], "label": "clientConfig", @@ -10642,9 +10651,11 @@ "> | undefined" ], "path": "src/core/server/elasticsearch/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -10772,23 +10783,26 @@ ], "path": "src/core/server/elasticsearch/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.type", + "id": "def-server.ElasticsearchServiceStart.createClient.$1", "type": "string", "tags": [], "label": "type", "description": [ "Unique identifier of the client" ], + "signature": [ + "string" + ], "path": "src/core/server/elasticsearch/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.clientConfig", + "id": "def-server.ElasticsearchServiceStart.createClient.$2", "type": "Object", "tags": [], "label": "clientConfig", @@ -10807,9 +10821,11 @@ "> | undefined" ], "path": "src/core/server/elasticsearch/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -10860,10 +10876,6 @@ "path": "src/core/server/elasticsearch/types.ts", "deprecated": true, "references": [ - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/server/plugin.ts" - }, { "plugin": "globalSearch", "path": "x-pack/plugins/global_search/server/services/context.ts" @@ -11802,11 +11814,10 @@ ], "path": "src/core/server/http_resources/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.route", + "id": "def-server.HttpResources.register.$1", "type": "Object", "tags": [], "label": "route", @@ -11822,25 +11833,25 @@ "" ], "path": "src/core/server/http_resources/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.handler", + "id": "def-server.HttpResources.register.$2", "type": "Function", "tags": [], "label": "handler", "description": [], "signature": [ - "(context: Context, request: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" + "section": "def-server.RequestHandler", + "text": "RequestHandler" }, - ", response: { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + " | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", "Stream", " | undefined>(options: ", { @@ -12022,28 +12033,14 @@ "section": "def-server.HttpResourcesServiceToolkit", "text": "HttpResourcesServiceToolkit" }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - " | Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - ">" + ">" ], "path": "src/core/server/http_resources/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -12120,11 +12117,10 @@ ], "path": "src/core/server/http_resources/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.options", + "id": "def-server.HttpResourcesServiceToolkit.renderCoreApp.$1", "type": "Object", "tags": [], "label": "options", @@ -12140,9 +12136,11 @@ " | undefined" ], "path": "src/core/server/http_resources/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -12174,11 +12172,10 @@ ], "path": "src/core/server/http_resources/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.options", + "id": "def-server.HttpResourcesServiceToolkit.renderAnonymousCoreApp.$1", "type": "Object", "tags": [], "label": "options", @@ -12194,9 +12191,11 @@ " | undefined" ], "path": "src/core/server/http_resources/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -12228,11 +12227,10 @@ ], "path": "src/core/server/http_resources/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.options", + "id": "def-server.HttpResourcesServiceToolkit.renderHtml.$1", "type": "Object", "tags": [], "label": "options", @@ -12247,9 +12245,11 @@ } ], "path": "src/core/server/http_resources/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -12281,11 +12281,10 @@ ], "path": "src/core/server/http_resources/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.options", + "id": "def-server.HttpResourcesServiceToolkit.renderJs.$1", "type": "Object", "tags": [], "label": "options", @@ -12300,9 +12299,11 @@ } ], "path": "src/core/server/http_resources/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -12420,44 +12421,29 @@ ], "path": "src/core/server/elasticsearch/client/cluster_client.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.request", + "id": "def-server.IClusterClient.asScoped.$1", "type": "CompoundType", "tags": [], "label": "request", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.LegacyRequest", - "text": "LegacyRequest" - }, - " | ", { "pluginId": "core", "scope": "server", "docId": "kibCorePluginApi", - "section": "def-server.FakeRequest", - "text": "FakeRequest" + "section": "def-server.ScopeableRequest", + "text": "ScopeableRequest" } ], "path": "src/core/server/elasticsearch/client/cluster_client.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -13310,8 +13296,8 @@ ], "path": "src/core/server/elasticsearch/client/cluster_client.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -13612,8 +13598,8 @@ ], "path": "src/core/server/ui_settings/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "core", @@ -13629,19 +13615,23 @@ ], "path": "src/core/server/ui_settings/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.key", + "id": "def-server.IUiSettingsClient.get.$1", "type": "string", "tags": [], "label": "key", "description": [], + "signature": [ + "string" + ], "path": "src/core/server/ui_settings/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -13657,8 +13647,8 @@ ], "path": "src/core/server/ui_settings/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "core", @@ -13676,8 +13666,8 @@ ], "path": "src/core/server/ui_settings/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "core", @@ -13693,22 +13683,23 @@ ], "path": "src/core/server/ui_settings/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.changes", + "id": "def-server.IUiSettingsClient.setMany.$1", "type": "Object", "tags": [], "label": "changes", "description": [], "signature": [ - "{ [x: string]: any; }" + "Record" ], "path": "src/core/server/ui_settings/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -13724,21 +13715,24 @@ ], "path": "src/core/server/ui_settings/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.key", + "id": "def-server.IUiSettingsClient.set.$1", "type": "string", "tags": [], "label": "key", "description": [], + "signature": [ + "string" + ], "path": "src/core/server/ui_settings/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.value", + "id": "def-server.IUiSettingsClient.set.$2", "type": "Any", "tags": [], "label": "value", @@ -13747,9 +13741,11 @@ "any" ], "path": "src/core/server/ui_settings/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -13765,19 +13761,23 @@ ], "path": "src/core/server/ui_settings/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.key", + "id": "def-server.IUiSettingsClient.remove.$1", "type": "string", "tags": [], "label": "key", "description": [], + "signature": [ + "string" + ], "path": "src/core/server/ui_settings/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -13793,11 +13793,10 @@ ], "path": "src/core/server/ui_settings/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.keys", + "id": "def-server.IUiSettingsClient.removeMany.$1", "type": "Array", "tags": [], "label": "keys", @@ -13806,9 +13805,11 @@ "string[]" ], "path": "src/core/server/ui_settings/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -13824,19 +13825,23 @@ ], "path": "src/core/server/ui_settings/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.key", + "id": "def-server.IUiSettingsClient.isOverridden.$1", "type": "string", "tags": [], "label": "key", "description": [], + "signature": [ + "string" + ], "path": "src/core/server/ui_settings/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -13852,19 +13857,23 @@ ], "path": "src/core/server/ui_settings/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.key", + "id": "def-server.IUiSettingsClient.isSensitive.$1", "type": "string", "tags": [], "label": "key", "description": [], + "signature": [ + "string" + ], "path": "src/core/server/ui_settings/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -13992,25 +14001,8 @@ "path": "src/core/server/elasticsearch/legacy/api_types.ts", "deprecated": true, "removeBy": "7.16", - "references": [ - { - "plugin": "crossClusterReplication", - "path": "x-pack/plugins/cross_cluster_replication/server/plugin.ts" - }, - { - "plugin": "crossClusterReplication", - "path": "x-pack/plugins/cross_cluster_replication/server/plugin.ts" - }, - { - "plugin": "indexLifecycleManagement", - "path": "x-pack/plugins/index_lifecycle_management/server/plugin.ts" - }, - { - "plugin": "indexLifecycleManagement", - "path": "x-pack/plugins/index_lifecycle_management/server/plugin.ts" - } - ], - "children": [ + "references": [], + "children": [ { "parentPluginId": "core", "id": "def-server.LegacyAPICaller.Unnamed", @@ -16264,8 +16256,8 @@ ], "path": "src/core/server/metrics/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -17497,8 +17489,8 @@ ], "path": "src/core/server/preboot/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "core", @@ -17514,23 +17506,26 @@ ], "path": "src/core/server/preboot/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.reason", + "id": "def-server.PrebootServicePreboot.holdSetupUntilResolved.$1", "type": "string", "tags": [], "label": "reason", "description": [ "A string that explains the reason why this promise should hold `setup`. It's supposed to be a human\nreadable string that will be recorded in the logs or standard output." ], + "signature": [ + "string" + ], "path": "src/core/server/preboot/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.promise", + "id": "def-server.PrebootServicePreboot.holdSetupUntilResolved.$2", "type": "Object", "tags": [], "label": "promise", @@ -17541,9 +17536,11 @@ "Promise<{ shouldReloadConfig: boolean; } | undefined>" ], "path": "src/core/server/preboot/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -17586,11 +17583,10 @@ ], "path": "src/core/server/deprecations/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.context", + "id": "def-server.RegisterDeprecationsConfig.getDeprecations.$1", "type": "Object", "tags": [], "label": "context", @@ -17605,9 +17601,11 @@ } ], "path": "src/core/server/deprecations/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -18527,8 +18525,8 @@ ], "path": "src/core/server/status/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -18965,6 +18963,22 @@ ], "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.details", + "type": "Object", + "tags": [], + "label": "details", + "description": [], + "signature": [ + "DeprecatedConfigDetails" + ], + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -19021,6 +19035,8 @@ ], "path": "src/core/server/capabilities/types.ts", "deprecated": false, + "returnComment": [], + "children": [], "initialIsOpen": false }, { @@ -19051,6 +19067,52 @@ ], "path": "src/core/server/capabilities/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.request", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "src/core/server/capabilities/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.uiCapabilities", + "type": "Object", + "tags": [], + "label": "uiCapabilities", + "description": [], + "signature": [ + "Capabilities" + ], + "path": "src/core/server/capabilities/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.useDefaultCapabilities", + "type": "boolean", + "tags": [], + "label": "useDefaultCapabilities", + "description": [], + "path": "src/core/server/capabilities/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -19071,6 +19133,22 @@ ], "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.factory", + "type": "Object", + "tags": [], + "label": "factory", + "description": [], + "signature": [ + "ConfigDeprecationFactory" + ], + "path": "node_modules/@kbn/config/target/deprecation/types.d.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -19332,6 +19410,35 @@ ], "path": "src/core/server/context/container/context.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.context", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "T" + ], + "path": "src/core/server/context/container/context.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.args", + "type": "Array", + "tags": [], + "label": "args", + "description": [], + "signature": [ + "any[]" + ], + "path": "src/core/server/context/container/context.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -19572,6 +19679,55 @@ ], "path": "src/core/server/http_resources/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.context", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "src/core/server/http/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.request", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "src/core/server/http/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.response", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "src/core/server/http/router/router.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -19792,6 +19948,223 @@ ], "path": "src/core/server/context/container/context.ts", "deprecated": false, + "returnComment": [ + "The context value associated with this key. May also return a Promise which will be resolved before\nattaching to the context object." + ], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.context", + "type": "Object", + "tags": [], + "label": "context", + "description": [ + "- A partial context object containing only the keys for values provided by plugin dependencies" + ], + "signature": [ + "{ [P in Exclude]: Context[P]; }" + ], + "path": "src/core/server/context/container/context.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.rest", + "type": "Object", + "tags": [], + "label": "rest", + "description": [ + "- Additional parameters provided by the service owner of this context" + ], + "signature": [ + "[request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + "Stream", + " | undefined>(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; ok: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; accepted: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; noContent: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; }]" + ], + "path": "src/core/server/context/container/context.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -19911,16 +20284,7 @@ "path": "src/core/server/elasticsearch/legacy/cluster_client.ts", "deprecated": true, "removeBy": "7.16", - "references": [ - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/server/plugin.ts" - }, - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/server/plugin.ts" - } - ], + "references": [], "initialIsOpen": false }, { @@ -19957,18 +20321,6 @@ "deprecated": true, "removeBy": "7.16", "references": [ - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/server/types.ts" - }, - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/server/types.ts" - }, - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/server/types.ts" - }, { "plugin": "globalSearch", "path": "x-pack/plugins/global_search/server/types.ts" @@ -19984,18 +20336,6 @@ { "plugin": "globalSearch", "path": "x-pack/plugins/global_search/target/types/server/types.d.ts" - }, - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/target/types/server/types.d.ts" - }, - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/target/types/server/types.d.ts" - }, - { - "plugin": "indexManagement", - "path": "x-pack/plugins/index_management/target/types/server/types.d.ts" } ], "initialIsOpen": false @@ -20271,6 +20611,29 @@ ], "path": "src/core/server/plugins/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.core", + "type": "Object", + "tags": [], + "label": "core", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.PluginInitializerContext", + "text": "PluginInitializerContext" + }, + "" + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -20457,6 +20820,8 @@ ], "path": "src/core/server/index.ts", "deprecated": false, + "returnComment": [], + "children": [], "initialIsOpen": false }, { diff --git a/api_docs/core.mdx b/api_docs/core.mdx index 7dbeb6f4c05c1..7f97d7caea57f 100644 --- a/api_docs/core.mdx +++ b/api_docs/core.mdx @@ -18,7 +18,7 @@ import coreObj from './core.json'; | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2363 | 148 | 1081 | 31 | +| 2450 | 149 | 1165 | 31 | ## Client diff --git a/api_docs/core_application.json b/api_docs/core_application.json index 91b21b0669123..b5db33f2e6e5c 100644 --- a/api_docs/core_application.json +++ b/api_docs/core_application.json @@ -871,7 +871,9 @@ "(() => void) | undefined" ], "path": "src/core/public/application/types.ts", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -1495,31 +1497,29 @@ "path": "x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts" } ], - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-public.handler", + "id": "def-public.AppMountParameters.onAppLeave.$1", "type": "Function", "tags": [], "label": "handler", "description": [], "signature": [ - "(factory: ", - "AppLeaveActionFactory", - ", nextAppId?: string | undefined) => ", { "pluginId": "core", "scope": "public", "docId": "kibCoreApplicationPluginApi", - "section": "def-public.AppLeaveAction", - "text": "AppLeaveAction" + "section": "def-public.AppLeaveHandler", + "text": "AppLeaveHandler" } ], "path": "src/core/public/application/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -1543,11 +1543,10 @@ ], "path": "src/core/public/application/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-public.menuMount", + "id": "def-public.AppMountParameters.setHeaderActionMenu.$1", "type": "Function", "tags": [], "label": "menuMount", @@ -1563,9 +1562,11 @@ " | undefined" ], "path": "src/core/public/application/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -1951,6 +1952,35 @@ "path": "x-pack/plugins/security_solution/public/app/app.tsx" } ], + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.factory", + "type": "Object", + "tags": [], + "label": "factory", + "description": [], + "signature": [ + "AppLeaveActionFactory" + ], + "path": "src/core/public/application/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.nextAppId", + "type": "string", + "tags": [], + "label": "nextAppId", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/core/public/application/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -1991,6 +2021,31 @@ ], "path": "src/core/public/application/types.ts", "deprecated": false, + "returnComment": [ + "An unmounting function that will be called to unmount the application. See {@link AppUnmount}." + ], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.params", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.AppMountParameters", + "text": "AppMountParameters" + }, + "" + ], + "path": "src/core/public/application/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -2007,6 +2062,8 @@ ], "path": "src/core/public/application/types.ts", "deprecated": false, + "returnComment": [], + "children": [], "initialIsOpen": false }, { @@ -2079,6 +2136,29 @@ ], "path": "src/core/public/application/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-public.app", + "type": "Object", + "tags": [], + "label": "app", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.App", + "text": "App" + }, + "" + ], + "path": "src/core/public/application/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { diff --git a/api_docs/core_application.mdx b/api_docs/core_application.mdx index 9ce48ced2d738..9baa6247dc194 100644 --- a/api_docs/core_application.mdx +++ b/api_docs/core_application.mdx @@ -18,7 +18,7 @@ import coreApplicationObj from './core_application.json'; | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2363 | 148 | 1081 | 31 | +| 2450 | 149 | 1165 | 31 | ## Client diff --git a/api_docs/core_chrome.json b/api_docs/core_chrome.json index 873543cf4de41..dc1f3c7b89cc3 100644 --- a/api_docs/core_chrome.json +++ b/api_docs/core_chrome.json @@ -212,7 +212,24 @@ "((element: HTMLDivElement) => () => void) | undefined" ], "path": "src/core/public/chrome/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.ChromeHelpExtension.content.$1", + "type": "Object", + "tags": [], + "label": "element", + "description": [], + "signature": [ + "HTMLDivElement" + ], + "path": "src/core/public/chrome/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false diff --git a/api_docs/core_chrome.mdx b/api_docs/core_chrome.mdx index d8c9cb76483c5..32be6b8894aa4 100644 --- a/api_docs/core_chrome.mdx +++ b/api_docs/core_chrome.mdx @@ -18,7 +18,7 @@ import coreChromeObj from './core_chrome.json'; | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2363 | 148 | 1081 | 31 | +| 2450 | 149 | 1165 | 31 | ## Client diff --git a/api_docs/core_http.json b/api_docs/core_http.json index 2c5b3b0dc2b1a..c4f2272ec1e1b 100644 --- a/api_docs/core_http.json +++ b/api_docs/core_http.json @@ -1592,8 +1592,8 @@ ], "path": "src/core/public/http/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "core", @@ -1609,19 +1609,23 @@ ], "path": "src/core/public/http/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-public.url", + "id": "def-public.IBasePath.prepend.$1", "type": "string", "tags": [], "label": "url", "description": [], + "signature": [ + "string" + ], "path": "src/core/public/http/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -1637,19 +1641,23 @@ ], "path": "src/core/public/http/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-public.url", + "id": "def-public.IBasePath.remove.$1", "type": "string", "tags": [], "label": "url", "description": [], + "signature": [ + "string" + ], "path": "src/core/public/http/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -2826,11 +2834,10 @@ ], "path": "src/core/server/http/lifecycle/auth.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.data", + "id": "def-server.AuthToolkit.authenticated.$1", "type": "Object", "tags": [], "label": "data", @@ -2846,9 +2853,11 @@ " | undefined" ], "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -2871,8 +2880,8 @@ ], "path": "src/core/server/http/lifecycle/auth.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "core", @@ -2895,11 +2904,10 @@ ], "path": "src/core/server/http/lifecycle/auth.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.headers", + "id": "def-server.AuthToolkit.redirected.$1", "type": "CompoundType", "tags": [], "label": "headers", @@ -2908,9 +2916,11 @@ "({ location: string; } & Record<\"accept\" | \"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\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"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\" | \"warning\" | \"www-authenticate\", string | string[]>) | ({ location: string; } & Record)" ], "path": "src/core/server/http/lifecycle/auth.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -3493,11 +3503,10 @@ ], "path": "src/core/server/http/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.cookieOptions", + "id": "def-server.HttpServiceSetup.createCookieSessionStorageFactory.$1", "type": "Object", "tags": [], "label": "cookieOptions", @@ -3513,9 +3522,11 @@ "" ], "path": "src/core/server/http/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -3539,170 +3550,29 @@ ], "path": "src/core/server/http/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.handler", + "id": "def-server.HttpServiceSetup.registerOnPreRouting.$1", "type": "Function", "tags": [], "label": "handler", "description": [], "signature": [ - "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: { badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">; conflict: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">) => ", - "KibanaResponse", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | Buffer | ", - "Stream", - ">; }, toolkit: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreRoutingToolkit", - "text": "OnPreRoutingToolkit" - }, - ") => Next | RewriteUrl | ", - "KibanaResponse", - " | Promise>" + "section": "def-server.OnPreRoutingHandler", + "text": "OnPreRoutingHandler" + } ], "path": "src/core/server/http/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -3726,179 +3596,84 @@ ], "path": "src/core/server/http/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.handler", + "id": "def-server.HttpServiceSetup.registerOnPreAuth.$1", "type": "Function", "tags": [], "label": "handler", "description": [], "signature": [ - "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: { badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "<", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">; unauthorized: (options?: ", + "section": "def-server.OnPreAuthHandler", + "text": "OnPreAuthHandler" + } + ], + "path": "src/core/server/http/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.registerAuth", + "type": "Function", + "tags": [], + "label": "registerAuth", + "description": [ + "\nTo define custom authentication and/or authorization mechanism for incoming requests.\n" + ], + "signature": [ + "(handler: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.AuthenticationHandler", + "text": "AuthenticationHandler" + }, + ") => void" + ], + "path": "src/core/server/http/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.registerAuth.$1", + "type": "Function", + "tags": [], + "label": "handler", + "description": [], + "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">) => ", - "KibanaResponse", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | Buffer | ", - "Stream", - ">; }, toolkit: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreAuthToolkit", - "text": "OnPreAuthToolkit" - }, - ") => ", - "KibanaResponse", - " | Next | Promise<", - "KibanaResponse", - " | Next>" + "section": "def-server.AuthenticationHandler", + "text": "AuthenticationHandler" + } ], "path": "src/core/server/http/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.registerAuth", + "id": "def-server.HttpServiceSetup.registerOnPostAuth", "type": "Function", "tags": [], - "label": "registerAuth", + "label": "registerOnPostAuth", "description": [ - "\nTo define custom authentication and/or authorization mechanism for incoming requests.\n" + "\nTo define custom logic after Auth interceptor did make sure a user has access to the requested resource.\n" ], "signature": [ "(handler: ", @@ -3906,487 +3681,82 @@ "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthenticationHandler", - "text": "AuthenticationHandler" + "section": "def-server.OnPostAuthHandler", + "text": "OnPostAuthHandler" }, ") => void" ], "path": "src/core/server/http/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.handler", + "id": "def-server.HttpServiceSetup.registerOnPostAuth.$1", "type": "Function", "tags": [], "label": "handler", "description": [], "signature": [ - "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: { badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">; conflict: (options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "<", + "section": "def-server.OnPostAuthHandler", + "text": "OnPostAuthHandler" + } + ], + "path": "src/core/server/http/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.registerOnPreResponse", + "type": "Function", + "tags": [], + "label": "registerOnPreResponse", + "description": [ + "\nTo define custom logic to perform for the server response.\n" + ], + "signature": [ + "(handler: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.OnPreResponseHandler", + "text": "OnPreResponseHandler" + }, + ") => void" + ], + "path": "src/core/server/http/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.registerOnPreResponse.$1", + "type": "Function", + "tags": [], + "label": "handler", + "description": [], + "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">) => ", - "KibanaResponse", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | Buffer | ", - "Stream", - ">; }, toolkit: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthToolkit", - "text": "AuthToolkit" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.Authenticated", - "text": "Authenticated" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthNotHandled", - "text": "AuthNotHandled" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthRedirected", - "text": "AuthRedirected" - }, - " | Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.IKibanaResponse", - "text": "IKibanaResponse" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.Authenticated", - "text": "Authenticated" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthNotHandled", - "text": "AuthNotHandled" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.AuthRedirected", - "text": "AuthRedirected" - }, - ">" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.registerOnPostAuth", - "type": "Function", - "tags": [], - "label": "registerOnPostAuth", - "description": [ - "\nTo define custom logic after Auth interceptor did make sure a user has access to the requested resource.\n" - ], - "signature": [ - "(handler: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPostAuthHandler", - "text": "OnPostAuthHandler" - }, - ") => void" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.handler", - "type": "Function", - "tags": [], - "label": "handler", - "description": [], - "signature": [ - "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: { badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">) => ", - "KibanaResponse", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | Buffer | ", - "Stream", - ">; }, toolkit: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPostAuthToolkit", - "text": "OnPostAuthToolkit" - }, - ") => ", - "KibanaResponse", - " | Next | Promise<", - "KibanaResponse", - " | Next>" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "core", - "id": "def-server.HttpServiceSetup.registerOnPreResponse", - "type": "Function", - "tags": [], - "label": "registerOnPreResponse", - "description": [ - "\nTo define custom logic to perform for the server response.\n" - ], - "signature": [ - "(handler: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreResponseHandler", - "text": "OnPreResponseHandler" - }, - ") => void" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.handler", - "type": "Function", - "tags": [], - "label": "handler", - "description": [], - "signature": [ - "(request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", preResponse: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreResponseInfo", - "text": "OnPreResponseInfo" - }, - ", toolkit: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreResponseToolkit", - "text": "OnPreResponseToolkit" - }, - ") => Render | Next | Promise" + "section": "def-server.OnPreResponseHandler", + "text": "OnPreResponseHandler" + } ], "path": "src/core/server/http/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -4518,8 +3888,8 @@ ], "path": "src/core/server/http/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "core", @@ -4554,221 +3924,48 @@ "docId": "kibCorePluginApi", "section": "def-server.IContextContainer", "text": "IContextContainer" - } - ], - "path": "src/core/server/http/types.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.contextName", - "type": "Uncategorized", - "tags": [], - "label": "contextName", - "description": [], - "signature": [ - "ContextName" - ], - "path": "src/core/server/http/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.provider", - "type": "Function", - "tags": [], - "label": "provider", - "description": [], - "signature": [ - "(context: Pick>, request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ", response: { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "; badRequest: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">; unauthorized: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">; forbidden: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">; notFound: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">; conflict: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ErrorHttpResponseOptions", - "text": "ErrorHttpResponseOptions" - }, - ") => ", - "KibanaResponse", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">; customError: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.CustomHttpResponseOptions", - "text": "CustomHttpResponseOptions" - }, - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">) => ", - "KibanaResponse", - "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.ResponseError", - "text": "ResponseError" - }, - ">; redirected: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.RedirectResponseOptions", - "text": "RedirectResponseOptions" - }, - ") => ", - "KibanaResponse", - " | Buffer | ", - "Stream", - ">; ok: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | Buffer | ", - "Stream", - ">; accepted: (options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" - }, - ") => ", - "KibanaResponse", - " | Buffer | ", - "Stream", - ">; noContent: (options?: ", + } + ], + "path": "src/core/server/http/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.registerRouteHandlerContext.$1", + "type": "Uncategorized", + "tags": [], + "label": "contextName", + "description": [], + "signature": [ + "ContextName" + ], + "path": "src/core/server/http/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.HttpServiceSetup.registerRouteHandlerContext.$2", + "type": "Function", + "tags": [], + "label": "provider", + "description": [], + "signature": [ { "pluginId": "core", "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.HttpResponseOptions", - "text": "HttpResponseOptions" + "docId": "kibCorePluginApi", + "section": "def-server.IContextProvider", + "text": "IContextProvider" }, - ") => ", - "KibanaResponse", - "; }) => Context[ContextName] | Promise" + "" ], "path": "src/core/server/http/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -4791,8 +3988,8 @@ ], "path": "src/core/server/http/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -4896,8 +4093,8 @@ ], "path": "src/core/server/http/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -5678,7 +4875,56 @@ ">" ], "path": "src/core/server/http/router/router.ts", - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.context", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "src/core/server/http/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.request", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "src/core/server/http/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.response", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "src/core/server/http/router/router.ts", + "deprecated": false + } + ] } ] }, @@ -6117,7 +5363,56 @@ ">" ], "path": "src/core/server/http/router/router.ts", - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.context", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "src/core/server/http/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.request", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "src/core/server/http/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.response", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "src/core/server/http/router/router.ts", + "deprecated": false + } + ] } ] }, @@ -6556,7 +5851,56 @@ ">" ], "path": "src/core/server/http/router/router.ts", - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.context", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "src/core/server/http/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.request", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "src/core/server/http/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.response", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "src/core/server/http/router/router.ts", + "deprecated": false + } + ] } ] }, @@ -6995,7 +6339,56 @@ ">" ], "path": "src/core/server/http/router/router.ts", - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.context", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "src/core/server/http/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.request", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "src/core/server/http/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.response", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "src/core/server/http/router/router.ts", + "deprecated": false + } + ] } ] }, @@ -7434,7 +6827,56 @@ ">" ], "path": "src/core/server/http/router/router.ts", - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.context", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "src/core/server/http/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.request", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "src/core/server/http/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.response", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "src/core/server/http/router/router.ts", + "deprecated": false + } + ] } ] }, @@ -7877,7 +7319,56 @@ ">" ], "path": "src/core/server/http/router/router.ts", - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.context", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "src/core/server/http/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.request", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "src/core/server/http/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.response", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "src/core/server/http/router/router.ts", + "deprecated": false + } + ] } ] } @@ -8075,8 +7566,8 @@ ], "path": "src/core/server/http/lifecycle/on_post_auth.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -8105,8 +7596,8 @@ ], "path": "src/core/server/http/lifecycle/on_pre_auth.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -8242,11 +7733,10 @@ ], "path": "src/core/server/http/lifecycle/on_pre_response.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.responseRender", + "id": "def-server.OnPreResponseToolkit.render.$1", "type": "Object", "tags": [], "label": "responseRender", @@ -8261,9 +7751,11 @@ } ], "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -8287,11 +7779,10 @@ ], "path": "src/core/server/http/lifecycle/on_pre_response.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.responseExtensions", + "id": "def-server.OnPreResponseToolkit.next.$1", "type": "Object", "tags": [], "label": "responseExtensions", @@ -8307,9 +7798,11 @@ " | undefined" ], "path": "src/core/server/http/lifecycle/on_pre_response.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -8338,8 +7831,8 @@ ], "path": "src/core/server/http/lifecycle/on_pre_routing.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "core", @@ -8355,19 +7848,23 @@ ], "path": "src/core/server/http/lifecycle/on_pre_routing.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.url", + "id": "def-server.OnPreRoutingToolkit.rewriteUrl.$1", "type": "string", "tags": [], "label": "url", "description": [], + "signature": [ + "string" + ], "path": "src/core/server/http/lifecycle/on_pre_routing.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -8685,11 +8182,10 @@ ], "path": "src/core/server/http/router/validator/validator.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.value", + "id": "def-server.RouteValidationResultFactory.ok.$1", "type": "Uncategorized", "tags": [], "label": "value", @@ -8698,9 +8194,11 @@ "T" ], "path": "src/core/server/http/router/validator/validator.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -8722,11 +8220,10 @@ ], "path": "src/core/server/http/router/validator/validator.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.error", + "id": "def-server.RouteValidationResultFactory.badRequest.$1", "type": "CompoundType", "tags": [], "label": "error", @@ -8735,11 +8232,12 @@ "string | Error" ], "path": "src/core/server/http/router/validator/validator.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.path", + "id": "def-server.RouteValidationResultFactory.badRequest.$2", "type": "Array", "tags": [], "label": "path", @@ -8748,9 +8246,11 @@ "string[] | undefined" ], "path": "src/core/server/http/router/validator/validator.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -9090,11 +8590,10 @@ ], "path": "src/core/server/http/cookie_session_storage.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.sessionValue", + "id": "def-server.SessionStorageCookieOptions.validate.$1", "type": "CompoundType", "tags": [], "label": "sessionValue", @@ -9103,9 +8602,11 @@ "T | T[]" ], "path": "src/core/server/http/cookie_session_storage.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -9187,11 +8688,10 @@ ], "path": "src/core/server/http/session_storage.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.request", + "id": "def-server.SessionStorageFactory.asScoped.$1", "type": "Object", "tags": [], "label": "request", @@ -9207,9 +8707,11 @@ "" ], "path": "src/core/server/http/session_storage.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -9464,6 +8966,189 @@ ], "path": "src/core/server/http/lifecycle/auth.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.request", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "src/core/server/http/lifecycle/auth.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.response", + "type": "Object", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "{ badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; }" + ], + "path": "src/core/server/http/lifecycle/auth.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.toolkit", + "type": "Object", + "tags": [], + "label": "toolkit", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.AuthToolkit", + "text": "AuthToolkit" + } + ], + "path": "src/core/server/http/lifecycle/auth.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -9566,6 +9251,38 @@ ], "path": "src/core/server/http/auth_headers_storage.ts", "deprecated": false, + "returnComment": [ + "authentication headers {@link AuthHeaders} for - an incoming request." + ], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.request", + "type": "CompoundType", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.LegacyRequest", + "text": "LegacyRequest" + } + ], + "path": "src/core/server/http/auth_headers_storage.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -9606,6 +9323,36 @@ ], "path": "src/core/server/http/auth_state_storage.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.request", + "type": "CompoundType", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.LegacyRequest", + "text": "LegacyRequest" + } + ], + "path": "src/core/server/http/auth_state_storage.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -9718,8 +9465,38 @@ }, ") => boolean" ], - "path": "src/core/server/http/auth_state_storage.ts", - "deprecated": false, + "path": "src/core/server/http/auth_state_storage.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.request", + "type": "CompoundType", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.LegacyRequest", + "text": "LegacyRequest" + } + ], + "path": "src/core/server/http/auth_state_storage.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -10274,6 +10051,189 @@ ], "path": "src/core/server/http/lifecycle/on_post_auth.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.request", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "src/core/server/http/lifecycle/on_post_auth.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.response", + "type": "Object", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "{ badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; }" + ], + "path": "src/core/server/http/lifecycle/on_post_auth.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.toolkit", + "type": "Object", + "tags": [], + "label": "toolkit", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.OnPostAuthToolkit", + "text": "OnPostAuthToolkit" + } + ], + "path": "src/core/server/http/lifecycle/on_post_auth.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -10418,26 +10378,209 @@ "section": "def-server.RedirectResponseOptions", "text": "RedirectResponseOptions" }, - ") => ", - "KibanaResponse", - " | Buffer | ", - "Stream", - ">; }, toolkit: ", + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; }, toolkit: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.OnPreAuthToolkit", + "text": "OnPreAuthToolkit" + }, + ") => ", + "KibanaResponse", + " | Next | Promise<", + "KibanaResponse", + " | Next>" + ], + "path": "src/core/server/http/lifecycle/on_pre_auth.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.request", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "src/core/server/http/lifecycle/on_pre_auth.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.response", + "type": "Object", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "{ badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; }" + ], + "path": "src/core/server/http/lifecycle/on_pre_auth.ts", + "deprecated": false + }, { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreAuthToolkit", - "text": "OnPreAuthToolkit" - }, - ") => ", - "KibanaResponse", - " | Next | Promise<", - "KibanaResponse", - " | Next>" + "parentPluginId": "core", + "id": "def-server.toolkit", + "type": "Object", + "tags": [], + "label": "toolkit", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.OnPreAuthToolkit", + "text": "OnPreAuthToolkit" + } + ], + "path": "src/core/server/http/lifecycle/on_pre_auth.ts", + "deprecated": false + } ], - "path": "src/core/server/http/lifecycle/on_pre_auth.ts", - "deprecated": false, "initialIsOpen": false }, { @@ -10478,6 +10621,67 @@ ], "path": "src/core/server/http/lifecycle/on_pre_response.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.request", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "src/core/server/http/lifecycle/on_pre_response.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.preResponse", + "type": "Object", + "tags": [], + "label": "preResponse", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.OnPreResponseInfo", + "text": "OnPreResponseInfo" + } + ], + "path": "src/core/server/http/lifecycle/on_pre_response.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.toolkit", + "type": "Object", + "tags": [], + "label": "toolkit", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.OnPreResponseToolkit", + "text": "OnPreResponseToolkit" + } + ], + "path": "src/core/server/http/lifecycle/on_pre_response.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -10622,26 +10826,209 @@ "section": "def-server.RedirectResponseOptions", "text": "RedirectResponseOptions" }, - ") => ", - "KibanaResponse", - " | Buffer | ", - "Stream", - ">; }, toolkit: ", + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; }, toolkit: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.OnPreRoutingToolkit", + "text": "OnPreRoutingToolkit" + }, + ") => Next | RewriteUrl | ", + "KibanaResponse", + " | Promise>" + ], + "path": "src/core/server/http/lifecycle/on_pre_routing.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.request", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "src/core/server/http/lifecycle/on_pre_routing.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.response", + "type": "Object", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "{ badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; }" + ], + "path": "src/core/server/http/lifecycle/on_pre_routing.ts", + "deprecated": false + }, { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.OnPreRoutingToolkit", - "text": "OnPreRoutingToolkit" - }, - ") => Next | RewriteUrl | ", - "KibanaResponse", - " | Promise>" + "parentPluginId": "core", + "id": "def-server.toolkit", + "type": "Object", + "tags": [], + "label": "toolkit", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.OnPreRoutingToolkit", + "text": "OnPreRoutingToolkit" + } + ], + "path": "src/core/server/http/lifecycle/on_pre_routing.ts", + "deprecated": false + } ], - "path": "src/core/server/http/lifecycle/on_pre_routing.ts", - "deprecated": false, "initialIsOpen": false }, { @@ -10705,6 +11092,55 @@ ], "path": "src/core/server/http/router/router.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.context", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "src/core/server/http/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.request", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "src/core/server/http/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.response", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "src/core/server/http/router/router.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -10923,8 +11359,219 @@ "KibanaResponse", "; }) => Context[ContextName] | Promise" ], - "path": "src/core/server/http/types.ts", - "deprecated": false, + "path": "src/core/server/http/types.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.context", + "type": "Object", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "{ [P in Exclude]: Context[P]; }" + ], + "path": "src/core/server/context/container/context.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.rest", + "type": "Object", + "tags": [], + "label": "rest", + "description": [], + "signature": [ + "[request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + "Stream", + " | undefined>(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; ok: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; accepted: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; noContent: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; }]" + ], + "path": "src/core/server/context/container/context.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -11329,6 +11976,95 @@ ], "path": "src/core/server/http/router/router.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.handler", + "type": "Function", + "tags": [], + "label": "handler", + "description": [], + "signature": [ + "(context: Context, request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: ResponseFactory) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" + ], + "path": "src/core/server/http/router/router.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.context", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "src/core/server/http/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.request", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "src/core/server/http/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.response", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "src/core/server/http/router/router.ts", + "deprecated": false + } + ] + } + ], "initialIsOpen": false }, { @@ -11613,8 +12349,291 @@ "KibanaResponse", "; }>) => void" ], - "path": "src/core/server/http/router/router.ts", - "deprecated": false, + "path": "src/core/server/http/router/router.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.route", + "type": "Object", + "tags": [], + "label": "route", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteConfig", + "text": "RouteConfig" + }, + "" + ], + "path": "src/core/server/http/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.handler", + "type": "Function", + "tags": [], + "label": "handler", + "description": [], + "signature": [ + "(context: Context, request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ", response: { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ", + "Stream", + " | undefined>(options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; badRequest: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; unauthorized: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; forbidden: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; notFound: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; conflict: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ErrorHttpResponseOptions", + "text": "ErrorHttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; customError: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.CustomHttpResponseOptions", + "text": "CustomHttpResponseOptions" + }, + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">) => ", + "KibanaResponse", + "<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.ResponseError", + "text": "ResponseError" + }, + ">; redirected: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RedirectResponseOptions", + "text": "RedirectResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; ok: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; accepted: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + " | Buffer | ", + "Stream", + ">; noContent: (options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.HttpResponseOptions", + "text": "HttpResponseOptions" + }, + ") => ", + "KibanaResponse", + "; }) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + " | Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.IKibanaResponse", + "text": "IKibanaResponse" + }, + ">" + ], + "path": "src/core/server/http/router/router.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.context", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "Context" + ], + "path": "src/core/server/http/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.request", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "src/core/server/http/router/router.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.response", + "type": "Uncategorized", + "tags": [], + "label": "response", + "description": [], + "signature": [ + "ResponseFactory" + ], + "path": "src/core/server/http/router/router.ts", + "deprecated": false + } + ] + } + ], "initialIsOpen": false }, { @@ -11647,6 +12666,41 @@ ], "path": "src/core/server/http/router/validator/validator.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.data", + "type": "Any", + "tags": [], + "label": "data", + "description": [], + "signature": [ + "any" + ], + "path": "src/core/server/http/router/validator/validator.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.validationResult", + "type": "Object", + "tags": [], + "label": "validationResult", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.RouteValidationResultFactory", + "text": "RouteValidationResultFactory" + } + ], + "path": "src/core/server/http/router/validator/validator.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { diff --git a/api_docs/core_http.mdx b/api_docs/core_http.mdx index 99f0cdfbd708e..dabbf58dc339f 100644 --- a/api_docs/core_http.mdx +++ b/api_docs/core_http.mdx @@ -18,7 +18,7 @@ import coreHttpObj from './core_http.json'; | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2363 | 148 | 1081 | 31 | +| 2450 | 149 | 1165 | 31 | ## Client diff --git a/api_docs/core_saved_objects.json b/api_docs/core_saved_objects.json index e5f0119c2efc5..1712e35614408 100644 --- a/api_docs/core_saved_objects.json +++ b/api_docs/core_saved_objects.json @@ -9107,8 +9107,8 @@ ], "path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "core", @@ -9124,8 +9124,8 @@ ], "path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -12748,19 +12748,23 @@ ], "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.msg", + "id": "def-server.SavedObjectsMigrationLogger.debug.$1", "type": "string", "tags": [], "label": "msg", "description": [], + "signature": [ + "string" + ], "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -12774,19 +12778,23 @@ ], "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.msg", + "id": "def-server.SavedObjectsMigrationLogger.info.$1", "type": "string", "tags": [], "label": "msg", "description": [], + "signature": [ + "string" + ], "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -12820,19 +12828,23 @@ "path": "x-pack/plugins/lens/server/migrations/saved_object_migrations.ts" } ], - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.msg", + "id": "def-server.SavedObjectsMigrationLogger.warning.$1", "type": "string", "tags": [], "label": "msg", "description": [], + "signature": [ + "string" + ], "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -12846,19 +12858,23 @@ ], "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.msg", + "id": "def-server.SavedObjectsMigrationLogger.warn.$1", "type": "string", "tags": [], "label": "msg", "description": [], + "signature": [ + "string" + ], "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -12876,21 +12892,24 @@ ], "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.msg", + "id": "def-server.SavedObjectsMigrationLogger.error.$1", "type": "string", "tags": [], "label": "msg", "description": [], + "signature": [ + "string" + ], "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.meta", + "id": "def-server.SavedObjectsMigrationLogger.error.$2", "type": "Uncategorized", "tags": [], "label": "meta", @@ -12899,9 +12918,11 @@ "Meta" ], "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -13254,11 +13275,10 @@ ], "path": "src/core/server/saved_objects/saved_objects_service.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.req", + "id": "def-server.SavedObjectsRepositoryFactory.createScopedRepository.$1", "type": "Object", "tags": [], "label": "req", @@ -13274,11 +13294,12 @@ "" ], "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.includedHiddenTypes", + "id": "def-server.SavedObjectsRepositoryFactory.createScopedRepository.$2", "type": "Array", "tags": [], "label": "includedHiddenTypes", @@ -13289,9 +13310,11 @@ "string[] | undefined" ], "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -13315,11 +13338,10 @@ ], "path": "src/core/server/saved_objects/saved_objects_service.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.includedHiddenTypes", + "id": "def-server.SavedObjectsRepositoryFactory.createInternalRepository.$1", "type": "Array", "tags": [], "label": "includedHiddenTypes", @@ -13330,9 +13352,11 @@ "string[] | undefined" ], "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -13521,37 +13545,29 @@ ], "path": "src/core/server/saved_objects/saved_objects_service.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.clientFactoryProvider", + "id": "def-server.SavedObjectsServiceSetup.setClientFactoryProvider.$1", "type": "Function", "tags": [], "label": "clientFactoryProvider", "description": [], "signature": [ - "(repositoryFactory: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRepositoryFactory", - "text": "SavedObjectsRepositoryFactory" - }, - ") => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientFactory", - "text": "SavedObjectsClientFactory" + "section": "def-server.SavedObjectsClientFactoryProvider", + "text": "SavedObjectsClientFactoryProvider" } ], "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -13575,58 +13591,57 @@ ], "path": "src/core/server/saved_objects/saved_objects_service.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.priority", + "id": "def-server.SavedObjectsServiceSetup.addClientWrapper.$1", "type": "number", "tags": [], "label": "priority", "description": [], + "signature": [ + "number" + ], "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.id", + "id": "def-server.SavedObjectsServiceSetup.addClientWrapper.$2", "type": "string", "tags": [], "label": "id", "description": [], + "signature": [ + "string" + ], "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.factory", + "id": "def-server.SavedObjectsServiceSetup.addClientWrapper.$3", "type": "Function", "tags": [], "label": "factory", "description": [], "signature": [ - "(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientWrapperOptions", - "text": "SavedObjectsClientWrapperOptions" - }, - ") => Pick<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClient", - "text": "SavedObjectsClient" - }, - ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" + "section": "def-server.SavedObjectsClientWrapperFactory", + "text": "SavedObjectsClientWrapperFactory" + } ], "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -13650,11 +13665,10 @@ ], "path": "src/core/server/saved_objects/saved_objects_service.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.type", + "id": "def-server.SavedObjectsServiceSetup.registerType.$1", "type": "Object", "tags": [], "label": "type", @@ -13670,9 +13684,11 @@ "" ], "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -13727,11 +13743,10 @@ ], "path": "src/core/server/saved_objects/saved_objects_service.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.req", + "id": "def-server.SavedObjectsServiceStart.getScopedClient.$1", "type": "Object", "tags": [], "label": "req", @@ -13747,11 +13762,12 @@ "" ], "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.options", + "id": "def-server.SavedObjectsServiceStart.getScopedClient.$2", "type": "Object", "tags": [], "label": "options", @@ -13767,9 +13783,11 @@ " | undefined" ], "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -13801,11 +13819,10 @@ ], "path": "src/core/server/saved_objects/saved_objects_service.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.req", + "id": "def-server.SavedObjectsServiceStart.createScopedRepository.$1", "type": "Object", "tags": [], "label": "req", @@ -13823,11 +13840,12 @@ "" ], "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.includedHiddenTypes", + "id": "def-server.SavedObjectsServiceStart.createScopedRepository.$2", "type": "Array", "tags": [], "label": "includedHiddenTypes", @@ -13838,9 +13856,11 @@ "string[] | undefined" ], "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -13864,11 +13884,10 @@ ], "path": "src/core/server/saved_objects/saved_objects_service.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.includedHiddenTypes", + "id": "def-server.SavedObjectsServiceStart.createInternalRepository.$1", "type": "Array", "tags": [], "label": "includedHiddenTypes", @@ -13879,9 +13898,11 @@ "string[] | undefined" ], "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -13904,8 +13925,8 @@ ], "path": "src/core/server/saved_objects/saved_objects_service.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "core", @@ -13937,669 +13958,87 @@ ], "path": "src/core/server/saved_objects/saved_objects_service.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "core", - "id": "def-server.client", + "id": "def-server.SavedObjectsServiceStart.createExporter.$1", "type": "Object", "tags": [], "label": "client", "description": [], "signature": [ - "{ get: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - "SavedObject", - ">; delete: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteOptions", - "text": "SavedObjectsDeleteOptions" - }, - ") => Promise<{}>; create: (type: string, attributes: T, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - "SavedObject", - ">; bulkCreate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResponse", - "text": "SavedObjectsBulkResponse" - }, - ">; checkConflicts: (objects?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCheckConflictsObject", - "text": "SavedObjectsCheckConflictsObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCheckConflictsResponse", - "text": "SavedObjectsCheckConflictsResponse" - }, - ">; find: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptions", - "text": "SavedObjectsFindOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindResponse", - "text": "SavedObjectsFindResponse" - }, - ">; bulkGet: (objects?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkGetObject", - "text": "SavedObjectsBulkGetObject" - }, - "[], options?: ", + "Pick<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" }, - ") => Promise<", + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" + ], + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsServiceStart.createImporter", + "type": "Function", + "tags": [], + "label": "createImporter", + "description": [ + "\nCreates an {@link ISavedObjectsImporter | importer} bound to given client." + ], + "signature": [ + "(client: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">) => Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImporter", + "text": "SavedObjectsImporter" + }, + ", \"import\" | \"resolveImportErrors\">" + ], + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsServiceStart.createImporter.$1", + "type": "Object", + "tags": [], + "label": "client", + "description": [], + "signature": [ + "Pick<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResponse", - "text": "SavedObjectsBulkResponse" + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" }, - ">; resolve: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsResolveResponse", - "text": "SavedObjectsResolveResponse" - }, - ">; update: (type: string, id: string, attributes: Partial, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" - }, - ">; collectMultiNamespaceReferences: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", - "text": "SavedObjectsCollectMultiNamespaceReferencesObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", - "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse", - "text": "SavedObjectsCollectMultiNamespaceReferencesResponse" - }, - ">; updateObjectsSpaces: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesObject", - "text": "SavedObjectsUpdateObjectsSpacesObject" - }, - "[], spacesToAdd: string[], spacesToRemove: string[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", - "text": "SavedObjectsUpdateObjectsSpacesOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesResponse", - "text": "SavedObjectsUpdateObjectsSpacesResponse" - }, - ">; bulkUpdate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateOptions", - "text": "SavedObjectsBulkUpdateOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateResponse", - "text": "SavedObjectsBulkUpdateResponse" - }, - ">; removeReferencesTo: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToOptions", - "text": "SavedObjectsRemoveReferencesToOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToResponse", - "text": "SavedObjectsRemoveReferencesToResponse" - }, - ">; openPointInTimeForType: (type: string | string[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeOptions", - "text": "SavedObjectsOpenPointInTimeOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeResponse", - "text": "SavedObjectsOpenPointInTimeResponse" - }, - ">; closePointInTime: (id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClosePointInTimeResponse", - "text": "SavedObjectsClosePointInTimeResponse" - }, - ">; createPointInTimeFinder: (findOptions: Pick<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptions", - "text": "SavedObjectsFindOptions" - }, - ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, dependencies?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", - "text": "SavedObjectsCreatePointInTimeFinderDependencies" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.ISavedObjectsPointInTimeFinder", - "text": "ISavedObjectsPointInTimeFinder" - }, - "; errors: typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - "; }" - ], - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceStart.createImporter", - "type": "Function", - "tags": [], - "label": "createImporter", - "description": [ - "\nCreates an {@link ISavedObjectsImporter | importer} bound to given client." - ], - "signature": [ - "(client: Pick<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClient", - "text": "SavedObjectsClient" - }, - ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">) => Pick<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImporter", - "text": "SavedObjectsImporter" - }, - ", \"import\" | \"resolveImportErrors\">" - ], - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.client", - "type": "Object", - "tags": [], - "label": "client", - "description": [], - "signature": [ - "{ get: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - "SavedObject", - ">; delete: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteOptions", - "text": "SavedObjectsDeleteOptions" - }, - ") => Promise<{}>; create: (type: string, attributes: T, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - "SavedObject", - ">; bulkCreate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResponse", - "text": "SavedObjectsBulkResponse" - }, - ">; checkConflicts: (objects?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCheckConflictsObject", - "text": "SavedObjectsCheckConflictsObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCheckConflictsResponse", - "text": "SavedObjectsCheckConflictsResponse" - }, - ">; find: (options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptions", - "text": "SavedObjectsFindOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindResponse", - "text": "SavedObjectsFindResponse" - }, - ">; bulkGet: (objects?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkGetObject", - "text": "SavedObjectsBulkGetObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResponse", - "text": "SavedObjectsBulkResponse" - }, - ">; resolve: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsResolveResponse", - "text": "SavedObjectsResolveResponse" - }, - ">; update: (type: string, id: string, attributes: Partial, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" - }, - ">; collectMultiNamespaceReferences: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", - "text": "SavedObjectsCollectMultiNamespaceReferencesObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", - "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse", - "text": "SavedObjectsCollectMultiNamespaceReferencesResponse" - }, - ">; updateObjectsSpaces: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesObject", - "text": "SavedObjectsUpdateObjectsSpacesObject" - }, - "[], spacesToAdd: string[], spacesToRemove: string[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", - "text": "SavedObjectsUpdateObjectsSpacesOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesResponse", - "text": "SavedObjectsUpdateObjectsSpacesResponse" - }, - ">; bulkUpdate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateOptions", - "text": "SavedObjectsBulkUpdateOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateResponse", - "text": "SavedObjectsBulkUpdateResponse" - }, - ">; removeReferencesTo: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToOptions", - "text": "SavedObjectsRemoveReferencesToOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToResponse", - "text": "SavedObjectsRemoveReferencesToResponse" - }, - ">; openPointInTimeForType: (type: string | string[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeOptions", - "text": "SavedObjectsOpenPointInTimeOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeResponse", - "text": "SavedObjectsOpenPointInTimeResponse" - }, - ">; closePointInTime: (id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClosePointInTimeResponse", - "text": "SavedObjectsClosePointInTimeResponse" - }, - ">; createPointInTimeFinder: (findOptions: Pick<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptions", - "text": "SavedObjectsFindOptions" - }, - ", \"type\" | \"filter\" | \"aggs\" | \"fields\" | \"perPage\" | \"sortField\" | \"sortOrder\" | \"search\" | \"searchFields\" | \"rootSearchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"typeToNamespacesMap\" | \"preference\">, dependencies?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", - "text": "SavedObjectsCreatePointInTimeFinderDependencies" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.ISavedObjectsPointInTimeFinder", - "text": "ISavedObjectsPointInTimeFinder" - }, - "; errors: typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - "; }" + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">" ], "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -14623,8 +14062,8 @@ ], "path": "src/core/server/saved_objects/saved_objects_service.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -14941,7 +14380,25 @@ ") => string) | undefined" ], "path": "src/core/server/saved_objects/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsTypeManagementDefinition.getTitle.$1", + "type": "Object", + "tags": [], + "label": "savedObject", + "description": [], + "signature": [ + "SavedObject", + "" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -14958,7 +14415,25 @@ ") => string) | undefined" ], "path": "src/core/server/saved_objects/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsTypeManagementDefinition.getEditUrl.$1", + "type": "Object", + "tags": [], + "label": "savedObject", + "description": [], + "signature": [ + "SavedObject", + "" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "core", @@ -14975,7 +14450,27 @@ ") => { path: string; uiCapabilitiesPath: string; }) | undefined" ], "path": "src/core/server/saved_objects/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsTypeManagementDefinition.getInAppUrl.$1", + "type": "Object", + "tags": [], + "label": "savedObject", + "description": [], + "signature": [ + "SavedObject", + "" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "an object containing a `path` and `uiCapabilitiesPath` properties. the `path` is the path to\nthe object page, relative to the base path. `uiCapabilitiesPath` is the path to check in the\n{@link Capabilities | uiCapabilities} to check if the user has permission to access the object." + ] }, { "parentPluginId": "core", @@ -15948,6 +15443,41 @@ ], "path": "src/core/server/saved_objects/migrations/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.doc", + "type": "CompoundType", + "tags": [], + "label": "doc", + "description": [], + "signature": [ + "SavedObjectDoc & Partial" + ], + "path": "src/core/server/saved_objects/migrations/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.context", + "type": "Object", + "tags": [], + "label": "context", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectMigrationContext", + "text": "SavedObjectMigrationContext" + } + ], + "path": "src/core/server/saved_objects/migrations/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -16312,6 +15842,30 @@ ], "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.__0", + "type": "Object", + "tags": [], + "label": "__0", + "description": [], + "signature": [ + "{ request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "; includedHiddenTypes?: string[] | undefined; }" + ], + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -16343,6 +15897,28 @@ ], "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.repositoryFactory", + "type": "Object", + "tags": [], + "label": "repositoryFactory", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRepositoryFactory", + "text": "SavedObjectsRepositoryFactory" + } + ], + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -16375,6 +15951,28 @@ ], "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClientWrapperOptions", + "text": "SavedObjectsClientWrapperOptions" + } + ], + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -16457,6 +16055,42 @@ ], "path": "src/core/server/saved_objects/export/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.context", + "type": "Object", + "tags": [], + "label": "context", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExportTransformContext", + "text": "SavedObjectsExportTransformContext" + } + ], + "path": "src/core/server/saved_objects/export/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.objects", + "type": "Array", + "tags": [], + "label": "objects", + "description": [], + "signature": [ + "SavedObject", + "[]" + ], + "path": "src/core/server/saved_objects/export/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -16577,6 +16211,23 @@ ], "path": "src/core/server/saved_objects/import/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.objects", + "type": "Array", + "tags": [], + "label": "objects", + "description": [], + "signature": [ + "SavedObject", + "[]" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -16653,6 +16304,30 @@ ], "path": "src/core/server/saved_objects/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.toolkit", + "type": "Object", + "tags": [], + "label": "toolkit", + "description": [], + "signature": [ + "{ readonlyEsClient: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClient", + "text": "ElasticsearchClient" + }, + ", \"search\">; }" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { diff --git a/api_docs/core_saved_objects.mdx b/api_docs/core_saved_objects.mdx index bed2039941ed9..a138b077840f0 100644 --- a/api_docs/core_saved_objects.mdx +++ b/api_docs/core_saved_objects.mdx @@ -18,7 +18,7 @@ import coreSavedObjectsObj from './core_saved_objects.json'; | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2363 | 148 | 1081 | 31 | +| 2450 | 149 | 1165 | 31 | ## Client diff --git a/api_docs/dashboard.json b/api_docs/dashboard.json index 7254f3477a003..656364b835af5 100644 --- a/api_docs/dashboard.json +++ b/api_docs/dashboard.json @@ -1222,7 +1222,8 @@ "\nOptionally apply filers. NOTE: if given and used in conjunction with `dashboardId`, and the\nsaved dashboard has filters saved with it, this will _replace_ those filters." ], "signature": [ - "any[] | undefined" + "Filter", + "[] | undefined" ], "path": "src/plugins/dashboard/public/locator.ts", "deprecated": false @@ -1230,14 +1231,15 @@ { "parentPluginId": "dashboard", "id": "def-public.DashboardAppLocatorParams.query", - "type": "Any", + "type": "Object", "tags": [], "label": "query", "description": [ "\nOptionally set a query. NOTE: if given and used in conjunction with `dashboardId`, and the\nsaved dashboard has a query saved with it, this will _replace_ that query." ], "signature": [ - "any" + "Query", + " | undefined" ], "path": "src/plugins/dashboard/public/locator.ts", "deprecated": false @@ -1532,7 +1534,8 @@ "label": "filters", "description": [], "signature": [ - "any[]" + "Filter", + "[]" ], "path": "src/plugins/dashboard/public/types.ts", "deprecated": false @@ -1550,12 +1553,12 @@ { "parentPluginId": "dashboard", "id": "def-public.DashboardContainerInput.query", - "type": "Any", + "type": "Object", "tags": [], "label": "query", "description": [], "signature": [ - "any" + "{ query: string | { [key: string]: any; }; language: string; }" ], "path": "src/plugins/dashboard/public/types.ts", "deprecated": false @@ -1961,7 +1964,8 @@ "label": "getQuery", "description": [], "signature": [ - "() => any" + "() => ", + "Query" ], "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", "deprecated": false, @@ -1976,7 +1980,9 @@ "label": "getFilters", "description": [], "signature": [ - "() => any[]" + "() => ", + "Filter", + "[]" ], "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", "deprecated": false, @@ -1995,11 +2001,10 @@ ], "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "dashboard", - "id": "def-public.editMode", + "id": "def-public.DashboardSavedObject.getFullEditPath.$1", "type": "CompoundType", "tags": [], "label": "editMode", @@ -2008,9 +2013,11 @@ "boolean | undefined" ], "path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -2097,7 +2104,8 @@ "\nOptionally apply filers. NOTE: if given and used in conjunction with `dashboardId`, and the\nsaved dashboard has filters saved with it, this will _replace_ those filters." ], "signature": [ - "any[] | undefined" + "Filter", + "[] | undefined" ], "path": "src/plugins/dashboard/public/url_generator.ts", "deprecated": false @@ -2105,14 +2113,15 @@ { "parentPluginId": "dashboard", "id": "def-public.DashboardUrlGeneratorState.query", - "type": "Any", + "type": "Object", "tags": [], "label": "query", "description": [ "\nOptionally set a query. NOTE: if given and used in conjunction with `dashboardId`, and the\nsaved dashboard has a query saved with it, this will _replace_ that query." ], "signature": [ - "any" + "Query", + " | undefined" ], "path": "src/plugins/dashboard/public/url_generator.ts", "deprecated": false @@ -2508,8 +2517,8 @@ ], "path": "src/plugins/dashboard/public/plugin.tsx", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "dashboard", @@ -2523,8 +2532,8 @@ ], "path": "src/plugins/dashboard/public/plugin.tsx", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "dashboard", diff --git a/api_docs/dashboard.mdx b/api_docs/dashboard.mdx index 1ada2f7a695bd..2adae80a02061 100644 --- a/api_docs/dashboard.mdx +++ b/api_docs/dashboard.mdx @@ -18,7 +18,7 @@ import dashboardObj from './dashboard.json'; | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 160 | 4 | 137 | 9 | +| 160 | 1 | 137 | 9 | ## Client diff --git a/api_docs/data.json b/api_docs/data.json index 79656ada252c3..e4f94168f50be 100644 --- a/api_docs/data.json +++ b/api_docs/data.json @@ -1973,7 +1973,9 @@ "label": "getSearchSourceTimeFilter", "description": [], "signature": [ - "(forceNow?: Date | undefined) => any[]" + "(forceNow?: Date | undefined) => ", + "RangeFilter", + "[] | { meta: { index: string | undefined; params: {}; alias: string; disabled: boolean; negate: boolean; }; query: { bool: { should: { bool: { filter: { range: { [x: string]: { gte: string; lte: string; }; }; }[]; }; }[]; minimum_should_match: number; }; }; }[]" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, @@ -7554,7 +7556,9 @@ "section": "def-common.TimeRange", "text": "TimeRange" }, - ", options: { forceNow?: Date | undefined; fieldName?: string | undefined; } | undefined) => any" + ", options: { forceNow?: Date | undefined; fieldName?: string | undefined; } | undefined) => ", + "RangeFilter", + " | undefined" ], "path": "src/plugins/data/common/query/timefilter/get_time.ts", "deprecated": false, @@ -7818,7 +7822,8 @@ "label": "isFilter", "description": [], "signature": [ - "(x: unknown) => x is any" + "(x: unknown) => x is ", + "Filter" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -7851,7 +7856,9 @@ "label": "isFilters", "description": [], "signature": [ - "(x: unknown) => x is any[]" + "(x: unknown) => x is ", + "Filter", + "[]" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -7939,7 +7946,8 @@ "label": "isQuery", "description": [], "signature": [ - "(x: unknown) => x is any" + "(x: unknown) => x is ", + "Query" ], "path": "src/plugins/data/common/query/is_query.ts", "deprecated": false, @@ -8109,7 +8117,17 @@ "section": "def-common.GeoPoint", "text": "GeoPoint" }, - "; }) | ({ type: \"geo_bounding_box\"; } & WellKnownText) | undefined; filter?: any; }, \"filter\" | \"geo_bounding_box\"> & Pick<{ geo_bounding_box?: ({ type: \"geo_bounding_box\"; } & GeoBox) | ({ type: \"geo_bounding_box\"; } & { top_left: ", + "; }) | ({ type: \"geo_bounding_box\"; } & WellKnownText) | undefined; filter?: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"kibana_query\", ", + "Query", + "> | undefined; }, \"filter\" | \"geo_bounding_box\"> & Pick<{ geo_bounding_box?: ({ type: \"geo_bounding_box\"; } & GeoBox) | ({ type: \"geo_bounding_box\"; } & { top_left: ", { "pluginId": "data", "scope": "common", @@ -8141,7 +8159,17 @@ "section": "def-common.GeoPoint", "text": "GeoPoint" }, - "; }) | ({ type: \"geo_bounding_box\"; } & WellKnownText) | undefined; filter?: any; }, never>, \"enabled\" | \"id\" | \"filter\" | \"customLabel\" | \"schema\" | \"geo_bounding_box\" | \"json\" | \"timeShift\">, ", + "; }) | ({ type: \"geo_bounding_box\"; } & WellKnownText) | undefined; filter?: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"kibana_query\", ", + "Query", + "> | undefined; }, never>, \"enabled\" | \"id\" | \"filter\" | \"customLabel\" | \"schema\" | \"geo_bounding_box\" | \"json\" | \"timeShift\">, ", "AggExpressionType", ", ", { @@ -10294,7 +10322,8 @@ "label": "filters", "description": [], "signature": [ - "any[]" + "Filter", + "[]" ], "path": "src/plugins/data/public/actions/apply_filter_action.ts", "deprecated": false @@ -10363,7 +10392,9 @@ "signature": [ "({ data, negate, }: ", "ValueClickDataContext", - ") => Promise" + ") => Promise<", + "Filter", + "[]>" ], "path": "src/plugins/data/public/types.ts", "deprecated": false, @@ -10394,7 +10425,9 @@ "signature": [ "(event: ", "RangeSelectDataContext", - ") => Promise" + ") => Promise<", + "Filter", + "[]>" ], "path": "src/plugins/data/public/types.ts", "deprecated": false, @@ -11767,7 +11800,67 @@ ") | undefined" ], "path": "src/plugins/data/common/index_patterns/fields/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.IFieldType.toSpec.$1.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.IFieldType.toSpec.$1.options.getFormatterForField", + "type": "Function", + "tags": [], + "label": "getFormatterForField", + "description": [], + "signature": [ + "((field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + ") | undefined" + ], + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -11795,18 +11888,6 @@ "path": "src/plugins/data/common/index_patterns/types.ts", "deprecated": true, "references": [ - { - "plugin": "savedObjects", - "path": "src/plugins/saved_objects/public/types.ts" - }, - { - "plugin": "savedObjects", - "path": "src/plugins/saved_objects/public/types.ts" - }, - { - "plugin": "savedObjects", - "path": "src/plugins/saved_objects/public/types.ts" - }, { "plugin": "observability", "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts" @@ -12527,14 +12608,6 @@ "plugin": "observability", "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts" }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/embeddable/types.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/embeddable/types.ts" - }, { "plugin": "ml", "path": "x-pack/plugins/ml/public/application/jobs/new_job/utils/new_job_utils.ts" @@ -12796,7 +12869,46 @@ ") | undefined" ], "path": "src/plugins/data/common/index_patterns/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.IIndexPattern.getFormatterForField.$1", + "type": "CompoundType", + "tags": [], + "label": "field", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } + ], + "path": "src/plugins/data/common/index_patterns/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -14002,11 +14114,10 @@ ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-public.fields", + "id": "def-public.ISearchStartSearchSource.create.$1", "type": "Object", "tags": [], "label": "fields", @@ -14022,9 +14133,11 @@ " | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "data", @@ -14048,8 +14161,8 @@ ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -14117,11 +14230,10 @@ ], "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-public.agg", + "id": "def-public.OptionedValueProp.isCompatible.$1", "type": "Object", "tags": [], "label": "agg", @@ -14136,9 +14248,11 @@ } ], "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -14277,14 +14391,15 @@ { "parentPluginId": "data", "id": "def-public.SearchSourceFields.query", - "type": "Any", + "type": "Object", "tags": [], "label": "query", "description": [ "\n{@link Query}" ], "signature": [ - "any" + "Query", + " | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false @@ -14292,14 +14407,21 @@ { "parentPluginId": "data", "id": "def-public.SearchSourceFields.filter", - "type": "Any", + "type": "CompoundType", "tags": [], "label": "filter", "description": [ "\n{@link Filter}" ], "signature": [ - "any" + "Filter", + " | ", + "Filter", + "[] | (() => ", + "Filter", + " | ", + "Filter", + "[] | undefined) | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false @@ -14955,7 +15077,8 @@ "label": "CustomFilter", "description": [], "signature": [ - "any" + "Filter", + " & { query: any; }" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -15171,7 +15294,13 @@ "label": "ExecutionContextSearch", "description": [], "signature": [ - "{ filters?: any[] | undefined; query?: any; timeRange?: ", + "{ filters?: ", + "Filter", + "[] | undefined; query?: ", + "Query", + " | ", + "Query", + "[] | undefined; timeRange?: ", { "pluginId": "data", "scope": "common", @@ -15195,7 +15324,10 @@ "label": "ExistsFilter", "description": [], "signature": [ - "any" + "Filter", + " & { meta: ", + "FilterMeta", + "; exists?: { field: string; } | undefined; }" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -15408,6 +15540,32 @@ ], "path": "src/plugins/data/common/field_formats/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.key", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "path": "src/plugins/data/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.defaultOverride", + "type": "Uncategorized", + "tags": [], + "label": "defaultOverride", + "description": [], + "signature": [ + "T | undefined" + ], + "path": "src/plugins/data/common/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -15420,7 +15578,11 @@ "label": "Filter", "description": [], "signature": [ - "any" + "{ $state?: { store: ", + "FilterStateStore", + "; } | undefined; meta: ", + "FilterMeta", + "; query?: any; }" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -17737,6 +17899,42 @@ ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.request", + "type": "Uncategorized", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "SearchStrategyRequest" + ], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined" + ], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -18284,7 +18482,10 @@ "label": "MatchAllFilter", "description": [], "signature": [ - "any" + "Filter", + " & { meta: ", + "MatchAllFilterMeta", + "; match_all: any; }" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -18326,7 +18527,10 @@ "label": "PhraseFilter", "description": [], "signature": [ - "any" + "Filter", + " & { meta: ", + "PhraseFilterMeta", + "; script?: { script: { source?: string | undefined; lang?: \"painless\" | \"expression\" | \"mustache\" | \"java\" | undefined; params: { [key: string]: PhraseFilterValue; }; }; } | undefined; }" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -18343,13 +18547,30 @@ "label": "PhrasesFilter", "description": [], "signature": [ - "any" + "Filter", + " & { meta: ", + "PhrasesFilterMeta", + "; }" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, "references": [], "initialIsOpen": false }, + { + "parentPluginId": "data", + "id": "def-public.Query", + "type": "Type", + "tags": [], + "label": "Query", + "description": [], + "signature": [ + "{ query: string | { [key: string]: any; }; language: string; }" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/types.d.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "data", "id": "def-public.RangeFilter", @@ -18360,7 +18581,14 @@ "label": "RangeFilter", "description": [], "signature": [ - "any" + "Filter", + " & ", + "EsRangeFilter", + " & { meta: ", + "RangeFilterMeta", + "; script?: { script: { params: any; lang: ", + "ScriptLanguage", + "; source: string; }; } | undefined; match_all?: any; }" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -18386,7 +18614,10 @@ "label": "RangeFilterMeta", "description": [], "signature": [ - "any" + "FilterMeta", + " & { params: ", + "RangeFilterParams", + "; field?: string | undefined; formattedValue?: string | undefined; }" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -18403,7 +18634,7 @@ "label": "RangeFilterParams", "description": [], "signature": [ - "any" + "RangeFilterParams" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -19036,171 +19267,755 @@ { "parentPluginId": "data", "id": "def-public.esFilters.buildEmptyFilter", - "type": "Any", + "type": "Function", "tags": [], "label": "buildEmptyFilter", "description": [], "signature": [ - "any" + "(isPinned: boolean, index?: string | undefined) => ", + "Filter" ], "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.isPinned", + "type": "boolean", + "tags": [], + "label": "isPinned", + "description": [], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/build_empty_filter.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.index", + "type": "string", + "tags": [], + "label": "index", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/build_empty_filter.d.ts", + "deprecated": false + } + ] }, { "parentPluginId": "data", "id": "def-public.esFilters.buildPhrasesFilter", - "type": "Any", + "type": "Function", "tags": [], "label": "buildPhrasesFilter", "description": [], "signature": [ - "any" + "(field: ", + "IndexPatternFieldBase", + ", params: string[], indexPattern: ", + "IndexPatternBase", + ") => ", + "PhrasesFilter" ], "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.field", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "IndexPatternFieldBase" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/phrases_filter.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.params", + "type": "Array", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "string[]" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/phrases_filter.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.indexPattern", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + "IndexPatternBase" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/phrases_filter.d.ts", + "deprecated": false + } + ] }, { "parentPluginId": "data", "id": "def-public.esFilters.buildExistsFilter", - "type": "Any", + "type": "Function", "tags": [], "label": "buildExistsFilter", "description": [], "signature": [ - "any" + "(field: ", + "IndexPatternFieldBase", + ", indexPattern: ", + "IndexPatternBase", + ") => ", + "ExistsFilter" ], "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.field", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "IndexPatternFieldBase" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/exists_filter.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.indexPattern", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + "IndexPatternBase" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/exists_filter.d.ts", + "deprecated": false + } + ] }, { "parentPluginId": "data", "id": "def-public.esFilters.buildPhraseFilter", - "type": "Any", + "type": "Function", "tags": [], "label": "buildPhraseFilter", "description": [], "signature": [ - "any" + "(field: ", + "IndexPatternFieldBase", + ", value: PhraseFilterValue, indexPattern: ", + "IndexPatternBase", + ") => ", + "PhraseFilter" ], "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.field", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "IndexPatternFieldBase" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/phrase_filter.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.value", + "type": "CompoundType", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "string | number | boolean" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/phrase_filter.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.indexPattern", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + "IndexPatternBase" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/phrase_filter.d.ts", + "deprecated": false + } + ] }, { "parentPluginId": "data", "id": "def-public.esFilters.buildQueryFilter", - "type": "Any", + "type": "Function", "tags": [], "label": "buildQueryFilter", "description": [], "signature": [ - "any" + "(query: any, index: string, alias: string) => ", + "QueryStringFilter" ], "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.query", + "type": "Any", + "tags": [], + "label": "query", + "description": [], + "signature": [ + "any" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/query_string_filter.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.index", + "type": "string", + "tags": [], + "label": "index", + "description": [], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/query_string_filter.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.alias", + "type": "string", + "tags": [], + "label": "alias", + "description": [], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/query_string_filter.d.ts", + "deprecated": false + } + ] }, { "parentPluginId": "data", "id": "def-public.esFilters.buildRangeFilter", - "type": "Any", + "type": "Function", "tags": [], "label": "buildRangeFilter", "description": [], "signature": [ - "any" + "(field: ", + "IndexPatternFieldBase", + ", params: ", + "RangeFilterParams", + ", indexPattern: ", + "IndexPatternBase", + ", formattedValue?: string | undefined) => ", + "RangeFilter" ], "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.field", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "IndexPatternFieldBase" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/range_filter.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.params", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "RangeFilterParams" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/range_filter.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.indexPattern", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + "IndexPatternBase" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/range_filter.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.formattedValue", + "type": "string", + "tags": [], + "label": "formattedValue", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/range_filter.d.ts", + "deprecated": false + } + ] }, { "parentPluginId": "data", "id": "def-public.esFilters.isPhraseFilter", - "type": "Any", + "type": "Function", "tags": [], "label": "isPhraseFilter", "description": [], "signature": [ - "any" + "(filter: ", + "RangeFilter", + " | ", + "ExistsFilter", + " | ", + "GeoBoundingBoxFilter", + " | ", + "GeoPolygonFilter", + " | ", + "PhraseFilter", + " | ", + "PhrasesFilter", + " | ", + "MatchAllFilter", + " | ", + "MissingFilter", + ") => filter is ", + "PhraseFilter" ], "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.filter", + "type": "CompoundType", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "RangeFilter", + " | ", + "ExistsFilter", + " | ", + "GeoBoundingBoxFilter", + " | ", + "GeoPolygonFilter", + " | ", + "PhraseFilter", + " | ", + "PhrasesFilter", + " | ", + "MatchAllFilter", + " | ", + "MissingFilter" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/phrase_filter.d.ts", + "deprecated": false + } + ] }, { "parentPluginId": "data", "id": "def-public.esFilters.isExistsFilter", - "type": "Any", + "type": "Function", "tags": [], "label": "isExistsFilter", "description": [], "signature": [ - "any" + "(filter: ", + "RangeFilter", + " | ", + "ExistsFilter", + " | ", + "GeoBoundingBoxFilter", + " | ", + "GeoPolygonFilter", + " | ", + "PhraseFilter", + " | ", + "PhrasesFilter", + " | ", + "MatchAllFilter", + " | ", + "MissingFilter", + ") => filter is ", + "ExistsFilter" ], "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.filter", + "type": "CompoundType", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "RangeFilter", + " | ", + "ExistsFilter", + " | ", + "GeoBoundingBoxFilter", + " | ", + "GeoPolygonFilter", + " | ", + "PhraseFilter", + " | ", + "PhrasesFilter", + " | ", + "MatchAllFilter", + " | ", + "MissingFilter" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/exists_filter.d.ts", + "deprecated": false + } + ] }, { "parentPluginId": "data", "id": "def-public.esFilters.isPhrasesFilter", - "type": "Any", + "type": "Function", "tags": [], "label": "isPhrasesFilter", "description": [], "signature": [ - "any" + "(filter: ", + "RangeFilter", + " | ", + "ExistsFilter", + " | ", + "GeoBoundingBoxFilter", + " | ", + "GeoPolygonFilter", + " | ", + "PhraseFilter", + " | ", + "PhrasesFilter", + " | ", + "MatchAllFilter", + " | ", + "MissingFilter", + ") => filter is ", + "PhrasesFilter" ], "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.filter", + "type": "CompoundType", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "RangeFilter", + " | ", + "ExistsFilter", + " | ", + "GeoBoundingBoxFilter", + " | ", + "GeoPolygonFilter", + " | ", + "PhraseFilter", + " | ", + "PhrasesFilter", + " | ", + "MatchAllFilter", + " | ", + "MissingFilter" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/phrases_filter.d.ts", + "deprecated": false + } + ] }, { "parentPluginId": "data", "id": "def-public.esFilters.isRangeFilter", - "type": "Any", + "type": "Function", "tags": [], "label": "isRangeFilter", "description": [], "signature": [ - "any" + "(filter?: ", + "RangeFilter", + " | ", + "ExistsFilter", + " | ", + "GeoBoundingBoxFilter", + " | ", + "GeoPolygonFilter", + " | ", + "PhraseFilter", + " | ", + "PhrasesFilter", + " | ", + "MatchAllFilter", + " | ", + "MissingFilter", + " | undefined) => filter is ", + "RangeFilter" ], "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.filter", + "type": "CompoundType", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "RangeFilter", + " | ", + "ExistsFilter", + " | ", + "GeoBoundingBoxFilter", + " | ", + "GeoPolygonFilter", + " | ", + "PhraseFilter", + " | ", + "PhrasesFilter", + " | ", + "MatchAllFilter", + " | ", + "MissingFilter", + " | undefined" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/range_filter.d.ts", + "deprecated": false + } + ] }, { "parentPluginId": "data", "id": "def-public.esFilters.isMatchAllFilter", - "type": "Any", + "type": "Function", "tags": [], "label": "isMatchAllFilter", "description": [], "signature": [ - "any" + "(filter: ", + "RangeFilter", + " | ", + "ExistsFilter", + " | ", + "GeoBoundingBoxFilter", + " | ", + "GeoPolygonFilter", + " | ", + "PhraseFilter", + " | ", + "PhrasesFilter", + " | ", + "MatchAllFilter", + " | ", + "MissingFilter", + ") => filter is ", + "MatchAllFilter" ], "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.filter", + "type": "CompoundType", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "RangeFilter", + " | ", + "ExistsFilter", + " | ", + "GeoBoundingBoxFilter", + " | ", + "GeoPolygonFilter", + " | ", + "PhraseFilter", + " | ", + "PhrasesFilter", + " | ", + "MatchAllFilter", + " | ", + "MissingFilter" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/match_all_filter.d.ts", + "deprecated": false + } + ] }, { "parentPluginId": "data", "id": "def-public.esFilters.isMissingFilter", - "type": "Any", + "type": "Function", "tags": [], "label": "isMissingFilter", "description": [], "signature": [ - "any" + "(filter: ", + "RangeFilter", + " | ", + "ExistsFilter", + " | ", + "GeoBoundingBoxFilter", + " | ", + "GeoPolygonFilter", + " | ", + "PhraseFilter", + " | ", + "PhrasesFilter", + " | ", + "MatchAllFilter", + " | ", + "MissingFilter", + ") => filter is ", + "MissingFilter" ], "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.filter", + "type": "CompoundType", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "RangeFilter", + " | ", + "ExistsFilter", + " | ", + "GeoBoundingBoxFilter", + " | ", + "GeoPolygonFilter", + " | ", + "PhraseFilter", + " | ", + "PhrasesFilter", + " | ", + "MatchAllFilter", + " | ", + "MissingFilter" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/missing_filter.d.ts", + "deprecated": false + } + ] }, { "parentPluginId": "data", "id": "def-public.esFilters.isQueryStringFilter", - "type": "Any", + "type": "Function", "tags": [], "label": "isQueryStringFilter", "description": [], "signature": [ - "any" + "(filter: ", + "RangeFilter", + " | ", + "ExistsFilter", + " | ", + "GeoBoundingBoxFilter", + " | ", + "GeoPolygonFilter", + " | ", + "PhraseFilter", + " | ", + "PhrasesFilter", + " | ", + "MatchAllFilter", + " | ", + "MissingFilter", + ") => filter is ", + "QueryStringFilter" ], "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.filter", + "type": "CompoundType", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "RangeFilter", + " | ", + "ExistsFilter", + " | ", + "GeoBoundingBoxFilter", + " | ", + "GeoPolygonFilter", + " | ", + "PhraseFilter", + " | ", + "PhrasesFilter", + " | ", + "MatchAllFilter", + " | ", + "MissingFilter" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/query_string_filter.d.ts", + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -19210,7 +20025,9 @@ "label": "isFilterPinned", "description": [], "signature": [ - "(filter: any) => boolean | undefined" + "(filter: ", + "Filter", + ") => boolean | undefined" ], "path": "src/plugins/data/public/deprecated.ts", "deprecated": false, @@ -19219,12 +20036,16 @@ { "parentPluginId": "data", "id": "def-public.filter", - "type": "Any", + "type": "Object", "tags": [], "label": "filter", "description": [], "signature": [ - "any" + "{ $state?: { store: ", + "FilterStateStore", + "; } | undefined; meta: ", + "FilterMeta", + "; query?: any; }" ], "path": "node_modules/@kbn/es-query/target_types/filters/helpers/meta_filter.d.ts", "deprecated": false @@ -19239,7 +20060,11 @@ "label": "toggleFilterNegated", "description": [], "signature": [ - "(filter: any) => { meta: { negate: boolean; alias: string | null; disabled: boolean; controlledBy?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }; $state?: { store: any; } | undefined; query?: any; }" + "(filter: ", + "Filter", + ") => { meta: { negate: boolean; alias: string | null; disabled: boolean; controlledBy?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }; $state?: { store: ", + "FilterStateStore", + "; } | undefined; query?: any; }" ], "path": "src/plugins/data/public/deprecated.ts", "deprecated": false, @@ -19248,12 +20073,16 @@ { "parentPluginId": "data", "id": "def-public.filter", - "type": "Any", + "type": "Object", "tags": [], "label": "filter", "description": [], "signature": [ - "any" + "{ $state?: { store: ", + "FilterStateStore", + "; } | undefined; meta: ", + "FilterMeta", + "; query?: any; }" ], "path": "node_modules/@kbn/es-query/target_types/filters/helpers/meta_filter.d.ts", "deprecated": false @@ -19268,7 +20097,10 @@ "label": "disableFilter", "description": [], "signature": [ - "(filter: any) => any" + "(filter: ", + "Filter", + ") => ", + "Filter" ], "path": "src/plugins/data/public/deprecated.ts", "deprecated": false, @@ -19277,12 +20109,16 @@ { "parentPluginId": "data", "id": "def-public.filter", - "type": "Any", + "type": "Object", "tags": [], "label": "filter", "description": [], "signature": [ - "any" + "{ $state?: { store: ", + "FilterStateStore", + "; } | undefined; meta: ", + "FilterMeta", + "; query?: any; }" ], "path": "node_modules/@kbn/es-query/target_types/filters/helpers/meta_filter.d.ts", "deprecated": false @@ -19292,28 +20128,70 @@ { "parentPluginId": "data", "id": "def-public.esFilters.getPhraseFilterField", - "type": "Any", + "type": "Function", "tags": [], "label": "getPhraseFilterField", "description": [], "signature": [ - "any" + "(filter: ", + "PhraseFilter", + ") => string" ], "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.filter", + "type": "CompoundType", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "Filter", + " & { meta: ", + "PhraseFilterMeta", + "; script?: { script: { source?: string | undefined; lang?: \"painless\" | \"expression\" | \"mustache\" | \"java\" | undefined; params: { [key: string]: PhraseFilterValue; }; }; } | undefined; }" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/phrase_filter.d.ts", + "deprecated": false + } + ] }, { "parentPluginId": "data", "id": "def-public.esFilters.getPhraseFilterValue", - "type": "Any", + "type": "Function", "tags": [], "label": "getPhraseFilterValue", "description": [], "signature": [ - "any" + "(filter: ", + "PhraseFilter", + ") => PhraseFilterValue" ], "path": "src/plugins/data/public/deprecated.ts", - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.filter", + "type": "CompoundType", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "Filter", + " & { meta: ", + "PhraseFilterMeta", + "; script?: { script: { source?: string | undefined; lang?: \"painless\" | \"expression\" | \"mustache\" | \"java\" | undefined; params: { [key: string]: PhraseFilterValue; }; }; } | undefined; }" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/phrase_filter.d.ts", + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -19323,7 +20201,9 @@ "label": "getDisplayValueFromFilter", "description": [], "signature": [ - "(filter: any, indexPatterns: ", + "(filter: ", + "Filter", + ", indexPatterns: ", { "pluginId": "data", "scope": "common", @@ -19340,12 +20220,16 @@ { "parentPluginId": "data", "id": "def-public.filter", - "type": "Any", + "type": "Object", "tags": [], "label": "filter", "description": [], "signature": [ - "any" + "{ $state?: { store: ", + "FilterStateStore", + "; } | undefined; meta: ", + "FilterMeta", + "; query?: any; }" ], "path": "src/plugins/data/public/query/filter_manager/lib/get_display_value.ts", "deprecated": false @@ -19380,7 +20264,15 @@ "label": "compareFilters", "description": [], "signature": [ - "(first: any, second: any, comparatorOptions?: ", + "(first: ", + "Filter", + " | ", + "Filter", + "[], second: ", + "Filter", + " | ", + "Filter", + "[], comparatorOptions?: ", "FilterCompareOptions", " | undefined) => boolean" ], @@ -19391,12 +20283,15 @@ { "parentPluginId": "data", "id": "def-public.first", - "type": "Any", + "type": "CompoundType", "tags": [], "label": "first", "description": [], "signature": [ - "any" + "Filter", + " | ", + "Filter", + "[]" ], "path": "node_modules/@kbn/es-query/target_types/filters/helpers/compare_filters.d.ts", "deprecated": false @@ -19404,12 +20299,15 @@ { "parentPluginId": "data", "id": "def-public.second", - "type": "Any", + "type": "CompoundType", "tags": [], "label": "second", "description": [], "signature": [ - "any" + "Filter", + " | ", + "Filter", + "[]" ], "path": "node_modules/@kbn/es-query/target_types/filters/helpers/compare_filters.d.ts", "deprecated": false @@ -19467,7 +20365,9 @@ "section": "def-common.IFieldType", "text": "IFieldType" }, - ", values: any, operation: string, index: string) => any[]" + ", values: any, operation: string, index: string) => ", + "Filter", + "[]" ], "path": "src/plugins/data/public/deprecated.ts", "deprecated": false, @@ -19555,7 +20455,11 @@ "label": "onlyDisabledFiltersChanged", "description": [], "signature": [ - "(newFilters?: any[] | undefined, oldFilters?: any[] | undefined) => boolean" + "(newFilters?: ", + "Filter", + "[] | undefined, oldFilters?: ", + "Filter", + "[] | undefined) => boolean" ], "path": "src/plugins/data/public/deprecated.ts", "deprecated": false, @@ -19569,7 +20473,8 @@ "label": "newFilters", "description": [], "signature": [ - "any[] | undefined" + "Filter", + "[] | undefined" ], "path": "node_modules/@kbn/es-query/target_types/filters/helpers/only_disabled.d.ts", "deprecated": false @@ -19582,7 +20487,8 @@ "label": "oldFilters", "description": [], "signature": [ - "any[] | undefined" + "Filter", + "[] | undefined" ], "path": "node_modules/@kbn/es-query/target_types/filters/helpers/only_disabled.d.ts", "deprecated": false @@ -19599,7 +20505,9 @@ "signature": [ "(timeFilter: Pick<", "Timefilter", - ", \"isTimeRangeSelectorEnabled\" | \"isAutoRefreshSelectorEnabled\" | \"isTimeTouched\" | \"getEnabledUpdated$\" | \"getTimeUpdate$\" | \"getRefreshIntervalUpdate$\" | \"getAutoRefreshFetch$\" | \"getFetch$\" | \"getTime\" | \"getAbsoluteTime\" | \"setTime\" | \"getRefreshInterval\" | \"setRefreshInterval\" | \"createFilter\" | \"getBounds\" | \"calculateBounds\" | \"getActiveBounds\" | \"enableTimeRangeSelector\" | \"disableTimeRangeSelector\" | \"enableAutoRefreshSelector\" | \"disableAutoRefreshSelector\" | \"getTimeDefaults\" | \"getRefreshIntervalDefaults\">, filter: any) => void" + ", \"isTimeRangeSelectorEnabled\" | \"isAutoRefreshSelectorEnabled\" | \"isTimeTouched\" | \"getEnabledUpdated$\" | \"getTimeUpdate$\" | \"getRefreshIntervalUpdate$\" | \"getAutoRefreshFetch$\" | \"getFetch$\" | \"getTime\" | \"getAbsoluteTime\" | \"setTime\" | \"getRefreshInterval\" | \"setRefreshInterval\" | \"createFilter\" | \"getBounds\" | \"calculateBounds\" | \"getActiveBounds\" | \"enableTimeRangeSelector\" | \"disableTimeRangeSelector\" | \"enableAutoRefreshSelector\" | \"disableAutoRefreshSelector\" | \"getTimeDefaults\" | \"getRefreshIntervalDefaults\">, filter: ", + "RangeFilter", + ") => void" ], "path": "src/plugins/data/public/deprecated.ts", "deprecated": false, @@ -19687,7 +20595,9 @@ "section": "def-common.TimeRange", "text": "TimeRange" }, - " | undefined) => any; getBounds: () => ", + " | undefined) => ", + "RangeFilter", + " | undefined; getBounds: () => ", { "pluginId": "data", "scope": "common", @@ -19743,12 +20653,19 @@ { "parentPluginId": "data", "id": "def-public.filter", - "type": "Any", + "type": "CompoundType", "tags": [], "label": "filter", "description": [], "signature": [ - "any" + "Filter", + " & ", + "EsRangeFilter", + " & { meta: ", + "RangeFilterMeta", + "; script?: { script: { params: any; lang: ", + "ScriptLanguage", + "; source: string; }; } | undefined; match_all?: any; }" ], "path": "src/plugins/data/public/query/timefilter/lib/change_time_filter.ts", "deprecated": false @@ -19763,7 +20680,9 @@ "label": "convertRangeFilterToTimeRangeString", "description": [], "signature": [ - "(filter: any) => ", + "(filter: ", + "RangeFilter", + ") => ", { "pluginId": "data", "scope": "common", @@ -19779,12 +20698,19 @@ { "parentPluginId": "data", "id": "def-public.filter", - "type": "Any", + "type": "CompoundType", "tags": [], "label": "filter", "description": [], "signature": [ - "any" + "Filter", + " & ", + "EsRangeFilter", + " & { meta: ", + "RangeFilterMeta", + "; script?: { script: { params: any; lang: ", + "ScriptLanguage", + "; source: string; }; } | undefined; match_all?: any; }" ], "path": "src/plugins/data/public/query/timefilter/lib/change_time_filter.ts", "deprecated": false @@ -19799,7 +20725,11 @@ "label": "mapAndFlattenFilters", "description": [], "signature": [ - "(filters: any[]) => any[]" + "(filters: ", + "Filter", + "[]) => ", + "Filter", + "[]" ], "path": "src/plugins/data/public/deprecated.ts", "deprecated": false, @@ -19813,7 +20743,8 @@ "label": "filters", "description": [], "signature": [ - "any[]" + "Filter", + "[]" ], "path": "src/plugins/data/public/query/filter_manager/lib/map_and_flatten_filters.ts", "deprecated": false @@ -19828,7 +20759,13 @@ "label": "extractTimeFilter", "description": [], "signature": [ - "(timeFieldName: string, filters: any[]) => { restOfFilters: any[]; timeRangeFilter: any; }" + "(timeFieldName: string, filters: ", + "Filter", + "[]) => { restOfFilters: ", + "Filter", + "[]; timeRangeFilter: ", + "RangeFilter", + " | undefined; }" ], "path": "src/plugins/data/public/deprecated.ts", "deprecated": false, @@ -19852,7 +20789,8 @@ "label": "filters", "description": [], "signature": [ - "any[]" + "Filter", + "[]" ], "path": "src/plugins/data/public/query/timefilter/lib/extract_time_filter.ts", "deprecated": false @@ -19867,7 +20805,11 @@ "label": "extractTimeRange", "description": [], "signature": [ - "(filters: any[], timeFieldName?: string | undefined) => { restOfFilters: any[]; timeRange?: ", + "(filters: ", + "Filter", + "[], timeFieldName?: string | undefined) => { restOfFilters: ", + "Filter", + "[]; timeRange?: ", { "pluginId": "data", "scope": "common", @@ -19889,7 +20831,8 @@ "label": "filters", "description": [], "signature": [ - "any[]" + "Filter", + "[]" ], "path": "src/plugins/data/public/query/timefilter/lib/extract_time_filter.ts", "deprecated": false @@ -20751,11 +21694,23 @@ "signature": [ "(indexPattern: ", "IndexPatternBase", - " | undefined, queries: any, filters: any, config?: ", + " | undefined, queries: ", + "Query", + " | ", + "Query", + "[], filters: ", + "Filter", + " | ", + "Filter", + "[], config?: ", "EsQueryConfig", " | undefined) => { bool: { must: ", "DslQuery", - "[]; filter: any[]; should: never[]; must_not: any[]; }; }" + "[]; filter: ", + "Filter", + "[]; should: never[]; must_not: ", + "Filter", + "[]; }; }" ], "path": "src/plugins/data/public/deprecated.ts", "deprecated": false, @@ -20778,12 +21733,15 @@ { "parentPluginId": "data", "id": "def-public.queries", - "type": "Any", + "type": "CompoundType", "tags": [], "label": "queries", "description": [], "signature": [ - "any" + "Query", + " | ", + "Query", + "[]" ], "path": "node_modules/@kbn/es-query/target_types/es_query/build_es_query.d.ts", "deprecated": false @@ -20791,12 +21749,15 @@ { "parentPluginId": "data", "id": "def-public.filters", - "type": "Any", + "type": "CompoundType", "tags": [], "label": "filters", "description": [], "signature": [ - "any" + "Filter", + " | ", + "Filter", + "[]" ], "path": "node_modules/@kbn/es-query/target_types/es_query/build_es_query.d.ts", "deprecated": false @@ -20855,9 +21816,15 @@ "label": "buildQueryFromFilters", "description": [], "signature": [ - "(filters: any[] | undefined, indexPattern: ", + "(filters: ", + "Filter", + "[] | undefined, indexPattern: ", "IndexPatternBase", - " | undefined, ignoreFilterIfFieldNotInIndex?: boolean | undefined) => { must: never[]; filter: any[]; should: never[]; must_not: any[]; }" + " | undefined, ignoreFilterIfFieldNotInIndex?: boolean | undefined) => { must: never[]; filter: ", + "Filter", + "[]; should: never[]; must_not: ", + "Filter", + "[]; }" ], "path": "src/plugins/data/public/deprecated.ts", "deprecated": false, @@ -20871,7 +21838,8 @@ "label": "filters", "description": [], "signature": [ - "any[] | undefined" + "Filter", + "[] | undefined" ], "path": "node_modules/@kbn/es-query/target_types/es_query/from_filters.d.ts", "deprecated": false @@ -23191,7 +24159,9 @@ "\nquery service\n{@link QueryStart}" ], "signature": [ - "{ addToQueryLog: (appName: string, { language, query }: any) => void; filterManager: ", + "{ addToQueryLog: (appName: string, { language, query }: ", + "Query", + ") => void; filterManager: ", { "pluginId": "data", "scope": "public", @@ -23247,7 +24217,11 @@ }, " | undefined) => { bool: { must: ", "DslQuery", - "[]; filter: any[]; should: never[]; must_not: any[]; }; }; }" + "[]; filter: ", + "Filter", + "[]; should: never[]; must_not: ", + "Filter", + "[]; }; }; }" ], "path": "src/plugins/data/public/types.ts", "deprecated": false @@ -27350,9 +28324,15 @@ "label": "buildQueryFromFilters", "description": [], "signature": [ - "(filters: any[] | undefined, indexPattern: ", + "(filters: ", + "Filter", + "[] | undefined, indexPattern: ", "IndexPatternBase", - " | undefined, ignoreFilterIfFieldNotInIndex?: boolean | undefined) => { must: never[]; filter: any[]; should: never[]; must_not: any[]; }" + " | undefined, ignoreFilterIfFieldNotInIndex?: boolean | undefined) => { must: never[]; filter: ", + "Filter", + "[]; should: never[]; must_not: ", + "Filter", + "[]; }" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -27367,7 +28347,8 @@ "label": "filters", "description": [], "signature": [ - "any[] | undefined" + "Filter", + "[] | undefined" ], "path": "node_modules/@kbn/es-query/target_types/es_query/from_filters.d.ts", "deprecated": false @@ -27507,7 +28488,9 @@ "section": "def-common.TimeRange", "text": "TimeRange" }, - ", options: { forceNow?: Date | undefined; fieldName?: string | undefined; } | undefined) => any" + ", options: { forceNow?: Date | undefined; fieldName?: string | undefined; } | undefined) => ", + "RangeFilter", + " | undefined" ], "path": "src/plugins/data/common/query/timefilter/get_time.ts", "deprecated": false, @@ -27697,7 +28680,17 @@ "section": "def-common.GeoPoint", "text": "GeoPoint" }, - "; }) | ({ type: \"geo_bounding_box\"; } & WellKnownText) | undefined; filter?: any; }, \"filter\" | \"geo_bounding_box\"> & Pick<{ geo_bounding_box?: ({ type: \"geo_bounding_box\"; } & GeoBox) | ({ type: \"geo_bounding_box\"; } & { top_left: ", + "; }) | ({ type: \"geo_bounding_box\"; } & WellKnownText) | undefined; filter?: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"kibana_query\", ", + "Query", + "> | undefined; }, \"filter\" | \"geo_bounding_box\"> & Pick<{ geo_bounding_box?: ({ type: \"geo_bounding_box\"; } & GeoBox) | ({ type: \"geo_bounding_box\"; } & { top_left: ", { "pluginId": "data", "scope": "common", @@ -27729,7 +28722,17 @@ "section": "def-common.GeoPoint", "text": "GeoPoint" }, - "; }) | ({ type: \"geo_bounding_box\"; } & WellKnownText) | undefined; filter?: any; }, never>, \"enabled\" | \"id\" | \"filter\" | \"customLabel\" | \"schema\" | \"geo_bounding_box\" | \"json\" | \"timeShift\">, ", + "; }) | ({ type: \"geo_bounding_box\"; } & WellKnownText) | undefined; filter?: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"kibana_query\", ", + "Query", + "> | undefined; }, never>, \"enabled\" | \"id\" | \"filter\" | \"customLabel\" | \"schema\" | \"geo_bounding_box\" | \"json\" | \"timeShift\">, ", "AggExpressionType", ", ", { @@ -30964,7 +31967,67 @@ ") | undefined" ], "path": "src/plugins/data/common/index_patterns/fields/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.IFieldType.toSpec.$1.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.IFieldType.toSpec.$1.options.getFormatterForField", + "type": "Function", + "tags": [], + "label": "getFormatterForField", + "description": [], + "signature": [ + "((field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + ") | undefined" + ], + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -31341,11 +32404,10 @@ ], "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-server.agg", + "id": "def-server.OptionedValueProp.isCompatible.$1", "type": "Object", "tags": [], "label": "agg", @@ -31360,9 +32422,11 @@ } ], "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -31616,7 +32680,13 @@ "label": "ExecutionContextSearch", "description": [], "signature": [ - "{ filters?: any[] | undefined; query?: any; timeRange?: ", + "{ filters?: ", + "Filter", + "[] | undefined; query?: ", + "Query", + " | ", + "Query", + "[] | undefined; timeRange?: ", { "pluginId": "data", "scope": "common", @@ -31785,6 +32855,32 @@ ], "path": "src/plugins/data/common/field_formats/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.key", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "path": "src/plugins/data/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.defaultOverride", + "type": "Uncategorized", + "tags": [], + "label": "defaultOverride", + "description": [], + "signature": [ + "T | undefined" + ], + "path": "src/plugins/data/common/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -31797,7 +32893,11 @@ "label": "Filter", "description": [], "signature": [ - "any" + "{ $state?: { store: ", + "FilterStateStore", + "; } | undefined; meta: ", + "FilterMeta", + "; query?: any; }" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -34217,6 +35317,20 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "data", + "id": "def-server.Query", + "type": "Type", + "tags": [], + "label": "Query", + "description": [], + "signature": [ + "{ query: string | { [key: string]: any; }; language: string; }" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/types.d.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "data", "id": "def-server.TimeRange", @@ -34303,15 +35417,52 @@ { "parentPluginId": "data", "id": "def-server.esFilters.buildQueryFilter", - "type": "Any", + "type": "Function", "tags": [], "label": "buildQueryFilter", "description": [], "signature": [ - "any" + "(query: any, index: string, alias: string) => ", + "QueryStringFilter" ], "path": "src/plugins/data/server/deprecated.ts", - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.query", + "type": "Any", + "tags": [], + "label": "query", + "description": [], + "signature": [ + "any" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/query_string_filter.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.index", + "type": "string", + "tags": [], + "label": "index", + "description": [], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/query_string_filter.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.alias", + "type": "string", + "tags": [], + "label": "alias", + "description": [], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/query_string_filter.d.ts", + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -34323,7 +35474,8 @@ "signature": [ "(indexPatternString: string, queryDsl: any, disabled: boolean, negate: boolean, alias: string | null, store: ", "FilterStateStore", - ") => any" + ") => ", + "Filter" ], "path": "src/plugins/data/server/deprecated.ts", "deprecated": false, @@ -34336,7 +35488,7 @@ "tags": [], "label": "indexPatternString", "description": [], - "path": "node_modules/@kbn/es-query/target_types/filters/build_filters.d.ts", + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/custom_filter.d.ts", "deprecated": false }, { @@ -34349,7 +35501,7 @@ "signature": [ "any" ], - "path": "node_modules/@kbn/es-query/target_types/filters/build_filters.d.ts", + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/custom_filter.d.ts", "deprecated": false }, { @@ -34359,7 +35511,7 @@ "tags": [], "label": "disabled", "description": [], - "path": "node_modules/@kbn/es-query/target_types/filters/build_filters.d.ts", + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/custom_filter.d.ts", "deprecated": false }, { @@ -34369,7 +35521,7 @@ "tags": [], "label": "negate", "description": [], - "path": "node_modules/@kbn/es-query/target_types/filters/build_filters.d.ts", + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/custom_filter.d.ts", "deprecated": false }, { @@ -34382,7 +35534,7 @@ "signature": [ "string | null" ], - "path": "node_modules/@kbn/es-query/target_types/filters/build_filters.d.ts", + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/custom_filter.d.ts", "deprecated": false }, { @@ -34395,7 +35547,7 @@ "signature": [ "FilterStateStore" ], - "path": "node_modules/@kbn/es-query/target_types/filters/build_filters.d.ts", + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/custom_filter.d.ts", "deprecated": false } ] @@ -34403,28 +35555,89 @@ { "parentPluginId": "data", "id": "def-server.esFilters.buildEmptyFilter", - "type": "Any", + "type": "Function", "tags": [], "label": "buildEmptyFilter", "description": [], "signature": [ - "any" + "(isPinned: boolean, index?: string | undefined) => ", + "Filter" ], "path": "src/plugins/data/server/deprecated.ts", - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.isPinned", + "type": "boolean", + "tags": [], + "label": "isPinned", + "description": [], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/build_empty_filter.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.index", + "type": "string", + "tags": [], + "label": "index", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/build_empty_filter.d.ts", + "deprecated": false + } + ] }, { "parentPluginId": "data", "id": "def-server.esFilters.buildExistsFilter", - "type": "Any", + "type": "Function", "tags": [], "label": "buildExistsFilter", "description": [], "signature": [ - "any" + "(field: ", + "IndexPatternFieldBase", + ", indexPattern: ", + "IndexPatternBase", + ") => ", + "ExistsFilter" ], "path": "src/plugins/data/server/deprecated.ts", - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.field", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "IndexPatternFieldBase" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/exists_filter.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.indexPattern", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + "IndexPatternBase" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/exists_filter.d.ts", + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -34442,7 +35655,8 @@ "FILTERS", ", negate: boolean, disabled: boolean, params: any, alias: string | null, store?: ", "FilterStateStore", - " | undefined) => any" + " | undefined) => ", + "Filter" ], "path": "src/plugins/data/server/deprecated.ts", "deprecated": false, @@ -34458,7 +35672,7 @@ "signature": [ "IndexPatternBase" ], - "path": "node_modules/@kbn/es-query/target_types/filters/build_filters.d.ts", + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/build_filters.d.ts", "deprecated": false }, { @@ -34471,7 +35685,7 @@ "signature": [ "IndexPatternFieldBase" ], - "path": "node_modules/@kbn/es-query/target_types/filters/build_filters.d.ts", + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/build_filters.d.ts", "deprecated": false }, { @@ -34484,7 +35698,7 @@ "signature": [ "FILTERS" ], - "path": "node_modules/@kbn/es-query/target_types/filters/build_filters.d.ts", + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/build_filters.d.ts", "deprecated": false }, { @@ -34494,7 +35708,7 @@ "tags": [], "label": "negate", "description": [], - "path": "node_modules/@kbn/es-query/target_types/filters/build_filters.d.ts", + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/build_filters.d.ts", "deprecated": false }, { @@ -34504,7 +35718,7 @@ "tags": [], "label": "disabled", "description": [], - "path": "node_modules/@kbn/es-query/target_types/filters/build_filters.d.ts", + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/build_filters.d.ts", "deprecated": false }, { @@ -34517,7 +35731,7 @@ "signature": [ "any" ], - "path": "node_modules/@kbn/es-query/target_types/filters/build_filters.d.ts", + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/build_filters.d.ts", "deprecated": false }, { @@ -34530,7 +35744,7 @@ "signature": [ "string | null" ], - "path": "node_modules/@kbn/es-query/target_types/filters/build_filters.d.ts", + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/build_filters.d.ts", "deprecated": false }, { @@ -34544,7 +35758,7 @@ "FilterStateStore", " | undefined" ], - "path": "node_modules/@kbn/es-query/target_types/filters/build_filters.d.ts", + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/build_filters.d.ts", "deprecated": false } ] @@ -34552,41 +35766,197 @@ { "parentPluginId": "data", "id": "def-server.esFilters.buildPhraseFilter", - "type": "Any", + "type": "Function", "tags": [], "label": "buildPhraseFilter", "description": [], "signature": [ - "any" + "(field: ", + "IndexPatternFieldBase", + ", value: PhraseFilterValue, indexPattern: ", + "IndexPatternBase", + ") => ", + "PhraseFilter" ], "path": "src/plugins/data/server/deprecated.ts", - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.field", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "IndexPatternFieldBase" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/phrase_filter.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.value", + "type": "CompoundType", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "string | number | boolean" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/phrase_filter.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.indexPattern", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + "IndexPatternBase" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/phrase_filter.d.ts", + "deprecated": false + } + ] }, { "parentPluginId": "data", "id": "def-server.esFilters.buildPhrasesFilter", - "type": "Any", + "type": "Function", "tags": [], "label": "buildPhrasesFilter", "description": [], "signature": [ - "any" + "(field: ", + "IndexPatternFieldBase", + ", params: string[], indexPattern: ", + "IndexPatternBase", + ") => ", + "PhrasesFilter" ], "path": "src/plugins/data/server/deprecated.ts", - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.field", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "IndexPatternFieldBase" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/phrases_filter.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.params", + "type": "Array", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "string[]" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/phrases_filter.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.indexPattern", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + "IndexPatternBase" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/phrases_filter.d.ts", + "deprecated": false + } + ] }, { "parentPluginId": "data", "id": "def-server.esFilters.buildRangeFilter", - "type": "Any", + "type": "Function", "tags": [], "label": "buildRangeFilter", "description": [], "signature": [ - "any" + "(field: ", + "IndexPatternFieldBase", + ", params: ", + "RangeFilterParams", + ", indexPattern: ", + "IndexPatternBase", + ", formattedValue?: string | undefined) => ", + "RangeFilter" ], "path": "src/plugins/data/server/deprecated.ts", - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-server.field", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "IndexPatternFieldBase" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/range_filter.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.params", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "RangeFilterParams" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/range_filter.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.indexPattern", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + "IndexPatternBase" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/range_filter.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-server.formattedValue", + "type": "string", + "tags": [], + "label": "formattedValue", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/range_filter.d.ts", + "deprecated": false + } + ] }, { "parentPluginId": "data", @@ -34596,7 +35966,9 @@ "label": "isFilterDisabled", "description": [], "signature": [ - "(filter: any) => boolean" + "(filter: ", + "Filter", + ") => boolean" ], "path": "src/plugins/data/server/deprecated.ts", "deprecated": false, @@ -34605,12 +35977,16 @@ { "parentPluginId": "data", "id": "def-server.filter", - "type": "Any", + "type": "Object", "tags": [], "label": "filter", "description": [], "signature": [ - "any" + "{ $state?: { store: ", + "FilterStateStore", + "; } | undefined; meta: ", + "FilterMeta", + "; query?: any; }" ], "path": "node_modules/@kbn/es-query/target_types/filters/helpers/meta_filter.d.ts", "deprecated": false @@ -34785,9 +36161,15 @@ "label": "buildQueryFromFilters", "description": [], "signature": [ - "(filters: any[] | undefined, indexPattern: ", + "(filters: ", + "Filter", + "[] | undefined, indexPattern: ", "IndexPatternBase", - " | undefined, ignoreFilterIfFieldNotInIndex?: boolean | undefined) => { must: never[]; filter: any[]; should: never[]; must_not: any[]; }" + " | undefined, ignoreFilterIfFieldNotInIndex?: boolean | undefined) => { must: never[]; filter: ", + "Filter", + "[]; should: never[]; must_not: ", + "Filter", + "[]; }" ], "path": "src/plugins/data/server/deprecated.ts", "deprecated": false, @@ -34801,7 +36183,8 @@ "label": "filters", "description": [], "signature": [ - "any[] | undefined" + "Filter", + "[] | undefined" ], "path": "node_modules/@kbn/es-query/target_types/es_query/from_filters.d.ts", "deprecated": false @@ -34875,11 +36258,23 @@ "signature": [ "(indexPattern: ", "IndexPatternBase", - " | undefined, queries: any, filters: any, config?: ", + " | undefined, queries: ", + "Query", + " | ", + "Query", + "[], filters: ", + "Filter", + " | ", + "Filter", + "[], config?: ", "EsQueryConfig", " | undefined) => { bool: { must: ", "DslQuery", - "[]; filter: any[]; should: never[]; must_not: any[]; }; }" + "[]; filter: ", + "Filter", + "[]; should: never[]; must_not: ", + "Filter", + "[]; }; }" ], "path": "src/plugins/data/server/deprecated.ts", "deprecated": false, @@ -34902,12 +36297,15 @@ { "parentPluginId": "data", "id": "def-server.queries", - "type": "Any", + "type": "CompoundType", "tags": [], "label": "queries", "description": [], "signature": [ - "any" + "Query", + " | ", + "Query", + "[]" ], "path": "node_modules/@kbn/es-query/target_types/es_query/build_es_query.d.ts", "deprecated": false @@ -34915,12 +36313,15 @@ { "parentPluginId": "data", "id": "def-server.filters", - "type": "Any", + "type": "CompoundType", "tags": [], "label": "filters", "description": [], "signature": [ - "any" + "Filter", + " | ", + "Filter", + "[]" ], "path": "node_modules/@kbn/es-query/target_types/es_query/build_es_query.d.ts", "deprecated": false @@ -36385,7 +37786,8 @@ "signature": [ "(indexPatternString: string, queryDsl: any, disabled: boolean, negate: boolean, alias: string | null, store: ", "FilterStateStore", - ") => any" + ") => ", + "Filter" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -36399,7 +37801,7 @@ "tags": [], "label": "indexPatternString", "description": [], - "path": "node_modules/@kbn/es-query/target_types/filters/build_filters.d.ts", + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/custom_filter.d.ts", "deprecated": false }, { @@ -36412,7 +37814,7 @@ "signature": [ "any" ], - "path": "node_modules/@kbn/es-query/target_types/filters/build_filters.d.ts", + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/custom_filter.d.ts", "deprecated": false }, { @@ -36422,7 +37824,7 @@ "tags": [], "label": "disabled", "description": [], - "path": "node_modules/@kbn/es-query/target_types/filters/build_filters.d.ts", + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/custom_filter.d.ts", "deprecated": false }, { @@ -36432,7 +37834,7 @@ "tags": [], "label": "negate", "description": [], - "path": "node_modules/@kbn/es-query/target_types/filters/build_filters.d.ts", + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/custom_filter.d.ts", "deprecated": false }, { @@ -36445,7 +37847,7 @@ "signature": [ "string | null" ], - "path": "node_modules/@kbn/es-query/target_types/filters/build_filters.d.ts", + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/custom_filter.d.ts", "deprecated": false }, { @@ -36458,7 +37860,51 @@ "signature": [ "FilterStateStore" ], - "path": "node_modules/@kbn/es-query/target_types/filters/build_filters.d.ts", + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/custom_filter.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.buildEmptyFilter", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "buildEmptyFilter", + "description": [], + "signature": [ + "(isPinned: boolean, index?: string | undefined) => ", + "Filter" + ], + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "references": [], + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.isPinned", + "type": "boolean", + "tags": [], + "label": "isPinned", + "description": [], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/build_empty_filter.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.index", + "type": "string", + "tags": [], + "label": "index", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/build_empty_filter.d.ts", "deprecated": false } ], @@ -36476,11 +37922,23 @@ "signature": [ "(indexPattern: ", "IndexPatternBase", - " | undefined, queries: any, filters: any, config?: ", + " | undefined, queries: ", + "Query", + " | ", + "Query", + "[], filters: ", + "Filter", + " | ", + "Filter", + "[], config?: ", "EsQueryConfig", " | undefined) => { bool: { must: ", "DslQuery", - "[]; filter: any[]; should: never[]; must_not: any[]; }; }" + "[]; filter: ", + "Filter", + "[]; should: never[]; must_not: ", + "Filter", + "[]; }; }" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -36504,12 +37962,15 @@ { "parentPluginId": "data", "id": "def-common.queries", - "type": "Any", + "type": "CompoundType", "tags": [], "label": "queries", "description": [], "signature": [ - "any" + "Query", + " | ", + "Query", + "[]" ], "path": "node_modules/@kbn/es-query/target_types/es_query/build_es_query.d.ts", "deprecated": false @@ -36517,12 +37978,15 @@ { "parentPluginId": "data", "id": "def-common.filters", - "type": "Any", + "type": "CompoundType", "tags": [], "label": "filters", "description": [], "signature": [ - "any" + "Filter", + " | ", + "Filter", + "[]" ], "path": "node_modules/@kbn/es-query/target_types/es_query/build_es_query.d.ts", "deprecated": false @@ -36544,6 +38008,57 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "data", + "id": "def-common.buildExistsFilter", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "buildExistsFilter", + "description": [], + "signature": [ + "(field: ", + "IndexPatternFieldBase", + ", indexPattern: ", + "IndexPatternBase", + ") => ", + "ExistsFilter" + ], + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "references": [], + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.field", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "IndexPatternFieldBase" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/exists_filter.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.indexPattern", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + "IndexPatternBase" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/exists_filter.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "data", "id": "def-common.buildFilter", @@ -36562,7 +38077,8 @@ "FILTERS", ", negate: boolean, disabled: boolean, params: any, alias: string | null, store?: ", "FilterStateStore", - " | undefined) => any" + " | undefined) => ", + "Filter" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -36579,7 +38095,7 @@ "signature": [ "IndexPatternBase" ], - "path": "node_modules/@kbn/es-query/target_types/filters/build_filters.d.ts", + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/build_filters.d.ts", "deprecated": false }, { @@ -36592,7 +38108,7 @@ "signature": [ "IndexPatternFieldBase" ], - "path": "node_modules/@kbn/es-query/target_types/filters/build_filters.d.ts", + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/build_filters.d.ts", "deprecated": false }, { @@ -36605,7 +38121,7 @@ "signature": [ "FILTERS" ], - "path": "node_modules/@kbn/es-query/target_types/filters/build_filters.d.ts", + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/build_filters.d.ts", "deprecated": false }, { @@ -36615,7 +38131,7 @@ "tags": [], "label": "negate", "description": [], - "path": "node_modules/@kbn/es-query/target_types/filters/build_filters.d.ts", + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/build_filters.d.ts", "deprecated": false }, { @@ -36625,7 +38141,7 @@ "tags": [], "label": "disabled", "description": [], - "path": "node_modules/@kbn/es-query/target_types/filters/build_filters.d.ts", + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/build_filters.d.ts", "deprecated": false }, { @@ -36638,7 +38154,7 @@ "signature": [ "any" ], - "path": "node_modules/@kbn/es-query/target_types/filters/build_filters.d.ts", + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/build_filters.d.ts", "deprecated": false }, { @@ -36651,7 +38167,7 @@ "signature": [ "string | null" ], - "path": "node_modules/@kbn/es-query/target_types/filters/build_filters.d.ts", + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/build_filters.d.ts", "deprecated": false }, { @@ -36665,7 +38181,189 @@ "FilterStateStore", " | undefined" ], - "path": "node_modules/@kbn/es-query/target_types/filters/build_filters.d.ts", + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/build_filters.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.buildPhraseFilter", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "buildPhraseFilter", + "description": [], + "signature": [ + "(field: ", + "IndexPatternFieldBase", + ", value: PhraseFilterValue, indexPattern: ", + "IndexPatternBase", + ") => ", + "PhraseFilter" + ], + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "references": [], + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.field", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "IndexPatternFieldBase" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/phrase_filter.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.value", + "type": "CompoundType", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "string | number | boolean" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/phrase_filter.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.indexPattern", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + "IndexPatternBase" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/phrase_filter.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.buildPhrasesFilter", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "buildPhrasesFilter", + "description": [], + "signature": [ + "(field: ", + "IndexPatternFieldBase", + ", params: string[], indexPattern: ", + "IndexPatternBase", + ") => ", + "PhrasesFilter" + ], + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "references": [], + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.field", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "IndexPatternFieldBase" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/phrases_filter.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.params", + "type": "Array", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "string[]" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/phrases_filter.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.indexPattern", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + "IndexPatternBase" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/phrases_filter.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.buildQueryFilter", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "buildQueryFilter", + "description": [], + "signature": [ + "(query: any, index: string, alias: string) => ", + "QueryStringFilter" + ], + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "references": [], + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.query", + "type": "Any", + "tags": [], + "label": "query", + "description": [], + "signature": [ + "any" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/query_string_filter.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.index", + "type": "string", + "tags": [], + "label": "index", + "description": [], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/query_string_filter.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.alias", + "type": "string", + "tags": [], + "label": "alias", + "description": [], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/query_string_filter.d.ts", "deprecated": false } ], @@ -36681,9 +38379,15 @@ "label": "buildQueryFromFilters", "description": [], "signature": [ - "(filters: any[] | undefined, indexPattern: ", + "(filters: ", + "Filter", + "[] | undefined, indexPattern: ", "IndexPatternBase", - " | undefined, ignoreFilterIfFieldNotInIndex?: boolean | undefined) => { must: never[]; filter: any[]; should: never[]; must_not: any[]; }" + " | undefined, ignoreFilterIfFieldNotInIndex?: boolean | undefined) => { must: never[]; filter: ", + "Filter", + "[]; should: never[]; must_not: ", + "Filter", + "[]; }" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -36698,7 +38402,8 @@ "label": "filters", "description": [], "signature": [ - "any[] | undefined" + "Filter", + "[] | undefined" ], "path": "node_modules/@kbn/es-query/target_types/es_query/from_filters.d.ts", "deprecated": false @@ -36733,6 +38438,85 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "data", + "id": "def-common.buildRangeFilter", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "buildRangeFilter", + "description": [], + "signature": [ + "(field: ", + "IndexPatternFieldBase", + ", params: ", + "RangeFilterParams", + ", indexPattern: ", + "IndexPatternBase", + ", formattedValue?: string | undefined) => ", + "RangeFilter" + ], + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "references": [], + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.field", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "IndexPatternFieldBase" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/range_filter.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.params", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "RangeFilterParams" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/range_filter.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.indexPattern", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + "IndexPatternBase" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/range_filter.d.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.formattedValue", + "type": "string", + "tags": [], + "label": "formattedValue", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/range_filter.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "data", "id": "def-common.castEsToKbnFieldTypeName", @@ -36823,7 +38607,15 @@ "label": "compareFilters", "description": [], "signature": [ - "(first: any, second: any, comparatorOptions?: ", + "(first: ", + "Filter", + " | ", + "Filter", + "[], second: ", + "Filter", + " | ", + "Filter", + "[], comparatorOptions?: ", "FilterCompareOptions", " | undefined) => boolean" ], @@ -36835,12 +38627,15 @@ { "parentPluginId": "data", "id": "def-common.first", - "type": "Any", + "type": "CompoundType", "tags": [], "label": "first", "description": [], "signature": [ - "any" + "Filter", + " | ", + "Filter", + "[]" ], "path": "node_modules/@kbn/es-query/target_types/filters/helpers/compare_filters.d.ts", "deprecated": false @@ -36848,12 +38643,15 @@ { "parentPluginId": "data", "id": "def-common.second", - "type": "Any", + "type": "CompoundType", "tags": [], "label": "second", "description": [], "signature": [ - "any" + "Filter", + " | ", + "Filter", + "[]" ], "path": "node_modules/@kbn/es-query/target_types/filters/helpers/compare_filters.d.ts", "deprecated": false @@ -37059,9 +38857,15 @@ "label": "dedupFilters", "description": [], "signature": [ - "(existingFilters: any[], filters: any[], comparatorOptions?: ", + "(existingFilters: ", + "Filter", + "[], filters: ", + "Filter", + "[], comparatorOptions?: ", "FilterCompareOptions", - " | undefined) => any[]" + " | undefined) => ", + "Filter", + "[]" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -37076,7 +38880,8 @@ "label": "existingFilters", "description": [], "signature": [ - "any[]" + "Filter", + "[]" ], "path": "node_modules/@kbn/es-query/target_types/filters/helpers/dedup_filters.d.ts", "deprecated": false @@ -37089,7 +38894,8 @@ "label": "filters", "description": [], "signature": [ - "any[]" + "Filter", + "[]" ], "path": "node_modules/@kbn/es-query/target_types/filters/helpers/dedup_filters.d.ts", "deprecated": false @@ -37121,7 +38927,10 @@ "label": "disableFilter", "description": [], "signature": [ - "(filter: any) => any" + "(filter: ", + "Filter", + ") => ", + "Filter" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -37131,12 +38940,16 @@ { "parentPluginId": "data", "id": "def-common.filter", - "type": "Any", + "type": "Object", "tags": [], "label": "filter", "description": [], "signature": [ - "any" + "{ $state?: { store: ", + "FilterStateStore", + "; } | undefined; meta: ", + "FilterMeta", + "; query?: any; }" ], "path": "node_modules/@kbn/es-query/target_types/filters/helpers/meta_filter.d.ts", "deprecated": false @@ -37154,7 +38967,10 @@ "label": "enableFilter", "description": [], "signature": [ - "(filter: any) => any" + "(filter: ", + "Filter", + ") => ", + "Filter" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -37164,12 +38980,16 @@ { "parentPluginId": "data", "id": "def-common.filter", - "type": "Any", + "type": "Object", "tags": [], "label": "filter", "description": [], "signature": [ - "any" + "{ $state?: { store: ", + "FilterStateStore", + "; } | undefined; meta: ", + "FilterMeta", + "; query?: any; }" ], "path": "node_modules/@kbn/es-query/target_types/filters/helpers/meta_filter.d.ts", "deprecated": false @@ -37332,6 +39152,146 @@ "children": [], "initialIsOpen": false }, + { + "parentPluginId": "data", + "id": "def-common.getPhraseFilterField", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "getPhraseFilterField", + "description": [], + "signature": [ + "(filter: ", + "PhraseFilter", + ") => string" + ], + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "references": [], + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.filter", + "type": "CompoundType", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "Filter", + " & { meta: ", + "PhraseFilterMeta", + "; script?: { script: { source?: string | undefined; lang?: \"painless\" | \"expression\" | \"mustache\" | \"java\" | undefined; params: { [key: string]: PhraseFilterValue; }; }; } | undefined; }" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/phrase_filter.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.getPhraseFilterValue", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "getPhraseFilterValue", + "description": [], + "signature": [ + "(filter: ", + "PhraseFilter", + ") => PhraseFilterValue" + ], + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "references": [], + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.filter", + "type": "CompoundType", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "Filter", + " & { meta: ", + "PhraseFilterMeta", + "; script?: { script: { source?: string | undefined; lang?: \"painless\" | \"expression\" | \"mustache\" | \"java\" | undefined; params: { [key: string]: PhraseFilterValue; }; }; } | undefined; }" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/phrase_filter.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.isExistsFilter", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "isExistsFilter", + "description": [], + "signature": [ + "(filter: ", + "RangeFilter", + " | ", + "ExistsFilter", + " | ", + "GeoBoundingBoxFilter", + " | ", + "GeoPolygonFilter", + " | ", + "PhraseFilter", + " | ", + "PhrasesFilter", + " | ", + "MatchAllFilter", + " | ", + "MissingFilter", + ") => filter is ", + "ExistsFilter" + ], + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "references": [], + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.filter", + "type": "CompoundType", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "RangeFilter", + " | ", + "ExistsFilter", + " | ", + "GeoBoundingBoxFilter", + " | ", + "GeoPolygonFilter", + " | ", + "PhraseFilter", + " | ", + "PhrasesFilter", + " | ", + "MatchAllFilter", + " | ", + "MissingFilter" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/exists_filter.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "data", "id": "def-common.isFilter", @@ -37342,7 +39302,8 @@ "label": "isFilter", "description": [], "signature": [ - "(x: unknown) => x is any" + "(x: unknown) => x is ", + "Filter" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -37375,7 +39336,9 @@ "label": "isFilterDisabled", "description": [], "signature": [ - "(filter: any) => boolean" + "(filter: ", + "Filter", + ") => boolean" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -37385,12 +39348,16 @@ { "parentPluginId": "data", "id": "def-common.filter", - "type": "Any", + "type": "Object", "tags": [], "label": "filter", "description": [], "signature": [ - "any" + "{ $state?: { store: ", + "FilterStateStore", + "; } | undefined; meta: ", + "FilterMeta", + "; query?: any; }" ], "path": "node_modules/@kbn/es-query/target_types/filters/helpers/meta_filter.d.ts", "deprecated": false @@ -37408,7 +39375,9 @@ "label": "isFilterPinned", "description": [], "signature": [ - "(filter: any) => boolean | undefined" + "(filter: ", + "Filter", + ") => boolean | undefined" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -37418,12 +39387,16 @@ { "parentPluginId": "data", "id": "def-common.filter", - "type": "Any", + "type": "Object", "tags": [], "label": "filter", "description": [], "signature": [ - "any" + "{ $state?: { store: ", + "FilterStateStore", + "; } | undefined; meta: ", + "FilterMeta", + "; query?: any; }" ], "path": "node_modules/@kbn/es-query/target_types/filters/helpers/meta_filter.d.ts", "deprecated": false @@ -37441,7 +39414,9 @@ "label": "isFilters", "description": [], "signature": [ - "(x: unknown) => x is any[]" + "(x: unknown) => x is ", + "Filter", + "[]" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -37473,6 +39448,519 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "data", + "id": "def-common.isGeoBoundingBoxFilter", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "isGeoBoundingBoxFilter", + "description": [], + "signature": [ + "(filter: ", + "RangeFilter", + " | ", + "ExistsFilter", + " | ", + "GeoBoundingBoxFilter", + " | ", + "GeoPolygonFilter", + " | ", + "PhraseFilter", + " | ", + "PhrasesFilter", + " | ", + "MatchAllFilter", + " | ", + "MissingFilter", + ") => filter is ", + "GeoBoundingBoxFilter" + ], + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "references": [], + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.filter", + "type": "CompoundType", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "RangeFilter", + " | ", + "ExistsFilter", + " | ", + "GeoBoundingBoxFilter", + " | ", + "GeoPolygonFilter", + " | ", + "PhraseFilter", + " | ", + "PhrasesFilter", + " | ", + "MatchAllFilter", + " | ", + "MissingFilter" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/geo_bounding_box_filter.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.isGeoPolygonFilter", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "isGeoPolygonFilter", + "description": [], + "signature": [ + "(filter: ", + "RangeFilter", + " | ", + "ExistsFilter", + " | ", + "GeoBoundingBoxFilter", + " | ", + "GeoPolygonFilter", + " | ", + "PhraseFilter", + " | ", + "PhrasesFilter", + " | ", + "MatchAllFilter", + " | ", + "MissingFilter", + ") => filter is ", + "GeoPolygonFilter" + ], + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "references": [], + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.filter", + "type": "CompoundType", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "RangeFilter", + " | ", + "ExistsFilter", + " | ", + "GeoBoundingBoxFilter", + " | ", + "GeoPolygonFilter", + " | ", + "PhraseFilter", + " | ", + "PhrasesFilter", + " | ", + "MatchAllFilter", + " | ", + "MissingFilter" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/geo_polygon_filter.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.isMatchAllFilter", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "isMatchAllFilter", + "description": [], + "signature": [ + "(filter: ", + "RangeFilter", + " | ", + "ExistsFilter", + " | ", + "GeoBoundingBoxFilter", + " | ", + "GeoPolygonFilter", + " | ", + "PhraseFilter", + " | ", + "PhrasesFilter", + " | ", + "MatchAllFilter", + " | ", + "MissingFilter", + ") => filter is ", + "MatchAllFilter" + ], + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "references": [], + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.filter", + "type": "CompoundType", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "RangeFilter", + " | ", + "ExistsFilter", + " | ", + "GeoBoundingBoxFilter", + " | ", + "GeoPolygonFilter", + " | ", + "PhraseFilter", + " | ", + "PhrasesFilter", + " | ", + "MatchAllFilter", + " | ", + "MissingFilter" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/match_all_filter.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.isMissingFilter", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "isMissingFilter", + "description": [], + "signature": [ + "(filter: ", + "RangeFilter", + " | ", + "ExistsFilter", + " | ", + "GeoBoundingBoxFilter", + " | ", + "GeoPolygonFilter", + " | ", + "PhraseFilter", + " | ", + "PhrasesFilter", + " | ", + "MatchAllFilter", + " | ", + "MissingFilter", + ") => filter is ", + "MissingFilter" + ], + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "references": [], + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.filter", + "type": "CompoundType", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "RangeFilter", + " | ", + "ExistsFilter", + " | ", + "GeoBoundingBoxFilter", + " | ", + "GeoPolygonFilter", + " | ", + "PhraseFilter", + " | ", + "PhrasesFilter", + " | ", + "MatchAllFilter", + " | ", + "MissingFilter" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/missing_filter.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.isPhraseFilter", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "isPhraseFilter", + "description": [], + "signature": [ + "(filter: ", + "RangeFilter", + " | ", + "ExistsFilter", + " | ", + "GeoBoundingBoxFilter", + " | ", + "GeoPolygonFilter", + " | ", + "PhraseFilter", + " | ", + "PhrasesFilter", + " | ", + "MatchAllFilter", + " | ", + "MissingFilter", + ") => filter is ", + "PhraseFilter" + ], + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "references": [], + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.filter", + "type": "CompoundType", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "RangeFilter", + " | ", + "ExistsFilter", + " | ", + "GeoBoundingBoxFilter", + " | ", + "GeoPolygonFilter", + " | ", + "PhraseFilter", + " | ", + "PhrasesFilter", + " | ", + "MatchAllFilter", + " | ", + "MissingFilter" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/phrase_filter.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.isPhrasesFilter", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "isPhrasesFilter", + "description": [], + "signature": [ + "(filter: ", + "RangeFilter", + " | ", + "ExistsFilter", + " | ", + "GeoBoundingBoxFilter", + " | ", + "GeoPolygonFilter", + " | ", + "PhraseFilter", + " | ", + "PhrasesFilter", + " | ", + "MatchAllFilter", + " | ", + "MissingFilter", + ") => filter is ", + "PhrasesFilter" + ], + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "references": [], + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.filter", + "type": "CompoundType", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "RangeFilter", + " | ", + "ExistsFilter", + " | ", + "GeoBoundingBoxFilter", + " | ", + "GeoPolygonFilter", + " | ", + "PhraseFilter", + " | ", + "PhrasesFilter", + " | ", + "MatchAllFilter", + " | ", + "MissingFilter" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/phrases_filter.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.isQueryStringFilter", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "isQueryStringFilter", + "description": [], + "signature": [ + "(filter: ", + "RangeFilter", + " | ", + "ExistsFilter", + " | ", + "GeoBoundingBoxFilter", + " | ", + "GeoPolygonFilter", + " | ", + "PhraseFilter", + " | ", + "PhrasesFilter", + " | ", + "MatchAllFilter", + " | ", + "MissingFilter", + ") => filter is ", + "QueryStringFilter" + ], + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "references": [], + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.filter", + "type": "CompoundType", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "RangeFilter", + " | ", + "ExistsFilter", + " | ", + "GeoBoundingBoxFilter", + " | ", + "GeoPolygonFilter", + " | ", + "PhraseFilter", + " | ", + "PhrasesFilter", + " | ", + "MatchAllFilter", + " | ", + "MissingFilter" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/query_string_filter.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.isRangeFilter", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "isRangeFilter", + "description": [], + "signature": [ + "(filter?: ", + "RangeFilter", + " | ", + "ExistsFilter", + " | ", + "GeoBoundingBoxFilter", + " | ", + "GeoPolygonFilter", + " | ", + "PhraseFilter", + " | ", + "PhrasesFilter", + " | ", + "MatchAllFilter", + " | ", + "MissingFilter", + " | undefined) => filter is ", + "RangeFilter" + ], + "path": "src/plugins/data/common/es_query/index.ts", + "deprecated": true, + "references": [], + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.filter", + "type": "CompoundType", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "RangeFilter", + " | ", + "ExistsFilter", + " | ", + "GeoBoundingBoxFilter", + " | ", + "GeoPolygonFilter", + " | ", + "PhraseFilter", + " | ", + "PhrasesFilter", + " | ", + "MatchAllFilter", + " | ", + "MissingFilter", + " | undefined" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/range_filter.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "data", "id": "def-common.luceneStringToDsl", @@ -37517,7 +40005,11 @@ "label": "onlyDisabledFiltersChanged", "description": [], "signature": [ - "(newFilters?: any[] | undefined, oldFilters?: any[] | undefined) => boolean" + "(newFilters?: ", + "Filter", + "[] | undefined, oldFilters?: ", + "Filter", + "[] | undefined) => boolean" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -37532,7 +40024,8 @@ "label": "newFilters", "description": [], "signature": [ - "any[] | undefined" + "Filter", + "[] | undefined" ], "path": "node_modules/@kbn/es-query/target_types/filters/helpers/only_disabled.d.ts", "deprecated": false @@ -37545,7 +40038,8 @@ "label": "oldFilters", "description": [], "signature": [ - "any[] | undefined" + "Filter", + "[] | undefined" ], "path": "node_modules/@kbn/es-query/target_types/filters/helpers/only_disabled.d.ts", "deprecated": false @@ -37563,7 +40057,10 @@ "label": "pinFilter", "description": [], "signature": [ - "(filter: any) => any" + "(filter: ", + "Filter", + ") => ", + "Filter" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -37573,12 +40070,16 @@ { "parentPluginId": "data", "id": "def-common.filter", - "type": "Any", + "type": "Object", "tags": [], "label": "filter", "description": [], "signature": [ - "any" + "{ $state?: { store: ", + "FilterStateStore", + "; } | undefined; meta: ", + "FilterMeta", + "; query?: any; }" ], "path": "node_modules/@kbn/es-query/target_types/filters/helpers/meta_filter.d.ts", "deprecated": false @@ -37769,7 +40270,11 @@ "label": "toggleFilterDisabled", "description": [], "signature": [ - "(filter: any) => { meta: { disabled: boolean; alias: string | null; negate: boolean; controlledBy?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }; $state?: { store: any; } | undefined; query?: any; }" + "(filter: ", + "Filter", + ") => { meta: { disabled: boolean; alias: string | null; negate: boolean; controlledBy?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }; $state?: { store: ", + "FilterStateStore", + "; } | undefined; query?: any; }" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -37779,12 +40284,16 @@ { "parentPluginId": "data", "id": "def-common.filter", - "type": "Any", + "type": "Object", "tags": [], "label": "filter", "description": [], "signature": [ - "any" + "{ $state?: { store: ", + "FilterStateStore", + "; } | undefined; meta: ", + "FilterMeta", + "; query?: any; }" ], "path": "node_modules/@kbn/es-query/target_types/filters/helpers/meta_filter.d.ts", "deprecated": false @@ -37802,7 +40311,11 @@ "label": "toggleFilterNegated", "description": [], "signature": [ - "(filter: any) => { meta: { negate: boolean; alias: string | null; disabled: boolean; controlledBy?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }; $state?: { store: any; } | undefined; query?: any; }" + "(filter: ", + "Filter", + ") => { meta: { negate: boolean; alias: string | null; disabled: boolean; controlledBy?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }; $state?: { store: ", + "FilterStateStore", + "; } | undefined; query?: any; }" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -37812,12 +40325,16 @@ { "parentPluginId": "data", "id": "def-common.filter", - "type": "Any", + "type": "Object", "tags": [], "label": "filter", "description": [], "signature": [ - "any" + "{ $state?: { store: ", + "FilterStateStore", + "; } | undefined; meta: ", + "FilterMeta", + "; query?: any; }" ], "path": "node_modules/@kbn/es-query/target_types/filters/helpers/meta_filter.d.ts", "deprecated": false @@ -37835,7 +40352,11 @@ "label": "uniqFilters", "description": [], "signature": [ - "(filters: any[], comparatorOptions?: any) => any[]" + "(filters: ", + "Filter", + "[], comparatorOptions?: any) => ", + "Filter", + "[]" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -37850,7 +40371,8 @@ "label": "filters", "description": [], "signature": [ - "any[]" + "Filter", + "[]" ], "path": "node_modules/@kbn/es-query/target_types/filters/helpers/uniq_filters.d.ts", "deprecated": false @@ -37924,19 +40446,23 @@ ], "path": "src/plugins/data/common/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-common.type", + "id": "def-common.FilterValueFormatter.getConverterFor.$1", "type": "string", "tags": [], "label": "type", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/data/common/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -38226,108 +40752,6 @@ } ], "misc": [ - { - "parentPluginId": "data", - "id": "def-common.buildEmptyFilter", - "type": "Any", - "tags": [ - "deprecated" - ], - "label": "buildEmptyFilter", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.buildExistsFilter", - "type": "Any", - "tags": [ - "deprecated" - ], - "label": "buildExistsFilter", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.buildPhraseFilter", - "type": "Any", - "tags": [ - "deprecated" - ], - "label": "buildPhraseFilter", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.buildPhrasesFilter", - "type": "Any", - "tags": [ - "deprecated" - ], - "label": "buildPhrasesFilter", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.buildQueryFilter", - "type": "Any", - "tags": [ - "deprecated" - ], - "label": "buildQueryFilter", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.buildRangeFilter", - "type": "Any", - "tags": [ - "deprecated" - ], - "label": "buildRangeFilter", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "references": [], - "initialIsOpen": false - }, { "parentPluginId": "data", "id": "def-common.CSV_FORMULA_CHARS", @@ -38366,7 +40790,8 @@ "label": "CustomFilter", "description": [], "signature": [ - "any" + "Filter", + " & { query: any; }" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -38431,7 +40856,10 @@ "label": "ExistsFilter", "description": [], "signature": [ - "any" + "Filter", + " & { meta: ", + "FilterMeta", + "; exists?: { field: string; } | undefined; }" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -38469,7 +40897,11 @@ "label": "Filter", "description": [], "signature": [ - "any" + "{ $state?: { store: ", + "FilterStateStore", + "; } | undefined; meta: ", + "FilterMeta", + "; query?: any; }" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -40219,7 +42651,7 @@ "label": "FilterMeta", "description": [], "signature": [ - "any" + "{ alias: string | null; disabled: boolean; negate: boolean; controlledBy?: string | undefined; index?: string | undefined; isMultiIndex?: boolean | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -40245,7 +42677,10 @@ "label": "GeoBoundingBoxFilter", "description": [], "signature": [ - "any" + "Filter", + " & { meta: ", + "GeoBoundingBoxFilterMeta", + "; geo_bounding_box: any; }" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -40262,7 +42697,10 @@ "label": "GeoPolygonFilter", "description": [], "signature": [ - "any" + "Filter", + " & { meta: ", + "GeoPolygonFilterMeta", + "; geo_polygon: any; }" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -40283,40 +42721,32 @@ ], "path": "src/plugins/data/common/types.ts", "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.getPhraseFilterField", - "type": "Any", - "tags": [ - "deprecated" - ], - "label": "getPhraseFilterField", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.getPhraseFilterValue", - "type": "Any", - "tags": [ - "deprecated" - ], - "label": "getPhraseFilterValue", - "description": [], - "signature": [ - "any" + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.key", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "path": "src/plugins/data/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.defaultOverride", + "type": "Uncategorized", + "tags": [], + "label": "defaultOverride", + "description": [], + "signature": [ + "T | undefined" + ], + "path": "src/plugins/data/common/types.ts", + "deprecated": false + } ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "references": [], "initialIsOpen": false }, { @@ -40359,159 +42789,6 @@ "deprecated": false, "initialIsOpen": false }, - { - "parentPluginId": "data", - "id": "def-common.isExistsFilter", - "type": "Any", - "tags": [ - "deprecated" - ], - "label": "isExistsFilter", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.isGeoBoundingBoxFilter", - "type": "Any", - "tags": [ - "deprecated" - ], - "label": "isGeoBoundingBoxFilter", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.isGeoPolygonFilter", - "type": "Any", - "tags": [ - "deprecated" - ], - "label": "isGeoPolygonFilter", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.isMatchAllFilter", - "type": "Any", - "tags": [ - "deprecated" - ], - "label": "isMatchAllFilter", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.isMissingFilter", - "type": "Any", - "tags": [ - "deprecated" - ], - "label": "isMissingFilter", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.isPhraseFilter", - "type": "Any", - "tags": [ - "deprecated" - ], - "label": "isPhraseFilter", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.isPhrasesFilter", - "type": "Any", - "tags": [ - "deprecated" - ], - "label": "isPhrasesFilter", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.isQueryStringFilter", - "type": "Any", - "tags": [ - "deprecated" - ], - "label": "isQueryStringFilter", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "references": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-common.isRangeFilter", - "type": "Any", - "tags": [ - "deprecated" - ], - "label": "isRangeFilter", - "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data/common/es_query/index.ts", - "deprecated": true, - "references": [], - "initialIsOpen": false - }, { "parentPluginId": "data", "id": "def-common.KIBANA_USER_QUERY_LANGUAGE_KEY", @@ -40858,7 +43135,10 @@ "label": "MatchAllFilter", "description": [], "signature": [ - "any" + "Filter", + " & { meta: ", + "MatchAllFilterMeta", + "; match_all: any; }" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -40884,7 +43164,10 @@ "label": "MissingFilter", "description": [], "signature": [ - "any" + "Filter", + " & { meta: ", + "FilterMeta", + "; missing: { field: string; }; }" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -40901,7 +43184,10 @@ "label": "PhraseFilter", "description": [], "signature": [ - "any" + "Filter", + " & { meta: ", + "PhraseFilterMeta", + "; script?: { script: { source?: string | undefined; lang?: \"painless\" | \"expression\" | \"mustache\" | \"java\" | undefined; params: { [key: string]: PhraseFilterValue; }; }; } | undefined; }" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -40918,13 +43204,30 @@ "label": "PhrasesFilter", "description": [], "signature": [ - "any" + "Filter", + " & { meta: ", + "PhrasesFilterMeta", + "; }" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, "references": [], "initialIsOpen": false }, + { + "parentPluginId": "data", + "id": "def-common.Query", + "type": "Type", + "tags": [], + "label": "Query", + "description": [], + "signature": [ + "{ query: string | { [key: string]: any; }; language: string; }" + ], + "path": "node_modules/@kbn/es-query/target_types/filters/build_filters/types.d.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "data", "id": "def-common.RangeFilter", @@ -40935,7 +43238,14 @@ "label": "RangeFilter", "description": [], "signature": [ - "any" + "Filter", + " & ", + "EsRangeFilter", + " & { meta: ", + "RangeFilterMeta", + "; script?: { script: { params: any; lang: ", + "ScriptLanguage", + "; source: string; }; } | undefined; match_all?: any; }" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -40961,7 +43271,10 @@ "label": "RangeFilterMeta", "description": [], "signature": [ - "any" + "FilterMeta", + " & { params: ", + "RangeFilterParams", + "; field?: string | undefined; formattedValue?: string | undefined; }" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, @@ -40978,7 +43291,7 @@ "label": "RangeFilterParams", "description": [], "signature": [ - "any" + "RangeFilterParams" ], "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, diff --git a/api_docs/data.mdx b/api_docs/data.mdx index d8d9fd6dcb7f8..201d4a23cd9c2 100644 --- a/api_docs/data.mdx +++ b/api_docs/data.mdx @@ -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 | |-------------------|-----------|------------------------|-----------------| -| 3870 | 151 | 3322 | 63 | +| 3994 | 85 | 3446 | 63 | ## Client diff --git a/api_docs/data_autocomplete.json b/api_docs/data_autocomplete.json index 178d949732bbf..57fe5efbde55a 100644 --- a/api_docs/data_autocomplete.json +++ b/api_docs/data_autocomplete.json @@ -381,6 +381,28 @@ ], "path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.args", + "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 } ], diff --git a/api_docs/data_autocomplete.mdx b/api_docs/data_autocomplete.mdx index 7127cef253d07..b637beec7a273 100644 --- a/api_docs/data_autocomplete.mdx +++ b/api_docs/data_autocomplete.mdx @@ -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 | |-------------------|-----------|------------------------|-----------------| -| 3870 | 151 | 3322 | 63 | +| 3994 | 85 | 3446 | 63 | ## Client diff --git a/api_docs/data_field_formats.json b/api_docs/data_field_formats.json index 5e0e4b244d4de..acab018231ec5 100644 --- a/api_docs/data_field_formats.json +++ b/api_docs/data_field_formats.json @@ -3598,6 +3598,32 @@ ], "path": "src/plugins/data/common/field_formats/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.key", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "path": "src/plugins/data/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.defaultOverride", + "type": "Uncategorized", + "tags": [], + "label": "defaultOverride", + "description": [], + "signature": [ + "T | undefined" + ], + "path": "src/plugins/data/common/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { diff --git a/api_docs/data_field_formats.mdx b/api_docs/data_field_formats.mdx index f15408a709240..7aebda56c0461 100644 --- a/api_docs/data_field_formats.mdx +++ b/api_docs/data_field_formats.mdx @@ -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 | |-------------------|-----------|------------------------|-----------------| -| 3870 | 151 | 3322 | 63 | +| 3994 | 85 | 3446 | 63 | ## Client diff --git a/api_docs/data_index_patterns.json b/api_docs/data_index_patterns.json index 8aca3f6d7f1ec..3badbb04ce527 100644 --- a/api_docs/data_index_patterns.json +++ b/api_docs/data_index_patterns.json @@ -5712,7 +5712,67 @@ ") | undefined" ], "path": "src/plugins/data/common/index_patterns/fields/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.IFieldType.toSpec.$1.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.IFieldType.toSpec.$1.options.getFormatterForField", + "type": "Function", + "tags": [], + "label": "getFormatterForField", + "description": [], + "signature": [ + "((field: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + }, + ") => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataFieldFormatsPluginApi", + "section": "def-common.FieldFormat", + "text": "FieldFormat" + }, + ") | undefined" + ], + "path": "src/plugins/data/common/index_patterns/fields/types.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -5740,18 +5800,6 @@ "path": "src/plugins/data/common/index_patterns/types.ts", "deprecated": true, "references": [ - { - "plugin": "savedObjects", - "path": "src/plugins/saved_objects/public/types.ts" - }, - { - "plugin": "savedObjects", - "path": "src/plugins/saved_objects/public/types.ts" - }, - { - "plugin": "savedObjects", - "path": "src/plugins/saved_objects/public/types.ts" - }, { "plugin": "observability", "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts" @@ -6472,14 +6520,6 @@ "plugin": "observability", "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts" }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/embeddable/types.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/public/embeddable/types.ts" - }, { "plugin": "ml", "path": "x-pack/plugins/ml/public/application/jobs/new_job/utils/new_job_utils.ts" @@ -6741,7 +6781,46 @@ ") | undefined" ], "path": "src/plugins/data/common/index_patterns/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.IIndexPattern.getFormatterForField.$1", + "type": "CompoundType", + "tags": [], + "label": "field", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + }, + " | ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.FieldSpec", + "text": "FieldSpec" + } + ], + "path": "src/plugins/data/common/index_patterns/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -7211,11 +7290,10 @@ ], "path": "src/plugins/data/common/index_patterns/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-common.options", + "id": "def-common.IIndexPatternsApiClient.getFieldsForTimePattern.$1", "type": "Object", "tags": [], "label": "options", @@ -7230,9 +7308,11 @@ } ], "path": "src/plugins/data/common/index_patterns/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "data", @@ -7254,11 +7334,10 @@ ], "path": "src/plugins/data/common/index_patterns/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-common.options", + "id": "def-common.IIndexPatternsApiClient.getFieldsForWildcard.$1", "type": "Object", "tags": [], "label": "options", @@ -7273,9 +7352,11 @@ } ], "path": "src/plugins/data/common/index_patterns/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -7780,11 +7861,10 @@ ], "path": "src/plugins/data/common/index_patterns/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-common.options", + "id": "def-common.SavedObjectsClientCommon.find.$1", "type": "Object", "tags": [], "label": "options", @@ -7799,9 +7879,11 @@ } ], "path": "src/plugins/data/common/index_patterns/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "data", @@ -7817,29 +7899,37 @@ ], "path": "src/plugins/data/common/index_patterns/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-common.type", + "id": "def-common.SavedObjectsClientCommon.get.$1", "type": "string", "tags": [], "label": "type", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/data/common/index_patterns/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "data", - "id": "def-common.id", + "id": "def-common.SavedObjectsClientCommon.get.$2", "type": "string", "tags": [], "label": "id", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/data/common/index_patterns/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "data", @@ -7855,55 +7945,65 @@ ], "path": "src/plugins/data/common/index_patterns/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-common.type", + "id": "def-common.SavedObjectsClientCommon.update.$1", "type": "string", "tags": [], "label": "type", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/data/common/index_patterns/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "data", - "id": "def-common.id", + "id": "def-common.SavedObjectsClientCommon.update.$2", "type": "string", "tags": [], "label": "id", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/data/common/index_patterns/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "data", - "id": "def-common.attributes", + "id": "def-common.SavedObjectsClientCommon.update.$3", "type": "Object", "tags": [], "label": "attributes", "description": [], "signature": [ - "{ [x: string]: any; }" + "Record" ], "path": "src/plugins/data/common/index_patterns/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "data", - "id": "def-common.options", + "id": "def-common.SavedObjectsClientCommon.update.$4", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ - "{ [x: string]: any; }" + "Record" ], "path": "src/plugins/data/common/index_patterns/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "data", @@ -7919,45 +8019,51 @@ ], "path": "src/plugins/data/common/index_patterns/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-common.type", + "id": "def-common.SavedObjectsClientCommon.create.$1", "type": "string", "tags": [], "label": "type", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/data/common/index_patterns/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "data", - "id": "def-common.attributes", + "id": "def-common.SavedObjectsClientCommon.create.$2", "type": "Object", "tags": [], "label": "attributes", "description": [], "signature": [ - "{ [x: string]: any; }" + "Record" ], "path": "src/plugins/data/common/index_patterns/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "data", - "id": "def-common.options", + "id": "def-common.SavedObjectsClientCommon.create.$3", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ - "{ [x: string]: any; }" + "Record" ], "path": "src/plugins/data/common/index_patterns/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "data", @@ -7971,29 +8077,37 @@ ], "path": "src/plugins/data/common/index_patterns/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-common.type", + "id": "def-common.SavedObjectsClientCommon.delete.$1", "type": "string", "tags": [], "label": "type", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/data/common/index_patterns/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "data", - "id": "def-common.id", + "id": "def-common.SavedObjectsClientCommon.delete.$2", "type": "string", "tags": [], "label": "id", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/data/common/index_patterns/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -8160,19 +8274,23 @@ ], "path": "src/plugins/data/common/index_patterns/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-common.key", + "id": "def-common.UiSettingsCommon.get.$1", "type": "string", "tags": [], "label": "key", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/data/common/index_patterns/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "data", @@ -8186,8 +8304,8 @@ ], "path": "src/plugins/data/common/index_patterns/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "data", @@ -8201,21 +8319,24 @@ ], "path": "src/plugins/data/common/index_patterns/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-common.key", + "id": "def-common.UiSettingsCommon.set.$1", "type": "string", "tags": [], "label": "key", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/data/common/index_patterns/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "data", - "id": "def-common.value", + "id": "def-common.UiSettingsCommon.set.$2", "type": "Any", "tags": [], "label": "value", @@ -8224,9 +8345,11 @@ "any" ], "path": "src/plugins/data/common/index_patterns/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "data", @@ -8240,19 +8363,23 @@ ], "path": "src/plugins/data/common/index_patterns/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-common.key", + "id": "def-common.UiSettingsCommon.remove.$1", "type": "string", "tags": [], "label": "key", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/data/common/index_patterns/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -8585,6 +8712,41 @@ ], "path": "src/plugins/data/common/index_patterns/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.error", + "type": "Object", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "Error" + ], + "path": "src/plugins/data/common/index_patterns/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.toastInputFields", + "type": "Object", + "tags": [], + "label": "toastInputFields", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.ErrorToastOptions", + "text": "ErrorToastOptions" + } + ], + "path": "src/plugins/data/common/index_patterns/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -8607,6 +8769,40 @@ ], "path": "src/plugins/data/common/index_patterns/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.toastInputFields", + "type": "CompoundType", + "tags": [], + "label": "toastInputFields", + "description": [], + "signature": [ + "Pick<", + "Toast", + ", \"children\" | \"onClick\" | \"onChange\" | \"color\" | \"onKeyDown\" | \"defaultChecked\" | \"defaultValue\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"className\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"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\" | \"security\" | \"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", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + " | undefined; text?: string | ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.MountPoint", + "text": "MountPoint" + }, + " | undefined; }" + ], + "path": "src/plugins/data/common/index_patterns/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { diff --git a/api_docs/data_index_patterns.mdx b/api_docs/data_index_patterns.mdx index 25465d70f5e2a..e4430947ed163 100644 --- a/api_docs/data_index_patterns.mdx +++ b/api_docs/data_index_patterns.mdx @@ -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 | |-------------------|-----------|------------------------|-----------------| -| 3870 | 151 | 3322 | 63 | +| 3994 | 85 | 3446 | 63 | ## Server diff --git a/api_docs/data_query.json b/api_docs/data_query.json index 597775b540df3..3ed8cc6ab9f02 100644 --- a/api_docs/data_query.json +++ b/api_docs/data_query.json @@ -82,7 +82,9 @@ "label": "getFilters", "description": [], "signature": [ - "() => any[]" + "() => ", + "Filter", + "[]" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, @@ -97,7 +99,9 @@ "label": "getAppFilters", "description": [], "signature": [ - "() => any[]" + "() => ", + "Filter", + "[]" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, @@ -112,7 +116,9 @@ "label": "getGlobalFilters", "description": [], "signature": [ - "() => any[]" + "() => ", + "Filter", + "[]" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, @@ -177,7 +183,11 @@ "label": "addFilters", "description": [], "signature": [ - "(filters: any, pinFilterStatus?: boolean) => void" + "(filters: ", + "Filter", + " | ", + "Filter", + "[], pinFilterStatus?: boolean) => void" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, @@ -185,12 +195,15 @@ { "parentPluginId": "data", "id": "def-public.FilterManager.addFilters.$1", - "type": "Any", + "type": "CompoundType", "tags": [], "label": "filters", "description": [], "signature": [ - "any" + "Filter", + " | ", + "Filter", + "[]" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, @@ -221,7 +234,9 @@ "label": "setFilters", "description": [], "signature": [ - "(newFilters: any[], pinFilterStatus?: boolean) => void" + "(newFilters: ", + "Filter", + "[], pinFilterStatus?: boolean) => void" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, @@ -234,7 +249,8 @@ "label": "newFilters", "description": [], "signature": [ - "any[]" + "Filter", + "[]" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, @@ -267,7 +283,9 @@ "\nSets new global filters and leaves app filters untouched,\nRemoves app filters for which there is a duplicate within new global filters" ], "signature": [ - "(newGlobalFilters: any[]) => void" + "(newGlobalFilters: ", + "Filter", + "[]) => void" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, @@ -280,7 +298,8 @@ "label": "newGlobalFilters", "description": [], "signature": [ - "any[]" + "Filter", + "[]" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, @@ -299,7 +318,9 @@ "\nSets new app filters and leaves global filters untouched,\nRemoves app filters for which there is a duplicate within new global filters" ], "signature": [ - "(newAppFilters: any[]) => void" + "(newAppFilters: ", + "Filter", + "[]) => void" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, @@ -312,7 +333,8 @@ "label": "newAppFilters", "description": [], "signature": [ - "any[]" + "Filter", + "[]" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, @@ -329,7 +351,9 @@ "label": "removeFilter", "description": [], "signature": [ - "(filter: any) => void" + "(filter: ", + "Filter", + ") => void" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, @@ -337,12 +361,12 @@ { "parentPluginId": "data", "id": "def-public.FilterManager.removeFilter.$1", - "type": "Any", + "type": "Object", "tags": [], "label": "filter", "description": [], "signature": [ - "any" + "Filter" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, @@ -374,7 +398,9 @@ "label": "setFiltersStore", "description": [], "signature": [ - "(filters: any[], store: ", + "(filters: ", + "Filter", + "[], store: ", "FilterStateStore", ", shouldOverrideStore?: boolean) => void" ], @@ -389,7 +415,8 @@ "label": "filters", "description": [], "signature": [ - "any[]" + "Filter", + "[]" ], "path": "src/plugins/data/public/query/filter_manager/filter_manager.ts", "deprecated": false, @@ -678,7 +705,9 @@ "section": "def-public.QueryState", "text": "QueryState" }, - ">({ timefilter: { timefilter }, filterManager, queryString, state$, }: Pick<{ addToQueryLog: (appName: string, { language, query }: any) => void; filterManager: ", + ">({ timefilter: { timefilter }, filterManager, queryString, state$, }: Pick<{ addToQueryLog: (appName: string, { language, query }: ", + "Query", + ") => void; filterManager: ", { "pluginId": "data", "scope": "public", @@ -734,7 +763,11 @@ }, " | undefined) => { bool: { must: ", "DslQuery", - "[]; filter: any[]; should: never[]; must_not: any[]; }; }; } | { filterManager: ", + "[]; filter: ", + "Filter", + "[]; should: never[]; must_not: ", + "Filter", + "[]; }; }; } | { filterManager: ", { "pluginId": "data", "scope": "public", @@ -787,7 +820,9 @@ "label": "{\n timefilter: { timefilter },\n filterManager,\n queryString,\n state$,\n }", "description": [], "signature": [ - "Pick<{ addToQueryLog: (appName: string, { language, query }: any) => void; filterManager: ", + "Pick<{ addToQueryLog: (appName: string, { language, query }: ", + "Query", + ") => void; filterManager: ", { "pluginId": "data", "scope": "public", @@ -843,7 +878,11 @@ }, " | undefined) => { bool: { must: ", "DslQuery", - "[]; filter: any[]; should: never[]; must_not: any[]; }; }; } | { filterManager: ", + "[]; filter: ", + "Filter", + "[]; should: never[]; must_not: ", + "Filter", + "[]; }; }; } | { filterManager: ", { "pluginId": "data", "scope": "public", @@ -1034,7 +1073,11 @@ "label": "extractTimeRange", "description": [], "signature": [ - "(filters: any[], timeFieldName: string | undefined) => { restOfFilters: any[]; timeRange?: ", + "(filters: ", + "Filter", + "[], timeFieldName: string | undefined) => { restOfFilters: ", + "Filter", + "[]; timeRange?: ", { "pluginId": "data", "scope": "common", @@ -1055,7 +1098,8 @@ "label": "filters", "description": [], "signature": [ - "any[]" + "Filter", + "[]" ], "path": "src/plugins/data/public/query/timefilter/lib/extract_time_filter.ts", "deprecated": false, @@ -1105,7 +1149,9 @@ "section": "def-common.IFieldType", "text": "IFieldType" }, - ", values: any, operation: string, index: string) => any[]" + ", values: any, operation: string, index: string) => ", + "Filter", + "[]" ], "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", "deprecated": false, @@ -1252,7 +1298,9 @@ "label": "getDisplayValueFromFilter", "description": [], "signature": [ - "(filter: any, indexPatterns: ", + "(filter: ", + "Filter", + ", indexPatterns: ", { "pluginId": "data", "scope": "common", @@ -1268,12 +1316,12 @@ { "parentPluginId": "data", "id": "def-public.getDisplayValueFromFilter.$1", - "type": "Any", + "type": "Object", "tags": [], "label": "filter", "description": [], "signature": [ - "any" + "Filter" ], "path": "src/plugins/data/public/query/filter_manager/lib/get_display_value.ts", "deprecated": false, @@ -1314,7 +1362,9 @@ "\nHelper to setup syncing of global data with the URL" ], "signature": [ - "(query: Pick<{ addToQueryLog: (appName: string, { language, query }: any) => void; filterManager: ", + "(query: Pick<{ addToQueryLog: (appName: string, { language, query }: ", + "Query", + ") => void; filterManager: ", { "pluginId": "data", "scope": "public", @@ -1370,7 +1420,11 @@ }, " | undefined) => { bool: { must: ", "DslQuery", - "[]; filter: any[]; should: never[]; must_not: any[]; }; }; } | { filterManager: ", + "[]; filter: ", + "Filter", + "[]; should: never[]; must_not: ", + "Filter", + "[]; }; }; } | { filterManager: ", { "pluginId": "data", "scope": "public", @@ -1421,7 +1475,9 @@ "label": "query", "description": [], "signature": [ - "Pick<{ addToQueryLog: (appName: string, { language, query }: any) => void; filterManager: ", + "Pick<{ addToQueryLog: (appName: string, { language, query }: ", + "Query", + ") => void; filterManager: ", { "pluginId": "data", "scope": "public", @@ -1477,7 +1533,11 @@ }, " | undefined) => { bool: { must: ", "DslQuery", - "[]; filter: any[]; should: never[]; must_not: any[]; }; }; } | { filterManager: ", + "[]; filter: ", + "Filter", + "[]; should: never[]; must_not: ", + "Filter", + "[]; }; }; } | { filterManager: ", { "pluginId": "data", "scope": "public", @@ -1601,7 +1661,8 @@ "label": "filters", "description": [], "signature": [ - "any[] | undefined" + "Filter", + "[] | undefined" ], "path": "src/plugins/data/public/query/state_sync/types.ts", "deprecated": false @@ -1609,12 +1670,13 @@ { "parentPluginId": "data", "id": "def-public.QueryState.query", - "type": "Any", + "type": "Object", "tags": [], "label": "query", "description": [], "signature": [ - "any" + "Query", + " | undefined" ], "path": "src/plugins/data/public/query/state_sync/types.ts", "deprecated": false @@ -1739,11 +1801,10 @@ ], "path": "src/plugins/data/public/query/saved_query/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-public.attributes", + "id": "def-public.SavedQueryService.saveQuery.$1", "type": "Object", "tags": [], "label": "attributes", @@ -1752,22 +1813,33 @@ "SavedQueryAttributes" ], "path": "src/plugins/data/public/query/saved_query/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "data", - "id": "def-public.config", + "id": "def-public.SavedQueryService.saveQuery.$2.config", "type": "Object", "tags": [], "label": "config", "description": [], - "signature": [ - "{ overwrite: boolean; } | undefined" - ], "path": "src/plugins/data/public/query/saved_query/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.SavedQueryService.saveQuery.$2.config.overwrite", + "type": "boolean", + "tags": [], + "label": "overwrite", + "description": [], + "path": "src/plugins/data/public/query/saved_query/types.ts", + "deprecated": false + } + ] } - ] + ], + "returnComment": [] }, { "parentPluginId": "data", @@ -1789,8 +1861,8 @@ ], "path": "src/plugins/data/public/query/saved_query/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "data", @@ -1812,11 +1884,10 @@ ], "path": "src/plugins/data/public/query/saved_query/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-public.searchText", + "id": "def-public.SavedQueryService.findSavedQueries.$1", "type": "string", "tags": [], "label": "searchText", @@ -1825,11 +1896,12 @@ "string | undefined" ], "path": "src/plugins/data/public/query/saved_query/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": false }, { "parentPluginId": "data", - "id": "def-public.perPage", + "id": "def-public.SavedQueryService.findSavedQueries.$2", "type": "number", "tags": [], "label": "perPage", @@ -1838,11 +1910,12 @@ "number | undefined" ], "path": "src/plugins/data/public/query/saved_query/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": false }, { "parentPluginId": "data", - "id": "def-public.activePage", + "id": "def-public.SavedQueryService.findSavedQueries.$3", "type": "number", "tags": [], "label": "activePage", @@ -1851,9 +1924,11 @@ "number | undefined" ], "path": "src/plugins/data/public/query/saved_query/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "data", @@ -1875,19 +1950,23 @@ ], "path": "src/plugins/data/public/query/saved_query/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-public.id", + "id": "def-public.SavedQueryService.getSavedQuery.$1", "type": "string", "tags": [], "label": "id", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/data/public/query/saved_query/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "data", @@ -1901,19 +1980,23 @@ ], "path": "src/plugins/data/public/query/saved_query/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-public.id", + "id": "def-public.SavedQueryService.deleteSavedQuery.$1", "type": "string", "tags": [], "label": "id", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/data/public/query/saved_query/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "data", @@ -1927,8 +2010,8 @@ ], "path": "src/plugins/data/public/query/saved_query/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -1948,6 +2031,8 @@ ], "path": "src/plugins/data/public/query/timefilter/lib/auto_refresh_loop.ts", "deprecated": false, + "returnComment": [], + "children": [], "initialIsOpen": false }, { @@ -1979,7 +2064,9 @@ "label": "QueryStart", "description": [], "signature": [ - "{ addToQueryLog: (appName: string, { language, query }: any) => void; filterManager: ", + "{ addToQueryLog: (appName: string, { language, query }: ", + "Query", + ") => void; filterManager: ", { "pluginId": "data", "scope": "public", @@ -2035,7 +2122,11 @@ }, " | undefined) => { bool: { must: ", "DslQuery", - "[]; filter: any[]; should: never[]; must_not: any[]; }; }; }" + "[]; filter: ", + "Filter", + "[]; should: never[]; must_not: ", + "Filter", + "[]; }; }; }" ], "path": "src/plugins/data/public/query/query_service.ts", "deprecated": false, @@ -2152,7 +2243,9 @@ "section": "def-common.TimeRange", "text": "TimeRange" }, - " | undefined) => any; getBounds: () => ", + " | undefined) => ", + "RangeFilter", + " | undefined; getBounds: () => ", { "pluginId": "data", "scope": "common", @@ -2417,7 +2510,9 @@ "section": "def-common.TimeRange", "text": "TimeRange" }, - ", options: { forceNow?: Date | undefined; fieldName?: string | undefined; } | undefined) => any" + ", options: { forceNow?: Date | undefined; fieldName?: string | undefined; } | undefined) => ", + "RangeFilter", + " | undefined" ], "path": "src/plugins/data/common/query/timefilter/get_time.ts", "deprecated": false, @@ -2513,7 +2608,8 @@ "label": "isQuery", "description": [], "signature": [ - "(x: unknown) => x is any" + "(x: unknown) => x is ", + "Query" ], "path": "src/plugins/data/common/query/is_query.ts", "deprecated": false, diff --git a/api_docs/data_query.mdx b/api_docs/data_query.mdx index 2c58a8895cc27..f920798fd8b93 100644 --- a/api_docs/data_query.mdx +++ b/api_docs/data_query.mdx @@ -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 | |-------------------|-----------|------------------------|-----------------| -| 3870 | 151 | 3322 | 63 | +| 3994 | 85 | 3446 | 63 | ## Client diff --git a/api_docs/data_search.json b/api_docs/data_search.json index 2ff9a049552aa..d6006dc315db1 100644 --- a/api_docs/data_search.json +++ b/api_docs/data_search.json @@ -1055,11 +1055,10 @@ ], "path": "src/plugins/data/public/search/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-public.e", + "id": "def-public.ISearchStart.showError.$1", "type": "Object", "tags": [], "label": "e", @@ -1068,9 +1067,11 @@ "Error" ], "path": "src/plugins/data/public/search/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "data", @@ -1681,8 +1682,8 @@ ], "path": "src/plugins/data/public/search/session/session_service.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "data", @@ -1727,8 +1728,8 @@ ], "path": "src/plugins/data/public/search/session/session_service.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -2788,11 +2789,10 @@ ], "path": "src/plugins/data/server/search/session/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-server.core", + "id": "def-server.ISearchSessionService.asScopedProvider.$1", "type": "Object", "tags": [], "label": "core", @@ -2807,9 +2807,11 @@ } ], "path": "src/plugins/data/server/search/session/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -2891,21 +2893,24 @@ ], "path": "src/plugins/data/server/search/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-server.name", + "id": "def-server.ISearchSetup.registerSearchStrategy.$1", "type": "string", "tags": [], "label": "name", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/data/server/search/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "data", - "id": "def-server.strategy", + "id": "def-server.ISearchSetup.registerSearchStrategy.$2", "type": "Object", "tags": [], "label": "strategy", @@ -2921,9 +2926,11 @@ "" ], "path": "src/plugins/data/server/search/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "data", @@ -3043,11 +3050,10 @@ ], "path": "src/plugins/data/server/search/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-server.name", + "id": "def-server.ISearchStart.getSearchStrategy.$1", "type": "string", "tags": [], "label": "name", @@ -3056,9 +3062,11 @@ "string | undefined" ], "path": "src/plugins/data/server/search/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "data", @@ -3087,11 +3095,10 @@ ], "path": "src/plugins/data/server/search/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-server.request", + "id": "def-server.ISearchStart.asScoped.$1", "type": "Object", "tags": [], "label": "request", @@ -3107,9 +3114,11 @@ "" ], "path": "src/plugins/data/server/search/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "data", @@ -3195,11 +3204,10 @@ ], "path": "src/plugins/data/server/search/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-server.request", + "id": "def-server.ISearchStrategy.search.$1", "type": "Uncategorized", "tags": [], "label": "request", @@ -3208,11 +3216,12 @@ "SearchStrategyRequest" ], "path": "src/plugins/data/server/search/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "data", - "id": "def-server.options", + "id": "def-server.ISearchStrategy.search.$2", "type": "Object", "tags": [], "label": "options", @@ -3227,11 +3236,12 @@ } ], "path": "src/plugins/data/server/search/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "data", - "id": "def-server.deps", + "id": "def-server.ISearchStrategy.search.$3", "type": "Object", "tags": [], "label": "deps", @@ -3246,9 +3256,11 @@ } ], "path": "src/plugins/data/server/search/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "data", @@ -3277,7 +3289,64 @@ ") => Promise) | undefined" ], "path": "src/plugins/data/server/search/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.ISearchStrategy.cancel.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data/server/search/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.ISearchStrategy.cancel.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + } + ], + "path": "src/plugins/data/server/search/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.ISearchStrategy.cancel.$3", + "type": "Object", + "tags": [], + "label": "deps", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataSearchPluginApi", + "section": "def-server.SearchStrategyDependencies", + "text": "SearchStrategyDependencies" + } + ], + "path": "src/plugins/data/server/search/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "data", @@ -3306,7 +3375,78 @@ ") => Promise) | undefined" ], "path": "src/plugins/data/server/search/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.ISearchStrategy.extend.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data/server/search/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.ISearchStrategy.extend.$2", + "type": "string", + "tags": [], + "label": "keepAlive", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data/server/search/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.ISearchStrategy.extend.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + } + ], + "path": "src/plugins/data/server/search/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.ISearchStrategy.extend.$4", + "type": "Object", + "tags": [], + "label": "deps", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataSearchPluginApi", + "section": "def-server.SearchStrategyDependencies", + "text": "SearchStrategyDependencies" + } + ], + "path": "src/plugins/data/server/search/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -5766,7 +5906,9 @@ "label": "getSearchSourceTimeFilter", "description": [], "signature": [ - "(forceNow?: Date | undefined) => any[]" + "(forceNow?: Date | undefined) => ", + "RangeFilter", + "[] | { meta: { index: string | undefined; params: {}; alias: string; disabled: boolean; negate: boolean; }; query: { bool: { should: { bool: { filter: { range: { [x: string]: { gte: string; lte: string; }; }; }[]; }; }[]; minimum_should_match: number; }; }; }[]" ], "path": "src/plugins/data/common/search/aggs/agg_configs.ts", "deprecated": false, @@ -11032,7 +11174,11 @@ "label": "filtersToAst", "description": [], "signature": [ - "(filters: any) => ", + "(filters: ", + "Filter", + " | ", + "Filter", + "[]) => ", { "pluginId": "expressions", "scope": "common", @@ -11048,12 +11194,15 @@ { "parentPluginId": "data", "id": "def-common.filtersToAst.$1", - "type": "Any", + "type": "CompoundType", "tags": [], "label": "filters", "description": [], "signature": [ - "any" + "Filter", + " | ", + "Filter", + "[]" ], "path": "src/plugins/data/common/search/expressions/filters_to_ast.ts", "deprecated": false, @@ -11782,11 +11931,10 @@ ], "path": "src/plugins/data/common/search/expressions/esdsl.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-common.getKibanaRequest", + "id": "def-common.getEsdslFn.$1.getStartDependencies.getStartDependencies.$1", "type": "Any", "tags": [], "label": "getKibanaRequest", @@ -11795,9 +11943,11 @@ "any" ], "path": "src/plugins/data/common/search/expressions/esdsl.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ] } @@ -11856,19 +12006,23 @@ ], "path": "src/plugins/data/common/search/aggs/buckets/filter.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-common.key", + "id": "def-common.getFilterBucketAgg.$1.getConfig.getConfig.$1", "type": "string", "tags": [], "label": "key", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/data/common/search/aggs/buckets/filter.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ] } @@ -14185,7 +14339,9 @@ "label": "queryToAst", "description": [], "signature": [ - "(query: any) => ", + "(query: ", + "Query", + ") => ", { "pluginId": "expressions", "scope": "common", @@ -14200,12 +14356,12 @@ { "parentPluginId": "data", "id": "def-common.queryToAst.$1", - "type": "Any", + "type": "Object", "tags": [], "label": "query", "description": [], "signature": [ - "any" + "Query" ], "path": "src/plugins/data/common/search/expressions/query_to_ast.ts", "deprecated": false, @@ -14695,7 +14851,17 @@ "section": "def-common.GeoPoint", "text": "GeoPoint" }, - "; }) | ({ type: \"geo_bounding_box\"; } & WellKnownText) | undefined; filter?: any; }, \"filter\" | \"geo_bounding_box\"> & Pick<{ geo_bounding_box?: ({ type: \"geo_bounding_box\"; } & GeoBox) | ({ type: \"geo_bounding_box\"; } & { top_left: ", + "; }) | ({ type: \"geo_bounding_box\"; } & WellKnownText) | undefined; filter?: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"kibana_query\", ", + "Query", + "> | undefined; }, \"filter\" | \"geo_bounding_box\"> & Pick<{ geo_bounding_box?: ({ type: \"geo_bounding_box\"; } & GeoBox) | ({ type: \"geo_bounding_box\"; } & { top_left: ", { "pluginId": "data", "scope": "common", @@ -14727,7 +14893,17 @@ "section": "def-common.GeoPoint", "text": "GeoPoint" }, - "; }) | ({ type: \"geo_bounding_box\"; } & WellKnownText) | undefined; filter?: any; }, never>, \"enabled\" | \"id\" | \"filter\" | \"customLabel\" | \"schema\" | \"geo_bounding_box\" | \"json\" | \"timeShift\">, ", + "; }) | ({ type: \"geo_bounding_box\"; } & WellKnownText) | undefined; filter?: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"kibana_query\", ", + "Query", + "> | undefined; }, never>, \"enabled\" | \"id\" | \"filter\" | \"customLabel\" | \"schema\" | \"geo_bounding_box\" | \"json\" | \"timeShift\">, ", "AggExpressionType", ", ", { @@ -19101,36 +19277,81 @@ "((aggConfig: TAggConfig, key: any, params?: any) => any) | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.AggTypeConfig.createFilter.$1", + "type": "Uncategorized", + "tags": [], + "label": "aggConfig", + "description": [], + "signature": [ + "TAggConfig" + ], + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.AggTypeConfig.createFilter.$2", + "type": "Any", + "tags": [], + "label": "key", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.AggTypeConfig.createFilter.$3", + "type": "Any", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-common.AggTypeConfig.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.AggTypeConfig.dslName", + "type": "string", + "tags": [], + "label": "dslName", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data/common/search/aggs/agg_type.ts", "deprecated": false }, { "parentPluginId": "data", - "id": "def-common.AggTypeConfig.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-common.AggTypeConfig.dslName", - "type": "string", - "tags": [], - "label": "dslName", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "deprecated": false - }, - { - "parentPluginId": "data", "id": "def-common.AggTypeConfig.expressionName", "type": "string", "tags": [], @@ -19280,7 +19501,9 @@ "(() => any) | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "data", @@ -19314,7 +19537,24 @@ ">) | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.AggTypeConfig.getSerializedFormat.$1", + "type": "Uncategorized", + "tags": [], + "label": "agg", + "description": [], + "signature": [ + "TAggConfig" + ], + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "data", @@ -19327,7 +19567,38 @@ "((agg: TAggConfig, bucket: any) => any) | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.AggTypeConfig.getValue.$1", + "type": "Uncategorized", + "tags": [], + "label": "agg", + "description": [], + "signature": [ + "TAggConfig" + ], + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.AggTypeConfig.getValue.$2", + "type": "Any", + "tags": [], + "label": "bucket", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "data", @@ -19340,7 +19611,52 @@ "((bucket: any, key: any, agg: TAggConfig) => any) | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.AggTypeConfig.getKey.$1", + "type": "Any", + "tags": [], + "label": "bucket", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.AggTypeConfig.getKey.$2", + "type": "Any", + "tags": [], + "label": "key", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-common.AggTypeConfig.getKey.$3", + "type": "Uncategorized", + "tags": [], + "label": "agg", + "description": [], + "signature": [ + "TAggConfig" + ], + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "data", @@ -19353,7 +19669,24 @@ "((agg: TAggConfig) => string) | undefined" ], "path": "src/plugins/data/common/search/aggs/agg_type.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.AggTypeConfig.getValueBucketPath.$1", + "type": "Uncategorized", + "tags": [], + "label": "agg", + "description": [], + "signature": [ + "TAggConfig" + ], + "path": "src/plugins/data/common/search/aggs/agg_type.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -19576,8 +19909,8 @@ ], "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "data", @@ -19591,19 +19924,23 @@ ], "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-common.key", + "id": "def-common.DateHistogramBucketAggDependencies.getConfig.$1", "type": "string", "tags": [], "label": "key", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -19669,8 +20006,8 @@ ], "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "data", @@ -19684,19 +20021,23 @@ ], "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-common.key", + "id": "def-common.DateRangeBucketAggDependencies.getConfig.$1", "type": "string", "tags": [], "label": "key", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/data/common/search/aggs/buckets/date_range.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -19922,24 +20263,24 @@ ], "path": "src/plugins/data/common/search/search_source/fetch/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-common.request", + "id": "def-common.FetchHandlers.onResponse.$1", "type": "Object", "tags": [], "label": "request", "description": [], "signature": [ - "{ [x: string]: any; }" + "Record" ], "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "data", - "id": "def-common.response", + "id": "def-common.FetchHandlers.onResponse.$2", "type": "Object", "tags": [], "label": "response", @@ -19955,9 +20296,11 @@ "" ], "path": "src/plugins/data/common/search/search_source/fetch/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -19984,19 +20327,23 @@ ], "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-common.key", + "id": "def-common.FiltersBucketAggDependencies.getConfig.$1", "type": "string", "tags": [], "label": "key", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/data/common/search/aggs/buckets/filters.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -20023,19 +20370,23 @@ ], "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-common.key", + "id": "def-common.HistogramBucketAggDependencies.getConfig.$1", "type": "string", "tags": [], "label": "key", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "data", @@ -20256,11 +20607,10 @@ ], "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-common.bounds", + "id": "def-common.IBucketHistogramAggConfig.setAutoBounds.$1", "type": "Object", "tags": [], "label": "bounds", @@ -20275,9 +20625,11 @@ } ], "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "data", @@ -20298,8 +20650,8 @@ ], "path": "src/plugins/data/common/search/aggs/buckets/histogram.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -21124,11 +21476,10 @@ ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-common.fields", + "id": "def-common.ISearchStartSearchSource.create.$1", "type": "Object", "tags": [], "label": "fields", @@ -21144,9 +21495,11 @@ " | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "data", @@ -21170,8 +21523,8 @@ ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -21209,21 +21562,24 @@ ], "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-common.customLabel", + "id": "def-common.IStdDevAggConfig.keyedDetails.$1", "type": "string", "tags": [], "label": "customLabel", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "data", - "id": "def-common.fieldDisplayName", + "id": "def-common.IStdDevAggConfig.keyedDetails.$2", "type": "string", "tags": [], "label": "fieldDisplayName", @@ -21232,9 +21588,11 @@ "string | undefined" ], "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "data", @@ -21248,8 +21606,8 @@ ], "path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -21484,11 +21842,10 @@ ], "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "data", - "id": "def-common.agg", + "id": "def-common.OptionedValueProp.isCompatible.$1", "type": "Object", "tags": [], "label": "agg", @@ -21503,9 +21860,11 @@ } ], "path": "src/plugins/data/common/search/aggs/param_types/optioned.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -21559,12 +21918,12 @@ { "parentPluginId": "data", "id": "def-common.QueryFilter.input", - "type": "Any", + "type": "Object", "tags": [], "label": "input", "description": [], "signature": [ - "any" + "{ query: string | { [key: string]: any; }; language: string; }" ], "path": "src/plugins/data/common/search/expressions/query_filter.ts", "deprecated": false @@ -22414,14 +22773,15 @@ { "parentPluginId": "data", "id": "def-common.SearchSourceFields.query", - "type": "Any", + "type": "Object", "tags": [], "label": "query", "description": [ "\n{@link Query}" ], "signature": [ - "any" + "Query", + " | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false @@ -22429,14 +22789,21 @@ { "parentPluginId": "data", "id": "def-common.SearchSourceFields.filter", - "type": "Any", + "type": "CompoundType", "tags": [], "label": "filter", "description": [ "\n{@link Filter}" ], "signature": [ - "any" + "Filter", + " | ", + "Filter", + "[] | (() => ", + "Filter", + " | ", + "Filter", + "[] | undefined) | undefined" ], "path": "src/plugins/data/common/search/search_source/types.ts", "deprecated": false @@ -24132,7 +24499,13 @@ "label": "ExecutionContextSearch", "description": [], "signature": [ - "{ filters?: any[] | undefined; query?: any; timeRange?: ", + "{ filters?: ", + "Filter", + "[] | undefined; query?: ", + "Query", + " | ", + "Query", + "[] | undefined; timeRange?: ", { "pluginId": "data", "scope": "common", @@ -24287,7 +24660,17 @@ "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, - "<\"existsFilter\", null, Arguments, any, ", + "<\"existsFilter\", null, Arguments, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"kibana_filter\", ", + "Filter", + ">, ", { "pluginId": "expressions", "scope": "common", @@ -24739,7 +25122,17 @@ "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, - "<\"kibanaFilter\", null, Arguments, any, ", + "<\"kibanaFilter\", null, Arguments, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"kibana_filter\", ", + "Filter", + ">, ", { "pluginId": "expressions", "scope": "common", @@ -24841,7 +25234,17 @@ "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, - "<\"kql\", null, Arguments, any, ", + "<\"kql\", null, Arguments, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"kibana_query\", ", + "Query", + ">, ", { "pluginId": "expressions", "scope": "common", @@ -24880,7 +25283,17 @@ "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, - "<\"lucene\", null, Arguments, any, ", + "<\"lucene\", null, Arguments, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"kibana_query\", ", + "Query", + ">, ", { "pluginId": "expressions", "scope": "common", @@ -24982,7 +25395,17 @@ "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, - "<\"rangeFilter\", null, Arguments, any, ", + "<\"rangeFilter\", null, Arguments, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"kibana_filter\", ", + "Filter", + ">, ", { "pluginId": "expressions", "scope": "common", @@ -25123,7 +25546,17 @@ "section": "def-common.ExpressionFunctionDefinition", "text": "ExpressionFunctionDefinition" }, - "<\"rangeFilter\", null, Arguments, any, ", + "<\"rangeFilter\", null, Arguments, ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionValueBoxed", + "text": "ExpressionValueBoxed" + }, + "<\"kibana_filter\", ", + "Filter", + ">, ", { "pluginId": "expressions", "scope": "common", @@ -25673,6 +26106,39 @@ ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined" + ], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -25695,6 +26161,49 @@ ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.keepAlive", + "type": "string", + "tags": [], + "label": "keepAlive", + "description": [], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined" + ], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -25751,6 +26260,42 @@ ], "path": "src/plugins/data/common/search/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.request", + "type": "Uncategorized", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "SearchStrategyRequest" + ], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + " | undefined" + ], + "path": "src/plugins/data/common/search/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -26042,7 +26587,8 @@ "label": "KibanaFilter", "description": [], "signature": [ - "any" + "{ type: \"kibana_filter\"; } & ", + "Filter" ], "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "deprecated": false, @@ -26056,7 +26602,8 @@ "label": "KibanaQueryOutput", "description": [], "signature": [ - "any" + "{ type: \"kibana_query\"; } & ", + "Query" ], "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts", "deprecated": false, @@ -26787,6 +27334,9 @@ "tags": [], "label": "type", "description": [], + "signature": [ + "\"kibana_filter\"" + ], "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "deprecated": false }, @@ -26929,7 +27479,11 @@ "label": "fn", "description": [], "signature": [ - "(input: null, args: Arguments) => any" + "(input: null, args: Arguments) => { $state?: { store: ", + "FilterStateStore", + "; } | undefined; meta: ", + "FilterMeta", + "; query?: any; type: \"kibana_filter\"; }" ], "path": "src/plugins/data/common/search/expressions/exists_filter.ts", "deprecated": false, @@ -28678,6 +29232,9 @@ "tags": [], "label": "type", "description": [], + "signature": [ + "\"kibana_filter\"" + ], "path": "src/plugins/data/common/search/expressions/kibana_filter.ts", "deprecated": false }, @@ -29226,6 +29783,9 @@ "tags": [], "label": "type", "description": [], + "signature": [ + "\"kibana_query\"" + ], "path": "src/plugins/data/common/search/expressions/kql.ts", "deprecated": false }, @@ -29333,7 +29893,7 @@ "label": "fn", "description": [], "signature": [ - "(input: null, args: Arguments) => { type: string; language: string; query: string; }" + "(input: null, args: Arguments) => { type: \"kibana_query\"; language: string; query: string; }" ], "path": "src/plugins/data/common/search/expressions/kql.ts", "deprecated": false, @@ -29402,6 +29962,9 @@ "tags": [], "label": "type", "description": [], + "signature": [ + "\"kibana_query\"" + ], "path": "src/plugins/data/common/search/expressions/lucene.ts", "deprecated": false }, @@ -29509,7 +30072,7 @@ "label": "fn", "description": [], "signature": [ - "(input: null, args: Arguments) => { type: string; language: string; query: any; }" + "(input: null, args: Arguments) => { type: \"kibana_query\"; language: string; query: any; }" ], "path": "src/plugins/data/common/search/expressions/lucene.ts", "deprecated": false, @@ -30037,6 +30600,9 @@ "tags": [], "label": "type", "description": [], + "signature": [ + "\"kibana_filter\"" + ], "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "deprecated": false }, @@ -30240,7 +30806,11 @@ "label": "fn", "description": [], "signature": [ - "(input: null, args: Arguments) => any" + "(input: null, args: Arguments) => { $state?: { store: ", + "FilterStateStore", + "; } | undefined; meta: ", + "FilterMeta", + "; query?: any; type: \"kibana_filter\"; }" ], "path": "src/plugins/data/common/search/expressions/phrase_filter.ts", "deprecated": false, @@ -30539,6 +31109,9 @@ "tags": [], "label": "type", "description": [], + "signature": [ + "\"kibana_filter\"" + ], "path": "src/plugins/data/common/search/expressions/range_filter.ts", "deprecated": false }, @@ -30729,7 +31302,11 @@ "label": "fn", "description": [], "signature": [ - "(input: null, args: Arguments) => any" + "(input: null, args: Arguments) => { $state?: { store: ", + "FilterStateStore", + "; } | undefined; meta: ", + "FilterMeta", + "; query?: any; type: \"kibana_filter\"; }" ], "path": "src/plugins/data/common/search/expressions/range_filter.ts", "deprecated": false, diff --git a/api_docs/data_search.mdx b/api_docs/data_search.mdx index e8afc4da7cce2..16970fe094d46 100644 --- a/api_docs/data_search.mdx +++ b/api_docs/data_search.mdx @@ -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 | |-------------------|-----------|------------------------|-----------------| -| 3870 | 151 | 3322 | 63 | +| 3994 | 85 | 3446 | 63 | ## Client diff --git a/api_docs/data_ui.json b/api_docs/data_ui.json index b46ad04dd1e87..35a017b2bd592 100644 --- a/api_docs/data_ui.json +++ b/api_docs/data_ui.json @@ -150,12 +150,12 @@ { "parentPluginId": "data", "id": "def-public.QueryStringInputProps.query", - "type": "Any", + "type": "Object", "tags": [], "label": "query", "description": [], "signature": [ - "any" + "{ query: string | { [key: string]: any; }; language: string; }" ], "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", "deprecated": false @@ -276,7 +276,9 @@ "(() => void) | undefined" ], "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "data", @@ -286,10 +288,29 @@ "label": "onChange", "description": [], "signature": [ - "((query: any) => void) | undefined" + "((query: ", + "Query", + ") => void) | undefined" ], "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.QueryStringInputProps.onChange.$1", + "type": "Object", + "tags": [], + "label": "query", + "description": [], + "signature": [ + "Query" + ], + "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "data", @@ -302,7 +323,24 @@ "((isFocused: boolean) => void) | undefined" ], "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.QueryStringInputProps.onChangeQueryInputFocus.$1", + "type": "boolean", + "tags": [], + "label": "isFocused", + "description": [], + "signature": [ + "boolean" + ], + "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "data", @@ -312,10 +350,29 @@ "label": "onSubmit", "description": [], "signature": [ - "((query: any) => void) | undefined" + "((query: ", + "Query", + ") => void) | undefined" ], "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.QueryStringInputProps.onSubmit.$1", + "type": "Object", + "tags": [], + "label": "query", + "description": [], + "signature": [ + "Query" + ], + "path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "data", diff --git a/api_docs/data_ui.mdx b/api_docs/data_ui.mdx index bd419a0a5ea11..d39b9c3ea55d4 100644 --- a/api_docs/data_ui.mdx +++ b/api_docs/data_ui.mdx @@ -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 | |-------------------|-----------|------------------------|-----------------| -| 3870 | 151 | 3322 | 63 | +| 3994 | 85 | 3446 | 63 | ## Client diff --git a/api_docs/data_visualizer.json b/api_docs/data_visualizer.json index 393181a4987d9..458674d4f93e4 100644 --- a/api_docs/data_visualizer.json +++ b/api_docs/data_visualizer.json @@ -230,6 +230,35 @@ ], "path": "x-pack/plugins/data_visualizer/public/application/file_data_visualizer/file_data_visualizer.tsx", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "dataVisualizer", + "id": "def-public.props", + "type": "CompoundType", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P & { children?: React.ReactNode; }" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "dataVisualizer", + "id": "def-public.context", + "type": "Any", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "any" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -252,6 +281,35 @@ ], "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/index_data_visualizer.tsx", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "dataVisualizer", + "id": "def-public.props", + "type": "CompoundType", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P & { children?: React.ReactNode; }" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "dataVisualizer", + "id": "def-public.context", + "type": "Any", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "any" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ], "initialIsOpen": false } ], diff --git a/api_docs/data_visualizer.mdx b/api_docs/data_visualizer.mdx index df666753ecbae..428d1cd518b33 100644 --- a/api_docs/data_visualizer.mdx +++ b/api_docs/data_visualizer.mdx @@ -18,7 +18,7 @@ Contact [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) for q | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 104 | 3 | 104 | 0 | +| 108 | 5 | 108 | 0 | ## Client diff --git a/api_docs/deprecations_by_api.mdx b/api_docs/deprecations_by_api.mdx index f9a137ba576b0..dac08687437c9 100644 --- a/api_docs/deprecations_by_api.mdx +++ b/api_docs/deprecations_by_api.mdx @@ -14,17 +14,14 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | indexPatternFieldEditor, savedObjectsManagement | 8.0 | | | indexPatternFieldEditor, savedObjectsManagement | 8.0 | | | indexPatternFieldEditor, savedObjectsManagement | 8.0 | -| | indexManagement | 7.16 | -| | indexManagement | 7.16 | -| | indexManagement, globalSearch | 7.16 | -| | crossClusterReplication, indexLifecycleManagement | 7.16 | -| | savedObjects, observability, timelines, infra, ml, securitySolution, maps, stackAlerts, transform | - | -| | savedObjects, observability, timelines, infra, ml, securitySolution, maps, stackAlerts, transform | - | +| | globalSearch | 7.16 | +| | observability, timelines, infra, ml, securitySolution, stackAlerts, transform | - | | | discover, visualizations, dashboard, lens, observability, maps, canvas, dashboardEnhanced, discoverEnhanced, securitySolution | - | | | observability | - | | | canvas, discover, visualizations, dashboard, lens, observability, timelines, maps, infra, dashboardEnhanced, discoverEnhanced, securitySolution, urlDrilldown, lists, ml, visTypeTimeseries | - | | | canvas, discover, visualizations, dashboard, lens, observability, timelines, maps, infra, dashboardEnhanced, discoverEnhanced, securitySolution, urlDrilldown, lists, ml, visTypeTimeseries | - | | | observability | - | +| | observability, timelines, infra, ml, securitySolution, stackAlerts, transform | - | | | canvas, discover, visualizations, dashboard, lens, observability, timelines, maps, infra, dashboardEnhanced, discoverEnhanced, securitySolution, urlDrilldown, lists, ml, visTypeTimeseries | - | | | timelines | - | | | fleet, lens, timelines, infra, dataVisualizer, ml, apm, securitySolution, stackAlerts, transform, uptime | - | diff --git a/api_docs/deprecations_by_plugin.mdx b/api_docs/deprecations_by_plugin.mdx index bd85224ef8973..5937c2e439bd4 100644 --- a/api_docs/deprecations_by_plugin.mdx +++ b/api_docs/deprecations_by_plugin.mdx @@ -177,16 +177,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex -## crossClusterReplication - -| Deprecated API | Reference location(s) | Remove By | -| ---------------|-----------|-----------| -| | [plugin.ts - ](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cross_cluster_replication/server/plugin.ts#:~:text=LegacyAPICaller), [plugin.ts - ](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cross_cluster_replication/server/plugin.ts#:~:text=LegacyAPICaller) | 7.16 | - - - ## dashboard | Deprecated API | Reference location(s) | Remove By | @@ -572,38 +562,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex -## indexLifecycleManagement - -| Deprecated API | Reference location(s) | Remove By | -| ---------------|-----------|-----------| -| | [plugin.ts - ](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_lifecycle_management/server/plugin.ts#:~:text=LegacyAPICaller), [plugin.ts - ](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_lifecycle_management/server/plugin.ts#:~:text=LegacyAPICaller) | 7.16 | - - - -## indexManagement - -| Deprecated API | Reference location(s) | Remove By | -| ---------------|-----------|-----------| -| | [plugin.ts - ](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/server/plugin.ts#:~:text=ILegacyCustomClusterClient), [plugin.ts - ](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/server/plugin.ts#:~:text=ILegacyCustomClusterClient) | 7.16 | -| | [types.ts - ](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/server/types.ts#:~:text=LegacyScopedClusterClient), [types.ts - ](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/server/types.ts#:~:text=LegacyScopedClusterClient), [types.d.ts - ](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/target/types/server/types.d.ts#:~:text=LegacyScopedClusterClient), [types.d.ts - ](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/target/types/server/types.d.ts#:~:text=LegacyScopedClusterClient) | 7.16 | -| | [types.ts - ](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/server/types.ts#:~:text=ILegacyScopedClusterClient), [types.ts - ](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/server/types.ts#:~:text=ILegacyScopedClusterClient), [types.ts - ](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/server/types.ts#:~:text=ILegacyScopedClusterClient), [types.d.ts - ](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/target/types/server/types.d.ts#:~:text=ILegacyScopedClusterClient), [types.d.ts - ](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/target/types/server/types.d.ts#:~:text=ILegacyScopedClusterClient), [types.d.ts - ](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/target/types/server/types.d.ts#:~:text=ILegacyScopedClusterClient) | 7.16 | - - - ## indexPatternFieldEditor | Deprecated API | Reference location(s) | Remove By | @@ -829,9 +787,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [types.ts - ](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/embeddable/types.ts#:~:text=IIndexPattern), [types.ts - ](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/embeddable/types.ts#:~:text=IIndexPattern) | - | | | [es_doc_field.ts ](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/es_doc_field.ts#:~:text=IFieldType), [es_doc_field.ts ](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/es_doc_field.ts#:~:text=IFieldType), [es_source.ts @@ -887,9 +842,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex ](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/index_pattern_util.ts#:~:text=IFieldType), [index_pattern_util.ts ](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/index_pattern_util.ts#:~:text=IFieldType), [index_pattern_util.ts ](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/index_pattern_util.ts#:~:text=IFieldType)+ 84 more | - | -| | [types.ts - ](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/embeddable/types.ts#:~:text=IIndexPattern), [types.ts - ](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/embeddable/types.ts#:~:text=IIndexPattern) | - | | | [es_doc_field.ts ](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/es_doc_field.ts#:~:text=IFieldType), [es_doc_field.ts ](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/es_doc_field.ts#:~:text=IFieldType), [es_source.ts @@ -1078,21 +1030,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex -## savedObjects - -| Deprecated API | Reference location(s) | Remove By | -| ---------------|-----------|-----------| -| | [types.ts - ](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/types.ts#:~:text=IIndexPattern), [types.ts - ](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/types.ts#:~:text=IIndexPattern), [types.ts - ](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/types.ts#:~:text=IIndexPattern) | - | -| | [types.ts - ](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/types.ts#:~:text=IIndexPattern), [types.ts - ](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/types.ts#:~:text=IIndexPattern), [types.ts - ](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/types.ts#:~:text=IIndexPattern) | - | - - - ## savedObjectsManagement | Deprecated API | Reference location(s) | Remove By | diff --git a/api_docs/dev_tools.json b/api_docs/dev_tools.json index 3b8ee18eb9897..bab8b4a9a999e 100644 --- a/api_docs/dev_tools.json +++ b/api_docs/dev_tools.json @@ -178,11 +178,10 @@ ], "path": "src/plugins/dev_tools/public/plugin.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "devTools", - "id": "def-public.devTool", + "id": "def-public.DevToolsSetup.register.$1", "type": "CompoundType", "tags": [], "label": "devTool", @@ -190,14 +189,14 @@ "The dev tools descriptor" ], "signature": [ - "Pick<", - "DevToolApp", - ", \"title\" | \"id\" | \"order\" | \"mount\" | \"tooltipContent\" | \"enableRouting\"> & { disabled?: boolean | undefined; }" + "CreateDevToolArgs" ], "path": "src/plugins/dev_tools/public/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "lifecycle": "setup", diff --git a/api_docs/discover.json b/api_docs/discover.json index 4af8487f4f2dd..ec94f42df2a0e 100644 --- a/api_docs/discover.json +++ b/api_docs/discover.json @@ -181,7 +181,8 @@ "\nOptionally apply filters." ], "signature": [ - "any[] | undefined" + "Filter", + "[] | undefined" ], "path": "src/plugins/discover/public/locator.ts", "deprecated": false @@ -189,14 +190,15 @@ { "parentPluginId": "discover", "id": "def-public.DiscoverAppLocatorParams.query", - "type": "Any", + "type": "Object", "tags": [], "label": "query", "description": [ "\nOptionally set a query." ], "signature": [ - "any" + "Query", + " | undefined" ], "path": "src/plugins/discover/public/locator.ts", "deprecated": false @@ -396,7 +398,8 @@ "\nOptionally apply filters." ], "signature": [ - "any[] | undefined" + "Filter", + "[] | undefined" ], "path": "src/plugins/discover/public/url_generator.ts", "deprecated": false @@ -404,14 +407,15 @@ { "parentPluginId": "discover", "id": "def-public.DiscoverUrlGeneratorState.query", - "type": "Any", + "type": "Object", "tags": [], "label": "query", "description": [ "\nOptionally set a query. NOTE: if given and used in conjunction with `dashboardId`, and the\nsaved dashboard has a query saved with it, this will _replace_ that query." ], "signature": [ - "any" + "Query", + " | undefined" ], "path": "src/plugins/discover/public/url_generator.ts", "deprecated": false @@ -686,8 +690,8 @@ ], "path": "src/plugins/discover/public/saved_searches/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "discover", @@ -709,11 +713,10 @@ ], "path": "src/plugins/discover/public/saved_searches/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "discover", - "id": "def-public.saveOptions", + "id": "def-public.SavedSearch.save.$1", "type": "Object", "tags": [], "label": "saveOptions", @@ -728,9 +731,11 @@ } ], "path": "src/plugins/discover/public/saved_searches/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "discover", @@ -804,19 +809,23 @@ ], "path": "src/plugins/discover/public/saved_searches/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "discover", - "id": "def-public.id", + "id": "def-public.SavedSearchLoader.get.$1", "type": "string", "tags": [], "label": "id", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/discover/public/saved_searches/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "discover", @@ -830,19 +839,23 @@ ], "path": "src/plugins/discover/public/saved_searches/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "discover", - "id": "def-public.id", + "id": "def-public.SavedSearchLoader.urlFor.$1", "type": "string", "tags": [], "label": "id", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/discover/public/saved_searches/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -890,12 +903,13 @@ { "parentPluginId": "discover", "id": "def-public.SearchInput.query", - "type": "Any", + "type": "Object", "tags": [], "label": "query", "description": [], "signature": [ - "any" + "Query", + " | undefined" ], "path": "src/plugins/discover/public/application/embeddable/types.ts", "deprecated": false @@ -908,7 +922,8 @@ "label": "filters", "description": [], "signature": [ - "any[] | undefined" + "Filter", + "[] | undefined" ], "path": "src/plugins/discover/public/application/embeddable/types.ts", "deprecated": false diff --git a/api_docs/discover.mdx b/api_docs/discover.mdx index 9e3ae166da774..610ec5d90f267 100644 --- a/api_docs/discover.mdx +++ b/api_docs/discover.mdx @@ -18,7 +18,7 @@ Contact [Kibana App](https://github.com/orgs/elastic/teams/kibana-app) for quest | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 81 | 3 | 55 | 6 | +| 81 | 0 | 55 | 6 | ## Client diff --git a/api_docs/embeddable.json b/api_docs/embeddable.json index e328448161d7d..44c5ecbe0c063 100644 --- a/api_docs/embeddable.json +++ b/api_docs/embeddable.json @@ -5797,8 +5797,8 @@ ], "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "embeddable", @@ -7783,11 +7783,10 @@ ], "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "embeddable", - "id": "def-public.input", + "id": "def-public.ReferenceOrValueEmbeddable.inputIsRefType.$1", "type": "CompoundType", "tags": [], "label": "input", @@ -7796,9 +7795,11 @@ "ValTypeInput | RefTypeInput" ], "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "embeddable", @@ -7814,8 +7815,8 @@ ], "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "embeddable", @@ -7831,8 +7832,8 @@ ], "path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -8139,6 +8140,35 @@ ], "path": "src/plugins/embeddable/public/plugin.tsx", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.props", + "type": "CompoundType", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P & { children?: React.ReactNode; }" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "embeddable", + "id": "def-public.context", + "type": "Any", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "any" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -8419,52 +8449,46 @@ ], "path": "src/plugins/embeddable/public/plugin.tsx", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "embeddable", - "id": "def-public.id", + "id": "def-public.EmbeddableSetup.registerEmbeddableFactory.$1", "type": "string", "tags": [], "label": "id", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/embeddable/public/plugin.tsx", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "embeddable", - "id": "def-public.factory", + "id": "def-public.EmbeddableSetup.registerEmbeddableFactory.$2", "type": "CompoundType", "tags": [], "label": "factory", "description": [], "signature": [ - "Pick<", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableFactory", - "text": "EmbeddableFactory" - }, - ", \"type\" | \"create\" | \"isEditable\" | \"getDisplayName\"> & Partial, \"createFromSavedObject\" | \"isContainerType\" | \"getExplicitInput\" | \"savedObjectMetaData\" | \"canCreateNew\" | \"getDefaultInput\" | \"telemetry\" | \"extract\" | \"inject\" | \"migrations\" | \"grouping\" | \"getIconType\" | \"getDescription\">>" + ">" ], "path": "src/plugins/embeddable/public/plugin.tsx", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "embeddable", @@ -8494,11 +8518,10 @@ ], "path": "src/plugins/embeddable/public/plugin.tsx", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "embeddable", - "id": "def-public.enhancement", + "id": "def-public.EmbeddableSetup.registerEnhancement.$1", "type": "Object", "tags": [], "label": "enhancement", @@ -8522,9 +8545,11 @@ ">" ], "path": "src/plugins/embeddable/public/plugin.tsx", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "embeddable", @@ -8540,90 +8565,23 @@ ], "path": "src/plugins/embeddable/public/plugin.tsx", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "embeddable", - "id": "def-public.customProvider", + "id": "def-public.EmbeddableSetup.setCustomEmbeddableFactoryProvider.$1", "type": "Function", "tags": [], "label": "customProvider", "description": [], "signature": [ - " = ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.IEmbeddable", - "text": "IEmbeddable" - }, - ", T extends ", - "SavedObjectAttributes", - " = ", - "SavedObjectAttributes", - ">(def: ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableFactoryDefinition", - "text": "EmbeddableFactoryDefinition" - }, - ") => ", - { - "pluginId": "embeddable", - "scope": "public", - "docId": "kibEmbeddablePluginApi", - "section": "def-public.EmbeddableFactory", - "text": "EmbeddableFactory" - }, - "" + "EmbeddableFactoryProvider" ], "path": "src/plugins/embeddable/public/plugin.tsx", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "lifecycle": "setup", @@ -8735,19 +8693,23 @@ ], "path": "src/plugins/embeddable/public/plugin.tsx", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "embeddable", - "id": "def-public.embeddableFactoryId", + "id": "def-public.EmbeddableStart.getEmbeddableFactory.$1", "type": "string", "tags": [], "label": "embeddableFactoryId", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/embeddable/public/plugin.tsx", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "embeddable", @@ -8811,8 +8773,8 @@ ], "path": "src/plugins/embeddable/public/plugin.tsx", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "embeddable", @@ -8907,11 +8869,10 @@ ], "path": "src/plugins/embeddable/public/plugin.tsx", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "embeddable", - "id": "def-public.storage", + "id": "def-public.EmbeddableStart.getStateTransfer.$1", "type": "Object", "tags": [], "label": "storage", @@ -8927,9 +8888,11 @@ " | undefined" ], "path": "src/plugins/embeddable/public/plugin.tsx", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "embeddable", @@ -8985,21 +8948,24 @@ ], "path": "src/plugins/embeddable/public/plugin.tsx", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "embeddable", - "id": "def-public.type", + "id": "def-public.EmbeddableStart.getAttributeService.$1", "type": "string", "tags": [], "label": "type", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/embeddable/public/plugin.tsx", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "embeddable", - "id": "def-public.options", + "id": "def-public.EmbeddableStart.getAttributeService.$2", "type": "Object", "tags": [], "label": "options", @@ -9009,9 +8975,11 @@ "" ], "path": "src/plugins/embeddable/public/plugin.tsx", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "lifecycle": "start", @@ -9172,11 +9140,10 @@ ], "path": "src/plugins/embeddable/server/plugin.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "embeddable", - "id": "def-server.factory", + "id": "def-server.EmbeddableSetup.registerEmbeddableFactory.$1", "type": "Object", "tags": [], "label": "factory", @@ -9200,9 +9167,11 @@ ">" ], "path": "src/plugins/embeddable/server/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "embeddable", @@ -9232,11 +9201,10 @@ ], "path": "src/plugins/embeddable/server/plugin.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "embeddable", - "id": "def-server.enhancement", + "id": "def-server.EmbeddableSetup.registerEnhancement.$1", "type": "Object", "tags": [], "label": "enhancement", @@ -9260,9 +9228,11 @@ ">" ], "path": "src/plugins/embeddable/server/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "embeddable", @@ -9283,8 +9253,8 @@ ], "path": "src/plugins/embeddable/server/plugin.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "lifecycle": "setup", @@ -9822,19 +9792,23 @@ ], "path": "src/plugins/embeddable/common/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "embeddable", - "id": "def-common.embeddableFactoryId", + "id": "def-common.CommonEmbeddableStartContract.getEmbeddableFactory.$1", "type": "string", "tags": [], "label": "embeddableFactoryId", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/embeddable/common/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "embeddable", @@ -9848,19 +9822,23 @@ ], "path": "src/plugins/embeddable/common/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "embeddable", - "id": "def-common.enhancementId", + "id": "def-common.CommonEmbeddableStartContract.getEnhancement.$1", "type": "string", "tags": [], "label": "enhancementId", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/embeddable/common/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -10073,6 +10051,40 @@ ], "path": "src/plugins/embeddable/common/lib/migrate.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-common.state", + "type": "Object", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "{ [key: string]: ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.Serializable", + "text": "Serializable" + }, + "; }" + ], + "path": "src/plugins/embeddable/common/lib/migrate.ts", + "deprecated": false + }, + { + "parentPluginId": "embeddable", + "id": "def-common.version", + "type": "string", + "tags": [], + "label": "version", + "description": [], + "path": "src/plugins/embeddable/common/lib/migrate.ts", + "deprecated": false + } + ], "initialIsOpen": false } ], diff --git a/api_docs/embeddable.mdx b/api_docs/embeddable.mdx index 0568d6b8ddeb6..e004c73b7e04c 100644 --- a/api_docs/embeddable.mdx +++ b/api_docs/embeddable.mdx @@ -18,7 +18,7 @@ import embeddableObj from './embeddable.json'; | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 456 | 4 | 384 | 3 | +| 460 | 5 | 388 | 3 | ## Client diff --git a/api_docs/encrypted_saved_objects.json b/api_docs/encrypted_saved_objects.json index 7f382c9b32787..9bd91501c23dd 100644 --- a/api_docs/encrypted_saved_objects.json +++ b/api_docs/encrypted_saved_objects.json @@ -155,31 +155,38 @@ ], "path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "encryptedSavedObjects", - "id": "def-server.type", + "id": "def-server.EncryptedSavedObjectsClient.getDecryptedAsInternalUser.$1", "type": "string", "tags": [], "label": "type", "description": [], + "signature": [ + "string" + ], "path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "encryptedSavedObjects", - "id": "def-server.id", + "id": "def-server.EncryptedSavedObjectsClient.getDecryptedAsInternalUser.$2", "type": "string", "tags": [], "label": "id", "description": [], + "signature": [ + "string" + ], "path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "encryptedSavedObjects", - "id": "def-server.options", + "id": "def-server.EncryptedSavedObjectsClient.getDecryptedAsInternalUser.$3", "type": "Object", "tags": [], "label": "options", @@ -195,9 +202,11 @@ " | undefined" ], "path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -294,6 +303,37 @@ ], "path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "encryptedSavedObjects", + "id": "def-server.encryptedDoc", + "type": "CompoundType", + "tags": [], + "label": "encryptedDoc", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectUnsanitizedDoc", + "text": "SavedObjectUnsanitizedDoc" + }, + " | ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectUnsanitizedDoc", + "text": "SavedObjectUnsanitizedDoc" + }, + "" + ], + "path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts", + "deprecated": false + } + ], "initialIsOpen": false } ], @@ -340,11 +380,10 @@ ], "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "encryptedSavedObjects", - "id": "def-server.typeRegistration", + "id": "def-server.EncryptedSavedObjectsPluginSetup.registerType.$1", "type": "Object", "tags": [], "label": "typeRegistration", @@ -359,9 +398,11 @@ } ], "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "encryptedSavedObjects", @@ -421,11 +462,10 @@ ], "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "encryptedSavedObjects", - "id": "def-server.error", + "id": "def-server.EncryptedSavedObjectsPluginStart.isEncryptionError.$1", "type": "Object", "tags": [], "label": "error", @@ -434,9 +474,11 @@ "Error" ], "path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "encryptedSavedObjects", diff --git a/api_docs/encrypted_saved_objects.mdx b/api_docs/encrypted_saved_objects.mdx index d274500438ba5..c872427012c2d 100644 --- a/api_docs/encrypted_saved_objects.mdx +++ b/api_docs/encrypted_saved_objects.mdx @@ -18,7 +18,7 @@ Contact [Platform Security](https://github.com/orgs/elastic/teams/kibana-securit | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 28 | 0 | 26 | 4 | +| 29 | 0 | 27 | 4 | ## Server diff --git a/api_docs/es_ui_shared.json b/api_docs/es_ui_shared.json index 83e4a2aff394b..053844e545872 100644 --- a/api_docs/es_ui_shared.json +++ b/api_docs/es_ui_shared.json @@ -1065,7 +1065,24 @@ "((data: any) => any) | undefined" ], "path": "src/plugins/es_ui_shared/public/request/use_request.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "esUiShared", + "id": "def-public.UseRequestConfig.deserializer.$1", + "type": "Any", + "tags": [], + "label": "data", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/es_ui_shared/public/request/use_request.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -1148,8 +1165,8 @@ ], "path": "src/plugins/es_ui_shared/public/request/use_request.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -1191,6 +1208,29 @@ ], "path": "src/plugins/es_ui_shared/public/components/json_editor/use_json.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "esUiShared", + "id": "def-public.arg", + "type": "Object", + "tags": [], + "label": "arg", + "description": [], + "signature": [ + { + "pluginId": "esUiShared", + "scope": "public", + "docId": "kibEsUiSharedPluginApi", + "section": "def-public.JsonEditorState", + "text": "JsonEditorState" + }, + "" + ], + "path": "src/plugins/es_ui_shared/public/components/json_editor/use_json.ts", + "deprecated": false + } + ], "initialIsOpen": false } ], @@ -1364,37 +1404,6 @@ "returnComment": [], "initialIsOpen": false }, - { - "parentPluginId": "esUiShared", - "id": "def-server.isEsError", - "type": "Function", - "tags": [], - "label": "isEsError", - "description": [], - "signature": [ - "(err: RequestError) => boolean" - ], - "path": "src/plugins/es_ui_shared/__packages_do_not_import__/errors/is_es_error.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "esUiShared", - "id": "def-server.isEsError.$1", - "type": "Object", - "tags": [], - "label": "err", - "description": [], - "signature": [ - "RequestError" - ], - "path": "src/plugins/es_ui_shared/__packages_do_not_import__/errors/is_es_error.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, { "parentPluginId": "esUiShared", "id": "def-server.parseEsError", diff --git a/api_docs/es_ui_shared.mdx b/api_docs/es_ui_shared.mdx index 0db5869f46abf..84687d60931da 100644 --- a/api_docs/es_ui_shared.mdx +++ b/api_docs/es_ui_shared.mdx @@ -18,7 +18,7 @@ import esUiSharedObj from './es_ui_shared.json'; | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 92 | 4 | 90 | 1 | +| 92 | 5 | 90 | 1 | ## Client diff --git a/api_docs/expression_repeat_image.json b/api_docs/expression_repeat_image.json index f401d231d11c2..4917dc1f62205 100644 --- a/api_docs/expression_repeat_image.json +++ b/api_docs/expression_repeat_image.json @@ -355,6 +355,8 @@ ], "path": "src/plugins/expression_repeat_image/common/types/expression_functions.ts", "deprecated": false, + "returnComment": [], + "children": [], "initialIsOpen": false }, { diff --git a/api_docs/expression_shape.json b/api_docs/expression_shape.json index 16e2e9eee30af..607c10fb38240 100644 --- a/api_docs/expression_shape.json +++ b/api_docs/expression_shape.json @@ -596,8 +596,8 @@ ], "path": "src/plugins/expression_shape/public/components/reusable/types.tsx", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -896,6 +896,8 @@ ], "path": "src/plugins/expression_shape/common/types/expression_functions.ts", "deprecated": false, + "returnComment": [], + "children": [], "initialIsOpen": false }, { @@ -1408,6 +1410,8 @@ ], "path": "src/plugins/expression_shape/common/types/expression_functions.ts", "deprecated": false, + "returnComment": [], + "children": [], "initialIsOpen": false }, { diff --git a/api_docs/expressions.json b/api_docs/expressions.json index 5c9e86bc9119f..6185466a02cc8 100644 --- a/api_docs/expressions.json +++ b/api_docs/expressions.json @@ -6404,8 +6404,8 @@ ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -6489,8 +6489,8 @@ ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -6513,7 +6513,9 @@ ") | undefined" ], "path": "src/plugins/expressions/common/execution/types.ts", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -6528,7 +6530,9 @@ "(() => boolean) | undefined" ], "path": "src/plugins/expressions/common/execution/types.ts", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -6552,8 +6556,8 @@ ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -6921,13 +6925,10 @@ ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, - "returnComment": [ - "`ExpressionAstFunctionBuilder[]`" - ], "children": [ { "parentPluginId": "expressions", - "id": "def-public.fnName", + "id": "def-public.ExpressionAstExpressionBuilder.findFunction.$1", "type": "Uncategorized", "tags": [], "label": "fnName", @@ -6945,8 +6946,12 @@ "[\"name\"]" ], "path": "src/plugins/expressions/common/ast/build_expression.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } + ], + "returnComment": [ + "`ExpressionAstFunctionBuilder[]`" ] }, { @@ -6972,10 +6977,10 @@ ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, + "children": [], "returnComment": [ "`ExpressionAstExpression`" - ], - "children": [] + ] }, { "parentPluginId": "expressions", @@ -6993,10 +6998,10 @@ ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, + "children": [], "returnComment": [ "`string`" - ], - "children": [] + ] } ], "initialIsOpen": false @@ -7097,13 +7102,10 @@ ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, - "returnComment": [ - "`this`" - ], "children": [ { "parentPluginId": "expressions", - "id": "def-public.name", + "id": "def-public.ExpressionAstFunctionBuilder.addArgument.$1", "type": "Uncategorized", "tags": [], "label": "name", @@ -7114,11 +7116,12 @@ "A" ], "path": "src/plugins/expressions/common/ast/build_function.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "expressions", - "id": "def-public.value", + "id": "def-public.ExpressionAstFunctionBuilder.addArgument.$2", "type": "CompoundType", "tags": [], "label": "value", @@ -7136,8 +7139,12 @@ " | FunctionArgs[A]" ], "path": "src/plugins/expressions/common/ast/build_function.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } + ], + "returnComment": [ + "`this`" ] }, { @@ -7164,13 +7171,10 @@ ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, - "returnComment": [ - "`ExpressionAstFunctionBuilderArgument[] | undefined`" - ], "children": [ { "parentPluginId": "expressions", - "id": "def-public.name", + "id": "def-public.ExpressionAstFunctionBuilder.getArgument.$1", "type": "Uncategorized", "tags": [], "label": "name", @@ -7181,8 +7185,12 @@ "A" ], "path": "src/plugins/expressions/common/ast/build_function.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } + ], + "returnComment": [ + "`ExpressionAstFunctionBuilderArgument[] | undefined`" ] }, { @@ -7209,13 +7217,10 @@ ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, - "returnComment": [ - "`this`" - ], "children": [ { "parentPluginId": "expressions", - "id": "def-public.name", + "id": "def-public.ExpressionAstFunctionBuilder.replaceArgument.$1", "type": "Uncategorized", "tags": [], "label": "name", @@ -7226,11 +7231,12 @@ "A" ], "path": "src/plugins/expressions/common/ast/build_function.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "expressions", - "id": "def-public.value", + "id": "def-public.ExpressionAstFunctionBuilder.replaceArgument.$2", "type": "Array", "tags": [], "label": "value", @@ -7249,8 +7255,12 @@ " | FunctionArgs[A])[]" ], "path": "src/plugins/expressions/common/ast/build_function.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } + ], + "returnComment": [ + "`this`" ] }, { @@ -7269,13 +7279,10 @@ ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, - "returnComment": [ - "`this`" - ], "children": [ { "parentPluginId": "expressions", - "id": "def-public.name", + "id": "def-public.ExpressionAstFunctionBuilder.removeArgument.$1", "type": "Uncategorized", "tags": [], "label": "name", @@ -7286,8 +7293,12 @@ "A" ], "path": "src/plugins/expressions/common/ast/build_function.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } + ], + "returnComment": [ + "`this`" ] }, { @@ -7313,10 +7324,10 @@ ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, + "children": [], "returnComment": [ "`ExpressionAstFunction`" - ], - "children": [] + ] }, { "parentPluginId": "expressions", @@ -7334,10 +7345,10 @@ ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, + "children": [], "returnComment": [ "`string`" - ], - "children": [] + ] } ], "initialIsOpen": false @@ -8236,7 +8247,9 @@ "(() => Error | undefined) | undefined" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -8272,11 +8285,10 @@ ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "expressions", - "id": "def-public.domNode", + "id": "def-public.ExpressionRenderDefinition.render.$1", "type": "Object", "tags": [], "label": "domNode", @@ -8285,11 +8297,12 @@ "HTMLElement" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "expressions", - "id": "def-public.config", + "id": "def-public.ExpressionRenderDefinition.render.$2", "type": "Uncategorized", "tags": [], "label": "config", @@ -8298,11 +8311,12 @@ "Config" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "expressions", - "id": "def-public.handlers", + "id": "def-public.ExpressionRenderDefinition.render.$3", "type": "Object", "tags": [], "label": "handlers", @@ -8317,9 +8331,11 @@ } ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -8443,19 +8459,23 @@ ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "expressions", - "id": "def-public.name", + "id": "def-public.ExpressionsServiceStart.getFunction.$1", "type": "string", "tags": [], "label": "name", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/expressions/common/service/expressions_services.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -8479,19 +8499,23 @@ ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "expressions", - "id": "def-public.name", + "id": "def-public.ExpressionsServiceStart.getRenderer.$1", "type": "string", "tags": [], "label": "name", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/expressions/common/service/expressions_services.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -8515,19 +8539,23 @@ ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "expressions", - "id": "def-public.name", + "id": "def-public.ExpressionsServiceStart.getType.$1", "type": "string", "tags": [], "label": "name", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/expressions/common/service/expressions_services.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -8593,11 +8621,10 @@ ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "expressions", - "id": "def-public.ast", + "id": "def-public.ExpressionsServiceStart.run.$1", "type": "CompoundType", "tags": [], "label": "ast", @@ -8613,11 +8640,12 @@ } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "expressions", - "id": "def-public.input", + "id": "def-public.ExpressionsServiceStart.run.$2", "type": "Uncategorized", "tags": [], "label": "input", @@ -8626,11 +8654,12 @@ "Input" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "expressions", - "id": "def-public.params", + "id": "def-public.ExpressionsServiceStart.run.$3", "type": "Object", "tags": [], "label": "params", @@ -8646,9 +8675,11 @@ " | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -8688,11 +8719,10 @@ ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "expressions", - "id": "def-public.ast", + "id": "def-public.ExpressionsServiceStart.execute.$1", "type": "CompoundType", "tags": [], "label": "ast", @@ -8708,11 +8738,12 @@ } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "expressions", - "id": "def-public.input", + "id": "def-public.ExpressionsServiceStart.execute.$2", "type": "Uncategorized", "tags": [], "label": "input", @@ -8721,11 +8752,12 @@ "Input" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "expressions", - "id": "def-public.params", + "id": "def-public.ExpressionsServiceStart.execute.$3", "type": "Object", "tags": [], "label": "params", @@ -8741,9 +8773,11 @@ " | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -8766,8 +8800,8 @@ ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -8818,7 +8852,24 @@ "((type: any) => void | Error) | undefined" ], "path": "src/plugins/expressions/common/expression_types/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionTypeDefinition.validate.$1", + "type": "Any", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/expressions/common/expression_types/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -8831,7 +8882,24 @@ "((type: Value) => SerializedType) | undefined" ], "path": "src/plugins/expressions/common/expression_types/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionTypeDefinition.serialize.$1", + "type": "Uncategorized", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "Value" + ], + "path": "src/plugins/expressions/common/expression_types/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -8844,7 +8912,24 @@ "((type: SerializedType) => Value) | undefined" ], "path": "src/plugins/expressions/common/expression_types/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionTypeDefinition.deserialize.$1", + "type": "Uncategorized", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "SerializedType" + ], + "path": "src/plugins/expressions/common/expression_types/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -9288,8 +9373,8 @@ ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -9303,11 +9388,10 @@ ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "expressions", - "id": "def-public.fn", + "id": "def-public.IInterpreterRenderHandlers.onDestroy.$1", "type": "Function", "tags": [], "label": "fn", @@ -9316,9 +9400,11 @@ "() => void" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -9332,8 +9418,8 @@ ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -9347,11 +9433,10 @@ ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "expressions", - "id": "def-public.params", + "id": "def-public.IInterpreterRenderHandlers.update.$1", "type": "Any", "tags": [], "label": "params", @@ -9360,9 +9445,11 @@ "any" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -9376,11 +9463,10 @@ ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "expressions", - "id": "def-public.event", + "id": "def-public.IInterpreterRenderHandlers.event.$1", "type": "Any", "tags": [], "label": "event", @@ -9389,9 +9475,11 @@ "any" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -9403,8 +9491,25 @@ "signature": [ "((event: any) => Promise) | undefined" ], - "path": "src/plugins/expressions/common/expression_renderers/types.ts", - "deprecated": false + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.IInterpreterRenderHandlers.hasCompatibleActions.$1", + "type": "Any", + "tags": [], + "label": "event", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -9425,8 +9530,8 @@ ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -9440,8 +9545,8 @@ ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -9746,7 +9851,45 @@ " | null | undefined) => React.ReactElement React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)> | React.ReactElement React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)>[]) | undefined" ], "path": "src/plugins/expressions/public/react_expression_renderer.tsx", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.ReactExpressionRendererProps.renderError.$1", + "type": "CompoundType", + "tags": [], + "label": "message", + "description": [], + "signature": [ + "string | null | undefined" + ], + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "expressions", + "id": "def-public.ReactExpressionRendererProps.renderError.$2", + "type": "CompoundType", + "tags": [], + "label": "error", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ExpressionRenderError", + "text": "ExpressionRenderError" + }, + " | null | undefined" + ], + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -9780,7 +9923,30 @@ ") => void) | undefined" ], "path": "src/plugins/expressions/public/react_expression_renderer.tsx", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.ReactExpressionRendererProps.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.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -9793,7 +9959,52 @@ "((data: TData, adapters?: TInspectorAdapters | undefined, partial?: boolean | undefined) => void) | undefined" ], "path": "src/plugins/expressions/public/react_expression_renderer.tsx", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.ReactExpressionRendererProps.onData$.$1", + "type": "Uncategorized", + "tags": [], + "label": "data", + "description": [], + "signature": [ + "TData" + ], + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "expressions", + "id": "def-public.ReactExpressionRendererProps.onData$.$2", + "type": "Uncategorized", + "tags": [], + "label": "adapters", + "description": [], + "signature": [ + "TInspectorAdapters | undefined" + ], + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "expressions", + "id": "def-public.ReactExpressionRendererProps.onData$.$3", + "type": "CompoundType", + "tags": [], + "label": "partial", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/expressions/public/react_expression_renderer.tsx", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -10304,6 +10515,35 @@ ], "path": "src/plugins/expressions/public/react_expression_renderer.tsx", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.props", + "type": "CompoundType", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P & { children?: React.ReactNode; }" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-public.context", + "type": "Any", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "any" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -10346,6 +10586,35 @@ ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-public.input", + "type": "Uncategorized", + "tags": [], + "label": "input", + "description": [], + "signature": [ + "I" + ], + "path": "src/plugins/expressions/common/expression_types/types.ts", + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-public.availableTypes", + "type": "Object", + "tags": [], + "label": "availableTypes", + "description": [], + "signature": [ + "{ [x: string]: any; }" + ], + "path": "src/plugins/expressions/common/expression_types/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -15898,8 +16167,8 @@ ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -15983,8 +16252,8 @@ ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -16007,7 +16276,9 @@ ") | undefined" ], "path": "src/plugins/expressions/common/execution/types.ts", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -16022,7 +16293,9 @@ "(() => boolean) | undefined" ], "path": "src/plugins/expressions/common/execution/types.ts", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -16046,8 +16319,8 @@ ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -16415,13 +16688,10 @@ ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, - "returnComment": [ - "`ExpressionAstFunctionBuilder[]`" - ], "children": [ { "parentPluginId": "expressions", - "id": "def-server.fnName", + "id": "def-server.ExpressionAstExpressionBuilder.findFunction.$1", "type": "Uncategorized", "tags": [], "label": "fnName", @@ -16439,8 +16709,12 @@ "[\"name\"]" ], "path": "src/plugins/expressions/common/ast/build_expression.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } + ], + "returnComment": [ + "`ExpressionAstFunctionBuilder[]`" ] }, { @@ -16466,10 +16740,10 @@ ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, + "children": [], "returnComment": [ "`ExpressionAstExpression`" - ], - "children": [] + ] }, { "parentPluginId": "expressions", @@ -16487,10 +16761,10 @@ ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, + "children": [], "returnComment": [ "`string`" - ], - "children": [] + ] } ], "initialIsOpen": false @@ -16591,13 +16865,10 @@ ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, - "returnComment": [ - "`this`" - ], "children": [ { "parentPluginId": "expressions", - "id": "def-server.name", + "id": "def-server.ExpressionAstFunctionBuilder.addArgument.$1", "type": "Uncategorized", "tags": [], "label": "name", @@ -16608,11 +16879,12 @@ "A" ], "path": "src/plugins/expressions/common/ast/build_function.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "expressions", - "id": "def-server.value", + "id": "def-server.ExpressionAstFunctionBuilder.addArgument.$2", "type": "CompoundType", "tags": [], "label": "value", @@ -16630,8 +16902,12 @@ " | FunctionArgs[A]" ], "path": "src/plugins/expressions/common/ast/build_function.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } + ], + "returnComment": [ + "`this`" ] }, { @@ -16658,13 +16934,10 @@ ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, - "returnComment": [ - "`ExpressionAstFunctionBuilderArgument[] | undefined`" - ], "children": [ { "parentPluginId": "expressions", - "id": "def-server.name", + "id": "def-server.ExpressionAstFunctionBuilder.getArgument.$1", "type": "Uncategorized", "tags": [], "label": "name", @@ -16675,8 +16948,12 @@ "A" ], "path": "src/plugins/expressions/common/ast/build_function.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } + ], + "returnComment": [ + "`ExpressionAstFunctionBuilderArgument[] | undefined`" ] }, { @@ -16703,13 +16980,10 @@ ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, - "returnComment": [ - "`this`" - ], "children": [ { "parentPluginId": "expressions", - "id": "def-server.name", + "id": "def-server.ExpressionAstFunctionBuilder.replaceArgument.$1", "type": "Uncategorized", "tags": [], "label": "name", @@ -16720,11 +16994,12 @@ "A" ], "path": "src/plugins/expressions/common/ast/build_function.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "expressions", - "id": "def-server.value", + "id": "def-server.ExpressionAstFunctionBuilder.replaceArgument.$2", "type": "Array", "tags": [], "label": "value", @@ -16743,8 +17018,12 @@ " | FunctionArgs[A])[]" ], "path": "src/plugins/expressions/common/ast/build_function.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } + ], + "returnComment": [ + "`this`" ] }, { @@ -16763,13 +17042,10 @@ ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, - "returnComment": [ - "`this`" - ], "children": [ { "parentPluginId": "expressions", - "id": "def-server.name", + "id": "def-server.ExpressionAstFunctionBuilder.removeArgument.$1", "type": "Uncategorized", "tags": [], "label": "name", @@ -16780,8 +17056,12 @@ "A" ], "path": "src/plugins/expressions/common/ast/build_function.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } + ], + "returnComment": [ + "`this`" ] }, { @@ -16807,10 +17087,10 @@ ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, + "children": [], "returnComment": [ "`ExpressionAstFunction`" - ], - "children": [] + ] }, { "parentPluginId": "expressions", @@ -16828,10 +17108,10 @@ ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, + "children": [], "returnComment": [ "`string`" - ], - "children": [] + ] } ], "initialIsOpen": false @@ -17701,7 +17981,9 @@ "(() => Error | undefined) | undefined" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -17737,11 +18019,10 @@ ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "expressions", - "id": "def-server.domNode", + "id": "def-server.ExpressionRenderDefinition.render.$1", "type": "Object", "tags": [], "label": "domNode", @@ -17750,11 +18031,12 @@ "HTMLElement" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "expressions", - "id": "def-server.config", + "id": "def-server.ExpressionRenderDefinition.render.$2", "type": "Uncategorized", "tags": [], "label": "config", @@ -17763,11 +18045,12 @@ "Config" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "expressions", - "id": "def-server.handlers", + "id": "def-server.ExpressionRenderDefinition.render.$3", "type": "Object", "tags": [], "label": "handlers", @@ -17782,9 +18065,11 @@ } ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -17835,7 +18120,24 @@ "((type: any) => void | Error) | undefined" ], "path": "src/plugins/expressions/common/expression_types/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-server.ExpressionTypeDefinition.validate.$1", + "type": "Any", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/expressions/common/expression_types/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -17848,7 +18150,24 @@ "((type: Value) => SerializedType) | undefined" ], "path": "src/plugins/expressions/common/expression_types/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-server.ExpressionTypeDefinition.serialize.$1", + "type": "Uncategorized", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "Value" + ], + "path": "src/plugins/expressions/common/expression_types/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -17861,7 +18180,24 @@ "((type: SerializedType) => Value) | undefined" ], "path": "src/plugins/expressions/common/expression_types/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-server.ExpressionTypeDefinition.deserialize.$1", + "type": "Uncategorized", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "SerializedType" + ], + "path": "src/plugins/expressions/common/expression_types/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -18043,8 +18379,8 @@ ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -18058,11 +18394,10 @@ ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "expressions", - "id": "def-server.fn", + "id": "def-server.IInterpreterRenderHandlers.onDestroy.$1", "type": "Function", "tags": [], "label": "fn", @@ -18071,9 +18406,11 @@ "() => void" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -18087,8 +18424,8 @@ ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -18102,11 +18439,10 @@ ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "expressions", - "id": "def-server.params", + "id": "def-server.IInterpreterRenderHandlers.update.$1", "type": "Any", "tags": [], "label": "params", @@ -18115,9 +18451,11 @@ "any" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -18131,11 +18469,10 @@ ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "expressions", - "id": "def-server.event", + "id": "def-server.IInterpreterRenderHandlers.event.$1", "type": "Any", "tags": [], "label": "event", @@ -18144,9 +18481,11 @@ "any" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -18159,7 +18498,24 @@ "((event: any) => Promise) | undefined" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-server.IInterpreterRenderHandlers.hasCompatibleActions.$1", + "type": "Any", + "tags": [], + "label": "event", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -18180,8 +18536,8 @@ ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -18195,8 +18551,8 @@ ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -18906,6 +19262,35 @@ ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-server.input", + "type": "Uncategorized", + "tags": [], + "label": "input", + "description": [], + "signature": [ + "I" + ], + "path": "src/plugins/expressions/common/expression_types/types.ts", + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-server.availableTypes", + "type": "Object", + "tags": [], + "label": "availableTypes", + "description": [], + "signature": [ + "{ [x: string]: any; }" + ], + "path": "src/plugins/expressions/common/expression_types/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -26585,8 +26970,8 @@ ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -26670,8 +27055,8 @@ ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -26694,7 +27079,9 @@ ") | undefined" ], "path": "src/plugins/expressions/common/execution/types.ts", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -26709,7 +27096,9 @@ "(() => boolean) | undefined" ], "path": "src/plugins/expressions/common/execution/types.ts", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -26733,8 +27122,8 @@ ], "path": "src/plugins/expressions/common/execution/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -26872,11 +27261,10 @@ ], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "expressions", - "id": "def-common.state", + "id": "def-common.ExecutionPureTransitions.start.$1", "type": "Object", "tags": [], "label": "state", @@ -26892,9 +27280,11 @@ "" ], "path": "src/plugins/expressions/common/execution/container.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -26924,11 +27314,10 @@ ], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "expressions", - "id": "def-common.state", + "id": "def-common.ExecutionPureTransitions.setResult.$1", "type": "Object", "tags": [], "label": "state", @@ -26944,9 +27333,11 @@ "" ], "path": "src/plugins/expressions/common/execution/container.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -26976,11 +27367,10 @@ ], "path": "src/plugins/expressions/common/execution/container.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "expressions", - "id": "def-common.state", + "id": "def-common.ExecutionPureTransitions.setError.$1", "type": "Object", "tags": [], "label": "state", @@ -26996,9 +27386,11 @@ "" ], "path": "src/plugins/expressions/common/execution/container.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -27190,11 +27582,10 @@ ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "expressions", - "id": "def-common.state", + "id": "def-common.ExecutorPureSelectors.getFunction.$1", "type": "Object", "tags": [], "label": "state", @@ -27210,9 +27601,11 @@ ">" ], "path": "src/plugins/expressions/common/executor/container.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -27242,11 +27635,10 @@ ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "expressions", - "id": "def-common.state", + "id": "def-common.ExecutorPureSelectors.getType.$1", "type": "Object", "tags": [], "label": "state", @@ -27262,9 +27654,11 @@ ">" ], "path": "src/plugins/expressions/common/executor/container.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -27286,11 +27680,10 @@ ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "expressions", - "id": "def-common.state", + "id": "def-common.ExecutorPureSelectors.getContext.$1", "type": "Object", "tags": [], "label": "state", @@ -27306,9 +27699,11 @@ ">" ], "path": "src/plugins/expressions/common/executor/container.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -27359,11 +27754,10 @@ ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "expressions", - "id": "def-common.state", + "id": "def-common.ExecutorPureTransitions.addFunction.$1", "type": "Object", "tags": [], "label": "state", @@ -27379,9 +27773,11 @@ ">" ], "path": "src/plugins/expressions/common/executor/container.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -27419,11 +27815,10 @@ ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "expressions", - "id": "def-common.state", + "id": "def-common.ExecutorPureTransitions.addType.$1", "type": "Object", "tags": [], "label": "state", @@ -27439,9 +27834,11 @@ ">" ], "path": "src/plugins/expressions/common/executor/container.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -27471,11 +27868,10 @@ ], "path": "src/plugins/expressions/common/executor/container.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "expressions", - "id": "def-common.state", + "id": "def-common.ExecutorPureTransitions.extendContext.$1", "type": "Object", "tags": [], "label": "state", @@ -27491,9 +27887,11 @@ ">" ], "path": "src/plugins/expressions/common/executor/container.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -27679,13 +28077,10 @@ ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, - "returnComment": [ - "`ExpressionAstFunctionBuilder[]`" - ], "children": [ { "parentPluginId": "expressions", - "id": "def-common.fnName", + "id": "def-common.ExpressionAstExpressionBuilder.findFunction.$1", "type": "Uncategorized", "tags": [], "label": "fnName", @@ -27703,8 +28098,12 @@ "[\"name\"]" ], "path": "src/plugins/expressions/common/ast/build_expression.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } + ], + "returnComment": [ + "`ExpressionAstFunctionBuilder[]`" ] }, { @@ -27730,10 +28129,10 @@ ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, + "children": [], "returnComment": [ "`ExpressionAstExpression`" - ], - "children": [] + ] }, { "parentPluginId": "expressions", @@ -27751,10 +28150,10 @@ ], "path": "src/plugins/expressions/common/ast/build_expression.ts", "deprecated": false, + "children": [], "returnComment": [ "`string`" - ], - "children": [] + ] } ], "initialIsOpen": false @@ -27855,13 +28254,10 @@ ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, - "returnComment": [ - "`this`" - ], "children": [ { "parentPluginId": "expressions", - "id": "def-common.name", + "id": "def-common.ExpressionAstFunctionBuilder.addArgument.$1", "type": "Uncategorized", "tags": [], "label": "name", @@ -27872,11 +28268,12 @@ "A" ], "path": "src/plugins/expressions/common/ast/build_function.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "expressions", - "id": "def-common.value", + "id": "def-common.ExpressionAstFunctionBuilder.addArgument.$2", "type": "CompoundType", "tags": [], "label": "value", @@ -27894,8 +28291,12 @@ " | FunctionArgs[A]" ], "path": "src/plugins/expressions/common/ast/build_function.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } + ], + "returnComment": [ + "`this`" ] }, { @@ -27922,13 +28323,10 @@ ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, - "returnComment": [ - "`ExpressionAstFunctionBuilderArgument[] | undefined`" - ], "children": [ { "parentPluginId": "expressions", - "id": "def-common.name", + "id": "def-common.ExpressionAstFunctionBuilder.getArgument.$1", "type": "Uncategorized", "tags": [], "label": "name", @@ -27939,8 +28337,12 @@ "A" ], "path": "src/plugins/expressions/common/ast/build_function.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } + ], + "returnComment": [ + "`ExpressionAstFunctionBuilderArgument[] | undefined`" ] }, { @@ -27967,13 +28369,10 @@ ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, - "returnComment": [ - "`this`" - ], "children": [ { "parentPluginId": "expressions", - "id": "def-common.name", + "id": "def-common.ExpressionAstFunctionBuilder.replaceArgument.$1", "type": "Uncategorized", "tags": [], "label": "name", @@ -27984,11 +28383,12 @@ "A" ], "path": "src/plugins/expressions/common/ast/build_function.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "expressions", - "id": "def-common.value", + "id": "def-common.ExpressionAstFunctionBuilder.replaceArgument.$2", "type": "Array", "tags": [], "label": "value", @@ -28007,8 +28407,12 @@ " | FunctionArgs[A])[]" ], "path": "src/plugins/expressions/common/ast/build_function.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } + ], + "returnComment": [ + "`this`" ] }, { @@ -28027,13 +28431,10 @@ ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, - "returnComment": [ - "`this`" - ], "children": [ { "parentPluginId": "expressions", - "id": "def-common.name", + "id": "def-common.ExpressionAstFunctionBuilder.removeArgument.$1", "type": "Uncategorized", "tags": [], "label": "name", @@ -28044,8 +28445,12 @@ "A" ], "path": "src/plugins/expressions/common/ast/build_function.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } + ], + "returnComment": [ + "`this`" ] }, { @@ -28071,10 +28476,10 @@ ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, + "children": [], "returnComment": [ "`ExpressionAstFunction`" - ], - "children": [] + ] }, { "parentPluginId": "expressions", @@ -28092,10 +28497,10 @@ ], "path": "src/plugins/expressions/common/ast/build_function.ts", "deprecated": false, + "children": [], "returnComment": [ "`string`" - ], - "children": [] + ] } ], "initialIsOpen": false @@ -29142,7 +29547,9 @@ "(() => Error | undefined) | undefined" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -29178,11 +29585,10 @@ ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "expressions", - "id": "def-common.domNode", + "id": "def-common.ExpressionRenderDefinition.render.$1", "type": "Object", "tags": [], "label": "domNode", @@ -29191,11 +29597,12 @@ "HTMLElement" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "expressions", - "id": "def-common.config", + "id": "def-common.ExpressionRenderDefinition.render.$2", "type": "Uncategorized", "tags": [], "label": "config", @@ -29204,11 +29611,12 @@ "Config" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "expressions", - "id": "def-common.handlers", + "id": "def-common.ExpressionRenderDefinition.render.$3", "type": "Object", "tags": [], "label": "handlers", @@ -29223,9 +29631,11 @@ } ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -29317,19 +29727,23 @@ ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "expressions", - "id": "def-common.name", + "id": "def-common.ExpressionsServiceStart.getFunction.$1", "type": "string", "tags": [], "label": "name", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/expressions/common/service/expressions_services.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -29353,19 +29767,23 @@ ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "expressions", - "id": "def-common.name", + "id": "def-common.ExpressionsServiceStart.getRenderer.$1", "type": "string", "tags": [], "label": "name", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/expressions/common/service/expressions_services.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -29389,19 +29807,23 @@ ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "expressions", - "id": "def-common.name", + "id": "def-common.ExpressionsServiceStart.getType.$1", "type": "string", "tags": [], "label": "name", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/expressions/common/service/expressions_services.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -29467,11 +29889,10 @@ ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "expressions", - "id": "def-common.ast", + "id": "def-common.ExpressionsServiceStart.run.$1", "type": "CompoundType", "tags": [], "label": "ast", @@ -29487,11 +29908,12 @@ } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "expressions", - "id": "def-common.input", + "id": "def-common.ExpressionsServiceStart.run.$2", "type": "Uncategorized", "tags": [], "label": "input", @@ -29500,11 +29922,12 @@ "Input" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "expressions", - "id": "def-common.params", + "id": "def-common.ExpressionsServiceStart.run.$3", "type": "Object", "tags": [], "label": "params", @@ -29520,9 +29943,11 @@ " | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -29562,11 +29987,10 @@ ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "expressions", - "id": "def-common.ast", + "id": "def-common.ExpressionsServiceStart.execute.$1", "type": "CompoundType", "tags": [], "label": "ast", @@ -29582,11 +30006,12 @@ } ], "path": "src/plugins/expressions/common/service/expressions_services.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "expressions", - "id": "def-common.input", + "id": "def-common.ExpressionsServiceStart.execute.$2", "type": "Uncategorized", "tags": [], "label": "input", @@ -29595,11 +30020,12 @@ "Input" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "expressions", - "id": "def-common.params", + "id": "def-common.ExpressionsServiceStart.execute.$3", "type": "Object", "tags": [], "label": "params", @@ -29615,9 +30041,11 @@ " | undefined" ], "path": "src/plugins/expressions/common/service/expressions_services.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -29640,8 +30068,8 @@ ], "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -29692,7 +30120,24 @@ "((type: any) => void | Error) | undefined" ], "path": "src/plugins/expressions/common/expression_types/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionTypeDefinition.validate.$1", + "type": "Any", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/expressions/common/expression_types/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -29705,7 +30150,24 @@ "((type: Value) => SerializedType) | undefined" ], "path": "src/plugins/expressions/common/expression_types/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionTypeDefinition.serialize.$1", + "type": "Uncategorized", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "Value" + ], + "path": "src/plugins/expressions/common/expression_types/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -29718,7 +30180,24 @@ "((type: SerializedType) => Value) | undefined" ], "path": "src/plugins/expressions/common/expression_types/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionTypeDefinition.deserialize.$1", + "type": "Uncategorized", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "SerializedType" + ], + "path": "src/plugins/expressions/common/expression_types/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -29900,8 +30379,8 @@ ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -29915,11 +30394,10 @@ ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "expressions", - "id": "def-common.fn", + "id": "def-common.IInterpreterRenderHandlers.onDestroy.$1", "type": "Function", "tags": [], "label": "fn", @@ -29928,9 +30406,11 @@ "() => void" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -29944,8 +30424,8 @@ ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -29959,11 +30439,10 @@ ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "expressions", - "id": "def-common.params", + "id": "def-common.IInterpreterRenderHandlers.update.$1", "type": "Any", "tags": [], "label": "params", @@ -29972,9 +30451,11 @@ "any" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -29988,11 +30469,10 @@ ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "expressions", - "id": "def-common.event", + "id": "def-common.IInterpreterRenderHandlers.event.$1", "type": "Any", "tags": [], "label": "event", @@ -30001,9 +30481,11 @@ "any" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -30016,7 +30498,24 @@ "((event: any) => Promise) | undefined" ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.IInterpreterRenderHandlers.hasCompatibleActions.$1", + "type": "Any", + "tags": [], + "label": "event", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -30037,8 +30536,8 @@ ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -30052,8 +30551,8 @@ ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "expressions", @@ -31829,6 +32328,35 @@ ], "path": "src/plugins/expressions/common/expression_types/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "expressions", + "id": "def-common.input", + "type": "Uncategorized", + "tags": [], + "label": "input", + "description": [], + "signature": [ + "I" + ], + "path": "src/plugins/expressions/common/expression_types/types.ts", + "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-common.availableTypes", + "type": "Object", + "tags": [], + "label": "availableTypes", + "description": [], + "signature": [ + "{ [x: string]: any; }" + ], + "path": "src/plugins/expressions/common/expression_types/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { diff --git a/api_docs/expressions.mdx b/api_docs/expressions.mdx index abac2ad5cd8b9..ffc13bfdff967 100644 --- a/api_docs/expressions.mdx +++ b/api_docs/expressions.mdx @@ -18,7 +18,7 @@ import expressionsObj from './expressions.json'; | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2004 | 58 | 1569 | 5 | +| 2030 | 65 | 1595 | 5 | ## Client diff --git a/api_docs/features.json b/api_docs/features.json index 0e57b3618ddf6..982c88d5f626c 100644 --- a/api_docs/features.json +++ b/api_docs/features.json @@ -2143,7 +2143,23 @@ "(licenseType: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\") => boolean | undefined" ], "path": "x-pack/plugins/features/server/feature_privilege_iterator/sub_feature_privilege_iterator.ts", - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "features", + "id": "def-server.licenseType", + "type": "CompoundType", + "tags": [], + "label": "licenseType", + "description": [], + "signature": [ + "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" + ], + "path": "x-pack/plugins/features/server/feature_privilege_iterator/sub_feature_privilege_iterator.ts", + "deprecated": false + } + ] } ] } diff --git a/api_docs/features.mdx b/api_docs/features.mdx index 6bead616a2913..6b44744e68dd8 100644 --- a/api_docs/features.mdx +++ b/api_docs/features.mdx @@ -18,7 +18,7 @@ import featuresObj from './features.json'; | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 215 | 0 | 97 | 2 | +| 216 | 0 | 98 | 2 | ## Client diff --git a/api_docs/file_upload.json b/api_docs/file_upload.json index 1c67c9c89c392..0c935915a9eee 100644 --- a/api_docs/file_upload.json +++ b/api_docs/file_upload.json @@ -102,11 +102,10 @@ ], "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "fileUpload", - "id": "def-public.geojsonFile", + "id": "def-public.FileUploadComponentProps.onFileSelect.$1", "type": "Object", "tags": [], "label": "geojsonFile", @@ -115,29 +114,39 @@ "GeoJSON.FeatureCollection" ], "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "fileUpload", - "id": "def-public.name", + "id": "def-public.FileUploadComponentProps.onFileSelect.$2", "type": "string", "tags": [], "label": "name", "description": [], + "signature": [ + "string" + ], "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "fileUpload", - "id": "def-public.previewCoverage", + "id": "def-public.FileUploadComponentProps.onFileSelect.$3", "type": "number", "tags": [], "label": "previewCoverage", "description": [], + "signature": [ + "number" + ], "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "fileUpload", @@ -151,8 +160,8 @@ ], "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "fileUpload", @@ -166,8 +175,8 @@ ], "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "fileUpload", @@ -181,8 +190,8 @@ ], "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "fileUpload", @@ -204,11 +213,10 @@ ], "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "fileUpload", - "id": "def-public.results", + "id": "def-public.FileUploadComponentProps.onUploadComplete.$1", "type": "Object", "tags": [], "label": "results", @@ -223,9 +231,11 @@ } ], "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "fileUpload", @@ -239,8 +249,8 @@ ], "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -791,21 +801,24 @@ ], "path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "fileUpload", - "id": "def-public.name", + "id": "def-public.Props.onIndexNameChange.$1", "type": "string", "tags": [], "label": "name", "description": [], + "signature": [ + "string" + ], "path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "fileUpload", - "id": "def-public.error", + "id": "def-public.Props.onIndexNameChange.$2", "type": "string", "tags": [], "label": "error", @@ -814,9 +827,11 @@ "string | undefined" ], "path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "fileUpload", @@ -830,8 +845,8 @@ ], "path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "fileUpload", @@ -845,8 +860,8 @@ ], "path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false diff --git a/api_docs/fleet.json b/api_docs/fleet.json index e8efeff2da9b5..a50bc0bb78063 100644 --- a/api_docs/fleet.json +++ b/api_docs/fleet.json @@ -962,30 +962,54 @@ ], "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "fleet", - "id": "def-public.opts", + "id": "def-public.PackagePolicyCreateExtensionComponentProps.onChange.$1.opts", "type": "Object", "tags": [], "label": "opts", "description": [], - "signature": [ - "{ isValid: boolean; updatedPolicy: ", + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", + "deprecated": false, + "children": [ { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.NewPackagePolicy", - "text": "NewPackagePolicy" + "parentPluginId": "fleet", + "id": "def-public.PackagePolicyCreateExtensionComponentProps.onChange.$1.opts.isValid", + "type": "boolean", + "tags": [], + "label": "isValid", + "description": [ + "is current form state is valid" + ], + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", + "deprecated": false }, - "; }" - ], - "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", - "deprecated": false + { + "parentPluginId": "fleet", + "id": "def-public.PackagePolicyCreateExtensionComponentProps.onChange.$1.opts.updatedPolicy", + "type": "Object", + "tags": [], + "label": "updatedPolicy", + "description": [ + "The updated Integration Policy to be merged back and included in the API call" + ], + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewPackagePolicy", + "text": "NewPackagePolicy" + } + ], + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", + "deprecated": false + } + ] } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -1163,30 +1187,131 @@ ], "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "fleet", - "id": "def-public.opts", + "id": "def-public.PackagePolicyEditExtensionComponentProps.onChange.$1.opts", "type": "Object", "tags": [], "label": "opts", "description": [], - "signature": [ - "{ isValid: boolean; updatedPolicy: Partial<", + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", + "deprecated": false, + "children": [ { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.NewPackagePolicy", - "text": "NewPackagePolicy" + "parentPluginId": "fleet", + "id": "def-public.PackagePolicyEditExtensionComponentProps.onChange.$1.opts.isValid", + "type": "boolean", + "tags": [], + "label": "isValid", + "description": [ + "is current form state is valid" + ], + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", + "deprecated": false }, - ">; }" - ], - "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", - "deprecated": false + { + "parentPluginId": "fleet", + "id": "def-public.PackagePolicyEditExtensionComponentProps.onChange.$1.opts.updatedPolicy", + "type": "Object", + "tags": [], + "label": "updatedPolicy", + "description": [ + "The updated Integration Policy to be merged back and included in the API call" + ], + "signature": [ + "{ name?: string | undefined; description?: string | undefined; namespace?: string | undefined; enabled?: boolean | undefined; policy_id?: string | undefined; output_id?: string | undefined; package?: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicyPackage", + "text": "PackagePolicyPackage" + }, + " | undefined; inputs?: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewPackagePolicyInput", + "text": "NewPackagePolicyInput" + }, + "[] | undefined; vars?: Record | undefined; }" + ], + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", + "deprecated": false + } + ] } - ] + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-public.PackagePolicyEditTabsExtension", + "type": "Interface", + "tags": [], + "label": "PackagePolicyEditTabsExtension", + "description": [ + "Extension point registration contract for Integration Policy Edit tabs views" + ], + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-public.PackagePolicyEditTabsExtension.package", + "type": "string", + "tags": [], + "label": "package", + "description": [], + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-public.PackagePolicyEditTabsExtension.view", + "type": "string", + "tags": [], + "label": "view", + "description": [], + "signature": [ + "\"package-policy-edit-tabs\"" + ], + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-public.PackagePolicyEditTabsExtension.tabs", + "type": "Array", + "tags": [], + "label": "tabs", + "description": [], + "signature": [ + "{ title: string; Component: React.LazyExoticComponent>; }[]" + ], + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", + "deprecated": false } ], "initialIsOpen": false @@ -1390,6 +1515,14 @@ "text": "PackagePolicyEditExtension" }, " | ", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.PackagePolicyEditTabsExtension", + "text": "PackagePolicyEditTabsExtension" + }, + " | ", { "pluginId": "fleet", "scope": "public", @@ -1448,6 +1581,68 @@ ], "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "fleet", + "id": "def-public.extensionPoint", + "type": "CompoundType", + "tags": [], + "label": "extensionPoint", + "description": [], + "signature": [ + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.PackagePolicyEditExtension", + "text": "PackagePolicyEditExtension" + }, + " | ", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.PackagePolicyEditTabsExtension", + "text": "PackagePolicyEditTabsExtension" + }, + " | ", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.PackageCustomExtension", + "text": "PackageCustomExtension" + }, + " | ", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.PackagePolicyCreateExtension", + "text": "PackagePolicyCreateExtension" + }, + " | ", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.PackageAssetsExtension", + "text": "PackageAssetsExtension" + }, + " | ", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.AgentEnrollmentFlyoutFinalStepExtension", + "text": "AgentEnrollmentFlyoutFinalStepExtension" + } + ], + "path": "x-pack/plugins/fleet/public/types/ui_extensions.ts", + "deprecated": false + } + ], "initialIsOpen": false } ], @@ -2082,6 +2277,14 @@ "text": "PackagePolicyEditExtension" }, " | ", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.PackagePolicyEditTabsExtension", + "text": "PackagePolicyEditTabsExtension" + }, + " | ", { "pluginId": "fleet", "scope": "public", @@ -2131,8 +2334,8 @@ ], "path": "x-pack/plugins/fleet/public/plugin.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "lifecycle": "start", @@ -5079,8 +5282,8 @@ ], "path": "x-pack/plugins/fleet/server/plugin.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "fleet", @@ -5195,86 +5398,29 @@ ], "path": "x-pack/plugins/fleet/server/plugin.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "fleet", - "id": "def-server.args", + "id": "def-server.FleetStartContract.registerExternalCallback.$1", "type": "CompoundType", "tags": [], "label": "args", "description": [], "signature": [ - "[\"packagePolicyCreate\", (newPackagePolicy: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.NewPackagePolicy", - "text": "NewPackagePolicy" - }, - ", context: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.RequestHandlerContext", - "text": "RequestHandlerContext" - }, - ", request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ") => Promise<", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.NewPackagePolicy", - "text": "NewPackagePolicy" - }, - ">] | [\"packagePolicyUpdate\", (newPackagePolicy: ", { "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.UpdatePackagePolicy", - "text": "UpdatePackagePolicy" - }, - ", context: ", - { - "pluginId": "core", "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.RequestHandlerContext", - "text": "RequestHandlerContext" - }, - ", request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - ") => Promise<", - { - "pluginId": "fleet", - "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.UpdatePackagePolicy", - "text": "UpdatePackagePolicy" - }, - ">]" + "section": "def-server.ExternalCallback", + "text": "ExternalCallback" + } ], "path": "x-pack/plugins/fleet/server/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "fleet", @@ -5291,19 +5437,23 @@ ], "path": "x-pack/plugins/fleet/server/plugin.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "fleet", - "id": "def-server.packageName", + "id": "def-server.FleetStartContract.createArtifactsClient.$1", "type": "string", "tags": [], "label": "packageName", "description": [], + "signature": [ + "string" + ], "path": "x-pack/plugins/fleet/server/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "lifecycle": "start", diff --git a/api_docs/fleet.mdx b/api_docs/fleet.mdx index c02764f5b94fe..39f2921cf9234 100644 --- a/api_docs/fleet.mdx +++ b/api_docs/fleet.mdx @@ -18,7 +18,7 @@ import fleetObj from './fleet.json'; | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 1140 | 15 | 1045 | 8 | +| 1149 | 15 | 1049 | 8 | ## Client diff --git a/api_docs/global_search.json b/api_docs/global_search.json index ae8a7b4ea74af..87c7e1e1a0a8c 100644 --- a/api_docs/global_search.json +++ b/api_docs/global_search.json @@ -398,8 +398,8 @@ ], "path": "x-pack/plugins/global_search/public/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -948,11 +948,10 @@ ], "path": "x-pack/plugins/global_search/server/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "globalSearch", - "id": "def-server.context", + "id": "def-server.GlobalSearchResultProvider.getSearchableTypes.$1", "type": "Object", "tags": [], "label": "context", @@ -967,9 +966,11 @@ } ], "path": "x-pack/plugins/global_search/server/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -1066,8 +1067,8 @@ ], "path": "x-pack/plugins/global_search/server/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false diff --git a/api_docs/home.json b/api_docs/home.json index 4e6e7e84561ad..c30afaa4a024c 100644 --- a/api_docs/home.json +++ b/api_docs/home.json @@ -241,7 +241,9 @@ "(() => boolean) | undefined" ], "path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "home", @@ -461,6 +463,35 @@ ], "path": "src/plugins/home/public/services/tutorials/tutorial_service.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "home", + "id": "def-public.props", + "type": "CompoundType", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P & { children?: React.ReactNode; }" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "home", + "id": "def-public.context", + "type": "Any", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "any" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -475,6 +506,35 @@ ], "path": "src/plugins/home/public/services/tutorials/tutorial_service.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "home", + "id": "def-public.props", + "type": "CompoundType", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P & { children?: React.ReactNode; }" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "home", + "id": "def-public.context", + "type": "Any", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "any" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -489,6 +549,35 @@ ], "path": "src/plugins/home/public/services/tutorials/tutorial_service.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "home", + "id": "def-public.props", + "type": "CompoundType", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P & { children?: React.ReactNode; }" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "home", + "id": "def-public.context", + "type": "Any", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "any" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -951,6 +1040,8 @@ ], "path": "src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts", "deprecated": false, + "returnComment": [], + "children": [], "initialIsOpen": false }, { @@ -967,6 +1058,22 @@ ], "path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "home", + "id": "def-server.context", + "type": "Object", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "TutorialContext" + ], + "path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { diff --git a/api_docs/home.mdx b/api_docs/home.mdx index e6ddbfa5c95aa..f84e5a228a76e 100644 --- a/api_docs/home.mdx +++ b/api_docs/home.mdx @@ -18,7 +18,7 @@ import homeObj from './home.json'; | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 94 | 0 | 70 | 5 | +| 101 | 3 | 77 | 5 | ## Client diff --git a/api_docs/index_pattern_field_editor.json b/api_docs/index_pattern_field_editor.json index 38ab5859f86c8..430110f239414 100644 --- a/api_docs/index_pattern_field_editor.json +++ b/api_docs/index_pattern_field_editor.json @@ -314,22 +314,34 @@ ], "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "indexPatternFieldEditor", - "id": "def-public.newParams", + "id": "def-public.FormatEditorProps.onChange.$1.newParams", "type": "Object", "tags": [], "label": "newParams", "description": [], - "signature": [ - "{ [key: string]: any; }" - ], "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "indexPatternFieldEditor", + "id": "def-public.FormatEditorProps.onChange.$1.newParams.Unnamed", + "type": "Any", + "tags": [], + "label": "Unnamed", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/types.ts", + "deprecated": false + } + ] } - ] + ], + "returnComment": [] }, { "parentPluginId": "indexPatternFieldEditor", @@ -405,7 +417,24 @@ "((fieldNames: string[]) => void) | undefined" ], "path": "src/plugins/index_pattern_field_editor/public/open_delete_modal.tsx", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "indexPatternFieldEditor", + "id": "def-public.OpenFieldDeleteModalOptions.onDelete.$1", + "type": "Array", + "tags": [], + "label": "fieldNames", + "description": [], + "signature": [ + "string[]" + ], + "path": "src/plugins/index_pattern_field_editor/public/open_delete_modal.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "indexPatternFieldEditor", @@ -473,7 +502,30 @@ ") => void) | undefined" ], "path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "indexPatternFieldEditor", + "id": "def-public.OpenFieldEditorOptions.onSave.$1", + "type": "Object", + "tags": [], + "label": "field", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataIndexPatternsPluginApi", + "section": "def-common.IndexPatternField", + "text": "IndexPatternField" + } + ], + "path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "indexPatternFieldEditor", @@ -548,6 +600,8 @@ ], "path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/types.ts", "deprecated": false, + "returnComment": [], + "children": [], "initialIsOpen": false } ], diff --git a/api_docs/index_pattern_field_editor.mdx b/api_docs/index_pattern_field_editor.mdx index a231ac79bd77b..f35b78a4d8195 100644 --- a/api_docs/index_pattern_field_editor.mdx +++ b/api_docs/index_pattern_field_editor.mdx @@ -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 | |-------------------|-----------|------------------------|-----------------| -| 41 | 1 | 36 | 3 | +| 44 | 2 | 39 | 3 | ## Client diff --git a/api_docs/infra.json b/api_docs/infra.json index 86bad7fb6f783..5e40eab3a0c0f 100644 --- a/api_docs/infra.json +++ b/api_docs/infra.json @@ -358,21 +358,24 @@ ], "path": "x-pack/plugins/infra/server/plugin.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "infra", - "id": "def-server.sourceId", + "id": "def-server.InfraPluginSetup.defineInternalSourceConfiguration.$1", "type": "string", "tags": [], "label": "sourceId", "description": [], + "signature": [ + "string" + ], "path": "x-pack/plugins/infra/server/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "infra", - "id": "def-server.sourceProperties", + "id": "def-server.InfraPluginSetup.defineInternalSourceConfiguration.$2", "type": "Object", "tags": [], "label": "sourceProperties", @@ -381,9 +384,11 @@ "InfraStaticSourceConfiguration" ], "path": "x-pack/plugins/infra/server/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "lifecycle": "setup", diff --git a/api_docs/inspector.json b/api_docs/inspector.json index 4b246e5dfc0dc..a664d83be259b 100644 --- a/api_docs/inspector.json +++ b/api_docs/inspector.json @@ -881,7 +881,30 @@ ") => boolean) | undefined" ], "path": "src/plugins/inspector/public/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "inspector", + "id": "def-public.InspectorViewDescription.shouldShow.$1", + "type": "Object", + "tags": [], + "label": "adapters", + "description": [], + "signature": [ + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + } + ], + "path": "src/plugins/inspector/public/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "inspector", @@ -1181,13 +1204,10 @@ ], "path": "src/plugins/inspector/public/plugin.tsx", "deprecated": false, - "returnComment": [ - "True, if a call to `open` with the same adapters\nwould have shown the inspector panel, false otherwise." - ], "children": [ { "parentPluginId": "inspector", - "id": "def-public.adapters", + "id": "def-public.Start.isAvailable.$1", "type": "Object", "tags": [], "label": "adapters", @@ -1205,8 +1225,12 @@ " | undefined" ], "path": "src/plugins/inspector/public/plugin.tsx", - "deprecated": false + "deprecated": false, + "isRequired": false } + ], + "returnComment": [ + "True, if a call to `open` with the same adapters\nwould have shown the inspector panel, false otherwise." ] }, { @@ -1249,13 +1273,10 @@ ], "path": "src/plugins/inspector/public/plugin.tsx", "deprecated": false, - "returnComment": [ - "The session instance for the opened inspector." - ], "children": [ { "parentPluginId": "inspector", - "id": "def-public.adapters", + "id": "def-public.Start.open.$1", "type": "Object", "tags": [], "label": "adapters", @@ -1272,11 +1293,12 @@ } ], "path": "src/plugins/inspector/public/plugin.tsx", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "inspector", - "id": "def-public.options", + "id": "def-public.Start.open.$2", "type": "Object", "tags": [], "label": "options", @@ -1294,8 +1316,12 @@ " | undefined" ], "path": "src/plugins/inspector/public/plugin.tsx", - "deprecated": false + "deprecated": false, + "isRequired": false } + ], + "returnComment": [ + "The session instance for the opened inspector." ] } ], diff --git a/api_docs/inspector.mdx b/api_docs/inspector.mdx index e89f1a98fb493..33fb9823ba592 100644 --- a/api_docs/inspector.mdx +++ b/api_docs/inspector.mdx @@ -18,7 +18,7 @@ import inspectorObj from './inspector.json'; | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 101 | 6 | 78 | 4 | +| 102 | 6 | 79 | 4 | ## Client diff --git a/api_docs/kibana_legacy.json b/api_docs/kibana_legacy.json index de011fadbcbea..9c05836b3fc2a 100644 --- a/api_docs/kibana_legacy.json +++ b/api_docs/kibana_legacy.json @@ -919,7 +919,24 @@ "((...args: any[]) => void) | undefined" ], "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "kibanaLegacy", + "id": "def-public.RouteConfiguration.resolveRedirectTo.$1", + "type": "Array", + "tags": [], + "label": "args", + "description": [], + "signature": [ + "any[]" + ], + "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "kibanaLegacy", @@ -999,7 +1016,24 @@ "[]) | undefined" ], "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "kibanaLegacy", + "id": "def-public.RouteConfiguration.k7Breadcrumbs.$1", + "type": "Array", + "tags": [], + "label": "args", + "description": [], + "signature": [ + "any[]" + ], + "path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "kibanaLegacy", @@ -1060,6 +1094,38 @@ ], "path": "src/plugins/kibana_legacy/public/utils/private.d.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaLegacy", + "id": "def-public.provider", + "type": "Function", + "tags": [], + "label": "provider", + "description": [], + "signature": [ + "(...injectable: any[]) => T" + ], + "path": "src/plugins/kibana_legacy/public/utils/private.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaLegacy", + "id": "def-public.injectable", + "type": "Array", + "tags": [], + "label": "injectable", + "description": [], + "signature": [ + "any[]" + ], + "path": "src/plugins/kibana_legacy/public/utils/private.d.ts", + "deprecated": false + } + ] + } + ], "initialIsOpen": false }, { diff --git a/api_docs/kibana_legacy.mdx b/api_docs/kibana_legacy.mdx index 0cd1ce47b6b88..e3253990a134a 100644 --- a/api_docs/kibana_legacy.mdx +++ b/api_docs/kibana_legacy.mdx @@ -18,7 +18,7 @@ Contact [Kibana App](https://github.com/orgs/elastic/teams/kibana-app) for quest | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 66 | 3 | 62 | 1 | +| 70 | 3 | 66 | 1 | ## Client diff --git a/api_docs/kibana_react.json b/api_docs/kibana_react.json index f54de84490de5..9c1390cdba8c6 100644 --- a/api_docs/kibana_react.json +++ b/api_docs/kibana_react.json @@ -892,6 +892,35 @@ ], "path": "src/plugins/kibana_react/public/context/context.tsx", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaReact", + "id": "def-public.props", + "type": "CompoundType", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P & { children?: React.ReactNode; }" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "kibanaReact", + "id": "def-public.context", + "type": "Any", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "any" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -1835,8 +1864,8 @@ ], "path": "src/plugins/kibana_react/public/exit_full_screen_button/exit_full_screen_button.tsx", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -1992,7 +2021,9 @@ "(() => void) | undefined" ], "path": "src/plugins/kibana_react/public/field_button/field_button.tsx", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "kibanaReact", @@ -2381,24 +2412,24 @@ ], "path": "src/plugins/kibana_react/public/overlays/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "kibanaReact", - "id": "def-public.node", + "id": "def-public.KibanaReactOverlays.openFlyout.$1", "type": "CompoundType", "tags": [], "label": "node", "description": [], "signature": [ - "string | number | boolean | {} | React.ReactElement React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)> | React.ReactNodeArray | React.ReactPortal | null | undefined" + "React.ReactNode" ], "path": "src/plugins/kibana_react/public/overlays/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": false }, { "parentPluginId": "kibanaReact", - "id": "def-public.options", + "id": "def-public.KibanaReactOverlays.openFlyout.$2", "type": "Object", "tags": [], "label": "options", @@ -2414,9 +2445,11 @@ " | undefined" ], "path": "src/plugins/kibana_react/public/overlays/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "kibanaReact", @@ -2445,24 +2478,24 @@ ], "path": "src/plugins/kibana_react/public/overlays/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "kibanaReact", - "id": "def-public.node", + "id": "def-public.KibanaReactOverlays.openModal.$1", "type": "CompoundType", "tags": [], "label": "node", "description": [], "signature": [ - "string | number | boolean | {} | React.ReactElement React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)> | React.ReactNodeArray | React.ReactPortal | null | undefined" + "React.ReactNode" ], "path": "src/plugins/kibana_react/public/overlays/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": false }, { "parentPluginId": "kibanaReact", - "id": "def-public.options", + "id": "def-public.KibanaReactOverlays.openModal.$2", "type": "Object", "tags": [], "label": "options", @@ -2478,9 +2511,11 @@ " | undefined" ], "path": "src/plugins/kibana_react/public/overlays/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -3199,7 +3234,25 @@ ".IStandaloneCodeEditor) => void) | undefined" ], "path": "src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "kibanaReact", + "id": "def-public.UrlTemplateEditorProps.onEditor.$1", + "type": "Object", + "tags": [], + "label": "editor", + "description": [], + "signature": [ + "editor", + ".IStandaloneCodeEditor" + ], + "path": "src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "kibanaReact", @@ -4198,6 +4251,43 @@ ], "path": "src/plugins/kibana_react/common/eui_styled_components.tsx", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaReact", + "id": "def-common.first", + "type": "CompoundType", + "tags": [], + "label": "first", + "description": [], + "signature": [ + "CSSObject", + " | ", + "InterpolationFunction", + "<", + "ThemedStyledProps", + "> | TemplateStringsArray" + ], + "path": "node_modules/@types/styled-components/ts3.7/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "kibanaReact", + "id": "def-common.interpolations", + "type": "Array", + "tags": [], + "label": "interpolations", + "description": [], + "signature": [ + "Interpolation", + "<", + "ThemedStyledProps", + ">[]" + ], + "path": "node_modules/@types/styled-components/ts3.7/index.d.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -4374,6 +4464,37 @@ ], "path": "src/plugins/kibana_react/common/eui_styled_components.tsx", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaReact", + "id": "def-common.strings", + "type": "CompoundType", + "tags": [], + "label": "strings", + "description": [], + "signature": [ + "TemplateStringsArray | ", + "CSSKeyframes" + ], + "path": "node_modules/@types/styled-components/ts3.7/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "kibanaReact", + "id": "def-common.interpolations", + "type": "Array", + "tags": [], + "label": "interpolations", + "description": [], + "signature": [ + "SimpleInterpolation", + "[]" + ], + "path": "node_modules/@types/styled-components/ts3.7/index.d.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -4404,6 +4525,22 @@ ], "path": "src/plugins/kibana_react/common/eui_styled_components.tsx", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaReact", + "id": "def-common.component", + "type": "Uncategorized", + "tags": [], + "label": "component", + "description": [], + "signature": [ + "React.ComponentProps extends { theme?: T | undefined; } ? C : never" + ], + "path": "node_modules/@types/styled-components/ts3.7/index.d.ts", + "deprecated": false + } + ], "initialIsOpen": false } ], diff --git a/api_docs/kibana_react.mdx b/api_docs/kibana_react.mdx index 3a89efb7af28c..95aa1fb017ea5 100644 --- a/api_docs/kibana_react.mdx +++ b/api_docs/kibana_react.mdx @@ -18,7 +18,7 @@ import kibanaReactObj from './kibana_react.json'; | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 258 | 5 | 228 | 4 | +| 266 | 6 | 236 | 4 | ## Client diff --git a/api_docs/kibana_utils.json b/api_docs/kibana_utils.json index 4c9a86ba830de..fa59e31712129 100644 --- a/api_docs/kibana_utils.json +++ b/api_docs/kibana_utils.json @@ -1673,7 +1673,24 @@ "((error: Error) => void) | undefined" ], "path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-public.createKbnUrlStateStorage.$1.useHashfalsehistoryonGetErroronSetError.onGetError.$1", + "type": "Object", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "Error" + ], + "path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "kibanaUtils", @@ -1686,7 +1703,24 @@ "((error: Error) => void) | undefined" ], "path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-public.createKbnUrlStateStorage.$1.useHashfalsehistoryonGetErroronSetError.onSetError.$1", + "type": "Object", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "Error" + ], + "path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ] } @@ -2015,7 +2049,9 @@ ") | undefined" ], "path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_tracker.ts", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "kibanaUtils", @@ -2045,7 +2081,26 @@ "((pathname: string) => boolean) | undefined" ], "path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_tracker.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-public.createKbnUrlTracker.$1.baseUrldefaultSubUrlstorageKeystateParamsnavLinkUpdater$toastNotificationshistorygetHistorystorageshouldTrackUrlUpdatereturntrueonBeforeNavLinkSavednewNavLinknewNavLink.shouldTrackUrlUpdate.$1", + "type": "string", + "tags": [], + "label": "pathname", + "description": [ + "A location's pathname which comes to history listener" + ], + "signature": [ + "string" + ], + "path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_tracker.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "kibanaUtils", @@ -2060,7 +2115,24 @@ "((newNavLink: string) => string) | undefined" ], "path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_tracker.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-public.createKbnUrlTracker.$1.baseUrldefaultSubUrlstorageKeystateParamsnavLinkUpdater$toastNotificationshistorygetHistorystorageshouldTrackUrlUpdatereturntrueonBeforeNavLinkSavednewNavLinknewNavLink.onBeforeNavLinkSaved.$1", + "type": "string", + "tags": [], + "label": "newNavLink", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/kibana_utils/public/state_management/url/kbn_url_tracker.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ] } @@ -3513,7 +3585,30 @@ ") => void) | undefined" ], "path": "src/plugins/kibana_utils/public/history/redirect_when_missing.tsx", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-public.redirectWhenMissing.$1.historynavigateToAppbasePathmappingtoastNotificationsonBeforeRedirect.onBeforeRedirect.$1", + "type": "Object", + "tags": [], + "label": "error", + "description": [], + "signature": [ + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SavedObjectNotFound", + "text": "SavedObjectNotFound" + } + ], + "path": "src/plugins/kibana_utils/public/history/redirect_when_missing.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ] } @@ -4260,10 +4355,10 @@ ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", "deprecated": false, + "children": [], "returnComment": [ "current state" - ], - "children": [] + ] }, { "parentPluginId": "kibanaUtils", @@ -4279,11 +4374,10 @@ ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "kibanaUtils", - "id": "def-public.state", + "id": "def-public.BaseStateContainer.set.$1", "type": "Uncategorized", "tags": [], "label": "state", @@ -4294,9 +4388,11 @@ "State" ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "kibanaUtils", @@ -4368,11 +4464,10 @@ ], "path": "src/plugins/kibana_utils/public/ui/configurable.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "kibanaUtils", - "id": "def-public.config", + "id": "def-public.CollectConfigProps.onConfig.$1", "type": "Uncategorized", "tags": [], "label": "config", @@ -4381,9 +4476,11 @@ "Config" ], "path": "src/plugins/kibana_utils/public/ui/configurable.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "kibanaUtils", @@ -4439,11 +4536,10 @@ ], "path": "src/plugins/kibana_utils/public/ui/configurable.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "kibanaUtils", - "id": "def-public.context", + "id": "def-public.Configurable.createConfig.$1", "type": "Uncategorized", "tags": [], "label": "context", @@ -4452,9 +4548,11 @@ "Context" ], "path": "src/plugins/kibana_utils/public/ui/configurable.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "kibanaUtils", @@ -4470,11 +4568,10 @@ ], "path": "src/plugins/kibana_utils/public/ui/configurable.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "kibanaUtils", - "id": "def-public.config", + "id": "def-public.Configurable.isConfigValid.$1", "type": "Uncategorized", "tags": [], "label": "config", @@ -4483,11 +4580,12 @@ "Config" ], "path": "src/plugins/kibana_utils/public/ui/configurable.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "kibanaUtils", - "id": "def-public.context", + "id": "def-public.Configurable.isConfigValid.$2", "type": "Uncategorized", "tags": [], "label": "context", @@ -4496,9 +4594,11 @@ "Context" ], "path": "src/plugins/kibana_utils/public/ui/configurable.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "kibanaUtils", @@ -4561,7 +4661,24 @@ "((state: T) => T) | undefined" ], "path": "src/plugins/kibana_utils/common/state_containers/create_state_container.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-public.CreateStateContainerOptions.freeze.$1", + "type": "Uncategorized", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "T" + ], + "path": "src/plugins/kibana_utils/common/state_containers/create_state_container.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -4601,21 +4718,24 @@ ], "path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "kibanaUtils", - "id": "def-public.key", + "id": "def-public.IKbnUrlStateStorage.set.$1", "type": "string", "tags": [], "label": "key", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "kibanaUtils", - "id": "def-public.state", + "id": "def-public.IKbnUrlStateStorage.set.$2", "type": "Uncategorized", "tags": [], "label": "state", @@ -4624,22 +4744,33 @@ "State" ], "path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "kibanaUtils", - "id": "def-public.opts", + "id": "def-public.IKbnUrlStateStorage.set.$3.opts", "type": "Object", "tags": [], "label": "opts", "description": [], - "signature": [ - "{ replace: boolean; } | undefined" - ], "path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-public.IKbnUrlStateStorage.set.$3.opts.replace", + "type": "boolean", + "tags": [], + "label": "replace", + "description": [], + "path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.ts", + "deprecated": false + } + ] } - ] + ], + "returnComment": [] }, { "parentPluginId": "kibanaUtils", @@ -4653,19 +4784,23 @@ ], "path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "kibanaUtils", - "id": "def-public.key", + "id": "def-public.IKbnUrlStateStorage.get.$1", "type": "string", "tags": [], "label": "key", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "kibanaUtils", @@ -4681,19 +4816,23 @@ ], "path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "kibanaUtils", - "id": "def-public.key", + "id": "def-public.IKbnUrlStateStorage.change$.$1", "type": "string", "tags": [], "label": "key", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "kibanaUtils", @@ -4709,8 +4848,8 @@ ], "path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_kbn_url_state_storage.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "kibanaUtils", @@ -4772,11 +4911,10 @@ ], "path": "src/plugins/kibana_utils/public/state_sync/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "kibanaUtils", - "id": "def-public.state", + "id": "def-public.INullableBaseStateContainer.set.$1", "type": "CompoundType", "tags": [], "label": "state", @@ -4785,9 +4923,11 @@ "State | null" ], "path": "src/plugins/kibana_utils/public/state_sync/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -4827,21 +4967,24 @@ ], "path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_session_storage_state_storage.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "kibanaUtils", - "id": "def-public.key", + "id": "def-public.ISessionStorageStateStorage.set.$1", "type": "string", "tags": [], "label": "key", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_session_storage_state_storage.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "kibanaUtils", - "id": "def-public.state", + "id": "def-public.ISessionStorageStateStorage.set.$2", "type": "Uncategorized", "tags": [], "label": "state", @@ -4850,9 +4993,11 @@ "State" ], "path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_session_storage_state_storage.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "kibanaUtils", @@ -4866,19 +5011,23 @@ ], "path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_session_storage_state_storage.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "kibanaUtils", - "id": "def-public.key", + "id": "def-public.ISessionStorageStateStorage.get.$1", "type": "string", "tags": [], "label": "key", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/kibana_utils/public/state_sync/state_sync_state_storage/create_session_storage_state_storage.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -4989,19 +5138,23 @@ ], "path": "src/plugins/kibana_utils/public/storage/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "kibanaUtils", - "id": "def-public.key", + "id": "def-public.IStorage.getItem.$1", "type": "string", "tags": [], "label": "key", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/kibana_utils/public/storage/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "kibanaUtils", @@ -5015,21 +5168,24 @@ ], "path": "src/plugins/kibana_utils/public/storage/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "kibanaUtils", - "id": "def-public.key", + "id": "def-public.IStorage.setItem.$1", "type": "string", "tags": [], "label": "key", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/kibana_utils/public/storage/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "kibanaUtils", - "id": "def-public.value", + "id": "def-public.IStorage.setItem.$2", "type": "Uncategorized", "tags": [], "label": "value", @@ -5038,9 +5194,11 @@ "T" ], "path": "src/plugins/kibana_utils/public/storage/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "kibanaUtils", @@ -5054,19 +5212,23 @@ ], "path": "src/plugins/kibana_utils/public/storage/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "kibanaUtils", - "id": "def-public.key", + "id": "def-public.IStorage.removeItem.$1", "type": "string", "tags": [], "label": "key", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/kibana_utils/public/storage/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "kibanaUtils", @@ -5080,8 +5242,8 @@ ], "path": "src/plugins/kibana_utils/public/storage/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -5118,19 +5280,23 @@ ], "path": "src/plugins/kibana_utils/public/storage/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "kibanaUtils", - "id": "def-public.key", + "id": "def-public.IStorageWrapper.get.$1", "type": "string", "tags": [], "label": "key", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/kibana_utils/public/storage/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "kibanaUtils", @@ -5144,21 +5310,24 @@ ], "path": "src/plugins/kibana_utils/public/storage/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "kibanaUtils", - "id": "def-public.key", + "id": "def-public.IStorageWrapper.set.$1", "type": "string", "tags": [], "label": "key", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/kibana_utils/public/storage/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "kibanaUtils", - "id": "def-public.value", + "id": "def-public.IStorageWrapper.set.$2", "type": "Uncategorized", "tags": [], "label": "value", @@ -5167,9 +5336,11 @@ "T" ], "path": "src/plugins/kibana_utils/public/storage/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "kibanaUtils", @@ -5183,19 +5354,23 @@ ], "path": "src/plugins/kibana_utils/public/storage/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "kibanaUtils", - "id": "def-public.key", + "id": "def-public.IStorageWrapper.remove.$1", "type": "string", "tags": [], "label": "key", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/kibana_utils/public/storage/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "kibanaUtils", @@ -5209,8 +5384,8 @@ ], "path": "src/plugins/kibana_utils/public/storage/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -5370,8 +5545,8 @@ ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "kibanaUtils", @@ -5438,24 +5613,30 @@ ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "kibanaUtils", - "id": "def-public.nextReducer", + "id": "def-public.ReduxLikeStateContainer.replaceReducer.$1", "type": "Function", "tags": [], "label": "nextReducer", "description": [], "signature": [ - "(state: State, action: ", - "TransitionDescription", - ") => State" + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.Reducer", + "text": "Reducer" + }, + "" ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "kibanaUtils", @@ -5471,11 +5652,10 @@ ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "kibanaUtils", - "id": "def-public.action", + "id": "def-public.ReduxLikeStateContainer.dispatch.$1", "type": "Object", "tags": [], "label": "action", @@ -5485,9 +5665,11 @@ "" ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "kibanaUtils", @@ -5509,42 +5691,30 @@ ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "kibanaUtils", - "id": "def-public.middleware", + "id": "def-public.ReduxLikeStateContainer.addMiddleware.$1", "type": "Function", "tags": [], "label": "middleware", "description": [], "signature": [ - "(store: Pick<", - { - "pluginId": "kibanaUtils", - "scope": "common", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.ReduxLikeStateContainer", - "text": "ReduxLikeStateContainer" - }, - ", \"getState\" | \"dispatch\">) => (next: (action: ", - "TransitionDescription", - ") => any) => ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.Dispatch", - "text": "Dispatch" + "section": "def-common.Middleware", + "text": "Middleware" }, - "<", - "TransitionDescription", - ">" + "" ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "kibanaUtils", @@ -5558,11 +5728,10 @@ ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "kibanaUtils", - "id": "def-public.listener", + "id": "def-public.ReduxLikeStateContainer.subscribe.$1", "type": "Function", "tags": [], "label": "listener", @@ -5571,9 +5740,11 @@ "(state: State) => void" ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -5844,6 +6015,35 @@ ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-public.previous", + "type": "Uncategorized", + "tags": [], + "label": "previous", + "description": [], + "signature": [ + "Result" + ], + "path": "src/plugins/kibana_utils/common/state_containers/types.ts", + "deprecated": false + }, + { + "parentPluginId": "kibanaUtils", + "id": "def-public.current", + "type": "Uncategorized", + "tags": [], + "label": "current", + "description": [], + "signature": [ + "Result" + ], + "path": "src/plugins/kibana_utils/common/state_containers/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -5868,6 +6068,38 @@ ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-public.mapStateToProp", + "type": "Function", + "tags": [], + "label": "mapStateToProp", + "description": [], + "signature": [ + "(state: State) => Pick" + ], + "path": "src/plugins/kibana_utils/common/state_containers/types.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-public.state", + "type": "Uncategorized", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "State" + ], + "path": "src/plugins/kibana_utils/common/state_containers/types.ts", + "deprecated": false + } + ] + } + ], "initialIsOpen": false }, { @@ -5884,6 +6116,22 @@ ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-public.action", + "type": "Uncategorized", + "tags": [], + "label": "action", + "description": [], + "signature": [ + "T" + ], + "path": "src/plugins/kibana_utils/common/state_containers/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -5906,6 +6154,22 @@ ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-public.state", + "type": "Uncategorized", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "State" + ], + "path": "src/plugins/kibana_utils/common/state_containers/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -5922,6 +6186,22 @@ ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-public.state", + "type": "Uncategorized", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "State" + ], + "path": "src/plugins/kibana_utils/common/state_containers/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -5936,6 +6216,8 @@ ], "path": "src/plugins/kibana_utils/common/create_getter_setter.ts", "deprecated": false, + "returnComment": [], + "children": [], "initialIsOpen": false }, { @@ -5952,6 +6234,22 @@ ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-public.state", + "type": "Uncategorized", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "State" + ], + "path": "src/plugins/kibana_utils/common/state_containers/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -5988,6 +6286,24 @@ ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-public.store", + "type": "Object", + "tags": [], + "label": "store", + "description": [], + "signature": [ + "{ getState: () => State; dispatch: (action: ", + "TransitionDescription", + ") => void; }" + ], + "path": "src/plugins/kibana_utils/common/state_containers/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -6010,6 +6326,22 @@ ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-public.state", + "type": "Uncategorized", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "State" + ], + "path": "src/plugins/kibana_utils/common/state_containers/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -6067,6 +6399,22 @@ ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-public.args", + "type": "Uncategorized", + "tags": [], + "label": "args", + "description": [], + "signature": [ + "Args" + ], + "path": "src/plugins/kibana_utils/common/state_containers/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -6085,34 +6433,96 @@ ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "kibanaUtils", - "id": "def-public.Selector", - "type": "Type", - "tags": [], - "label": "Selector", - "description": [], - "signature": [ - "(...args: Args) => Result" - ], - "path": "src/plugins/kibana_utils/common/state_containers/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "kibanaUtils", - "id": "def-public.Set", - "type": "Type", - "tags": [], - "label": "Set", - "description": [], - "signature": [ - "(value: T) => void" + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-public.state", + "type": "Uncategorized", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "State" + ], + "path": "src/plugins/kibana_utils/common/state_containers/types.ts", + "deprecated": false + }, + { + "parentPluginId": "kibanaUtils", + "id": "def-public.action", + "type": "Object", + "tags": [], + "label": "action", + "description": [], + "signature": [ + "TransitionDescription", + "" + ], + "path": "src/plugins/kibana_utils/common/state_containers/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "kibanaUtils", + "id": "def-public.Selector", + "type": "Type", + "tags": [], + "label": "Selector", + "description": [], + "signature": [ + "(...args: Args) => Result" + ], + "path": "src/plugins/kibana_utils/common/state_containers/types.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-public.args", + "type": "Uncategorized", + "tags": [], + "label": "args", + "description": [], + "signature": [ + "Args" + ], + "path": "src/plugins/kibana_utils/common/state_containers/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "kibanaUtils", + "id": "def-public.Set", + "type": "Type", + "tags": [], + "label": "Set", + "description": [], + "signature": [ + "(value: T) => void" ], "path": "src/plugins/kibana_utils/common/create_getter_setter.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-public.value", + "type": "Uncategorized", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "T" + ], + "path": "src/plugins/kibana_utils/common/create_getter_setter.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -6143,6 +6553,8 @@ ], "path": "src/plugins/kibana_utils/public/core/create_start_service_getter.ts", "deprecated": false, + "returnComment": [], + "children": [], "initialIsOpen": false }, { @@ -6157,6 +6569,8 @@ ], "path": "src/plugins/kibana_utils/public/state_sync/state_sync.ts", "deprecated": false, + "returnComment": [], + "children": [], "initialIsOpen": false }, { @@ -6171,6 +6585,8 @@ ], "path": "src/plugins/kibana_utils/public/state_sync/state_sync.ts", "deprecated": false, + "returnComment": [], + "children": [], "initialIsOpen": false }, { @@ -6195,6 +6611,8 @@ ], "path": "src/plugins/kibana_utils/common/ui/ui_component.ts", "deprecated": false, + "returnComment": [], + "children": [], "initialIsOpen": false }, { @@ -6296,7 +6714,33 @@ "(val: string, pctEncodeSpaces?: boolean | undefined) => string" ], "path": "src/plugins/kibana_utils/common/url/encode_uri_query.ts", - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-public.val", + "type": "string", + "tags": [], + "label": "val", + "description": [], + "path": "src/plugins/kibana_utils/common/url/encode_uri_query.ts", + "deprecated": false + }, + { + "parentPluginId": "kibanaUtils", + "id": "def-public.pctEncodeSpaces", + "type": "CompoundType", + "tags": [], + "label": "pctEncodeSpaces", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/kibana_utils/common/url/encode_uri_query.ts", + "deprecated": false + } + ] }, { "parentPluginId": "kibanaUtils", @@ -7213,6 +7657,8 @@ ], "path": "src/plugins/kibana_utils/common/create_getter_setter.ts", "deprecated": false, + "returnComment": [], + "children": [], "initialIsOpen": false }, { @@ -7227,6 +7673,22 @@ ], "path": "src/plugins/kibana_utils/common/create_getter_setter.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-server.value", + "type": "Uncategorized", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "T" + ], + "path": "src/plugins/kibana_utils/common/create_getter_setter.ts", + "deprecated": false + } + ], "initialIsOpen": false } ], @@ -7284,7 +7746,33 @@ "(val: string, pctEncodeSpaces?: boolean | undefined) => string" ], "path": "src/plugins/kibana_utils/common/url/encode_uri_query.ts", - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-server.val", + "type": "string", + "tags": [], + "label": "val", + "description": [], + "path": "src/plugins/kibana_utils/common/url/encode_uri_query.ts", + "deprecated": false + }, + { + "parentPluginId": "kibanaUtils", + "id": "def-server.pctEncodeSpaces", + "type": "CompoundType", + "tags": [], + "label": "pctEncodeSpaces", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/kibana_utils/common/url/encode_uri_query.ts", + "deprecated": false + } + ] }, { "parentPluginId": "kibanaUtils", @@ -8975,10 +9463,10 @@ ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", "deprecated": false, + "children": [], "returnComment": [ "current state" - ], - "children": [] + ] }, { "parentPluginId": "kibanaUtils", @@ -8994,11 +9482,10 @@ ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "kibanaUtils", - "id": "def-common.state", + "id": "def-common.BaseStateContainer.set.$1", "type": "Uncategorized", "tags": [], "label": "state", @@ -9009,9 +9496,11 @@ "State" ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "kibanaUtils", @@ -9057,7 +9546,24 @@ "((state: T) => T) | undefined" ], "path": "src/plugins/kibana_utils/common/state_containers/create_state_container.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-common.CreateStateContainerOptions.freeze.$1", + "type": "Uncategorized", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "T" + ], + "path": "src/plugins/kibana_utils/common/state_containers/create_state_container.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -9156,13 +9662,10 @@ ], "path": "src/plugins/kibana_utils/common/persistable_state/types.ts", "deprecated": false, - "returnComment": [ - "A new stats object augmented with new telemetry information." - ], "children": [ { "parentPluginId": "kibanaUtils", - "id": "def-common.state", + "id": "def-common.PersistableState.telemetry.$1", "type": "Uncategorized", "tags": [], "label": "state", @@ -9173,11 +9676,12 @@ "P" ], "path": "src/plugins/kibana_utils/common/persistable_state/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "kibanaUtils", - "id": "def-common.stats", + "id": "def-common.PersistableState.telemetry.$2", "type": "Object", "tags": [], "label": "stats", @@ -9185,11 +9689,15 @@ "Stats object containing the stats which were already\ncollected. This `stats` object shall not be mutated in-line." ], "signature": [ - "{ [x: string]: any; }" + "Record" ], "path": "src/plugins/kibana_utils/common/persistable_state/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } + ], + "returnComment": [ + "A new stats object augmented with new telemetry information." ] }, { @@ -9208,13 +9716,10 @@ ], "path": "src/plugins/kibana_utils/common/persistable_state/types.ts", "deprecated": false, - "returnComment": [ - "Persistable state object with references injected." - ], "children": [ { "parentPluginId": "kibanaUtils", - "id": "def-common.state", + "id": "def-common.PersistableState.inject.$1", "type": "Uncategorized", "tags": [], "label": "state", @@ -9225,11 +9730,12 @@ "P" ], "path": "src/plugins/kibana_utils/common/persistable_state/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "kibanaUtils", - "id": "def-common.references", + "id": "def-common.PersistableState.inject.$2", "type": "Array", "tags": [], "label": "references", @@ -9241,8 +9747,12 @@ "[]" ], "path": "src/plugins/kibana_utils/common/persistable_state/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } + ], + "returnComment": [ + "Persistable state object with references injected." ] }, { @@ -9261,13 +9771,10 @@ ], "path": "src/plugins/kibana_utils/common/persistable_state/types.ts", "deprecated": false, - "returnComment": [ - "Persistable state object with references extracted and a list of\nreferences." - ], "children": [ { "parentPluginId": "kibanaUtils", - "id": "def-common.state", + "id": "def-common.PersistableState.extract.$1", "type": "Uncategorized", "tags": [], "label": "state", @@ -9278,8 +9785,12 @@ "P" ], "path": "src/plugins/kibana_utils/common/persistable_state/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } + ], + "returnComment": [ + "Persistable state object with references extracted and a list of\nreferences." ] }, { @@ -9502,7 +10013,43 @@ ">) => P) | undefined" ], "path": "src/plugins/kibana_utils/common/persistable_state/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-common.PersistableStateService.migrateToLatest.$1", + "type": "Object", + "tags": [], + "label": "state", + "description": [ + "The persistable state serializable state object." + ], + "signature": [ + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.VersionedState", + "text": "VersionedState" + }, + "<", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.SerializableState", + "text": "SerializableState" + }, + ">" + ], + "path": "src/plugins/kibana_utils/common/persistable_state/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "A serializable state object migrated to the latest state." + ] }, { "parentPluginId": "kibanaUtils", @@ -9525,8 +10072,8 @@ ], "path": "src/plugins/kibana_utils/common/persistable_state/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -9573,8 +10120,8 @@ ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "kibanaUtils", @@ -9641,24 +10188,30 @@ ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "kibanaUtils", - "id": "def-common.nextReducer", + "id": "def-common.ReduxLikeStateContainer.replaceReducer.$1", "type": "Function", "tags": [], "label": "nextReducer", "description": [], "signature": [ - "(state: State, action: ", - "TransitionDescription", - ") => State" - ], - "path": "src/plugins/kibana_utils/common/state_containers/types.ts", - "deprecated": false - } - ] + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.Reducer", + "text": "Reducer" + }, + "" + ], + "path": "src/plugins/kibana_utils/common/state_containers/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "kibanaUtils", @@ -9674,11 +10227,10 @@ ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "kibanaUtils", - "id": "def-common.action", + "id": "def-common.ReduxLikeStateContainer.dispatch.$1", "type": "Object", "tags": [], "label": "action", @@ -9688,9 +10240,11 @@ "" ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "kibanaUtils", @@ -9712,42 +10266,30 @@ ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "kibanaUtils", - "id": "def-common.middleware", + "id": "def-common.ReduxLikeStateContainer.addMiddleware.$1", "type": "Function", "tags": [], "label": "middleware", "description": [], "signature": [ - "(store: Pick<", - { - "pluginId": "kibanaUtils", - "scope": "common", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.ReduxLikeStateContainer", - "text": "ReduxLikeStateContainer" - }, - ", \"getState\" | \"dispatch\">) => (next: (action: ", - "TransitionDescription", - ") => any) => ", { "pluginId": "kibanaUtils", "scope": "common", "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.Dispatch", - "text": "Dispatch" + "section": "def-common.Middleware", + "text": "Middleware" }, - "<", - "TransitionDescription", - ">" + "" ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "kibanaUtils", @@ -9761,11 +10303,10 @@ ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "kibanaUtils", - "id": "def-common.listener", + "id": "def-common.ReduxLikeStateContainer.subscribe.$1", "type": "Function", "tags": [], "label": "listener", @@ -9774,9 +10315,11 @@ "(state: State) => void" ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -10033,6 +10576,35 @@ ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-common.previous", + "type": "Uncategorized", + "tags": [], + "label": "previous", + "description": [], + "signature": [ + "Result" + ], + "path": "src/plugins/kibana_utils/common/state_containers/types.ts", + "deprecated": false + }, + { + "parentPluginId": "kibanaUtils", + "id": "def-common.current", + "type": "Uncategorized", + "tags": [], + "label": "current", + "description": [], + "signature": [ + "Result" + ], + "path": "src/plugins/kibana_utils/common/state_containers/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -10057,6 +10629,38 @@ ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-common.mapStateToProp", + "type": "Function", + "tags": [], + "label": "mapStateToProp", + "description": [], + "signature": [ + "(state: State) => Pick" + ], + "path": "src/plugins/kibana_utils/common/state_containers/types.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-common.state", + "type": "Uncategorized", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "State" + ], + "path": "src/plugins/kibana_utils/common/state_containers/types.ts", + "deprecated": false + } + ] + } + ], "initialIsOpen": false }, { @@ -10073,6 +10677,22 @@ ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-common.action", + "type": "Uncategorized", + "tags": [], + "label": "action", + "description": [], + "signature": [ + "T" + ], + "path": "src/plugins/kibana_utils/common/state_containers/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -10095,6 +10715,22 @@ ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-common.state", + "type": "Uncategorized", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "State" + ], + "path": "src/plugins/kibana_utils/common/state_containers/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -10111,6 +10747,22 @@ ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-common.state", + "type": "Uncategorized", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "State" + ], + "path": "src/plugins/kibana_utils/common/state_containers/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -10125,6 +10777,8 @@ ], "path": "src/plugins/kibana_utils/common/create_getter_setter.ts", "deprecated": false, + "returnComment": [], + "children": [], "initialIsOpen": false }, { @@ -10141,6 +10795,22 @@ ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-common.state", + "type": "Uncategorized", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "State" + ], + "path": "src/plugins/kibana_utils/common/state_containers/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -10177,6 +10847,24 @@ ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-common.store", + "type": "Object", + "tags": [], + "label": "store", + "description": [], + "signature": [ + "{ getState: () => State; dispatch: (action: ", + "TransitionDescription", + ") => void; }" + ], + "path": "src/plugins/kibana_utils/common/state_containers/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -10191,6 +10879,22 @@ ], "path": "src/plugins/kibana_utils/common/persistable_state/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-common.state", + "type": "Uncategorized", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "FromVersion" + ], + "path": "src/plugins/kibana_utils/common/persistable_state/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -10274,6 +10978,40 @@ ], "path": "src/plugins/kibana_utils/common/persistable_state/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-common.state", + "type": "Object", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "{ [key: string]: ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.Serializable", + "text": "Serializable" + }, + "; }" + ], + "path": "src/plugins/kibana_utils/common/persistable_state/types.ts", + "deprecated": false + }, + { + "parentPluginId": "kibanaUtils", + "id": "def-common.version", + "type": "string", + "tags": [], + "label": "version", + "description": [], + "path": "src/plugins/kibana_utils/common/persistable_state/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -10296,6 +11034,22 @@ ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-common.state", + "type": "Uncategorized", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "State" + ], + "path": "src/plugins/kibana_utils/common/state_containers/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -10353,6 +11107,22 @@ ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-common.args", + "type": "Uncategorized", + "tags": [], + "label": "args", + "description": [], + "signature": [ + "Args" + ], + "path": "src/plugins/kibana_utils/common/state_containers/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -10371,6 +11141,36 @@ ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-common.state", + "type": "Uncategorized", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "State" + ], + "path": "src/plugins/kibana_utils/common/state_containers/types.ts", + "deprecated": false + }, + { + "parentPluginId": "kibanaUtils", + "id": "def-common.action", + "type": "Object", + "tags": [], + "label": "action", + "description": [], + "signature": [ + "TransitionDescription", + "" + ], + "path": "src/plugins/kibana_utils/common/state_containers/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -10385,6 +11185,22 @@ ], "path": "src/plugins/kibana_utils/common/state_containers/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-common.args", + "type": "Uncategorized", + "tags": [], + "label": "args", + "description": [], + "signature": [ + "Args" + ], + "path": "src/plugins/kibana_utils/common/state_containers/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -10475,6 +11291,22 @@ ], "path": "src/plugins/kibana_utils/common/create_getter_setter.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-common.value", + "type": "Uncategorized", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "T" + ], + "path": "src/plugins/kibana_utils/common/create_getter_setter.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -10499,6 +11331,8 @@ ], "path": "src/plugins/kibana_utils/common/ui/ui_component.ts", "deprecated": false, + "returnComment": [], + "children": [], "initialIsOpen": false }, { @@ -10580,7 +11414,33 @@ "(val: string, pctEncodeSpaces?: boolean | undefined) => string" ], "path": "src/plugins/kibana_utils/common/url/encode_uri_query.ts", - "deprecated": false + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "kibanaUtils", + "id": "def-common.val", + "type": "string", + "tags": [], + "label": "val", + "description": [], + "path": "src/plugins/kibana_utils/common/url/encode_uri_query.ts", + "deprecated": false + }, + { + "parentPluginId": "kibanaUtils", + "id": "def-common.pctEncodeSpaces", + "type": "CompoundType", + "tags": [], + "label": "pctEncodeSpaces", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/kibana_utils/common/url/encode_uri_query.ts", + "deprecated": false + } + ] }, { "parentPluginId": "kibanaUtils", diff --git a/api_docs/kibana_utils.mdx b/api_docs/kibana_utils.mdx index 26abebb3442d6..d3b81d90994b4 100644 --- a/api_docs/kibana_utils.mdx +++ b/api_docs/kibana_utils.mdx @@ -18,7 +18,7 @@ import kibanaUtilsObj from './kibana_utils.json'; | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 551 | 3 | 359 | 8 | +| 600 | 3 | 406 | 8 | ## Client diff --git a/api_docs/lens.json b/api_docs/lens.json index f936a7a91e85a..34408d962cead 100644 --- a/api_docs/lens.json +++ b/api_docs/lens.json @@ -627,26 +627,30 @@ ], "path": "x-pack/plugins/lens/public/plugin.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "lens", - "id": "def-public.input", + "id": "def-public.LensPublicStart.navigateToPrefilledEditor.$1", "type": "CompoundType", "tags": [], "label": "input", "description": [], "signature": [ - "LensByValueInput", - " | ", - "LensByReferenceInput" + { + "pluginId": "lens", + "scope": "public", + "docId": "kibLensPluginApi", + "section": "def-public.LensEmbeddableInput", + "text": "LensEmbeddableInput" + } ], "path": "x-pack/plugins/lens/public/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "lens", - "id": "def-public.openInNewTab", + "id": "def-public.LensPublicStart.navigateToPrefilledEditor.$2", "type": "CompoundType", "tags": [], "label": "openInNewTab", @@ -655,9 +659,11 @@ "boolean | undefined" ], "path": "x-pack/plugins/lens/public/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "lens", @@ -673,8 +679,8 @@ ], "path": "x-pack/plugins/lens/public/plugin.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "lens", @@ -692,8 +698,8 @@ ], "path": "x-pack/plugins/lens/public/plugin.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -3459,7 +3465,8 @@ "section": "def-common.PersistableFilter", "text": "PersistableFilter" }, - " extends any" + " extends ", + "Filter" ], "path": "x-pack/plugins/lens/common/types.ts", "deprecated": false, @@ -3501,7 +3508,8 @@ "section": "def-common.PersistableFilterMeta", "text": "PersistableFilterMeta" }, - " extends any" + " extends ", + "FilterMeta" ], "path": "x-pack/plugins/lens/common/types.ts", "deprecated": false, @@ -3637,6 +3645,29 @@ ], "path": "x-pack/plugins/lens/common/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "lens", + "id": "def-common.mapping", + "type": "Object", + "tags": [], + "label": "mapping", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + "> | undefined" + ], + "path": "x-pack/plugins/lens/common/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { diff --git a/api_docs/lens.mdx b/api_docs/lens.mdx index c7e65c3036e7a..eec8be6fa3824 100644 --- a/api_docs/lens.mdx +++ b/api_docs/lens.mdx @@ -18,7 +18,7 @@ Contact [Kibana App](https://github.com/orgs/elastic/teams/kibana-app) for quest | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 207 | 0 | 191 | 23 | +| 208 | 0 | 192 | 23 | ## Client diff --git a/api_docs/licensing.json b/api_docs/licensing.json index 27a4b9248f0bf..7c115d73327bd 100644 --- a/api_docs/licensing.json +++ b/api_docs/licensing.json @@ -143,8 +143,8 @@ ], "path": "x-pack/plugins/licensing/common/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "licensing", @@ -175,8 +175,8 @@ ], "path": "x-pack/plugins/licensing/common/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "licensing", @@ -764,11 +764,7 @@ }, { "plugin": "reporting", - "path": "x-pack/plugins/reporting/public/share_context_menu/register_csv_reporting.tsx" - }, - { - "plugin": "reporting", - "path": "x-pack/plugins/reporting/public/share_context_menu/register_pdf_png_reporting.tsx" + "path": "x-pack/plugins/reporting/public/share_context_menu/index.ts" }, { "plugin": "reporting", @@ -1849,8 +1845,8 @@ ], "path": "x-pack/plugins/licensing/common/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "licensing", @@ -1881,8 +1877,8 @@ ], "path": "x-pack/plugins/licensing/common/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "licensing", @@ -2409,6 +2405,22 @@ ], "path": "x-pack/plugins/licensing/server/wrap_route_with_license_check.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "licensing", + "id": "def-server.license", + "type": "Object", + "tags": [], + "label": "license", + "description": [], + "signature": [ + "ILicense" + ], + "path": "x-pack/plugins/licensing/server/wrap_route_with_license_check.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -2739,11 +2751,10 @@ ], "path": "x-pack/plugins/licensing/server/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "licensing", - "id": "def-server.clusterClient", + "id": "def-server.LicensingPluginStart.createLicensePoller.$1", "type": "Object", "tags": [], "label": "clusterClient", @@ -2758,19 +2769,25 @@ } ], "path": "x-pack/plugins/licensing/server/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "licensing", - "id": "def-server.pollingFrequency", + "id": "def-server.LicensingPluginStart.createLicensePoller.$2", "type": "number", "tags": [], "label": "pollingFrequency", "description": [], + "signature": [ + "number" + ], "path": "x-pack/plugins/licensing/server/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "licensing", diff --git a/api_docs/licensing.mdx b/api_docs/licensing.mdx index 84cba56ea87d2..4b378e9773b11 100644 --- a/api_docs/licensing.mdx +++ b/api_docs/licensing.mdx @@ -18,7 +18,7 @@ import licensingObj from './licensing.json'; | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 117 | 0 | 42 | 8 | +| 118 | 0 | 43 | 8 | ## Client diff --git a/api_docs/lists.json b/api_docs/lists.json index 9e18c73ec444f..db65a52a8e4c5 100644 --- a/api_docs/lists.json +++ b/api_docs/lists.json @@ -2551,8 +2551,8 @@ ], "path": "x-pack/plugins/lists/server/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "lists", @@ -2573,8 +2573,8 @@ ], "path": "x-pack/plugins/lists/server/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false diff --git a/api_docs/management.json b/api_docs/management.json index 44482a9a6dda2..5ec2da0cdf204 100644 --- a/api_docs/management.json +++ b/api_docs/management.json @@ -499,11 +499,10 @@ ], "path": "src/plugins/management/public/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "management", - "id": "def-public.crumbs", + "id": "def-public.ManagementAppMountParams.setBreadcrumbs.$1", "type": "Array", "tags": [], "label": "crumbs", @@ -513,9 +512,11 @@ "[]" ], "path": "src/plugins/management/public/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "management", diff --git a/api_docs/maps.json b/api_docs/maps.json index 6ea34d19528ad..cb21f32f58a27 100644 --- a/api_docs/maps.json +++ b/api_docs/maps.json @@ -373,7 +373,9 @@ "label": "_getFilters", "description": [], "signature": [ - "() => any[]" + "() => ", + "Filter", + "[]" ], "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", "deprecated": false, @@ -608,7 +610,9 @@ "label": "addFilters", "description": [], "signature": [ - "(filters: any[], actionId?: string) => Promise" + "(filters: ", + "Filter", + "[], actionId?: string) => Promise" ], "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", "deprecated": false, @@ -621,7 +625,8 @@ "label": "filters", "description": [], "signature": [ - "any[]" + "Filter", + "[]" ], "path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx", "deprecated": false, @@ -822,7 +827,9 @@ "label": "addFilters", "description": [], "signature": [ - "((filters: any[], actionId: string) => Promise) | null" + "((filters: ", + "Filter", + "[], actionId: string) => Promise) | null" ], "path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts", "deprecated": false @@ -839,8 +846,8 @@ ], "path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "maps", @@ -875,7 +882,9 @@ ") | undefined" ], "path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "maps", @@ -896,7 +905,9 @@ "[]>) | undefined" ], "path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "maps", @@ -910,19 +921,23 @@ ], "path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "maps", - "id": "def-public.layerId", + "id": "def-public.RenderTooltipContentParams.getLayerName.$1", "type": "string", "tags": [], "label": "layerId", "description": [], + "signature": [ + "string" + ], "path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "maps", @@ -948,22 +963,57 @@ ], "path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "maps", - "id": "def-public.__0", + "id": "def-public.RenderTooltipContentParams.loadFeatureProperties.$1.layerIdfeatureIdmbProperties", "type": "Object", "tags": [], - "label": "__0", + "label": "{\n layerId,\n featureId,\n mbProperties,\n }", "description": [], - "signature": [ - "{ layerId: string; featureId?: string | number | undefined; mbProperties: GeoJSON.GeoJsonProperties; }" - ], "path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "maps", + "id": "def-public.RenderTooltipContentParams.loadFeatureProperties.$1.layerIdfeatureIdmbProperties.layerId", + "type": "string", + "tags": [], + "label": "layerId", + "description": [], + "path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts", + "deprecated": false + }, + { + "parentPluginId": "maps", + "id": "def-public.RenderTooltipContentParams.loadFeatureProperties.$1.layerIdfeatureIdmbProperties.featureId", + "type": "CompoundType", + "tags": [], + "label": "featureId", + "description": [], + "signature": [ + "string | number | undefined" + ], + "path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts", + "deprecated": false + }, + { + "parentPluginId": "maps", + "id": "def-public.RenderTooltipContentParams.loadFeatureProperties.$1.layerIdfeatureIdmbProperties.mbProperties", + "type": "CompoundType", + "tags": [], + "label": "mbProperties", + "description": [], + "signature": [ + "{ [name: string]: any; } | null" + ], + "path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts", + "deprecated": false + } + ] } - ] + ], + "returnComment": [] }, { "parentPluginId": "maps", @@ -977,22 +1027,44 @@ ], "path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "maps", - "id": "def-public.__0", + "id": "def-public.RenderTooltipContentParams.loadFeatureGeometry.$1.layerIdfeatureId", "type": "Object", "tags": [], - "label": "__0", + "label": "{\n layerId,\n featureId,\n }", "description": [], - "signature": [ - "{ layerId: string; featureId?: string | number | undefined; }" - ], "path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "maps", + "id": "def-public.RenderTooltipContentParams.loadFeatureGeometry.$1.layerIdfeatureId.layerId", + "type": "string", + "tags": [], + "label": "layerId", + "description": [], + "path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts", + "deprecated": false + }, + { + "parentPluginId": "maps", + "id": "def-public.RenderTooltipContentParams.loadFeatureGeometry.$1.layerIdfeatureId.featureId", + "type": "CompoundType", + "tags": [], + "label": "featureId", + "description": [], + "signature": [ + "string | number | undefined" + ], + "path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts", + "deprecated": false + } + ] } - ] + ], + "returnComment": [] }, { "parentPluginId": "maps", @@ -1013,7 +1085,58 @@ ") => void) | undefined" ], "path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "maps", + "id": "def-public.RenderTooltipContentParams.onSingleValueTrigger.$1", + "type": "string", + "tags": [], + "label": "actionId", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "maps", + "id": "def-public.RenderTooltipContentParams.onSingleValueTrigger.$2", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "maps", + "id": "def-public.RenderTooltipContentParams.onSingleValueTrigger.$3", + "type": "CompoundType", + "tags": [], + "label": "value", + "description": [], + "signature": [ + { + "pluginId": "maps", + "scope": "common", + "docId": "kibMapsPluginApi", + "section": "def-common.RawValue", + "text": "RawValue" + } + ], + "path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -1110,8 +1233,8 @@ "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" + "section": "def-common.IndexPattern", + "text": "IndexPattern" }, "[]; }" ], @@ -2359,6 +2482,22 @@ ], "path": "x-pack/plugins/maps/common/constants.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "maps", + "id": "def-common.value", + "type": "CompoundType", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "string | number | boolean | string[] | null | undefined" + ], + "path": "x-pack/plugins/maps/common/constants.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { diff --git a/api_docs/maps.mdx b/api_docs/maps.mdx index cd7b1641b0f79..994cdb3bd8f7d 100644 --- a/api_docs/maps.mdx +++ b/api_docs/maps.mdx @@ -18,7 +18,7 @@ import mapsObj from './maps.json'; | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 204 | 2 | 203 | 11 | +| 213 | 2 | 212 | 11 | ## Client diff --git a/api_docs/maps_ems.json b/api_docs/maps_ems.json index af9faa1a77df2..df458ddf4466d 100644 --- a/api_docs/maps_ems.json +++ b/api_docs/maps_ems.json @@ -783,8 +783,8 @@ ], "path": "src/plugins/maps_ems/public/index.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "lifecycle": "setup", diff --git a/api_docs/ml.json b/api_docs/ml.json index d30f84f2a1db5..0517a63ea1dbc 100644 --- a/api_docs/ml.json +++ b/api_docs/ml.json @@ -1247,6 +1247,24 @@ ], "path": "x-pack/plugins/ml/public/application/components/data_grid/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "ml", + "id": "def-public.__0", + "type": "Object", + "tags": [], + "label": "__0", + "description": [], + "signature": [ + "{ rowIndex: number; columnId: string; setCellProps: (props: ", + "CommonProps", + " & React.HTMLAttributes) => void; }" + ], + "path": "x-pack/plugins/ml/public/application/components/data_grid/types.ts", + "deprecated": false + } + ], "initialIsOpen": false } ], diff --git a/api_docs/ml.mdx b/api_docs/ml.mdx index a866593eb3743..8bb0019735cfd 100644 --- a/api_docs/ml.mdx +++ b/api_docs/ml.mdx @@ -18,7 +18,7 @@ Contact [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) for q | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 278 | 10 | 274 | 33 | +| 279 | 10 | 275 | 33 | ## Client diff --git a/api_docs/monitoring.json b/api_docs/monitoring.json index d5433b1d70f67..8edd098d6f8bf 100644 --- a/api_docs/monitoring.json +++ b/api_docs/monitoring.json @@ -34,8 +34,8 @@ ], "path": "x-pack/plugins/monitoring/server/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "monitoring", @@ -49,8 +49,8 @@ ], "path": "x-pack/plugins/monitoring/server/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "monitoring", @@ -72,32 +72,29 @@ ], "path": "x-pack/plugins/monitoring/server/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "monitoring", - "id": "def-server.esClient", + "id": "def-server.IBulkUploader.start.$1", "type": "CompoundType", "tags": [], "label": "esClient", "description": [], "signature": [ - "Pick<", - "KibanaClient", - ", \"get\" | \"delete\" | \"create\" | \"index\" | \"update\" | \"closePointInTime\" | \"count\" | \"search\" | \"security\" | \"eql\" | \"on\" | \"off\" | \"transform\" | \"helpers\" | \"emit\" | \"once\" | \"asyncSearch\" | \"autoscaling\" | \"bulk\" | \"cat\" | \"ccr\" | \"clearScroll\" | \"cluster\" | \"danglingIndices\" | \"dataFrameTransformDeprecated\" | \"deleteByQuery\" | \"deleteByQueryRethrottle\" | \"deleteScript\" | \"enrich\" | \"exists\" | \"existsSource\" | \"explain\" | \"features\" | \"fieldCaps\" | \"fleet\" | \"getScript\" | \"getScriptContext\" | \"getScriptLanguages\" | \"getSource\" | \"graph\" | \"ilm\" | \"indices\" | \"info\" | \"ingest\" | \"license\" | \"logstash\" | \"mget\" | \"migration\" | \"ml\" | \"monitoring\" | \"msearch\" | \"msearchTemplate\" | \"mtermvectors\" | \"nodes\" | \"openPointInTime\" | \"ping\" | \"putScript\" | \"rankEval\" | \"reindex\" | \"reindexRethrottle\" | \"renderSearchTemplate\" | \"rollup\" | \"scriptsPainlessExecute\" | \"scroll\" | \"searchShards\" | \"searchTemplate\" | \"searchableSnapshots\" | \"shutdown\" | \"slm\" | \"snapshot\" | \"sql\" | \"ssl\" | \"tasks\" | \"termsEnum\" | \"termvectors\" | \"textStructure\" | \"updateByQuery\" | \"updateByQueryRethrottle\" | \"watcher\" | \"xpack\"> & { transport: { request(params: ", - "TransportRequestParams", - ", options?: ", - "TransportRequestOptions", - " | undefined): ", - "TransportRequestPromise", - "<", - "ApiResponse", - ", unknown>>; }; }" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClient", + "text": "ElasticsearchClient" + } ], "path": "x-pack/plugins/monitoring/server/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "monitoring", @@ -111,8 +108,8 @@ ], "path": "x-pack/plugins/monitoring/server/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false diff --git a/api_docs/observability.json b/api_docs/observability.json index e87ea796c49a6..1daf96c7a551f 100644 --- a/api_docs/observability.json +++ b/api_docs/observability.json @@ -1479,29 +1479,37 @@ ], "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "observability", - "id": "def-public.by", + "id": "def-public.MetricsFetchDataResponse.sort.$1", "type": "string", "tags": [], "label": "by", "description": [], + "signature": [ + "string" + ], "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "observability", - "id": "def-public.direction", + "id": "def-public.MetricsFetchDataResponse.sort.$2", "type": "string", "tags": [], "label": "direction", "description": [], + "signature": [ + "string" + ], "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "observability", @@ -2834,6 +2842,28 @@ ], "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "observability", + "id": "def-public.fetchDataParams", + "type": "Object", + "tags": [], + "label": "fetchDataParams", + "description": [], + "signature": [ + { + "pluginId": "observability", + "scope": "public", + "docId": "kibObservabilityPluginApi", + "section": "def-public.FetchDataParams", + "text": "FetchDataParams" + } + ], + "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -2864,6 +2894,29 @@ ], "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "observability", + "id": "def-public.params", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + { + "pluginId": "observability", + "scope": "public", + "docId": "kibObservabilityPluginApi", + "section": "def-public.HasDataParams", + "text": "HasDataParams" + }, + " | undefined" + ], + "path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -2930,6 +2983,24 @@ ], "path": "x-pack/plugins/observability/public/rules/create_observability_rule_type_registry.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "observability", + "id": "def-public.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "{ fields: OutputOf<", + "Optional", + "<{ readonly \"kibana.rac.alert.owner\": { readonly type: \"keyword\"; }; readonly \"kibana.rac.alert.producer\": { readonly type: \"keyword\"; }; readonly \"kibana.space_ids\": { readonly type: \"keyword\"; readonly array: true; }; readonly \"kibana.rac.alert.uuid\": { readonly type: \"keyword\"; }; readonly \"kibana.rac.alert.id\": { readonly type: \"keyword\"; }; readonly \"kibana.rac.alert.start\": { readonly type: \"date\"; }; readonly \"kibana.rac.alert.end\": { readonly type: \"date\"; }; readonly \"kibana.rac.alert.duration.us\": { readonly type: \"long\"; }; readonly \"kibana.rac.alert.severity.level\": { readonly type: \"keyword\"; }; readonly \"kibana.rac.alert.severity.value\": { readonly type: \"long\"; }; readonly \"kibana.rac.alert.status\": { readonly type: \"keyword\"; }; readonly \"kibana.rac.alert.evaluation.threshold\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.rac.alert.evaluation.value\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.rac.alert.reason\": { readonly type: \"keyword\"; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly '@timestamp': { readonly type: \"date\"; readonly array: false; readonly required: true; }; readonly 'event.kind': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.action': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.uuid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.category': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; }, \"tags\" | \"event.kind\" | \"event.action\" | \"rule.uuid\" | \"rule.id\" | \"rule.name\" | \"rule.category\" | \"kibana.rac.alert.producer\" | \"kibana.rac.alert.owner\" | \"kibana.rac.alert.id\" | \"kibana.rac.alert.uuid\" | \"kibana.rac.alert.start\" | \"kibana.rac.alert.end\" | \"kibana.rac.alert.duration.us\" | \"kibana.rac.alert.severity.level\" | \"kibana.rac.alert.severity.value\" | \"kibana.rac.alert.status\" | \"kibana.rac.alert.evaluation.threshold\" | \"kibana.rac.alert.evaluation.value\" | \"kibana.rac.alert.reason\" | \"kibana.space_ids\">> & Record; formatters: { asDuration: (value: number | null | undefined, { defaultValue, extended }?: FormatterOptions) => string; asPercent: (numerator: number | null | undefined, denominator: number | undefined, fallbackResult?: string) => string; }; }" + ], + "path": "x-pack/plugins/observability/public/rules/create_observability_rule_type_registry.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -3051,6 +3122,22 @@ ], "path": "x-pack/plugins/observability/public/hooks/use_track_metric.tsx", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "observability", + "id": "def-public.__0", + "type": "CompoundType", + "tags": [], + "label": "__0", + "description": [], + "signature": [ + "TrackOptions & { metric: string; }" + ], + "path": "x-pack/plugins/observability/public/hooks/use_track_metric.tsx", + "deprecated": false + } + ], "initialIsOpen": false } ], diff --git a/api_docs/observability.mdx b/api_docs/observability.mdx index bb0545f4adf87..5755741ee71ab 100644 --- a/api_docs/observability.mdx +++ b/api_docs/observability.mdx @@ -18,7 +18,7 @@ Contact Observability UI for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 219 | 0 | 219 | 10 | +| 223 | 0 | 223 | 10 | ## Client diff --git a/api_docs/presentation_util.json b/api_docs/presentation_util.json index 85ee92cfb72a9..d062fa63965e7 100644 --- a/api_docs/presentation_util.json +++ b/api_docs/presentation_util.json @@ -1454,8 +1454,8 @@ ], "path": "src/plugins/presentation_util/public/services/capabilities.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "presentationUtil", @@ -1469,8 +1469,8 @@ ], "path": "src/plugins/presentation_util/public/services/capabilities.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "presentationUtil", @@ -1484,8 +1484,8 @@ ], "path": "src/plugins/presentation_util/public/services/capabilities.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "presentationUtil", @@ -1499,8 +1499,8 @@ ], "path": "src/plugins/presentation_util/public/services/capabilities.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -1537,21 +1537,24 @@ ], "path": "src/plugins/presentation_util/public/services/dashboards.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "presentationUtil", - "id": "def-public.query", + "id": "def-public.PresentationDashboardsService.findDashboards.$1", "type": "string", "tags": [], "label": "query", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/presentation_util/public/services/dashboards.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "presentationUtil", - "id": "def-public.fields", + "id": "def-public.PresentationDashboardsService.findDashboards.$2", "type": "Array", "tags": [], "label": "fields", @@ -1560,9 +1563,11 @@ "string[]" ], "path": "src/plugins/presentation_util/public/services/dashboards.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "presentationUtil", @@ -1586,19 +1591,23 @@ ], "path": "src/plugins/presentation_util/public/services/dashboards.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "presentationUtil", - "id": "def-public.title", + "id": "def-public.PresentationDashboardsService.findDashboardsByTitle.$1", "type": "string", "tags": [], "label": "title", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/presentation_util/public/services/dashboards.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -1625,11 +1634,10 @@ ], "path": "src/plugins/presentation_util/public/services/labs.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "presentationUtil", - "id": "def-public.id", + "id": "def-public.PresentationLabsService.isProjectEnabled.$1", "type": "string", "tags": [], "label": "id", @@ -1638,9 +1646,11 @@ "\"labs:dashboard:deferBelowFold\"" ], "path": "src/plugins/presentation_util/public/services/labs.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "presentationUtil", @@ -1654,8 +1664,8 @@ ], "path": "src/plugins/presentation_util/public/services/labs.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "presentationUtil", @@ -1676,11 +1686,10 @@ ], "path": "src/plugins/presentation_util/public/services/labs.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "presentationUtil", - "id": "def-public.id", + "id": "def-public.PresentationLabsService.getProject.$1", "type": "string", "tags": [], "label": "id", @@ -1689,9 +1698,11 @@ "\"labs:dashboard:deferBelowFold\"" ], "path": "src/plugins/presentation_util/public/services/labs.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "presentationUtil", @@ -1713,11 +1724,10 @@ ], "path": "src/plugins/presentation_util/public/services/labs.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "presentationUtil", - "id": "def-public.solutions", + "id": "def-public.PresentationLabsService.getProjects.$1", "type": "Array", "tags": [], "label": "solutions", @@ -1726,9 +1736,11 @@ "(\"dashboard\" | \"canvas\" | \"presentation\")[] | undefined" ], "path": "src/plugins/presentation_util/public/services/labs.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "presentationUtil", @@ -1742,11 +1754,10 @@ ], "path": "src/plugins/presentation_util/public/services/labs.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "presentationUtil", - "id": "def-public.id", + "id": "def-public.PresentationLabsService.setProjectStatus.$1", "type": "string", "tags": [], "label": "id", @@ -1755,11 +1766,12 @@ "\"labs:dashboard:deferBelowFold\"" ], "path": "src/plugins/presentation_util/public/services/labs.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "presentationUtil", - "id": "def-public.env", + "id": "def-public.PresentationLabsService.setProjectStatus.$2", "type": "CompoundType", "tags": [], "label": "env", @@ -1768,19 +1780,25 @@ "\"kibana\" | \"browser\" | \"session\"" ], "path": "src/plugins/presentation_util/public/services/labs.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "presentationUtil", - "id": "def-public.status", + "id": "def-public.PresentationLabsService.setProjectStatus.$3", "type": "boolean", "tags": [], "label": "status", "description": [], + "signature": [ + "boolean" + ], "path": "src/plugins/presentation_util/public/services/labs.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "presentationUtil", @@ -1794,8 +1812,8 @@ ], "path": "src/plugins/presentation_util/public/services/labs.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -1844,8 +1862,8 @@ ], "path": "src/plugins/presentation_util/public/components/solution_toolbar/items/quick_group.tsx", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "presentationUtil", @@ -1918,8 +1936,8 @@ ], "path": "src/plugins/presentation_util/public/components/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "presentationUtil", @@ -1941,11 +1959,10 @@ ], "path": "src/plugins/presentation_util/public/components/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "presentationUtil", - "id": "def-public.props", + "id": "def-public.SaveModalDashboardProps.onSave.$1", "type": "CompoundType", "tags": [], "label": "props", @@ -1961,9 +1978,11 @@ " & { dashboardId: string | null; addToLibrary: boolean; }" ], "path": "src/plugins/presentation_util/public/components/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "presentationUtil", @@ -2028,6 +2047,29 @@ ], "path": "src/plugins/presentation_util/public/services/create/factory.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "presentationUtil", + "id": "def-public.params", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + { + "pluginId": "presentationUtil", + "scope": "public", + "docId": "kibPresentationUtilPluginApi", + "section": "def-public.KibanaPluginServiceParams", + "text": "KibanaPluginServiceParams" + }, + "" + ], + "path": "src/plugins/presentation_util/public/services/create/factory.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -2044,6 +2086,22 @@ ], "path": "src/plugins/presentation_util/public/services/create/factory.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "presentationUtil", + "id": "def-public.params", + "type": "Uncategorized", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "Parameters" + ], + "path": "src/plugins/presentation_util/public/services/create/factory.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { diff --git a/api_docs/presentation_util.mdx b/api_docs/presentation_util.mdx index b2376b309272c..641d602dcb564 100644 --- a/api_docs/presentation_util.mdx +++ b/api_docs/presentation_util.mdx @@ -18,7 +18,7 @@ import presentationUtilObj from './presentation_util.json'; | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 176 | 3 | 149 | 5 | +| 178 | 3 | 151 | 5 | ## Client diff --git a/api_docs/reporting.json b/api_docs/reporting.json index 68c79a9240572..b959cb91c4af3 100644 --- a/api_docs/reporting.json +++ b/api_docs/reporting.json @@ -54,6 +54,40 @@ "path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "reporting", + "id": "def-public.ReportingAPIClient.Unnamed.$2", + "type": "Object", + "tags": [], + "label": "uiSettings", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCorePluginApi", + "section": "def-public.IUiSettingsClient", + "text": "IUiSettingsClient" + } + ], + "path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "reporting", + "id": "def-public.ReportingAPIClient.Unnamed.$3", + "type": "string", + "tags": [], + "label": "kibanaVersion", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts", + "deprecated": false, + "isRequired": true } ], "returnComment": [] @@ -311,7 +345,9 @@ "label": "getReportingJobPath", "description": [], "signature": [ - "(exportType: string, jobParams: JobParams) => string" + "(exportType: string, jobParams: ", + "BaseParams", + ") => string" ], "path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts", "deprecated": false, @@ -338,7 +374,7 @@ "label": "jobParams", "description": [], "signature": [ - "JobParams" + "BaseParams" ], "path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts", "deprecated": false, @@ -355,7 +391,9 @@ "label": "createReportingJob", "description": [], "signature": [ - "(exportType: string, jobParams: any) => Promise<", + "(exportType: string, jobParams: ", + "BaseParams", + ") => Promise<", "Job", ">" ], @@ -379,12 +417,77 @@ { "parentPluginId": "reporting", "id": "def-public.ReportingAPIClient.createReportingJob.$2", - "type": "Any", + "type": "Object", "tags": [], "label": "jobParams", "description": [], "signature": [ - "any" + "BaseParams" + ], + "path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "reporting", + "id": "def-public.ReportingAPIClient.createImmediateReport", + "type": "Function", + "tags": [], + "label": "createImmediateReport", + "description": [], + "signature": [ + "(baseParams: ", + "BaseParams", + ") => Promise" + ], + "path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "reporting", + "id": "def-public.ReportingAPIClient.createImmediateReport.$1", + "type": "Object", + "tags": [], + "label": "baseParams", + "description": [], + "signature": [ + "BaseParams" + ], + "path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "reporting", + "id": "def-public.ReportingAPIClient.getDecoratedJobParams", + "type": "Function", + "tags": [], + "label": "getDecoratedJobParams", + "description": [], + "signature": [ + ">(baseParams: T) => ", + "BaseParams" + ], + "path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "reporting", + "id": "def-public.ReportingAPIClient.getDecoratedJobParams.$1", + "type": "Uncategorized", + "tags": [], + "label": "baseParams", + "description": [], + "signature": [ + "T" ], "path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts", "deprecated": false, @@ -871,6 +974,21 @@ ], "returnComment": [] }, + { + "parentPluginId": "reporting", + "id": "def-server.ReportingCore.getKibanaVersion", + "type": "Function", + "tags": [], + "label": "getKibanaVersion", + "description": [], + "signature": [ + "() => string" + ], + "path": "x-pack/plugins/reporting/server/core.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, { "parentPluginId": "reporting", "id": "def-server.ReportingCore.pluginSetup", @@ -2138,8 +2256,8 @@ ], "path": "x-pack/plugins/reporting/server/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "lifecycle": "start", diff --git a/api_docs/reporting.mdx b/api_docs/reporting.mdx index 2c46a2c088852..b852149816d70 100644 --- a/api_docs/reporting.mdx +++ b/api_docs/reporting.mdx @@ -18,7 +18,7 @@ Contact [Kibana Reporting Services](https://github.com/orgs/elastic/teams/kibana | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 133 | 1 | 132 | 14 | +| 140 | 0 | 139 | 15 | ## Client diff --git a/api_docs/rule_registry.json b/api_docs/rule_registry.json index 96cd95735756c..24a8be2d2650f 100644 --- a/api_docs/rule_registry.json +++ b/api_docs/rule_registry.json @@ -792,8 +792,8 @@ ], "path": "x-pack/plugins/rule_registry/server/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -915,6 +915,22 @@ ], "path": "x-pack/plugins/rule_registry/server/utils/create_lifecycle_rule_type_factory.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "ruleRegistry", + "id": "def-server.alert", + "type": "Object", + "tags": [], + "label": "alert", + "description": [], + "signature": [ + "{ id: string; fields: Record; }" + ], + "path": "x-pack/plugins/rule_registry/server/utils/create_lifecycle_rule_type_factory.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -939,6 +955,46 @@ ], "path": "x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "ruleRegistry", + "id": "def-server.options", + "type": "CompoundType", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "Pick<", + { + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.AlertExecutorOptions", + "text": "AlertExecutorOptions" + }, + ", \"name\" | \"params\" | \"tags\" | \"spaceId\" | \"rule\" | \"createdBy\" | \"updatedBy\" | \"previousStartedAt\" | \"state\" | \"alertId\" | \"namespace\" | \"startedAt\"> & { services: ", + { + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.AlertServices", + "text": "AlertServices" + }, + " & ", + { + "pluginId": "ruleRegistry", + "scope": "server", + "docId": "kibRuleRegistryPluginApi", + "section": "def-server.LifecycleAlertServices", + "text": "LifecycleAlertServices" + }, + "; }" + ], + "path": "x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -1029,11 +1085,10 @@ ], "path": "x-pack/plugins/rule_registry/server/plugin.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "ruleRegistry", - "id": "def-server.req", + "id": "def-server.RuleRegistryPluginStartContract.getRacClientWithRequest.$1", "type": "Object", "tags": [], "label": "req", @@ -1049,9 +1104,11 @@ "" ], "path": "x-pack/plugins/rule_registry/server/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "ruleRegistry", diff --git a/api_docs/rule_registry.mdx b/api_docs/rule_registry.mdx index b3ae2722bb14e..2578475c2dc8e 100644 --- a/api_docs/rule_registry.mdx +++ b/api_docs/rule_registry.mdx @@ -18,7 +18,7 @@ import ruleRegistryObj from './rule_registry.json'; | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 60 | 0 | 60 | 9 | +| 62 | 0 | 62 | 9 | ## Server diff --git a/api_docs/runtime_fields.json b/api_docs/runtime_fields.json index 4a7eb5dd20c49..8348666426fa9 100644 --- a/api_docs/runtime_fields.json +++ b/api_docs/runtime_fields.json @@ -200,11 +200,10 @@ ], "path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "runtimeFields", - "id": "def-public.field", + "id": "def-public.Props.onSave.$1", "type": "Object", "tags": [], "label": "field", @@ -219,9 +218,11 @@ } ], "path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "runtimeFields", @@ -237,8 +238,8 @@ ], "path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "runtimeFields", diff --git a/api_docs/saved_objects.json b/api_docs/saved_objects.json index b7e931ee126eb..39fb367f066bd 100644 --- a/api_docs/saved_objects.json +++ b/api_docs/saved_objects.json @@ -1884,8 +1884,8 @@ ], "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "savedObjects", @@ -1934,7 +1934,24 @@ "((appId: string) => string | undefined) | undefined" ], "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "savedObjects", + "id": "def-public.OriginSaveModalProps.getAppNameFromId.$1", + "type": "string", + "tags": [], + "label": "appId", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "savedObjects", @@ -1997,8 +2014,8 @@ ], "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "savedObjects", @@ -2041,11 +2058,10 @@ ], "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "savedObjects", - "id": "def-public.props", + "id": "def-public.OriginSaveModalProps.onSave.$1", "type": "CompoundType", "tags": [], "label": "props", @@ -2061,9 +2077,11 @@ " & { returnToOrigin: boolean; }" ], "path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -2198,8 +2216,8 @@ ], "path": "src/plugins/saved_objects/public/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "savedObjects", @@ -2234,22 +2252,23 @@ ], "path": "src/plugins/saved_objects/public/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "savedObjects", - "id": "def-public.resp", + "id": "def-public.SavedObject.applyESResp.$1", "type": "Object", "tags": [], "label": "resp", "description": [], "signature": [ - "{ [x: string]: any; }" + "Record" ], "path": "src/plugins/saved_objects/public/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "savedObjects", @@ -2275,11 +2294,10 @@ ], "path": "src/plugins/saved_objects/public/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "savedObjects", - "id": "def-public.opts", + "id": "def-public.SavedObject.creationOpts.$1", "type": "Object", "tags": [], "label": "opts", @@ -2288,9 +2306,11 @@ "SavedObjectCreationOpts" ], "path": "src/plugins/saved_objects/public/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "savedObjects", @@ -2316,7 +2336,9 @@ "(() => Promise<{}>) | undefined" ], "path": "src/plugins/saved_objects/public/types.ts", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "savedObjects", @@ -2330,8 +2352,8 @@ ], "path": "src/plugins/saved_objects/public/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "savedObjects", @@ -2345,8 +2367,8 @@ ], "path": "src/plugins/saved_objects/public/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "savedObjects", @@ -2360,8 +2382,8 @@ ], "path": "src/plugins/saved_objects/public/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "savedObjects", @@ -2375,8 +2397,8 @@ ], "path": "src/plugins/saved_objects/public/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "savedObjects", @@ -2391,13 +2413,30 @@ "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" + "section": "def-common.IndexPattern", + "text": "IndexPattern" }, " | null>) | undefined" ], "path": "src/plugins/saved_objects/public/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "savedObjects", + "id": "def-public.SavedObject.hydrateIndexPattern.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/saved_objects/public/types.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] }, { "parentPluginId": "savedObjects", @@ -2431,7 +2470,9 @@ ">) | undefined" ], "path": "src/plugins/saved_objects/public/types.ts", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "savedObjects", @@ -2455,8 +2496,8 @@ ], "path": "src/plugins/saved_objects/public/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "savedObjects", @@ -2501,11 +2542,10 @@ ], "path": "src/plugins/saved_objects/public/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "savedObjects", - "id": "def-public.saveOptions", + "id": "def-public.SavedObject.save.$1", "type": "Object", "tags": [], "label": "saveOptions", @@ -2520,9 +2560,11 @@ } ], "path": "src/plugins/saved_objects/public/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "savedObjects", @@ -2639,7 +2681,30 @@ ">) | undefined" ], "path": "src/plugins/saved_objects/public/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "savedObjects", + "id": "def-public.SavedObjectConfig.afterESResp.$1", + "type": "Object", + "tags": [], + "label": "savedObject", + "description": [], + "signature": [ + { + "pluginId": "savedObjects", + "scope": "public", + "docId": "kibSavedObjectsPluginApi", + "section": "def-public.SavedObject", + "text": "SavedObject" + } + ], + "path": "src/plugins/saved_objects/public/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "savedObjects", @@ -2669,7 +2734,24 @@ ") | undefined" ], "path": "src/plugins/saved_objects/public/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "savedObjects", + "id": "def-public.SavedObjectConfig.extractReferences.$1", + "type": "Object", + "tags": [], + "label": "opts", + "description": [], + "signature": [ + "SavedObjectAttributesAndRefs" + ], + "path": "src/plugins/saved_objects/public/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "savedObjects", @@ -2692,7 +2774,39 @@ "[]) => void) | undefined" ], "path": "src/plugins/saved_objects/public/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "savedObjects", + "id": "def-public.SavedObjectConfig.injectReferences.$1", + "type": "Uncategorized", + "tags": [], + "label": "object", + "description": [], + "signature": [ + "T" + ], + "path": "src/plugins/saved_objects/public/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "savedObjects", + "id": "def-public.SavedObjectConfig.injectReferences.$2", + "type": "Array", + "tags": [], + "label": "references", + "description": [], + "signature": [ + "SavedObjectReference", + "[]" + ], + "path": "src/plugins/saved_objects/public/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "savedObjects", @@ -2718,7 +2832,9 @@ "(() => void) | undefined" ], "path": "src/plugins/saved_objects/public/types.ts", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "savedObjects", @@ -2732,8 +2848,8 @@ "pluginId": "data", "scope": "common", "docId": "kibDataIndexPatternsPluginApi", - "section": "def-common.IIndexPattern", - "text": "IIndexPattern" + "section": "def-common.IndexPattern", + "text": "IndexPattern" }, " | undefined" ], @@ -2875,11 +2991,10 @@ ], "path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "savedObjects", - "id": "def-public.config", + "id": "def-public.SavedObjectDecorator.decorateConfig.$1", "type": "Object", "tags": [], "label": "config", @@ -2894,9 +3009,11 @@ } ], "path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "savedObjects", @@ -2912,11 +3029,10 @@ ], "path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "savedObjects", - "id": "def-public.object", + "id": "def-public.SavedObjectDecorator.decorateObject.$1", "type": "Uncategorized", "tags": [], "label": "object", @@ -2925,9 +3041,11 @@ "T" ], "path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -3363,7 +3481,9 @@ "(() => void) | undefined" ], "path": "src/plugins/saved_objects/public/types.ts", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "savedObjects", @@ -3507,6 +3627,22 @@ ], "path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "savedObjects", + "id": "def-public.services", + "type": "Object", + "tags": [], + "label": "services", + "description": [], + "signature": [ + "SavedObjectKibanaServices" + ], + "path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -3644,11 +3780,10 @@ ], "path": "src/plugins/saved_objects/public/plugin.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "savedObjects", - "id": "def-public.config", + "id": "def-public.SavedObjectSetup.registerDecorator.$1", "type": "Object", "tags": [], "label": "config", @@ -3664,9 +3799,11 @@ "" ], "path": "src/plugins/saved_objects/public/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "lifecycle": "setup", diff --git a/api_docs/saved_objects.mdx b/api_docs/saved_objects.mdx index 0e64b52cbe31f..4a7bf6ae82e75 100644 --- a/api_docs/saved_objects.mdx +++ b/api_docs/saved_objects.mdx @@ -18,7 +18,7 @@ import savedObjectsObj from './saved_objects.json'; | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 213 | 3 | 199 | 5 | +| 220 | 3 | 206 | 5 | ## Client diff --git a/api_docs/saved_objects_management.json b/api_docs/saved_objects_management.json index b8e43a3836071..d7d19f1dfdfba 100644 --- a/api_docs/saved_objects_management.json +++ b/api_docs/saved_objects_management.json @@ -710,11 +710,10 @@ ], "path": "src/plugins/saved_objects_management/public/services/action_service.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "savedObjectsManagement", - "id": "def-public.action", + "id": "def-public.SavedObjectsManagementActionServiceSetup.register.$1", "type": "Object", "tags": [], "label": "action", @@ -729,9 +728,11 @@ } ], "path": "src/plugins/saved_objects_management/public/services/action_service.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -760,19 +761,23 @@ ], "path": "src/plugins/saved_objects_management/public/services/action_service.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "savedObjectsManagement", - "id": "def-public.actionId", + "id": "def-public.SavedObjectsManagementActionServiceStart.has.$1", "type": "string", "tags": [], "label": "actionId", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/saved_objects_management/public/services/action_service.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "savedObjectsManagement", @@ -796,8 +801,8 @@ ], "path": "src/plugins/saved_objects_management/public/services/action_service.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -906,11 +911,10 @@ ], "path": "src/plugins/saved_objects_management/public/services/column_service.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "savedObjectsManagement", - "id": "def-public.column", + "id": "def-public.SavedObjectsManagementColumnServiceSetup.register.$1", "type": "Object", "tags": [], "label": "column", @@ -926,9 +930,11 @@ "" ], "path": "src/plugins/saved_objects_management/public/services/column_service.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -965,8 +971,8 @@ ], "path": "src/plugins/saved_objects_management/public/services/column_service.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false diff --git a/api_docs/saved_objects_tagging_oss.json b/api_docs/saved_objects_tagging_oss.json index a7b52b9355b11..eb9d9a733dced 100644 --- a/api_docs/saved_objects_tagging_oss.json +++ b/api_docs/saved_objects_tagging_oss.json @@ -253,11 +253,10 @@ ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "savedObjectsTaggingOss", - "id": "def-public.ids", + "id": "def-public.SavedObjectSaveModalTagSelectorComponentProps.onTagsSelected.$1", "type": "Array", "tags": [], "label": "ids", @@ -266,9 +265,11 @@ "string[]" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -1037,11 +1038,10 @@ ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "savedObjectsTaggingOss", - "id": "def-public.ids", + "id": "def-public.TagSelectorComponentProps.onTagsSelected.$1", "type": "Array", "tags": [], "label": "ids", @@ -1050,9 +1050,11 @@ "string[]" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -1087,6 +1089,28 @@ ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "savedObjectsTaggingOss", + "id": "def-public.object", + "type": "Object", + "tags": [], + "label": "object", + "description": [], + "signature": [ + { + "pluginId": "savedObjects", + "scope": "public", + "docId": "kibSavedObjectsPluginApi", + "section": "def-public.SavedObject", + "text": "SavedObject" + } + ], + "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { diff --git a/api_docs/saved_objects_tagging_oss.mdx b/api_docs/saved_objects_tagging_oss.mdx index 407c9244349aa..1d3d0934c97ab 100644 --- a/api_docs/saved_objects_tagging_oss.mdx +++ b/api_docs/saved_objects_tagging_oss.mdx @@ -18,7 +18,7 @@ import savedObjectsTaggingOssObj from './saved_objects_tagging_oss.json'; | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 89 | 3 | 50 | 0 | +| 90 | 3 | 51 | 0 | ## Client diff --git a/api_docs/screenshot_mode.json b/api_docs/screenshot_mode.json index 14203cc4c3c4c..14e2ad501bbbf 100644 --- a/api_docs/screenshot_mode.json +++ b/api_docs/screenshot_mode.json @@ -232,8 +232,8 @@ ], "path": "src/plugins/screenshot_mode/server/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "lifecycle": "setup", diff --git a/api_docs/security.json b/api_docs/security.json index f0a93cc5e6753..5a88090ecf980 100644 --- a/api_docs/security.json +++ b/api_docs/security.json @@ -119,8 +119,8 @@ ], "path": "x-pack/plugins/security/public/authentication/authentication_service.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "security", @@ -136,8 +136,8 @@ ], "path": "x-pack/plugins/security/public/authentication/authentication_service.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -446,8 +446,8 @@ ], "path": "x-pack/plugins/security/public/nav_control/nav_control_service.tsx", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "security", @@ -471,11 +471,10 @@ ], "path": "x-pack/plugins/security/public/nav_control/nav_control_service.tsx", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "security", - "id": "def-public.newUserMenuLink", + "id": "def-public.SecurityNavControlServiceStart.addUserMenuLinks.$1", "type": "Array", "tags": [], "label": "newUserMenuLink", @@ -491,9 +490,11 @@ "[]" ], "path": "x-pack/plugins/security/public/nav_control/nav_control_service.tsx", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -808,11 +809,10 @@ ], "path": "x-pack/plugins/security/server/audit/audit_service.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "security", - "id": "def-server.event", + "id": "def-server.AuditLogger.log.$1", "type": "Object", "tags": [], "label": "event", @@ -828,9 +828,11 @@ " | undefined" ], "path": "x-pack/plugins/security/server/audit/audit_service.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -872,11 +874,10 @@ ], "path": "x-pack/plugins/security/server/audit/audit_service.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "security", - "id": "def-server.request", + "id": "def-server.AuditServiceSetup.asScoped.$1", "type": "Object", "tags": [], "label": "request", @@ -892,9 +893,11 @@ "" ], "path": "x-pack/plugins/security/server/audit/audit_service.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "security", @@ -915,11 +918,10 @@ ], "path": "x-pack/plugins/security/server/audit/audit_service.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "security", - "id": "def-server.id", + "id": "def-server.AuditServiceSetup.getLogger.$1", "type": "string", "tags": [], "label": "id", @@ -928,9 +930,11 @@ "string | undefined" ], "path": "x-pack/plugins/security/server/audit/audit_service.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -1147,11 +1151,10 @@ ], "path": "x-pack/plugins/security/server/authentication/authentication_service.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "security", - "id": "def-server.request", + "id": "def-server.AuthenticationServiceStart.getCurrentUser.$1", "type": "Object", "tags": [], "label": "request", @@ -1167,9 +1170,11 @@ "" ], "path": "x-pack/plugins/security/server/authentication/authentication_service.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -1494,31 +1499,38 @@ ], "path": "x-pack/plugins/security/server/audit/audit_service.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "security", - "id": "def-server.eventType", + "id": "def-server.LegacyAuditLogger.log.$1", "type": "string", "tags": [], "label": "eventType", "description": [], + "signature": [ + "string" + ], "path": "x-pack/plugins/security/server/audit/audit_service.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "security", - "id": "def-server.message", + "id": "def-server.LegacyAuditLogger.log.$2", "type": "string", "tags": [], "label": "message", "description": [], + "signature": [ + "string" + ], "path": "x-pack/plugins/security/server/audit/audit_service.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "security", - "id": "def-server.data", + "id": "def-server.LegacyAuditLogger.log.$3", "type": "Object", "tags": [], "label": "data", @@ -1527,9 +1539,11 @@ "Record | undefined" ], "path": "x-pack/plugins/security/server/audit/audit_service.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] } ], "initialIsOpen": false diff --git a/api_docs/security_oss.json b/api_docs/security_oss.json index 1953d10c3f396..601563752d47d 100644 --- a/api_docs/security_oss.json +++ b/api_docs/security_oss.json @@ -126,11 +126,10 @@ ], "path": "src/plugins/security_oss/server/plugin.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "securityOss", - "id": "def-server.provider", + "id": "def-server.SecurityOssPluginSetup.setAnonymousAccessServiceProvider.$1", "type": "Function", "tags": [], "label": "provider", @@ -140,9 +139,11 @@ "AnonymousAccessService" ], "path": "src/plugins/security_oss/server/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "lifecycle": "setup", diff --git a/api_docs/security_solution.json b/api_docs/security_solution.json index 2db97ed3a6e65..7fff8eb0a2172 100644 --- a/api_docs/security_solution.json +++ b/api_docs/security_solution.json @@ -349,8 +349,8 @@ ], "path": "x-pack/plugins/security_solution/public/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "lifecycle": "setup", @@ -707,8 +707,8 @@ ], "path": "x-pack/plugins/security_solution/server/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -1079,8 +1079,8 @@ ], "path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "securitySolution", @@ -1195,7 +1195,9 @@ "(() => void) | undefined" ], "path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "securitySolution", @@ -1208,7 +1210,9 @@ "(() => void) | undefined" ], "path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "securitySolution", @@ -1264,7 +1268,9 @@ "(() => void) | undefined" ], "path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -2627,21 +2633,24 @@ ], "path": "x-pack/plugins/timelines/common/types/timeline/columns/index.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "securitySolution", - "id": "def-common.columnName", + "id": "def-common.ColumnRenderer.isInstance.$1", "type": "string", "tags": [], "label": "columnName", "description": [], + "signature": [ + "string" + ], "path": "x-pack/plugins/timelines/common/types/timeline/columns/index.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "securitySolution", - "id": "def-common.data", + "id": "def-common.ColumnRenderer.isInstance.$2", "type": "Array", "tags": [], "label": "data", @@ -2657,9 +2666,11 @@ "[]" ], "path": "x-pack/plugins/timelines/common/types/timeline/columns/index.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "securitySolution", @@ -2681,30 +2692,115 @@ ], "path": "x-pack/plugins/timelines/common/types/timeline/columns/index.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "securitySolution", - "id": "def-common.__0", + "id": "def-common.ColumnRenderer.renderColumn.$1.columnNameeventIdfieldtimelineIdtruncatevalueslinkValues", "type": "Object", "tags": [], - "label": "__0", + "label": "{\n columnName,\n eventId,\n field,\n timelineId,\n truncate,\n values,\n linkValues,\n }", "description": [], - "signature": [ - "{ columnName: string; eventId: string; field: ", + "path": "x-pack/plugins/timelines/common/types/timeline/columns/index.ts", + "deprecated": false, + "children": [ { - "pluginId": "timelines", - "scope": "common", - "docId": "kibTimelinesPluginApi", - "section": "def-common.ColumnHeaderOptions", - "text": "ColumnHeaderOptions" + "parentPluginId": "securitySolution", + "id": "def-common.ColumnRenderer.renderColumn.$1.columnNameeventIdfieldtimelineIdtruncatevalueslinkValues.columnName", + "type": "string", + "tags": [], + "label": "columnName", + "description": [], + "path": "x-pack/plugins/timelines/common/types/timeline/columns/index.ts", + "deprecated": false }, - "; timelineId: string; truncate?: boolean | undefined; values: string[] | null | undefined; linkValues?: string[] | null | undefined; }" - ], - "path": "x-pack/plugins/timelines/common/types/timeline/columns/index.ts", - "deprecated": false + { + "parentPluginId": "securitySolution", + "id": "def-common.ColumnRenderer.renderColumn.$1.columnNameeventIdfieldtimelineIdtruncatevalueslinkValues.eventId", + "type": "string", + "tags": [], + "label": "eventId", + "description": [], + "path": "x-pack/plugins/timelines/common/types/timeline/columns/index.ts", + "deprecated": false + }, + { + "parentPluginId": "securitySolution", + "id": "def-common.ColumnRenderer.renderColumn.$1.columnNameeventIdfieldtimelineIdtruncatevalueslinkValues.field", + "type": "CompoundType", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "Pick<", + "EuiDataGridColumn", + ", \"id\" | \"display\" | \"displayAsText\" | \"initialWidth\"> & { aggregatable?: boolean | undefined; category?: string | undefined; columnHeaderType: ", + { + "pluginId": "timelines", + "scope": "common", + "docId": "kibTimelinesPluginApi", + "section": "def-common.ColumnHeaderType", + "text": "ColumnHeaderType" + }, + "; description?: string | undefined; example?: string | undefined; format?: string | undefined; linkField?: string | undefined; placeholder?: string | undefined; subType?: ", + "IFieldSubType", + " | undefined; type?: string | undefined; }" + ], + "path": "x-pack/plugins/timelines/common/types/timeline/columns/index.ts", + "deprecated": false + }, + { + "parentPluginId": "securitySolution", + "id": "def-common.ColumnRenderer.renderColumn.$1.columnNameeventIdfieldtimelineIdtruncatevalueslinkValues.timelineId", + "type": "string", + "tags": [], + "label": "timelineId", + "description": [], + "path": "x-pack/plugins/timelines/common/types/timeline/columns/index.ts", + "deprecated": false + }, + { + "parentPluginId": "securitySolution", + "id": "def-common.ColumnRenderer.renderColumn.$1.columnNameeventIdfieldtimelineIdtruncatevalueslinkValues.truncate", + "type": "CompoundType", + "tags": [], + "label": "truncate", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/timelines/common/types/timeline/columns/index.ts", + "deprecated": false + }, + { + "parentPluginId": "securitySolution", + "id": "def-common.ColumnRenderer.renderColumn.$1.columnNameeventIdfieldtimelineIdtruncatevalueslinkValues.values", + "type": "CompoundType", + "tags": [], + "label": "values", + "description": [], + "signature": [ + "string[] | null | undefined" + ], + "path": "x-pack/plugins/timelines/common/types/timeline/columns/index.ts", + "deprecated": false + }, + { + "parentPluginId": "securitySolution", + "id": "def-common.ColumnRenderer.renderColumn.$1.columnNameeventIdfieldtimelineIdtruncatevalueslinkValues.linkValues", + "type": "CompoundType", + "tags": [], + "label": "linkValues", + "description": [], + "signature": [ + "string[] | null | undefined" + ], + "path": "x-pack/plugins/timelines/common/types/timeline/columns/index.ts", + "deprecated": false + } + ] } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -4973,22 +5069,31 @@ ], "path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "securitySolution", - "id": "def-common.__0", + "id": "def-common.HeaderActionProps.onSelectAll.$1.isSelected", "type": "Object", "tags": [], - "label": "__0", + "label": "{ isSelected }", "description": [], - "signature": [ - "{ isSelected: boolean; }" - ], "path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "securitySolution", + "id": "def-common.HeaderActionProps.onSelectAll.$1.isSelected.isSelected", + "type": "boolean", + "tags": [], + "label": "isSelected", + "description": [], + "path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts", + "deprecated": false + } + ] } - ] + ], + "returnComment": [] }, { "parentPluginId": "securitySolution", @@ -9265,11 +9370,10 @@ ], "path": "x-pack/plugins/security_solution/common/search_strategy/security_solution/matrix_histogram/index.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "securitySolution", - "id": "def-common.options", + "id": "def-common.MatrixHistogramSchema.buildDsl.$1", "type": "Object", "tags": [], "label": "options", @@ -9284,9 +9388,11 @@ } ], "path": "x-pack/plugins/security_solution/common/search_strategy/security_solution/matrix_histogram/index.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "securitySolution", @@ -9335,7 +9441,45 @@ "[]) | undefined" ], "path": "x-pack/plugins/security_solution/common/search_strategy/security_solution/matrix_histogram/index.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "securitySolution", + "id": "def-common.MatrixHistogramSchema.parser.$1", + "type": "Uncategorized", + "tags": [], + "label": "data", + "description": [], + "signature": [ + { + "pluginId": "securitySolution", + "scope": "common", + "docId": "kibSecuritySolutionPluginApi", + "section": "def-common.MatrixHistogramParseData", + "text": "MatrixHistogramParseData" + }, + "" + ], + "path": "x-pack/plugins/security_solution/common/search_strategy/security_solution/matrix_histogram/index.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "securitySolution", + "id": "def-common.MatrixHistogramSchema.parser.$2", + "type": "string", + "tags": [], + "label": "keyBucket", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/security_solution/common/search_strategy/security_solution/matrix_histogram/index.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -14320,11 +14464,10 @@ ], "path": "x-pack/plugins/timelines/common/types/timeline/rows/index.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "securitySolution", - "id": "def-common.data", + "id": "def-common.RowRenderer.isInstance.$1", "type": "Object", "tags": [], "label": "data", @@ -14333,9 +14476,11 @@ "Ecs" ], "path": "x-pack/plugins/timelines/common/types/timeline/rows/index.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "securitySolution", @@ -14359,32 +14504,75 @@ ], "path": "x-pack/plugins/timelines/common/types/timeline/rows/index.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "securitySolution", - "id": "def-common.__0", + "id": "def-common.RowRenderer.renderRow.$1.browserFieldsdataisDraggabletimelineId", "type": "Object", "tags": [], - "label": "__0", + "label": "{\n browserFields,\n data,\n isDraggable,\n timelineId,\n }", "description": [], - "signature": [ - "{ browserFields: Readonly; }" + ], + "path": "x-pack/plugins/timelines/common/types/timeline/rows/index.ts", + "deprecated": false }, - ">>>; data: ", - "Ecs", - "; isDraggable: boolean; timelineId: string; }" - ], - "path": "x-pack/plugins/timelines/common/types/timeline/rows/index.ts", - "deprecated": false + { + "parentPluginId": "securitySolution", + "id": "def-common.RowRenderer.renderRow.$1.browserFieldsdataisDraggabletimelineId.data", + "type": "Object", + "tags": [], + "label": "data", + "description": [], + "signature": [ + "Ecs" + ], + "path": "x-pack/plugins/timelines/common/types/timeline/rows/index.ts", + "deprecated": false + }, + { + "parentPluginId": "securitySolution", + "id": "def-common.RowRenderer.renderRow.$1.browserFieldsdataisDraggabletimelineId.isDraggable", + "type": "boolean", + "tags": [], + "label": "isDraggable", + "description": [], + "path": "x-pack/plugins/timelines/common/types/timeline/rows/index.ts", + "deprecated": false + }, + { + "parentPluginId": "securitySolution", + "id": "def-common.RowRenderer.renderRow.$1.browserFieldsdataisDraggabletimelineId.timelineId", + "type": "string", + "tags": [], + "label": "timelineId", + "description": [], + "path": "x-pack/plugins/timelines/common/types/timeline/rows/index.ts", + "deprecated": false + } + ] } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -16330,7 +16518,8 @@ "label": "filters", "description": [], "signature": [ - "any[] | undefined" + "Filter", + "[] | undefined" ], "path": "x-pack/plugins/security_solution/common/types/timeline/store.ts", "deprecated": false @@ -19902,6 +20091,19 @@ ], "path": "x-pack/plugins/security_solution/common/types/timeline/store.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "securitySolution", + "id": "def-common.nextPage", + "type": "number", + "tags": [], + "label": "nextPage", + "description": [], + "path": "x-pack/plugins/security_solution/common/types/timeline/store.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -19916,6 +20118,19 @@ ], "path": "x-pack/plugins/security_solution/common/types/timeline/store.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "securitySolution", + "id": "def-common.columnId", + "type": "string", + "tags": [], + "label": "columnId", + "description": [], + "path": "x-pack/plugins/security_solution/common/types/timeline/store.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -19930,6 +20145,22 @@ ], "path": "x-pack/plugins/security_solution/common/types/timeline/store.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "securitySolution", + "id": "def-common.__0", + "type": "Object", + "tags": [], + "label": "__0", + "description": [], + "signature": [ + "{ columnId: string; delta: number; }" + ], + "path": "x-pack/plugins/security_solution/common/types/timeline/store.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -19954,6 +20185,30 @@ ], "path": "x-pack/plugins/security_solution/common/types/timeline/store.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "securitySolution", + "id": "def-common.sorted", + "type": "Object", + "tags": [], + "label": "sorted", + "description": [], + "signature": [ + "{ columnId: string; sortDirection: ", + { + "pluginId": "securitySolution", + "scope": "common", + "docId": "kibSecuritySolutionPluginApi", + "section": "def-common.SortDirection", + "text": "SortDirection" + }, + "; }" + ], + "path": "x-pack/plugins/security_solution/common/types/timeline/store.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -19976,6 +20231,30 @@ ], "path": "x-pack/plugins/security_solution/common/types/timeline/store.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "securitySolution", + "id": "def-common.sorted", + "type": "Array", + "tags": [], + "label": "sorted", + "description": [], + "signature": [ + "{ columnId: string; sortDirection: ", + { + "pluginId": "securitySolution", + "scope": "common", + "docId": "kibSecuritySolutionPluginApi", + "section": "def-common.SortDirection", + "text": "SortDirection" + }, + "; }[]" + ], + "path": "x-pack/plugins/security_solution/common/types/timeline/store.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -19992,6 +20271,19 @@ ], "path": "x-pack/plugins/security_solution/common/types/timeline/store.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "securitySolution", + "id": "def-common.eventId", + "type": "string", + "tags": [], + "label": "eventId", + "description": [], + "path": "x-pack/plugins/security_solution/common/types/timeline/store.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -20008,6 +20300,22 @@ ], "path": "x-pack/plugins/security_solution/common/types/timeline/store.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "securitySolution", + "id": "def-common.__0", + "type": "Object", + "tags": [], + "label": "__0", + "description": [], + "signature": [ + "{ eventIds: string[]; isSelected: boolean; }" + ], + "path": "x-pack/plugins/security_solution/common/types/timeline/store.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -20024,6 +20332,22 @@ ], "path": "x-pack/plugins/security_solution/common/types/timeline/store.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "securitySolution", + "id": "def-common.__0", + "type": "Object", + "tags": [], + "label": "__0", + "description": [], + "signature": [ + "{ isSelected: boolean; }" + ], + "path": "x-pack/plugins/security_solution/common/types/timeline/store.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -20040,6 +20364,19 @@ ], "path": "x-pack/plugins/security_solution/common/types/timeline/store.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "securitySolution", + "id": "def-common.eventId", + "type": "string", + "tags": [], + "label": "eventId", + "description": [], + "path": "x-pack/plugins/security_solution/common/types/timeline/store.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -20064,6 +20401,29 @@ ], "path": "x-pack/plugins/security_solution/common/types/timeline/store.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "securitySolution", + "id": "def-common.columns", + "type": "Array", + "tags": [], + "label": "columns", + "description": [], + "signature": [ + { + "pluginId": "timelines", + "scope": "common", + "docId": "kibTimelinesPluginApi", + "section": "def-common.ColumnHeaderOptions", + "text": "ColumnHeaderOptions" + }, + "[]" + ], + "path": "x-pack/plugins/security_solution/common/types/timeline/store.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { diff --git a/api_docs/security_solution.mdx b/api_docs/security_solution.mdx index c61a6e7d8e28f..fe1ba0f7b06e8 100644 --- a/api_docs/security_solution.mdx +++ b/api_docs/security_solution.mdx @@ -18,7 +18,7 @@ import securitySolutionObj from './security_solution.json'; | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 1298 | 8 | 1247 | 27 | +| 1322 | 8 | 1271 | 27 | ## Client diff --git a/api_docs/share.json b/api_docs/share.json index dbb9000b6d1ea..d9b0ba64d94ce 100644 --- a/api_docs/share.json +++ b/api_docs/share.json @@ -852,11 +852,10 @@ ], "path": "src/plugins/share/common/url_service/locators/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "share", - "id": "def-public.params", + "id": "def-public.LocatorPublic.useUrl.$1", "type": "Uncategorized", "tags": [], "label": "params", @@ -865,11 +864,12 @@ "P" ], "path": "src/plugins/share/common/url_service/locators/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "share", - "id": "def-public.getUrlParams", + "id": "def-public.LocatorPublic.useUrl.$2", "type": "Object", "tags": [], "label": "getUrlParams", @@ -879,11 +879,12 @@ " | undefined" ], "path": "src/plugins/share/common/url_service/locators/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": false }, { "parentPluginId": "share", - "id": "def-public.deps", + "id": "def-public.LocatorPublic.useUrl.$3", "type": "Object", "tags": [], "label": "deps", @@ -892,9 +893,11 @@ "React.DependencyList | undefined" ], "path": "src/plugins/share/common/url_service/locators/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -979,8 +982,8 @@ ], "path": "src/plugins/share/public/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "share", @@ -995,7 +998,24 @@ ") => boolean) | undefined" ], "path": "src/plugins/share/public/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "share", + "id": "def-public.ShareContext.showPublicUrlSwitch.$1", + "type": "Object", + "tags": [], + "label": "anonymousUserCapabilities", + "description": [], + "signature": [ + "Capabilities" + ], + "path": "src/plugins/share/public/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -1141,11 +1161,10 @@ ], "path": "src/plugins/share/public/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "share", - "id": "def-public.context", + "id": "def-public.ShareMenuProvider.getShareMenuItems.$1", "type": "Object", "tags": [], "label": "context", @@ -1160,9 +1179,11 @@ } ], "path": "src/plugins/share/public/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -1449,7 +1470,31 @@ "[Id][\"State\"]) => Promise) | undefined" ], "path": "src/plugins/share/public/url_generators/url_generator_definition.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "share", + "id": "def-public.UrlGeneratorsDefinition.createUrl.$1", + "type": "Uncategorized", + "tags": [], + "label": "state", + "description": [], + "signature": [ + { + "pluginId": "share", + "scope": "public", + "docId": "kibSharePluginApi", + "section": "def-public.UrlGeneratorStateMapping", + "text": "UrlGeneratorStateMapping" + }, + "[Id][\"State\"]" + ], + "path": "src/plugins/share/public/url_generators/url_generator_definition.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "share", @@ -1499,7 +1544,31 @@ "[Id][\"MigratedId\"]; }>) | undefined" ], "path": "src/plugins/share/public/url_generators/url_generator_definition.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "share", + "id": "def-public.UrlGeneratorsDefinition.migrate.$1", + "type": "Uncategorized", + "tags": [], + "label": "state", + "description": [], + "signature": [ + { + "pluginId": "share", + "scope": "public", + "docId": "kibSharePluginApi", + "section": "def-public.UrlGeneratorStateMapping", + "text": "UrlGeneratorStateMapping" + }, + "[Id][\"State\"]" + ], + "path": "src/plugins/share/public/url_generators/url_generator_definition.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -2172,11 +2241,10 @@ ], "path": "src/plugins/share/common/url_service/locators/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "share", - "id": "def-common.params", + "id": "def-common.LocatorPublic.useUrl.$1", "type": "Uncategorized", "tags": [], "label": "params", @@ -2185,11 +2253,12 @@ "P" ], "path": "src/plugins/share/common/url_service/locators/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "share", - "id": "def-common.getUrlParams", + "id": "def-common.LocatorPublic.useUrl.$2", "type": "Object", "tags": [], "label": "getUrlParams", @@ -2199,11 +2268,12 @@ " | undefined" ], "path": "src/plugins/share/common/url_service/locators/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": false }, { "parentPluginId": "share", - "id": "def-common.deps", + "id": "def-common.LocatorPublic.useUrl.$3", "type": "Object", "tags": [], "label": "deps", @@ -2212,9 +2282,11 @@ "React.DependencyList | undefined" ], "path": "src/plugins/share/common/url_service/locators/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] } ], "initialIsOpen": false diff --git a/api_docs/share.mdx b/api_docs/share.mdx index 7f6906c4a745c..3200c951b36e4 100644 --- a/api_docs/share.mdx +++ b/api_docs/share.mdx @@ -18,7 +18,7 @@ import shareObj from './share.json'; | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 123 | 1 | 83 | 8 | +| 126 | 1 | 86 | 8 | ## Client diff --git a/api_docs/spaces.json b/api_docs/spaces.json index 457b311d6ad17..e9a754f74bdda 100644 --- a/api_docs/spaces.json +++ b/api_docs/spaces.json @@ -1394,11 +1394,10 @@ ], "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "spaces", - "id": "def-server.request", + "id": "def-server.SpacesServiceStart.createSpacesClient.$1", "type": "Object", "tags": [], "label": "request", @@ -1416,9 +1415,11 @@ "" ], "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "spaces", @@ -1705,6 +1706,48 @@ ], "path": "x-pack/plugins/spaces/server/spaces_client/spaces_client_service.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "spaces", + "id": "def-server.request", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "x-pack/plugins/spaces/server/spaces_client/spaces_client_service.ts", + "deprecated": false + }, + { + "parentPluginId": "spaces", + "id": "def-server.savedObjectsStart", + "type": "Object", + "tags": [], + "label": "savedObjectsStart", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsServiceStart", + "text": "SavedObjectsServiceStart" + } + ], + "path": "x-pack/plugins/spaces/server/spaces_client/spaces_client_service.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -1746,6 +1789,48 @@ ], "path": "x-pack/plugins/spaces/server/spaces_client/spaces_client_service.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "spaces", + "id": "def-server.request", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "x-pack/plugins/spaces/server/spaces_client/spaces_client_service.ts", + "deprecated": false + }, + { + "parentPluginId": "spaces", + "id": "def-server.baseClient", + "type": "Object", + "tags": [], + "label": "baseClient", + "description": [], + "signature": [ + { + "pluginId": "spaces", + "scope": "server", + "docId": "kibSpacesPluginApi", + "section": "def-server.ISpacesClient", + "text": "ISpacesClient" + } + ], + "path": "x-pack/plugins/spaces/server/spaces_client/spaces_client_service.ts", + "deprecated": false + } + ], "initialIsOpen": false } ], diff --git a/api_docs/spaces.mdx b/api_docs/spaces.mdx index 9f724afd37a6e..b723b3c72288c 100644 --- a/api_docs/spaces.mdx +++ b/api_docs/spaces.mdx @@ -18,7 +18,7 @@ Contact [Platform Security](https://github.com/orgs/elastic/teams/kibana-securit | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 106 | 0 | 0 | 0 | +| 110 | 0 | 4 | 0 | ## Client diff --git a/api_docs/spaces_oss.json b/api_docs/spaces_oss.json index b480af5d380f6..cd59756b548b6 100644 --- a/api_docs/spaces_oss.json +++ b/api_docs/spaces_oss.json @@ -191,7 +191,52 @@ "((objects: { type: string; id: string; }[], spacesToAdd: string[], spacesToRemove: string[]) => Promise) | undefined" ], "path": "src/plugins/spaces_oss/public/api.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "spacesOss", + "id": "def-public.ShareToSpaceFlyoutProps.changeSpacesHandler.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [], + "signature": [ + "{ type: string; id: string; }[]" + ], + "path": "src/plugins/spaces_oss/public/api.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "spacesOss", + "id": "def-public.ShareToSpaceFlyoutProps.changeSpacesHandler.$2", + "type": "Array", + "tags": [], + "label": "spacesToAdd", + "description": [], + "signature": [ + "string[]" + ], + "path": "src/plugins/spaces_oss/public/api.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "spacesOss", + "id": "def-public.ShareToSpaceFlyoutProps.changeSpacesHandler.$3", + "type": "Array", + "tags": [], + "label": "spacesToRemove", + "description": [], + "signature": [ + "string[]" + ], + "path": "src/plugins/spaces_oss/public/api.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "spacesOss", @@ -206,7 +251,24 @@ "((updatedObjects: { type: string; id: string; }[]) => void) | undefined" ], "path": "src/plugins/spaces_oss/public/api.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "spacesOss", + "id": "def-public.ShareToSpaceFlyoutProps.onUpdate.$1", + "type": "Array", + "tags": [], + "label": "updatedObjects", + "description": [], + "signature": [ + "{ type: string; id: string; }[]" + ], + "path": "src/plugins/spaces_oss/public/api.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "spacesOss", @@ -221,7 +283,9 @@ "(() => void) | undefined" ], "path": "src/plugins/spaces_oss/public/api.ts", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -610,23 +674,26 @@ ], "path": "src/plugins/spaces_oss/public/api.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "spacesOss", - "id": "def-public.path", + "id": "def-public.SpacesApiUi.redirectLegacyUrl.$1", "type": "string", "tags": [], "label": "path", "description": [ "The path to use for the new URL, optionally including `search` and/or `hash` URL components." ], + "signature": [ + "string" + ], "path": "src/plugins/spaces_oss/public/api.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "spacesOss", - "id": "def-public.objectNoun", + "id": "def-public.SpacesApiUi.redirectLegacyUrl.$2", "type": "string", "tags": [], "label": "objectNoun", @@ -637,9 +704,11 @@ "string | undefined" ], "path": "src/plugins/spaces_oss/public/api.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -982,6 +1051,22 @@ ], "path": "src/plugins/spaces_oss/public/api.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "spacesOss", + "id": "def-public.props", + "type": "Uncategorized", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "T" + ], + "path": "src/plugins/spaces_oss/public/api.ts", + "deprecated": false + } + ], "initialIsOpen": false } ], diff --git a/api_docs/spaces_oss.mdx b/api_docs/spaces_oss.mdx index fa7433a203333..d166a37a9373a 100644 --- a/api_docs/spaces_oss.mdx +++ b/api_docs/spaces_oss.mdx @@ -18,7 +18,7 @@ Contact [Platform Security](https://github.com/orgs/elastic/teams/kibana-securit | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 72 | 0 | 5 | 0 | +| 77 | 0 | 10 | 0 | ## Client diff --git a/api_docs/task_manager.json b/api_docs/task_manager.json index f3cbc0712713c..945a0ed5748e5 100644 --- a/api_docs/task_manager.json +++ b/api_docs/task_manager.json @@ -883,6 +883,28 @@ ], "path": "x-pack/plugins/task_manager/server/task.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "taskManager", + "id": "def-server.context", + "type": "Object", + "tags": [], + "label": "context", + "description": [], + "signature": [ + { + "pluginId": "taskManager", + "scope": "server", + "docId": "kibTaskManagerPluginApi", + "section": "def-server.RunContext", + "text": "RunContext" + } + ], + "path": "x-pack/plugins/task_manager/server/task.ts", + "deprecated": false + } + ], "initialIsOpen": false } ], diff --git a/api_docs/task_manager.mdx b/api_docs/task_manager.mdx index f3d8befa755c2..df7ad2605d035 100644 --- a/api_docs/task_manager.mdx +++ b/api_docs/task_manager.mdx @@ -18,7 +18,7 @@ import taskManagerObj from './task_manager.json'; | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 52 | 0 | 25 | 8 | +| 53 | 0 | 26 | 8 | ## Server diff --git a/api_docs/telemetry.json b/api_docs/telemetry.json index e535cabee297a..cf1bb4c629343 100644 --- a/api_docs/telemetry.json +++ b/api_docs/telemetry.json @@ -165,8 +165,8 @@ ], "path": "src/plugins/telemetry/public/plugin.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "telemetry", @@ -194,8 +194,8 @@ ], "path": "src/plugins/telemetry/public/plugin.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "telemetry", @@ -211,8 +211,8 @@ ], "path": "src/plugins/telemetry/public/plugin.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "telemetry", @@ -228,8 +228,8 @@ ], "path": "src/plugins/telemetry/public/plugin.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "telemetry", @@ -245,21 +245,25 @@ ], "path": "src/plugins/telemetry/public/plugin.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "telemetry", - "id": "def-public.optedIn", + "id": "def-public.TelemetryServicePublicApis.setOptIn.$1", "type": "boolean", "tags": [], "label": "optedIn", "description": [ "Whether the user is opting-in (`true`) or out (`false`)." ], + "signature": [ + "boolean" + ], "path": "src/plugins/telemetry/public/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -661,8 +665,8 @@ ], "path": "src/plugins/telemetry/server/plugin.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "lifecycle": "setup", @@ -694,8 +698,8 @@ ], "path": "src/plugins/telemetry/server/plugin.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] } ], "lifecycle": "start", diff --git a/api_docs/telemetry_collection_manager.json b/api_docs/telemetry_collection_manager.json index d5f11a5861d36..e962a772e84da 100644 --- a/api_docs/telemetry_collection_manager.json +++ b/api_docs/telemetry_collection_manager.json @@ -533,6 +533,47 @@ ], "path": "src/plugins/telemetry_collection_manager/server/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "telemetryCollectionManager", + "id": "def-server.config", + "type": "Object", + "tags": [], + "label": "config", + "description": [], + "signature": [ + { + "pluginId": "telemetryCollectionManager", + "scope": "server", + "docId": "kibTelemetryCollectionManagerPluginApi", + "section": "def-server.StatsCollectionConfig", + "text": "StatsCollectionConfig" + } + ], + "path": "src/plugins/telemetry_collection_manager/server/types.ts", + "deprecated": false + }, + { + "parentPluginId": "telemetryCollectionManager", + "id": "def-server.context", + "type": "Object", + "tags": [], + "label": "context", + "description": [], + "signature": [ + { + "pluginId": "telemetryCollectionManager", + "scope": "server", + "docId": "kibTelemetryCollectionManagerPluginApi", + "section": "def-server.StatsCollectionContext", + "text": "StatsCollectionContext" + } + ], + "path": "src/plugins/telemetry_collection_manager/server/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -571,6 +612,67 @@ ], "path": "src/plugins/telemetry_collection_manager/server/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "telemetryCollectionManager", + "id": "def-server.clustersDetails", + "type": "Array", + "tags": [], + "label": "clustersDetails", + "description": [], + "signature": [ + { + "pluginId": "telemetryCollectionManager", + "scope": "server", + "docId": "kibTelemetryCollectionManagerPluginApi", + "section": "def-server.ClusterDetails", + "text": "ClusterDetails" + }, + "[]" + ], + "path": "src/plugins/telemetry_collection_manager/server/types.ts", + "deprecated": false + }, + { + "parentPluginId": "telemetryCollectionManager", + "id": "def-server.config", + "type": "Object", + "tags": [], + "label": "config", + "description": [], + "signature": [ + { + "pluginId": "telemetryCollectionManager", + "scope": "server", + "docId": "kibTelemetryCollectionManagerPluginApi", + "section": "def-server.StatsCollectionConfig", + "text": "StatsCollectionConfig" + } + ], + "path": "src/plugins/telemetry_collection_manager/server/types.ts", + "deprecated": false + }, + { + "parentPluginId": "telemetryCollectionManager", + "id": "def-server.context", + "type": "Object", + "tags": [], + "label": "context", + "description": [], + "signature": [ + { + "pluginId": "telemetryCollectionManager", + "scope": "server", + "docId": "kibTelemetryCollectionManagerPluginApi", + "section": "def-server.StatsCollectionContext", + "text": "StatsCollectionContext" + } + ], + "path": "src/plugins/telemetry_collection_manager/server/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -617,11 +719,10 @@ ], "path": "src/plugins/telemetry_collection_manager/server/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "telemetryCollectionManager", - "id": "def-server.collectionConfig", + "id": "def-server.TelemetryCollectionManagerPluginSetup.setCollectionStrategy.$1", "type": "Object", "tags": [], "label": "collectionConfig", @@ -631,9 +732,11 @@ "" ], "path": "src/plugins/telemetry_collection_manager/server/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "telemetryCollectionManager", diff --git a/api_docs/telemetry_collection_manager.mdx b/api_docs/telemetry_collection_manager.mdx index 6589f18a49c32..799b328833f9a 100644 --- a/api_docs/telemetry_collection_manager.mdx +++ b/api_docs/telemetry_collection_manager.mdx @@ -18,7 +18,7 @@ import telemetryCollectionManagerObj from './telemetry_collection_manager.json'; | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 29 | 0 | 29 | 4 | +| 34 | 0 | 34 | 4 | ## Server diff --git a/api_docs/telemetry_management_section.json b/api_docs/telemetry_management_section.json index 90a231a9282da..84ef19d54d547 100644 --- a/api_docs/telemetry_management_section.json +++ b/api_docs/telemetry_management_section.json @@ -191,19 +191,23 @@ ], "path": "src/plugins/telemetry_management_section/public/plugin.tsx", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "telemetryManagementSection", - "id": "def-public.enabled", + "id": "def-public.TelemetryManagementSectionPluginSetup.toggleSecuritySolutionExample.$1", "type": "boolean", "tags": [], "label": "enabled", "description": [], + "signature": [ + "boolean" + ], "path": "src/plugins/telemetry_management_section/public/plugin.tsx", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "lifecycle": "setup", diff --git a/api_docs/timelines.json b/api_docs/timelines.json index 7a202a956371c..f273ee5fc24ba 100644 --- a/api_docs/timelines.json +++ b/api_docs/timelines.json @@ -458,11 +458,10 @@ ], "path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "timelines", - "id": "def-public.containerElement", + "id": "def-public.getTableSkipFocus.$1.containerElementgetFocusedCellshiftKeytableHasFocustableClassName.tableHasFocus.$1", "type": "CompoundType", "tags": [], "label": "containerElement", @@ -471,9 +470,11 @@ "HTMLElement | null" ], "path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "timelines", @@ -567,8 +568,8 @@ ], "path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "timelines", @@ -582,8 +583,8 @@ ], "path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "timelines", @@ -1496,6 +1497,22 @@ ], "path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "timelines", + "id": "def-public.__0", + "type": "Object", + "tags": [], + "label": "__0", + "description": [], + "signature": [ + "{ newFocusedColumn: HTMLDivElement | null; newFocusedColumnAriaColindex: number | null; }" + ], + "path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -1514,7 +1531,9 @@ "section": "def-common.ColumnHeaderOptions", "text": "ColumnHeaderOptions" }, - "[]; filters?: any[] | undefined; title: string; id: string; sort: ", + "[]; filters?: ", + "Filter", + "[] | undefined; title: string; id: string; sort: ", { "pluginId": "timelines", "scope": "common", @@ -1624,8 +1643,8 @@ ], "path": "x-pack/plugins/timelines/public/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "timelines", @@ -1645,22 +1664,24 @@ ], "path": "x-pack/plugins/timelines/public/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "timelines", - "id": "def-public.props", + "id": "def-public.TimelinesUIStart.getTGrid.$1", "type": "Uncategorized", "tags": [], "label": "props", "description": [], "signature": [ - "T extends \"standalone\" ? TGridStandaloneCompProps : T extends \"embedded\" ? TGridIntegratedCompProps : TGridIntegratedCompProps" + "GetTGridProps", + "" ], "path": "x-pack/plugins/timelines/public/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "timelines", @@ -1674,8 +1695,8 @@ ], "path": "x-pack/plugins/timelines/public/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "timelines", @@ -1693,11 +1714,10 @@ ], "path": "x-pack/plugins/timelines/public/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "timelines", - "id": "def-public.props", + "id": "def-public.TimelinesUIStart.getLoadingPanel.$1", "type": "Object", "tags": [], "label": "props", @@ -1706,9 +1726,11 @@ "LoadingPanelProps" ], "path": "x-pack/plugins/timelines/public/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "timelines", @@ -1726,11 +1748,10 @@ ], "path": "x-pack/plugins/timelines/public/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "timelines", - "id": "def-public.props", + "id": "def-public.TimelinesUIStart.getLastUpdated.$1", "type": "Object", "tags": [], "label": "props", @@ -1739,9 +1760,11 @@ "LastUpdatedAtProps" ], "path": "x-pack/plugins/timelines/public/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "timelines", @@ -1752,31 +1775,30 @@ "description": [], "signature": [ "(props: ", - "FieldBrowserWrappedProps", + "FieldBrowserProps", ") => React.ReactElement<", - "FieldBrowserWrappedProps", + "FieldBrowserProps", ">" ], "path": "x-pack/plugins/timelines/public/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "timelines", - "id": "def-public.props", - "type": "CompoundType", + "id": "def-public.TimelinesUIStart.getFieldBrowser.$1", + "type": "Object", "tags": [], "label": "props", "description": [], "signature": [ - "Pick<", - "FieldBrowserProps", - ", \"timelineId\" | \"columnHeaders\" | \"browserFields\" | \"isEventViewer\" | \"onFieldSelected\"> & { width?: number | undefined; height?: number | undefined; }" + "FieldBrowserProps" ], "path": "x-pack/plugins/timelines/public/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "timelines", @@ -1793,8 +1815,8 @@ ], "path": "x-pack/plugins/timelines/public/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "timelines", @@ -1810,8 +1832,8 @@ ], "path": "x-pack/plugins/timelines/public/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "timelines", @@ -1828,8 +1850,8 @@ ], "path": "x-pack/plugins/timelines/public/types.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "timelines", @@ -1847,11 +1869,10 @@ ], "path": "x-pack/plugins/timelines/public/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "timelines", - "id": "def-public.store", + "id": "def-public.TimelinesUIStart.setTGridEmbeddedStore.$1", "type": "Object", "tags": [], "label": "store", @@ -1863,9 +1884,11 @@ ">" ], "path": "x-pack/plugins/timelines/public/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "timelines", @@ -1883,11 +1906,10 @@ ], "path": "x-pack/plugins/timelines/public/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "timelines", - "id": "def-public.props", + "id": "def-public.TimelinesUIStart.getAddToCaseAction.$1", "type": "Object", "tags": [], "label": "props", @@ -1896,9 +1918,11 @@ "AddToCaseActionProps" ], "path": "x-pack/plugins/timelines/public/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "lifecycle": "start", @@ -3204,11 +3228,10 @@ ], "path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "timelines", - "id": "def-common.containerElement", + "id": "def-common.getTableSkipFocus.$1.containerElementgetFocusedCellshiftKeytableHasFocustableClassName.tableHasFocus.$1", "type": "CompoundType", "tags": [], "label": "containerElement", @@ -3217,9 +3240,11 @@ "HTMLElement | null" ], "path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "timelines", @@ -3327,8 +3352,8 @@ ], "path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "timelines", @@ -3342,8 +3367,8 @@ ], "path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "timelines", @@ -4753,8 +4778,8 @@ ], "path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "timelines", @@ -4869,7 +4894,9 @@ "(() => void) | undefined" ], "path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "timelines", @@ -4882,7 +4909,9 @@ "(() => void) | undefined" ], "path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "timelines", @@ -4938,7 +4967,9 @@ "(() => void) | undefined" ], "path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -5541,21 +5572,24 @@ ], "path": "x-pack/plugins/timelines/common/types/timeline/columns/index.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "timelines", - "id": "def-common.columnName", + "id": "def-common.ColumnRenderer.isInstance.$1", "type": "string", "tags": [], "label": "columnName", "description": [], + "signature": [ + "string" + ], "path": "x-pack/plugins/timelines/common/types/timeline/columns/index.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "timelines", - "id": "def-common.data", + "id": "def-common.ColumnRenderer.isInstance.$2", "type": "Array", "tags": [], "label": "data", @@ -5571,9 +5605,11 @@ "[]" ], "path": "x-pack/plugins/timelines/common/types/timeline/columns/index.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "timelines", @@ -5595,30 +5631,115 @@ ], "path": "x-pack/plugins/timelines/common/types/timeline/columns/index.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "timelines", - "id": "def-common.__0", + "id": "def-common.ColumnRenderer.renderColumn.$1.columnNameeventIdfieldtimelineIdtruncatevalueslinkValues", "type": "Object", "tags": [], - "label": "__0", + "label": "{\n columnName,\n eventId,\n field,\n timelineId,\n truncate,\n values,\n linkValues,\n }", "description": [], - "signature": [ - "{ columnName: string; eventId: string; field: ", + "path": "x-pack/plugins/timelines/common/types/timeline/columns/index.ts", + "deprecated": false, + "children": [ { - "pluginId": "timelines", - "scope": "common", - "docId": "kibTimelinesPluginApi", - "section": "def-common.ColumnHeaderOptions", - "text": "ColumnHeaderOptions" + "parentPluginId": "timelines", + "id": "def-common.ColumnRenderer.renderColumn.$1.columnNameeventIdfieldtimelineIdtruncatevalueslinkValues.columnName", + "type": "string", + "tags": [], + "label": "columnName", + "description": [], + "path": "x-pack/plugins/timelines/common/types/timeline/columns/index.ts", + "deprecated": false }, - "; timelineId: string; truncate?: boolean | undefined; values: string[] | null | undefined; linkValues?: string[] | null | undefined; }" - ], - "path": "x-pack/plugins/timelines/common/types/timeline/columns/index.ts", - "deprecated": false + { + "parentPluginId": "timelines", + "id": "def-common.ColumnRenderer.renderColumn.$1.columnNameeventIdfieldtimelineIdtruncatevalueslinkValues.eventId", + "type": "string", + "tags": [], + "label": "eventId", + "description": [], + "path": "x-pack/plugins/timelines/common/types/timeline/columns/index.ts", + "deprecated": false + }, + { + "parentPluginId": "timelines", + "id": "def-common.ColumnRenderer.renderColumn.$1.columnNameeventIdfieldtimelineIdtruncatevalueslinkValues.field", + "type": "CompoundType", + "tags": [], + "label": "field", + "description": [], + "signature": [ + "Pick<", + "EuiDataGridColumn", + ", \"id\" | \"display\" | \"displayAsText\" | \"initialWidth\"> & { aggregatable?: boolean | undefined; category?: string | undefined; columnHeaderType: ", + { + "pluginId": "timelines", + "scope": "common", + "docId": "kibTimelinesPluginApi", + "section": "def-common.ColumnHeaderType", + "text": "ColumnHeaderType" + }, + "; description?: string | undefined; example?: string | undefined; format?: string | undefined; linkField?: string | undefined; placeholder?: string | undefined; subType?: ", + "IFieldSubType", + " | undefined; type?: string | undefined; }" + ], + "path": "x-pack/plugins/timelines/common/types/timeline/columns/index.ts", + "deprecated": false + }, + { + "parentPluginId": "timelines", + "id": "def-common.ColumnRenderer.renderColumn.$1.columnNameeventIdfieldtimelineIdtruncatevalueslinkValues.timelineId", + "type": "string", + "tags": [], + "label": "timelineId", + "description": [], + "path": "x-pack/plugins/timelines/common/types/timeline/columns/index.ts", + "deprecated": false + }, + { + "parentPluginId": "timelines", + "id": "def-common.ColumnRenderer.renderColumn.$1.columnNameeventIdfieldtimelineIdtruncatevalueslinkValues.truncate", + "type": "CompoundType", + "tags": [], + "label": "truncate", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/timelines/common/types/timeline/columns/index.ts", + "deprecated": false + }, + { + "parentPluginId": "timelines", + "id": "def-common.ColumnRenderer.renderColumn.$1.columnNameeventIdfieldtimelineIdtruncatevalueslinkValues.values", + "type": "CompoundType", + "tags": [], + "label": "values", + "description": [], + "signature": [ + "string[] | null | undefined" + ], + "path": "x-pack/plugins/timelines/common/types/timeline/columns/index.ts", + "deprecated": false + }, + { + "parentPluginId": "timelines", + "id": "def-common.ColumnRenderer.renderColumn.$1.columnNameeventIdfieldtimelineIdtruncatevalueslinkValues.linkValues", + "type": "CompoundType", + "tags": [], + "label": "linkValues", + "description": [], + "signature": [ + "string[] | null | undefined" + ], + "path": "x-pack/plugins/timelines/common/types/timeline/columns/index.ts", + "deprecated": false + } + ] } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -7575,22 +7696,31 @@ ], "path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "timelines", - "id": "def-common.__0", + "id": "def-common.HeaderActionProps.onSelectAll.$1.isSelected", "type": "Object", "tags": [], - "label": "__0", + "label": "{ isSelected }", "description": [], - "signature": [ - "{ isSelected: boolean; }" - ], "path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "timelines", + "id": "def-common.HeaderActionProps.onSelectAll.$1.isSelected.isSelected", + "type": "boolean", + "tags": [], + "label": "isSelected", + "description": [], + "path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts", + "deprecated": false + } + ] } - ] + ], + "returnComment": [] }, { "parentPluginId": "timelines", @@ -8556,11 +8686,10 @@ ], "path": "x-pack/plugins/timelines/common/types/timeline/rows/index.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "timelines", - "id": "def-common.data", + "id": "def-common.RowRenderer.isInstance.$1", "type": "Object", "tags": [], "label": "data", @@ -8569,9 +8698,11 @@ "Ecs" ], "path": "x-pack/plugins/timelines/common/types/timeline/rows/index.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "timelines", @@ -8595,32 +8726,75 @@ ], "path": "x-pack/plugins/timelines/common/types/timeline/rows/index.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "timelines", - "id": "def-common.__0", + "id": "def-common.RowRenderer.renderRow.$1.browserFieldsdataisDraggabletimelineId", "type": "Object", "tags": [], - "label": "__0", + "label": "{\n browserFields,\n data,\n isDraggable,\n timelineId,\n }", "description": [], - "signature": [ - "{ browserFields: Readonly; }" + ], + "path": "x-pack/plugins/timelines/common/types/timeline/rows/index.ts", + "deprecated": false }, - ">>>; data: ", - "Ecs", - "; isDraggable: boolean; timelineId: string; }" - ], - "path": "x-pack/plugins/timelines/common/types/timeline/rows/index.ts", - "deprecated": false + { + "parentPluginId": "timelines", + "id": "def-common.RowRenderer.renderRow.$1.browserFieldsdataisDraggabletimelineId.data", + "type": "Object", + "tags": [], + "label": "data", + "description": [], + "signature": [ + "Ecs" + ], + "path": "x-pack/plugins/timelines/common/types/timeline/rows/index.ts", + "deprecated": false + }, + { + "parentPluginId": "timelines", + "id": "def-common.RowRenderer.renderRow.$1.browserFieldsdataisDraggabletimelineId.isDraggable", + "type": "boolean", + "tags": [], + "label": "isDraggable", + "description": [], + "path": "x-pack/plugins/timelines/common/types/timeline/rows/index.ts", + "deprecated": false + }, + { + "parentPluginId": "timelines", + "id": "def-common.RowRenderer.renderRow.$1.browserFieldsdataisDraggabletimelineId.timelineId", + "type": "string", + "tags": [], + "label": "timelineId", + "description": [], + "path": "x-pack/plugins/timelines/common/types/timeline/rows/index.ts", + "deprecated": false + } + ] } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -10437,7 +10611,8 @@ "label": "filters", "description": [], "signature": [ - "any[] | undefined" + "Filter", + "[] | undefined" ], "path": "x-pack/plugins/timelines/common/types/timeline/store.ts", "deprecated": false @@ -12148,6 +12323,22 @@ ], "path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "timelines", + "id": "def-common.__0", + "type": "Object", + "tags": [], + "label": "__0", + "description": [], + "signature": [ + "{ containerElement: HTMLElement | null; tableClassName: string; }" + ], + "path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -12316,6 +12507,19 @@ ], "path": "x-pack/plugins/timelines/common/types/timeline/store.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "timelines", + "id": "def-common.nextPage", + "type": "number", + "tags": [], + "label": "nextPage", + "description": [], + "path": "x-pack/plugins/timelines/common/types/timeline/store.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -12330,6 +12534,22 @@ ], "path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "timelines", + "id": "def-common.__0", + "type": "Object", + "tags": [], + "label": "__0", + "description": [], + "signature": [ + "{ newFocusedColumn: HTMLDivElement | null; newFocusedColumnAriaColindex: number | null; }" + ], + "path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -12344,6 +12564,19 @@ ], "path": "x-pack/plugins/timelines/common/types/timeline/store.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "timelines", + "id": "def-common.columnId", + "type": "string", + "tags": [], + "label": "columnId", + "description": [], + "path": "x-pack/plugins/timelines/common/types/timeline/store.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -12358,6 +12591,22 @@ ], "path": "x-pack/plugins/timelines/common/types/timeline/store.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "timelines", + "id": "def-common.__0", + "type": "Object", + "tags": [], + "label": "__0", + "description": [], + "signature": [ + "{ columnId: string; delta: number; }" + ], + "path": "x-pack/plugins/timelines/common/types/timeline/store.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -12382,6 +12631,30 @@ ], "path": "x-pack/plugins/timelines/common/types/timeline/store.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "timelines", + "id": "def-common.sorted", + "type": "Object", + "tags": [], + "label": "sorted", + "description": [], + "signature": [ + "{ columnId: string; sortDirection: ", + { + "pluginId": "securitySolution", + "scope": "common", + "docId": "kibSecuritySolutionPluginApi", + "section": "def-common.SortDirection", + "text": "SortDirection" + }, + "; }" + ], + "path": "x-pack/plugins/timelines/common/types/timeline/store.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -12404,6 +12677,30 @@ ], "path": "x-pack/plugins/timelines/common/types/timeline/store.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "timelines", + "id": "def-common.sorted", + "type": "Array", + "tags": [], + "label": "sorted", + "description": [], + "signature": [ + "{ columnId: string; sortDirection: ", + { + "pluginId": "securitySolution", + "scope": "common", + "docId": "kibSecuritySolutionPluginApi", + "section": "def-common.SortDirection", + "text": "SortDirection" + }, + "; }[]" + ], + "path": "x-pack/plugins/timelines/common/types/timeline/store.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -12420,6 +12717,19 @@ ], "path": "x-pack/plugins/timelines/common/types/timeline/store.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "timelines", + "id": "def-common.eventId", + "type": "string", + "tags": [], + "label": "eventId", + "description": [], + "path": "x-pack/plugins/timelines/common/types/timeline/store.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -12436,6 +12746,22 @@ ], "path": "x-pack/plugins/timelines/common/types/timeline/store.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "timelines", + "id": "def-common.__0", + "type": "Object", + "tags": [], + "label": "__0", + "description": [], + "signature": [ + "{ eventIds: string[]; isSelected: boolean; }" + ], + "path": "x-pack/plugins/timelines/common/types/timeline/store.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -12452,6 +12778,22 @@ ], "path": "x-pack/plugins/timelines/common/types/timeline/store.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "timelines", + "id": "def-common.__0", + "type": "Object", + "tags": [], + "label": "__0", + "description": [], + "signature": [ + "{ isSelected: boolean; }" + ], + "path": "x-pack/plugins/timelines/common/types/timeline/store.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -12468,6 +12810,19 @@ ], "path": "x-pack/plugins/timelines/common/types/timeline/store.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "timelines", + "id": "def-common.eventId", + "type": "string", + "tags": [], + "label": "eventId", + "description": [], + "path": "x-pack/plugins/timelines/common/types/timeline/store.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -12492,6 +12847,29 @@ ], "path": "x-pack/plugins/timelines/common/types/timeline/store.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "timelines", + "id": "def-common.columns", + "type": "Array", + "tags": [], + "label": "columns", + "description": [], + "signature": [ + { + "pluginId": "timelines", + "scope": "common", + "docId": "kibTimelinesPluginApi", + "section": "def-common.ColumnHeaderOptions", + "text": "ColumnHeaderOptions" + }, + "[]" + ], + "path": "x-pack/plugins/timelines/common/types/timeline/store.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { diff --git a/api_docs/timelines.mdx b/api_docs/timelines.mdx index 78b00340cc544..2669285776df9 100644 --- a/api_docs/timelines.mdx +++ b/api_docs/timelines.mdx @@ -18,7 +18,7 @@ import timelinesObj from './timelines.json'; | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 889 | 6 | 770 | 26 | +| 914 | 6 | 795 | 25 | ## Client diff --git a/api_docs/triggers_actions_ui.json b/api_docs/triggers_actions_ui.json index 4beeb5f45363d..23c9adad627b7 100644 --- a/api_docs/triggers_actions_ui.json +++ b/api_docs/triggers_actions_ui.json @@ -1154,11 +1154,10 @@ ], "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "triggersActionsUi", - "id": "def-public.alertParams", + "id": "def-public.AlertTypeModel.validate.$1", "type": "Uncategorized", "tags": [], "label": "alertParams", @@ -1167,9 +1166,11 @@ "Params" ], "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "triggersActionsUi", @@ -1312,11 +1313,10 @@ ], "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "triggersActionsUi", - "id": "def-public.property", + "id": "def-public.AlertTypeParamsExpressionProps.setAlertParams.$1", "type": "Uncategorized", "tags": [], "label": "property", @@ -1325,11 +1325,12 @@ "Key" ], "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.value", + "id": "def-public.AlertTypeParamsExpressionProps.setAlertParams.$2", "type": "Uncategorized", "tags": [], "label": "value", @@ -1338,9 +1339,11 @@ "Params[Key] | undefined" ], "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "triggersActionsUi", @@ -1362,11 +1365,10 @@ ], "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "triggersActionsUi", - "id": "def-public.key", + "id": "def-public.AlertTypeParamsExpressionProps.setAlertProperty.$1", "type": "Uncategorized", "tags": [], "label": "key", @@ -1375,11 +1377,12 @@ "Prop" ], "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.value", + "id": "def-public.AlertTypeParamsExpressionProps.setAlertProperty.$2", "type": "CompoundType", "tags": [], "label": "value", @@ -1396,9 +1399,11 @@ ", \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"throttle\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">[Prop] | null" ], "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] }, { "parentPluginId": "triggersActionsUi", @@ -1803,11 +1808,10 @@ ], "path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "triggersActionsUi", - "id": "def-public.crumbs", + "id": "def-public.TriggersAndActionsUiServices.setBreadcrumbs.$1", "type": "Array", "tags": [], "label": "crumbs", @@ -1817,9 +1821,11 @@ "[]" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/app.tsx", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "triggersActionsUi", @@ -3117,46 +3123,25 @@ ], "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "triggersActionsUi", - "id": "def-public.props", + "id": "def-public.TriggersAndActionsUIPublicPluginStart.getAddConnectorFlyout.$1", "type": "Object", "tags": [], "label": "props", "description": [], "signature": [ - "{ onClose: () => void; consumer?: string | undefined; actionTypes?: ", - { - "pluginId": "actions", - "scope": "common", - "docId": "kibActionsPluginApi", - "section": "def-common.ActionType", - "text": "ActionType" - }, - "[] | undefined; onTestConnector?: ((connector: ", - { - "pluginId": "triggersActionsUi", - "scope": "public", - "docId": "kibTriggersActionsUiPluginApi", - "section": "def-public.ActionConnector", - "text": "ActionConnector" - }, - ", Record>) => void) | undefined; reloadConnectors?: (() => Promise, Record>[]>) | undefined; }" + "Pick<", + "ConnectorAddFlyoutProps", + ", \"onClose\" | \"consumer\" | \"actionTypes\" | \"onTestConnector\" | \"reloadConnectors\">" ], "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "triggersActionsUi", @@ -3174,40 +3159,25 @@ ], "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "triggersActionsUi", - "id": "def-public.props", + "id": "def-public.TriggersAndActionsUIPublicPluginStart.getEditConnectorFlyout.$1", "type": "Object", "tags": [], "label": "props", "description": [], "signature": [ - "{ onClose: () => void; consumer?: string | undefined; reloadConnectors?: (() => Promise, Record>[]>) | undefined; initialConnector: ", - { - "pluginId": "triggersActionsUi", - "scope": "public", - "docId": "kibTriggersActionsUiPluginApi", - "section": "def-public.ActionConnector", - "text": "ActionConnector" - }, - ", Record>; tab?: ", - "EditConectorTabs", - " | undefined; }" + "Pick<", + "ConnectorEditFlyoutProps", + ", \"onClose\" | \"consumer\" | \"reloadConnectors\" | \"initialConnector\" | \"tab\">" ], "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "triggersActionsUi", @@ -3225,38 +3195,25 @@ ], "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "triggersActionsUi", - "id": "def-public.props", + "id": "def-public.TriggersAndActionsUIPublicPluginStart.getAddAlertFlyout.$1", "type": "Object", "tags": [], "label": "props", "description": [], "signature": [ - "{ onClose: (reason: ", - { - "pluginId": "triggersActionsUi", - "scope": "public", - "docId": "kibTriggersActionsUiPluginApi", - "section": "def-public.AlertFlyoutCloseReason", - "text": "AlertFlyoutCloseReason" - }, - ") => void; metadata?: Record | undefined; onSave?: (() => Promise) | undefined; alertTypeId?: string | undefined; consumer: string; canChangeTrigger?: boolean | undefined; initialValues?: Partial>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"throttle\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">> | undefined; reloadAlerts?: (() => Promise) | undefined; }" + "Pick<", + "AlertAddProps", + ">, \"onClose\" | \"metadata\" | \"onSave\" | \"alertTypeId\" | \"consumer\" | \"canChangeTrigger\" | \"initialValues\" | \"reloadAlerts\">" ], "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "triggersActionsUi", @@ -3274,38 +3231,25 @@ ], "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "triggersActionsUi", - "id": "def-public.props", + "id": "def-public.TriggersAndActionsUIPublicPluginStart.getEditAlertFlyout.$1", "type": "Object", "tags": [], "label": "props", "description": [], "signature": [ - "{ onClose: (reason: ", - { - "pluginId": "triggersActionsUi", - "scope": "public", - "docId": "kibTriggersActionsUiPluginApi", - "section": "def-public.AlertFlyoutCloseReason", - "text": "AlertFlyoutCloseReason" - }, - ") => void; metadata?: Record | undefined; onSave?: (() => Promise) | undefined; reloadAlerts?: (() => Promise) | undefined; initialAlert: Pick<", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.Alert", - "text": "Alert" - }, - ">, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"throttle\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">; }" + "Pick<", + "AlertEditProps", + ">, \"onClose\" | \"metadata\" | \"onSave\" | \"reloadAlerts\" | \"initialAlert\">" ], "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "lifecycle": "start", diff --git a/api_docs/triggers_actions_ui.mdx b/api_docs/triggers_actions_ui.mdx index e682f3872becf..3b1f4dfe55f05 100644 --- a/api_docs/triggers_actions_ui.mdx +++ b/api_docs/triggers_actions_ui.mdx @@ -18,7 +18,7 @@ import triggersActionsUiObj from './triggers_actions_ui.json'; | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 237 | 1 | 228 | 19 | +| 237 | 1 | 228 | 18 | ## Client diff --git a/api_docs/ui_actions_enhanced.json b/api_docs/ui_actions_enhanced.json index d75bb38be5224..697231e9f7935 100644 --- a/api_docs/ui_actions_enhanced.json +++ b/api_docs/ui_actions_enhanced.json @@ -2749,8 +2749,8 @@ ], "path": "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "uiActionsEnhanced", @@ -3160,11 +3160,10 @@ ], "path": "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "uiActionsEnhanced", - "id": "def-public.context", + "id": "def-public.DynamicActionManagerParams.isCompatible.$1", "type": "Uncategorized", "tags": [], "label": "context", @@ -3173,9 +3172,11 @@ "C" ], "path": "x-pack/plugins/ui_actions_enhanced/public/dynamic_actions/dynamic_action_manager.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -3983,11 +3984,10 @@ ], "path": "x-pack/plugins/ui_actions_enhanced/server/plugin.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "uiActionsEnhanced", - "id": "def-server.definition", + "id": "def-server.SetupContract.registerActionFactory.$1", "type": "Object", "tags": [], "label": "definition", @@ -4011,9 +4011,11 @@ ">" ], "path": "x-pack/plugins/ui_actions_enhanced/server/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "lifecycle": "setup", diff --git a/api_docs/url_forwarding.json b/api_docs/url_forwarding.json index 745775a1434bf..ab6a119cce283 100644 --- a/api_docs/url_forwarding.json +++ b/api_docs/url_forwarding.json @@ -217,19 +217,23 @@ ], "path": "src/plugins/url_forwarding/public/plugin.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "urlForwarding", - "id": "def-public.legacyPath", + "id": "def-public.ForwardDefinition.rewritePath.$1", "type": "string", "tags": [], "label": "legacyPath", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/url_forwarding/public/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false diff --git a/api_docs/usage_collection.json b/api_docs/usage_collection.json index b4e421165c782..b7a68aaa9cef7 100644 --- a/api_docs/usage_collection.json +++ b/api_docs/usage_collection.json @@ -145,39 +145,38 @@ ], "path": "src/plugins/usage_collection/public/plugin.tsx", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "usageCollection", - "id": "def-public.appName", + "id": "def-public.UsageCollectionSetup.reportUiCounter.$1", "type": "string", "tags": [], "label": "appName", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/usage_collection/public/plugin.tsx", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "usageCollection", - "id": "def-public.type", + "id": "def-public.UsageCollectionSetup.reportUiCounter.$2", "type": "CompoundType", "tags": [], "label": "type", "description": [], "signature": [ - "METRIC_TYPE", - ".COUNT | ", - "METRIC_TYPE", - ".LOADED | ", - "METRIC_TYPE", - ".CLICK" + "UiCounterMetricType" ], "path": "src/plugins/usage_collection/public/plugin.tsx", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "usageCollection", - "id": "def-public.eventNames", + "id": "def-public.UsageCollectionSetup.reportUiCounter.$3", "type": "CompoundType", "tags": [], "label": "eventNames", @@ -186,11 +185,12 @@ "string | string[]" ], "path": "src/plugins/usage_collection/public/plugin.tsx", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "usageCollection", - "id": "def-public.count", + "id": "def-public.UsageCollectionSetup.reportUiCounter.$4", "type": "number", "tags": [], "label": "count", @@ -199,9 +199,11 @@ "number | undefined" ], "path": "src/plugins/usage_collection/public/plugin.tsx", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] } ], "lifecycle": "setup", @@ -235,39 +237,38 @@ ], "path": "src/plugins/usage_collection/public/plugin.tsx", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "usageCollection", - "id": "def-public.appName", + "id": "def-public.UsageCollectionStart.reportUiCounter.$1", "type": "string", "tags": [], "label": "appName", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/usage_collection/public/plugin.tsx", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "usageCollection", - "id": "def-public.type", + "id": "def-public.UsageCollectionStart.reportUiCounter.$2", "type": "CompoundType", "tags": [], "label": "type", "description": [], "signature": [ - "METRIC_TYPE", - ".COUNT | ", - "METRIC_TYPE", - ".LOADED | ", - "METRIC_TYPE", - ".CLICK" + "UiCounterMetricType" ], "path": "src/plugins/usage_collection/public/plugin.tsx", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "usageCollection", - "id": "def-public.eventNames", + "id": "def-public.UsageCollectionStart.reportUiCounter.$3", "type": "CompoundType", "tags": [], "label": "eventNames", @@ -276,11 +277,12 @@ "string | string[]" ], "path": "src/plugins/usage_collection/public/plugin.tsx", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "usageCollection", - "id": "def-public.count", + "id": "def-public.UsageCollectionStart.reportUiCounter.$4", "type": "number", "tags": [], "label": "count", @@ -289,9 +291,11 @@ "number | undefined" ], "path": "src/plugins/usage_collection/public/plugin.tsx", - "deprecated": false + "deprecated": false, + "isRequired": false } - ] + ], + "returnComment": [] } ], "lifecycle": "start", @@ -553,11 +557,10 @@ ], "path": "src/plugins/usage_collection/server/usage_counters/usage_counter.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "usageCollection", - "id": "def-server.params", + "id": "def-server.IUsageCounter.incrementCounter.$1", "type": "Object", "tags": [], "label": "params", @@ -572,9 +575,11 @@ } ], "path": "src/plugins/usage_collection/server/usage_counters/usage_counter.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "initialIsOpen": false @@ -742,6 +747,46 @@ ], "path": "src/plugins/usage_collection/server/collector/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "usageCollection", + "id": "def-server.context", + "type": "CompoundType", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "{ esClient: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.ElasticsearchClient", + "text": "ElasticsearchClient" + }, + "; soClient: Pick<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClient", + "text": "SavedObjectsClient" + }, + ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\" | \"errors\">; } & (WithKibanaRequest extends true ? { kibanaRequest?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + " | undefined; } : {})" + ], + "path": "src/plugins/usage_collection/server/collector/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -963,19 +1008,23 @@ ], "path": "src/plugins/usage_collection/server/plugin.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "usageCollection", - "id": "def-server.type", + "id": "def-server.UsageCollectionSetup.createUsageCounter.$1", "type": "string", "tags": [], "label": "type", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/usage_collection/server/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "usageCollection", @@ -999,19 +1048,23 @@ ], "path": "src/plugins/usage_collection/server/plugin.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "usageCollection", - "id": "def-server.type", + "id": "def-server.UsageCollectionSetup.getUsageCounterByType.$1", "type": "string", "tags": [], "label": "type", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/usage_collection/server/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "usageCollection", @@ -1043,62 +1096,30 @@ ], "path": "src/plugins/usage_collection/server/plugin.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "usageCollection", - "id": "def-server.options", + "id": "def-server.UsageCollectionSetup.makeUsageCollector.$1", "type": "CompoundType", "tags": [], "label": "options", "description": [], "signature": [ - "{ type: string; isReady: () => boolean | Promise; schema?: ", - { - "pluginId": "usageCollection", - "scope": "server", - "docId": "kibUsageCollectionPluginApi", - "section": "def-server.MakeSchemaFrom", - "text": "MakeSchemaFrom" - }, - " | undefined; fetch: ", - { - "pluginId": "usageCollection", - "scope": "server", - "docId": "kibUsageCollectionPluginApi", - "section": "def-server.CollectorFetchMethod", - "text": "CollectorFetchMethod" - }, - "; } & ExtraOptions & (WithKibanaRequest extends true ? { extendFetchContext: ", { "pluginId": "usageCollection", "scope": "server", "docId": "kibUsageCollectionPluginApi", - "section": "def-server.CollectorOptionsFetchExtendedContext", - "text": "CollectorOptionsFetchExtendedContext" + "section": "def-server.UsageCollectorOptions", + "text": "UsageCollectorOptions" }, - "; } : { extendFetchContext?: ", - { - "pluginId": "usageCollection", - "scope": "server", - "docId": "kibUsageCollectionPluginApi", - "section": "def-server.CollectorOptionsFetchExtendedContext", - "text": "CollectorOptionsFetchExtendedContext" - }, - " | undefined; }) & Required, \"schema\">>" + "" ], "path": "src/plugins/usage_collection/server/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "usageCollection", @@ -1122,11 +1143,10 @@ ], "path": "src/plugins/usage_collection/server/plugin.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "usageCollection", - "id": "def-server.collector", + "id": "def-server.UsageCollectionSetup.registerCollector.$1", "type": "Object", "tags": [], "label": "collector", @@ -1142,9 +1162,11 @@ "" ], "path": "src/plugins/usage_collection/server/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "usageCollection", @@ -1168,19 +1190,23 @@ ], "path": "src/plugins/usage_collection/server/plugin.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "usageCollection", - "id": "def-server.type", + "id": "def-server.UsageCollectionSetup.getCollectorByType.$1", "type": "string", "tags": [], "label": "type", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/usage_collection/server/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "lifecycle": "setup", diff --git a/api_docs/usage_collection.mdx b/api_docs/usage_collection.mdx index 6070c24c62003..72d3f34c6bd01 100644 --- a/api_docs/usage_collection.mdx +++ b/api_docs/usage_collection.mdx @@ -18,7 +18,7 @@ import usageCollectionObj from './usage_collection.json'; | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 57 | 0 | 16 | 2 | +| 58 | 0 | 17 | 2 | ## Client diff --git a/api_docs/vis_type_timeseries.json b/api_docs/vis_type_timeseries.json index f46208881a913..01b211e3da90b 100644 --- a/api_docs/vis_type_timeseries.json +++ b/api_docs/vis_type_timeseries.json @@ -135,11 +135,10 @@ ], "path": "src/plugins/vis_type_timeseries/server/plugin.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "visTypeTimeseries", - "id": "def-server.requestContext", + "id": "def-server.VisTypeTimeseriesSetup.getVisData.$1", "type": "Object", "tags": [], "label": "requestContext", @@ -148,11 +147,12 @@ "DataRequestHandlerContext" ], "path": "src/plugins/vis_type_timeseries/server/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "visTypeTimeseries", - "id": "def-server.fakeRequest", + "id": "def-server.VisTypeTimeseriesSetup.getVisData.$2", "type": "Object", "tags": [], "label": "fakeRequest", @@ -168,11 +168,12 @@ "" ], "path": "src/plugins/vis_type_timeseries/server/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "visTypeTimeseries", - "id": "def-server.options", + "id": "def-server.VisTypeTimeseriesSetup.getVisData.$3", "type": "Any", "tags": [], "label": "options", @@ -181,9 +182,11 @@ "any" ], "path": "src/plugins/vis_type_timeseries/server/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] } ], "lifecycle": "setup", diff --git a/api_docs/visualizations.json b/api_docs/visualizations.json index 9d55abf29d6f4..c779b4695fde5 100644 --- a/api_docs/visualizations.json +++ b/api_docs/visualizations.json @@ -2613,7 +2613,9 @@ "section": "def-common.TimeRange", "text": "TimeRange" }, - " | undefined) => any; getBounds: () => ", + " | undefined) => ", + "RangeFilter", + " | undefined; getBounds: () => ", { "pluginId": "data", "scope": "common", @@ -2802,7 +2804,9 @@ "(() => string[]) | undefined" ], "path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "visualizations", @@ -2932,7 +2936,31 @@ " | undefined) => string[]) | undefined" ], "path": "src/plugins/visualizations/public/vis_types/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "visualizations", + "id": "def-public.VisTypeDefinition.getSupportedTriggers.$1", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + { + "pluginId": "visualizations", + "scope": "common", + "docId": "kibVisualizationsPluginApi", + "section": "def-common.VisParams", + "text": "VisParams" + }, + " | undefined" + ], + "path": "src/plugins/visualizations/public/vis_types/types.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] }, { "parentPluginId": "visualizations", @@ -2971,7 +2999,30 @@ "[]>) | undefined" ], "path": "src/plugins/visualizations/public/vis_types/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "visualizations", + "id": "def-public.VisTypeDefinition.getUsedIndexPattern.$1", + "type": "Object", + "tags": [], + "label": "visParams", + "description": [], + "signature": [ + { + "pluginId": "visualizations", + "scope": "common", + "docId": "kibVisualizationsPluginApi", + "section": "def-common.VisParams", + "text": "VisParams" + } + ], + "path": "src/plugins/visualizations/public/vis_types/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "visualizations", @@ -3157,7 +3208,39 @@ ">) => React.ReactNode) | undefined" ], "path": "src/plugins/visualizations/public/vis_types/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "visualizations", + "id": "def-public.VisTypeDefinition.getInfoMessage.$1", + "type": "Object", + "tags": [], + "label": "vis", + "description": [], + "signature": [ + { + "pluginId": "visualizations", + "scope": "public", + "docId": "kibVisualizationsPluginApi", + "section": "def-public.Vis", + "text": "Vis" + }, + "<", + { + "pluginId": "visualizations", + "scope": "common", + "docId": "kibVisualizationsPluginApi", + "section": "def-common.VisParams", + "text": "VisParams" + }, + ">" + ], + "path": "src/plugins/visualizations/public/vis_types/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "visualizations", @@ -3275,7 +3358,31 @@ ">) | undefined" ], "path": "src/plugins/visualizations/public/vis_types/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "visualizations", + "id": "def-public.VisTypeDefinition.setup.$1", + "type": "Object", + "tags": [], + "label": "vis", + "description": [], + "signature": [ + { + "pluginId": "visualizations", + "scope": "public", + "docId": "kibVisualizationsPluginApi", + "section": "def-public.Vis", + "text": "Vis" + }, + "" + ], + "path": "src/plugins/visualizations/public/vis_types/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "visualizations", @@ -3461,7 +3568,9 @@ "(() => string[]) | undefined" ], "path": "src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts", - "deprecated": false + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "visualizations", @@ -3602,12 +3711,13 @@ { "parentPluginId": "visualizations", "id": "def-public.VisualizeInput.query", - "type": "Any", + "type": "Object", "tags": [], "label": "query", "description": [], "signature": [ - "any" + "Query", + " | undefined" ], "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.ts", "deprecated": false @@ -3620,7 +3730,8 @@ "label": "filters", "description": [], "signature": [ - "any[] | undefined" + "Filter", + "[] | undefined" ], "path": "src/plugins/visualizations/public/embeddable/visualize_embeddable.ts", "deprecated": false @@ -3729,6 +3840,48 @@ ], "path": "src/plugins/visualizations/public/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "visualizations", + "id": "def-public.vis", + "type": "Object", + "tags": [], + "label": "vis", + "description": [], + "signature": [ + { + "pluginId": "visualizations", + "scope": "public", + "docId": "kibVisualizationsPluginApi", + "section": "def-public.Vis", + "text": "Vis" + }, + "" + ], + "path": "src/plugins/visualizations/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "visualizations", + "id": "def-public.params", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + { + "pluginId": "visualizations", + "scope": "public", + "docId": "kibVisualizationsPluginApi", + "section": "def-public.VisToExpressionAstParams", + "text": "VisToExpressionAstParams" + } + ], + "path": "src/plugins/visualizations/public/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -4370,21 +4523,24 @@ ], "path": "src/plugins/visualizations/public/plugin.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "visualizations", - "id": "def-public.visType", + "id": "def-public.VisualizationsStart.createVis.$1", "type": "string", "tags": [], "label": "visType", "description": [], + "signature": [ + "string" + ], "path": "src/plugins/visualizations/public/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "visualizations", - "id": "def-public.visState", + "id": "def-public.VisualizationsStart.createVis.$2", "type": "Object", "tags": [], "label": "visState", @@ -4408,9 +4564,11 @@ ">" ], "path": "src/plugins/visualizations/public/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "visualizations", diff --git a/api_docs/visualizations.mdx b/api_docs/visualizations.mdx index 4686c5b64f936..4e47d231c312e 100644 --- a/api_docs/visualizations.mdx +++ b/api_docs/visualizations.mdx @@ -18,7 +18,7 @@ Contact [Kibana App](https://github.com/orgs/elastic/teams/kibana-app) for quest | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 257 | 14 | 239 | 12 | +| 263 | 13 | 245 | 12 | ## Client 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 3e16a25b36a14..ce7f93826d1da 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 @@ -84,7 +84,7 @@ it('Test Interface Kind doc def', () => { expect(def.type).toBe(TypeKind.InterfaceKind); expect(def.children).toBeDefined(); - expect(def.children!.length).toBe(3); + expect(def.children!.length).toBe(6); }); it('Test union export', () => { 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 54b3f433b2e8f..3d54cda5cf0fc 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 @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { Node } from 'ts-morph'; +import { FunctionTypeNode, Node } from 'ts-morph'; import { ToolingLog, KibanaPlatformPlugin } from '@kbn/dev-utils'; import { buildClassDec } from './build_class_dec'; import { buildFunctionDec } from './build_function_dec'; @@ -17,6 +17,8 @@ import { buildTypeLiteralDec } from './build_type_literal_dec'; import { ApiScope } from '../types'; import { buildInterfaceDec } from './build_interface_dec'; import { buildBasicApiDeclaration } from './build_basic_api_declaration'; +import { buildFunctionTypeDec } from './build_function_type_dec'; +import { buildCallSignatureDec } from './build_call_signature_dec'; /** * A potentially recursive function, depending on the node type, that builds a JSON like structure @@ -65,13 +67,28 @@ export function buildApiDeclaration({ return buildClassDec(node, plugins, anchorLink, currentPluginId, log, captureReferences); } else if (Node.isInterfaceDeclaration(node)) { return buildInterfaceDec(node, plugins, anchorLink, currentPluginId, log, captureReferences); + } else if ( + Node.isPropertySignature(node) && + node.getTypeNode() && + Node.isFunctionTypeNode(node.getTypeNode()!) + ) { + // This code path covers optional properties on interfaces, otherwise they lost their children. Yes, a bit strange. + return buildFunctionTypeDec({ + node, + typeNode: node.getTypeNode()! as FunctionTypeNode, + plugins, + anchorLink, + currentPluginId, + log, + captureReferences, + }); } else if ( Node.isMethodSignature(node) || Node.isFunctionDeclaration(node) || Node.isMethodDeclaration(node) || Node.isConstructorDeclaration(node) ) { - return buildFunctionDec(node, plugins, anchorLink, currentPluginId, log, captureReferences); + return buildFunctionDec({ node, plugins, anchorLink, currentPluginId, log, captureReferences }); } else if ( Node.isPropertySignature(node) || Node.isPropertyDeclaration(node) || @@ -92,6 +109,29 @@ export function buildApiDeclaration({ ); } + // Without this types that are functions won't include comments on parameters. e.g. + // /** + // * @param t A parameter + // */ + // export type AFn = (t: string) => void; + // + if (node.getType().getCallSignatures().length > 0) { + if (node.getType().getCallSignatures().length > 1) { + log.warning(`Not handling more than one call signature for node ${apiName}`); + } else { + return buildCallSignatureDec({ + signature: node.getType().getCallSignatures()[0], + log, + captureReferences, + plugins, + anchorLink, + currentPluginId, + name: apiName, + node, + }); + } + } + return buildBasicApiDeclaration({ currentPluginId, anchorLink, 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 afdf971336d34..c387b551a3002 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 @@ -27,14 +27,21 @@ import { buildBasicApiDeclaration } from './build_basic_api_declaration'; * @param anchorLink * @param log */ -export function buildFunctionDec( - node: FunctionDeclaration | MethodDeclaration | ConstructorDeclaration | MethodSignature, - plugins: KibanaPlatformPlugin[], - anchorLink: AnchorLink, - currentPluginId: string, - log: ToolingLog, - captureReferences: boolean -): ApiDeclaration { +export function buildFunctionDec({ + node, + plugins, + anchorLink, + currentPluginId, + log, + captureReferences, +}: { + node: FunctionDeclaration | MethodDeclaration | ConstructorDeclaration | MethodSignature; + plugins: KibanaPlatformPlugin[]; + anchorLink: AnchorLink; + currentPluginId: string; + log: ToolingLog; + captureReferences: boolean; +}): ApiDeclaration { const label = Node.isConstructorDeclaration(node) ? 'Constructor' : node.getName() || '(WARN: Missing name)'; diff --git a/packages/kbn-docs-utils/src/api_docs/build_api_declarations/build_function_type_dec.ts b/packages/kbn-docs-utils/src/api_docs/build_api_declarations/build_function_type_dec.ts new file mode 100644 index 0000000000000..e8137e9e7536d --- /dev/null +++ b/packages/kbn-docs-utils/src/api_docs/build_api_declarations/build_function_type_dec.ts @@ -0,0 +1,60 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ +import { PropertySignature } from 'ts-morph'; + +import { ToolingLog, KibanaPlatformPlugin } from '@kbn/dev-utils'; +import { FunctionTypeNode } from 'ts-morph'; +import { buildApiDecsForParameters } from './build_parameter_decs'; +import { AnchorLink, ApiDeclaration, TypeKind } from '../types'; +import { getJSDocReturnTagComment, getJSDocs } from './js_doc_utils'; +import { buildBasicApiDeclaration } from './build_basic_api_declaration'; + +/** + * Takes the various function-type node declaration types and converts them into an ApiDeclaration. + */ +export function buildFunctionTypeDec({ + node, + typeNode, + plugins, + anchorLink, + currentPluginId, + log, + captureReferences, +}: { + node: PropertySignature; + typeNode: FunctionTypeNode; + plugins: KibanaPlatformPlugin[]; + anchorLink: AnchorLink; + currentPluginId: string; + log: ToolingLog; + captureReferences: boolean; +}): ApiDeclaration { + const fn = { + ...buildBasicApiDeclaration({ + currentPluginId, + anchorLink, + node, + captureReferences, + plugins, + log, + apiName: node.getName(), + }), + type: TypeKind.FunctionKind, + children: buildApiDecsForParameters( + typeNode.getParameters(), + plugins, + anchorLink, + currentPluginId, + log, + captureReferences, + getJSDocs(node) + ), + returnComment: getJSDocReturnTagComment(node), + }; + return fn; +} diff --git a/packages/kbn-docs-utils/src/api_docs/build_api_declarations/build_variable_dec.ts b/packages/kbn-docs-utils/src/api_docs/build_api_declarations/build_variable_dec.ts index cc3c2f8f50211..7a363f93f2efa 100644 --- a/packages/kbn-docs-utils/src/api_docs/build_api_declarations/build_variable_dec.ts +++ b/packages/kbn-docs-utils/src/api_docs/build_api_declarations/build_variable_dec.ts @@ -46,7 +46,6 @@ export function buildVariableDec( captureReferences: boolean ): ApiDeclaration { const initializer = node.getInitializer(); - if (initializer && Node.isObjectLiteralExpression(initializer)) { // Recursively list object properties as children. return { @@ -90,6 +89,7 @@ export function buildVariableDec( ); } + // Without this the test "Property on interface pointing to generic function type exported with link" will fail. if (node.getType().getCallSignatures().length > 0) { if (node.getType().getCallSignatures().length > 1) { log.warning(`Not handling more than one call signature for node ${node.getName()}`); 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 f17e3e4d90600..d91cadce10754 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(35); + expect(doc?.client.length).toBe(36); 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(33); + expect(mainDoc?.client.length).toBe(34); }); diff --git a/packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/classes.ts b/packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/classes.ts index 3641bc41945aa..e80ae3f4f4c5f 100644 --- a/packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/classes.ts +++ b/packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/classes.ts @@ -8,7 +8,7 @@ /* eslint-disable max-classes-per-file */ -import { ImAType } from './types'; +import { FnTypeWithGeneric, ImAType } from './types'; /** * @internal @@ -87,10 +87,26 @@ export interface ExampleInterface extends AnotherInterface { */ aFnWithGen: (t: T) => void; + /** + * Add coverage for this bug report: https://github.com/elastic/kibana/issues/107145 + */ + anOptionalFn?: (foo: string) => string; + /** * These are not coming back properly. */ aFn(): void; + + /** + * This one is slightly different than the above `aFnWithGen`. The generic is part of the type, not the function (it's before the = sign). + * Ideally, we can still capture the children. + */ + fnTypeWithGeneric: FnTypeWithGeneric; + + /** + * Optional code path is different than others. + */ + fnTypeWithGenericThatIsOptional?: FnTypeWithGeneric; } /** diff --git a/packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/types.ts b/packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/types.ts index 0e70fe1afb6cf..e0ac1bfd089fc 100644 --- a/packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/types.ts +++ b/packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/types.ts @@ -25,6 +25,14 @@ export type ImAType = string | number | TypeWithGeneric | FooType | ImAC */ export type FnWithGeneric = (t: T) => TypeWithGeneric; +/** + * Ever so slightly different than above. Users of this type must specify the generic. + * + * @param t something! + * @return something! + */ +export type FnTypeWithGeneric = (t: T, p: MyProps) => TypeWithGeneric; + /** * Comments on enums. */ diff --git a/packages/kbn-docs-utils/src/api_docs/tests/api_doc_suite.test.ts b/packages/kbn-docs-utils/src/api_docs/tests/api_doc_suite.test.ts index 0c97743c65d35..0d567632346f1 100644 --- a/packages/kbn-docs-utils/src/api_docs/tests/api_doc_suite.test.ts +++ b/packages/kbn-docs-utils/src/api_docs/tests/api_doc_suite.test.ts @@ -244,7 +244,49 @@ describe('objects', () => { }); }); -describe('Misc types', () => { +describe('Types', () => { + it('Generic type pointing to a function', () => { + const api = doc.client.find((c) => c.label === 'FnTypeWithGeneric'); + expect(api).toBeDefined(); + expect(api?.signature).toBeDefined(); + expect(linkCount(api?.signature!)).toBe(2); + + expect(api?.children).toBeDefined(); + expect(api?.signature!).toMatchInlineSnapshot(` + Array [ + "(t: T, p: ", + Object { + "docId": "kibPluginAPluginApi", + "pluginId": "pluginA", + "scope": "public", + "section": "def-public.MyProps", + "text": "MyProps", + }, + ") => ", + Object { + "docId": "kibPluginAPluginApi", + "pluginId": "pluginA", + "scope": "public", + "section": "def-public.TypeWithGeneric", + "text": "TypeWithGeneric", + }, + "", + ] + `); + }); + + it('Generic type pointing to an array', () => { + const api = doc.client.find((c) => c.label === 'TypeWithGeneric'); + expect(api).toBeDefined(); + expect(api?.signature).toBeDefined(); + expect(linkCount(api?.signature!)).toBe(0); + expect(api?.signature!).toMatchInlineSnapshot(` + Array [ + "T[]", + ] + `); + }); + it('Type using ReactElement has the right signature', () => { const api = doc.client.find((c) => c.label === 'AReactElementFn'); expect(api).toBeDefined(); @@ -322,6 +364,14 @@ describe('Misc types', () => { ] `); expect(linkCount(fnType?.signature!)).toBe(1); + + expect(fnType?.children).toBeDefined(); + expect(fnType?.children?.length).toBe(1); + expect(fnType?.children![0].description).toMatchInlineSnapshot(` + Array [ + "This is a generic T type. It can be anything.", + ] + `); }); it('Union type is exported correctly', () => { @@ -417,6 +467,20 @@ describe('interfaces and classes', () => { `); }); + /** + * Coverage for https://github.com/elastic/kibana/issues/107145 + */ + it('Optional function on interface includes children', () => { + const exampleInterface = doc.client.find((c) => c.label === 'ExampleInterface'); + expect(exampleInterface).toBeDefined(); + + const fn = exampleInterface!.children?.find((c) => c.label === 'anOptionalFn'); + expect(fn).toBeDefined(); + expect(fn?.type).toBe(TypeKind.FunctionKind); + expect(fn?.children).toBeDefined(); + expect(fn?.children?.length).toBe(1); + }); + it('Non arrow function on interface is exported as function type', () => { const exampleInterface = doc.client.find((c) => c.label === 'ExampleInterface'); expect(exampleInterface).toBeDefined(); @@ -462,7 +526,7 @@ describe('interfaces and classes', () => { expect(linkCount(clss?.signature!)).toBe(3); }); - it('Function with generic inside interface is exported with function type', () => { + it('Generic function inside interface is exported as a function', () => { const exampleInterface = doc.client.find((c) => c.label === 'ExampleInterface'); expect(exampleInterface).toBeDefined(); @@ -481,6 +545,47 @@ describe('interfaces and classes', () => { expect(param!.description![0]).toBe('This a parameter.'); }); + it('Property on interface pointing to generic function type exported with link', () => { + const exampleInterface = doc.client.find((c) => c.label === 'ExampleInterface'); + expect(exampleInterface).toBeDefined(); + + const fn = exampleInterface?.children?.find((c) => c.label === 'fnTypeWithGeneric'); + expect(fn).toBeDefined(); + + // `fnTypeWithGeneric` is defined as: + // fnTypeWithGeneric: FnTypeWithGeneric; + // and `GenericTypeFn` is defined as: + // type FnTypeWithGeneric = (t: T, p: MyProps) => TypeWithGeneric; + // In get_signature.ts, we use the `TypeFormatFlags.InTypeAlias` flag which ends up expanding the type + // to be a function, and thus this doesn't show up as a single referenced type with no kids. If we ever fixed that, + // it would be find to change expectations here to be no children and TypeKind instead of FunctionKind. + expect(fn?.children).toBeDefined(); + expect(fn?.type).toBe(TypeKind.FunctionKind); + expect(fn?.signature).toBeDefined(); + expect(linkCount(fn!.signature!)).toBe(2); + expect(fn?.children?.length).toBe(2); + + // This will fail! It actually shows up as Uncategorized. It would be some effort to get it to show up as string, which may involve + // trying to fix the above issue so it's not expanded. + // expect(fn?.children[0]!.type).toBe(TypeKind.StringKind); + }); + + // Optional code path is different than non-optional properties. + it('Optional interface property pointing to generic function type', () => { + const exampleInterface = doc.client.find((c) => c.label === 'ExampleInterface'); + expect(exampleInterface).toBeDefined(); + + const fn = exampleInterface?.children?.find( + (c) => c.label === 'fnTypeWithGenericThatIsOptional' + ); + expect(fn).toBeDefined(); + + // Unlike the above, the type is _not_ expanded inline, so we make sure it has no children, but does link to the property. + expect(fn?.children).toBeUndefined(); + expect(fn?.signature).toBeDefined(); + expect(linkCount(fn!.signature!)).toBe(1); + }); + it('interfaces with internal tags are not exported', () => { const internal = doc.client.find((c) => c.label === 'IShouldBeInternalInterface'); expect(internal).toBeUndefined(); diff --git a/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_a.json b/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_a.json index 8a2a31c11be57..a63f726a8ca45 100644 --- a/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_a.json +++ b/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_a.json @@ -416,22 +416,31 @@ ], "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/fns.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "pluginA", - "id": "def-public.foo", + "id": "def-public.crazyFunction.$2.fn.fn.$1.foo", "type": "Object", "tags": [], "label": "foo", "description": [], - "signature": [ - "{ param: string; }" - ], "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/fns.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "pluginA", + "id": "def-public.crazyFunction.$2.fn.fn.$1.foo.param", + "type": "string", + "tags": [], + "label": "param", + "description": [], + "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/fns.ts", + "deprecated": false + } + ] } - ] + ], + "returnComment": [] } ] }, @@ -732,8 +741,8 @@ ], "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/classes.ts", "deprecated": false, - "returnComment": [], - "children": [] + "children": [], + "returnComment": [] }, { "parentPluginId": "pluginA", @@ -749,13 +758,10 @@ ], "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/classes.ts", "deprecated": false, - "returnComment": [ - "nothing!" - ], "children": [ { "parentPluginId": "pluginA", - "id": "def-public.t", + "id": "def-public.ExampleInterface.aFnWithGen.$1", "type": "Uncategorized", "tags": [], "label": "t", @@ -766,10 +772,46 @@ "T" ], "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/classes.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } + ], + "returnComment": [ + "nothing!" ] }, + { + "parentPluginId": "pluginA", + "id": "def-public.ExampleInterface.anOptionalFn", + "type": "Function", + "tags": [], + "label": "anOptionalFn", + "description": [ + "\nAdd coverage for this bug report: https://github.com/elastic/kibana/issues/107145" + ], + "signature": [ + "((foo: string) => string) | undefined" + ], + "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/classes.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "pluginA", + "id": "def-public.ExampleInterface.anOptionalFn.$1", + "type": "string", + "tags": [], + "label": "foo", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/classes.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, { "parentPluginId": "pluginA", "id": "def-public.ExampleInterface.aFn", @@ -786,6 +828,94 @@ "deprecated": false, "children": [], "returnComment": [] + }, + { + "parentPluginId": "pluginA", + "id": "def-public.ExampleInterface.fnTypeWithGeneric", + "type": "Function", + "tags": [], + "label": "fnTypeWithGeneric", + "description": [ + "\nThis one is slightly different than the above `aFnWithGen`. The generic is part of the type, not the function (it's before the = sign).\nIdeally, we can still capture the children." + ], + "signature": [ + "(t: string, p: ", + { + "pluginId": "pluginA", + "scope": "public", + "docId": "kibPluginAPluginApi", + "section": "def-public.MyProps", + "text": "MyProps" + }, + ") => ", + { + "pluginId": "pluginA", + "scope": "public", + "docId": "kibPluginAPluginApi", + "section": "def-public.TypeWithGeneric", + "text": "TypeWithGeneric" + }, + "" + ], + "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/classes.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "pluginA", + "id": "def-public.t", + "type": "Uncategorized", + "tags": [], + "label": "t", + "description": [], + "signature": [ + "T" + ], + "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "pluginA", + "id": "def-public.p", + "type": "Object", + "tags": [], + "label": "p", + "description": [], + "signature": [ + { + "pluginId": "pluginA", + "scope": "public", + "docId": "kibPluginAPluginApi", + "section": "def-public.MyProps", + "text": "MyProps" + } + ], + "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/types.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "pluginA", + "id": "def-public.ExampleInterface.fnTypeWithGenericThatIsOptional", + "type": "Function", + "tags": [], + "label": "fnTypeWithGenericThatIsOptional", + "description": [ + "\nOptional code path is different than others." + ], + "signature": [ + { + "pluginId": "pluginA", + "scope": "public", + "docId": "kibPluginAPluginApi", + "section": "def-public.FnTypeWithGeneric", + "text": "FnTypeWithGeneric" + }, + " | undefined" + ], + "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/classes.ts", + "deprecated": false } ], "initialIsOpen": false @@ -1074,6 +1204,8 @@ ], "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/types.ts", "deprecated": false, + "returnComment": [], + "children": [], "initialIsOpen": false }, { @@ -1129,6 +1261,79 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "pluginA", + "id": "def-public.FnTypeWithGeneric", + "type": "Type", + "tags": [ + "return" + ], + "label": "FnTypeWithGeneric", + "description": [ + "\nEver so slightly different than above. Users of this type must specify the generic.\n" + ], + "signature": [ + "(t: T, p: ", + { + "pluginId": "pluginA", + "scope": "public", + "docId": "kibPluginAPluginApi", + "section": "def-public.MyProps", + "text": "MyProps" + }, + ") => ", + { + "pluginId": "pluginA", + "scope": "public", + "docId": "kibPluginAPluginApi", + "section": "def-public.TypeWithGeneric", + "text": "TypeWithGeneric" + }, + "" + ], + "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/types.ts", + "deprecated": false, + "returnComment": [ + "something!" + ], + "children": [ + { + "parentPluginId": "pluginA", + "id": "def-public.t", + "type": "Uncategorized", + "tags": [], + "label": "t", + "description": [ + "something!" + ], + "signature": [ + "T" + ], + "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "pluginA", + "id": "def-public.p", + "type": "Object", + "tags": [], + "label": "p", + "description": [], + "signature": [ + { + "pluginId": "pluginA", + "scope": "public", + "docId": "kibPluginAPluginApi", + "section": "def-public.MyProps", + "text": "MyProps" + } + ], + "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "pluginA", "id": "def-public.FnWithGeneric", @@ -1151,6 +1356,24 @@ ], "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/types.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "pluginA", + "id": "def-public.t", + "type": "Uncategorized", + "tags": [], + "label": "t", + "description": [ + "This is a generic T type. It can be anything." + ], + "signature": [ + "T" + ], + "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/types.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -1309,6 +1532,94 @@ ], "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/fns.ts", "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "pluginA", + "id": "def-public.a", + "type": "string", + "tags": [], + "label": "a", + "description": [], + "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/fns.ts", + "deprecated": false + }, + { + "parentPluginId": "pluginA", + "id": "def-public.b", + "type": "number", + "tags": [], + "label": "b", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/fns.ts", + "deprecated": false + }, + { + "parentPluginId": "pluginA", + "id": "def-public.c", + "type": "Array", + "tags": [], + "label": "c", + "description": [], + "signature": [ + "string[]" + ], + "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/fns.ts", + "deprecated": false + }, + { + "parentPluginId": "pluginA", + "id": "def-public.d", + "type": "CompoundType", + "tags": [], + "label": "d", + "description": [], + "signature": [ + "string | number | ", + { + "pluginId": "pluginA", + "scope": "public", + "docId": "kibPluginAFooPluginApi", + "section": "def-public.FooType", + "text": "FooType" + }, + " | ", + { + "pluginId": "pluginA", + "scope": "public", + "docId": "kibPluginAPluginApi", + "section": "def-public.TypeWithGeneric", + "text": "TypeWithGeneric" + }, + " | ", + { + "pluginId": "pluginA", + "scope": "common", + "docId": "kibPluginAPluginApi", + "section": "def-common.ImACommonType", + "text": "ImACommonType" + } + ], + "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/fns.ts", + "deprecated": false + }, + { + "parentPluginId": "pluginA", + "id": "def-public.e", + "type": "string", + "tags": [], + "label": "e", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/fns.ts", + "deprecated": false + } + ], "initialIsOpen": false }, { @@ -1738,13 +2049,10 @@ ], "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/plugin.ts", "deprecated": false, - "returnComment": [ - "the id of the search service." - ], "children": [ { "parentPluginId": "pluginA", - "id": "def-public.searchSpec", + "id": "def-public.Setup.getSearchService.$1", "type": "Object", "tags": [], "label": "searchSpec", @@ -1761,8 +2069,12 @@ } ], "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true } + ], + "returnComment": [ + "the id of the search service." ] }, { @@ -1779,24 +2091,41 @@ ], "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/plugin.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "pluginA", - "id": "def-public.searchSpec", + "id": "def-public.Setup.getSearchService2.$1.searchSpec", "type": "Object", "tags": [], "label": "searchSpec", - "description": [ - "Provide the settings neccessary to create a new Search Service" - ], - "signature": [ - "{ username: string; password: string; }" - ], + "description": [], "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/plugin.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "pluginA", + "id": "def-public.Setup.getSearchService2.$1.searchSpec.username", + "type": "string", + "tags": [], + "label": "username", + "description": [], + "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/plugin.ts", + "deprecated": false + }, + { + "parentPluginId": "pluginA", + "id": "def-public.Setup.getSearchService2.$1.searchSpec.password", + "type": "string", + "tags": [], + "label": "password", + "description": [], + "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/plugin.ts", + "deprecated": false + } + ] } - ] + ], + "returnComment": [] }, { "parentPluginId": "pluginA", @@ -1815,48 +2144,63 @@ "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/plugin.ts", "deprecated": true, "references": [], - "returnComment": [], "children": [ { "parentPluginId": "pluginA", - "id": "def-public.thingOne", + "id": "def-public.Setup.doTheThing.$1", "type": "number", "tags": [], "label": "thingOne", "description": [ "Thing one comment" ], + "signature": [ + "number" + ], "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "pluginA", - "id": "def-public.thingTwo", + "id": "def-public.Setup.doTheThing.$2", "type": "string", "tags": [], "label": "thingTwo", "description": [ "ThingTwo comment" ], + "signature": [ + "string" + ], "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/plugin.ts", - "deprecated": false + "deprecated": false, + "isRequired": true }, { "parentPluginId": "pluginA", - "id": "def-public.thingThree", + "id": "def-public.Setup.doTheThing.$3.thingThree", "type": "Object", "tags": [], "label": "thingThree", - "description": [ - "Thing three is an object with a nested var" - ], - "signature": [ - "{ nestedVar: number; }" - ], + "description": [], "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/plugin.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "pluginA", + "id": "def-public.Setup.doTheThing.$3.thingThree.nestedVar", + "type": "number", + "tags": [], + "label": "nestedVar", + "description": [], + "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/plugin.ts", + "deprecated": false + } + ] } - ] + ], + "returnComment": [] }, { "parentPluginId": "pluginA", @@ -1872,25 +2216,60 @@ ], "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/plugin.ts", "deprecated": false, - "returnComment": [ - "It's hard to tell but I think this returns a function that returns an object with a\nproperty that is a function that returns a string. Whoa." - ], "children": [ { "parentPluginId": "pluginA", - "id": "def-public.obj", + "id": "def-public.Setup.fnWithInlineParams.$1.obj", "type": "Object", "tags": [], "label": "obj", - "description": [ - "A funky parameter." - ], - "signature": [ - "{ fn: (foo: { param: string; }) => number; }" - ], + "description": [], "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/plugin.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "pluginA", + "id": "def-public.Setup.fnWithInlineParams.$1.obj.fn", + "type": "Function", + "tags": [], + "label": "fn", + "description": [], + "signature": [ + "(foo: { param: string; }) => number" + ], + "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/plugin.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "pluginA", + "id": "def-public.Setup.fnWithInlineParams.$1.obj.fn.$1.foo", + "type": "Object", + "tags": [], + "label": "foo", + "description": [], + "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/plugin.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "pluginA", + "id": "def-public.Setup.fnWithInlineParams.$1.obj.fn.$1.foo.param", + "type": "string", + "tags": [], + "label": "param", + "description": [], + "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/plugin.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [] + } + ] } + ], + "returnComment": [ + "It's hard to tell but I think this returns a function that returns an object with a\nproperty that is a function that returns a string. Whoa." ] }, { @@ -1934,10 +2313,10 @@ ], "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/plugin.ts", "deprecated": false, + "children": [], "returnComment": [ "The currently selected {@link SearchLanguage}" - ], - "children": [] + ] } ], "lifecycle": "start", diff --git a/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_a_foo.json b/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_a_foo.json index 83931cfa3b087..c7b43d9436cb9 100644 --- a/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_a_foo.json +++ b/packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_a_foo.json @@ -35,6 +35,8 @@ ], "path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/foo/index.ts", "deprecated": false, + "returnComment": [], + "children": [], "initialIsOpen": false } ], From 3555e74dc056105af512f5263194d2e87afffaae Mon Sep 17 00:00:00 2001 From: Kyle Pollich Date: Tue, 3 Aug 2021 11:58:20 -0400 Subject: [PATCH 05/63] [Fleet] Remove references to legacy Elasticsearch types (#107519) * Remove references to legacy elasticsearch types * Fix types * Fix more types --- .../fleet/server/errors/handlers.test.ts | 53 ------------------- .../plugins/fleet/server/errors/handlers.ts | 38 ------------- x-pack/plugins/fleet/server/errors/index.ts | 6 +-- 3 files changed, 1 insertion(+), 96 deletions(-) diff --git a/x-pack/plugins/fleet/server/errors/handlers.test.ts b/x-pack/plugins/fleet/server/errors/handlers.test.ts index dc6f90d64180d..2d3fddeb951f4 100644 --- a/x-pack/plugins/fleet/server/errors/handlers.test.ts +++ b/x-pack/plugins/fleet/server/errors/handlers.test.ts @@ -6,7 +6,6 @@ */ import Boom from '@hapi/boom'; -import { errors } from 'elasticsearch'; import { httpServerMock } from 'src/core/server/mocks'; import { createAppContextStartContractMock } from '../mocks'; @@ -20,9 +19,6 @@ import { defaultIngestErrorHandler, } from './index'; -const LegacyESErrors = errors as Record; -type ITestEsErrorsFnParams = [errorCode: string, error: any, expectedMessage: string]; - describe('defaultIngestErrorHandler', () => { let mockContract: ReturnType; beforeEach(async () => { @@ -36,55 +32,6 @@ describe('defaultIngestErrorHandler', () => { appContextService.stop(); }); - async function testEsErrorsFn(...args: ITestEsErrorsFnParams) { - const [, error, expectedMessage] = args; - jest.clearAllMocks(); - const response = httpServerMock.createResponseFactory(); - await defaultIngestErrorHandler({ error, response }); - - // response - expect(response.ok).toHaveBeenCalledTimes(0); - expect(response.customError).toHaveBeenCalledTimes(1); - expect(response.customError).toHaveBeenCalledWith({ - statusCode: error.status, - body: { message: expectedMessage }, - }); - - // logging - expect(mockContract.logger?.error).toHaveBeenCalledTimes(1); - expect(mockContract.logger?.error).toHaveBeenCalledWith(expectedMessage); - } - - describe('use the HTTP error status code provided by LegacyESErrors', () => { - const statusCodes = Object.keys(LegacyESErrors).filter((key) => /^\d+$/.test(key)); - const errorCodes = statusCodes.filter((key) => parseInt(key, 10) >= 400); - const casesWithPathResponse: ITestEsErrorsFnParams[] = errorCodes.map((errorCode) => [ - errorCode, - new LegacyESErrors[errorCode]('the root message', { - path: '/path/to/call', - response: 'response is here', - }), - 'the root message response from /path/to/call: response is here', - ]); - const casesWithOtherMeta: ITestEsErrorsFnParams[] = errorCodes.map((errorCode) => [ - errorCode, - new LegacyESErrors[errorCode]('the root message', { - other: '/path/to/call', - props: 'response is here', - }), - 'the root message', - ]); - const casesWithoutMeta: ITestEsErrorsFnParams[] = errorCodes.map((errorCode) => [ - errorCode, - new LegacyESErrors[errorCode]('some message'), - 'some message', - ]); - - test.each(casesWithPathResponse)('%d - with path & response', testEsErrorsFn); - test.each(casesWithOtherMeta)('%d - with other metadata', testEsErrorsFn); - test.each(casesWithoutMeta)('%d - without metadata', testEsErrorsFn); - }); - describe('IngestManagerError', () => { it('502: RegistryError', async () => { const error = new RegistryError('xyz'); diff --git a/x-pack/plugins/fleet/server/errors/handlers.ts b/x-pack/plugins/fleet/server/errors/handlers.ts index 073727729ad84..c47b1a07780ec 100644 --- a/x-pack/plugins/fleet/server/errors/handlers.ts +++ b/x-pack/plugins/fleet/server/errors/handlers.ts @@ -7,7 +7,6 @@ import type Boom from '@hapi/boom'; import { isBoom } from '@hapi/boom'; -import { errors as LegacyESErrors } from 'elasticsearch'; import type { IKibanaResponse, @@ -40,26 +39,6 @@ interface IngestErrorHandlerParams { // unsure if this is correct. would prefer to use something "official" // this type is based on BadRequest values observed while debugging https://github.com/elastic/kibana/issues/75862 -interface LegacyESClientError { - message: string; - stack: string; - status: number; - displayName: string; - path?: string; - query?: string | undefined; - body?: { - error: { - type: string; - }; - status: number; - }; - statusCode?: number; - response?: string; -} -export const isLegacyESClientError = (error: any): error is LegacyESClientError => { - return error instanceof LegacyESErrors._Abstract; -}; - const getHTTPResponseCode = (error: IngestManagerError): number => { if (error instanceof RegistryError) { return 502; // Bad Gateway @@ -84,23 +63,6 @@ const getHTTPResponseCode = (error: IngestManagerError): number => { export function ingestErrorToResponseOptions(error: IngestErrorHandlerParams['error']) { const logger = appContextService.getLogger(); - if (isLegacyESClientError(error)) { - // there was a problem communicating with ES (e.g. via `callCluster`) - // only log the message - const message = - error?.path && error?.response - ? // if possible, return the failing endpoint and its response - `${error.message} response from ${error.path}: ${error.response}` - : error.message; - - logger.error(message); - - return { - statusCode: error?.statusCode || error.status, - body: { message }, - }; - } - // our "expected" errors if (error instanceof IngestManagerError) { // only log the message diff --git a/x-pack/plugins/fleet/server/errors/index.ts b/x-pack/plugins/fleet/server/errors/index.ts index 335bd147ab585..f31719d6c4364 100644 --- a/x-pack/plugins/fleet/server/errors/index.ts +++ b/x-pack/plugins/fleet/server/errors/index.ts @@ -8,11 +8,7 @@ /* eslint-disable max-classes-per-file */ import { isESClientError } from './utils'; -export { - defaultIngestErrorHandler, - ingestErrorToResponseOptions, - isLegacyESClientError, -} from './handlers'; +export { defaultIngestErrorHandler, ingestErrorToResponseOptions } from './handlers'; export { isESClientError } from './utils'; From 76881a241d51921d8fb84178d2db6bf66ecc4383 Mon Sep 17 00:00:00 2001 From: Patrick Mueller Date: Tue, 3 Aug 2021 12:06:45 -0400 Subject: [PATCH 06/63] [actions] change cloud icon usage for the customHostSettings connector settings (#107481) Adds the cloud icon to `xpack.actions.customHostSettings[n].ssl.verificationMode` and removes it from `xpack.actions.customHostSettings[n].ssl.rejectUnauthorized`, in the actions configuration documentation. The doc was written before `verificationMode` was added and `rejectUnauthorized` was deprecated. --- docs/settings/alert-action-settings.asciidoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/settings/alert-action-settings.asciidoc b/docs/settings/alert-action-settings.asciidoc index a523c2cb005a2..4bcbdd7843671 100644 --- a/docs/settings/alert-action-settings.asciidoc +++ b/docs/settings/alert-action-settings.asciidoc @@ -117,13 +117,13 @@ xpack.actions.customHostSettings: The options `smtp.ignoreTLS` and `smtp.requireTLS` can not both be set to true. | `xpack.actions.customHostSettings[n]` -`.ssl.rejectUnauthorized` {ess-icon} +`.ssl.rejectUnauthorized` | Deprecated. Use <> instead. A boolean value indicating whether to bypass server certificate validation. Overrides the general `xpack.actions.rejectUnauthorized` configuration for requests made for this hostname/port. |[[action-config-custom-host-verification-mode]] `xpack.actions.customHostSettings[n]` -`.ssl.verificationMode` +`.ssl.verificationMode` {ess-icon} | Controls the verification of the server certificate that {hosted-ems} receives when making an outbound SSL/TLS connection to the host server. Valid values are `full`, `certificate`, and `none`. Use `full` to perform hostname verification, `certificate` to skip hostname verification, and `none` to skip verification. Default: `full`. <>. Overrides the general `xpack.actions.ssl.verificationMode` configuration for requests made for this hostname/port. From 1750ebb951d3c728db5f0a5dc7a3dee7addfd7ec Mon Sep 17 00:00:00 2001 From: Byron Hulcher Date: Tue, 3 Aug 2021 12:16:39 -0400 Subject: [PATCH 07/63] [App Search] Crawler Overview: Migrate Crawl Requests Table, Add Domains Table empty state (#107436) * New CrawlRequest type * Add crawlRequests value to CrawlerOverviewLogic * New CrawlRequestsTable component * Added CrawlRequestsTable to CrawlerOverview * Hide the CrawlRequest table when there are no domains or crawl requests for an engine * Add an empty state for CrawlerOverview when there are no domains * Remove unused import * Fix AddDomainLogic tests * Apply suggestions from code review Co-authored-by: Constance * Fix capitalization * Clarify test expectations * Use noItemsMessage prop for CrawlRequestsTable empty state * Refactor crawl requests logic * Fix heading sizes * Remove unused variable Co-authored-by: Constance --- .../components/crawl_requests_table.test.tsx | 103 ++++++++++++++++ .../components/crawl_requests_table.tsx | 89 ++++++++++++++ .../crawler/crawler_overview.test.tsx | 114 ++++++++++++++++-- .../components/crawler/crawler_overview.tsx | 106 +++++++++++++--- .../crawler/crawler_overview_logic.test.ts | 89 +++++++++++--- .../crawler/crawler_overview_logic.ts | 29 ++++- .../app_search/components/crawler/types.ts | 74 ++++++++++++ .../components/crawler/utils.test.ts | 108 +++++++++++++---- .../app_search/components/crawler/utils.ts | 20 +++ .../server/routes/app_search/crawler.test.ts | 33 +++++ .../server/routes/app_search/crawler.ts | 14 +++ 11 files changed, 715 insertions(+), 64 deletions(-) create mode 100644 x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/components/crawl_requests_table.test.tsx create mode 100644 x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/components/crawl_requests_table.tsx diff --git a/x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/components/crawl_requests_table.test.tsx b/x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/components/crawl_requests_table.test.tsx new file mode 100644 index 0000000000000..80c72235f7a4a --- /dev/null +++ b/x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/components/crawl_requests_table.test.tsx @@ -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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { setMockValues } from '../../../../__mocks__/kea_logic'; +import '../../../__mocks__/engine_logic.mock'; + +import React from 'react'; + +import { shallow, ShallowWrapper } from 'enzyme'; + +import { EuiBasicTable, EuiEmptyPrompt } from '@elastic/eui'; + +import { mountWithIntl } from '../../../../test_helpers'; + +import { + CrawlerDomain, + CrawlerPolicies, + CrawlerRules, + CrawlerStatus, + CrawlRequest, +} from '../types'; + +import { CrawlRequestsTable } from './crawl_requests_table'; + +const values: { domains: CrawlerDomain[]; crawlRequests: CrawlRequest[] } = { + // CrawlerOverviewLogic + domains: [ + { + id: '507f1f77bcf86cd799439011', + createdOn: 'Mon, 31 Aug 2020 17:00:00 +0000', + url: 'elastic.co', + documentCount: 13, + sitemaps: [], + entryPoints: [], + crawlRules: [], + defaultCrawlRule: { + id: '-', + policy: CrawlerPolicies.allow, + rule: CrawlerRules.regex, + pattern: '.*', + }, + }, + ], + crawlRequests: [ + { + id: '618d0e66abe97bc688328900', + status: CrawlerStatus.Pending, + createdAt: 'Mon, 31 Aug 2020 17:00:00 +0000', + beganAt: null, + completedAt: null, + }, + ], +}; + +describe('CrawlRequestsTable', () => { + let wrapper: ShallowWrapper; + let tableContent: string; + + beforeEach(() => { + jest.clearAllMocks(); + }); + + describe('columns', () => { + beforeAll(() => { + setMockValues(values); + wrapper = shallow(); + tableContent = mountWithIntl() + .find(EuiBasicTable) + .text(); + }); + + it('renders an id column', () => { + expect(tableContent).toContain('618d0e66abe97bc688328900'); + }); + + it('renders a created at column', () => { + expect(tableContent).toContain('Created'); + expect(tableContent).toContain('Aug 31, 2020'); + }); + + it('renders a status column', () => { + expect(tableContent).toContain('Status'); + expect(tableContent).toContain('Pending'); + }); + }); + + describe('no items message', () => { + it('displays an empty prompt when there are no crawl requests', () => { + setMockValues({ + ...values, + crawlRequests: [], + }); + + wrapper = shallow(); + + expect(wrapper.find(EuiBasicTable).dive().find(EuiEmptyPrompt)).toHaveLength(1); + }); + }); +}); diff --git a/x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/components/crawl_requests_table.tsx b/x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/components/crawl_requests_table.tsx new file mode 100644 index 0000000000000..19b1a543ad207 --- /dev/null +++ b/x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/components/crawl_requests_table.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 { useValues } from 'kea'; + +import { EuiBasicTable, EuiEmptyPrompt, EuiTableFieldDataColumnType } from '@elastic/eui'; + +import { i18n } from '@kbn/i18n'; + +import { CrawlerOverviewLogic } from '../crawler_overview_logic'; +import { CrawlRequest, readableCrawlerStatuses } from '../types'; + +import { CustomFormattedTimestamp } from './custom_formatted_timestamp'; + +const columns: Array> = [ + { + field: 'id', + name: i18n.translate( + 'xpack.enterpriseSearch.appSearch.crawler.crawlRequestsTable.column.domainURL', + { + defaultMessage: 'Request ID', + } + ), + }, + { + field: 'createdAt', + name: i18n.translate( + 'xpack.enterpriseSearch.appSearch.crawler.crawlRequestsTable.column.created', + { + defaultMessage: 'Created', + } + ), + render: (createdAt: CrawlRequest['createdAt']) => ( + + ), + }, + { + field: 'status', + name: i18n.translate( + 'xpack.enterpriseSearch.appSearch.crawler.crawlRequestsTable.column.status', + { + defaultMessage: 'Status', + } + ), + render: (status: CrawlRequest['status']) => readableCrawlerStatuses[status], + }, +]; + +export const CrawlRequestsTable: React.FC = () => { + const { crawlRequests } = useValues(CrawlerOverviewLogic); + + return ( + + {i18n.translate( + 'xpack.enterpriseSearch.appSearch.crawler.crawlRequestsTable.emptyPrompt.title', + { + defaultMessage: 'No recent crawl requests', + } + )} + + } + body={ +

+ {i18n.translate( + 'xpack.enterpriseSearch.appSearch.crawler.crawlRequestsTable.emptyPrompt.body', + { + defaultMessage: "You haven't started any crawls yet.", + } + )} +

+ } + /> + } + /> + ); +}; diff --git a/x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/crawler_overview.test.tsx b/x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/crawler_overview.test.tsx index 610ad1f571699..e46804a658803 100644 --- a/x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/crawler_overview.test.tsx +++ b/x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/crawler_overview.test.tsx @@ -11,11 +11,66 @@ import '../../__mocks__/engine_logic.mock'; import React from 'react'; -import { shallow, ShallowWrapper } from 'enzyme'; +import { shallow } from 'enzyme'; import { AddDomainFlyout } from './components/add_domain/add_domain_flyout'; +import { AddDomainForm } from './components/add_domain/add_domain_form'; +import { AddDomainFormSubmitButton } from './components/add_domain/add_domain_form_submit_button'; +import { CrawlRequestsTable } from './components/crawl_requests_table'; import { DomainsTable } from './components/domains_table'; import { CrawlerOverview } from './crawler_overview'; +import { + CrawlerDomainFromServer, + CrawlerPolicies, + CrawlerRules, + CrawlerStatus, + CrawlRequestFromServer, +} from './types'; + +const domains: CrawlerDomainFromServer[] = [ + { + id: 'x', + name: 'moviedatabase.com', + document_count: 13, + created_on: 'Mon, 31 Aug 2020 17:00:00 +0000', + sitemaps: [], + entry_points: [], + crawl_rules: [], + default_crawl_rule: { + id: '-', + policy: CrawlerPolicies.allow, + rule: CrawlerRules.regex, + pattern: '.*', + }, + }, + { + id: 'y', + name: 'swiftype.com', + last_visited_at: 'Mon, 31 Aug 2020 17:00:00 +0000', + document_count: 40, + created_on: 'Mon, 31 Aug 2020 17:00:00 +0000', + sitemaps: [], + entry_points: [], + crawl_rules: [], + }, +]; + +const crawlRequests: CrawlRequestFromServer[] = [ + { + id: 'a', + status: CrawlerStatus.Canceled, + created_at: 'Mon, 31 Aug 2020 11:00:00 +0000', + began_at: 'Mon, 31 Aug 2020 12:00:00 +0000', + completed_at: 'Mon, 31 Aug 2020 13:00:00 +0000', + }, + { + id: 'b', + status: CrawlerStatus.Success, + created_at: 'Mon, 31 Aug 2020 14:00:00 +0000', + began_at: 'Mon, 31 Aug 2020 15:00:00 +0000', + completed_at: 'Mon, 31 Aug 2020 16:00:00 +0000', + }, +]; describe('CrawlerOverview', () => { const mockActions = { @@ -24,29 +79,68 @@ describe('CrawlerOverview', () => { const mockValues = { dataLoading: false, - domains: [], + domains, + crawlRequests, }; - let wrapper: ShallowWrapper; - beforeEach(() => { jest.clearAllMocks(); - setMockValues(mockValues); setMockActions(mockActions); - wrapper = shallow(); }); it('calls fetchCrawlerData on page load', () => { + setMockValues(mockValues); + + shallow(); + expect(mockActions.fetchCrawlerData).toHaveBeenCalledTimes(1); }); - it('renders', () => { - expect(wrapper.find(DomainsTable)).toHaveLength(1); + it('hides the domain and crawl request tables when there are no domains, and no crawl requests', () => { + setMockValues({ ...mockValues, domains: [], crawlRequests: [] }); + + const wrapper = shallow(); + + expect(wrapper.find(AddDomainForm)).toHaveLength(1); + expect(wrapper.find(AddDomainFormSubmitButton)).toHaveLength(1); + expect(wrapper.find(AddDomainFlyout)).toHaveLength(0); + expect(wrapper.find(DomainsTable)).toHaveLength(0); + expect(wrapper.find(CrawlRequestsTable)).toHaveLength(0); + }); + + it('shows the domain and the crawl request tables when there are domains, but no crawl requests', () => { + setMockValues({ ...mockValues, crawlRequests: [] }); - // TODO test for CrawlRequestsTable after it is built in a future PR + const wrapper = shallow(); + expect(wrapper.find(AddDomainForm)).toHaveLength(0); + expect(wrapper.find(AddDomainFormSubmitButton)).toHaveLength(0); expect(wrapper.find(AddDomainFlyout)).toHaveLength(1); + expect(wrapper.find(DomainsTable)).toHaveLength(1); + expect(wrapper.find(CrawlRequestsTable)).toHaveLength(1); + }); + + it('hides the domain table and shows the crawl request tables when there are crawl requests but no domains', () => { + setMockValues({ ...mockValues, domains: [] }); + + const wrapper = shallow(); + + expect(wrapper.find(AddDomainForm)).toHaveLength(1); + expect(wrapper.find(AddDomainFormSubmitButton)).toHaveLength(1); + expect(wrapper.find(AddDomainFlyout)).toHaveLength(0); + expect(wrapper.find(DomainsTable)).toHaveLength(0); + expect(wrapper.find(CrawlRequestsTable)).toHaveLength(1); + }); - // TODO test for empty state after it is built in a future PR + it('shows the domain and the crawl request tables when there are crawl requests and domains', () => { + setMockValues(mockValues); + + const wrapper = shallow(); + + expect(wrapper.find(AddDomainForm)).toHaveLength(0); + expect(wrapper.find(AddDomainFormSubmitButton)).toHaveLength(0); + expect(wrapper.find(AddDomainFlyout)).toHaveLength(1); + expect(wrapper.find(DomainsTable)).toHaveLength(1); + expect(wrapper.find(CrawlRequestsTable)).toHaveLength(1); }); }); diff --git a/x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/crawler_overview.tsx b/x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/crawler_overview.tsx index 0daac399b7b09..1f676467a5503 100644 --- a/x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/crawler_overview.tsx +++ b/x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/crawler_overview.tsx @@ -9,20 +9,24 @@ import React, { useEffect } from 'react'; import { useActions, useValues } from 'kea'; -import { EuiFlexGroup, EuiFlexItem, EuiSpacer, EuiTitle } from '@elastic/eui'; +import { EuiFlexGroup, EuiFlexItem, EuiLink, EuiSpacer, EuiText, EuiTitle } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; +import { DOCS_PREFIX } from '../../routes'; import { getEngineBreadcrumbs } from '../engine'; import { AppSearchPageTemplate } from '../layout'; import { AddDomainFlyout } from './components/add_domain/add_domain_flyout'; +import { AddDomainForm } from './components/add_domain/add_domain_form'; +import { AddDomainFormSubmitButton } from './components/add_domain/add_domain_form_submit_button'; +import { CrawlRequestsTable } from './components/crawl_requests_table'; import { DomainsTable } from './components/domains_table'; import { CRAWLER_TITLE } from './constants'; import { CrawlerOverviewLogic } from './crawler_overview_logic'; export const CrawlerOverview: React.FC = () => { - const { dataLoading } = useValues(CrawlerOverviewLogic); + const { crawlRequests, dataLoading, domains } = useValues(CrawlerOverviewLogic); const { fetchCrawlerData } = useActions(CrawlerOverviewLogic); @@ -36,22 +40,94 @@ export const CrawlerOverview: React.FC = () => { pageHeader={{ pageTitle: CRAWLER_TITLE }} isLoading={dataLoading} > - - + {domains.length > 0 ? ( + <> + + + +

+ {i18n.translate('xpack.enterpriseSearch.appSearch.crawler.domainsTitle', { + defaultMessage: 'Domains', + })} +

+ + + + + + + + + + ) : ( + <> -

- {i18n.translate('xpack.enterpriseSearch.appSearch.crawler.domainsTitle', { - defaultMessage: 'Domains', +

+ {i18n.translate('xpack.enterpriseSearch.appSearch.crawler.empty.title', { + defaultMessage: 'Add a domain to get started', })} -

+ - - - - - - - + +

+ {i18n.translate('xpack.enterpriseSearch.appSearch.crawler.empty.description', { + defaultMessage: + "Easily index your website's content. To get started, enter your domain name, provide optional entry points and crawl rules, and we will handle the rest.", + })}{' '} + + {i18n.translate( + 'xpack.enterpriseSearch.appSearch.crawler.empty.crawlerDocumentationLinkDescription', + { + defaultMessage: 'Learn more about the web crawler', + } + )} + +

+ + + + + + + + + + )} + {(crawlRequests.length > 0 || domains.length > 0) && ( + <> + + +

+ {i18n.translate('xpack.enterpriseSearch.appSearch.crawler.crawlRequestsTitle', { + defaultMessage: 'Recent crawl requests', + })} +

+ + + +

+ {i18n.translate('xpack.enterpriseSearch.appSearch.crawler.crawlRequestsDescription', { + defaultMessage: + "Recent crawl requests are logged here. Using the request ID of each crawl, you can track progress and examine crawl events in Kibana's Discover or Logs user interfaces.", + })}{' '} + + {i18n.translate( + 'xpack.enterpriseSearch.appSearch.crawler.configurationDocumentationLinkDescription', + { + defaultMessage: 'Learn more about configuring crawler logs in Kibana', + } + )} + +

+ + + + + )} ); }; diff --git a/x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/crawler_overview_logic.test.ts b/x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/crawler_overview_logic.test.ts index 146f31eab8a97..6ec0cb0f26a78 100644 --- a/x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/crawler_overview_logic.test.ts +++ b/x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/crawler_overview_logic.test.ts @@ -14,17 +14,22 @@ import '../../__mocks__/engine_logic.mock'; import { nextTick } from '@kbn/test/jest'; -import { CrawlerOverviewLogic } from './crawler_overview_logic'; +import { CrawlerOverviewLogic, CrawlerOverviewValues } from './crawler_overview_logic'; import { + CrawlerData, CrawlerDataFromServer, CrawlerDomain, CrawlerPolicies, CrawlerRules, + CrawlerStatus, + CrawlRequest, + CrawlRequestFromServer, CrawlRule, } from './types'; -import { crawlerDataServerToClient } from './utils'; +import { crawlerDataServerToClient, crawlRequestServerToClient } from './utils'; -const DEFAULT_VALUES = { +const DEFAULT_VALUES: CrawlerOverviewValues = { + crawlRequests: [], dataLoading: true, domains: [], }; @@ -36,7 +41,7 @@ const DEFAULT_CRAWL_RULE: CrawlRule = { pattern: '.*', }; -const MOCK_SERVER_DATA: CrawlerDataFromServer = { +const MOCK_SERVER_CRAWLER_DATA: CrawlerDataFromServer = { domains: [ { id: '507f1f77bcf86cd799439011', @@ -50,7 +55,20 @@ const MOCK_SERVER_DATA: CrawlerDataFromServer = { ], }; -const MOCK_CLIENT_DATA = crawlerDataServerToClient(MOCK_SERVER_DATA); +const MOCK_SERVER_CRAWL_REQUESTS_DATA: CrawlRequestFromServer[] = [ + { + id: '618d0e66abe97bc688328900', + status: CrawlerStatus.Pending, + created_at: 'Mon, 31 Aug 2020 17:00:00 +0000', + began_at: null, + completed_at: null, + }, +]; + +const MOCK_CLIENT_CRAWLER_DATA = crawlerDataServerToClient(MOCK_SERVER_CRAWLER_DATA); +const MOCK_CLIENT_CRAWL_REQUESTS_DATA = MOCK_SERVER_CRAWL_REQUESTS_DATA.map( + crawlRequestServerToClient +); describe('CrawlerOverviewLogic', () => { const { mount } = new LogicMounter(CrawlerOverviewLogic); @@ -68,7 +86,7 @@ describe('CrawlerOverviewLogic', () => { describe('actions', () => { describe('onReceiveCrawlerData', () => { - const crawlerData = { + const crawlerData: CrawlerData = { domains: [ { id: '507f1f77bcf86cd799439011', @@ -95,25 +113,68 @@ describe('CrawlerOverviewLogic', () => { expect(CrawlerOverviewLogic.values.dataLoading).toEqual(false); }); }); + + describe('onReceiveCrawlRequests', () => { + const crawlRequests: CrawlRequest[] = [ + { + id: '618d0e66abe97bc688328900', + status: CrawlerStatus.Pending, + createdAt: 'Mon, 31 Aug 2020 17:00:00 +0000', + beganAt: null, + completedAt: null, + }, + ]; + + beforeEach(() => { + CrawlerOverviewLogic.actions.onReceiveCrawlRequests(crawlRequests); + }); + + it('should set the crawl requests', () => { + expect(CrawlerOverviewLogic.values.crawlRequests).toEqual(crawlRequests); + }); + }); }); describe('listeners', () => { describe('fetchCrawlerData', () => { - it('calls onReceiveCrawlerData with retrieved data that has been converted from server to client', async () => { + it('updates logic with data that has been converted from server to client', async () => { jest.spyOn(CrawlerOverviewLogic.actions, 'onReceiveCrawlerData'); + // TODO this spyOn should be removed when crawl request polling is added + jest.spyOn(CrawlerOverviewLogic.actions, 'onReceiveCrawlRequests'); - http.get.mockReturnValue(Promise.resolve(MOCK_SERVER_DATA)); + // TODO this first mock for MOCK_SERVER_CRAWL_REQUESTS_DATA should be removed when crawl request polling is added + http.get.mockReturnValueOnce(Promise.resolve(MOCK_SERVER_CRAWL_REQUESTS_DATA)); + http.get.mockReturnValueOnce(Promise.resolve(MOCK_SERVER_CRAWLER_DATA)); CrawlerOverviewLogic.actions.fetchCrawlerData(); await nextTick(); - expect(http.get).toHaveBeenCalledWith('/api/app_search/engines/some-engine/crawler'); + expect(http.get).toHaveBeenNthCalledWith( + 1, + '/api/app_search/engines/some-engine/crawler/crawl_requests' + ); + expect(CrawlerOverviewLogic.actions.onReceiveCrawlRequests).toHaveBeenCalledWith( + MOCK_CLIENT_CRAWL_REQUESTS_DATA + ); + + expect(http.get).toHaveBeenNthCalledWith(2, '/api/app_search/engines/some-engine/crawler'); expect(CrawlerOverviewLogic.actions.onReceiveCrawlerData).toHaveBeenCalledWith( - MOCK_CLIENT_DATA + MOCK_CLIENT_CRAWLER_DATA ); }); - it('calls flashApiErrors when there is an error', async () => { - http.get.mockReturnValue(Promise.reject('error')); + // TODO this test should be removed when crawl request polling is added + it('calls flashApiErrors when there is an error on the request for crawl results', async () => { + http.get.mockReturnValueOnce(Promise.reject('error')); + CrawlerOverviewLogic.actions.fetchCrawlerData(); + await nextTick(); + + expect(flashAPIErrors).toHaveBeenCalledWith('error'); + }); + + it('calls flashApiErrors when there is an error on the request for crawler data', async () => { + // TODO this first mock for MOCK_SERVER_CRAWL_REQUESTS_DATA should be removed when crawl request polling is added + http.get.mockReturnValueOnce(Promise.resolve(MOCK_SERVER_CRAWL_REQUESTS_DATA)); + http.get.mockReturnValueOnce(Promise.reject('error')); CrawlerOverviewLogic.actions.fetchCrawlerData(); await nextTick(); @@ -125,7 +186,7 @@ describe('CrawlerOverviewLogic', () => { it('calls onReceiveCrawlerData with retrieved data that has been converted from server to client', async () => { jest.spyOn(CrawlerOverviewLogic.actions, 'onReceiveCrawlerData'); - http.delete.mockReturnValue(Promise.resolve(MOCK_SERVER_DATA)); + http.delete.mockReturnValue(Promise.resolve(MOCK_SERVER_CRAWLER_DATA)); CrawlerOverviewLogic.actions.deleteDomain({ id: '1234' } as CrawlerDomain); await nextTick(); @@ -136,7 +197,7 @@ describe('CrawlerOverviewLogic', () => { } ); expect(CrawlerOverviewLogic.actions.onReceiveCrawlerData).toHaveBeenCalledWith( - MOCK_CLIENT_DATA + MOCK_CLIENT_CRAWLER_DATA ); expect(flashSuccessToast).toHaveBeenCalled(); }); diff --git a/x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/crawler_overview_logic.ts b/x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/crawler_overview_logic.ts index 3f64cbbd9a866..5d6d1db2bd8a3 100644 --- a/x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/crawler_overview_logic.ts +++ b/x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/crawler_overview_logic.ts @@ -14,8 +14,8 @@ import { flashAPIErrors, flashSuccessToast } from '../../../shared/flash_message import { HttpLogic } from '../../../shared/http'; import { EngineLogic } from '../engine'; -import { CrawlerData, CrawlerDomain } from './types'; -import { crawlerDataServerToClient } from './utils'; +import { CrawlerData, CrawlerDomain, CrawlRequest, CrawlRequestFromServer } from './types'; +import { crawlerDataServerToClient, crawlRequestServerToClient } from './utils'; export const DELETE_DOMAIN_MESSAGE = (domainUrl: string) => i18n.translate( @@ -28,7 +28,8 @@ export const DELETE_DOMAIN_MESSAGE = (domainUrl: string) => } ); -interface CrawlerOverviewValues { +export interface CrawlerOverviewValues { + crawlRequests: CrawlRequest[]; dataLoading: boolean; domains: CrawlerDomain[]; } @@ -37,6 +38,7 @@ interface CrawlerOverviewActions { deleteDomain(domain: CrawlerDomain): { domain: CrawlerDomain }; fetchCrawlerData(): void; onReceiveCrawlerData(data: CrawlerData): { data: CrawlerData }; + onReceiveCrawlRequests(crawlRequests: CrawlRequest[]): { crawlRequests: CrawlRequest[] }; } export const CrawlerOverviewLogic = kea< @@ -47,6 +49,7 @@ export const CrawlerOverviewLogic = kea< deleteDomain: (domain) => ({ domain }), fetchCrawlerData: true, onReceiveCrawlerData: (data) => ({ data }), + onReceiveCrawlRequests: (crawlRequests) => ({ crawlRequests }), }, reducers: { dataLoading: [ @@ -61,15 +64,35 @@ export const CrawlerOverviewLogic = kea< onReceiveCrawlerData: (_, { data: { domains } }) => domains, }, ], + crawlRequests: [ + [], + { + onReceiveCrawlRequests: (_, { crawlRequests }) => crawlRequests, + }, + ], }, listeners: ({ actions }) => ({ fetchCrawlerData: async () => { const { http } = HttpLogic.values; const { engineName } = EngineLogic.values; + // TODO Remove fetching crawl requests here once Crawl Request Polling is implemented + try { + const crawlResultsResponse: CrawlRequestFromServer[] = await http.get( + `/api/app_search/engines/${engineName}/crawler/crawl_requests` + ); + + const crawlRequests = crawlResultsResponse.map(crawlRequestServerToClient); + actions.onReceiveCrawlRequests(crawlRequests); + } catch (e) { + flashAPIErrors(e); + } + try { const response = await http.get(`/api/app_search/engines/${engineName}/crawler`); + const crawlerData = crawlerDataServerToClient(response); + actions.onReceiveCrawlerData(crawlerData); } catch (e) { flashAPIErrors(e); diff --git a/x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/types.ts b/x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/types.ts index 38f06c7fab927..8f1abd6cb055b 100644 --- a/x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/types.ts +++ b/x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/types.ts @@ -5,6 +5,8 @@ * 2.0. */ +import { i18n } from '@kbn/i18n'; + export enum CrawlerPolicies { allow = 'allow', deny = 'deny', @@ -101,3 +103,75 @@ export type CrawlerDomainValidationStepName = | 'networkConnectivity' | 'indexingRestrictions' | 'contentVerification'; +// See SharedTogo::Crawler::Status for details on how these are generated +export enum CrawlerStatus { + Pending = 'pending', + Suspended = 'suspended', + Starting = 'starting', + Running = 'running', + Suspending = 'suspending', + Canceling = 'canceling', + Success = 'success', + Failed = 'failed', + Canceled = 'canceled', + Skipped = 'skipped', +} + +export interface CrawlRequestFromServer { + id: string; + status: CrawlerStatus; + created_at: string; + began_at: string | null; + completed_at: string | null; +} + +export interface CrawlRequest { + id: string; + status: CrawlerStatus; + createdAt: string; + beganAt: string | null; + completedAt: string | null; +} + +export const readableCrawlerStatuses: { [key in CrawlerStatus]: string } = { + [CrawlerStatus.Pending]: i18n.translate( + 'xpack.enterpriseSearch.appSearch.crawler.crawlerStatusOptions.pending', + { defaultMessage: 'Pending' } + ), + [CrawlerStatus.Suspended]: i18n.translate( + 'xpack.enterpriseSearch.appSearch.crawler.crawlerStatusOptions.suspended', + { defaultMessage: 'Suspended' } + ), + [CrawlerStatus.Starting]: i18n.translate( + 'xpack.enterpriseSearch.appSearch.crawler.crawlerStatusOptions.starting', + { defaultMessage: 'Starting' } + ), + [CrawlerStatus.Running]: i18n.translate( + 'xpack.enterpriseSearch.appSearch.crawler.crawlerStatusOptions.running', + { defaultMessage: 'Running' } + ), + [CrawlerStatus.Suspending]: i18n.translate( + 'xpack.enterpriseSearch.appSearch.crawler.crawlerStatusOptions.suspending', + { defaultMessage: 'Suspending' } + ), + [CrawlerStatus.Canceling]: i18n.translate( + 'xpack.enterpriseSearch.appSearch.crawler.crawlerStatusOptions.canceling', + { defaultMessage: 'Canceling' } + ), + [CrawlerStatus.Success]: i18n.translate( + 'xpack.enterpriseSearch.appSearch.crawler.crawlerStatusOptions.success', + { defaultMessage: 'Success' } + ), + [CrawlerStatus.Failed]: i18n.translate( + 'xpack.enterpriseSearch.appSearch.crawler.crawlerStatusOptions.failed', + { defaultMessage: 'Failed' } + ), + [CrawlerStatus.Canceled]: i18n.translate( + 'xpack.enterpriseSearch.appSearch.crawler.crawlerStatusOptions.canceled', + { defaultMessage: 'Canceled' } + ), + [CrawlerStatus.Skipped]: i18n.translate( + 'xpack.enterpriseSearch.appSearch.crawler.crawlerStatusOptions.skipped', + { defaultMessage: 'Skipped' } + ), +}; diff --git a/x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/utils.test.ts b/x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/utils.test.ts index c1b715f5d823a..95a7c714eba6a 100644 --- a/x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/utils.test.ts +++ b/x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/utils.test.ts @@ -12,12 +12,17 @@ import { CrawlerDomainFromServer, CrawlerDomainValidationStep, CrawlerDomainValidationResultFromServer, + CrawlRequestFromServer, + CrawlerStatus, + CrawlerData, + CrawlRequest, } from './types'; import { crawlerDomainServerToClient, crawlerDataServerToClient, crawlDomainValidationToResult, + crawlRequestServerToClient, } from './utils'; const DEFAULT_CRAWL_RULE: CrawlRule = { @@ -68,38 +73,97 @@ describe('crawlerDomainServerToClient', () => { }); }); +describe('crawlRequestServerToClient', () => { + it('converts the API payload into properties matching our code style', () => { + const id = '507f1f77bcf86cd799439011'; + + const defaultServerPayload: CrawlRequestFromServer = { + id, + status: CrawlerStatus.Pending, + created_at: 'Mon, 31 Aug 2020 17:00:00 +0000', + began_at: null, + completed_at: null, + }; + + const defaultClientPayload: CrawlRequest = { + id, + status: CrawlerStatus.Pending, + createdAt: 'Mon, 31 Aug 2020 17:00:00 +0000', + beganAt: null, + completedAt: null, + }; + + expect(crawlRequestServerToClient(defaultServerPayload)).toStrictEqual(defaultClientPayload); + expect( + crawlRequestServerToClient({ + ...defaultServerPayload, + began_at: 'Mon, 31 Aug 2020 17:00:00 +0000', + }) + ).toStrictEqual({ ...defaultClientPayload, beganAt: 'Mon, 31 Aug 2020 17:00:00 +0000' }); + expect( + crawlRequestServerToClient({ + ...defaultServerPayload, + completed_at: 'Mon, 31 Aug 2020 17:00:00 +0000', + }) + ).toStrictEqual({ ...defaultClientPayload, completedAt: 'Mon, 31 Aug 2020 17:00:00 +0000' }); + }); +}); + describe('crawlerDataServerToClient', () => { + let output: CrawlerData; + + const domains: CrawlerDomainFromServer[] = [ + { + id: 'x', + name: 'moviedatabase.com', + document_count: 13, + created_on: 'Mon, 31 Aug 2020 17:00:00 +0000', + sitemaps: [], + entry_points: [], + crawl_rules: [], + default_crawl_rule: DEFAULT_CRAWL_RULE, + }, + { + id: 'y', + name: 'swiftype.com', + last_visited_at: 'Mon, 31 Aug 2020 17:00:00 +0000', + document_count: 40, + created_on: 'Mon, 31 Aug 2020 17:00:00 +0000', + sitemaps: [], + entry_points: [], + crawl_rules: [], + }, + ]; + + beforeAll(() => { + output = crawlerDataServerToClient({ + domains, + }); + }); + it('converts all domains from the server form to their client form', () => { - const domains: CrawlerDomainFromServer[] = [ + expect(output.domains).toEqual([ { id: 'x', - name: 'moviedatabase.com', - document_count: 13, - created_on: 'Mon, 31 Aug 2020 17:00:00 +0000', + url: 'moviedatabase.com', + documentCount: 13, + createdOn: 'Mon, 31 Aug 2020 17:00:00 +0000', sitemaps: [], - entry_points: [], - crawl_rules: [], - default_crawl_rule: DEFAULT_CRAWL_RULE, + entryPoints: [], + crawlRules: [], + defaultCrawlRule: DEFAULT_CRAWL_RULE, }, { id: 'y', - name: 'swiftype.com', - last_visited_at: 'Mon, 31 Aug 2020 17:00:00 +0000', - document_count: 40, - created_on: 'Mon, 31 Aug 2020 17:00:00 +0000', + url: 'swiftype.com', + lastCrawl: 'Mon, 31 Aug 2020 17:00:00 +0000', + documentCount: 40, + createdOn: 'Mon, 31 Aug 2020 17:00:00 +0000', sitemaps: [], - entry_points: [], - crawl_rules: [], + entryPoints: [], + crawlRules: [], }, - ]; - - const output = crawlerDataServerToClient({ - domains, - }); - - expect(output.domains).toHaveLength(2); - expect(output.domains[0]).toEqual(crawlerDomainServerToClient(domains[0])); - expect(output.domains[1]).toEqual(crawlerDomainServerToClient(domains[1])); + ]); }); }); diff --git a/x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/utils.ts b/x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/utils.ts index f466c3d2faca0..fe759044b3e1b 100644 --- a/x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/utils.ts +++ b/x-pack/plugins/enterprise_search/public/applications/app_search/components/crawler/utils.ts @@ -12,6 +12,8 @@ import { CrawlerDataFromServer, CrawlerDomainValidationResultFromServer, CrawlerDomainValidationStep, + CrawlRequestFromServer, + CrawlRequest, } from './types'; export function crawlerDomainServerToClient(payload: CrawlerDomainFromServer): CrawlerDomain { @@ -48,6 +50,24 @@ export function crawlerDomainServerToClient(payload: CrawlerDomainFromServer): C return clientPayload; } +export function crawlRequestServerToClient(crawlRequest: CrawlRequestFromServer): CrawlRequest { + const { + id, + status, + created_at: createdAt, + began_at: beganAt, + completed_at: completedAt, + } = crawlRequest; + + return { + id, + status, + createdAt, + beganAt, + completedAt, + }; +} + export function crawlerDataServerToClient(payload: CrawlerDataFromServer): CrawlerData { const { domains } = payload; diff --git a/x-pack/plugins/enterprise_search/server/routes/app_search/crawler.test.ts b/x-pack/plugins/enterprise_search/server/routes/app_search/crawler.test.ts index 499b8da25774e..f54771e2bef9a 100644 --- a/x-pack/plugins/enterprise_search/server/routes/app_search/crawler.test.ts +++ b/x-pack/plugins/enterprise_search/server/routes/app_search/crawler.test.ts @@ -43,6 +43,39 @@ describe('crawler routes', () => { }); }); + describe('GET /api/app_search/engines/{name}/crawler/crawl_requests', () => { + let mockRouter: MockRouter; + + beforeEach(() => { + jest.clearAllMocks(); + mockRouter = new MockRouter({ + method: 'get', + path: '/api/app_search/engines/{name}/crawler/crawl_requests', + }); + + registerCrawlerRoutes({ + ...mockDependencies, + router: mockRouter.router, + }); + }); + + it('creates a request to enterprise search', () => { + expect(mockRequestHandler.createRequest).toHaveBeenCalledWith({ + path: '/api/as/v0/engines/:name/crawler/crawl_requests', + }); + }); + + it('validates correctly with name', () => { + const request = { params: { name: 'some-engine' } }; + mockRouter.shouldValidate(request); + }); + + it('fails validation without name', () => { + const request = { params: {} }; + mockRouter.shouldThrow(request); + }); + }); + describe('POST /api/app_search/engines/{name}/crawler/domains', () => { let mockRouter: MockRouter; diff --git a/x-pack/plugins/enterprise_search/server/routes/app_search/crawler.ts b/x-pack/plugins/enterprise_search/server/routes/app_search/crawler.ts index 4404551738101..5404a9a00bdac 100644 --- a/x-pack/plugins/enterprise_search/server/routes/app_search/crawler.ts +++ b/x-pack/plugins/enterprise_search/server/routes/app_search/crawler.ts @@ -27,6 +27,20 @@ export function registerCrawlerRoutes({ }) ); + router.get( + { + path: '/api/app_search/engines/{name}/crawler/crawl_requests', + validate: { + params: schema.object({ + name: schema.string(), + }), + }, + }, + enterpriseSearchRequestHandler.createRequest({ + path: '/api/as/v0/engines/:name/crawler/crawl_requests', + }) + ); + router.post( { path: '/api/app_search/engines/{name}/crawler/domains', From acb90020ffe4d2702421f5a4b7bde28bd4bab3cb Mon Sep 17 00:00:00 2001 From: CJ Cenizal Date: Tue, 3 Aug 2021 11:16:59 -0500 Subject: [PATCH 08/63] Index Management ES JS client migration followup (#107463) * Improve Index Management ts-expect-error annotations. * Add steps for testing legacy index template mappings types to Index Management README. * Rename component template API route handler files to follow pattern used elsewhere. --- .../server/plugin.ts | 2 +- x-pack/plugins/index_management/README.md | 19 ++++++++++++++++++- .../server/lib/fetch_indices.ts | 4 ++-- .../routes/api/component_templates/index.ts | 10 +++++----- .../{create.ts => register_create_route.ts} | 2 +- .../{delete.ts => register_delete_route.ts} | 0 .../{get.ts => register_get_route.ts} | 0 ...t.ts => register_privileges_route.test.ts} | 2 +- ...ileges.ts => register_privileges_route.ts} | 0 .../{update.ts => register_update_route.ts} | 4 ++-- .../api/data_streams/register_get_route.ts | 12 ++++++------ .../server/routes/api/templates/lib.ts | 4 ++-- 12 files changed, 38 insertions(+), 21 deletions(-) rename x-pack/plugins/index_management/server/routes/api/component_templates/{create.ts => register_create_route.ts} (94%) rename x-pack/plugins/index_management/server/routes/api/component_templates/{delete.ts => register_delete_route.ts} (100%) rename x-pack/plugins/index_management/server/routes/api/component_templates/{get.ts => register_get_route.ts} (100%) rename x-pack/plugins/index_management/server/routes/api/component_templates/{privileges.test.ts => register_privileges_route.test.ts} (98%) rename x-pack/plugins/index_management/server/routes/api/component_templates/{privileges.ts => register_privileges_route.ts} (100%) rename x-pack/plugins/index_management/server/routes/api/component_templates/{update.ts => register_update_route.ts} (92%) diff --git a/x-pack/plugins/index_lifecycle_management/server/plugin.ts b/x-pack/plugins/index_lifecycle_management/server/plugin.ts index 533d8736931a4..f511f837b8074 100644 --- a/x-pack/plugins/index_lifecycle_management/server/plugin.ts +++ b/x-pack/plugins/index_lifecycle_management/server/plugin.ts @@ -35,7 +35,7 @@ const indexLifecycleDataEnricher = async ( return indicesList.map((index: IndexWithoutIlm) => { return { ...index, - // @ts-expect-error @elastic/elasticsearch Element implicitly has an 'any' type + // @ts-expect-error @elastic/elasticsearch https://github.com/elastic/elasticsearch-specification/issues/531 ilm: { ...(ilmIndicesData[index.name] || {}) }, }; }); diff --git a/x-pack/plugins/index_management/README.md b/x-pack/plugins/index_management/README.md index 39f4821403a8d..fba162259ce91 100644 --- a/x-pack/plugins/index_management/README.md +++ b/x-pack/plugins/index_management/README.md @@ -82,4 +82,21 @@ PUT _template/.cloud-example } ``` -The UI will now prevent you from editing or deleting this template. \ No newline at end of file +The UI will now prevent you from editing or deleting this template. + +In 7.x, the UI supports types defined as part of the mappings for legacy index templates. To test this out, use the "Load JSON" feature and verify the custom type is preserved: + +``` +{ + "my_custom_type": { + "_source": { + "enabled": false + }, + "properties": { + "name1": { + "type": "keyword" + } + } + } +} +``` \ No newline at end of file diff --git a/x-pack/plugins/index_management/server/lib/fetch_indices.ts b/x-pack/plugins/index_management/server/lib/fetch_indices.ts index 48f633a8dc102..f78e666ddfc5f 100644 --- a/x-pack/plugins/index_management/server/lib/fetch_indices.ts +++ b/x-pack/plugins/index_management/server/lib/fetch_indices.ts @@ -52,9 +52,9 @@ async function fetchIndicesCall( size: hit['store.size'], isFrozen: hit.sth === 'true', // sth value coming back as a string from ES aliases: aliases.length ? aliases : 'none', - // @ts-expect-error @elastic/elasticsearch Property 'index' does not exist on type 'IndicesIndexSettings | IndicesIndexStatePrefixedSettings'. + // @ts-expect-error @elastic/elasticsearch https://github.com/elastic/elasticsearch-specification/issues/532 hidden: index.settings.index.hidden === 'true', - // @ts-expect-error @elastic/elasticsearch Property 'data_stream' does not exist on type 'IndicesIndexState'. + // @ts-expect-error @elastic/elasticsearch https://github.com/elastic/elasticsearch-specification/issues/532 data_stream: index.data_stream!, }); } diff --git a/x-pack/plugins/index_management/server/routes/api/component_templates/index.ts b/x-pack/plugins/index_management/server/routes/api/component_templates/index.ts index abc306c38d09a..fdc72893c7b7f 100644 --- a/x-pack/plugins/index_management/server/routes/api/component_templates/index.ts +++ b/x-pack/plugins/index_management/server/routes/api/component_templates/index.ts @@ -7,11 +7,11 @@ import { RouteDependencies } from '../../../types'; -import { registerGetAllRoute } from './get'; -import { registerCreateRoute } from './create'; -import { registerUpdateRoute } from './update'; -import { registerDeleteRoute } from './delete'; -import { registerPrivilegesRoute } from './privileges'; +import { registerGetAllRoute } from './register_get_route'; +import { registerCreateRoute } from './register_create_route'; +import { registerUpdateRoute } from './register_update_route'; +import { registerDeleteRoute } from './register_delete_route'; +import { registerPrivilegesRoute } from './register_privileges_route'; export function registerComponentTemplateRoutes(dependencies: RouteDependencies) { registerGetAllRoute(dependencies); diff --git a/x-pack/plugins/index_management/server/routes/api/component_templates/create.ts b/x-pack/plugins/index_management/server/routes/api/component_templates/register_create_route.ts similarity index 94% rename from x-pack/plugins/index_management/server/routes/api/component_templates/create.ts rename to x-pack/plugins/index_management/server/routes/api/component_templates/register_create_route.ts index 5fe607368b58a..b4683f1b8cb14 100644 --- a/x-pack/plugins/index_management/server/routes/api/component_templates/create.ts +++ b/x-pack/plugins/index_management/server/routes/api/component_templates/register_create_route.ts @@ -57,7 +57,7 @@ export const registerCreateRoute = ({ try { const { body: responseBody } = await client.asCurrentUser.cluster.putComponentTemplate({ name, - // @ts-expect-error @elastic/elasticsearch Type 'ComponentTemplateSerialized' is not assignable + // @ts-expect-error ComponentTemplateSerialized conflicts with @elastic/elasticsearch ClusterPutComponentTemplateRequest body: serializedComponentTemplate, }); diff --git a/x-pack/plugins/index_management/server/routes/api/component_templates/delete.ts b/x-pack/plugins/index_management/server/routes/api/component_templates/register_delete_route.ts similarity index 100% rename from x-pack/plugins/index_management/server/routes/api/component_templates/delete.ts rename to x-pack/plugins/index_management/server/routes/api/component_templates/register_delete_route.ts diff --git a/x-pack/plugins/index_management/server/routes/api/component_templates/get.ts b/x-pack/plugins/index_management/server/routes/api/component_templates/register_get_route.ts similarity index 100% rename from x-pack/plugins/index_management/server/routes/api/component_templates/get.ts rename to x-pack/plugins/index_management/server/routes/api/component_templates/register_get_route.ts diff --git a/x-pack/plugins/index_management/server/routes/api/component_templates/privileges.test.ts b/x-pack/plugins/index_management/server/routes/api/component_templates/register_privileges_route.test.ts similarity index 98% rename from x-pack/plugins/index_management/server/routes/api/component_templates/privileges.test.ts rename to x-pack/plugins/index_management/server/routes/api/component_templates/register_privileges_route.test.ts index 992c2f9ed29dd..fdbf0db89e689 100644 --- a/x-pack/plugins/index_management/server/routes/api/component_templates/privileges.test.ts +++ b/x-pack/plugins/index_management/server/routes/api/component_templates/register_privileges_route.test.ts @@ -10,7 +10,7 @@ import { kibanaResponseFactory, RequestHandlerContext, RequestHandler } from 'sr import { IndexDataEnricher } from '../../../services/index_data_enricher'; -import { registerPrivilegesRoute } from './privileges'; +import { registerPrivilegesRoute } from './register_privileges_route'; jest.mock('../../../services/index_data_enricher'); diff --git a/x-pack/plugins/index_management/server/routes/api/component_templates/privileges.ts b/x-pack/plugins/index_management/server/routes/api/component_templates/register_privileges_route.ts similarity index 100% rename from x-pack/plugins/index_management/server/routes/api/component_templates/privileges.ts rename to x-pack/plugins/index_management/server/routes/api/component_templates/register_privileges_route.ts diff --git a/x-pack/plugins/index_management/server/routes/api/component_templates/update.ts b/x-pack/plugins/index_management/server/routes/api/component_templates/register_update_route.ts similarity index 92% rename from x-pack/plugins/index_management/server/routes/api/component_templates/update.ts rename to x-pack/plugins/index_management/server/routes/api/component_templates/register_update_route.ts index 17e14f1a39c42..464d73790af2a 100644 --- a/x-pack/plugins/index_management/server/routes/api/component_templates/update.ts +++ b/x-pack/plugins/index_management/server/routes/api/component_templates/register_update_route.ts @@ -6,6 +6,7 @@ */ import { schema } from '@kbn/config-schema'; +import { estypes } from '@elastic/elasticsearch'; import { RouteDependencies } from '../../../types'; import { addBasePath } from '../index'; @@ -39,8 +40,7 @@ export const registerUpdateRoute = ({ const { body: responseBody } = await client.asCurrentUser.cluster.putComponentTemplate({ name, body: { - // @ts-expect-error @elastic/elasticsearch Not assignable to type 'IndicesIndexState' - template, + template: template as estypes.IndicesIndexState, version, _meta, }, diff --git a/x-pack/plugins/index_management/server/routes/api/data_streams/register_get_route.ts b/x-pack/plugins/index_management/server/routes/api/data_streams/register_get_route.ts index c7b28b46e8f00..87eecfbfbbbad 100644 --- a/x-pack/plugins/index_management/server/routes/api/data_streams/register_get_route.ts +++ b/x-pack/plugins/index_management/server/routes/api/data_streams/register_get_route.ts @@ -129,11 +129,11 @@ export function registerGetAllRoute({ router, lib: { handleEsError }, config }: } const enhancedDataStreams = enhanceDataStreams({ - // @ts-expect-error @elastic/elasticsearch DataStreamFromEs incompatible with IndicesGetDataStreamIndicesGetDataStreamItem + // @ts-expect-error DataStreamFromEs conflicts with @elastic/elasticsearch IndicesGetDataStreamIndicesGetDataStreamItem dataStreams, - // @ts-expect-error @elastic/elasticsearch StatsFromEs incompatible with IndicesDataStreamsStatsDataStreamsStatsItem + // @ts-expect-error StatsFromEs conflicts with @elastic/elasticsearch IndicesDataStreamsStatsDataStreamsStatsItem dataStreamsStats, - // @ts-expect-error @elastic/elasticsearch PrivilegesFromEs incompatible with ApplicationsPrivileges + // @ts-expect-error PrivilegesFromEs conflicts with @elastic/elasticsearch ApplicationsPrivileges dataStreamsPrivileges, }); @@ -176,11 +176,11 @@ export function registerGetOneRoute({ router, lib: { handleEsError }, config }: } const enhancedDataStreams = enhanceDataStreams({ - // @ts-expect-error @elastic/elasticsearch DataStreamFromEs incompatible with IndicesGetDataStreamIndicesGetDataStreamItem + // @ts-expect-error DataStreamFromEs conflicts with @elastic/elasticsearch IndicesGetDataStreamIndicesGetDataStreamItem dataStreams, - // @ts-expect-error @elastic/elasticsearch StatsFromEs incompatible with IndicesDataStreamsStatsDataStreamsStatsItem + // @ts-expect-error StatsFromEs conflicts with @elastic/elasticsearch IndicesDataStreamsStatsDataStreamsStatsItem dataStreamsStats, - // @ts-expect-error @elastic/elasticsearch PrivilegesFromEs incompatible with ApplicationsPrivileges + // @ts-expect-error PrivilegesFromEs conflicts with @elastic/elasticsearch ApplicationsPrivileges dataStreamsPrivileges, }); const body = deserializeDataStream(enhancedDataStreams[0]); diff --git a/x-pack/plugins/index_management/server/routes/api/templates/lib.ts b/x-pack/plugins/index_management/server/routes/api/templates/lib.ts index ef2642399d76d..ec8916b0b8d07 100644 --- a/x-pack/plugins/index_management/server/routes/api/templates/lib.ts +++ b/x-pack/plugins/index_management/server/routes/api/templates/lib.ts @@ -51,7 +51,7 @@ export const saveTemplate = async ({ return await client.asCurrentUser.indices.putTemplate({ name: template.name, - // @ts-expect-error @elastic/elasticsearch not assignable to parameter of type 'IndicesPutTemplateRequest' + // @ts-expect-error @elastic/elasticsearch https://github.com/elastic/elasticsearch-specification/issues/533 order, body: { index_patterns, @@ -65,7 +65,7 @@ export const saveTemplate = async ({ return await client.asCurrentUser.indices.putIndexTemplate({ name: template.name, - // @ts-expect-error @elastic/elasticsearch Type 'LegacyTemplateSerialized | TemplateSerialized' is not assignable + // @ts-expect-error LegacyTemplateSerialized | TemplateSerialized conflicts with @elastic/elasticsearch IndicesPutIndexTemplateRequest body: serializedTemplate, }); }; From 91e64e0afa1808d7d7119851ef1ebb58541c3ae6 Mon Sep 17 00:00:00 2001 From: Corey Robertson Date: Tue, 3 Aug 2021 12:30:36 -0400 Subject: [PATCH 09/63] Fix bug with expression reference extraction (#107309) Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> --- .../common/executor/executor.test.ts | 60 ++++++++++++++++++- .../expressions/common/executor/executor.ts | 3 +- 2 files changed, 60 insertions(+), 3 deletions(-) diff --git a/src/plugins/expressions/common/executor/executor.test.ts b/src/plugins/expressions/common/executor/executor.test.ts index d3837272fb50f..0a1e793ffbe22 100644 --- a/src/plugins/expressions/common/executor/executor.test.ts +++ b/src/plugins/expressions/common/executor/executor.test.ts @@ -10,8 +10,9 @@ import { Executor } from './executor'; import * as expressionTypes from '../expression_types'; import * as expressionFunctions from '../expression_functions'; import { Execution } from '../execution'; -import { ExpressionAstFunction, parseExpression } from '../ast'; +import { ExpressionAstFunction, parseExpression, formatExpression } from '../ast'; import { MigrateFunction } from '../../../kibana_utils/common/persistable_state'; +import { SavedObjectReference } from 'src/core/types'; describe('Executor', () => { test('can instantiate', () => { @@ -153,7 +154,7 @@ describe('Executor', () => { const executor = new Executor(); const injectFn = jest.fn().mockImplementation((args, references) => args); - const extractFn = jest.fn().mockReturnValue({ args: {}, references: [] }); + const extractFn = jest.fn().mockImplementation((state) => ({ state, references: [] })); const migrateFn = jest.fn().mockImplementation((args) => args); const fooFn = { @@ -181,7 +182,50 @@ describe('Executor', () => { }, fn: jest.fn(), }; + + const refFnRefName = 'ref.id'; + + const refFn = { + name: 'ref', + help: 'test', + args: { + id: { + types: ['string'], + help: 'will be extracted', + }, + other: { + types: ['string'], + help: 'other arg', + }, + }, + extract: (state: ExpressionAstFunction['arguments']) => { + const references: SavedObjectReference[] = [ + { + name: refFnRefName, + type: 'ref', + id: state.id[0] as string, + }, + ]; + + return { + state: { + ...state, + id: [refFnRefName], + }, + references, + }; + }, + inject: (state: ExpressionAstFunction['arguments'], references: SavedObjectReference[]) => { + const reference = references.find((ref) => ref.name === refFnRefName); + if (reference) { + state.id[0] = reference.id; + } + return state; + }, + fn: jest.fn(), + }; executor.registerFunction(fooFn); + executor.registerFunction(refFn); test('calls inject function for every expression function in expression', () => { executor.inject( @@ -198,6 +242,18 @@ describe('Executor', () => { ); expect(extractFn).toBeCalledTimes(5); }); + + test('extracts references with the proper step key', () => { + const expression = `ref id="my-id" other={ref id="nested-id" other="other" | foo bar="baz"}`; + const { state, references } = executor.extract(parseExpression(expression)); + + expect(references[0].name).toBe('l0_ref.id'); + expect(references[0].id).toBe('nested-id'); + expect(references[1].name).toBe('l2_ref.id'); + expect(references[1].id).toBe('my-id'); + + expect(formatExpression(executor.inject(state, references))).toBe(expression); + }); }); describe('.getAllMigrations', () => { diff --git a/src/plugins/expressions/common/executor/executor.ts b/src/plugins/expressions/common/executor/executor.ts index ec6ca0323ea5c..930c9a4f04243 100644 --- a/src/plugins/expressions/common/executor/executor.ts +++ b/src/plugins/expressions/common/executor/executor.ts @@ -237,7 +237,8 @@ export class Executor = Record { const { state, references } = fn.extract(link.arguments); link.arguments = state; - allReferences.push(...references.map((r) => ({ ...r, name: `l${linkId++}_${r.name}` }))); + allReferences.push(...references.map((r) => ({ ...r, name: `l${linkId}_${r.name}` }))); + linkId = linkId + 1; }); return { state: newAst, references: allReferences }; } From bcb16c1b863ccd729851c164689d3ff2b0f923a5 Mon Sep 17 00:00:00 2001 From: Marta Bondyra Date: Tue, 3 Aug 2021 18:37:15 +0200 Subject: [PATCH 10/63] [Lens] moving store loading to middleware (#106872) --- .../lens/public/app_plugin/app.test.tsx | 1 + .../lens/public/app_plugin/mounter.tsx | 262 ++---------------- .../plugins/lens/public/app_plugin/types.ts | 8 +- .../config_panel/config_panel.tsx | 7 +- .../editor_frame/config_panel/types.ts | 9 +- .../editor_frame/data_panel_wrapper.tsx | 4 +- .../editor_frame/editor_frame.tsx | 11 +- .../editor_frame/expression_helpers.ts | 6 +- .../editor_frame/state_helpers.ts | 8 +- .../editor_frame/suggestion_helpers.ts | 10 +- .../editor_frame/suggestion_panel.tsx | 13 +- .../workspace_panel/chart_switch.tsx | 14 +- .../workspace_panel/workspace_panel.tsx | 8 +- .../workspace_panel_wrapper.tsx | 6 +- x-pack/plugins/lens/public/mocks.tsx | 39 ++- .../lens/public/state_management/index.ts | 33 +-- .../state_management/init_middleware/index.ts | 33 +++ .../init_middleware/load_initial.test.tsx} | 159 +++++------ .../init_middleware/load_initial.ts | 199 +++++++++++++ .../subscribe_to_external_context.ts} | 29 +- .../public/state_management/lens_slice.ts | 49 +++- .../state_management/optimizing_middleware.ts | 8 +- .../lens/public/state_management/types.ts | 12 + x-pack/plugins/lens/public/types.ts | 7 +- x-pack/plugins/lens/public/utils.ts | 7 +- 25 files changed, 506 insertions(+), 436 deletions(-) create mode 100644 x-pack/plugins/lens/public/state_management/init_middleware/index.ts rename x-pack/plugins/lens/public/{app_plugin/mounter.test.tsx => state_management/init_middleware/load_initial.test.tsx} (76%) create mode 100644 x-pack/plugins/lens/public/state_management/init_middleware/load_initial.ts rename x-pack/plugins/lens/public/state_management/{external_context_middleware.ts => init_middleware/subscribe_to_external_context.ts} (75%) diff --git a/x-pack/plugins/lens/public/app_plugin/app.test.tsx b/x-pack/plugins/lens/public/app_plugin/app.test.tsx index 6bd75c585f954..c1984991b04d8 100644 --- a/x-pack/plugins/lens/public/app_plugin/app.test.tsx +++ b/x-pack/plugins/lens/public/app_plugin/app.test.tsx @@ -70,6 +70,7 @@ const sessionIdSubject = new Subject(); describe('Lens App', () => { let defaultDoc: Document; let defaultSavedObjectId: string; + const mockDatasource: DatasourceMock = createMockDatasource('testDatasource'); const mockDatasource2: DatasourceMock = createMockDatasource('testDatasource2'); const datasourceMap = { diff --git a/x-pack/plugins/lens/public/app_plugin/mounter.tsx b/x-pack/plugins/lens/public/app_plugin/mounter.tsx index 12522402116c9..55f3e7463754e 100644 --- a/x-pack/plugins/lens/public/app_plugin/mounter.tsx +++ b/x-pack/plugins/lens/public/app_plugin/mounter.tsx @@ -6,24 +6,20 @@ */ import React, { FC, useCallback } from 'react'; - +import { DeepPartial } from '@reduxjs/toolkit'; import { AppMountParameters, CoreSetup, CoreStart } from 'kibana/public'; import { FormattedMessage, I18nProvider } from '@kbn/i18n/react'; import { HashRouter, Route, RouteComponentProps, Switch } from 'react-router-dom'; import { History } from 'history'; import { render, unmountComponentAtNode } from 'react-dom'; import { i18n } from '@kbn/i18n'; - -import { DashboardFeatureFlagConfig } from 'src/plugins/dashboard/public'; import { Provider } from 'react-redux'; -import { isEqual } from 'lodash'; -import { EmbeddableEditorState } from 'src/plugins/embeddable/public'; import { Storage } from '../../../../../src/plugins/kibana_utils/public'; import { LensReportManager, setReportManager, trackUiEvent } from '../lens_ui_telemetry'; import { App } from './app'; -import { Datasource, EditorFrameStart, Visualization } from '../types'; +import { EditorFrameStart } from '../types'; import { addHelpMenuToAppChrome } from '../help_menu_util'; import { LensPluginStartDependencies } from '../plugin'; import { LENS_EMBEDDABLE_TYPE, LENS_EDIT_BY_VALUE, APP_ID } from '../../common'; @@ -32,32 +28,18 @@ import { LensByReferenceInput, LensByValueInput, } from '../embeddable/embeddable'; -import { - ACTION_VISUALIZE_LENS_FIELD, - VisualizeFieldContext, -} from '../../../../../src/plugins/ui_actions/public'; +import { ACTION_VISUALIZE_LENS_FIELD } from '../../../../../src/plugins/ui_actions/public'; import { LensAttributeService } from '../lens_attribute_service'; import { LensAppServices, RedirectToOriginProps, HistoryLocationState } from './types'; import { KibanaContextProvider } from '../../../../../src/plugins/kibana_react/public'; - import { makeConfigureStore, navigateAway, - getPreloadedState, LensRootStore, - setState, - LensAppState, - updateLayer, - updateVisualizationState, + loadInitial, + LensState, } from '../state_management'; -import { getPersistedDoc } from './save_modal_container'; -import { getResolvedDateRange, getInitialDatasourceId } from '../utils'; -import { initializeDatasources } from '../editor_frame_service/editor_frame'; -import { generateId } from '../id_generator'; -import { - getVisualizeFieldSuggestions, - switchToSuggestion, -} from '../editor_frame_service/editor_frame/suggestion_helpers'; +import { getPreloadedState } from '../state_management/lens_slice'; export async function getLensServices( coreStart: CoreStart, @@ -114,7 +96,7 @@ export async function mountApp( const lensServices = await getLensServices(coreStart, startDependencies, attributeService); - const { stateTransfer, data, storage, dashboardFeatureFlag } = lensServices; + const { stateTransfer, data, storage } = lensServices; const embeddableEditorIncomingState = stateTransfer?.getIncomingEditorState(APP_ID); @@ -183,37 +165,19 @@ export async function mountApp( if (embeddableEditorIncomingState?.searchSessionId) { data.search.session.continue(embeddableEditorIncomingState.searchSessionId); } - const { datasourceMap, visualizationMap } = instance; - const initialDatasourceId = getInitialDatasourceId(datasourceMap); - const datasourceStates: LensAppState['datasourceStates'] = {}; - if (initialDatasourceId) { - datasourceStates[initialDatasourceId] = { - state: null, - isLoading: true, - }; - } - - const preloadedState = getPreloadedState({ - isLoading: true, - query: data.query.queryString.getQuery(), - // Do not use app-specific filters from previous app, - // only if Lens was opened with the intention to visualize a field (e.g. coming from Discover) - filters: !initialContext - ? data.query.filterManager.getGlobalFilters() - : data.query.filterManager.getFilters(), - searchSessionId: data.search.session.getSessionId(), - resolvedDateRange: getResolvedDateRange(data.query.timefilter.timefilter), - isLinkedToOriginatingApp: Boolean(embeddableEditorIncomingState?.originatingApp), - activeDatasourceId: initialDatasourceId, - datasourceStates, - visualization: { - state: null, - activeId: Object.keys(visualizationMap)[0] || null, - }, - }); + const { datasourceMap, visualizationMap } = instance; + const storeDeps = { + lensServices, + datasourceMap, + visualizationMap, + embeddableEditorIncomingState, + initialContext, + }; + const lensStore: LensRootStore = makeConfigureStore(storeDeps, { + lens: getPreloadedState(storeDeps), + } as DeepPartial); - const lensStore: LensRootStore = makeConfigureStore(preloadedState, { data }); const EditorRenderer = React.memo( (props: { id?: string; history: History; editByValue?: boolean }) => { const redirectCallback = useCallback( @@ -224,17 +188,7 @@ export async function mountApp( ); trackUiEvent('loaded'); const initialInput = getInitialInput(props.id, props.editByValue); - loadInitialStore( - redirectCallback, - initialInput, - lensServices, - lensStore, - embeddableEditorIncomingState, - dashboardFeatureFlag, - datasourceMap, - visualizationMap, - initialContext - ); + lensStore.dispatch(loadInitial({ redirectCallback, initialInput })); return ( @@ -309,181 +263,3 @@ export async function mountApp( lensStore.dispatch(navigateAway()); }; } - -export function loadInitialStore( - redirectCallback: (savedObjectId?: string) => void, - initialInput: LensEmbeddableInput | undefined, - lensServices: LensAppServices, - lensStore: LensRootStore, - embeddableEditorIncomingState: EmbeddableEditorState | undefined, - dashboardFeatureFlag: DashboardFeatureFlagConfig, - datasourceMap: Record, - visualizationMap: Record, - initialContext?: VisualizeFieldContext -) { - const { attributeService, chrome, notifications, data } = lensServices; - const { persistedDoc } = lensStore.getState().lens; - if ( - !initialInput || - (attributeService.inputIsRefType(initialInput) && - initialInput.savedObjectId === persistedDoc?.savedObjectId) - ) { - return initializeDatasources( - datasourceMap, - lensStore.getState().lens.datasourceStates, - undefined, - initialContext, - { - isFullEditor: true, - } - ) - .then((result) => { - const datasourceStates = Object.entries(result).reduce( - (state, [datasourceId, datasourceState]) => ({ - ...state, - [datasourceId]: { - ...datasourceState, - isLoading: false, - }, - }), - {} - ); - lensStore.dispatch( - setState({ - datasourceStates, - isLoading: false, - }) - ); - if (initialContext) { - const selectedSuggestion = getVisualizeFieldSuggestions({ - datasourceMap, - datasourceStates, - visualizationMap, - activeVisualizationId: Object.keys(visualizationMap)[0] || null, - visualizationState: null, - visualizeTriggerFieldContext: initialContext, - }); - if (selectedSuggestion) { - switchToSuggestion(lensStore.dispatch, selectedSuggestion, 'SWITCH_VISUALIZATION'); - } - } - const activeDatasourceId = getInitialDatasourceId(datasourceMap); - const visualization = lensStore.getState().lens.visualization; - const activeVisualization = - visualization.activeId && visualizationMap[visualization.activeId]; - - if (visualization.state === null && activeVisualization) { - const newLayerId = generateId(); - - const initialVisualizationState = activeVisualization.initialize(() => newLayerId); - lensStore.dispatch( - updateLayer({ - datasourceId: activeDatasourceId!, - layerId: newLayerId, - updater: datasourceMap[activeDatasourceId!].insertLayer, - }) - ); - lensStore.dispatch( - updateVisualizationState({ - visualizationId: activeVisualization.id, - updater: initialVisualizationState, - }) - ); - } - }) - .catch((e: { message: string }) => { - notifications.toasts.addDanger({ - title: e.message, - }); - redirectCallback(); - }); - } - - getPersistedDoc({ - initialInput, - attributeService, - data, - chrome, - notifications, - }) - .then( - (doc) => { - if (doc) { - const currentSessionId = data.search.session.getSessionId(); - const docDatasourceStates = Object.entries(doc.state.datasourceStates).reduce( - (stateMap, [datasourceId, datasourceState]) => ({ - ...stateMap, - [datasourceId]: { - isLoading: true, - state: datasourceState, - }, - }), - {} - ); - - initializeDatasources( - datasourceMap, - docDatasourceStates, - doc.references, - initialContext, - { - isFullEditor: true, - } - ) - .then((result) => { - const activeDatasourceId = getInitialDatasourceId(datasourceMap, doc); - - lensStore.dispatch( - setState({ - query: doc.state.query, - searchSessionId: - dashboardFeatureFlag.allowByValueEmbeddables && - Boolean(embeddableEditorIncomingState?.originatingApp) && - !(initialInput as LensByReferenceInput)?.savedObjectId && - currentSessionId - ? currentSessionId - : data.search.session.start(), - ...(!isEqual(persistedDoc, doc) ? { persistedDoc: doc } : null), - activeDatasourceId, - visualization: { - activeId: doc.visualizationType, - state: doc.state.visualization, - }, - datasourceStates: Object.entries(result).reduce( - (state, [datasourceId, datasourceState]) => ({ - ...state, - [datasourceId]: { - ...datasourceState, - isLoading: false, - }, - }), - {} - ), - isLoading: false, - }) - ); - }) - .catch((e: { message: string }) => - notifications.toasts.addDanger({ - title: e.message, - }) - ); - } else { - redirectCallback(); - } - }, - () => { - lensStore.dispatch( - setState({ - isLoading: false, - }) - ); - redirectCallback(); - } - ) - .catch((e: { message: string }) => - notifications.toasts.addDanger({ - title: e.message, - }) - ); -} diff --git a/x-pack/plugins/lens/public/app_plugin/types.ts b/x-pack/plugins/lens/public/app_plugin/types.ts index 499ba3c86bca5..c482b56b70301 100644 --- a/x-pack/plugins/lens/public/app_plugin/types.ts +++ b/x-pack/plugins/lens/public/app_plugin/types.ts @@ -34,7 +34,7 @@ import { EmbeddableEditorState, EmbeddableStateTransfer, } from '../../../../../src/plugins/embeddable/public'; -import { Datasource, EditorFrameInstance, Visualization } from '../types'; +import { DatasourceMap, EditorFrameInstance, VisualizationMap } from '../types'; import { PresentationUtilPluginStart } from '../../../../../src/plugins/presentation_util/public'; export interface RedirectToOriginProps { input?: LensEmbeddableInput; @@ -54,8 +54,8 @@ export interface LensAppProps { // State passed in by the container which is used to determine the id of the Originating App. incomingState?: EmbeddableEditorState; - datasourceMap: Record; - visualizationMap: Record; + datasourceMap: DatasourceMap; + visualizationMap: VisualizationMap; } export type RunSave = ( @@ -82,7 +82,7 @@ export interface LensTopNavMenuProps { indicateNoData: boolean; setIsSaveModalVisible: React.Dispatch>; runSave: RunSave; - datasourceMap: Record; + datasourceMap: DatasourceMap; title?: string; } diff --git a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/config_panel.tsx b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/config_panel.tsx index d4a9870056b34..8a5d385b5be0f 100644 --- a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/config_panel.tsx +++ b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/config_panel.tsx @@ -27,11 +27,8 @@ import { } from '../../../state_management'; export const ConfigPanelWrapper = memo(function ConfigPanelWrapper(props: ConfigPanelWrapperProps) { - const activeVisualization = props.visualizationMap[props.activeVisualizationId || '']; - const { visualizationState } = props; - - return activeVisualization && visualizationState ? ( - + return props.activeVisualization && props.visualizationState ? ( + ) : null; }); diff --git a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/types.ts b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/types.ts index 683b96c6b8773..d9bf678d1916a 100644 --- a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/types.ts +++ b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/config_panel/types.ts @@ -8,17 +8,16 @@ import { Visualization, FramePublicAPI, - Datasource, DatasourceDimensionEditorProps, VisualizationDimensionGroupConfig, + DatasourceMap, } from '../../../types'; export interface ConfigPanelWrapperProps { activeDatasourceId: string; visualizationState: unknown; - visualizationMap: Record; - activeVisualizationId: string | null; + activeVisualization: Visualization | null; framePublicAPI: FramePublicAPI; - datasourceMap: Record; + datasourceMap: DatasourceMap; datasourceStates: Record< string, { @@ -33,7 +32,7 @@ export interface ConfigPanelWrapperProps { export interface LayerPanelProps { activeDatasourceId: string; visualizationState: unknown; - datasourceMap: Record; + datasourceMap: DatasourceMap; activeVisualization: Visualization; framePublicAPI: FramePublicAPI; datasourceStates: Record< diff --git a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/data_panel_wrapper.tsx b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/data_panel_wrapper.tsx index c50d3f41479f1..abfeb647186a7 100644 --- a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/data_panel_wrapper.tsx +++ b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/data_panel_wrapper.tsx @@ -13,7 +13,7 @@ import { EuiPopover, EuiButtonIcon, EuiContextMenuPanel, EuiContextMenuItem } fr import { createSelector } from '@reduxjs/toolkit'; import { NativeRenderer } from '../../native_renderer'; import { DragContext, DragDropIdentifier } from '../../drag_drop'; -import { StateSetter, DatasourceDataPanelProps, Datasource } from '../../types'; +import { StateSetter, DatasourceDataPanelProps, DatasourceMap } from '../../types'; import { UiActionsStart } from '../../../../../../src/plugins/ui_actions/public'; import { switchDatasource, @@ -27,7 +27,7 @@ import { initializeDatasources } from './state_helpers'; interface DataPanelWrapperProps { datasourceState: unknown; - datasourceMap: Record; + datasourceMap: DatasourceMap; activeDatasource: string | null; datasourceIsLoading: boolean; showNoDataPopover: () => void; diff --git a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/editor_frame.tsx b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/editor_frame.tsx index 4b725c4cd1850..653ad2d27fe06 100644 --- a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/editor_frame.tsx +++ b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/editor_frame.tsx @@ -8,7 +8,7 @@ import React, { useCallback, useRef, useMemo } from 'react'; import { CoreStart } from 'kibana/public'; import { ReactExpressionRendererType } from '../../../../../../src/plugins/expressions/public'; -import { Datasource, FramePublicAPI, Visualization } from '../../types'; +import { DatasourceMap, FramePublicAPI, VisualizationMap } from '../../types'; import { DataPanelWrapper } from './data_panel_wrapper'; import { ConfigPanelWrapper } from './config_panel'; import { FrameLayout } from './frame_layout'; @@ -22,8 +22,8 @@ import { trackUiEvent } from '../../lens_ui_telemetry'; import { useLensSelector, useLensDispatch } from '../../state_management'; export interface EditorFrameProps { - datasourceMap: Record; - visualizationMap: Record; + datasourceMap: DatasourceMap; + visualizationMap: VisualizationMap; ExpressionRenderer: ReactExpressionRendererType; core: CoreStart; plugins: EditorFrameStartPlugins; @@ -125,11 +125,12 @@ export function EditorFrame(props: EditorFrameProps) { configPanel={ allLoaded && ( , + datasourceMap: DatasourceMap, datasourceStates: Record< string, { @@ -80,7 +80,7 @@ export function buildExpression({ description?: string; visualization: Visualization | null; visualizationState: unknown; - datasourceMap: Record; + datasourceMap: DatasourceMap; datasourceStates: Record< string, { diff --git a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/state_helpers.ts b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/state_helpers.ts index e861112f3f7b4..2b0090554b7da 100644 --- a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/state_helpers.ts +++ b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/state_helpers.ts @@ -10,11 +10,13 @@ import { Ast } from '@kbn/interpreter/common'; import memoizeOne from 'memoize-one'; import { Datasource, + DatasourceMap, DatasourcePublicAPI, FramePublicAPI, InitializationOptions, Visualization, VisualizationDimensionGroupConfig, + VisualizationMap, } from '../../types'; import { buildExpression } from './expression_helpers'; import { Document } from '../../persistence/saved_object_store'; @@ -28,7 +30,7 @@ import { } from '../error_helper'; export async function initializeDatasources( - datasourceMap: Record, + datasourceMap: DatasourceMap, datasourceStates: Record, references?: SavedObjectReference[], initialContext?: VisualizeFieldContext, @@ -55,7 +57,7 @@ export async function initializeDatasources( } export const createDatasourceLayers = memoizeOne(function createDatasourceLayers( - datasourceMap: Record, + datasourceMap: DatasourceMap, datasourceStates: Record ) { const datasourceLayers: Record = {}; @@ -78,7 +80,7 @@ export const createDatasourceLayers = memoizeOne(function createDatasourceLayers export async function persistedStateToExpression( datasources: Record, - visualizations: Record, + visualizations: VisualizationMap, doc: Document ): Promise<{ ast: Ast | null; errors: ErrorMessage[] | undefined }> { const { diff --git a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/suggestion_helpers.ts b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/suggestion_helpers.ts index 9fdc283c3cc29..31d54d26c304b 100644 --- a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/suggestion_helpers.ts +++ b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/suggestion_helpers.ts @@ -18,6 +18,8 @@ import { TableSuggestion, DatasourceSuggestion, DatasourcePublicAPI, + DatasourceMap, + VisualizationMap, } from '../../types'; import { DragDropIdentifier } from '../../drag_drop'; import { LensDispatch, selectSuggestion, switchVisualization } from '../../state_management'; @@ -57,7 +59,7 @@ export function getSuggestions({ activeData, mainPalette, }: { - datasourceMap: Record; + datasourceMap: DatasourceMap; datasourceStates: Record< string, { @@ -65,7 +67,7 @@ export function getSuggestions({ state: unknown; } >; - visualizationMap: Record; + visualizationMap: VisualizationMap; activeVisualizationId: string | null; subVisualizationId?: string; visualizationState: unknown; @@ -140,7 +142,7 @@ export function getVisualizeFieldSuggestions({ visualizationState, visualizeTriggerFieldContext, }: { - datasourceMap: Record; + datasourceMap: DatasourceMap; datasourceStates: Record< string, { @@ -148,7 +150,7 @@ export function getVisualizeFieldSuggestions({ state: unknown; } >; - visualizationMap: Record; + visualizationMap: VisualizationMap; activeVisualizationId: string | null; subVisualizationId?: string; visualizationState: unknown; 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 6d360a09a5b49..c6dae5b23b9d4 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 @@ -25,7 +25,14 @@ import { Ast, toExpression } from '@kbn/interpreter/common'; import { i18n } from '@kbn/i18n'; import classNames from 'classnames'; import { ExecutionContextSearch } from 'src/plugins/data/public'; -import { Datasource, Visualization, FramePublicAPI, DatasourcePublicAPI } from '../../types'; +import { + Datasource, + Visualization, + FramePublicAPI, + DatasourcePublicAPI, + DatasourceMap, + VisualizationMap, +} from '../../types'; import { getSuggestions, switchToSuggestion } from './suggestion_helpers'; import { ReactExpressionRendererProps, @@ -45,7 +52,7 @@ const MAX_SUGGESTIONS_DISPLAYED = 5; export interface SuggestionPanelProps { activeDatasourceId: string | null; - datasourceMap: Record; + datasourceMap: DatasourceMap; datasourceStates: Record< string, { @@ -54,7 +61,7 @@ export interface SuggestionPanelProps { } >; activeVisualizationId: string | null; - visualizationMap: Record; + visualizationMap: VisualizationMap; visualizationState: unknown; ExpressionRenderer: ReactExpressionRendererType; frame: FramePublicAPI; diff --git a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/workspace_panel/chart_switch.tsx b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/workspace_panel/chart_switch.tsx index 314989ecc9758..7db639536b8ac 100644 --- a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/workspace_panel/chart_switch.tsx +++ b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/workspace_panel/chart_switch.tsx @@ -20,7 +20,13 @@ import { } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; import { FormattedMessage } from '@kbn/i18n/react'; -import { Visualization, FramePublicAPI, Datasource, VisualizationType } from '../../../types'; +import { + Visualization, + FramePublicAPI, + VisualizationType, + VisualizationMap, + DatasourceMap, +} from '../../../types'; import { getSuggestions, switchToSuggestion, Suggestion } from '../suggestion_helpers'; import { trackUiEvent } from '../../../lens_ui_telemetry'; import { ToolbarButton } from '../../../../../../../src/plugins/kibana_react/public'; @@ -44,9 +50,9 @@ interface VisualizationSelection { } interface Props { - visualizationMap: Record; framePublicAPI: FramePublicAPI; - datasourceMap: Record; + visualizationMap: VisualizationMap; + datasourceMap: DatasourceMap; } type SelectableEntry = EuiSelectableOption<{ value: string }>; @@ -55,7 +61,7 @@ function VisualizationSummary({ visualizationMap, visualization, }: { - visualizationMap: Record; + visualizationMap: VisualizationMap; visualization: { activeId: string | null; state: unknown; diff --git a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/workspace_panel/workspace_panel.tsx b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/workspace_panel/workspace_panel.tsx index a52d83ed81fe8..68243efc28d07 100644 --- a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/workspace_panel/workspace_panel.tsx +++ b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/workspace_panel/workspace_panel.tsx @@ -34,12 +34,12 @@ import { ReactExpressionRendererType, } from '../../../../../../../src/plugins/expressions/public'; import { - Datasource, - Visualization, FramePublicAPI, isLensBrushEvent, isLensFilterEvent, isLensEditEvent, + VisualizationMap, + DatasourceMap, } from '../../../types'; import { DragDrop, DragContext, DragDropIdentifier } from '../../../drag_drop'; import { Suggestion, switchToSuggestion } from '../suggestion_helpers'; @@ -62,10 +62,10 @@ import { export interface WorkspacePanelProps { activeVisualizationId: string | null; - visualizationMap: Record; + visualizationMap: VisualizationMap; visualizationState: unknown; activeDatasourceId: string | null; - datasourceMap: Record; + datasourceMap: DatasourceMap; datasourceStates: Record< string, { diff --git a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/workspace_panel/workspace_panel_wrapper.tsx b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/workspace_panel/workspace_panel_wrapper.tsx index d0e8e0d5a1bab..057d8c8baebfa 100644 --- a/x-pack/plugins/lens/public/editor_frame_service/editor_frame/workspace_panel/workspace_panel_wrapper.tsx +++ b/x-pack/plugins/lens/public/editor_frame_service/editor_frame/workspace_panel/workspace_panel_wrapper.tsx @@ -10,7 +10,7 @@ import './workspace_panel_wrapper.scss'; import React, { useCallback } from 'react'; import { EuiPageContent, EuiFlexGroup, EuiFlexItem } from '@elastic/eui'; import classNames from 'classnames'; -import { Datasource, FramePublicAPI, Visualization } from '../../../types'; +import { DatasourceMap, FramePublicAPI, VisualizationMap } from '../../../types'; import { NativeRenderer } from '../../../native_renderer'; import { ChartSwitch } from './chart_switch'; import { WarningsPopover } from './warnings_popover'; @@ -21,9 +21,9 @@ export interface WorkspacePanelWrapperProps { children: React.ReactNode | React.ReactNode[]; framePublicAPI: FramePublicAPI; visualizationState: unknown; - visualizationMap: Record; + visualizationMap: VisualizationMap; visualizationId: string | null; - datasourceMap: Record; + datasourceMap: DatasourceMap; datasourceStates: Record< string, { diff --git a/x-pack/plugins/lens/public/mocks.tsx b/x-pack/plugins/lens/public/mocks.tsx index fc1b3019df386..3c598540cbb93 100644 --- a/x-pack/plugins/lens/public/mocks.tsx +++ b/x-pack/plugins/lens/public/mocks.tsx @@ -16,6 +16,7 @@ import moment from 'moment'; import { Provider } from 'react-redux'; import { act } from 'react-dom/test-utils'; import { ReactExpressionRendererProps } from 'src/plugins/expressions/public'; +import { DeepPartial } from '@reduxjs/toolkit'; import { LensPublicStart } from '.'; import { visualizationTypes } from './xy_visualization/types'; import { navigationPluginMock } from '../../../../src/plugins/navigation/public/mocks'; @@ -35,7 +36,7 @@ import { import { LensAttributeService } from './lens_attribute_service'; import { EmbeddableStateTransfer } from '../../../../src/plugins/embeddable/public'; -import { makeConfigureStore, getPreloadedState, LensAppState } from './state_management/index'; +import { makeConfigureStore, LensAppState, LensState } from './state_management/index'; import { getResolvedDateRange } from './utils'; import { presentationUtilPluginMock } from '../../../../src/plugins/presentation_util/public/mocks'; import { DatasourcePublicAPI, Datasource, Visualization, FramePublicAPI } from './types'; @@ -82,6 +83,11 @@ export function createMockVisualization(): jest.Mocked { }; } +const visualizationMap = { + vis: createMockVisualization(), + vis2: createMockVisualization(), +}; + export type DatasourceMock = jest.Mocked & { publicAPIMock: jest.Mocked; }; @@ -126,6 +132,13 @@ export function createMockDatasource(id: string): DatasourceMock { }; } +const mockDatasource: DatasourceMock = createMockDatasource('testDatasource'); +const mockDatasource2: DatasourceMock = createMockDatasource('testDatasource2'); +const datasourceMap = { + testDatasource2: mockDatasource2, + testDatasource: mockDatasource, +}; + export function createExpressionRendererMock(): jest.Mock< React.ReactElement, [ReactExpressionRendererProps] @@ -401,17 +414,21 @@ export function makeLensStore({ data = mockDataPlugin(); } const lensStore = makeConfigureStore( - getPreloadedState({ - ...defaultState, - searchSessionId: data.search.session.start(), - query: data.query.queryString.getQuery(), - filters: data.query.filterManager.getGlobalFilters(), - resolvedDateRange: getResolvedDateRange(data.query.timefilter.timefilter), - ...preloadedState, - }), { - data, - } + lensServices: { ...makeDefaultServices(), data }, + datasourceMap, + visualizationMap, + }, + { + lens: { + ...defaultState, + searchSessionId: data.search.session.start(), + query: data.query.queryString.getQuery(), + filters: data.query.filterManager.getGlobalFilters(), + resolvedDateRange: getResolvedDateRange(data.query.timefilter.timefilter), + ...preloadedState, + }, + } as DeepPartial ); const origDispatch = lensStore.dispatch; diff --git a/x-pack/plugins/lens/public/state_management/index.ts b/x-pack/plugins/lens/public/state_management/index.ts index b72c383130208..b06dc73857cff 100644 --- a/x-pack/plugins/lens/public/state_management/index.ts +++ b/x-pack/plugins/lens/public/state_management/index.ts @@ -5,16 +5,14 @@ * 2.0. */ -import { configureStore, DeepPartial, getDefaultMiddleware } from '@reduxjs/toolkit'; +import { configureStore, getDefaultMiddleware, DeepPartial } from '@reduxjs/toolkit'; import logger from 'redux-logger'; import { useDispatch, useSelector, TypedUseSelectorHook } from 'react-redux'; -import { lensSlice, initialState } from './lens_slice'; +import { lensSlice } from './lens_slice'; import { timeRangeMiddleware } from './time_range_middleware'; import { optimizingMiddleware } from './optimizing_middleware'; -import { externalContextMiddleware } from './external_context_middleware'; - -import { DataPublicPluginStart } from '../../../../../src/plugins/data/public'; -import { LensAppState, LensState } from './types'; +import { LensState, LensStoreDeps } from './types'; +import { initMiddleware } from './init_middleware'; export * from './types'; export const reducer = { @@ -22,8 +20,9 @@ export const reducer = { }; export const { - setState, + loadInitial, navigateAway, + setState, setSaveable, onActiveDataChange, updateState, @@ -38,29 +37,17 @@ export const { setToggleFullscreen, } = lensSlice.actions; -export const getPreloadedState = (initializedState: Partial) => { - const state = { - lens: { - ...initialState, - ...initializedState, - }, - } as DeepPartial; - return state; -}; - -type PreloadedState = ReturnType; - export const makeConfigureStore = ( - preloadedState: PreloadedState, - { data }: { data: DataPublicPluginStart } + storeDeps: LensStoreDeps, + preloadedState: DeepPartial ) => { const middleware = [ ...getDefaultMiddleware({ serializableCheck: false, }), + initMiddleware(storeDeps), optimizingMiddleware(), - timeRangeMiddleware(data), - externalContextMiddleware(data), + timeRangeMiddleware(storeDeps.lensServices.data), ]; if (process.env.NODE_ENV === 'development') middleware.push(logger); diff --git a/x-pack/plugins/lens/public/state_management/init_middleware/index.ts b/x-pack/plugins/lens/public/state_management/init_middleware/index.ts new file mode 100644 index 0000000000000..854e08dfe83e4 --- /dev/null +++ b/x-pack/plugins/lens/public/state_management/init_middleware/index.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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { Dispatch, MiddlewareAPI, PayloadAction } from '@reduxjs/toolkit'; +import { LensStoreDeps } from '..'; +import { lensSlice } from '../lens_slice'; +import { loadInitial } from './load_initial'; +import { subscribeToExternalContext } from './subscribe_to_external_context'; + +export const initMiddleware = (storeDeps: LensStoreDeps) => (store: MiddlewareAPI) => { + const unsubscribeFromExternalContext = subscribeToExternalContext( + storeDeps.lensServices.data, + store.getState, + store.dispatch + ); + return (next: Dispatch) => (action: PayloadAction) => { + if (lensSlice.actions.loadInitial.match(action)) { + return loadInitial( + store, + storeDeps, + action.payload.redirectCallback, + action.payload.initialInput + ); + } else if (lensSlice.actions.navigateAway.match(action)) { + return unsubscribeFromExternalContext(); + } + next(action); + }; +}; diff --git a/x-pack/plugins/lens/public/app_plugin/mounter.test.tsx b/x-pack/plugins/lens/public/state_management/init_middleware/load_initial.test.tsx similarity index 76% rename from x-pack/plugins/lens/public/app_plugin/mounter.test.tsx rename to x-pack/plugins/lens/public/state_management/init_middleware/load_initial.test.tsx index 03eec4f617cfc..9f653c2ff9f86 100644 --- a/x-pack/plugins/lens/public/app_plugin/mounter.test.tsx +++ b/x-pack/plugins/lens/public/state_management/init_middleware/load_initial.test.tsx @@ -4,11 +4,17 @@ * 2.0; you may not use this file except in compliance with the Elastic License * 2.0. */ -import { makeDefaultServices, makeLensStore, defaultDoc, createMockVisualization } from '../mocks'; -import { createMockDatasource, DatasourceMock } from '../mocks'; +import { + makeDefaultServices, + makeLensStore, + defaultDoc, + createMockVisualization, + createMockDatasource, + DatasourceMock, +} from '../../mocks'; import { act } from 'react-dom/test-utils'; -import { loadInitialStore } from './mounter'; -import { LensEmbeddableInput } from '../embeddable/embeddable'; +import { loadInitial } from './load_initial'; +import { LensEmbeddableInput } from '../../embeddable'; const defaultSavedObjectId = '1234'; const preloadedState = { @@ -20,7 +26,6 @@ const preloadedState = { }; describe('Mounter', () => { - const byValueFlag = { allowByValueEmbeddables: true }; const mockDatasource: DatasourceMock = createMockDatasource('testDatasource'); const mockDatasource2: DatasourceMock = createMockDatasource('testDatasource2'); const datasourceMap = { @@ -66,15 +71,15 @@ describe('Mounter', () => { preloadedState, }); await act(async () => { - await loadInitialStore( - redirectCallback, - undefined, - services, + await loadInitial( lensStore, - undefined, - byValueFlag, - datasourceMap, - visualizationMap + { + lensServices: services, + datasourceMap, + visualizationMap, + }, + redirectCallback, + ({ savedObjectId: defaultSavedObjectId } as unknown) as LensEmbeddableInput ); }); expect(mockDatasource.initialize).toHaveBeenCalled(); @@ -87,15 +92,14 @@ describe('Mounter', () => { const lensStore = await makeLensStore({ data: services.data, preloadedState }); await act(async () => { - await loadInitialStore( - redirectCallback, - undefined, - services, + await loadInitial( lensStore, - undefined, - byValueFlag, - datasourceMap, - visualizationMap + { + lensServices: services, + datasourceMap, + visualizationMap, + }, + redirectCallback ); }); expect(mockDatasource.initialize).toHaveBeenCalled(); @@ -114,20 +118,19 @@ describe('Mounter', () => { // it.skip('should pass the datasource api for each layer to the visualization', async () => {}) // it('displays errors from the frame in a toast', async () => { - describe('loadInitialStore', () => { + describe('loadInitial', () => { it('does not load a document if there is no initial input', async () => { const services = makeDefaultServices(); const redirectCallback = jest.fn(); const lensStore = makeLensStore({ data: services.data, preloadedState }); - await loadInitialStore( - redirectCallback, - undefined, - services, + await loadInitial( lensStore, - undefined, - byValueFlag, - datasourceMap, - visualizationMap + { + lensServices: services, + datasourceMap, + visualizationMap, + }, + redirectCallback ); expect(services.attributeService.unwrapAttributes).not.toHaveBeenCalled(); }); @@ -139,15 +142,15 @@ describe('Mounter', () => { const lensStore = await makeLensStore({ data: services.data, preloadedState }); await act(async () => { - await loadInitialStore( - redirectCallback, - { savedObjectId: defaultSavedObjectId } as LensEmbeddableInput, - services, + await loadInitial( lensStore, - undefined, - byValueFlag, - datasourceMap, - visualizationMap + { + lensServices: services, + datasourceMap, + visualizationMap, + }, + redirectCallback, + ({ savedObjectId: defaultSavedObjectId } as unknown) as LensEmbeddableInput ); }); @@ -175,43 +178,43 @@ describe('Mounter', () => { const lensStore = makeLensStore({ data: services.data, preloadedState }); await act(async () => { - await loadInitialStore( - redirectCallback, - { savedObjectId: defaultSavedObjectId } as LensEmbeddableInput, - services, + await loadInitial( lensStore, - undefined, - byValueFlag, - datasourceMap, - visualizationMap + { + lensServices: services, + datasourceMap, + visualizationMap, + }, + redirectCallback, + ({ savedObjectId: defaultSavedObjectId } as unknown) as LensEmbeddableInput ); }); await act(async () => { - await loadInitialStore( - redirectCallback, - { savedObjectId: defaultSavedObjectId } as LensEmbeddableInput, - services, + await loadInitial( lensStore, - undefined, - byValueFlag, - datasourceMap, - visualizationMap + { + lensServices: services, + datasourceMap, + visualizationMap, + }, + redirectCallback, + ({ savedObjectId: defaultSavedObjectId } as unknown) as LensEmbeddableInput ); }); expect(services.attributeService.unwrapAttributes).toHaveBeenCalledTimes(1); await act(async () => { - await loadInitialStore( - redirectCallback, - { savedObjectId: '5678' } as LensEmbeddableInput, - services, + await loadInitial( lensStore, - undefined, - byValueFlag, - datasourceMap, - visualizationMap + { + lensServices: services, + datasourceMap, + visualizationMap, + }, + redirectCallback, + ({ savedObjectId: '5678' } as unknown) as LensEmbeddableInput ); }); @@ -227,15 +230,15 @@ describe('Mounter', () => { services.attributeService.unwrapAttributes = jest.fn().mockRejectedValue('failed to load'); await act(async () => { - await loadInitialStore( - redirectCallback, - { savedObjectId: defaultSavedObjectId } as LensEmbeddableInput, - services, + await loadInitial( lensStore, - undefined, - byValueFlag, - datasourceMap, - visualizationMap + { + lensServices: services, + datasourceMap, + visualizationMap, + }, + redirectCallback, + ({ savedObjectId: defaultSavedObjectId } as unknown) as LensEmbeddableInput ); }); expect(services.attributeService.unwrapAttributes).toHaveBeenCalledWith({ @@ -251,15 +254,15 @@ describe('Mounter', () => { const services = makeDefaultServices(); const lensStore = makeLensStore({ data: services.data, preloadedState }); await act(async () => { - await loadInitialStore( - redirectCallback, - ({ savedObjectId: defaultSavedObjectId } as unknown) as LensEmbeddableInput, - services, + await loadInitial( lensStore, - undefined, - byValueFlag, - datasourceMap, - visualizationMap + { + lensServices: services, + datasourceMap, + visualizationMap, + }, + redirectCallback, + ({ savedObjectId: defaultSavedObjectId } as unknown) as LensEmbeddableInput ); }); diff --git a/x-pack/plugins/lens/public/state_management/init_middleware/load_initial.ts b/x-pack/plugins/lens/public/state_management/init_middleware/load_initial.ts new file mode 100644 index 0000000000000..5aeeec81e29b0 --- /dev/null +++ b/x-pack/plugins/lens/public/state_management/init_middleware/load_initial.ts @@ -0,0 +1,199 @@ +/* + * Copyright 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 { MiddlewareAPI } from '@reduxjs/toolkit'; +import { isEqual } from 'lodash'; +import { setState } from '..'; +import { updateLayer, updateVisualizationState, LensStoreDeps } from '..'; +import { LensEmbeddableInput, LensByReferenceInput } from '../../embeddable/embeddable'; +import { getInitialDatasourceId } from '../../utils'; +import { initializeDatasources } from '../../editor_frame_service/editor_frame'; +import { generateId } from '../../id_generator'; +import { + getVisualizeFieldSuggestions, + switchToSuggestion, +} from '../../editor_frame_service/editor_frame/suggestion_helpers'; +import { getPersistedDoc } from '../../app_plugin/save_modal_container'; + +export function loadInitial( + store: MiddlewareAPI, + { + lensServices, + datasourceMap, + visualizationMap, + embeddableEditorIncomingState, + initialContext, + }: LensStoreDeps, + redirectCallback: (savedObjectId?: string) => void, + initialInput?: LensEmbeddableInput +) { + const { getState, dispatch } = store; + const { attributeService, chrome, notifications, data, dashboardFeatureFlag } = lensServices; + const { persistedDoc } = getState().lens; + if ( + !initialInput || + (attributeService.inputIsRefType(initialInput) && + initialInput.savedObjectId === persistedDoc?.savedObjectId) + ) { + return initializeDatasources( + datasourceMap, + getState().lens.datasourceStates, + undefined, + initialContext, + { + isFullEditor: true, + } + ) + .then((result) => { + const datasourceStates = Object.entries(result).reduce( + (state, [datasourceId, datasourceState]) => ({ + ...state, + [datasourceId]: { + ...datasourceState, + isLoading: false, + }, + }), + {} + ); + dispatch( + setState({ + datasourceStates, + isLoading: false, + }) + ); + if (initialContext) { + const selectedSuggestion = getVisualizeFieldSuggestions({ + datasourceMap, + datasourceStates, + visualizationMap, + activeVisualizationId: Object.keys(visualizationMap)[0] || null, + visualizationState: null, + visualizeTriggerFieldContext: initialContext, + }); + if (selectedSuggestion) { + switchToSuggestion(dispatch, selectedSuggestion, 'SWITCH_VISUALIZATION'); + } + } + const activeDatasourceId = getInitialDatasourceId(datasourceMap); + const visualization = getState().lens.visualization; + const activeVisualization = + visualization.activeId && visualizationMap[visualization.activeId]; + + if (visualization.state === null && activeVisualization) { + const newLayerId = generateId(); + + const initialVisualizationState = activeVisualization.initialize(() => newLayerId); + dispatch( + updateLayer({ + datasourceId: activeDatasourceId!, + layerId: newLayerId, + updater: datasourceMap[activeDatasourceId!].insertLayer, + }) + ); + dispatch( + updateVisualizationState({ + visualizationId: activeVisualization.id, + updater: initialVisualizationState, + }) + ); + } + }) + .catch((e: { message: string }) => { + notifications.toasts.addDanger({ + title: e.message, + }); + redirectCallback(); + }); + } + getPersistedDoc({ + initialInput, + attributeService, + data, + chrome, + notifications, + }) + .then( + (doc) => { + if (doc) { + const currentSessionId = data.search.session.getSessionId(); + const docDatasourceStates = Object.entries(doc.state.datasourceStates).reduce( + (stateMap, [datasourceId, datasourceState]) => ({ + ...stateMap, + [datasourceId]: { + isLoading: true, + state: datasourceState, + }, + }), + {} + ); + + initializeDatasources( + datasourceMap, + docDatasourceStates, + doc.references, + initialContext, + { + isFullEditor: true, + } + ) + .then((result) => { + const activeDatasourceId = getInitialDatasourceId(datasourceMap, doc); + + dispatch( + setState({ + query: doc.state.query, + searchSessionId: + dashboardFeatureFlag.allowByValueEmbeddables && + Boolean(embeddableEditorIncomingState?.originatingApp) && + !(initialInput as LensByReferenceInput)?.savedObjectId && + currentSessionId + ? currentSessionId + : data.search.session.start(), + ...(!isEqual(persistedDoc, doc) ? { persistedDoc: doc } : null), + activeDatasourceId, + visualization: { + activeId: doc.visualizationType, + state: doc.state.visualization, + }, + datasourceStates: Object.entries(result).reduce( + (state, [datasourceId, datasourceState]) => ({ + ...state, + [datasourceId]: { + ...datasourceState, + isLoading: false, + }, + }), + {} + ), + isLoading: false, + }) + ); + }) + .catch((e: { message: string }) => + notifications.toasts.addDanger({ + title: e.message, + }) + ); + } else { + redirectCallback(); + } + }, + () => { + dispatch( + setState({ + isLoading: false, + }) + ); + redirectCallback(); + } + ) + .catch((e: { message: string }) => + notifications.toasts.addDanger({ + title: e.message, + }) + ); +} diff --git a/x-pack/plugins/lens/public/state_management/external_context_middleware.ts b/x-pack/plugins/lens/public/state_management/init_middleware/subscribe_to_external_context.ts similarity index 75% rename from x-pack/plugins/lens/public/state_management/external_context_middleware.ts rename to x-pack/plugins/lens/public/state_management/init_middleware/subscribe_to_external_context.ts index 07233b87dd19b..325e246246fcd 100644 --- a/x-pack/plugins/lens/public/state_management/external_context_middleware.ts +++ b/x-pack/plugins/lens/public/state_management/init_middleware/subscribe_to_external_context.ts @@ -7,34 +7,15 @@ import { delay, finalize, switchMap, tap } from 'rxjs/operators'; import { debounce, isEqual } from 'lodash'; -import { Dispatch, MiddlewareAPI, PayloadAction } from '@reduxjs/toolkit'; -import { trackUiEvent } from '../lens_ui_telemetry'; - +import { trackUiEvent } from '../../lens_ui_telemetry'; import { waitUntilNextSessionCompletes$, DataPublicPluginStart, -} from '../../../../../src/plugins/data/public'; -import { setState, LensGetState, LensDispatch } from '.'; -import { LensAppState } from './types'; -import { getResolvedDateRange } from '../utils'; - -export const externalContextMiddleware = (data: DataPublicPluginStart) => ( - store: MiddlewareAPI -) => { - const unsubscribeFromExternalContext = subscribeToExternalContext( - data, - store.getState, - store.dispatch - ); - return (next: Dispatch) => (action: PayloadAction>) => { - if (action.type === 'lens/navigateAway') { - unsubscribeFromExternalContext(); - } - next(action); - }; -}; +} from '../../../../../../src/plugins/data/public'; +import { setState, LensGetState, LensDispatch } from '..'; +import { getResolvedDateRange } from '../../utils'; -function subscribeToExternalContext( +export function subscribeToExternalContext( data: DataPublicPluginStart, getState: LensGetState, dispatch: LensDispatch diff --git a/x-pack/plugins/lens/public/state_management/lens_slice.ts b/x-pack/plugins/lens/public/state_management/lens_slice.ts index cb181881a6552..21624ae99cefc 100644 --- a/x-pack/plugins/lens/public/state_management/lens_slice.ts +++ b/x-pack/plugins/lens/public/state_management/lens_slice.ts @@ -6,8 +6,10 @@ */ import { createSlice, current, PayloadAction } from '@reduxjs/toolkit'; +import { LensEmbeddableInput } from '..'; import { TableInspectorAdapter } from '../editor_frame_service/types'; -import { LensAppState } from './types'; +import { getInitialDatasourceId, getResolvedDateRange } from '../utils'; +import { LensAppState, LensStoreDeps } from './types'; export const initialState: LensAppState = { searchSessionId: '', @@ -26,6 +28,44 @@ export const initialState: LensAppState = { }, }; +export const getPreloadedState = ({ + lensServices: { data }, + initialContext, + embeddableEditorIncomingState, + datasourceMap, + visualizationMap, +}: LensStoreDeps) => { + const initialDatasourceId = getInitialDatasourceId(datasourceMap); + const datasourceStates: LensAppState['datasourceStates'] = {}; + if (initialDatasourceId) { + datasourceStates[initialDatasourceId] = { + state: null, + isLoading: true, + }; + } + + const state = { + ...initialState, + isLoading: true, + query: data.query.queryString.getQuery(), + // Do not use app-specific filters from previous app, + // only if Lens was opened with the intention to visualize a field (e.g. coming from Discover) + filters: !initialContext + ? data.query.filterManager.getGlobalFilters() + : data.query.filterManager.getFilters(), + searchSessionId: data.search.session.getSessionId(), + resolvedDateRange: getResolvedDateRange(data.query.timefilter.timefilter), + isLinkedToOriginatingApp: Boolean(embeddableEditorIncomingState?.originatingApp), + activeDatasourceId: initialDatasourceId, + datasourceStates, + visualization: { + state: null as unknown, + activeId: Object.keys(visualizationMap)[0] || null, + }, + }; + return state; +}; + export const lensSlice = createSlice({ name: 'lens', initialState, @@ -254,6 +294,13 @@ export const lensSlice = createSlice({ }; }, navigateAway: (state) => state, + loadInitial: ( + state, + payload: PayloadAction<{ + initialInput?: LensEmbeddableInput; + redirectCallback: (savedObjectId?: string) => void; + }> + ) => state, }, }); diff --git a/x-pack/plugins/lens/public/state_management/optimizing_middleware.ts b/x-pack/plugins/lens/public/state_management/optimizing_middleware.ts index 63e59221a683a..f1293a84255b9 100644 --- a/x-pack/plugins/lens/public/state_management/optimizing_middleware.ts +++ b/x-pack/plugins/lens/public/state_management/optimizing_middleware.ts @@ -5,14 +5,14 @@ * 2.0. */ -import { Dispatch, MiddlewareAPI, PayloadAction } from '@reduxjs/toolkit'; +import { Dispatch, MiddlewareAPI, Action } from '@reduxjs/toolkit'; import { isEqual } from 'lodash'; -import { LensAppState } from './types'; +import { lensSlice } from './lens_slice'; /** cancels updates to the store that don't change the state */ export const optimizingMiddleware = () => (store: MiddlewareAPI) => { - return (next: Dispatch) => (action: PayloadAction>) => { - if (action.type === 'lens/onActiveDataChange') { + return (next: Dispatch) => (action: Action) => { + if (lensSlice.actions.onActiveDataChange.match(action)) { if (isEqual(store.getState().lens.activeData, action.payload)) { return; } diff --git a/x-pack/plugins/lens/public/state_management/types.ts b/x-pack/plugins/lens/public/state_management/types.ts index 1c696a3d79f9d..8816ef27238c2 100644 --- a/x-pack/plugins/lens/public/state_management/types.ts +++ b/x-pack/plugins/lens/public/state_management/types.ts @@ -5,11 +5,15 @@ * 2.0. */ +import { VisualizeFieldContext } from 'src/plugins/ui_actions/public'; +import { EmbeddableEditorState } from 'src/plugins/embeddable/public'; import { Filter, Query, SavedQuery } from '../../../../../src/plugins/data/public'; import { Document } from '../persistence'; import { TableInspectorAdapter } from '../editor_frame_service/types'; import { DateRange } from '../../common'; +import { LensAppServices } from '../app_plugin/types'; +import { DatasourceMap, VisualizationMap } from '../types'; export interface PreviewState { visualization: { @@ -49,3 +53,11 @@ export type DispatchSetState = ( export interface LensState { lens: LensAppState; } + +export interface LensStoreDeps { + lensServices: LensAppServices; + datasourceMap: DatasourceMap; + visualizationMap: VisualizationMap; + initialContext?: VisualizeFieldContext; + embeddableEditorIncomingState?: EmbeddableEditorState; +} diff --git a/x-pack/plugins/lens/public/types.ts b/x-pack/plugins/lens/public/types.ts index 0e142c865aa81..91b16d2bcbc16 100644 --- a/x-pack/plugins/lens/public/types.ts +++ b/x-pack/plugins/lens/public/types.ts @@ -45,10 +45,13 @@ export interface EditorFrameProps { showNoDataPopover: () => void; } +export type VisualizationMap = Record; +export type DatasourceMap = Record; + export interface EditorFrameInstance { EditorFrameContainer: (props: EditorFrameProps) => React.ReactElement; - datasourceMap: Record; - visualizationMap: Record; + datasourceMap: DatasourceMap; + visualizationMap: VisualizationMap; } export interface EditorFrameSetup { diff --git a/x-pack/plugins/lens/public/utils.ts b/x-pack/plugins/lens/public/utils.ts index a79480d7d9953..b8ee5e4a0c26b 100644 --- a/x-pack/plugins/lens/public/utils.ts +++ b/x-pack/plugins/lens/public/utils.ts @@ -13,7 +13,7 @@ import { SavedObjectReference } from 'kibana/public'; import { Filter, Query } from 'src/plugins/data/public'; import { uniq } from 'lodash'; import { Document } from './persistence/saved_object_store'; -import { Datasource } from './types'; +import { Datasource, DatasourceMap } from './types'; import { extractFilterReferences } from './persistence'; export function getVisualizeGeoFieldMessage(fieldType: string) { @@ -55,10 +55,7 @@ export function getActiveDatasourceIdFromDoc(doc?: Document) { return firstDatasourceFromDoc || null; } -export const getInitialDatasourceId = ( - datasourceMap: Record, - doc?: Document -) => { +export const getInitialDatasourceId = (datasourceMap: DatasourceMap, doc?: Document) => { return (doc && getActiveDatasourceIdFromDoc(doc)) || Object.keys(datasourceMap)[0] || null; }; From 8f9086b4c2e509b6758a4dd138379dd85d8c2e64 Mon Sep 17 00:00:00 2001 From: Madison Caldwell Date: Tue, 3 Aug 2021 12:48:07 -0400 Subject: [PATCH 11/63] [RAC][Security Solution] Add base Security Rule Type (#105096) * injects bulkCreate and wrapHits to individual rule executors * WIP create_security_rule_type_factory based on Marshall's work in #d3076ca54526ea0e61a9a99e1c1bce854806977e * removes ruleStatusService from old rule executors, fixes executor unit tests * fixes rebase * Rename reference_rules to rule_types * Fix type errors * Fix type errors in base security rule factory * Additional improvements to types and interfaces * More type alignment * Fix remaining type errors in query rule * Add validation / inject lists plugin * Formatting * Improvements to typing * Static typing on executors * cleanup * Hook up params for query/threshold rules... includes exceptionsList and daterange tuple * Scaffolding for wrapHits and bulkCreate * Add error handling / status reporting * Fixup alert type state * Begin threshold * Begin work on threshold state * Organize rule types * Export base security rule types * Fixup lifecycle static typing * WrapHits / bulk changes * Field mappings (partial) * whoops * Remove redundant params * More flexibile implementation of bulkCreateFactory * Add mappings * Finish query rule * Revert "Remove redundant params" This reverts commit 87aff9c81041e9328ee47ed7ec413750ee722b65. * Revert "whoops" This reverts commit a7771bd3920cb2dd156325cf61a77e48acc84074. * Fixup return types * Use alertWithPersistence * Fix import * End-to-end rule mostly working * Fix bulkCreate * Bug fixes * Bug fixes and mapping changes * Fix indexing * cleanup * Fix type errors * Test fixes * Fix query tests * cleanup / rename kibana.rac to kibana * Remove eql/threshold (for now) * Move technical fields to package * Add indexAlias and buildRuleMessageFactory * imports * type errors * Change 'kibana.rac.*' to 'kibana.*' * Fix lifecycle tests * Single alert instance * fix import * Fix type error * Fix more type errors * Fix query rule type test * revert to previous ts-expect-error * type errors again * types / linting * General readability improvements * Add invariant function from Dmitrii's branch * Use invariant and constants * Improvements to field mappings * More test failure fixes * Add refresh param for bulk create * Update more field refs * Actually use refresh param * cleanup * test fixes * changes to rule creation script * Fix created signals count * Use ruleId * Updates to bulk indexing * Mapping updates * Cannot use 'strict' for dynamic setting Co-authored-by: Marshall Main Co-authored-by: Ece Ozalp Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> --- api_docs/observability.json | 6 +- api_docs/rule_registry.json | 12 +- .../src/technical_field_names.ts | 199 ++++++++--- .../helper/get_alert_annotations.test.tsx | 32 +- .../latency_chart/latency_chart.stories.tsx | 62 ++-- x-pack/plugins/apm/server/plugin.ts | 29 +- .../alerts_flyout/alerts_flyout.stories.tsx | 4 +- .../public/pages/alerts/example_data.ts | 57 +-- x-pack/plugins/rule_registry/README.md | 32 +- .../ecs_component_template.ts | 4 +- .../technical_component_template.ts | 2 +- .../common/assets/field_maps/ecs_field_map.ts | 5 + .../field_maps/technical_rule_field_map.ts | 275 ++++++++++++--- .../common/mapping_from_field_map.ts | 7 +- .../alerts_client/classes/alertsclient.md | 4 +- .../server/alert_data_client/alerts_client.ts | 10 +- .../alert_data_client/tests/get.test.ts | 31 +- .../alert_data_client/tests/update.test.ts | 27 +- .../server/event_log/event_schema/schema.ts | 6 +- .../event_log/log/event_log_resolver.ts | 2 +- .../event_log/log/event_logger_template.ts | 4 +- .../event_log/log/event_query_builder.ts | 2 +- .../log/utils/mapping_from_field_map.ts | 7 +- x-pack/plugins/rule_registry/server/index.ts | 9 +- .../server/routes/get_alert_by_id.test.ts | 25 +- x-pack/plugins/rule_registry/server/types.ts | 29 +- .../utils/create_lifecycle_executor.test.ts | 2 +- .../server/utils/create_lifecycle_executor.ts | 8 +- .../utils/create_lifecycle_rule_type.test.ts | 57 +-- .../create_lifecycle_rule_type_factory.ts | 21 +- .../create_persistence_rule_type_factory.ts | 104 ++---- .../server/utils/get_rule_executor_data.ts | 6 +- .../server/utils/persistence_types.ts | 50 +++ .../utils/with_rule_data_client_factory.ts | 5 +- .../security_solution/common/constants.ts | 2 +- .../alerts_table/default_config.tsx | 29 +- .../examples/observablity_alerts/columns.ts | 6 +- .../render_cell_value.test.tsx | 6 +- .../observablity_alerts/render_cell_value.tsx | 9 +- .../schedule_notification_actions.ts | 2 +- .../reference_rules/eql.test.ts | 90 ----- .../detection_engine/reference_rules/eql.ts | 122 ------- .../detection_engine/reference_rules/query.ts | 89 ----- .../scripts/create_reference_rule_eql.sh | 34 -- .../create_reference_rule_threshold.sh | 37 -- .../reference_rules/threshold.test.ts | 132 ------- .../reference_rules/threshold.ts | 207 ----------- .../rule_execution_log_bootstrapper.ts | 2 +- .../with_rule_execution_log.ts | 11 +- .../__mocks__/eql.ts | 0 .../rule_types/__mocks__/rule.ts | 52 +++ .../__mocks__/rule_type.ts | 47 ++- .../__mocks__/threshold.ts | 0 .../create_security_rule_type_factory.ts | 324 ++++++++++++++++++ .../factories/build_rule_message_factory.ts | 28 ++ .../factories/bulk_create_factory.ts | 105 ++++++ .../rule_types/factories/index.ts | 10 + .../rule_types/factories/utils/build_alert.ts | 147 ++++++++ .../factories/utils/build_bulk_body.ts | 40 +++ .../factories/utils/filter_source.ts | 24 ++ .../rule_types/factories/wrap_hits_factory.ts | 36 ++ .../rule_types/field_maps/alerts.ts | 298 ++++++++++++++++ .../rule_types/field_maps/index.ts | 10 + .../rule_types/field_maps/rules.ts | 136 ++++++++ .../lib/detection_engine/rule_types/index.ts | 8 + .../{reference_rules => rule_types}/ml.ts | 0 .../query/create_query_alert_type.test.ts} | 67 ++-- .../query/create_query_alert_type.ts | 111 ++++++ .../scripts/create_rule_query.sh} | 25 +- .../lib/detection_engine/rule_types/types.ts | 118 +++++++ .../rule_types/utils/get_list_client.ts | 38 ++ .../rule_types/utils/index.ts | 25 ++ .../signals/bulk_create_factory.ts | 1 + .../signals/executors/query.ts | 1 + .../signals/filter_duplicate_signals.ts | 20 +- .../signals/search_after_bulk_create.ts | 1 + .../signals/signal_rule_alert_type.ts | 8 +- .../lib/detection_engine/signals/types.ts | 11 +- .../signals/wrap_hits_factory.ts | 9 +- .../security_solution/server/plugin.ts | 41 +-- .../server/search_strategy/timeline/index.ts | 4 +- .../lib/alert_types/duration_anomaly.tsx | 11 +- .../public/lib/alert_types/monitor_status.tsx | 20 +- .../server/lib/alerts/status_check.test.ts | 4 +- .../plugins/uptime/server/lib/alerts/types.ts | 12 +- x-pack/plugins/uptime/server/plugin.ts | 2 +- .../tests/alerts/rule_registry.ts | 79 ++--- .../rule_registry/alerts/data.json | 20 +- .../rule_registry/alerts/mappings.json | 4 +- .../security_and_spaces/tests/basic/events.ts | 20 +- .../security_and_spaces/tests/trial/events.ts | 20 +- .../security_only/tests/basic/events.ts | 13 +- .../security_only/tests/trial/events.ts | 13 +- .../test/timeline/spaces_only/tests/events.ts | 15 +- 94 files changed, 2546 insertions(+), 1345 deletions(-) create mode 100644 x-pack/plugins/rule_registry/server/utils/persistence_types.ts delete mode 100644 x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/eql.test.ts delete mode 100644 x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/eql.ts delete mode 100644 x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/query.ts delete mode 100755 x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/scripts/create_reference_rule_eql.sh delete mode 100755 x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/scripts/create_reference_rule_threshold.sh delete mode 100644 x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/threshold.test.ts delete mode 100644 x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/threshold.ts rename x-pack/plugins/security_solution/server/lib/detection_engine/{reference_rules => rule_types}/__mocks__/eql.ts (100%) create mode 100644 x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/__mocks__/rule.ts rename x-pack/plugins/security_solution/server/lib/detection_engine/{reference_rules => rule_types}/__mocks__/rule_type.ts (62%) rename x-pack/plugins/security_solution/server/lib/detection_engine/{reference_rules => rule_types}/__mocks__/threshold.ts (100%) create mode 100644 x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/create_security_rule_type_factory.ts create mode 100644 x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/build_rule_message_factory.ts create mode 100644 x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/bulk_create_factory.ts create mode 100644 x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/index.ts create mode 100644 x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/utils/build_alert.ts create mode 100644 x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/utils/build_bulk_body.ts create mode 100644 x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/utils/filter_source.ts create mode 100644 x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/wrap_hits_factory.ts create mode 100644 x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/field_maps/alerts.ts create mode 100644 x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/field_maps/index.ts create mode 100644 x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/field_maps/rules.ts create mode 100644 x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/index.ts rename x-pack/plugins/security_solution/server/lib/detection_engine/{reference_rules => rule_types}/ml.ts (100%) rename x-pack/plugins/security_solution/server/lib/detection_engine/{reference_rules/query.test.ts => rule_types/query/create_query_alert_type.test.ts} (55%) create mode 100644 x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/create_query_alert_type.ts rename x-pack/plugins/security_solution/server/lib/detection_engine/{reference_rules/scripts/create_reference_rule_query.sh => rule_types/scripts/create_rule_query.sh} (55%) create mode 100644 x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/types.ts create mode 100644 x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/get_list_client.ts create mode 100644 x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/index.ts diff --git a/api_docs/observability.json b/api_docs/observability.json index 1daf96c7a551f..2a0528878114b 100644 --- a/api_docs/observability.json +++ b/api_docs/observability.json @@ -2122,7 +2122,7 @@ "signature": [ "(options: { fields: OutputOf<", "Optional", - "<{ readonly \"kibana.rac.alert.owner\": { readonly type: \"keyword\"; }; readonly \"kibana.rac.alert.producer\": { readonly type: \"keyword\"; }; readonly \"kibana.space_ids\": { readonly type: \"keyword\"; readonly array: true; }; readonly \"kibana.rac.alert.uuid\": { readonly type: \"keyword\"; }; readonly \"kibana.rac.alert.id\": { readonly type: \"keyword\"; }; readonly \"kibana.rac.alert.start\": { readonly type: \"date\"; }; readonly \"kibana.rac.alert.end\": { readonly type: \"date\"; }; readonly \"kibana.rac.alert.duration.us\": { readonly type: \"long\"; }; readonly \"kibana.rac.alert.severity.level\": { readonly type: \"keyword\"; }; readonly \"kibana.rac.alert.severity.value\": { readonly type: \"long\"; }; readonly \"kibana.rac.alert.status\": { readonly type: \"keyword\"; }; readonly \"kibana.rac.alert.evaluation.threshold\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.rac.alert.evaluation.value\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.rac.alert.reason\": { readonly type: \"keyword\"; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly '@timestamp': { readonly type: \"date\"; readonly array: false; readonly required: true; }; readonly 'event.kind': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.action': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.uuid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.category': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; }, \"tags\" | \"event.kind\" | \"event.action\" | \"rule.uuid\" | \"rule.id\" | \"rule.name\" | \"rule.category\" | \"kibana.rac.alert.producer\" | \"kibana.rac.alert.owner\" | \"kibana.rac.alert.id\" | \"kibana.rac.alert.uuid\" | \"kibana.rac.alert.start\" | \"kibana.rac.alert.end\" | \"kibana.rac.alert.duration.us\" | \"kibana.rac.alert.severity.level\" | \"kibana.rac.alert.severity.value\" | \"kibana.rac.alert.status\" | \"kibana.rac.alert.evaluation.threshold\" | \"kibana.rac.alert.evaluation.value\" | \"kibana.rac.alert.reason\" | \"kibana.space_ids\">> & Record; formatters: { asDuration: (value: number | null | undefined, { defaultValue, extended }?: FormatterOptions) => string; asPercent: (numerator: number | null | undefined, denominator: number | undefined, fallbackResult?: string) => string; }; }) => { reason: string; link: string; }" + "<{ readonly \"kibana.alert.owner\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.producer\": { readonly type: \"keyword\"; }; readonly \"kibana.space_ids\": { readonly type: \"keyword\"; readonly array: true; }; readonly \"kibana.alert.uuid\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.id\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.start\": { readonly type: \"date\"; }; readonly \"kibana.alert.end\": { readonly type: \"date\"; }; readonly \"kibana.alert.duration.us\": { readonly type: \"long\"; }; readonly \"kibana.alert.severity.level\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.severity.value\": { readonly type: \"long\"; }; readonly \"kibana.alert.status\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.evaluation.threshold\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.alert.evaluation.value\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.alert.reason\": { readonly type: \"keyword\"; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly '@timestamp': { readonly type: \"date\"; readonly array: false; readonly required: true; }; readonly 'event.kind': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.action': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.uuid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.category': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; }, \"tags\" | \"event.kind\" | \"event.action\" | \"rule.uuid\" | \"rule.id\" | \"rule.name\" | \"rule.category\" | \"kibana.alert.producer\" | \"kibana.alert.owner\" | \"kibana.alert.id\" | \"kibana.alert.uuid\" | \"kibana.alert.start\" | \"kibana.alert.end\" | \"kibana.alert.duration.us\" | \"kibana.alert.severity.level\" | \"kibana.alert.severity.value\" | \"kibana.alert.status\" | \"kibana.alert.evaluation.threshold\" | \"kibana.alert.evaluation.value\" | \"kibana.alert.reason\" | \"kibana.space_ids\">> & Record; formatters: { asDuration: (value: number | null | undefined, { defaultValue, extended }?: FormatterOptions) => string; asPercent: (numerator: number | null | undefined, denominator: number | undefined, fallbackResult?: string) => string; }; }) => { reason: string; link: string; }" ], "path": "x-pack/plugins/observability/public/rules/create_observability_rule_type_registry.ts", "deprecated": false, @@ -2138,7 +2138,7 @@ "signature": [ "{ fields: OutputOf<", "Optional", - "<{ readonly \"kibana.rac.alert.owner\": { readonly type: \"keyword\"; }; readonly \"kibana.rac.alert.producer\": { readonly type: \"keyword\"; }; readonly \"kibana.space_ids\": { readonly type: \"keyword\"; readonly array: true; }; readonly \"kibana.rac.alert.uuid\": { readonly type: \"keyword\"; }; readonly \"kibana.rac.alert.id\": { readonly type: \"keyword\"; }; readonly \"kibana.rac.alert.start\": { readonly type: \"date\"; }; readonly \"kibana.rac.alert.end\": { readonly type: \"date\"; }; readonly \"kibana.rac.alert.duration.us\": { readonly type: \"long\"; }; readonly \"kibana.rac.alert.severity.level\": { readonly type: \"keyword\"; }; readonly \"kibana.rac.alert.severity.value\": { readonly type: \"long\"; }; readonly \"kibana.rac.alert.status\": { readonly type: \"keyword\"; }; readonly \"kibana.rac.alert.evaluation.threshold\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.rac.alert.evaluation.value\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.rac.alert.reason\": { readonly type: \"keyword\"; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly '@timestamp': { readonly type: \"date\"; readonly array: false; readonly required: true; }; readonly 'event.kind': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.action': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.uuid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.category': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; }, \"tags\" | \"event.kind\" | \"event.action\" | \"rule.uuid\" | \"rule.id\" | \"rule.name\" | \"rule.category\" | \"kibana.rac.alert.producer\" | \"kibana.rac.alert.owner\" | \"kibana.rac.alert.id\" | \"kibana.rac.alert.uuid\" | \"kibana.rac.alert.start\" | \"kibana.rac.alert.end\" | \"kibana.rac.alert.duration.us\" | \"kibana.rac.alert.severity.level\" | \"kibana.rac.alert.severity.value\" | \"kibana.rac.alert.status\" | \"kibana.rac.alert.evaluation.threshold\" | \"kibana.rac.alert.evaluation.value\" | \"kibana.rac.alert.reason\" | \"kibana.space_ids\">> & Record; formatters: { asDuration: (value: number | null | undefined, { defaultValue, extended }?: FormatterOptions) => string; asPercent: (numerator: number | null | undefined, denominator: number | undefined, fallbackResult?: string) => string; }; }" + "<{ readonly \"kibana.alert.owner\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.producer\": { readonly type: \"keyword\"; }; readonly \"kibana.space_ids\": { readonly type: \"keyword\"; readonly array: true; }; readonly \"kibana.alert.uuid\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.id\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.start\": { readonly type: \"date\"; }; readonly \"kibana.alert.end\": { readonly type: \"date\"; }; readonly \"kibana.alert.duration.us\": { readonly type: \"long\"; }; readonly \"kibana.alert.severity.level\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.severity.value\": { readonly type: \"long\"; }; readonly \"kibana.alert.status\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.evaluation.threshold\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.alert.evaluation.value\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.alert.reason\": { readonly type: \"keyword\"; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly '@timestamp': { readonly type: \"date\"; readonly array: false; readonly required: true; }; readonly 'event.kind': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.action': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.uuid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.category': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; }, \"tags\" | \"event.kind\" | \"event.action\" | \"rule.uuid\" | \"rule.id\" | \"rule.name\" | \"rule.category\" | \"kibana.alert.producer\" | \"kibana.alert.owner\" | \"kibana.alert.id\" | \"kibana.alert.uuid\" | \"kibana.alert.start\" | \"kibana.alert.end\" | \"kibana.alert.duration.us\" | \"kibana.alert.severity.level\" | \"kibana.alert.severity.value\" | \"kibana.alert.status\" | \"kibana.alert.evaluation.threshold\" | \"kibana.alert.evaluation.value\" | \"kibana.alert.reason\" | \"kibana.space_ids\">> & Record; formatters: { asDuration: (value: number | null | undefined, { defaultValue, extended }?: FormatterOptions) => string; asPercent: (numerator: number | null | undefined, denominator: number | undefined, fallbackResult?: string) => string; }; }" ], "path": "x-pack/plugins/observability/public/rules/create_observability_rule_type_registry.ts", "deprecated": false @@ -2979,7 +2979,7 @@ "signature": [ "(options: { fields: OutputOf<", "Optional", - "<{ readonly \"kibana.rac.alert.owner\": { readonly type: \"keyword\"; }; readonly \"kibana.rac.alert.producer\": { readonly type: \"keyword\"; }; readonly \"kibana.space_ids\": { readonly type: \"keyword\"; readonly array: true; }; readonly \"kibana.rac.alert.uuid\": { readonly type: \"keyword\"; }; readonly \"kibana.rac.alert.id\": { readonly type: \"keyword\"; }; readonly \"kibana.rac.alert.start\": { readonly type: \"date\"; }; readonly \"kibana.rac.alert.end\": { readonly type: \"date\"; }; readonly \"kibana.rac.alert.duration.us\": { readonly type: \"long\"; }; readonly \"kibana.rac.alert.severity.level\": { readonly type: \"keyword\"; }; readonly \"kibana.rac.alert.severity.value\": { readonly type: \"long\"; }; readonly \"kibana.rac.alert.status\": { readonly type: \"keyword\"; }; readonly \"kibana.rac.alert.evaluation.threshold\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.rac.alert.evaluation.value\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.rac.alert.reason\": { readonly type: \"keyword\"; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly '@timestamp': { readonly type: \"date\"; readonly array: false; readonly required: true; }; readonly 'event.kind': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.action': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.uuid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.category': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; }, \"tags\" | \"event.kind\" | \"event.action\" | \"rule.uuid\" | \"rule.id\" | \"rule.name\" | \"rule.category\" | \"kibana.rac.alert.producer\" | \"kibana.rac.alert.owner\" | \"kibana.rac.alert.id\" | \"kibana.rac.alert.uuid\" | \"kibana.rac.alert.start\" | \"kibana.rac.alert.end\" | \"kibana.rac.alert.duration.us\" | \"kibana.rac.alert.severity.level\" | \"kibana.rac.alert.severity.value\" | \"kibana.rac.alert.status\" | \"kibana.rac.alert.evaluation.threshold\" | \"kibana.rac.alert.evaluation.value\" | \"kibana.rac.alert.reason\" | \"kibana.space_ids\">> & Record; formatters: { asDuration: (value: number | null | undefined, { defaultValue, extended }?: FormatterOptions) => string; asPercent: (numerator: number | null | undefined, denominator: number | undefined, fallbackResult?: string) => string; }; }) => { reason: string; link: string; }" + "<{ readonly \"kibana.alert.owner\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.producer\": { readonly type: \"keyword\"; }; readonly \"kibana.space_ids\": { readonly type: \"keyword\"; readonly array: true; }; readonly \"kibana.alert.uuid\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.id\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.start\": { readonly type: \"date\"; }; readonly \"kibana.alert.end\": { readonly type: \"date\"; }; readonly \"kibana.alert.duration.us\": { readonly type: \"long\"; }; readonly \"kibana.alert.severity.level\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.severity.value\": { readonly type: \"long\"; }; readonly \"kibana.alert.status\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.evaluation.threshold\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.alert.evaluation.value\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.alert.reason\": { readonly type: \"keyword\"; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly '@timestamp': { readonly type: \"date\"; readonly array: false; readonly required: true; }; readonly 'event.kind': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.action': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.uuid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.category': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; }, \"tags\" | \"event.kind\" | \"event.action\" | \"rule.uuid\" | \"rule.id\" | \"rule.name\" | \"rule.category\" | \"kibana.alert.producer\" | \"kibana.alert.owner\" | \"kibana.alert.id\" | \"kibana.alert.uuid\" | \"kibana.alert.start\" | \"kibana.alert.end\" | \"kibana.alert.duration.us\" | \"kibana.alert.severity.level\" | \"kibana.alert.severity.value\" | \"kibana.alert.status\" | \"kibana.alert.evaluation.threshold\" | \"kibana.alert.evaluation.value\" | \"kibana.alert.reason\" | \"kibana.space_ids\">> & Record; formatters: { asDuration: (value: number | null | undefined, { defaultValue, extended }?: FormatterOptions) => string; asPercent: (numerator: number | null | undefined, denominator: number | undefined, fallbackResult?: string) => string; }; }) => { reason: string; link: string; }" ], "path": "x-pack/plugins/observability/public/rules/create_observability_rule_type_registry.ts", "deprecated": false, diff --git a/api_docs/rule_registry.json b/api_docs/rule_registry.json index 24a8be2d2650f..74480af0eb2f8 100644 --- a/api_docs/rule_registry.json +++ b/api_docs/rule_registry.json @@ -525,7 +525,7 @@ "section": "def-server.AlertExecutorOptions", "text": "AlertExecutorOptions" }, - ") => { \"rule.id\": string; \"rule.uuid\": string; \"rule.category\": string; \"rule.name\": string; tags: string[]; \"kibana.rac.alert.producer\": string; }" + ") => { \"rule.id\": string; \"rule.uuid\": string; \"rule.category\": string; \"rule.name\": string; tags: string[]; \"kibana.alert.producer\": string; }" ], "path": "x-pack/plugins/rule_registry/server/utils/get_rule_executor_data.ts", "deprecated": false, @@ -740,7 +740,7 @@ "signature": [ "(alert: { id: string; fields: Record & Partial>, \"tags\" | \"@timestamp\" | \"event.kind\" | \"event.action\" | \"rule.uuid\" | \"rule.id\" | \"rule.name\" | \"rule.category\" | \"kibana.rac.alert.producer\" | \"kibana.rac.alert.owner\" | \"kibana.rac.alert.uuid\" | \"kibana.rac.alert.start\" | \"kibana.rac.alert.end\" | \"kibana.rac.alert.duration.us\" | \"kibana.rac.alert.severity.level\" | \"kibana.rac.alert.severity.value\" | \"kibana.rac.alert.status\" | \"kibana.rac.alert.evaluation.threshold\" | \"kibana.rac.alert.evaluation.value\" | \"kibana.rac.alert.reason\" | \"kibana.space_ids\">>; }) => Pick<", + "<{ readonly \"kibana.alert.owner\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.producer\": { readonly type: \"keyword\"; }; readonly \"kibana.space_ids\": { readonly type: \"keyword\"; readonly array: true; }; readonly \"kibana.alert.uuid\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.id\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.start\": { readonly type: \"date\"; }; readonly \"kibana.alert.end\": { readonly type: \"date\"; }; readonly \"kibana.alert.duration.us\": { readonly type: \"long\"; }; readonly \"kibana.alert.severity.level\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.severity.value\": { readonly type: \"long\"; }; readonly \"kibana.alert.status\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.evaluation.threshold\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.alert.evaluation.value\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.alert.reason\": { readonly type: \"keyword\"; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly '@timestamp': { readonly type: \"date\"; readonly array: false; readonly required: true; }; readonly 'event.kind': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.action': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.uuid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.category': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; }, \"tags\" | \"event.kind\" | \"event.action\" | \"rule.uuid\" | \"rule.id\" | \"rule.name\" | \"rule.category\" | \"kibana.alert.producer\" | \"kibana.alert.owner\" | \"kibana.alert.id\" | \"kibana.alert.uuid\" | \"kibana.alert.start\" | \"kibana.alert.end\" | \"kibana.alert.duration.us\" | \"kibana.alert.severity.level\" | \"kibana.alert.severity.value\" | \"kibana.alert.status\" | \"kibana.alert.evaluation.threshold\" | \"kibana.alert.evaluation.value\" | \"kibana.alert.reason\" | \"kibana.space_ids\">>, \"tags\" | \"@timestamp\" | \"event.kind\" | \"event.action\" | \"rule.uuid\" | \"rule.id\" | \"rule.name\" | \"rule.category\" | \"kibana.alert.producer\" | \"kibana.alert.owner\" | \"kibana.alert.uuid\" | \"kibana.alert.start\" | \"kibana.alert.end\" | \"kibana.alert.duration.us\" | \"kibana.alert.severity.level\" | \"kibana.alert.severity.value\" | \"kibana.alert.status\" | \"kibana.alert.evaluation.threshold\" | \"kibana.alert.evaluation.value\" | \"kibana.alert.reason\" | \"kibana.space_ids\">>; }) => Pick<", "AlertInstance", ", \"getState\" | \"replaceState\" | \"scheduleActions\" | \"scheduleActionsWithSubGroup\">" ], @@ -758,7 +758,7 @@ "signature": [ "{ id: string; fields: Record & Partial>, \"tags\" | \"@timestamp\" | \"event.kind\" | \"event.action\" | \"rule.uuid\" | \"rule.id\" | \"rule.name\" | \"rule.category\" | \"kibana.rac.alert.producer\" | \"kibana.rac.alert.owner\" | \"kibana.rac.alert.uuid\" | \"kibana.rac.alert.start\" | \"kibana.rac.alert.end\" | \"kibana.rac.alert.duration.us\" | \"kibana.rac.alert.severity.level\" | \"kibana.rac.alert.severity.value\" | \"kibana.rac.alert.status\" | \"kibana.rac.alert.evaluation.threshold\" | \"kibana.rac.alert.evaluation.value\" | \"kibana.rac.alert.reason\" | \"kibana.space_ids\">>; }" + "<{ readonly \"kibana.alert.owner\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.producer\": { readonly type: \"keyword\"; }; readonly \"kibana.space_ids\": { readonly type: \"keyword\"; readonly array: true; }; readonly \"kibana.alert.uuid\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.id\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.start\": { readonly type: \"date\"; }; readonly \"kibana.alert.end\": { readonly type: \"date\"; }; readonly \"kibana.alert.duration.us\": { readonly type: \"long\"; }; readonly \"kibana.alert.severity.level\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.severity.value\": { readonly type: \"long\"; }; readonly \"kibana.alert.status\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.evaluation.threshold\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.alert.evaluation.value\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.alert.reason\": { readonly type: \"keyword\"; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly '@timestamp': { readonly type: \"date\"; readonly array: false; readonly required: true; }; readonly 'event.kind': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.action': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.uuid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.category': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; }, \"tags\" | \"event.kind\" | \"event.action\" | \"rule.uuid\" | \"rule.id\" | \"rule.name\" | \"rule.category\" | \"kibana.alert.producer\" | \"kibana.alert.owner\" | \"kibana.alert.id\" | \"kibana.alert.uuid\" | \"kibana.alert.start\" | \"kibana.alert.end\" | \"kibana.alert.duration.us\" | \"kibana.alert.severity.level\" | \"kibana.alert.severity.value\" | \"kibana.alert.status\" | \"kibana.alert.evaluation.threshold\" | \"kibana.alert.evaluation.value\" | \"kibana.alert.reason\" | \"kibana.space_ids\">>, \"tags\" | \"@timestamp\" | \"event.kind\" | \"event.action\" | \"rule.uuid\" | \"rule.id\" | \"rule.name\" | \"rule.category\" | \"kibana.alert.producer\" | \"kibana.alert.owner\" | \"kibana.alert.uuid\" | \"kibana.alert.start\" | \"kibana.alert.end\" | \"kibana.alert.duration.us\" | \"kibana.alert.severity.level\" | \"kibana.alert.severity.value\" | \"kibana.alert.status\" | \"kibana.alert.evaluation.threshold\" | \"kibana.alert.evaluation.value\" | \"kibana.alert.reason\" | \"kibana.space_ids\">>; }" ], "path": "x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.ts", "deprecated": false @@ -850,10 +850,10 @@ }, { "parentPluginId": "ruleRegistry", - "id": "def-server.RuleExecutorData.PRODUCER", + "id": "def-server.RuleExecutorData.ALERT_PRODUCER", "type": "string", "tags": [], - "label": "[PRODUCER]", + "label": "[ALERT_PRODUCER]", "description": [], "path": "x-pack/plugins/rule_registry/server/utils/get_rule_executor_data.ts", "deprecated": false @@ -1147,7 +1147,7 @@ "signature": [ "(input: unknown) => OutputOf<", "Optional", - "<{ readonly \"kibana.rac.alert.owner\": { readonly type: \"keyword\"; }; readonly \"kibana.rac.alert.producer\": { readonly type: \"keyword\"; }; readonly \"kibana.space_ids\": { readonly type: \"keyword\"; readonly array: true; }; readonly \"kibana.rac.alert.uuid\": { readonly type: \"keyword\"; }; readonly \"kibana.rac.alert.id\": { readonly type: \"keyword\"; }; readonly \"kibana.rac.alert.start\": { readonly type: \"date\"; }; readonly \"kibana.rac.alert.end\": { readonly type: \"date\"; }; readonly \"kibana.rac.alert.duration.us\": { readonly type: \"long\"; }; readonly \"kibana.rac.alert.severity.level\": { readonly type: \"keyword\"; }; readonly \"kibana.rac.alert.severity.value\": { readonly type: \"long\"; }; readonly \"kibana.rac.alert.status\": { readonly type: \"keyword\"; }; readonly \"kibana.rac.alert.evaluation.threshold\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.rac.alert.evaluation.value\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.rac.alert.reason\": { readonly type: \"keyword\"; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly '@timestamp': { readonly type: \"date\"; readonly array: false; readonly required: true; }; readonly 'event.kind': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.action': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.uuid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.category': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; }, \"tags\" | \"event.kind\" | \"event.action\" | \"rule.uuid\" | \"rule.id\" | \"rule.name\" | \"rule.category\" | \"kibana.rac.alert.producer\" | \"kibana.rac.alert.owner\" | \"kibana.rac.alert.id\" | \"kibana.rac.alert.uuid\" | \"kibana.rac.alert.start\" | \"kibana.rac.alert.end\" | \"kibana.rac.alert.duration.us\" | \"kibana.rac.alert.severity.level\" | \"kibana.rac.alert.severity.value\" | \"kibana.rac.alert.status\" | \"kibana.rac.alert.evaluation.threshold\" | \"kibana.rac.alert.evaluation.value\" | \"kibana.rac.alert.reason\" | \"kibana.space_ids\">>" + "<{ readonly \"kibana.alert.owner\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.producer\": { readonly type: \"keyword\"; }; readonly \"kibana.space_ids\": { readonly type: \"keyword\"; readonly array: true; }; readonly \"kibana.alert.uuid\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.id\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.start\": { readonly type: \"date\"; }; readonly \"kibana.alert.end\": { readonly type: \"date\"; }; readonly \"kibana.alert.duration.us\": { readonly type: \"long\"; }; readonly \"kibana.alert.severity.level\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.severity.value\": { readonly type: \"long\"; }; readonly \"kibana.alert.status\": { readonly type: \"keyword\"; }; readonly \"kibana.alert.evaluation.threshold\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.alert.evaluation.value\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.alert.reason\": { readonly type: \"keyword\"; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly '@timestamp': { readonly type: \"date\"; readonly array: false; readonly required: true; }; readonly 'event.kind': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.action': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.uuid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.category': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; }, \"tags\" | \"event.kind\" | \"event.action\" | \"rule.uuid\" | \"rule.id\" | \"rule.name\" | \"rule.category\" | \"kibana.alert.producer\" | \"kibana.alert.owner\" | \"kibana.alert.id\" | \"kibana.alert.uuid\" | \"kibana.alert.start\" | \"kibana.alert.end\" | \"kibana.alert.duration.us\" | \"kibana.alert.severity.level\" | \"kibana.alert.severity.value\" | \"kibana.alert.status\" | \"kibana.alert.evaluation.threshold\" | \"kibana.alert.evaluation.value\" | \"kibana.alert.reason\" | \"kibana.space_ids\">>" ], "path": "x-pack/plugins/rule_registry/common/parse_technical_fields.ts", "deprecated": false, diff --git a/packages/kbn-rule-data-utils/src/technical_field_names.ts b/packages/kbn-rule-data-utils/src/technical_field_names.ts index 54a6fa26664e3..c55be6cfe8ff6 100644 --- a/packages/kbn-rule-data-utils/src/technical_field_names.ts +++ b/packages/kbn-rule-data-utils/src/technical_field_names.ts @@ -8,79 +8,192 @@ import { ValuesType } from 'utility-types'; -const ALERT_NAMESPACE = 'kibana.rac.alert' as const; +const KIBANA_NAMESPACE = 'kibana' as const; -const TIMESTAMP = '@timestamp' as const; -const EVENT_KIND = 'event.kind' as const; +const ALERT_NAMESPACE = `${KIBANA_NAMESPACE}.alert` as const; +const ALERT_RULE_NAMESPACE = `${ALERT_NAMESPACE}.rule` as const; + +const CONSUMERS = `${KIBANA_NAMESPACE}.consumers` as const; +const ECS_VERSION = 'ecs.version' as const; const EVENT_ACTION = 'event.action' as const; -const RULE_UUID = 'rule.uuid' as const; +const EVENT_KIND = 'event.kind' as const; +const RULE_CATEGORY = 'rule.category' as const; +const RULE_CONSUMERS = 'rule.consumers' as const; const RULE_ID = 'rule.id' as const; const RULE_NAME = 'rule.name' as const; -const RULE_CATEGORY = 'rule.category' as const; +const RULE_UUID = 'rule.uuid' as const; +const SPACE_IDS = `${KIBANA_NAMESPACE}.space_ids` as const; const TAGS = 'tags' as const; -const PRODUCER = `${ALERT_NAMESPACE}.producer` as const; -const OWNER = `${ALERT_NAMESPACE}.owner` as const; -const ALERT_ID = `${ALERT_NAMESPACE}.id` as const; -const ALERT_UUID = `${ALERT_NAMESPACE}.uuid` as const; -const ALERT_START = `${ALERT_NAMESPACE}.start` as const; -const ALERT_END = `${ALERT_NAMESPACE}.end` as const; +const TIMESTAMP = '@timestamp' as const; +const VERSION = `${KIBANA_NAMESPACE}.version` as const; + +const ALERT_ACTION_GROUP = `${ALERT_NAMESPACE}.action_group` as const; const ALERT_DURATION = `${ALERT_NAMESPACE}.duration.us` as const; -const ALERT_SEVERITY_LEVEL = `${ALERT_NAMESPACE}.severity.level` as const; -const ALERT_SEVERITY_VALUE = `${ALERT_NAMESPACE}.severity.value` as const; -const ALERT_STATUS = `${ALERT_NAMESPACE}.status` as const; -const SPACE_IDS = 'kibana.space_ids' as const; +const ALERT_END = `${ALERT_NAMESPACE}.end` as const; const ALERT_EVALUATION_THRESHOLD = `${ALERT_NAMESPACE}.evaluation.threshold` as const; const ALERT_EVALUATION_VALUE = `${ALERT_NAMESPACE}.evaluation.value` as const; +const ALERT_ID = `${ALERT_NAMESPACE}.id` as const; +const ALERT_OWNER = `${ALERT_NAMESPACE}.owner` as const; +const ALERT_PRODUCER = `${ALERT_NAMESPACE}.producer` as const; const ALERT_REASON = `${ALERT_NAMESPACE}.reason` as const; +const ALERT_RISK_SCORE = `${ALERT_NAMESPACE}.risk_score` as const; +const ALERT_SEVERITY = `${ALERT_NAMESPACE}.severity` as const; +const ALERT_SEVERITY_LEVEL = `${ALERT_NAMESPACE}.severity.level` as const; +const ALERT_SEVERITY_VALUE = `${ALERT_NAMESPACE}.severity.value` as const; +const ALERT_START = `${ALERT_NAMESPACE}.start` as const; +const ALERT_STATUS = `${ALERT_NAMESPACE}.status` as const; +const ALERT_SYSTEM_STATUS = `${ALERT_NAMESPACE}.system_status` as const; +const ALERT_UUID = `${ALERT_NAMESPACE}.uuid` as const; +const ALERT_WORKFLOW_REASON = `${ALERT_NAMESPACE}.workflow_reason` as const; +const ALERT_WORKFLOW_STATUS = `${ALERT_NAMESPACE}.workflow_status` as const; +const ALERT_WORKFLOW_USER = `${ALERT_NAMESPACE}.workflow_user` as const; + +const ALERT_RULE_AUTHOR = `${ALERT_RULE_NAMESPACE}.author` as const; +const ALERT_RULE_CONSUMERS = `${ALERT_RULE_NAMESPACE}.consumers` as const; +const ALERT_RULE_CREATED_AT = `${ALERT_RULE_NAMESPACE}.created_at` as const; +const ALERT_RULE_CREATED_BY = `${ALERT_RULE_NAMESPACE}.created_by` as const; +const ALERT_RULE_DESCRIPTION = `${ALERT_RULE_NAMESPACE}.description` as const; +const ALERT_RULE_ENABLED = `${ALERT_RULE_NAMESPACE}.enabled` as const; +const ALERT_RULE_FROM = `${ALERT_RULE_NAMESPACE}.from` as const; +const ALERT_RULE_ID = `${ALERT_RULE_NAMESPACE}.id` as const; +const ALERT_RULE_INTERVAL = `${ALERT_RULE_NAMESPACE}.interval` as const; +const ALERT_RULE_LICENSE = `${ALERT_RULE_NAMESPACE}.license` as const; +const ALERT_RULE_NAME = `${ALERT_RULE_NAMESPACE}.name` as const; +const ALERT_RULE_NOTE = `${ALERT_RULE_NAMESPACE}.note` as const; +const ALERT_RULE_REFERENCES = `${ALERT_RULE_NAMESPACE}.references` as const; +const ALERT_RULE_RISK_SCORE = `${ALERT_RULE_NAMESPACE}.risk_score` as const; +const ALERT_RULE_RISK_SCORE_MAPPING = `${ALERT_RULE_NAMESPACE}.risk_score_mapping` as const; +const ALERT_RULE_RULE_ID = `${ALERT_RULE_NAMESPACE}.rule_id` as const; +const ALERT_RULE_RULE_NAME_OVERRIDE = `${ALERT_RULE_NAMESPACE}.rule_name_override` as const; +const ALERT_RULE_SEVERITY = `${ALERT_RULE_NAMESPACE}.severity` as const; +const ALERT_RULE_SEVERITY_MAPPING = `${ALERT_RULE_NAMESPACE}.severity_mapping` as const; +const ALERT_RULE_TAGS = `${ALERT_RULE_NAMESPACE}.tags` as const; +const ALERT_RULE_TO = `${ALERT_RULE_NAMESPACE}.to` as const; +const ALERT_RULE_TYPE = `${ALERT_RULE_NAMESPACE}.type` as const; +const ALERT_RULE_UPDATED_AT = `${ALERT_RULE_NAMESPACE}.updated_at` as const; +const ALERT_RULE_UPDATED_BY = `${ALERT_RULE_NAMESPACE}.updated_by` as const; +const ALERT_RULE_VERSION = `${ALERT_RULE_NAMESPACE}.version` as const; const fields = { - TIMESTAMP, + CONSUMERS, + ECS_VERSION, EVENT_KIND, EVENT_ACTION, - RULE_UUID, + RULE_CATEGORY, + RULE_CONSUMERS, RULE_ID, RULE_NAME, - RULE_CATEGORY, + RULE_UUID, TAGS, - PRODUCER, - OWNER, + TIMESTAMP, + ALERT_ACTION_GROUP, + ALERT_DURATION, + ALERT_END, + ALERT_EVALUATION_THRESHOLD, + ALERT_EVALUATION_VALUE, ALERT_ID, - ALERT_UUID, + ALERT_OWNER, + ALERT_PRODUCER, + ALERT_REASON, + ALERT_RISK_SCORE, + ALERT_RULE_AUTHOR, + ALERT_RULE_CONSUMERS, + ALERT_RULE_CREATED_AT, + ALERT_RULE_CREATED_BY, + ALERT_RULE_DESCRIPTION, + ALERT_RULE_ENABLED, + ALERT_RULE_FROM, + ALERT_RULE_ID, + ALERT_RULE_INTERVAL, + ALERT_RULE_LICENSE, + ALERT_RULE_NAME, + ALERT_RULE_NOTE, + ALERT_RULE_REFERENCES, + ALERT_RULE_RISK_SCORE, + ALERT_RULE_RISK_SCORE_MAPPING, + ALERT_RULE_RULE_ID, + ALERT_RULE_RULE_NAME_OVERRIDE, + ALERT_RULE_SEVERITY, + ALERT_RULE_SEVERITY_MAPPING, + ALERT_RULE_TAGS, + ALERT_RULE_TO, + ALERT_RULE_TYPE, + ALERT_RULE_UPDATED_AT, + ALERT_RULE_UPDATED_BY, + ALERT_RULE_VERSION, ALERT_START, - ALERT_END, - ALERT_DURATION, + ALERT_SEVERITY, ALERT_SEVERITY_LEVEL, ALERT_SEVERITY_VALUE, ALERT_STATUS, - ALERT_EVALUATION_THRESHOLD, - ALERT_EVALUATION_VALUE, - ALERT_REASON, + ALERT_SYSTEM_STATUS, + ALERT_UUID, + ALERT_WORKFLOW_REASON, + ALERT_WORKFLOW_STATUS, + ALERT_WORKFLOW_USER, SPACE_IDS, + VERSION, }; export { - TIMESTAMP, - EVENT_KIND, - EVENT_ACTION, - RULE_UUID, - RULE_ID, - RULE_NAME, - RULE_CATEGORY, - TAGS, - PRODUCER, - OWNER, - ALERT_ID, - ALERT_UUID, - ALERT_START, - ALERT_END, + ALERT_ACTION_GROUP, ALERT_DURATION, - ALERT_SEVERITY_LEVEL, - ALERT_SEVERITY_VALUE, - ALERT_STATUS, + ALERT_END, ALERT_EVALUATION_THRESHOLD, ALERT_EVALUATION_VALUE, + ALERT_ID, + ALERT_OWNER, + ALERT_PRODUCER, ALERT_REASON, + ALERT_RISK_SCORE, + ALERT_STATUS, + ALERT_WORKFLOW_REASON, + ALERT_WORKFLOW_STATUS, + ALERT_WORKFLOW_USER, + ALERT_RULE_AUTHOR, + ALERT_RULE_CONSUMERS, + ALERT_RULE_CREATED_AT, + ALERT_RULE_CREATED_BY, + ALERT_RULE_DESCRIPTION, + ALERT_RULE_ENABLED, + ALERT_RULE_FROM, + ALERT_RULE_ID, + ALERT_RULE_INTERVAL, + ALERT_RULE_LICENSE, + ALERT_RULE_NAME, + ALERT_RULE_NOTE, + ALERT_RULE_REFERENCES, + ALERT_RULE_RISK_SCORE, + ALERT_RULE_RISK_SCORE_MAPPING, + ALERT_RULE_RULE_ID, + ALERT_RULE_RULE_NAME_OVERRIDE, + ALERT_RULE_SEVERITY_MAPPING, + ALERT_RULE_TAGS, + ALERT_RULE_TO, + ALERT_RULE_TYPE, + ALERT_RULE_UPDATED_AT, + ALERT_RULE_UPDATED_BY, + ALERT_RULE_VERSION, + ALERT_RULE_SEVERITY, + ALERT_SEVERITY, + ALERT_SEVERITY_LEVEL, + ALERT_SEVERITY_VALUE, + ALERT_START, + ALERT_SYSTEM_STATUS, + ALERT_UUID, + CONSUMERS, + ECS_VERSION, + EVENT_ACTION, + EVENT_KIND, + RULE_CATEGORY, + RULE_CONSUMERS, + RULE_ID, + RULE_NAME, + RULE_UUID, + TAGS, + TIMESTAMP, SPACE_IDS, + VERSION, }; export type TechnicalRuleDataFieldName = ValuesType; diff --git a/x-pack/plugins/apm/public/components/shared/charts/helper/get_alert_annotations.test.tsx b/x-pack/plugins/apm/public/components/shared/charts/helper/get_alert_annotations.test.tsx index b2d2f360a5fd4..01a8293163106 100644 --- a/x-pack/plugins/apm/public/components/shared/charts/helper/get_alert_annotations.test.tsx +++ b/x-pack/plugins/apm/public/components/shared/charts/helper/get_alert_annotations.test.tsx @@ -5,7 +5,17 @@ * 2.0. */ -import { ALERT_SEVERITY_LEVEL } from '@kbn/rule-data-utils/target/technical_field_names'; +import { + ALERT_DURATION, + ALERT_EVALUATION_THRESHOLD, + ALERT_EVALUATION_VALUE, + ALERT_ID, + ALERT_PRODUCER, + ALERT_SEVERITY_LEVEL, + ALERT_START, + ALERT_STATUS, + ALERT_UUID, +} from '@kbn/rule-data-utils'; import { ValuesType } from 'utility-types'; import { EuiTheme } from '../../../../../../../../src/plugins/kibana_react/common'; import { ObservabilityRuleTypeRegistry } from '../../../../../../observability/public'; @@ -23,28 +33,26 @@ const theme = ({ } as unknown) as EuiTheme; const alert: Alert = { 'rule.id': ['apm.transaction_duration'], - 'kibana.rac.alert.evaluation.value': [2057657.39], + [ALERT_EVALUATION_VALUE]: [2057657.39], 'service.name': ['frontend-rum'], 'rule.name': ['Latency threshold | frontend-rum'], - 'kibana.rac.alert.duration.us': [62879000], - 'kibana.rac.alert.status': ['open'], + [ALERT_DURATION]: [62879000], + [ALERT_STATUS]: ['open'], tags: ['apm', 'service.name:frontend-rum'], 'transaction.type': ['page-load'], - 'kibana.rac.alert.producer': ['apm'], - 'kibana.rac.alert.uuid': ['af2ae371-df79-4fca-b0eb-a2dbd9478180'], + [ALERT_PRODUCER]: ['apm'], + [ALERT_UUID]: ['af2ae371-df79-4fca-b0eb-a2dbd9478180'], 'rule.uuid': ['82e0ee40-c2f4-11eb-9a42-a9da66a1722f'], 'event.action': ['active'], '@timestamp': ['2021-06-01T16:16:05.183Z'], - 'kibana.rac.alert.id': ['apm.transaction_duration_All'], + [ALERT_ID]: ['apm.transaction_duration_All'], 'processor.event': ['transaction'], - 'kibana.rac.alert.evaluation.threshold': [500000], - 'kibana.rac.alert.start': ['2021-06-01T16:15:02.304Z'], + [ALERT_EVALUATION_THRESHOLD]: [500000], + [ALERT_START]: ['2021-06-01T16:15:02.304Z'], 'event.kind': ['state'], 'rule.category': ['Latency threshold'], }; -const chartStartTime = new Date( - alert['kibana.rac.alert.start']![0] as string -).getTime(); +const chartStartTime = new Date(alert[ALERT_START]![0] as string).getTime(); const getFormatter: ObservabilityRuleTypeRegistry['getFormatter'] = () => () => ({ link: '/', reason: 'a good reason', diff --git a/x-pack/plugins/apm/public/components/shared/charts/latency_chart/latency_chart.stories.tsx b/x-pack/plugins/apm/public/components/shared/charts/latency_chart/latency_chart.stories.tsx index 1439e59877ea4..71d517ad53871 100644 --- a/x-pack/plugins/apm/public/components/shared/charts/latency_chart/latency_chart.stories.tsx +++ b/x-pack/plugins/apm/public/components/shared/charts/latency_chart/latency_chart.stories.tsx @@ -5,6 +5,16 @@ * 2.0. */ +import { + ALERT_DURATION, + ALERT_EVALUATION_THRESHOLD, + ALERT_EVALUATION_VALUE, + ALERT_ID, + ALERT_SEVERITY_LEVEL, + ALERT_START, + ALERT_STATUS, + ALERT_UUID, +} from '@kbn/rule-data-utils'; import { StoryContext } from '@storybook/react'; import React, { ComponentType } from 'react'; import { MemoryRouter, Route } from 'react-router-dom'; @@ -111,66 +121,66 @@ Example.args = { alerts: [ { 'rule.id': ['apm.transaction_duration'], - 'kibana.rac.alert.evaluation.value': [2001708.19], + [ALERT_EVALUATION_VALUE]: [2001708.19], 'service.name': ['frontend-rum'], 'rule.name': ['Latency threshold | frontend-rum'], - 'kibana.rac.alert.duration.us': [10000000000], - 'kibana.rac.alert.status': ['open'], + [ALERT_DURATION]: [10000000000], + [ALERT_STATUS]: ['open'], tags: ['apm', 'service.name:frontend-rum'], 'transaction.type': ['page-load'], - 'kibana.rac.alert.producer': ['apm'], - 'kibana.rac.alert.uuid': ['af2ae371-df79-4fca-b0eb-a2dbd9478180'], + 'kibana.alert.producer': ['apm'], + [ALERT_UUID]: ['af2ae371-df79-4fca-b0eb-a2dbd9478180'], 'rule.uuid': ['82e0ee40-c2f4-11eb-9a42-a9da66a1722f'], 'event.action': ['active'], '@timestamp': ['2021-06-01T20:27:48.833Z'], - 'kibana.rac.alert.id': ['apm.transaction_duration_All'], + [ALERT_ID]: ['apm.transaction_duration_All'], 'processor.event': ['transaction'], - 'kibana.rac.alert.evaluation.threshold': [500000], - 'kibana.rac.alert.start': ['2021-06-02T04:00:00.000Z'], + [ALERT_EVALUATION_THRESHOLD]: [500000], + [ALERT_START]: ['2021-06-02T04:00:00.000Z'], 'event.kind': ['state'], 'rule.category': ['Latency threshold'], }, { 'rule.id': ['apm.transaction_duration'], - 'kibana.rac.alert.evaluation.value': [2001708.19], + [ALERT_EVALUATION_VALUE]: [2001708.19], 'service.name': ['frontend-rum'], 'rule.name': ['Latency threshold | frontend-rum'], - 'kibana.rac.alert.duration.us': [10000000000], - 'kibana.rac.alert.status': ['open'], + [ALERT_DURATION]: [10000000000], + [ALERT_STATUS]: ['open'], tags: ['apm', 'service.name:frontend-rum'], 'transaction.type': ['page-load'], - 'kibana.rac.alert.producer': ['apm'], - 'kibana.rac.alert.severity.level': ['warning'], - 'kibana.rac.alert.uuid': ['af2ae371-df79-4fca-b0eb-a2dbd9478181'], + 'kibana.alert.producer': ['apm'], + [ALERT_SEVERITY_LEVEL]: ['warning'], + [ALERT_UUID]: ['af2ae371-df79-4fca-b0eb-a2dbd9478181'], 'rule.uuid': ['82e0ee40-c2f4-11eb-9a42-a9da66a1722f'], 'event.action': ['active'], '@timestamp': ['2021-06-01T20:27:48.833Z'], - 'kibana.rac.alert.id': ['apm.transaction_duration_All'], + [ALERT_ID]: ['apm.transaction_duration_All'], 'processor.event': ['transaction'], - 'kibana.rac.alert.evaluation.threshold': [500000], - 'kibana.rac.alert.start': ['2021-06-02T10:45:00.000Z'], + [ALERT_EVALUATION_THRESHOLD]: [500000], + [ALERT_START]: ['2021-06-02T10:45:00.000Z'], 'event.kind': ['state'], 'rule.category': ['Latency threshold'], }, { 'rule.id': ['apm.transaction_duration'], - 'kibana.rac.alert.evaluation.value': [2001708.19], + [ALERT_EVALUATION_VALUE]: [2001708.19], 'service.name': ['frontend-rum'], 'rule.name': ['Latency threshold | frontend-rum'], - 'kibana.rac.alert.duration.us': [1000000000], - 'kibana.rac.alert.status': ['open'], + [ALERT_DURATION]: [1000000000], + [ALERT_STATUS]: ['open'], tags: ['apm', 'service.name:frontend-rum'], 'transaction.type': ['page-load'], - 'kibana.rac.alert.producer': ['apm'], - 'kibana.rac.alert.severity.level': ['critical'], - 'kibana.rac.alert.uuid': ['af2ae371-df79-4fca-b0eb-a2dbd9478182'], + 'kibana.alert.producer': ['apm'], + [ALERT_SEVERITY_LEVEL]: ['critical'], + [ALERT_UUID]: ['af2ae371-df79-4fca-b0eb-a2dbd9478182'], 'rule.uuid': ['82e0ee40-c2f4-11eb-9a42-a9da66a1722f'], 'event.action': ['active'], '@timestamp': ['2021-06-01T20:27:48.833Z'], - 'kibana.rac.alert.id': ['apm.transaction_duration_All'], + [ALERT_ID]: ['apm.transaction_duration_All'], 'processor.event': ['transaction'], - 'kibana.rac.alert.evaluation.threshold': [500000], - 'kibana.rac.alert.start': ['2021-06-02T16:50:00.000Z'], + [ALERT_EVALUATION_THRESHOLD]: [500000], + [ALERT_START]: ['2021-06-02T16:50:00.000Z'], 'event.kind': ['state'], 'rule.category': ['Latency threshold'], }, diff --git a/x-pack/plugins/apm/server/plugin.ts b/x-pack/plugins/apm/server/plugin.ts index d28e43d9cb976..50dd09a6366e8 100644 --- a/x-pack/plugins/apm/server/plugin.ts +++ b/x-pack/plugins/apm/server/plugin.ts @@ -133,20 +133,23 @@ export class APMPlugin settings: { number_of_shards: 1, }, - mappings: mappingFromFieldMap({ - [SERVICE_NAME]: { - type: 'keyword', + mappings: mappingFromFieldMap( + { + [SERVICE_NAME]: { + type: 'keyword', + }, + [SERVICE_ENVIRONMENT]: { + type: 'keyword', + }, + [TRANSACTION_TYPE]: { + type: 'keyword', + }, + [PROCESSOR_EVENT]: { + type: 'keyword', + }, }, - [SERVICE_ENVIRONMENT]: { - type: 'keyword', - }, - [TRANSACTION_TYPE]: { - type: 'keyword', - }, - [PROCESSOR_EVENT]: { - type: 'keyword', - }, - }), + 'strict' + ), }, }, }); diff --git a/x-pack/plugins/observability/public/pages/alerts/alerts_flyout/alerts_flyout.stories.tsx b/x-pack/plugins/observability/public/pages/alerts/alerts_flyout/alerts_flyout.stories.tsx index 8aae408b1f94b..a752b8d89a1bd 100644 --- a/x-pack/plugins/observability/public/pages/alerts/alerts_flyout/alerts_flyout.stories.tsx +++ b/x-pack/plugins/observability/public/pages/alerts/alerts_flyout/alerts_flyout.stories.tsx @@ -5,7 +5,7 @@ * 2.0. */ -import { ALERT_UUID } from '@kbn/rule-data-utils/target/technical_field_names'; +import { ALERT_UUID } from '@kbn/rule-data-utils'; import React, { ComponentType } from 'react'; import type { TopAlertResponse } from '../'; import { KibanaContextProvider } from '../../../../../../../src/plugins/kibana_react/public'; @@ -57,7 +57,7 @@ export default { }; export function Example({ alerts }: Args) { - const selectedAlertId = apmAlertResponseExample[0][ALERT_UUID][0]; + const selectedAlertId = apmAlertResponseExample[0]![ALERT_UUID]![0]; const observabilityRuleTypeRegistry = createObservabilityRuleTypeRegistryMock(); return ( \>, ``"kibana.rac.alert.owner"`` \| ``"rule.id"``\> & { `kibana.rac.alert.owner`: `string` ; `rule.id`: `string` } & { `_version`: `undefined` \| `string` }\> +▸ `Private` **fetchAlert**(`__namedParameters`): `Promise`\>, ``"kibana.alert.owner"`` \| ``"rule.id"``\> & { `kibana.alert.owner`: `string` ; `rule.id`: `string` } & { `_version`: `undefined` \| `string` }\> #### Parameters @@ -108,7 +108,7 @@ ___ #### Returns -`Promise`\>, ``"kibana.rac.alert.owner"`` \| ``"rule.id"``\> & { `kibana.rac.alert.owner`: `string` ; `rule.id`: `string` } & { `_version`: `undefined` \| `string` }\> +`Promise`\>, ``"kibana.alert.owner"`` \| ``"rule.id"``\> & { `kibana.alert.owner`: `string` ; `rule.id`: `string` } & { `_version`: `undefined` \| `string` }\> #### Defined in diff --git a/x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts b/x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts index 598818a7a69c3..91282edf3778a 100644 --- a/x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts +++ b/x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts @@ -24,7 +24,7 @@ import { alertAuditEvent, AlertAuditAction } from './audit_events'; import { AuditLogger } from '../../../security/server'; import { ALERT_STATUS, - OWNER, + ALERT_OWNER, RULE_ID, SPACE_IDS, } from '../../common/technical_rule_data_field_names'; @@ -33,10 +33,10 @@ import { ParsedTechnicalFields } from '../../common/parse_technical_fields'; // TODO: Fix typings https://github.com/elastic/kibana/issues/101776 type NonNullableProps = Omit & { [K in Props]-?: NonNullable }; -type AlertType = NonNullableProps; +type AlertType = NonNullableProps; const isValidAlert = (source?: ParsedTechnicalFields): source is AlertType => { - return source?.[RULE_ID] != null && source?.[OWNER] != null; + return source?.[RULE_ID] != null && source?.[ALERT_OWNER] != null; }; export interface ConstructorOptions { logger: Logger; @@ -156,7 +156,7 @@ export class AlertsClient { // client exposed to us for reuse await this.authorization.ensureAuthorized({ ruleTypeId: alert[RULE_ID], - consumer: alert[OWNER], + consumer: alert[ALERT_OWNER], operation: ReadOperations.Get, entity: AlertingAuthorizationEntity.Alert, }); @@ -200,7 +200,7 @@ export class AlertsClient { await this.authorization.ensureAuthorized({ ruleTypeId: alert[RULE_ID], - consumer: alert[OWNER], + consumer: alert[ALERT_OWNER], operation: WriteOperations.Update, entity: AlertingAuthorizationEntity.Alert, }); diff --git a/x-pack/plugins/rule_registry/server/alert_data_client/tests/get.test.ts b/x-pack/plugins/rule_registry/server/alert_data_client/tests/get.test.ts index 518b75637cf34..51789a09234e2 100644 --- a/x-pack/plugins/rule_registry/server/alert_data_client/tests/get.test.ts +++ b/x-pack/plugins/rule_registry/server/alert_data_client/tests/get.test.ts @@ -5,6 +5,7 @@ * 2.0. */ +import { ALERT_OWNER, ALERT_STATUS, SPACE_IDS } from '@kbn/rule-data-utils'; import { AlertsClient, ConstructorOptions } from '../alerts_client'; import { loggingSystemMock } from '../../../../../../src/core/server/mocks'; // eslint-disable-next-line @kbn/eslint/no-restricted-paths @@ -59,9 +60,9 @@ describe('get()', () => { _source: { 'rule.id': 'apm.error_rate', message: 'hello world 1', - 'kibana.rac.alert.owner': 'apm', - 'kibana.rac.alert.status': 'open', - 'kibana.rac.alert.space_ids': ['test_default_space_id'], + [ALERT_OWNER]: 'apm', + [ALERT_STATUS]: 'open', + [SPACE_IDS]: ['test_default_space_id'], }, }, ], @@ -73,11 +74,11 @@ describe('get()', () => { expect(result).toMatchInlineSnapshot(` Object { "_version": "WzM2MiwyXQ==", - "kibana.rac.alert.owner": "apm", - "kibana.rac.alert.space_ids": Array [ + "${ALERT_OWNER}": "apm", + "${ALERT_STATUS}": "open", + "${SPACE_IDS}": Array [ "test_default_space_id", ], - "kibana.rac.alert.status": "open", "message": "hello world 1", "rule.id": "apm.error_rate", } @@ -140,9 +141,9 @@ describe('get()', () => { _source: { 'rule.id': 'apm.error_rate', message: 'hello world 1', - 'kibana.rac.alert.owner': 'apm', - 'kibana.rac.alert.status': 'open', - 'kibana.rac.alert.space_ids': ['test_default_space_id'], + [ALERT_OWNER]: 'apm', + [ALERT_STATUS]: 'open', + [SPACE_IDS]: ['test_default_space_id'], }, }, ], @@ -202,9 +203,9 @@ describe('get()', () => { _source: { 'rule.id': 'apm.error_rate', message: 'hello world 1', - 'kibana.rac.alert.owner': 'apm', - 'kibana.rac.alert.status': 'open', - 'kibana.rac.alert.space_ids': ['test_default_space_id'], + [ALERT_OWNER]: 'apm', + [ALERT_STATUS]: 'open', + [SPACE_IDS]: ['test_default_space_id'], }, }, ], @@ -227,11 +228,11 @@ describe('get()', () => { expect(result).toMatchInlineSnapshot(` Object { "_version": "WzM2MiwyXQ==", - "kibana.rac.alert.owner": "apm", - "kibana.rac.alert.space_ids": Array [ + "${ALERT_OWNER}": "apm", + "${ALERT_STATUS}": "open", + "${SPACE_IDS}": Array [ "test_default_space_id", ], - "kibana.rac.alert.status": "open", "message": "hello world 1", "rule.id": "apm.error_rate", } diff --git a/x-pack/plugins/rule_registry/server/alert_data_client/tests/update.test.ts b/x-pack/plugins/rule_registry/server/alert_data_client/tests/update.test.ts index e24bae96975df..47a86c718d8de 100644 --- a/x-pack/plugins/rule_registry/server/alert_data_client/tests/update.test.ts +++ b/x-pack/plugins/rule_registry/server/alert_data_client/tests/update.test.ts @@ -5,6 +5,7 @@ * 2.0. */ +import { ALERT_OWNER, ALERT_STATUS, SPACE_IDS } from '@kbn/rule-data-utils'; import { AlertsClient, ConstructorOptions } from '../alerts_client'; import { loggingSystemMock } from '../../../../../../src/core/server/mocks'; // eslint-disable-next-line @kbn/eslint/no-restricted-paths @@ -56,9 +57,9 @@ describe('update()', () => { _source: { 'rule.id': 'apm.error_rate', message: 'hello world 1', - 'kibana.rac.alert.owner': 'apm', - 'kibana.rac.alert.status': 'open', - 'kibana.rac.alert.space_ids': ['test_default_space_id'], + [ALERT_OWNER]: 'apm', + [ALERT_STATUS]: 'open', + [SPACE_IDS]: ['test_default_space_id'], }, }, ], @@ -106,7 +107,7 @@ describe('update()', () => { Object { "body": Object { "doc": Object { - "kibana.rac.alert.status": "closed", + "${ALERT_STATUS}": "closed", }, }, "id": "1", @@ -142,9 +143,9 @@ describe('update()', () => { _source: { 'rule.id': 'apm.error_rate', message: 'hello world 1', - 'kibana.rac.alert.owner': 'apm', - 'kibana.rac.alert.status': 'open', - 'kibana.rac.alert.space_ids': ['test_default_space_id'], + [ALERT_OWNER]: 'apm', + [ALERT_STATUS]: 'open', + [SPACE_IDS]: ['test_default_space_id'], }, }, ], @@ -235,9 +236,9 @@ describe('update()', () => { _source: { 'rule.id': 'apm.error_rate', message: 'hello world 1', - 'kibana.rac.alert.owner': 'apm', - 'kibana.rac.alert.status': 'open', - 'kibana.rac.alert.space_ids': ['test_default_space_id'], + [ALERT_OWNER]: 'apm', + [ALERT_STATUS]: 'open', + [SPACE_IDS]: ['test_default_space_id'], }, }, ], @@ -295,9 +296,9 @@ describe('update()', () => { _source: { 'rule.id': 'apm.error_rate', message: 'hello world 1', - 'kibana.rac.alert.owner': 'apm', - 'kibana.rac.alert.status': 'open', - 'kibana.rac.alert.space_ids': ['test_default_space_id'], + [ALERT_OWNER]: 'apm', + [ALERT_STATUS]: 'open', + [SPACE_IDS]: ['test_default_space_id'], }, }, ], diff --git a/x-pack/plugins/rule_registry/server/event_log/event_schema/schema.ts b/x-pack/plugins/rule_registry/server/event_log/event_schema/schema.ts index 9b5d94918a83f..6ab82e7027efc 100644 --- a/x-pack/plugins/rule_registry/server/event_log/event_schema/schema.ts +++ b/x-pack/plugins/rule_registry/server/event_log/event_schema/schema.ts @@ -8,7 +8,7 @@ import { EventSchema, Event } from './schema_types'; import { FieldMap, runtimeTypeFromFieldMap, mergeFieldMaps } from '../../../common/field_map'; import { - TechnicalRuleFieldMaps, + TechnicalRuleFieldMap, technicalRuleFieldMap, } from '../../../common/assets/field_maps/technical_rule_field_map'; @@ -27,13 +27,13 @@ export abstract class Schema { return createSchema(combinedFields); } - public static getBase(): EventSchema { + public static getBase(): EventSchema { return baseSchema; } public static extendBase( fields: TMap - ): EventSchema { + ): EventSchema { const extensionSchema = createSchema(fields); return this.combine(baseSchema, extensionSchema); } diff --git a/x-pack/plugins/rule_registry/server/event_log/log/event_log_resolver.ts b/x-pack/plugins/rule_registry/server/event_log/log/event_log_resolver.ts index 8440f55432304..6f1d4aba9f6e5 100644 --- a/x-pack/plugins/rule_registry/server/event_log/log/event_log_resolver.ts +++ b/x-pack/plugins/rule_registry/server/event_log/log/event_log_resolver.ts @@ -92,7 +92,7 @@ export class EventLogResolver implements IEventLogResolver { kibanaSpaceId, }); - const indexMappings = mappingFromFieldMap(eventSchema.objectFields); + const indexMappings = mappingFromFieldMap(eventSchema.objectFields, 'strict'); return { indexNames, indexMappings, ilmPolicy }; } diff --git a/x-pack/plugins/rule_registry/server/event_log/log/event_logger_template.ts b/x-pack/plugins/rule_registry/server/event_log/log/event_logger_template.ts index 3872a5c744269..57d2dabb47bfa 100644 --- a/x-pack/plugins/rule_registry/server/event_log/log/event_logger_template.ts +++ b/x-pack/plugins/rule_registry/server/event_log/log/event_logger_template.ts @@ -42,8 +42,8 @@ export class EventLoggerTemplate implements IEventLoggerTemplate const nextFields = mergeFields(baseFields, extFields, { // TODO: Define a schema for own fields used/set by event log. Add it to the base schema. // Then maybe introduce a base type for TEvent. - 'kibana.rac.event_log.log_name': indexNames.logName, - 'kibana.rac.event_log.logger_name': nextName, + 'kibana.event_log.log_name': indexNames.logName, + 'kibana.event_log.logger_name': nextName, } as any); return { diff --git a/x-pack/plugins/rule_registry/server/event_log/log/event_query_builder.ts b/x-pack/plugins/rule_registry/server/event_log/log/event_query_builder.ts index bf9aca74f7800..9fafaa8ed1b76 100644 --- a/x-pack/plugins/rule_registry/server/event_log/log/event_query_builder.ts +++ b/x-pack/plugins/rule_registry/server/event_log/log/event_query_builder.ts @@ -83,7 +83,7 @@ export class EventQueryBuilder implements IEventQueryBuilder { if (this.loggerName) { result.push({ - term: { 'kibana.rac.event_log.logger_name': this.loggerName }, + term: { 'kibana.event_log.logger_name': this.loggerName }, }); } diff --git a/x-pack/plugins/rule_registry/server/event_log/log/utils/mapping_from_field_map.ts b/x-pack/plugins/rule_registry/server/event_log/log/utils/mapping_from_field_map.ts index fd5dc3ae02288..02c759cc328d2 100644 --- a/x-pack/plugins/rule_registry/server/event_log/log/utils/mapping_from_field_map.ts +++ b/x-pack/plugins/rule_registry/server/event_log/log/utils/mapping_from_field_map.ts @@ -9,9 +9,12 @@ import { set } from '@elastic/safer-lodash-set'; import { FieldMap } from '../../../../common/field_map'; import { IndexMappings } from '../../elasticsearch'; -export function mappingFromFieldMap(fieldMap: FieldMap): IndexMappings { +export function mappingFromFieldMap( + fieldMap: FieldMap, + dynamic: 'strict' | boolean +): IndexMappings { const mappings = { - dynamic: 'strict' as const, + dynamic, properties: {}, }; diff --git a/x-pack/plugins/rule_registry/server/index.ts b/x-pack/plugins/rule_registry/server/index.ts index e6656420af05d..af086abadbb72 100644 --- a/x-pack/plugins/rule_registry/server/index.ts +++ b/x-pack/plugins/rule_registry/server/index.ts @@ -14,18 +14,17 @@ export type { RacRequestHandlerContext, RacApiRequestHandlerContext } from './ty export { RuleDataClient } from './rule_data_client'; export { IRuleDataClient } from './rule_data_client/types'; export { getRuleData, RuleExecutorData } from './utils/get_rule_executor_data'; -export { - createLifecycleRuleTypeFactory, - LifecycleAlertService, -} from './utils/create_lifecycle_rule_type_factory'; +export { createLifecycleRuleTypeFactory } from './utils/create_lifecycle_rule_type_factory'; export { RuleDataPluginService } from './rule_data_plugin_service'; export { LifecycleRuleExecutor, + LifecycleAlertService, LifecycleAlertServices, createLifecycleExecutor, } from './utils/create_lifecycle_executor'; export { createPersistenceRuleTypeFactory } from './utils/create_persistence_rule_type_factory'; -export { AlertTypeWithExecutor } from './types'; +export * from './utils/persistence_types'; +export type { AlertTypeWithExecutor } from './types'; export const plugin = (initContext: PluginInitializerContext) => new RuleRegistryPlugin(initContext); diff --git a/x-pack/plugins/rule_registry/server/routes/get_alert_by_id.test.ts b/x-pack/plugins/rule_registry/server/routes/get_alert_by_id.test.ts index 0de1e6c585a17..d89eb305545e8 100644 --- a/x-pack/plugins/rule_registry/server/routes/get_alert_by_id.test.ts +++ b/x-pack/plugins/rule_registry/server/routes/get_alert_by_id.test.ts @@ -5,6 +5,18 @@ * 2.0. */ +import { + ALERT_OWNER, + ALERT_RULE_RISK_SCORE, + ALERT_RULE_SEVERITY, + ALERT_STATUS, + CONSUMERS, + ECS_VERSION, + RULE_ID, + TIMESTAMP, + VERSION, +} from '@kbn/rule-data-utils'; + import { BASE_RAC_ALERTS_API_PATH } from '../../common/constants'; import { ParsedTechnicalFields } from '../../common/parse_technical_fields'; import { getAlertByIdRoute } from './get_alert_by_id'; @@ -13,10 +25,15 @@ import { getReadRequest } from './__mocks__/request_responses'; import { requestMock, serverMock } from './__mocks__/server'; const getMockAlert = (): ParsedTechnicalFields => ({ - '@timestamp': '2021-06-21T21:33:05.713Z', - 'rule.id': 'apm.error_rate', - 'kibana.rac.alert.owner': 'apm', - 'kibana.rac.alert.status': 'open', + [TIMESTAMP]: '2021-06-21T21:33:05.713Z', + [ECS_VERSION]: '1.0.0', + [CONSUMERS]: [], + [VERSION]: '7.13.0', + [RULE_ID]: 'apm.error_rate', + [ALERT_OWNER]: 'apm', + [ALERT_STATUS]: 'open', + [ALERT_RULE_RISK_SCORE]: 20, + [ALERT_RULE_SEVERITY]: 'warning', }); describe('getAlertByIdRoute', () => { diff --git a/x-pack/plugins/rule_registry/server/types.ts b/x-pack/plugins/rule_registry/server/types.ts index 4b63acd5b01ab..c524a5412e13d 100644 --- a/x-pack/plugins/rule_registry/server/types.ts +++ b/x-pack/plugins/rule_registry/server/types.ts @@ -16,45 +16,32 @@ import { AlertExecutorOptions, AlertServices, AlertType } from '../../alerting/s import { AlertsClient } from './alert_data_client/alerts_client'; type SimpleAlertType< + TState extends AlertTypeState, TParams extends AlertTypeParams = {}, TAlertInstanceContext extends AlertInstanceContext = {} -> = AlertType< - TParams, - TParams, - AlertTypeState, - AlertInstanceState, - TAlertInstanceContext, - string, - string ->; +> = AlertType; export type AlertTypeExecutor< + TState extends AlertTypeState, TParams extends AlertTypeParams = {}, TAlertInstanceContext extends AlertInstanceContext = {}, TServices extends Record = {} > = ( - options: Parameters['executor']>[0] & { + options: Parameters['executor']>[0] & { services: TServices; } -) => Promise; +) => Promise; export type AlertTypeWithExecutor< + TState extends AlertTypeState = {}, TParams extends AlertTypeParams = {}, TAlertInstanceContext extends AlertInstanceContext = {}, TServices extends Record = {} > = Omit< - AlertType< - TParams, - TParams, - AlertTypeState, - AlertInstanceState, - TAlertInstanceContext, - string, - string - >, + AlertType, 'executor' > & { - executor: AlertTypeExecutor; + executor: AlertTypeExecutor; }; export type AlertExecutorOptionsWithExtraServices< diff --git a/x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.test.ts b/x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.test.ts index a036f42739998..80b75b8c74732 100644 --- a/x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.test.ts +++ b/x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.test.ts @@ -349,7 +349,7 @@ const createDefaultAlertExecutorOptions = < actions: [], enabled: true, consumer: 'CONSUMER', - producer: 'PRODUCER', + producer: 'ALERT_PRODUCER', schedule: { interval: '1m' }, throttle: null, createdAt, diff --git a/x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.ts b/x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.ts index 046b5bdddf6d8..50ac8afb945b4 100644 --- a/x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.ts +++ b/x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.ts @@ -29,7 +29,7 @@ import { ALERT_UUID, EVENT_ACTION, EVENT_KIND, - OWNER, + ALERT_OWNER, RULE_UUID, TIMESTAMP, SPACE_IDS, @@ -38,7 +38,7 @@ import { RuleDataClient } from '../rule_data_client'; import { AlertExecutorOptionsWithExtraServices } from '../types'; import { getRuleData } from './get_rule_executor_data'; -type LifecycleAlertService< +export type LifecycleAlertService< InstanceState extends AlertInstanceState = never, InstanceContext extends AlertInstanceContext = never, ActionGroupIds extends string = never @@ -242,9 +242,9 @@ export const createLifecycleExecutor = ( ...ruleExecutorData, [TIMESTAMP]: timestamp, [EVENT_KIND]: 'signal', - [OWNER]: rule.consumer, + [ALERT_OWNER]: rule.consumer, [ALERT_ID]: alertId, - }; + } as ParsedTechnicalFields; const isNew = !state.trackedAlerts[alertId]; const isRecovered = !currentAlerts[alertId]; diff --git a/x-pack/plugins/rule_registry/server/utils/create_lifecycle_rule_type.test.ts b/x-pack/plugins/rule_registry/server/utils/create_lifecycle_rule_type.test.ts index 11bb48a7440a7..c1358da97e95a 100644 --- a/x-pack/plugins/rule_registry/server/utils/create_lifecycle_rule_type.test.ts +++ b/x-pack/plugins/rule_registry/server/utils/create_lifecycle_rule_type.test.ts @@ -6,6 +6,15 @@ */ import { schema } from '@kbn/config-schema'; +import { + ALERT_DURATION, + ALERT_ID, + ALERT_OWNER, + ALERT_PRODUCER, + ALERT_START, + ALERT_STATUS, + ALERT_UUID, +} from '@kbn/rule-data-utils'; import { loggerMock } from '@kbn/logging/target/mocks'; import { castArray, omit, mapValues } from 'lodash'; import { RuleDataClient } from '../rule_data_client'; @@ -73,7 +82,7 @@ function createRule() { scheduleActions.mockClear(); - state = await type.executor({ + state = ((await type.executor({ alertId: 'alertId', createdBy: 'createdBy', name: 'name', @@ -109,7 +118,7 @@ function createRule() { tags: ['tags'], updatedBy: 'updatedBy', namespace: 'namespace', - }); + })) ?? {}) as Record; previousStartedAt = startedAt; }, @@ -176,28 +185,24 @@ describe('createLifecycleRuleTypeFactory', () => { expect(evaluationDocuments.length).toBe(0); expect(alertDocuments.length).toBe(2); - expect( - alertDocuments.every((doc) => doc['kibana.rac.alert.status'] === 'open') - ).toBeTruthy(); + expect(alertDocuments.every((doc) => doc[ALERT_STATUS] === 'open')).toBeTruthy(); - expect( - alertDocuments.every((doc) => doc['kibana.rac.alert.duration.us'] === 0) - ).toBeTruthy(); + expect(alertDocuments.every((doc) => doc[ALERT_DURATION] === 0)).toBeTruthy(); expect(alertDocuments.every((doc) => doc['event.action'] === 'open')).toBeTruthy(); - expect(documents.map((doc) => omit(doc, 'kibana.rac.alert.uuid'))).toMatchInlineSnapshot(` + expect(documents.map((doc) => omit(doc, ALERT_UUID))).toMatchInlineSnapshot(` Array [ Object { "@timestamp": "2021-06-16T09:01:00.000Z", "event.action": "open", "event.kind": "signal", - "kibana.rac.alert.duration.us": 0, - "kibana.rac.alert.id": "opbeans-java", - "kibana.rac.alert.owner": "consumer", - "kibana.rac.alert.producer": "producer", - "kibana.rac.alert.start": "2021-06-16T09:01:00.000Z", - "kibana.rac.alert.status": "open", + "${ALERT_DURATION}": 0, + "${ALERT_ID}": "opbeans-java", + "${ALERT_OWNER}": "consumer", + "${ALERT_PRODUCER}": "producer", + "${ALERT_START}": "2021-06-16T09:01:00.000Z", + "${ALERT_STATUS}": "open", "kibana.space_ids": Array [ "spaceId", ], @@ -214,12 +219,12 @@ describe('createLifecycleRuleTypeFactory', () => { "@timestamp": "2021-06-16T09:01:00.000Z", "event.action": "open", "event.kind": "signal", - "kibana.rac.alert.duration.us": 0, - "kibana.rac.alert.id": "opbeans-node", - "kibana.rac.alert.owner": "consumer", - "kibana.rac.alert.producer": "producer", - "kibana.rac.alert.start": "2021-06-16T09:01:00.000Z", - "kibana.rac.alert.status": "open", + "${ALERT_DURATION}": 0, + "${ALERT_ID}": "opbeans-node", + "${ALERT_OWNER}": "consumer", + "${ALERT_PRODUCER}": "producer", + "${ALERT_START}": "2021-06-16T09:01:00.000Z", + "${ALERT_STATUS}": "open", "kibana.space_ids": Array [ "spaceId", ], @@ -283,12 +288,10 @@ describe('createLifecycleRuleTypeFactory', () => { expect(evaluationDocuments.length).toBe(0); expect(alertDocuments.length).toBe(2); - expect( - alertDocuments.every((doc) => doc['kibana.rac.alert.status'] === 'open') - ).toBeTruthy(); + expect(alertDocuments.every((doc) => doc[ALERT_STATUS] === 'open')).toBeTruthy(); expect(alertDocuments.every((doc) => doc['event.action'] === 'active')).toBeTruthy(); - expect(alertDocuments.every((doc) => doc['kibana.rac.alert.duration.us'] > 0)).toBeTruthy(); + expect(alertDocuments.every((doc) => doc[ALERT_DURATION] > 0)).toBeTruthy(); }); }); @@ -363,10 +366,10 @@ describe('createLifecycleRuleTypeFactory', () => { ); expect(opbeansJavaAlertDoc['event.action']).toBe('active'); - expect(opbeansJavaAlertDoc['kibana.rac.alert.status']).toBe('open'); + expect(opbeansJavaAlertDoc[ALERT_STATUS]).toBe('open'); expect(opbeansNodeAlertDoc['event.action']).toBe('close'); - expect(opbeansNodeAlertDoc['kibana.rac.alert.status']).toBe('closed'); + expect(opbeansNodeAlertDoc[ALERT_STATUS]).toBe('closed'); }); }); }); diff --git a/x-pack/plugins/rule_registry/server/utils/create_lifecycle_rule_type_factory.ts b/x-pack/plugins/rule_registry/server/utils/create_lifecycle_rule_type_factory.ts index 783077a1f68ab..21e95fbefe4e2 100644 --- a/x-pack/plugins/rule_registry/server/utils/create_lifecycle_rule_type_factory.ts +++ b/x-pack/plugins/rule_registry/server/utils/create_lifecycle_rule_type_factory.ts @@ -12,31 +12,24 @@ import { AlertTypeParams, AlertTypeState, } from '../../../alerting/common'; -import { AlertInstance } from '../../../alerting/server'; import { AlertTypeWithExecutor } from '../types'; -import { createLifecycleExecutor } from './create_lifecycle_executor'; - -export type LifecycleAlertService< - TAlertInstanceContext extends Record, - TActionGroupIds extends string = string -> = (alert: { - id: string; - fields: Record; -}) => AlertInstance; +import { LifecycleAlertService, createLifecycleExecutor } from './create_lifecycle_executor'; export const createLifecycleRuleTypeFactory = ({ logger, ruleDataClient, }: { - ruleDataClient: RuleDataClient; logger: Logger; + ruleDataClient: RuleDataClient; }) => < TParams extends AlertTypeParams, TAlertInstanceContext extends AlertInstanceContext, - TServices extends { alertWithLifecycle: LifecycleAlertService } + TServices extends { + alertWithLifecycle: LifecycleAlertService, TAlertInstanceContext, string>; + } >( - type: AlertTypeWithExecutor -): AlertTypeWithExecutor => { + type: AlertTypeWithExecutor, TParams, TAlertInstanceContext, TServices> +): AlertTypeWithExecutor, TParams, TAlertInstanceContext, any> => { const createBoundLifecycleExecutor = createLifecycleExecutor(logger, ruleDataClient); const executor = createBoundLifecycleExecutor< TParams, diff --git a/x-pack/plugins/rule_registry/server/utils/create_persistence_rule_type_factory.ts b/x-pack/plugins/rule_registry/server/utils/create_persistence_rule_type_factory.ts index 9f4a6ce2e022c..50e5b224f01d8 100644 --- a/x-pack/plugins/rule_registry/server/utils/create_persistence_rule_type_factory.ts +++ b/x-pack/plugins/rule_registry/server/utils/create_persistence_rule_type_factory.ts @@ -4,40 +4,9 @@ * 2.0; you may not use this file except in compliance with the Elastic License * 2.0. */ -import { ESSearchRequest } from 'src/core/types/elasticsearch'; -import v4 from 'uuid/v4'; -import { Logger } from '@kbn/logging'; -import { AlertInstance } from '../../../alerting/server'; -import { - AlertInstanceContext, - AlertInstanceState, - AlertTypeParams, -} from '../../../alerting/common'; -import { RuleDataClient } from '../rule_data_client'; -import { AlertTypeWithExecutor } from '../types'; - -type PersistenceAlertService> = ( - alerts: Array> -) => Array>; - -type PersistenceAlertQueryService = ( - query: ESSearchRequest -) => Promise>>; - -type CreatePersistenceRuleTypeFactory = (options: { - ruleDataClient: RuleDataClient; - logger: Logger; -}) => < - TParams extends AlertTypeParams, - TAlertInstanceContext extends AlertInstanceContext, - TServices extends { - alertWithPersistence: PersistenceAlertService; - findAlerts: PersistenceAlertQueryService; - } ->( - type: AlertTypeWithExecutor -) => AlertTypeWithExecutor; +import { ALERT_ID } from '@kbn/rule-data-utils/target/technical_field_names'; +import { CreatePersistenceRuleTypeFactory } from './persistence_types'; export const createPersistenceRuleTypeFactory: CreatePersistenceRuleTypeFactory = ({ logger, @@ -46,66 +15,33 @@ export const createPersistenceRuleTypeFactory: CreatePersistenceRuleTypeFactory return { ...type, executor: async (options) => { - const { - services: { alertInstanceFactory, scopedClusterClient }, - } = options; - - const currentAlerts: Array> = []; - const timestamp = options.startedAt.toISOString(); - const state = await type.executor({ ...options, services: { ...options.services, - alertWithPersistence: (alerts) => { - alerts.forEach((alert) => currentAlerts.push(alert)); - return alerts.map((alert) => - alertInstanceFactory(alert['kibana.rac.alert.uuid']! as string) - ); - }, - findAlerts: async (query) => { - const { body } = await scopedClusterClient.asCurrentUser.search({ - ...query, - body: { - ...query.body, - }, - ignore_unavailable: true, - }); - return body.hits.hits - .map((event: { _source: any }) => event._source!) - .map((event: { [x: string]: any }) => { - const alertUuid = event['kibana.rac.alert.uuid']; - const isAlert = alertUuid != null; - return { - ...event, - 'event.kind': 'signal', - 'kibana.rac.alert.id': '???', - 'kibana.rac.alert.status': 'open', - 'kibana.rac.alert.uuid': v4(), - 'kibana.rac.alert.ancestors': isAlert - ? ((event['kibana.rac.alert.ancestors'] as string[]) ?? []).concat([ - alertUuid!, - ] as string[]) - : [], - 'kibana.rac.alert.depth': isAlert - ? ((event['kibana.rac.alert.depth'] as number) ?? 0) + 1 - : 0, - '@timestamp': timestamp, - }; + alertWithPersistence: async (alerts, refresh) => { + const numAlerts = alerts.length; + logger.debug(`Found ${numAlerts} alerts.`); + + if (ruleDataClient.isWriteEnabled() && numAlerts) { + const response = await ruleDataClient.getWriter().bulk({ + body: alerts.flatMap((event) => [ + { index: {} }, + { + [ALERT_ID]: event.id, + ...event.fields, + }, + ]), + refresh, }); + return response; + } else { + logger.debug('Writing is disabled.'); + } }, }, }); - const numAlerts = currentAlerts.length; - logger.debug(`Found ${numAlerts} alerts.`); - - if (ruleDataClient.isWriteEnabled() && numAlerts) { - await ruleDataClient.getWriter().bulk({ - body: currentAlerts.flatMap((event) => [{ index: {} }, event]), - }); - } - return state; }, }; diff --git a/x-pack/plugins/rule_registry/server/utils/get_rule_executor_data.ts b/x-pack/plugins/rule_registry/server/utils/get_rule_executor_data.ts index 144c0dafa3786..866eb5f882fe0 100644 --- a/x-pack/plugins/rule_registry/server/utils/get_rule_executor_data.ts +++ b/x-pack/plugins/rule_registry/server/utils/get_rule_executor_data.ts @@ -7,7 +7,7 @@ import { AlertExecutorOptions } from '../../../alerting/server'; import { - PRODUCER, + ALERT_PRODUCER, RULE_CATEGORY, RULE_ID, RULE_NAME, @@ -20,7 +20,7 @@ export interface RuleExecutorData { [RULE_ID]: string; [RULE_UUID]: string; [RULE_NAME]: string; - [PRODUCER]: string; + [ALERT_PRODUCER]: string; [TAGS]: string[]; } @@ -31,6 +31,6 @@ export function getRuleData(options: AlertExecutorOptions = ( + alerts: Array<{ + id: string; + fields: Record; + }>, + refresh: boolean | 'wait_for' +) => Promise>; + +export type PersistenceAlertQueryService = ( + query: ESSearchRequest +) => Promise>>; +export interface PersistenceServices { + alertWithPersistence: PersistenceAlertService; +} + +export type CreatePersistenceRuleTypeFactory = (options: { + ruleDataClient: RuleDataClient; + logger: Logger; +}) => < + TState extends AlertTypeState, + TParams extends AlertTypeParams, + TServices extends PersistenceServices, + TAlertInstanceContext extends AlertInstanceContext = {} +>( + type: AlertTypeWithExecutor +) => AlertTypeWithExecutor; diff --git a/x-pack/plugins/rule_registry/server/utils/with_rule_data_client_factory.ts b/x-pack/plugins/rule_registry/server/utils/with_rule_data_client_factory.ts index 02ff6b10f74cf..7943c3ad4f35a 100644 --- a/x-pack/plugins/rule_registry/server/utils/with_rule_data_client_factory.ts +++ b/x-pack/plugins/rule_registry/server/utils/with_rule_data_client_factory.ts @@ -5,21 +5,24 @@ * 2.0. */ -import { AlertInstanceContext, AlertTypeParams } from '../../../alerting/common'; +import { AlertInstanceContext, AlertTypeParams, AlertTypeState } from '../../../alerting/common'; import { RuleDataClient } from '../rule_data_client'; import { AlertTypeWithExecutor } from '../types'; export const withRuleDataClientFactory = (ruleDataClient: RuleDataClient) => < + TState extends AlertTypeState, TParams extends AlertTypeParams, TAlertInstanceContext extends AlertInstanceContext, TServices extends Record = {} >( type: AlertTypeWithExecutor< + TState, TParams, TAlertInstanceContext, TServices & { ruleDataClient: RuleDataClient } > ): AlertTypeWithExecutor< + TState, TParams, TAlertInstanceContext, TServices & { ruleDataClient: RuleDataClient } diff --git a/x-pack/plugins/security_solution/common/constants.ts b/x-pack/plugins/security_solution/common/constants.ts index ad877ec69945d..47e3b5b3ea364 100644 --- a/x-pack/plugins/security_solution/common/constants.ts +++ b/x-pack/plugins/security_solution/common/constants.ts @@ -193,7 +193,7 @@ export const SIGNALS_ID = `siem.signals`; export const REFERENCE_RULE_ALERT_TYPE_ID = `siem.referenceRule`; export const REFERENCE_RULE_PERSISTENCE_ALERT_TYPE_ID = `siem.referenceRulePersistence`; -export const CUSTOM_ALERT_TYPE_ID = `siem.customRule`; +export const QUERY_ALERT_TYPE_ID = `siem.queryRule`; export const EQL_ALERT_TYPE_ID = `siem.eqlRule`; export const INDICATOR_ALERT_TYPE_ID = `siem.indicatorRule`; export const ML_ALERT_TYPE_ID = `siem.mlRule`; diff --git a/x-pack/plugins/security_solution/public/detections/components/alerts_table/default_config.tsx b/x-pack/plugins/security_solution/public/detections/components/alerts_table/default_config.tsx index 9a142f6cba247..7ff6f82d40bdc 100644 --- a/x-pack/plugins/security_solution/public/detections/components/alerts_table/default_config.tsx +++ b/x-pack/plugins/security_solution/public/detections/components/alerts_table/default_config.tsx @@ -5,6 +5,15 @@ * 2.0. */ +import { + ALERT_DURATION, + ALERT_ID, + ALERT_PRODUCER, + ALERT_START, + ALERT_STATUS, + ALERT_UUID, +} from '@kbn/rule-data-utils'; + import { defaultColumnHeaderType } from '../../../timelines/components/timeline/body/column_headers/default_headers'; import { ColumnHeaderOptions, RowRendererId } from '../../../../common/types/timeline'; import { Status } from '../../../../common/detection_engine/schemas/common/schemas'; @@ -134,14 +143,14 @@ export const buildAlertStatusFilterRuleRegistry = (status: Status): Filter[] => negate: false, disabled: false, type: 'phrase', - key: 'kibana.rac.alert.status', + key: ALERT_STATUS, params: { query: status, }, }, query: { term: { - 'kibana.rac.alert.status': status, + [ALERT_STATUS]: status, }, }, }, @@ -159,28 +168,28 @@ export const buildShowBuildingBlockFilterRuleRegistry = ( negate: true, disabled: false, type: 'exists', - key: 'kibana.rac.rule.building_block_type', + key: 'kibana.rule.building_block_type', value: 'exists', }, // @ts-expect-error TODO: Rework parent typings to support ExistsFilter[] - exists: { field: 'kibana.rac.rule.building_block_type' }, + exists: { field: 'kibana.rule.building_block_type' }, }, ]; export const requiredFieldMappingsForActionsRuleRegistry = { '@timestamp': '@timestamp', - 'alert.id': 'kibana.rac.alert.id', + 'alert.id': ALERT_ID, 'event.kind': 'event.kind', - 'alert.start': 'kibana.rac.alert.start', - 'alert.uuid': 'kibana.rac.alert.uuid', + 'alert.start': ALERT_START, + 'alert.uuid': ALERT_UUID, 'event.action': 'event.action', - 'alert.status': 'kibana.rac.alert.status', - 'alert.duration.us': 'kibana.rac.alert.duration.us', + 'alert.status': ALERT_STATUS, + 'alert.duration.us': ALERT_DURATION, 'rule.uuid': 'rule.uuid', 'rule.id': 'rule.id', 'rule.name': 'rule.name', 'rule.category': 'rule.category', - producer: 'kibana.rac.alert.producer', + producer: ALERT_PRODUCER, tags: 'tags', }; diff --git a/x-pack/plugins/security_solution/public/detections/configurations/examples/observablity_alerts/columns.ts b/x-pack/plugins/security_solution/public/detections/configurations/examples/observablity_alerts/columns.ts index 5e1bf4d90fb46..ae9285f85501b 100644 --- a/x-pack/plugins/security_solution/public/detections/configurations/examples/observablity_alerts/columns.ts +++ b/x-pack/plugins/security_solution/public/detections/configurations/examples/observablity_alerts/columns.ts @@ -6,6 +6,8 @@ */ import { EuiDataGridColumn } from '@elastic/eui'; +import { ALERT_DURATION, ALERT_STATUS } from '@kbn/rule-data-utils'; + import { ColumnHeaderOptions } from '../../../../../common'; import { defaultColumnHeaderType } from '../../../../timelines/components/timeline/body/column_headers/default_headers'; import { DEFAULT_DATE_COLUMN_MIN_WIDTH } from '../../../../timelines/components/timeline/body/constants'; @@ -22,7 +24,7 @@ export const columns: Array< { columnHeaderType: defaultColumnHeaderType, displayAsText: i18n.STATUS, - id: 'kibana.rac.alert.status', + id: ALERT_STATUS, initialWidth: 74, }, { @@ -34,7 +36,7 @@ export const columns: Array< { columnHeaderType: defaultColumnHeaderType, displayAsText: i18n.ALERT_DURATION, - id: 'kibana.rac.alert.duration.us', + id: ALERT_DURATION, initialWidth: 116, }, { diff --git a/x-pack/plugins/security_solution/public/detections/configurations/examples/observablity_alerts/render_cell_value.test.tsx b/x-pack/plugins/security_solution/public/detections/configurations/examples/observablity_alerts/render_cell_value.test.tsx index d99fecb6bdadf..a4826445b23cf 100644 --- a/x-pack/plugins/security_solution/public/detections/configurations/examples/observablity_alerts/render_cell_value.test.tsx +++ b/x-pack/plugins/security_solution/public/detections/configurations/examples/observablity_alerts/render_cell_value.test.tsx @@ -9,6 +9,8 @@ import { mount } from 'enzyme'; import { cloneDeep } from 'lodash/fp'; import React from 'react'; +import { ALERT_DURATION, ALERT_STATUS } from '@kbn/rule-data-utils'; + import { mockBrowserFields } from '../../../../common/containers/source/mock'; import { DragDropContextWrapper } from '../../../../common/components/drag_and_drop/drag_drop_context_wrapper'; import { defaultHeaders, mockTimelineData, TestProviders } from '../../../../common/mock'; @@ -55,7 +57,7 @@ describe('RenderCellValue', () => { const wrapper = mount( - + ); @@ -67,7 +69,7 @@ describe('RenderCellValue', () => { const wrapper = mount( - + ); diff --git a/x-pack/plugins/security_solution/public/detections/configurations/examples/observablity_alerts/render_cell_value.tsx b/x-pack/plugins/security_solution/public/detections/configurations/examples/observablity_alerts/render_cell_value.tsx index 4eb885d4c9aea..684680ea2e852 100644 --- a/x-pack/plugins/security_solution/public/detections/configurations/examples/observablity_alerts/render_cell_value.tsx +++ b/x-pack/plugins/security_solution/public/detections/configurations/examples/observablity_alerts/render_cell_value.tsx @@ -4,12 +4,13 @@ * 2.0; you may not use this file except in compliance with the Elastic License * 2.0. */ - -import { EuiDataGridCellValueElementProps, EuiLink } from '@elastic/eui'; import { random } from 'lodash/fp'; import moment from 'moment'; import React from 'react'; +import { EuiDataGridCellValueElementProps, EuiLink } from '@elastic/eui'; +import { ALERT_DURATION, ALERT_STATUS } from '@kbn/rule-data-utils'; + import { TruncatableText } from '../../../../common/components/truncatable_text'; import { Severity } from '../../../components/severity'; import { getMappedNonEcsValue } from '../../../../timelines/components/timeline/body/data_driven_columns'; @@ -48,11 +49,11 @@ export const RenderCellValue: React.FC< })?.reduce((x) => x[0]) ?? ''; switch (columnId) { - case 'kibana.rac.alert.status': + case ALERT_STATUS: return ( ); - case 'kibana.rac.alert.duration.us': + case ALERT_DURATION: return {moment().fromNow(true)}; case 'signal.rule.severity': return ; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/notifications/schedule_notification_actions.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/notifications/schedule_notification_actions.ts index bfb96e97edf11..147c54cd6eb8a 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/notifications/schedule_notification_actions.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/notifications/schedule_notification_actions.ts @@ -10,8 +10,8 @@ import { AlertInstance } from '../../../../../alerting/server'; import { RuleParams } from '../schemas/rule_schemas'; export type NotificationRuleTypeParams = RuleParams & { - name: string; id: string; + name: string; }; interface ScheduleNotificationActions { diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/eql.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/eql.test.ts deleted file mode 100644 index da5c89a3102a1..0000000000000 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/eql.test.ts +++ /dev/null @@ -1,90 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -// eslint-disable-next-line @kbn/eslint/no-restricted-paths -import { elasticsearchClientMock } from 'src/core/server/elasticsearch/client/mocks'; -import { createEqlAlertType } from './eql'; -import { sequenceResponse } from './__mocks__/eql'; -import { createRuleTypeMocks } from './__mocks__/rule_type'; - -describe('EQL alerts', () => { - it('does not send an alert when sequence not found', async () => { - const { services, dependencies, executor } = createRuleTypeMocks(); - const eqlAlertType = createEqlAlertType(dependencies.ruleDataClient, dependencies.logger); - - dependencies.alerting.registerType(eqlAlertType); - - const params = { - eqlQuery: 'sequence by host.name↵[any where true]↵[any where true]↵[any where true]', - indexPatterns: ['*'], - }; - - services.scopedClusterClient.asCurrentUser.transport.request.mockReturnValue( - elasticsearchClientMock.createSuccessTransportRequestPromise({ - hits: { - hits: [], - sequences: [], - events: [], - total: { - relation: 'eq', - value: 0, - }, - }, - took: 0, - timed_out: false, - _shards: { - failed: 0, - skipped: 0, - successful: 1, - total: 1, - }, - }) - ); - - await executor({ params }); - expect(services.alertInstanceFactory).not.toBeCalled(); - }); - - it('sends a properly formatted alert when sequence is found', async () => { - const { services, dependencies, executor } = createRuleTypeMocks(); - const eqlAlertType = createEqlAlertType(dependencies.ruleDataClient, dependencies.logger); - - dependencies.alerting.registerType(eqlAlertType); - - const params = { - eqlQuery: 'sequence by host.name↵[any where true]↵[any where true]↵[any where true]', - indexPatterns: ['*'], - }; - - services.scopedClusterClient.asCurrentUser.transport.request.mockReturnValue( - elasticsearchClientMock.createSuccessTransportRequestPromise({ - hits: sequenceResponse.rawResponse.body.hits, - took: 0, - timed_out: false, - _shards: { - failed: 0, - skipped: 0, - successful: 1, - total: 1, - }, - }) - ); - - await executor({ params }); - expect(services.alertInstanceFactory).toBeCalled(); - /* - expect(services.alertWithPersistence).toBeCalledWith( - expect.arrayContaining([ - expect.objectContaining({ - 'event.kind': 'signal', - 'kibana.rac.alert.building_block_type': 'default', - }), - ]) - ); - */ - }); -}); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/eql.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/eql.ts deleted file mode 100644 index b98bd9b3551c3..0000000000000 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/eql.ts +++ /dev/null @@ -1,122 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import moment from 'moment'; -import v4 from 'uuid/v4'; - -import { ApiResponse } from '@elastic/elasticsearch'; -import { schema } from '@kbn/config-schema'; -import { Logger } from '@kbn/logging'; - -import { - RuleDataClient, - createPersistenceRuleTypeFactory, -} from '../../../../../rule_registry/server'; -import { EQL_ALERT_TYPE_ID } from '../../../../common/constants'; -import { buildEqlSearchRequest } from '../../../../common/detection_engine/get_query_filter'; -import { BaseSignalHit, EqlSignalSearchResponse } from '../signals/types'; - -export const createEqlAlertType = (ruleDataClient: RuleDataClient, logger: Logger) => { - const createPersistenceRuleType = createPersistenceRuleTypeFactory({ - ruleDataClient, - logger, - }); - return createPersistenceRuleType({ - id: EQL_ALERT_TYPE_ID, - name: 'EQL Rule', - validate: { - params: schema.object({ - eqlQuery: schema.string(), - indexPatterns: schema.arrayOf(schema.string()), - }), - }, - actionGroups: [ - { - id: 'default', - name: 'Default', - }, - ], - defaultActionGroupId: 'default', - actionVariables: { - context: [{ name: 'server', description: 'the server' }], - }, - minimumLicenseRequired: 'basic', - isExportable: false, - producer: 'security-solution', - async executor({ - startedAt, - services: { alertWithPersistence, findAlerts, scopedClusterClient }, - params: { indexPatterns, eqlQuery }, - }) { - const from = moment(startedAt).subtract(moment.duration(5, 'm')).toISOString(); // hardcoded 5-minute rule interval - const to = startedAt.toISOString(); - - const request = buildEqlSearchRequest( - eqlQuery, - indexPatterns, - from, - to, - 10, - undefined, - [], - undefined - ); - const { body: response } = (await scopedClusterClient.asCurrentUser.transport.request( - request - )) as ApiResponse; - - const buildSignalFromEvent = (event: BaseSignalHit) => { - return { - ...event, - 'event.kind': 'signal', - 'kibana.rac.alert.id': '???', - 'kibana.rac.alert.uuid': v4(), - '@timestamp': new Date().toISOString(), - }; - }; - - /* eslint-disable @typescript-eslint/no-explicit-any */ - let alerts: any[] = []; - if (response.hits.sequences !== undefined) { - alerts = response.hits.sequences.reduce((allAlerts: any[], sequence) => { - let previousAlertUuid: string | undefined; - return [ - ...allAlerts, - ...sequence.events.map((event, idx) => { - const alert = { - ...buildSignalFromEvent(event), - 'kibana.rac.alert.ancestors': previousAlertUuid != null ? [previousAlertUuid] : [], - 'kibana.rac.alert.building_block_type': 'default', - 'kibana.rac.alert.depth': idx, - }; - previousAlertUuid = alert['kibana.rac.alert.uuid']; - return alert; - }), - ]; - }, []); - } else if (response.hits.events !== undefined) { - alerts = response.hits.events.map((event) => { - return buildSignalFromEvent(event); - }, []); - } else { - throw new Error( - 'eql query response should have either `sequences` or `events` but had neither' - ); - } - - if (alerts.length > 0) { - alertWithPersistence(alerts).forEach((alert) => { - alert.scheduleActions('default', { server: 'server-test' }); - }); - } - - return { - lastChecked: new Date(), - }; - }, - }); -}; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/query.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/query.ts deleted file mode 100644 index 40c1246733056..0000000000000 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/query.ts +++ /dev/null @@ -1,89 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import type { estypes } from '@elastic/elasticsearch'; -import { schema } from '@kbn/config-schema'; -import { Logger } from '@kbn/logging'; -import { ESSearchRequest } from 'src/core/types/elasticsearch'; - -import { buildEsQuery } from '@kbn/es-query'; - -import type { IIndexPattern } from 'src/plugins/data/public'; -import { - RuleDataClient, - createPersistenceRuleTypeFactory, -} from '../../../../../rule_registry/server'; -import { CUSTOM_ALERT_TYPE_ID } from '../../../../common/constants'; - -export const createQueryAlertType = (ruleDataClient: RuleDataClient, logger: Logger) => { - const createPersistenceRuleType = createPersistenceRuleTypeFactory({ - ruleDataClient, - logger, - }); - return createPersistenceRuleType({ - id: CUSTOM_ALERT_TYPE_ID, - name: 'Custom Query Rule', - validate: { - params: schema.object({ - indexPatterns: schema.arrayOf(schema.string()), - customQuery: schema.string(), - }), - }, - actionGroups: [ - { - id: 'default', - name: 'Default', - }, - ], - defaultActionGroupId: 'default', - actionVariables: { - context: [{ name: 'server', description: 'the server' }], - }, - minimumLicenseRequired: 'basic', - isExportable: false, - producer: 'security-solution', - async executor({ - services: { alertWithPersistence, findAlerts }, - params: { indexPatterns, customQuery }, - }) { - try { - const indexPattern: IIndexPattern = { - fields: [], - title: indexPatterns.join(), - }; - - // TODO: kql or lucene? - - const esQuery = buildEsQuery( - indexPattern, - { query: customQuery, language: 'kuery' }, - [] - ) as estypes.QueryDslQueryContainer; - const query: ESSearchRequest = { - body: { - query: esQuery, - fields: ['*'], - sort: { - '@timestamp': 'asc' as const, - }, - }, - }; - - const alerts = await findAlerts(query); - alertWithPersistence(alerts).forEach((alert) => { - alert.scheduleActions('default', { server: 'server-test' }); - }); - - return { - lastChecked: new Date(), - }; - } catch (error) { - logger.error(error); - } - }, - }); -}; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/scripts/create_reference_rule_eql.sh b/x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/scripts/create_reference_rule_eql.sh deleted file mode 100755 index 25e247a08ef46..0000000000000 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/scripts/create_reference_rule_eql.sh +++ /dev/null @@ -1,34 +0,0 @@ -#!/bin/sh -# -# Copyright 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. -# - -curl -X POST http://localhost:5601/${BASE_PATH}/api/alerts/alert \ - -u ${ELASTICSEARCH_USERNAME}:${ELASTICSEARCH_PASSWORD} \ - -H 'kbn-xsrf: true' \ - -H 'Content-Type: application/json' \ - --verbose \ - -d ' -{ - "params":{ - "indexPatterns": ["*"], - "eqlQuery": "sequence by host.name↵[any where true]↵[any where true]↵[any where true]" - }, - "consumer":"alerts", - "alertTypeId":"siem.eqlRule", - "schedule":{ - "interval":"1m" - }, - "actions":[], - "tags":[ - "eql", - "persistence" - ], - "notifyWhen":"onActionGroupChange", - "name":"Basic EQL rule" -}' - - diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/scripts/create_reference_rule_threshold.sh b/x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/scripts/create_reference_rule_threshold.sh deleted file mode 100755 index 8b486b165c34b..0000000000000 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/scripts/create_reference_rule_threshold.sh +++ /dev/null @@ -1,37 +0,0 @@ -#!/bin/sh -# -# Copyright 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. -# - -curl -X POST http://localhost:5601/${BASE_PATH}/api/alerts/alert \ - -u ${ELASTICSEARCH_USERNAME}:${ELASTICSEARCH_PASSWORD} \ - -H 'kbn-xsrf: true' \ - -H 'Content-Type: application/json' \ - --verbose \ - -d ' -{ - "params":{ - "indexPatterns": ["*"], - "customQuery": "*:*", - "thresholdFields": ["source.ip", "destination.ip"], - "thresholdValue": 50, - "thresholdCardinality": [] - }, - "consumer":"alerts", - "alertTypeId":"siem.thresholdRule", - "schedule":{ - "interval":"1m" - }, - "actions":[], - "tags":[ - "persistence", - "threshold" - ], - "notifyWhen":"onActionGroupChange", - "name":"Basic Threshold rule" -}' - - diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/threshold.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/threshold.test.ts deleted file mode 100644 index 36e53b8154e70..0000000000000 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/threshold.test.ts +++ /dev/null @@ -1,132 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -// eslint-disable-next-line @kbn/eslint/no-restricted-paths -import { elasticsearchClientMock } from 'src/core/server/elasticsearch/client/mocks'; - -import { createRuleTypeMocks } from './__mocks__/rule_type'; -import { mockThresholdResults } from './__mocks__/threshold'; -import { createThresholdAlertType } from './threshold'; - -describe('Threshold alerts', () => { - it('does not send an alert when threshold is not met', async () => { - const { services, dependencies, executor } = createRuleTypeMocks(); - const thresholdAlertType = createThresholdAlertType( - dependencies.ruleDataClient, - dependencies.logger - ); - - dependencies.alerting.registerType(thresholdAlertType); - - const params = { - indexPatterns: ['*'], - customQuery: '*:*', - thresholdFields: ['source.ip', 'host.name'], - thresholdValue: 4, - }; - - services.scopedClusterClient.asCurrentUser.search.mockReturnValue( - elasticsearchClientMock.createSuccessTransportRequestPromise({ - hits: { - hits: [], - sequences: [], - events: [], - total: { - relation: 'eq', - value: 0, - }, - }, - aggregations: { - 'threshold_0:source.ip': { - buckets: [], - }, - }, - took: 0, - timed_out: false, - _shards: { - failed: 0, - skipped: 0, - successful: 1, - total: 1, - }, - }) - ); - - await executor({ params }); - expect(services.alertInstanceFactory).not.toBeCalled(); - }); - - it('sends a properly formatted alert when threshold is met', async () => { - const { services, dependencies, executor } = createRuleTypeMocks(); - const thresholdAlertType = createThresholdAlertType( - dependencies.ruleDataClient, - dependencies.logger - ); - - dependencies.alerting.registerType(thresholdAlertType); - - const params = { - indexPatterns: ['*'], - customQuery: '*:*', - thresholdFields: ['source.ip', 'host.name'], - thresholdValue: 4, - }; - - services.scopedClusterClient.asCurrentUser.search - .mockReturnValueOnce( - elasticsearchClientMock.createSuccessTransportRequestPromise({ - hits: { - hits: [], - total: { - relation: 'eq', - value: 0, - }, - }, - took: 0, - timed_out: false, - _shards: { - failed: 0, - skipped: 0, - successful: 1, - total: 1, - }, - }) - ) - .mockReturnValueOnce( - elasticsearchClientMock.createSuccessTransportRequestPromise({ - hits: { - hits: [], - total: { - relation: 'eq', - value: 0, - }, - }, - aggregations: mockThresholdResults.rawResponse.body.aggregations, - took: 0, - timed_out: false, - _shards: { - failed: 0, - skipped: 0, - successful: 1, - total: 1, - }, - }) - ); - - await executor({ params }); - expect(services.alertInstanceFactory).toBeCalled(); - /* - expect(services.alertWithPersistence).toBeCalledWith( - expect.arrayContaining([ - expect.objectContaining({ - 'event.kind': 'signal', - }), - ]) - ); - */ - }); -}); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/threshold.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/threshold.ts deleted file mode 100644 index fa291ef3139cd..0000000000000 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/threshold.ts +++ /dev/null @@ -1,207 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import moment from 'moment'; -import v4 from 'uuid/v4'; - -import { schema } from '@kbn/config-schema'; -import { Logger } from '@kbn/logging'; - -import { AlertServices } from '../../../../../alerting/server'; -import { - RuleDataClient, - createPersistenceRuleTypeFactory, -} from '../../../../../rule_registry/server'; -import { THRESHOLD_ALERT_TYPE_ID } from '../../../../common/constants'; -import { SignalSearchResponse, ThresholdSignalHistory } from '../signals/types'; -import { - findThresholdSignals, - getThresholdBucketFilters, - getThresholdSignalHistory, - transformThresholdResultsToEcs, -} from '../signals/threshold'; -import { getFilter } from '../signals/get_filter'; -import { BuildRuleMessage } from '../signals/rule_messages'; - -interface RuleParams { - indexPatterns: string[]; - customQuery: string; - thresholdFields: string[]; - thresholdValue: number; - thresholdCardinality: Array<{ - field: string; - value: number; - }>; -} - -interface BulkCreateThresholdSignalParams { - results: SignalSearchResponse; - ruleParams: RuleParams; - services: AlertServices & { logger: Logger }; - inputIndexPattern: string[]; - ruleId: string; - startedAt: Date; - from: Date; - thresholdSignalHistory: ThresholdSignalHistory; - buildRuleMessage: BuildRuleMessage; -} - -// eslint-disable-next-line @typescript-eslint/no-explicit-any -const formatThresholdSignals = (params: BulkCreateThresholdSignalParams): any[] => { - const thresholdResults = params.results; - const threshold = { - field: params.ruleParams.thresholdFields, - value: params.ruleParams.thresholdValue, - }; - const results = transformThresholdResultsToEcs( - thresholdResults, - params.ruleParams.indexPatterns.join(','), - params.startedAt, - params.from, - undefined, - params.services.logger, - threshold, - params.ruleId, - undefined, - params.thresholdSignalHistory - ); - return results.hits.hits.map((hit) => { - return { - ...hit, - 'event.kind': 'signal', - 'kibana.rac.alert.id': '???', - 'kibana.rac.alert.uuid': v4(), - '@timestamp': new Date().toISOString(), - }; - }); -}; - -export const createThresholdAlertType = (ruleDataClient: RuleDataClient, logger: Logger) => { - const createPersistenceRuleType = createPersistenceRuleTypeFactory({ - ruleDataClient, - logger, - }); - return createPersistenceRuleType({ - id: THRESHOLD_ALERT_TYPE_ID, - name: 'Threshold Rule', - validate: { - params: schema.object({ - indexPatterns: schema.arrayOf(schema.string()), - customQuery: schema.string(), - thresholdFields: schema.arrayOf(schema.string()), - thresholdValue: schema.number(), - thresholdCardinality: schema.arrayOf( - schema.object({ - field: schema.string(), - value: schema.number(), - }) - ), - }), - }, - actionGroups: [ - { - id: 'default', - name: 'Default', - }, - ], - defaultActionGroupId: 'default', - actionVariables: { - context: [{ name: 'server', description: 'the server' }], - }, - minimumLicenseRequired: 'basic', - isExportable: false, - producer: 'security-solution', - async executor({ startedAt, services, params, alertId }) { - const fromDate = moment(startedAt).subtract(moment.duration(5, 'm')); // hardcoded 5-minute rule interval - const from = fromDate.toISOString(); - const to = startedAt.toISOString(); - - // TODO: how to get the output index? - const outputIndex = ['.kibana-madi-8-alerts-security-solution-8.0.0-000001']; - const buildRuleMessage = (...messages: string[]) => messages.join(); - const timestampOverride = undefined; - - const { - thresholdSignalHistory, - searchErrors: previousSearchErrors, - } = await getThresholdSignalHistory({ - indexPattern: outputIndex, - from, - to, - services: (services as unknown) as AlertServices, - logger, - ruleId: alertId, - bucketByFields: params.thresholdFields, - timestampOverride, - buildRuleMessage, - }); - - const bucketFilters = await getThresholdBucketFilters({ - thresholdSignalHistory, - timestampOverride, - }); - - const esFilter = await getFilter({ - type: 'threshold', - filters: bucketFilters, - language: 'kuery', - query: params.customQuery, - savedId: undefined, - services: (services as unknown) as AlertServices, - index: params.indexPatterns, - lists: [], - }); - - const { - searchResult: thresholdResults, - searchErrors, - searchDuration: thresholdSearchDuration, - } = await findThresholdSignals({ - inputIndexPattern: params.indexPatterns, - from, - to, - services: (services as unknown) as AlertServices, - logger, - filter: esFilter, - threshold: { - field: params.thresholdFields, - value: params.thresholdValue, - cardinality: params.thresholdCardinality, - }, - timestampOverride, - buildRuleMessage, - }); - - logger.info(`Threshold search took ${thresholdSearchDuration}ms`); // TODO: rule status service - - const alerts = formatThresholdSignals({ - results: thresholdResults, - ruleParams: params, - services: (services as unknown) as AlertServices & { logger: Logger }, - inputIndexPattern: ['TODO'], - ruleId: alertId, - startedAt, - from: fromDate.toDate(), - thresholdSignalHistory, - buildRuleMessage, - }); - - const errors = searchErrors.concat(previousSearchErrors); - if (errors.length === 0) { - services.alertWithPersistence(alerts).forEach((alert) => { - alert.scheduleActions('default', { server: 'server-test' }); - }); - } else { - throw new Error(errors.join('\n')); - } - - return { - lastChecked: new Date(), - }; - }, - }); -}; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_execution_log/rule_registry_log_client/rule_execution_log_bootstrapper.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_execution_log/rule_registry_log_client/rule_execution_log_bootstrapper.ts index 50a9b45485741..9b13fbb1d21d6 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_execution_log/rule_registry_log_client/rule_execution_log_bootstrapper.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_execution_log/rule_registry_log_client/rule_execution_log_bootstrapper.ts @@ -28,7 +28,7 @@ export const bootstrapRuleExecutionLog = async ( settings: { number_of_shards: 1, }, - mappings: mappingFromFieldMap(ruleExecutionFieldMap), + mappings: mappingFromFieldMap(ruleExecutionFieldMap, 'strict'), }, }, }); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_execution_log/with_rule_execution_log.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_execution_log/with_rule_execution_log.ts index 7cd0b2b345438..95598ea943d8f 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_execution_log/with_rule_execution_log.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_execution_log/with_rule_execution_log.ts @@ -6,7 +6,11 @@ */ import { Logger } from '@kbn/logging'; -import { AlertInstanceContext, AlertTypeParams } from '../../../../../alerting/common'; +import { + AlertInstanceContext, + AlertTypeParams, + AlertTypeState, +} from '../../../../../alerting/common'; import { AlertTypeWithExecutor, RuleDataPluginService } from '../../../../../rule_registry/server'; import { RuleExecutionStatus } from '../../../../common/detection_engine/schemas/common/schemas'; import { RuleExecutionLogClient } from './rule_execution_log_client'; @@ -21,12 +25,13 @@ type WithRuleExecutionLog = (args: { logger: Logger; ruleDataService: RuleDataPluginService; }) => < + TState extends AlertTypeState, TParams extends AlertTypeParams, TAlertInstanceContext extends AlertInstanceContext, TServices extends ExecutionLogServices >( - type: AlertTypeWithExecutor -) => AlertTypeWithExecutor; + type: AlertTypeWithExecutor +) => AlertTypeWithExecutor; export const withRuleExecutionLogFactory: WithRuleExecutionLog = ({ logger, ruleDataService }) => ( type diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/__mocks__/eql.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/__mocks__/eql.ts similarity index 100% rename from x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/__mocks__/eql.ts rename to x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/__mocks__/eql.ts diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/__mocks__/rule.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/__mocks__/rule.ts new file mode 100644 index 0000000000000..25e687050cf88 --- /dev/null +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/__mocks__/rule.ts @@ -0,0 +1,52 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +export const createRuleMock = () => ({ + actions: [], + author: [], + buildingBlockType: undefined, + createdAt: '2020-01-10T21:11:45.839Z', + createdBy: 'elastic', + description: '24/7', + enabled: true, + eventCategoryOverride: undefined, + exceptionsList: [], + falsePositives: [], + filters: [], + from: 'now-300s', + id: 'cf1f6a49-18a3-4794-aad7-0e8482e075e9', + immutable: false, + index: ['auditbeat-*'], + interval: '5m', + language: 'kuery', + license: 'basic', + maxSignals: 100, + meta: { from: '0m' }, + name: 'Home Grown!', + note: '# this is some markdown documentation', + outputIndex: '.siem-signals-default', + query: '', + riskScore: 21, + riskScoreMapping: [], + references: [], + ruleId: 'b5ba41ab-aaf3-4f43-971b-bdf9434ce0ea', + ruleNameOverride: undefined, + savedId: "Garrett's IP", + tags: [], + threat: [], + throttle: 'no_actions', + timelineId: '86aa74d0-2136-11ea-9864-ebc8cc1cb8c2', + timelineTitle: 'Untitled timeline', + timestampOverride: undefined, + to: 'now', + type: 'query', + severity: 'low', + severityMapping: [], + updatedAt: '2020-01-10T21:11:45.839Z', + updatedBy: 'elastic', + version: 1, +}); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/__mocks__/rule_type.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/__mocks__/rule_type.ts similarity index 62% rename from x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/__mocks__/rule_type.ts rename to x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/__mocks__/rule_type.ts index 6c0670d1dbb2c..60dcbb3a4e77e 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/__mocks__/rule_type.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/__mocks__/rule_type.ts @@ -8,12 +8,15 @@ import { of } from 'rxjs'; import { v4 } from 'uuid'; -import { Logger } from 'kibana/server'; -import { elasticsearchServiceMock } from 'src/core/server/mocks'; +import { Logger, SavedObject } from 'kibana/server'; +import { elasticsearchServiceMock, savedObjectsClientMock } from 'src/core/server/mocks'; import type { RuleDataClient } from '../../../../../../rule_registry/server'; import { PluginSetupContract as AlertingPluginSetupContract } from '../../../../../../alerting/server'; import { ConfigType } from '../../../../config'; +import { AlertAttributes } from '../../signals/types'; +import { createRuleMock } from './rule'; +import { listMock } from '../../../../../../lists/server/mocks'; export const createRuleTypeMocks = () => { /* eslint-disable @typescript-eslint/no-explicit-any */ @@ -36,7 +39,29 @@ export const createRuleTypeMocks = () => { const scheduleActions = jest.fn(); + const mockSavedObjectsClient = savedObjectsClientMock.create(); + mockSavedObjectsClient.get.mockResolvedValue({ + id: 'de2f6a49-28a3-4794-bad7-0e9482e075f8', + type: 'query', + references: [], + attributes: { + actions: [], + enabled: true, + name: 'mock rule', + tags: [], + createdBy: 'user1', + createdAt: '', + updatedBy: 'user2', + schedule: { + interval: '30m', + }, + throttle: '', + params: createRuleMock(), + }, + } as SavedObject); + const services = { + savedObjectsClient: mockSavedObjectsClient, scopedClusterClient: elasticsearchServiceMock.createScopedClusterClient(), alertInstanceFactory: jest.fn(() => ({ scheduleActions })), findAlerts: jest.fn(), // TODO: does this stay? @@ -47,19 +72,17 @@ export const createRuleTypeMocks = () => { return { dependencies: { alerting, + buildRuleMessage: jest.fn(), config$: mockedConfig$, + lists: listMock.createSetup(), logger: loggerMock, ruleDataClient: ({ - getReader: () => { - return { - search: jest.fn(), - }; - }, - getWriter: () => { - return { - bulk: jest.fn(), - }; - }, + getReader: jest.fn(() => ({ + search: jest.fn(), + })), + getWriter: jest.fn(() => ({ + bulk: jest.fn(), + })), isWriteEnabled: jest.fn(() => true), } as unknown) as RuleDataClient, }, diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/__mocks__/threshold.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/__mocks__/threshold.ts similarity index 100% rename from x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/__mocks__/threshold.ts rename to x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/__mocks__/threshold.ts diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/create_security_rule_type_factory.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/create_security_rule_type_factory.ts new file mode 100644 index 0000000000000..71d922ed543c1 --- /dev/null +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/create_security_rule_type_factory.ts @@ -0,0 +1,324 @@ +/* + * Copyright 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 } from 'lodash'; +import { flow } from 'fp-ts/lib/function'; +import { Either, chain, fold, tryCatch } from 'fp-ts/lib/Either'; +import { parseScheduleDates } from '@kbn/securitysolution-io-ts-utils'; +import { ListArray } from '@kbn/securitysolution-io-ts-list-types'; +import { toError } from '@kbn/securitysolution-list-api'; +import { createPersistenceRuleTypeFactory } from '../../../../../rule_registry/server'; +import { ruleStatusSavedObjectsClientFactory } from '../signals/rule_status_saved_objects_client'; +import { ruleStatusServiceFactory } from '../signals/rule_status_service'; +import { buildRuleMessageFactory } from './factories/build_rule_message_factory'; +import { + checkPrivilegesFromEsClient, + getExceptions, + getRuleRangeTuples, + hasReadIndexPrivileges, + hasTimestampFields, + isMachineLearningParams, +} from '../signals/utils'; +import { DEFAULT_MAX_SIGNALS, DEFAULT_SEARCH_AFTER_PAGE_SIZE } from '../../../../common/constants'; +import { CreateSecurityRuleTypeFactory } from './types'; +import { getListClient } from './utils/get_list_client'; +import { + NotificationRuleTypeParams, + scheduleNotificationActions, +} from '../notifications/schedule_notification_actions'; +import { getNotificationResultsLink } from '../notifications/utils'; +import { createResultObject } from './utils'; +import { bulkCreateFactory, wrapHitsFactory } from './factories'; + +/* eslint-disable complexity */ +export const createSecurityRuleTypeFactory: CreateSecurityRuleTypeFactory = ({ + indexAlias, + lists, + logger, + mergeStrategy, + ruleDataClient, +}) => (type) => { + const persistenceRuleType = createPersistenceRuleTypeFactory({ ruleDataClient, logger }); + return persistenceRuleType({ + ...type, + async executor(options) { + const { + alertId, + params, + previousStartedAt, + services, + spaceId, + state, + updatedBy: updatedByUser, + } = options; + let runState = state; + const { from, maxSignals, meta, ruleId, timestampOverride, to } = params; + const { alertWithPersistence, savedObjectsClient, scopedClusterClient } = services; + const searchAfterSize = Math.min(maxSignals, DEFAULT_SEARCH_AFTER_PAGE_SIZE); + + const esClient = scopedClusterClient.asCurrentUser; + + const ruleStatusClient = ruleStatusSavedObjectsClientFactory(savedObjectsClient); + const ruleStatusService = await ruleStatusServiceFactory({ + alertId, + ruleStatusClient, + }); + + const ruleSO = await savedObjectsClient.get('alert', alertId); + + const { + actions, + name, + schedule: { interval }, + } = ruleSO.attributes; + const refresh = actions.length ? 'wait_for' : false; + + const buildRuleMessage = buildRuleMessageFactory({ + id: alertId, + ruleId, + name, + index: indexAlias, + }); + + logger.debug(buildRuleMessage('[+] Starting Signal Rule execution')); + logger.debug(buildRuleMessage(`interval: ${interval}`)); + + let wroteWarningStatus = false; + await ruleStatusService.goingToRun(); + + let result = createResultObject(state); + + // check if rule has permissions to access given index pattern + // move this collection of lines into a function in utils + // so that we can use it in create rules route, bulk, etc. + try { + if (!isMachineLearningParams(params)) { + const index = params.index; + const hasTimestampOverride = !!timestampOverride; + + const inputIndices = params.index ?? []; + + const [privileges, timestampFieldCaps] = await Promise.all([ + checkPrivilegesFromEsClient(esClient, inputIndices), + esClient.fieldCaps({ + index: index ?? ['*'], + fields: hasTimestampOverride + ? ['@timestamp', timestampOverride as string] + : ['@timestamp'], + include_unmapped: true, + }), + ]); + + fold, void>( + async (error: Error) => logger.error(buildRuleMessage(error.message)), + async (status: Promise) => (wroteWarningStatus = await status) + )( + flow( + () => + tryCatch( + () => + hasReadIndexPrivileges(privileges, logger, buildRuleMessage, ruleStatusService), + toError + ), + chain((wroteStatus: unknown) => + tryCatch( + () => + hasTimestampFields( + wroteStatus as boolean, + hasTimestampOverride ? (timestampOverride as string) : '@timestamp', + name, + timestampFieldCaps, + inputIndices, + ruleStatusService, + logger, + buildRuleMessage + ), + toError + ) + ) + )() as Either> + ); + } + } catch (exc) { + logger.error(buildRuleMessage(`Check privileges failed to execute ${exc}`)); + } + let hasError = false; + const { tuples, remainingGap } = getRuleRangeTuples({ + logger, + previousStartedAt, + from: from as string, + to: to as string, + interval, + maxSignals: DEFAULT_MAX_SIGNALS, + buildRuleMessage, + }); + if (remainingGap.asMilliseconds() > 0) { + const gapString = remainingGap.humanize(); + const gapMessage = buildRuleMessage( + `${gapString} (${remainingGap.asMilliseconds()}ms) were not queried between this rule execution and the last execution, so signals may have been missed.`, + 'Consider increasing your look behind time or adding more Kibana instances.' + ); + logger.warn(gapMessage); + hasError = true; + await ruleStatusService.error(gapMessage, { gap: gapString }); + } + + try { + const { listClient, exceptionsClient } = getListClient({ + esClient: services.scopedClusterClient.asCurrentUser, + updatedByUser, + spaceId, + lists, + savedObjectClient: options.services.savedObjectsClient, + }); + + const exceptionItems = await getExceptions({ + client: exceptionsClient, + lists: (params.exceptionsList as ListArray) ?? [], + }); + + const bulkCreate = bulkCreateFactory( + logger, + alertWithPersistence, + buildRuleMessage, + refresh + ); + + const wrapHits = wrapHitsFactory({ + ruleSO, + mergeStrategy, + }); + + for (const tuple of tuples) { + const runResult = await type.executor({ + ...options, + services, + state: runState, + runOpts: { + buildRuleMessage, + bulkCreate, + exceptionItems, + listClient, + rule: ruleSO, + searchAfterSize, + tuple, + wrapHits, + }, + }); + + const createdSignals = result.createdSignals.concat(runResult.createdSignals); + const warningMessages = result.warningMessages.concat(runResult.warningMessages); + result = { + bulkCreateTimes: result.bulkCreateTimes.concat(runResult.bulkCreateTimes), + createdSignals, + createdSignalsCount: createdSignals.length, + errors: result.errors.concat(runResult.errors), + lastLookbackDate: runResult.lastLookbackDate, + searchAfterTimes: result.searchAfterTimes.concat(runResult.searchAfterTimes), + state: runState, + success: result.success && runResult.success, + warning: warningMessages.length > 0, + warningMessages, + }; + runState = runResult.state; + } + + if (result.warningMessages.length) { + const warningMessage = buildRuleMessage(result.warningMessages.join()); + await ruleStatusService.partialFailure(warningMessage); + } + + if (result.success) { + const createdSignalsCount = result.createdSignals.length; + + if (actions.length) { + const notificationRuleParams: NotificationRuleTypeParams = ({ + ...params, + name: name as string, + id: ruleSO.id as string, + } as unknown) as NotificationRuleTypeParams; + + const fromInMs = parseScheduleDates(`now-${interval}`)?.format('x'); + const toInMs = parseScheduleDates('now')?.format('x'); + const resultsLink = getNotificationResultsLink({ + from: fromInMs, + to: toInMs, + id: ruleSO.id, + kibanaSiemAppUrl: (meta as { kibana_siem_app_url?: string } | undefined) + ?.kibana_siem_app_url, + }); + + logger.info(buildRuleMessage(`Found ${createdSignalsCount} signals for notification.`)); + + if (createdSignalsCount) { + const alertInstance = services.alertInstanceFactory(alertId); + scheduleNotificationActions({ + alertInstance, + signalsCount: createdSignalsCount, + signals: result.createdSignals, + resultsLink, + ruleParams: notificationRuleParams, + }); + } + } + + logger.debug(buildRuleMessage('[+] Signal Rule execution completed.')); + logger.debug( + buildRuleMessage( + `[+] Finished indexing ${createdSignalsCount} signals into alias ${indexAlias}` + ) + ); + + if (!hasError && !wroteWarningStatus && !result.warning) { + await ruleStatusService.success('succeeded', { + bulkCreateTimeDurations: result.bulkCreateTimes, + searchAfterTimeDurations: result.searchAfterTimes, + lastLookBackDate: result.lastLookbackDate?.toISOString(), + }); + } + + // adding this log line so we can get some information from cloud + logger.info( + buildRuleMessage( + `[+] Finished indexing ${createdSignalsCount} ${ + !isEmpty(tuples) + ? `signals searched between date ranges ${JSON.stringify(tuples, null, 2)}` + : '' + }` + ) + ); + } else { + const errorMessage = buildRuleMessage( + 'Bulk Indexing of signals failed:', + result.errors.join() + ); + logger.error(errorMessage); + await ruleStatusService.error(errorMessage, { + bulkCreateTimeDurations: result.bulkCreateTimes, + searchAfterTimeDurations: result.searchAfterTimes, + lastLookBackDate: result.lastLookbackDate?.toISOString(), + }); + } + } catch (error) { + const errorMessage = error.message ?? '(no error message given)'; + const message = buildRuleMessage( + 'An error occurred during rule execution:', + `message: "${errorMessage}"` + ); + + logger.error(message); + await ruleStatusService.error(message, { + bulkCreateTimeDurations: result.bulkCreateTimes, + searchAfterTimeDurations: result.searchAfterTimes, + lastLookBackDate: result.lastLookbackDate?.toISOString(), + }); + } + + return result.state; + }, + }); +}; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/build_rule_message_factory.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/build_rule_message_factory.ts new file mode 100644 index 0000000000000..09d2cb559fe69 --- /dev/null +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/build_rule_message_factory.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. + */ + +export type BuildRuleMessage = (...messages: string[]) => string; +export interface BuildRuleMessageFactoryParams { + name: string; + id: string; + ruleId: string | null | undefined; + index: string; +} + +export const buildRuleMessageFactory = ({ + id, + ruleId, + index, + name, +}: BuildRuleMessageFactoryParams): BuildRuleMessage => (...messages) => + [ + ...messages, + `name: "${name}"`, + `id: "${id}"`, + `rule id: "${ruleId ?? '(unknown rule id)'}"`, + `signals index alias: "${index}"`, + ].join(' '); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/bulk_create_factory.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/bulk_create_factory.ts new file mode 100644 index 0000000000000..c600e187bc8f1 --- /dev/null +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/bulk_create_factory.ts @@ -0,0 +1,105 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { performance } from 'perf_hooks'; +import { countBy, isEmpty } from 'lodash'; + +import { Logger } from 'kibana/server'; +import { BaseHit } from '../../../../../common/detection_engine/types'; +import { BuildRuleMessage } from '../../signals/rule_messages'; +import { errorAggregator, makeFloatString } from '../../signals/utils'; +import { RefreshTypes } from '../../types'; +import { PersistenceAlertService } from '../../../../../../rule_registry/server'; +import { AlertInstanceContext } from '../../../../../../alerting/common'; + +export interface GenericBulkCreateResponse { + success: boolean; + bulkCreateDuration: string; + createdItemsCount: number; + createdItems: Array; + errors: string[]; +} + +export const bulkCreateFactory = ( + logger: Logger, + alertWithPersistence: PersistenceAlertService, + buildRuleMessage: BuildRuleMessage, + refreshForBulkCreate: RefreshTypes +) => async (wrappedDocs: Array>): Promise> => { + if (wrappedDocs.length === 0) { + return { + errors: [], + success: true, + bulkCreateDuration: '0', + createdItemsCount: 0, + createdItems: [], + }; + } + + const start = performance.now(); + + const response = await alertWithPersistence( + wrappedDocs.map((doc) => ({ + id: doc._id, + fields: doc.fields ?? doc._source ?? {}, + })), + refreshForBulkCreate + ); + + const end = performance.now(); + + logger.debug( + buildRuleMessage( + `individual bulk process time took: ${makeFloatString(end - start)} milliseconds` + ) + ); + logger.debug( + buildRuleMessage(`took property says bulk took: ${response.body.took} milliseconds`) + ); + + const createdItems = wrappedDocs + .map((doc, index) => ({ + _id: response.body.items[index].index?._id ?? '', + _index: response.body.items[index].index?._index ?? '', + ...doc._source, + })) + .filter((_, index) => response.body.items[index].index?.status === 201); + const createdItemsCount = createdItems.length; + + const duplicateSignalsCount = countBy(response.body.items, 'create.status')['409']; + const errorCountByMessage = errorAggregator(response.body, [409]); + + logger.debug(buildRuleMessage(`bulk created ${createdItemsCount} signals`)); + + if (duplicateSignalsCount > 0) { + logger.debug(buildRuleMessage(`ignored ${duplicateSignalsCount} duplicate signals`)); + } + + if (!isEmpty(errorCountByMessage)) { + logger.error( + buildRuleMessage( + `[-] bulkResponse had errors with responses of: ${JSON.stringify(errorCountByMessage)}` + ) + ); + + return { + errors: Object.keys(errorCountByMessage), + success: false, + bulkCreateDuration: makeFloatString(end - start), + createdItemsCount: createdItems.length, + createdItems, + }; + } else { + return { + errors: [], + success: true, + bulkCreateDuration: makeFloatString(end - start), + createdItemsCount: createdItems.length, + createdItems, + }; + } +}; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/index.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/index.ts new file mode 100644 index 0000000000000..76263745ba7ae --- /dev/null +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/index.ts @@ -0,0 +1,10 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +export * from './build_rule_message_factory'; +export * from './bulk_create_factory'; +export * from './wrap_hits_factory'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/utils/build_alert.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/utils/build_alert.ts new file mode 100644 index 0000000000000..fbd033a7f4ec4 --- /dev/null +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/utils/build_alert.ts @@ -0,0 +1,147 @@ +/* + * Copyright 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 { ALERT_STATUS, ALERT_WORKFLOW_STATUS } from '@kbn/rule-data-utils'; +import { SearchTypes } from '../../../../../../common/detection_engine/types'; +import { RulesSchema } from '../../../../../../common/detection_engine/schemas/response/rules_schema'; +import { isEventTypeSignal } from '../../../signals/build_event_type_signal'; +import { + Ancestor, + BaseSignalHit, + SignalHit, + SignalSourceHit, + ThresholdResult, +} from '../../../signals/types'; +import { getValidDateFromDoc } from '../../../signals/utils'; +import { invariant } from '../../../../../../common/utils/invariant'; +import { DEFAULT_MAX_SIGNALS } from '../../../../../../common/constants'; + +/** + * Takes a parent signal or event document and extracts the information needed for the corresponding entry in the child + * signal's `signal.parents` array. + * @param doc The parent signal or event + */ +export const buildParent = (doc: BaseSignalHit): Ancestor => { + if (doc._source?.signal != null) { + return { + rule: doc._source?.signal.rule.id, + id: doc._id, + type: 'signal', + index: doc._index, + // We first look for signal.depth and use that if it exists. If it doesn't exist, this should be a pre-7.10 signal + // and should have signal.parent.depth instead. signal.parent.depth in this case is treated as equivalent to signal.depth. + depth: doc._source?.signal.depth ?? doc._source?.signal.parent?.depth ?? 1, + }; + } else { + return { + id: doc._id, + type: 'event', + index: doc._index, + depth: 0, + }; + } +}; + +/** + * Takes a parent signal or event document with N ancestors and adds the parent document to the ancestry array, + * creating an array of N+1 ancestors. + * @param doc The parent signal/event for which to extend the ancestry. + */ +export const buildAncestors = (doc: BaseSignalHit): Ancestor[] => { + const newAncestor = buildParent(doc); + const existingAncestors = doc._source?.signal?.ancestors; + if (existingAncestors != null) { + return [...existingAncestors, newAncestor]; + } else { + return [newAncestor]; + } +}; + +/** + * This removes any signal name clashes such as if a source index has + * "signal" but is not a signal object we put onto the object. If this + * is our "signal object" then we don't want to remove it. + * @param doc The source index doc to a signal. + */ +export const removeClashes = (doc: BaseSignalHit): BaseSignalHit => { + invariant(doc._source, '_source field not found'); + const { signal, ...noSignal } = doc._source; + if (signal == null || isEventTypeSignal(doc)) { + return doc; + } else { + return { + ...doc, + _source: { ...noSignal }, + }; + } +}; + +/** + * Builds the `signal.*` fields that are common across all signals. + * @param docs The parent signals/events of the new signal to be built. + * @param rule The rule that is generating the new signal. + */ +export const buildAlert = (doc: SignalSourceHit, rule: RulesSchema) => { + const removedClashes = removeClashes(doc); + const parent = buildParent(removedClashes); + const ancestors = buildAncestors(removedClashes); + const immutable = doc._source?.signal?.rule.immutable ? 'true' : 'false'; + + const source = doc._source as SignalHit; + const signal = source?.signal; + const signalRule = signal?.rule; + + return { + 'kibana.alert.ancestors': ancestors as object[], + [ALERT_STATUS]: 'open', + [ALERT_WORKFLOW_STATUS]: 'open', + 'kibana.alert.depth': parent.depth, + 'kibana.alert.rule.false_positives': signalRule?.false_positives ?? [], + 'kibana.alert.rule.id': rule.id, + 'kibana.alert.rule.immutable': immutable, + 'kibana.alert.rule.index': signalRule?.index ?? [], + 'kibana.alert.rule.language': signalRule?.language ?? 'kuery', + 'kibana.alert.rule.max_signals': signalRule?.max_signals ?? DEFAULT_MAX_SIGNALS, + 'kibana.alert.rule.query': signalRule?.query ?? '*:*', + 'kibana.alert.rule.saved_id': signalRule?.saved_id ?? '', + 'kibana.alert.rule.threat_index': signalRule?.threat_index, + 'kibana.alert.rule.threat_indicator_path': signalRule?.threat_indicator_path, + 'kibana.alert.rule.threat_language': signalRule?.threat_language, + 'kibana.alert.rule.threat_mapping.field': '', // TODO + 'kibana.alert.rule.threat_mapping.value': '', // TODO + 'kibana.alert.rule.threat_mapping.type': '', // TODO + 'kibana.alert.rule.threshold.field': signalRule?.threshold?.field, + 'kibana.alert.rule.threshold.value': signalRule?.threshold?.value, + 'kibana.alert.rule.threshold.cardinality.field': '', // TODO + 'kibana.alert.rule.threshold.cardinality.value': 0, // TODO + }; +}; + +const isThresholdResult = (thresholdResult: SearchTypes): thresholdResult is ThresholdResult => { + return typeof thresholdResult === 'object'; +}; + +/** + * Creates signal fields that are only available in the special case where a signal has only 1 parent signal/event. + * We copy the original time from the document as "original_time" since we override the timestamp with the current date time. + * @param doc The parent signal/event of the new signal to be built. + */ +export const additionalAlertFields = (doc: BaseSignalHit) => { + const thresholdResult = doc._source?.threshold_result; + if (thresholdResult != null && !isThresholdResult(thresholdResult)) { + throw new Error(`threshold_result failed to validate: ${thresholdResult}`); + } + const originalTime = getValidDateFromDoc({ + doc, + timestampOverride: undefined, + }); + return { + 'kibana.alert.original_time': originalTime != null ? originalTime.toISOString() : undefined, + 'kibana.alert.original_event': doc._source?.event ?? undefined, + 'kibana.alert.threshold_result': thresholdResult, + }; +}; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/utils/build_bulk_body.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/utils/build_bulk_body.ts new file mode 100644 index 0000000000000..8c868ece26ceb --- /dev/null +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/utils/build_bulk_body.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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { SavedObject } from 'src/core/types'; +import type { ConfigType } from '../../../../../config'; +import { buildRuleWithOverrides } from '../../../signals/build_rule'; +import { getMergeStrategy } from '../../../signals/source_fields_merging/strategies'; +import { AlertAttributes, SignalSourceHit } from '../../../signals/types'; +import { RACAlert } from '../../types'; +import { additionalAlertFields, buildAlert } from './build_alert'; +import { filterSource } from './filter_source'; + +/** + * Formats the search_after result for insertion into the signals index. We first create a + * "best effort" merged "fields" with the "_source" object, then build the signal object, + * then the event object, and finally we strip away any additional temporary data that was added + * such as the "threshold_result". + * @param ruleSO The rule saved object to build overrides + * @param doc The SignalSourceHit with "_source", "fields", and additional data such as "threshold_result" + * @returns The body that can be added to a bulk call for inserting the signal. + */ +export const buildBulkBody = ( + ruleSO: SavedObject, + doc: SignalSourceHit, + mergeStrategy: ConfigType['alertMergeStrategy'] +): RACAlert => { + const mergedDoc = getMergeStrategy(mergeStrategy)({ doc }); + const rule = buildRuleWithOverrides(ruleSO, mergedDoc._source ?? {}); + const filteredSource = filterSource(mergedDoc); + return { + ...filteredSource, + ...buildAlert(mergedDoc, rule), + ...additionalAlertFields(mergedDoc), + '@timestamp': new Date().toISOString(), + }; +}; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/utils/filter_source.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/utils/filter_source.ts new file mode 100644 index 0000000000000..2f1ebf545c6c1 --- /dev/null +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/utils/filter_source.ts @@ -0,0 +1,24 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { buildEventTypeSignal } from '../../../signals/build_event_type_signal'; +import { SignalSourceHit } from '../../../signals/types'; +import { RACAlert } from '../../types'; + +export const filterSource = (doc: SignalSourceHit): Partial => { + const event = buildEventTypeSignal(doc); + + const docSource = doc._source ?? {}; + const { threshold_result: thresholdResult, ...filteredSource } = docSource || { + threshold_result: null, + }; + + return { + ...filteredSource, + event, + }; +}; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/wrap_hits_factory.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/wrap_hits_factory.ts new file mode 100644 index 0000000000000..620e599e7a499 --- /dev/null +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/factories/wrap_hits_factory.ts @@ -0,0 +1,36 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { SearchAfterAndBulkCreateParams, SignalSourceHit, WrapHits } from '../../signals/types'; +import { buildBulkBody } from './utils/build_bulk_body'; +import { generateId } from '../../signals/utils'; +import { filterDuplicateSignals } from '../../signals/filter_duplicate_signals'; +import type { ConfigType } from '../../../../config'; +import { WrappedRACAlert } from '../types'; + +export const wrapHitsFactory = ({ + ruleSO, + mergeStrategy, +}: { + ruleSO: SearchAfterAndBulkCreateParams['ruleSO']; + mergeStrategy: ConfigType['alertMergeStrategy']; +}): WrapHits => (events) => { + const wrappedDocs: WrappedRACAlert[] = events.flatMap((doc) => [ + { + _index: '', + _id: generateId( + doc._index, + doc._id, + String(doc._version), + ruleSO.attributes.params.ruleId ?? '' + ), + _source: buildBulkBody(ruleSO, doc as SignalSourceHit, mergeStrategy), + }, + ]); + + return filterDuplicateSignals(ruleSO.id, wrappedDocs, true); +}; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/field_maps/alerts.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/field_maps/alerts.ts new file mode 100644 index 0000000000000..244905329f8ca --- /dev/null +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/field_maps/alerts.ts @@ -0,0 +1,298 @@ +/* + * Copyright 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 { FieldMap } from '../../../../../../rule_registry/common/field_map'; + +export const alertsFieldMap: FieldMap = { + 'kibana.alert.ancestors': { + type: 'object', + array: true, + required: true, + }, + 'kibana.alert.ancestors.depth': { + type: 'long', + array: false, + required: true, + }, + 'kibana.alert.ancestors.id': { + type: 'keyword', + array: false, + required: true, + }, + 'kibana.alert.ancestors.index': { + type: 'keyword', + array: false, + required: true, + }, + 'kibana.alert.ancestors.rule': { + type: 'keyword', + array: false, + required: false, + }, + 'kibana.alert.ancestors.type': { + type: 'keyword', + array: false, + required: true, + }, + 'kibana.alert.depth': { + type: 'long', + array: false, + required: true, + }, + 'kibana.alert.original_event': { + type: 'object', + array: false, + required: false, + }, + 'kibana.alert.original_event.action': { + type: 'keyword', + array: false, + required: true, + }, + 'kibana.alert.original_event.agent_id_status': { + type: 'keyword', + array: false, + required: false, + }, + 'kibana.alert.original_event.category': { + type: 'keyword', + array: true, + required: true, + }, + 'kibana.alert.original_event.code': { + type: 'keyword', + array: false, + required: false, + }, + 'kibana.alert.original_event.created': { + type: 'date', + array: false, + required: true, + }, + 'kibana.alert.original_event.dataset': { + type: 'keyword', + array: false, + required: true, + }, + 'kibana.alert.original_event.duration': { + type: 'keyword', + array: false, + required: false, + }, + 'kibana.alert.original_event.end': { + type: 'date', + array: false, + required: false, + }, + 'kibana.alert.original_event.hash': { + type: 'keyword', + array: false, + required: false, + }, + 'kibana.alert.original_event.id': { + type: 'keyword', + array: false, + required: true, + }, + 'kibana.alert.original_event.ingested': { + type: 'date', + array: false, + required: true, + }, + 'kibana.alert.original_event.kind': { + type: 'keyword', + array: false, + required: true, + }, + 'kibana.alert.original_event.module': { + type: 'keyword', + array: false, + required: true, + }, + 'kibana.alert.original_event.original': { + type: 'keyword', + array: false, + required: true, + }, + 'kibana.alert.original_event.outcome': { + type: 'keyword', + array: false, + required: true, + }, + 'kibana.alert.original_event.provider': { + type: 'keyword', + array: false, + required: true, + }, + 'kibana.alert.original_event.reason': { + type: 'keyword', + array: false, + required: false, + }, + 'kibana.alert.original_event.reference': { + type: 'keyword', + array: false, + required: false, + }, + 'kibana.alert.original_event.risk_score': { + type: 'float', + array: false, + required: false, + }, + 'kibana.alert.original_event.risk_score_norm': { + type: 'float', + array: false, + required: false, + }, + 'kibana.alert.original_event.sequence': { + type: 'long', + array: false, + required: true, + }, + 'kibana.alert.original_event.start': { + type: 'date', + array: false, + required: false, + }, + 'kibana.alert.original_event.timezone': { + type: 'keyword', + array: false, + required: false, + }, + 'kibana.alert.original_event.type': { + type: 'keyword', + array: true, + required: true, + }, + 'kibana.alert.original_event.url': { + type: 'keyword', + array: false, + required: false, + }, + 'kibana.alert.original_time': { + type: 'date', + array: false, + required: true, + }, + 'kibana.alert.threat': { + type: 'object', + array: false, + required: false, + }, + 'kibana.alert.threat.framework': { + type: 'keyword', + array: false, + required: true, + }, + 'kibana.alert.threat.tactic': { + type: 'object', + array: false, + required: true, + }, + 'kibana.alert.threat.tactic.id': { + type: 'keyword', + array: false, + required: true, + }, + 'kibana.alert.threat.tactic.name': { + type: 'keyword', + array: false, + required: true, + }, + 'kibana.alert.threat.tactic.reference': { + type: 'keyword', + array: false, + required: true, + }, + 'kibana.alert.threat.technique': { + type: 'object', + array: false, + required: true, + }, + 'kibana.alert.threat.technique.id': { + type: 'keyword', + array: false, + required: true, + }, + 'kibana.alert.threat.technique.name': { + type: 'keyword', + array: false, + required: true, + }, + 'kibana.alert.threat.technique.reference': { + type: 'keyword', + array: false, + required: true, + }, + 'kibana.alert.threat.technique.subtechnique': { + type: 'object', + array: false, + required: true, + }, + 'kibana.alert.threat.technique.subtechnique.id': { + type: 'keyword', + array: false, + required: true, + }, + 'kibana.alert.threat.technique.subtechnique.name': { + type: 'keyword', + array: false, + required: true, + }, + 'kibana.alert.threat.technique.subtechnique.reference': { + type: 'keyword', + array: false, + required: true, + }, + 'kibana.alert.threshold_result': { + type: 'object', + array: false, + required: false, + }, + 'kibana.alert.threshold_result.cardinality': { + type: 'object', + array: false, + required: false, + }, + 'kibana.alert.threshold_result.cardinality.field': { + type: 'keyword', + array: false, + required: false, + }, + 'kibana.alert.threshold_result.cardinality.value': { + type: 'long', + array: false, + required: false, + }, + 'kibana.alert.threshold_result.count': { + type: 'long', + array: false, + required: false, + }, + 'kibana.alert.threshold_result.from': { + type: 'date', + array: false, + required: false, + }, + 'kibana.alert.threshold_result.terms': { + type: 'object', + array: false, + required: false, + }, + 'kibana.alert.threshold_result.terms.field': { + type: 'keyword', + array: false, + required: false, + }, + 'kibana.alert.threshold_result.terms.value': { + type: 'keyword', + array: false, + required: false, + }, +} as const; + +export type AlertsFieldMap = typeof alertsFieldMap; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/field_maps/index.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/field_maps/index.ts new file mode 100644 index 0000000000000..0f19e2b3d3a91 --- /dev/null +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/field_maps/index.ts @@ -0,0 +1,10 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { AlertsFieldMap, alertsFieldMap } from './alerts'; +import { RulesFieldMap, rulesFieldMap } from './rules'; +export { AlertsFieldMap, RulesFieldMap, alertsFieldMap, rulesFieldMap }; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/field_maps/rules.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/field_maps/rules.ts new file mode 100644 index 0000000000000..21405672fdf7f --- /dev/null +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/field_maps/rules.ts @@ -0,0 +1,136 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +export const rulesFieldMap = { + 'kibana.alert.rule.building_block_type': { + type: 'keyword', + array: false, + required: false, + }, + 'kibana.alert.rule.false_positives': { + type: 'keyword', + array: true, + required: true, + }, + 'kibana.alert.rule.immutable': { + type: 'keyword', + array: true, + required: false, + }, + 'kibana.alert.rule.index': { + type: 'keyword', + array: true, + required: true, + }, + 'kibana.alert.rule.language': { + type: 'keyword', + array: true, + required: true, + }, + 'kibana.alert.rule.max_signals': { + type: 'long', + array: true, + required: true, + }, + 'kibana.alert.rule.query': { + type: 'keyword', + array: true, + required: true, + }, + 'kibana.alert.rule.saved_id': { + type: 'keyword', + array: true, + required: true, + }, + 'kibana.alert.rule.threat_filters': { + type: 'keyword', + array: true, + required: false, + }, + 'kibana.alert.rule.threat_index': { + type: 'keyword', + array: true, + required: false, + }, + 'kibana.alert.rule.threat_indicator_path': { + type: 'keyword', + array: true, + required: false, + }, + 'kibana.alert.rule.threat_language': { + type: 'keyword', + array: true, + required: false, + }, + 'kibana.alert.rule.threat_mapping': { + type: 'object', + array: true, + required: false, + }, + 'kibana.alert.rule.threat_mapping.field': { + type: 'keyword', + array: true, + required: false, + }, + 'kibana.alert.rule.threat_mapping.value': { + type: 'keyword', + array: true, + required: false, + }, + 'kibana.alert.rule.threat_mapping.type': { + type: 'keyword', + array: true, + required: false, + }, + 'kibana.alert.rule.threat_query': { + type: 'keyword', + array: true, + required: false, + }, + 'kibana.alert.rule.threshold': { + type: 'object', + array: true, + required: false, + }, + 'kibana.alert.rule.threshold.field': { + type: 'keyword', + array: true, + required: false, + }, + 'kibana.alert.rule.threshold.value': { + type: 'float', // TODO: should be 'long' (eventually, after we stabilize) + array: true, + required: false, + }, + 'kibana.alert.rule.threshold.cardinality': { + type: 'object', + array: true, + required: false, + }, + 'kibana.alert.rule.threshold.cardinality.field': { + type: 'keyword', + array: true, + required: false, + }, + 'kibana.alert.rule.threshold.cardinality.value': { + type: 'long', + array: true, + required: false, + }, + 'kibana.alert.rule.timeline_id': { + type: 'keyword', + array: true, + required: false, + }, + 'kibana.alert.rule.timeline_title': { + type: 'keyword', + array: true, + required: false, + }, +} as const; + +export type RulesFieldMap = typeof rulesFieldMap; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/index.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/index.ts new file mode 100644 index 0000000000000..1b1fe48be00e0 --- /dev/null +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/index.ts @@ -0,0 +1,8 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +export { createQueryAlertType } from './query/create_query_alert_type'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/ml.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/ml.ts similarity index 100% rename from x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/ml.ts rename to x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/ml.ts diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/query.test.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/create_query_alert_type.test.ts similarity index 55% rename from x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/query.test.ts rename to x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/create_query_alert_type.test.ts index e8c45e9ab7056..0127477e4800a 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/query.test.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/create_query_alert_type.test.ts @@ -10,21 +10,47 @@ import { v4 } from 'uuid'; // eslint-disable-next-line @kbn/eslint/no-restricted-paths import { elasticsearchClientMock } from 'src/core/server/elasticsearch/client/mocks'; -import { sampleDocNoSortId } from '../signals/__mocks__/es_results'; +import { allowedExperimentalValues } from '../../../../../common/experimental_features'; +import { sampleDocNoSortId } from '../../signals/__mocks__/es_results'; +import { createQueryAlertType } from './create_query_alert_type'; +import { createRuleTypeMocks } from '../__mocks__/rule_type'; -import { createQueryAlertType } from './query'; -import { createRuleTypeMocks } from './__mocks__/rule_type'; +jest.mock('../utils/get_list_client', () => ({ + getListClient: jest.fn().mockReturnValue({ + listClient: jest.fn(), + exceptionsClient: jest.fn(), + }), +})); + +jest.mock('../../signals/rule_status_service', () => ({ + ruleStatusServiceFactory: () => ({ + goingToRun: jest.fn(), + success: jest.fn(), + partialFailure: jest.fn(), + error: jest.fn(), + }), +})); describe('Custom query alerts', () => { it('does not send an alert when no events found', async () => { const { services, dependencies, executor } = createRuleTypeMocks(); - const queryAlertType = createQueryAlertType(dependencies.ruleDataClient, dependencies.logger); + const queryAlertType = createQueryAlertType({ + experimentalFeatures: allowedExperimentalValues, + indexAlias: 'alerts.security-alerts', + lists: dependencies.lists, + logger: dependencies.logger, + mergeStrategy: 'allFields', + ruleDataClient: dependencies.ruleDataClient, + version: '1.0.0', + }); dependencies.alerting.registerType(queryAlertType); const params = { - customQuery: 'dne:42', - indexPatterns: ['*'], + query: 'dne:42', + index: ['*'], + from: 'now-1m', + to: 'now', }; services.scopedClusterClient.asCurrentUser.search.mockReturnValue( @@ -50,18 +76,28 @@ describe('Custom query alerts', () => { ); await executor({ params }); - expect(services.alertInstanceFactory).not.toBeCalled(); + expect(dependencies.ruleDataClient.getWriter).not.toBeCalled(); }); it('sends a properly formatted alert when events are found', async () => { const { services, dependencies, executor } = createRuleTypeMocks(); - const queryAlertType = createQueryAlertType(dependencies.ruleDataClient, dependencies.logger); + const queryAlertType = createQueryAlertType({ + experimentalFeatures: allowedExperimentalValues, + indexAlias: 'alerts.security-alerts', + lists: dependencies.lists, + logger: dependencies.logger, + mergeStrategy: 'allFields', + ruleDataClient: dependencies.ruleDataClient, + version: '1.0.0', + }); dependencies.alerting.registerType(queryAlertType); const params = { - customQuery: '*:*', - indexPatterns: ['*'], + query: '*:*', + index: ['*'], + from: 'now-1m', + to: 'now', }; services.scopedClusterClient.asCurrentUser.search.mockReturnValue( @@ -85,15 +121,6 @@ describe('Custom query alerts', () => { ); await executor({ params }); - expect(services.alertInstanceFactory).toBeCalled(); - /* - expect(services.alertWithPersistence).toBeCalledWith( - expect.arrayContaining([ - expect.objectContaining({ - 'event.kind': 'signal', - }), - ]) - ); - */ + expect(dependencies.ruleDataClient.getWriter).toBeCalled(); }); }); diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/create_query_alert_type.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/create_query_alert_type.ts new file mode 100644 index 0000000000000..3321597d8268f --- /dev/null +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/create_query_alert_type.ts @@ -0,0 +1,111 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { Logger } from '@kbn/logging'; +import { validateNonExact } from '@kbn/securitysolution-io-ts-utils'; + +import { PersistenceServices, RuleDataClient } from '../../../../../../rule_registry/server'; +import { QUERY_ALERT_TYPE_ID } from '../../../../../common/constants'; +import { ExperimentalFeatures } from '../../../../../common/experimental_features'; +import { ConfigType } from '../../../../config'; +import { SetupPlugins } from '../../../../plugin'; + +import { queryRuleParams, QueryRuleParams } from '../../schemas/rule_schemas'; +import { queryExecutor } from '../../signals/executors/query'; + +import { createSecurityRuleTypeFactory } from '../create_security_rule_type_factory'; + +export const createQueryAlertType = (createOptions: { + experimentalFeatures: ExperimentalFeatures; + indexAlias: string; + lists: SetupPlugins['lists']; + logger: Logger; + mergeStrategy: ConfigType['alertMergeStrategy']; + ruleDataClient: RuleDataClient; + version: string; +}) => { + const { + experimentalFeatures, + indexAlias, + lists, + logger, + mergeStrategy, + ruleDataClient, + version, + } = createOptions; + const createSecurityRuleType = createSecurityRuleTypeFactory({ + indexAlias, + lists, + logger, + mergeStrategy, + ruleDataClient, + }); + return createSecurityRuleType({ + id: QUERY_ALERT_TYPE_ID, + name: 'Custom Query Rule', + validate: { + params: { + validate: (object: unknown) => { + const [validated, errors] = validateNonExact(object, queryRuleParams); + if (errors != null) { + throw new Error(errors); + } + if (validated == null) { + throw new Error('Validation of rule params failed'); + } + return validated; + }, + }, + }, + actionGroups: [ + { + id: 'default', + name: 'Default', + }, + ], + defaultActionGroupId: 'default', + actionVariables: { + context: [{ name: 'server', description: 'the server' }], + }, + minimumLicenseRequired: 'basic', + isExportable: false, + producer: 'security-solution', + async executor(execOptions) { + const { + runOpts: { + buildRuleMessage, + bulkCreate, + exceptionItems, + listClient, + rule, + searchAfterSize, + tuple, + wrapHits, + }, + services, + state, + } = execOptions; + + const result = await queryExecutor({ + buildRuleMessage, + bulkCreate, + exceptionItems, + experimentalFeatures, + eventsTelemetry: undefined, + listClient, + logger, + rule, + searchAfterSize, + services, + tuple, + version, + wrapHits, + }); + return { ...result, state }; + }, + }); +}; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/scripts/create_reference_rule_query.sh b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/scripts/create_rule_query.sh similarity index 55% rename from x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/scripts/create_reference_rule_query.sh rename to x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/scripts/create_rule_query.sh index b1d614e98ccae..aa632afc52095 100755 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/reference_rules/scripts/create_reference_rule_query.sh +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/scripts/create_rule_query.sh @@ -14,11 +14,30 @@ curl -X POST ${KIBANA_URL}${SPACE_URL}/api/alerts/alert \ -d ' { "params":{ - "indexPatterns": ["*"], - "customQuery": "*:*" + "author": [], + "description": "Basic custom query rule", + "exceptionsList": [], + "falsePositives": [], + "from": "now-300s", + "query": "*:*", + "immutable": false, + "index": ["*"], + "language": "kuery", + "maxSignals": 10, + "outputIndex": "", + "references": [], + "riskScore": 21, + "riskScoreMapping": [], + "ruleId": "81dec1ba-b779-469c-9667-6b0e865fb86b", + "severity": "low", + "severityMapping": [], + "threat": [], + "to": "now", + "type": "query", + "version": 1 }, "consumer":"alerts", - "alertTypeId":"siem.customRule", + "alertTypeId":"siem.queryRule", "schedule":{ "interval":"1m" }, diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/types.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/types.ts new file mode 100644 index 0000000000000..dc4cbba680b25 --- /dev/null +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/types.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; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { SearchHit } from '@elastic/elasticsearch/api/types'; +import { Logger } from '@kbn/logging'; +import { ExceptionListItemSchema } from '@kbn/securitysolution-io-ts-list-types'; +import { Moment } from 'moment'; +import { SavedObject } from '../../../../../../../src/core/server'; +import { + AlertInstanceContext, + AlertInstanceState, + AlertTypeParams, + AlertTypeState, +} from '../../../../../alerting/common'; +import { AlertType } from '../../../../../alerting/server'; +import { ListClient } from '../../../../../lists/server'; +import { TechnicalRuleFieldMap } from '../../../../../rule_registry/common/assets/field_maps/technical_rule_field_map'; +import { TypeOfFieldMap } from '../../../../../rule_registry/common/field_map'; +import { + AlertTypeWithExecutor, + PersistenceServices, + RuleDataClient, +} from '../../../../../rule_registry/server'; +import { BaseHit } from '../../../../common/detection_engine/types'; +import { ConfigType } from '../../../config'; +import { SetupPlugins } from '../../../plugin'; +import { RuleParams } from '../schemas/rule_schemas'; +import { BuildRuleMessage } from '../signals/rule_messages'; +import { AlertAttributes, BulkCreate, WrapHits } from '../signals/types'; +import { AlertsFieldMap, RulesFieldMap } from './field_maps'; + +export interface SecurityAlertTypeReturnValue { + bulkCreateTimes: string[]; + createdSignalsCount: number; + createdSignals: unknown[]; + errors: string[]; + lastLookbackDate?: Date | null; + searchAfterTimes: string[]; + state: TState; + success: boolean; + warning: boolean; + warningMessages: string[]; +} + +type SimpleAlertType< + TState extends AlertTypeState, + TParams extends AlertTypeParams = {}, + TAlertInstanceContext extends AlertInstanceContext = {} +> = AlertType; + +export interface RunOpts { + buildRuleMessage: BuildRuleMessage; + bulkCreate: BulkCreate; + exceptionItems: ExceptionListItemSchema[]; + listClient: ListClient; + rule: SavedObject>; + searchAfterSize: number; + tuple: { + to: Moment; + from: Moment; + maxSignals: number; + }; + wrapHits: WrapHits; +} + +export type SecurityAlertTypeExecutor< + TState extends AlertTypeState, + TServices extends PersistenceServices, + TParams extends RuleParams, + TAlertInstanceContext extends AlertInstanceContext = {} +> = ( + options: Parameters['executor']>[0] & { + runOpts: RunOpts; + } & { services: TServices } +) => Promise>; + +type SecurityAlertTypeWithExecutor< + TState extends AlertTypeState, + TServices extends PersistenceServices, + TParams extends RuleParams, + TAlertInstanceContext extends AlertInstanceContext = {} +> = Omit< + AlertType, + 'executor' +> & { + executor: SecurityAlertTypeExecutor; +}; + +export type CreateSecurityRuleTypeFactory = (options: { + indexAlias: string; + lists: SetupPlugins['lists']; + logger: Logger; + mergeStrategy: ConfigType['alertMergeStrategy']; + ruleDataClient: RuleDataClient; +}) => < + TParams extends RuleParams & { index: string[] | undefined }, + TAlertInstanceContext extends AlertInstanceContext, + TServices extends PersistenceServices, + TState extends AlertTypeState +>( + type: SecurityAlertTypeWithExecutor + // eslint-disable-next-line @typescript-eslint/no-explicit-any +) => AlertTypeWithExecutor; + +export type RACAlertSignal = TypeOfFieldMap & TypeOfFieldMap; +export type RACAlert = Exclude< + TypeOfFieldMap & RACAlertSignal, + '@timestamp' +> & { + '@timestamp': string; +}; + +export type RACSourceHit = SearchHit; +export type WrappedRACAlert = BaseHit; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/get_list_client.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/get_list_client.ts new file mode 100644 index 0000000000000..83a473799068a --- /dev/null +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/get_list_client.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 { ElasticsearchClient, SavedObjectsClientContract } from 'src/core/server'; +import { ExceptionListClient, ListClient, ListPluginSetup } from '../../../../../../lists/server'; + +export const getListClient = ({ + lists, + spaceId, + updatedByUser, + esClient, + savedObjectClient, +}: { + lists: ListPluginSetup | undefined; + spaceId: string; + updatedByUser: string | null; + esClient: ElasticsearchClient; + savedObjectClient: SavedObjectsClientContract; +}): { + listClient: ListClient; + exceptionsClient: ExceptionListClient; +} => { + if (lists == null) { + throw new Error('lists plugin unavailable during rule execution'); + } + + const listClient = lists.getListClient(esClient, spaceId, updatedByUser ?? 'elastic'); + const exceptionsClient = lists.getExceptionListClient( + savedObjectClient, + updatedByUser ?? 'elastic' + ); + + return { listClient, exceptionsClient }; +}; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/index.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/index.ts new file mode 100644 index 0000000000000..03cdcc6ef5c52 --- /dev/null +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/utils/index.ts @@ -0,0 +1,25 @@ +/* + * Copyright 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 { AlertTypeState } from '../../../../../../alerting/server'; +import { SecurityAlertTypeReturnValue } from '../types'; + +export const createResultObject = (state: TState) => { + const result: SecurityAlertTypeReturnValue = { + bulkCreateTimes: [], + createdSignalsCount: 0, + createdSignals: [], + errors: [], + lastLookbackDate: undefined, + searchAfterTimes: [], + state, + success: true, + warning: false, + warningMessages: [], + }; + return result; +}; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/bulk_create_factory.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/bulk_create_factory.ts index f518ac2386d0b..80d1ebf800191 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/bulk_create_factory.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/bulk_create_factory.ts @@ -7,6 +7,7 @@ import { performance } from 'perf_hooks'; import { countBy, isEmpty, get } from 'lodash'; + import { ElasticsearchClient, Logger } from 'kibana/server'; import { BuildRuleMessage } from './rule_messages'; import { RefreshTypes } from '../types'; diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/executors/query.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/executors/query.ts index 454cb464506a9..f27680315d194 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/executors/query.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/executors/query.ts @@ -59,6 +59,7 @@ export const queryExecutor = async ({ version, index: ruleParams.index, }); + const esFilter = await getFilter({ type: ruleParams.type, filters: ruleParams.filters, diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filter_duplicate_signals.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filter_duplicate_signals.ts index 0b9859fad7688..fb562a2d11f0a 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filter_duplicate_signals.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/filter_duplicate_signals.ts @@ -5,7 +5,8 @@ * 2.0. */ -import { SimpleHit, WrappedSignalHit } from './types'; +import { WrappedRACAlert } from '../rule_types/types'; +import { Ancestor, SimpleHit, WrappedSignalHit } from './types'; const isWrappedSignalHit = ( signals: SimpleHit[], @@ -14,6 +15,13 @@ const isWrappedSignalHit = ( return !isRuleRegistryEnabled; }; +const isWrappedRACAlert = ( + signals: SimpleHit[], + isRuleRegistryEnabled: boolean +): signals is WrappedRACAlert[] => { + return isRuleRegistryEnabled; +}; + export const filterDuplicateSignals = ( ruleId: string, signals: SimpleHit[], @@ -23,8 +31,14 @@ export const filterDuplicateSignals = ( return signals.filter( (doc) => !doc._source.signal?.ancestors.some((ancestor) => ancestor.rule === ruleId) ); + } else if (isWrappedRACAlert(signals, isRuleRegistryEnabled)) { + return signals.filter( + (doc) => + !(doc._source['kibana.alert.ancestors'] as Ancestor[]).some( + (ancestor) => ancestor.rule === ruleId + ) + ); } else { - // TODO: filter duplicate signals for RAC - return []; + return signals; } }; 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 75cffb598d186..7b5b61577cf32 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 @@ -155,6 +155,7 @@ export const searchAfterAndBulkCreate = async ({ success: bulkSuccess, errors: bulkErrors, } = await bulkCreate(wrappedDocs); + toReturn = mergeReturns([ toReturn, createSearchAfterReturnType({ diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/signal_rule_alert_type.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/signal_rule_alert_type.ts index d524757b7c144..d1cb7194f86ee 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/signal_rule_alert_type.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/signal_rule_alert_type.ts @@ -401,12 +401,8 @@ export const signalRulesAlertType = ({ logger.info( buildRuleMessage( `[+] Finished indexing ${result.createdSignalsCount} ${ - !isEmpty(result.totalToFromTuples) - ? `signals searched between date ranges ${JSON.stringify( - result.totalToFromTuples, - null, - 2 - )}` + !isEmpty(tuples) + ? `signals searched between date ranges ${JSON.stringify(tuples, null, 2)}` : '' }` ) 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 dbc6848335893..4ad734c3bf7d9 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 @@ -7,7 +7,7 @@ import type { estypes } from '@elastic/elasticsearch'; import { DslQuery, Filter } from '@kbn/es-query'; -import moment, { Moment } from 'moment'; +import moment from 'moment'; import type { ExceptionListItemSchema } from '@kbn/securitysolution-io-ts-list-types'; import { Status } from '../../../../common/detection_engine/schemas/common/schemas'; import { RulesSchema } from '../../../../common/detection_engine/schemas/response/rules_schema'; @@ -111,6 +111,8 @@ export interface SignalSource { }; rule: { id: string; + false_positives?: string[]; + immutable?: boolean; }; /** signal.depth was introduced in 7.10 and pre-7.10 signals do not have it. */ depth?: number; @@ -275,7 +277,7 @@ export type BulkCreate = (docs: Array>) => Promise; -export type WrapHits = (hits: Array>) => SimpleHit[]; +export type WrapHits = (hits: estypes.SearchHit[]) => SimpleHit[]; export type WrapSequences = (sequences: Array>) => SimpleHit[]; @@ -314,11 +316,6 @@ export interface SearchAfterAndBulkCreateReturnType { createdSignals: unknown[]; errors: string[]; warningMessages: string[]; - totalToFromTuples?: Array<{ - to: Moment | undefined; - from: Moment | undefined; - maxSignals: number; - }>; } export interface ThresholdAggregationBucket extends TermAggregationBucket { diff --git a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/wrap_hits_factory.ts b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/wrap_hits_factory.ts index b28c46aae8f82..5cef740e17895 100644 --- a/x-pack/plugins/security_solution/server/lib/detection_engine/signals/wrap_hits_factory.ts +++ b/x-pack/plugins/security_solution/server/lib/detection_engine/signals/wrap_hits_factory.ts @@ -5,7 +5,12 @@ * 2.0. */ -import { SearchAfterAndBulkCreateParams, WrapHits, WrappedSignalHit } from './types'; +import { + SearchAfterAndBulkCreateParams, + SignalSourceHit, + WrapHits, + WrappedSignalHit, +} from './types'; import { generateId } from './utils'; import { buildBulkBody } from './build_bulk_body'; import { filterDuplicateSignals } from './filter_duplicate_signals'; @@ -29,7 +34,7 @@ export const wrapHitsFactory = ({ String(doc._version), ruleSO.attributes.params.ruleId ?? '' ), - _source: buildBulkBody(ruleSO, doc, mergeStrategy), + _source: buildBulkBody(ruleSO, doc as SignalSourceHit, mergeStrategy), }, ]); diff --git a/x-pack/plugins/security_solution/server/plugin.ts b/x-pack/plugins/security_solution/server/plugin.ts index dd6081b6c9127..96171154f6007 100644 --- a/x-pack/plugins/security_solution/server/plugin.ts +++ b/x-pack/plugins/security_solution/server/plugin.ts @@ -27,7 +27,6 @@ import { PluginStartContract as AlertPluginStartContract, } from '../../alerting/server'; import { mappingFromFieldMap } from '../../rule_registry/common/mapping_from_field_map'; -import { technicalRuleFieldMap } from '../../rule_registry/common/assets/field_maps/technical_rule_field_map'; import { PluginStartContract as CasesPluginStartContract } from '../../cases/server'; import { @@ -48,9 +47,7 @@ import { SpacesPluginSetup as SpacesSetup } from '../../spaces/server'; import { ILicense, LicensingPluginStart } from '../../licensing/server'; import { FleetStartContract } from '../../fleet/server'; import { TaskManagerSetupContract, TaskManagerStartContract } from '../../task_manager/server'; -import { createQueryAlertType } from './lib/detection_engine/reference_rules/query'; -import { createEqlAlertType } from './lib/detection_engine/reference_rules/eql'; -import { createThresholdAlertType } from './lib/detection_engine/reference_rules/threshold'; +import { createQueryAlertType } from './lib/detection_engine/rule_types'; import { initRoutes } from './routes'; import { isAlertExecutor } from './lib/detection_engine/signals/types'; import { signalRulesAlertType } from './lib/detection_engine/signals/signal_rule_alert_type'; @@ -66,9 +63,7 @@ import { SERVER_APP_ID, SIGNALS_ID, NOTIFICATIONS_ID, - REFERENCE_RULE_ALERT_TYPE_ID, - REFERENCE_RULE_PERSISTENCE_ALERT_TYPE_ID, - CUSTOM_ALERT_TYPE_ID, + QUERY_ALERT_TYPE_ID, DEFAULT_SPACE_ID, } from '../common/constants'; import { registerEndpointRoutes } from './endpoint/routes/metadata'; @@ -92,6 +87,8 @@ import { licenseService } from './lib/license'; import { PolicyWatcher } from './endpoint/lib/policy/license_watch'; import { parseExperimentalConfigValue } from '../common/experimental_features'; import { migrateArtifactsToFleet } from './endpoint/lib/artifacts/migrate_artifacts_to_fleet'; +import { alertsFieldMap } from './lib/detection_engine/rule_types/field_maps/alerts'; +import { rulesFieldMap } from './lib/detection_engine/rule_types/field_maps/rules'; import { RuleExecutionLogClient } from './lib/detection_engine/rule_execution_log/rule_execution_log_client'; import { getKibanaPrivilegesFeaturePrivileges } from './features'; import { EndpointMetadataService } from './endpoint/services/metadata'; @@ -223,7 +220,7 @@ export class Plugin implements IPlugin initializeRuleDataTemplatesPromise ); - // Register reference rule types via rule-registry - this.setupPlugins.alerting.registerType(createQueryAlertType(ruleDataClient, this.logger)); - this.setupPlugins.alerting.registerType(createEqlAlertType(ruleDataClient, this.logger)); + // Register rule types via rule-registry this.setupPlugins.alerting.registerType( - createThresholdAlertType(ruleDataClient, this.logger) + createQueryAlertType({ + experimentalFeatures, + indexAlias, + lists: plugins.lists, + logger: this.logger, + mergeStrategy: this.config.alertMergeStrategy, + ruleDataClient, + version: this.context.env.packageInfo.version, + }) ); } - // TO DO We need to get the endpoint routes inside of initRoutes + // TODO We need to get the endpoint routes inside of initRoutes initRoutes( router, config, @@ -277,15 +282,11 @@ export class Plugin implements IPlugin({ type: AlertingAuthorizationFilterType.ESDSL, // Not passing in values, these are the paths for these fields fieldNames: { - consumer: OWNER, + consumer: ALERT_OWNER, ruleTypeId: RULE_ID, spaceIds: SPACE_IDS, }, diff --git a/x-pack/plugins/uptime/public/lib/alert_types/duration_anomaly.tsx b/x-pack/plugins/uptime/public/lib/alert_types/duration_anomaly.tsx index f14c1a4a9fdde..68036ea047866 100644 --- a/x-pack/plugins/uptime/public/lib/alert_types/duration_anomaly.tsx +++ b/x-pack/plugins/uptime/public/lib/alert_types/duration_anomaly.tsx @@ -8,12 +8,12 @@ import React from 'react'; import moment from 'moment'; -import { CLIENT_ALERT_TYPES } from '../../../common/constants/alerts'; -import { DurationAnomalyTranslations } from '../../../common/translations'; -import { AlertTypeInitializer } from '.'; +import { ALERT_END, ALERT_STATUS } from '@kbn/rule-data-utils'; +import { AlertTypeInitializer } from '.'; import { getMonitorRouteFromMonitorId } from './common'; - +import { CLIENT_ALERT_TYPES } from '../../../common/constants/alerts'; +import { DurationAnomalyTranslations } from '../../../common/translations'; import { ObservabilityRuleTypeModel } from '../../../../observability/public'; const { defaultActionMessage, description } = DurationAnomalyTranslations; @@ -39,8 +39,7 @@ export const initDurationAnomalyAlertType: AlertTypeInitializer = ({ reason: fields.reason, link: getMonitorRouteFromMonitorId({ monitorId: fields['monitor.id']!, - dateRangeEnd: - fields['kibana.rac.alert.status'] === 'open' ? 'now' : fields['kibana.rac.alert.end']!, + dateRangeEnd: fields[ALERT_STATUS] === 'open' ? 'now' : fields[ALERT_END]!, dateRangeStart: moment(new Date(fields['anomaly.start']!)).subtract('5', 'm').toISOString(), }), }), diff --git a/x-pack/plugins/uptime/public/lib/alert_types/monitor_status.tsx b/x-pack/plugins/uptime/public/lib/alert_types/monitor_status.tsx index a87ba4aedbb2a..7bd50fce52f3a 100644 --- a/x-pack/plugins/uptime/public/lib/alert_types/monitor_status.tsx +++ b/x-pack/plugins/uptime/public/lib/alert_types/monitor_status.tsx @@ -8,15 +8,14 @@ import React from 'react'; import moment from 'moment'; -import { ObservabilityRuleTypeModel } from '../../../../observability/public'; -import { ValidationResult } from '../../../../triggers_actions_ui/public'; - -import { CLIENT_ALERT_TYPES } from '../../../common/constants/alerts'; -import { MonitorStatusTranslations } from '../../../common/translations'; - -import { getMonitorRouteFromMonitorId } from './common'; +import { ALERT_END, ALERT_START, ALERT_STATUS } from '@kbn/rule-data-utils'; import { AlertTypeInitializer } from '.'; +import { getMonitorRouteFromMonitorId } from './common'; +import { MonitorStatusTranslations } from '../../../common/translations'; +import { CLIENT_ALERT_TYPES } from '../../../common/constants/alerts'; +import { ObservabilityRuleTypeModel } from '../../../../observability/public'; +import { ValidationResult } from '../../../../triggers_actions_ui/public'; const { defaultActionMessage, description } = MonitorStatusTranslations; @@ -54,11 +53,8 @@ export const initMonitorStatusAlertType: AlertTypeInitializer = ({ reason: fields.reason, link: getMonitorRouteFromMonitorId({ monitorId: fields['monitor.id']!, - dateRangeEnd: - fields['kibana.rac.alert.status'] === 'open' ? 'now' : fields['kibana.rac.alert.end']!, - dateRangeStart: moment(new Date(fields['kibana.rac.alert.start']!)) - .subtract('5', 'm') - .toISOString(), + dateRangeEnd: fields[ALERT_STATUS] === 'open' ? 'now' : fields[ALERT_END]!, + dateRangeStart: moment(new Date(fields[ALERT_START]!)).subtract('5', 'm').toISOString(), filters: { 'observer.geo.name': [fields['observer.geo.name'][0]], }, diff --git a/x-pack/plugins/uptime/server/lib/alerts/status_check.test.ts b/x-pack/plugins/uptime/server/lib/alerts/status_check.test.ts index dbb199a2e07d8..13c0c48eb28f8 100644 --- a/x-pack/plugins/uptime/server/lib/alerts/status_check.test.ts +++ b/x-pack/plugins/uptime/server/lib/alerts/status_check.test.ts @@ -149,13 +149,13 @@ describe('status check alert', () => { const alert = statusCheckAlertFactory(server, libs, plugins); // @ts-ignore the executor can return `void`, but ours never does const options = mockOptions(); - const state: Record = await alert.executor(options); + const state: Record | void = await alert.executor(options); const { services: { alertWithLifecycle }, } = options; expect(state).not.toBeUndefined(); - expect(state?.isTriggered).toBe(false); + expect(state instanceof Object ? state.isTriggered : true).toBe(false); expect(alertWithLifecycle).not.toHaveBeenCalled(); expect(mockGetter).toHaveBeenCalledTimes(1); expect(mockGetter.mock.calls[0][0]).toEqual( diff --git a/x-pack/plugins/uptime/server/lib/alerts/types.ts b/x-pack/plugins/uptime/server/lib/alerts/types.ts index 28f9eba7ab381..f4ac2f354d814 100644 --- a/x-pack/plugins/uptime/server/lib/alerts/types.ts +++ b/x-pack/plugins/uptime/server/lib/alerts/types.ts @@ -6,8 +6,9 @@ */ import { UptimeCorePlugins, UptimeCoreSetup } from '../adapters'; import { UMServerLibs } from '../lib'; -import { AlertTypeWithExecutor, LifecycleAlertService } from '../../../../rule_registry/server'; -import { AlertInstanceContext } from '../../../../alerting/common'; +import { AlertTypeWithExecutor } from '../../../../rule_registry/server'; +import { AlertInstanceContext, AlertTypeState } from '../../../../alerting/common'; +import { LifecycleAlertService } from '../../../../rule_registry/server'; /** * Because all of our types are presumably going to list the `producer` as `'uptime'`, @@ -16,10 +17,15 @@ import { AlertInstanceContext } from '../../../../alerting/common'; * When we register all the alerts we can inject this field. */ export type DefaultUptimeAlertInstance = AlertTypeWithExecutor< + Record, Record, AlertInstanceContext, { - alertWithLifecycle: LifecycleAlertService; + alertWithLifecycle: LifecycleAlertService< + AlertTypeState, + AlertInstanceContext, + TActionGroupIds + >; } >; diff --git a/x-pack/plugins/uptime/server/plugin.ts b/x-pack/plugins/uptime/server/plugin.ts index 5ef5e17d4e33a..d4bc9ca1b4d5d 100644 --- a/x-pack/plugins/uptime/server/plugin.ts +++ b/x-pack/plugins/uptime/server/plugin.ts @@ -50,7 +50,7 @@ export class Plugin implements PluginType { settings: { number_of_shards: 1, }, - mappings: mappingFromFieldMap(uptimeRuleFieldMap), + mappings: mappingFromFieldMap(uptimeRuleFieldMap, 'strict'), }, }, }); diff --git a/x-pack/test/apm_api_integration/tests/alerts/rule_registry.ts b/x-pack/test/apm_api_integration/tests/alerts/rule_registry.ts index 0677acd500c1f..8072064b2b1bf 100644 --- a/x-pack/test/apm_api_integration/tests/alerts/rule_registry.ts +++ b/x-pack/test/apm_api_integration/tests/alerts/rule_registry.ts @@ -6,9 +6,21 @@ */ import expect from '@kbn/expect'; +import { + ALERT_DURATION, + ALERT_END, + ALERT_EVALUATION_THRESHOLD, + ALERT_EVALUATION_VALUE, + ALERT_ID, + ALERT_OWNER, + ALERT_PRODUCER, + ALERT_START, + ALERT_STATUS, + ALERT_UUID, + EVENT_KIND, +} from '@kbn/rule-data-utils'; import { merge, omit } from 'lodash'; import { format } from 'url'; -import { EVENT_KIND } from '@kbn/rule-data-utils/target/technical_field_names'; import { FtrProviderContext } from '../../common/ftr_provider_context'; import { registry } from '../../common/registry'; @@ -338,12 +350,7 @@ export default function ApiTest({ getService }: FtrProviderContext) { any >; - const exclude = [ - '@timestamp', - 'kibana.rac.alert.start', - 'kibana.rac.alert.uuid', - 'rule.uuid', - ]; + const exclude = ['@timestamp', ALERT_START, ALERT_UUID, 'rule.uuid']; const toCompare = omit(alertEvent, exclude); @@ -355,25 +362,25 @@ export default function ApiTest({ getService }: FtrProviderContext) { "event.kind": Array [ "signal", ], - "kibana.rac.alert.duration.us": Array [ + "${ALERT_DURATION}": Array [ 0, ], - "kibana.rac.alert.evaluation.threshold": Array [ + "${ALERT_EVALUATION_THRESHOLD}": Array [ 30, ], - "kibana.rac.alert.evaluation.value": Array [ + "${ALERT_EVALUATION_VALUE}": Array [ 50, ], - "kibana.rac.alert.id": Array [ + "${ALERT_ID}": Array [ "apm.transaction_error_rate_opbeans-go_request_ENVIRONMENT_NOT_DEFINED", ], - "kibana.rac.alert.owner": Array [ + "${ALERT_OWNER}": Array [ "apm", ], - "kibana.rac.alert.producer": Array [ + "${ALERT_PRODUCER}": Array [ "apm", ], - "kibana.rac.alert.status": Array [ + "${ALERT_STATUS}": Array [ "open", ], "kibana.space_ids": Array [ @@ -431,25 +438,25 @@ export default function ApiTest({ getService }: FtrProviderContext) { "event.kind": Array [ "signal", ], - "kibana.rac.alert.duration.us": Array [ + "${ALERT_DURATION}": Array [ 0, ], - "kibana.rac.alert.evaluation.threshold": Array [ + "${ALERT_EVALUATION_THRESHOLD}": Array [ 30, ], - "kibana.rac.alert.evaluation.value": Array [ + "${ALERT_EVALUATION_VALUE}": Array [ 50, ], - "kibana.rac.alert.id": Array [ + "${ALERT_ID}": Array [ "apm.transaction_error_rate_opbeans-go_request_ENVIRONMENT_NOT_DEFINED", ], - "kibana.rac.alert.owner": Array [ + "${ALERT_OWNER}": Array [ "apm", ], - "kibana.rac.alert.producer": Array [ + "${ALERT_PRODUCER}": Array [ "apm", ], - "kibana.rac.alert.status": Array [ + "${ALERT_STATUS}": Array [ "open", ], "kibana.space_ids": Array [ @@ -525,18 +532,12 @@ export default function ApiTest({ getService }: FtrProviderContext) { any >; - expect(recoveredAlertEvent['kibana.rac.alert.status']?.[0]).to.eql('closed'); - expect(recoveredAlertEvent['kibana.rac.alert.duration.us']?.[0]).to.be.greaterThan(0); - expect( - new Date(recoveredAlertEvent['kibana.rac.alert.end']?.[0]).getTime() - ).to.be.greaterThan(0); + expect(recoveredAlertEvent[ALERT_STATUS]?.[0]).to.eql('closed'); + expect(recoveredAlertEvent[ALERT_DURATION]?.[0]).to.be.greaterThan(0); + expect(new Date(recoveredAlertEvent[ALERT_END]?.[0]).getTime()).to.be.greaterThan(0); - expectSnapshot( - omit( - recoveredAlertEvent, - exclude.concat(['kibana.rac.alert.duration.us', 'kibana.rac.alert.end']) - ) - ).toMatchInline(` + expectSnapshot(omit(recoveredAlertEvent, exclude.concat([ALERT_DURATION, ALERT_END]))) + .toMatchInline(` Object { "event.action": Array [ "close", @@ -544,22 +545,22 @@ export default function ApiTest({ getService }: FtrProviderContext) { "event.kind": Array [ "signal", ], - "kibana.rac.alert.evaluation.threshold": Array [ + "${ALERT_EVALUATION_THRESHOLD}": Array [ 30, ], - "kibana.rac.alert.evaluation.value": Array [ + "${ALERT_EVALUATION_VALUE}": Array [ 50, ], - "kibana.rac.alert.id": Array [ + "${ALERT_ID}": Array [ "apm.transaction_error_rate_opbeans-go_request_ENVIRONMENT_NOT_DEFINED", ], - "kibana.rac.alert.owner": Array [ + "${ALERT_OWNER}": Array [ "apm", ], - "kibana.rac.alert.producer": Array [ + "${ALERT_PRODUCER}": Array [ "apm", ], - "kibana.rac.alert.status": Array [ + "${ALERT_STATUS}": Array [ "closed", ], "kibana.space_ids": Array [ @@ -610,7 +611,7 @@ export default function ApiTest({ getService }: FtrProviderContext) { expect(topAlertsAfterRecovery.length).to.be(1); - expect(topAlertsAfterRecovery[0]['kibana.rac.alert.status']?.[0]).to.be('closed'); + expect(topAlertsAfterRecovery[0][ALERT_STATUS]?.[0]).to.be('closed'); }); }); }); diff --git a/x-pack/test/functional/es_archives/rule_registry/alerts/data.json b/x-pack/test/functional/es_archives/rule_registry/alerts/data.json index 6d7f78292ddac..c8c01883197f5 100644 --- a/x-pack/test/functional/es_archives/rule_registry/alerts/data.json +++ b/x-pack/test/functional/es_archives/rule_registry/alerts/data.json @@ -8,8 +8,8 @@ "@timestamp": "2020-12-16T15:16:18.570Z", "rule.id": "apm.error_rate", "message": "hello world 1", - "kibana.rac.alert.owner": "apm", - "kibana.rac.alert.status": "open", + "kibana.alert.owner": "apm", + "kibana.alert.status": "open", "kibana.space_ids": ["space1", "space2"] } } @@ -25,8 +25,8 @@ "@timestamp": "2020-12-16T15:16:18.570Z", "rule.id": "apm.error_rate", "message": "hello world 1", - "kibana.rac.alert.owner": "apm", - "kibana.rac.alert.status": "open", + "kibana.alert.owner": "apm", + "kibana.alert.status": "open", "kibana.space_ids": ["space1"] } } @@ -42,8 +42,8 @@ "@timestamp": "2020-12-16T15:16:18.570Z", "rule.id": "apm.error_rate", "message": "hello world 1", - "kibana.rac.alert.owner": "apm", - "kibana.rac.alert.status": "open", + "kibana.alert.owner": "apm", + "kibana.alert.status": "open", "kibana.space_ids": ["space2"] } } @@ -59,8 +59,8 @@ "@timestamp": "2020-12-16T15:16:18.570Z", "rule.id": "siem.signals", "message": "hello world security", - "kibana.rac.alert.owner": "siem", - "kibana.rac.alert.status": "open", + "kibana.alert.owner": "siem", + "kibana.alert.status": "open", "kibana.space_ids": ["space1", "space2"] } } @@ -76,8 +76,8 @@ "@timestamp": "2020-12-16T15:16:18.570Z", "rule.id": "siem.customRule", "message": "hello world security", - "kibana.rac.alert.owner": "siem", - "kibana.rac.alert.status": "open", + "kibana.alert.owner": "siem", + "kibana.alert.status": "open", "kibana.space_ids": ["space1", "space2"] } } diff --git a/x-pack/test/functional/es_archives/rule_registry/alerts/mappings.json b/x-pack/test/functional/es_archives/rule_registry/alerts/mappings.json index 4cb178d979982..74d50ca402e45 100644 --- a/x-pack/test/functional/es_archives/rule_registry/alerts/mappings.json +++ b/x-pack/test/functional/es_archives/rule_registry/alerts/mappings.json @@ -13,7 +13,7 @@ } } }, - "kibana.rac.alert.owner": { + "kibana.alert.owner": { "type": "keyword", "ignore_above": 256 } @@ -37,7 +37,7 @@ } } }, - "kibana.rac.alert.owner": { + "kibana.alert.owner": { "type": "keyword", "ignore_above": 256 } diff --git a/x-pack/test/timeline/security_and_spaces/tests/basic/events.ts b/x-pack/test/timeline/security_and_spaces/tests/basic/events.ts index f4b7efc096e33..79f5768b9a3ba 100644 --- a/x-pack/test/timeline/security_and_spaces/tests/basic/events.ts +++ b/x-pack/test/timeline/security_and_spaces/tests/basic/events.ts @@ -5,8 +5,9 @@ * 2.0. */ -import expect from '@kbn/expect'; import { JsonObject } from '@kbn/common-utils'; +import expect from '@kbn/expect'; +import { ALERT_ID, ALERT_OWNER } from '@kbn/rule-data-utils'; import { User } from '../../../../rule_registry/common/lib/authentication/types'; import { TimelineEdges, TimelineNonEcsData } from '../../../../../plugins/timelines/common/'; @@ -73,23 +74,17 @@ export default ({ getService }: FtrProviderContext) => { field: '@timestamp', }, { - field: 'kibana.rac.alert.owner', + field: ALERT_OWNER, }, { - field: 'kibana.rac.alert.id', + field: ALERT_ID, }, { field: 'event.kind', }, ], factoryQueryType: TimelineEventsQueries.all, - fieldRequested: [ - '@timestamp', - 'message', - 'kibana.rac.alert.owner', - 'kibana.rac.alert.id', - 'event.kind', - ], + fieldRequested: ['@timestamp', 'message', ALERT_OWNER, ALERT_ID, 'event.kind'], fields: [], filterQuery: { bool: { @@ -154,10 +149,7 @@ export default ({ getService }: FtrProviderContext) => { timeline.edges.every((hit: TimelineEdges) => { const data: TimelineNonEcsData[] = hit.node.data; return data.some(({ field, value }) => { - return ( - field === 'kibana.rac.alert.owner' && - featureIds.includes((value && value[0]) ?? '') - ); + return field === ALERT_OWNER && featureIds.includes((value && value[0]) ?? ''); }); }) ).to.equal(true); diff --git a/x-pack/test/timeline/security_and_spaces/tests/trial/events.ts b/x-pack/test/timeline/security_and_spaces/tests/trial/events.ts index 075c413e1f2dc..2ebb534c4a451 100644 --- a/x-pack/test/timeline/security_and_spaces/tests/trial/events.ts +++ b/x-pack/test/timeline/security_and_spaces/tests/trial/events.ts @@ -5,8 +5,9 @@ * 2.0. */ -import expect from '@kbn/expect'; import { JsonObject } from '@kbn/common-utils'; +import expect from '@kbn/expect'; +import { ALERT_ID, ALERT_OWNER } from '@kbn/rule-data-utils'; import { User } from '../../../../rule_registry/common/lib/authentication/types'; import { TimelineEdges, TimelineNonEcsData } from '../../../../../plugins/timelines/common/'; @@ -56,23 +57,17 @@ export default ({ getService }: FtrProviderContext) => { field: '@timestamp', }, { - field: 'kibana.rac.alert.owner', + field: ALERT_OWNER, }, { - field: 'kibana.rac.alert.id', + field: ALERT_ID, }, { field: 'event.kind', }, ], factoryQueryType: TimelineEventsQueries.all, - fieldRequested: [ - '@timestamp', - 'message', - 'kibana.rac.alert.owner', - 'kibana.rac.alert.id', - 'event.kind', - ], + fieldRequested: ['@timestamp', 'message', ALERT_OWNER, ALERT_ID, 'event.kind'], fields: [], filterQuery: { bool: { @@ -136,10 +131,7 @@ export default ({ getService }: FtrProviderContext) => { timeline.edges.every((hit: TimelineEdges) => { const data: TimelineNonEcsData[] = hit.node.data; return data.some(({ field, value }) => { - return ( - field === 'kibana.rac.alert.owner' && - featureIds.includes((value && value[0]) ?? '') - ); + return field === ALERT_OWNER && featureIds.includes((value && value[0]) ?? ''); }); }) ).to.equal(true); diff --git a/x-pack/test/timeline/security_only/tests/basic/events.ts b/x-pack/test/timeline/security_only/tests/basic/events.ts index 0f7ddc0c05825..fc8ee95dedfc4 100644 --- a/x-pack/test/timeline/security_only/tests/basic/events.ts +++ b/x-pack/test/timeline/security_only/tests/basic/events.ts @@ -6,6 +6,7 @@ */ import { JsonObject } from '@kbn/common-utils'; +import { ALERT_ID, ALERT_OWNER } from '@kbn/rule-data-utils'; import { getSpaceUrlPrefix } from '../../../../rule_registry/common/lib/authentication/spaces'; @@ -39,23 +40,17 @@ export default ({ getService }: FtrProviderContext) => { field: '@timestamp', }, { - field: 'kibana.rac.alert.owner', + field: ALERT_OWNER, }, { - field: 'kibana.rac.alert.id', + field: ALERT_ID, }, { field: 'event.kind', }, ], factoryQueryType: TimelineEventsQueries.all, - fieldRequested: [ - '@timestamp', - 'message', - 'kibana.rac.alert.owner', - 'kibana.rac.alert.id', - 'event.kind', - ], + fieldRequested: ['@timestamp', 'message', ALERT_OWNER, ALERT_ID, 'event.kind'], fields: [], filterQuery: { bool: { diff --git a/x-pack/test/timeline/security_only/tests/trial/events.ts b/x-pack/test/timeline/security_only/tests/trial/events.ts index 0f7ddc0c05825..fc8ee95dedfc4 100644 --- a/x-pack/test/timeline/security_only/tests/trial/events.ts +++ b/x-pack/test/timeline/security_only/tests/trial/events.ts @@ -6,6 +6,7 @@ */ import { JsonObject } from '@kbn/common-utils'; +import { ALERT_ID, ALERT_OWNER } from '@kbn/rule-data-utils'; import { getSpaceUrlPrefix } from '../../../../rule_registry/common/lib/authentication/spaces'; @@ -39,23 +40,17 @@ export default ({ getService }: FtrProviderContext) => { field: '@timestamp', }, { - field: 'kibana.rac.alert.owner', + field: ALERT_OWNER, }, { - field: 'kibana.rac.alert.id', + field: ALERT_ID, }, { field: 'event.kind', }, ], factoryQueryType: TimelineEventsQueries.all, - fieldRequested: [ - '@timestamp', - 'message', - 'kibana.rac.alert.owner', - 'kibana.rac.alert.id', - 'event.kind', - ], + fieldRequested: ['@timestamp', 'message', ALERT_OWNER, ALERT_ID, 'event.kind'], fields: [], filterQuery: { bool: { diff --git a/x-pack/test/timeline/spaces_only/tests/events.ts b/x-pack/test/timeline/spaces_only/tests/events.ts index 71ea077406462..829d46905b6d1 100644 --- a/x-pack/test/timeline/spaces_only/tests/events.ts +++ b/x-pack/test/timeline/spaces_only/tests/events.ts @@ -5,8 +5,9 @@ * 2.0. */ -import expect from '@kbn/expect'; import { JsonObject } from '@kbn/common-utils'; +import expect from '@kbn/expect'; +import { ALERT_ID, ALERT_OWNER } from '@kbn/rule-data-utils'; import { FtrProviderContext } from '../../../rule_registry/common/ftr_provider_context'; import { getSpaceUrlPrefix } from '../../../rule_registry/common/lib/authentication/spaces'; @@ -34,23 +35,17 @@ export default ({ getService }: FtrProviderContext) => { field: '@timestamp', }, { - field: 'kibana.rac.alert.owner', + field: ALERT_OWNER, }, { - field: 'kibana.rac.alert.id', + field: ALERT_ID, }, { field: 'event.kind', }, ], factoryQueryType: TimelineEventsQueries.all, - fieldRequested: [ - '@timestamp', - 'message', - 'kibana.rac.alert.owner', - 'kibana.rac.alert.id', - 'event.kind', - ], + fieldRequested: ['@timestamp', 'message', ALERT_OWNER, ALERT_ID, 'event.kind'], fields: [], filterQuery: { bool: { From 8df883ad49febcfe940f7cc67231b6d7d95664a9 Mon Sep 17 00:00:00 2001 From: Nathan Reese Date: Tue, 3 Aug 2021 10:53:15 -0600 Subject: [PATCH 12/63] [maps] deprecate xpack.maps.showMapVisualizationTypes (#105981) * [maps] deprecate xpack.maps.showMapVisualizationTypes in upgrade assistent * use custom function instead of unusedFromRoot so config does not get removed * fix i18n ids and align deprecation message Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> --- x-pack/plugins/maps/server/index.ts | 29 ++++++++++++++++++++++++++--- 1 file changed, 26 insertions(+), 3 deletions(-) diff --git a/x-pack/plugins/maps/server/index.ts b/x-pack/plugins/maps/server/index.ts index 331e9ac70afdd..a884b2354b583 100644 --- a/x-pack/plugins/maps/server/index.ts +++ b/x-pack/plugins/maps/server/index.ts @@ -24,6 +24,30 @@ export const config: PluginConfigDescriptor = { }, schema: configSchema, deprecations: () => [ + ( + completeConfig: Record, + rootPath: string, + addDeprecation: AddConfigDeprecation + ) => { + if (_.get(completeConfig, 'xpack.maps.showMapVisualizationTypes') === undefined) { + return completeConfig; + } + addDeprecation({ + message: i18n.translate('xpack.maps.deprecation.showMapVisualizationTypes.message', { + defaultMessage: + 'xpack.maps.showMapVisualizationTypes is deprecated and is no longer used', + }), + correctiveActions: { + manualSteps: [ + i18n.translate('xpack.maps.deprecation.showMapVisualizationTypes.step1', { + defaultMessage: + 'Remove "xpack.maps.showMapVisualizationTypes" in the Kibana config file, CLI flag, or environment variable (in Docker only).', + }), + ], + }, + }); + return completeConfig; + }, ( completeConfig: Record, rootPath: string, @@ -36,8 +60,7 @@ export const config: PluginConfigDescriptor = { documentationUrl: 'https://www.elastic.co/guide/en/kibana/current/maps-connect-to-ems.html#elastic-maps-server', message: i18n.translate('xpack.maps.deprecation.proxyEMS.message', { - defaultMessage: - 'map.proxyElasticMapsServiceInMaps is deprecated and will be removed in 8.0.', + defaultMessage: 'map.proxyElasticMapsServiceInMaps is deprecated and is no longer used', }), correctiveActions: { manualSteps: [ @@ -63,7 +86,7 @@ export const config: PluginConfigDescriptor = { } addDeprecation({ message: i18n.translate('xpack.maps.deprecation.regionmap.message', { - defaultMessage: 'map.regionmap is deprecated and will be removed in 8.0.', + defaultMessage: 'map.regionmap is deprecated and is no longer used', }), correctiveActions: { manualSteps: [ From 1e1d6696501b83d253c373d2a36f9a552a57e491 Mon Sep 17 00:00:00 2001 From: Dario Gieselaar Date: Tue, 3 Aug 2021 18:57:13 +0200 Subject: [PATCH 13/63] [APM] Add and link to service dependencies page (#107522) * [APM] Add and link to service dependencies page * Update labels --- .../backend_detail_dependencies_table.tsx | 13 +++++++++++ .../index.tsx | 12 ++++++++++ .../app/service_dependencies/index.tsx | 11 +++++++++ .../index.tsx | 23 +++++++++++++++++-- .../routing/service_detail/index.tsx | 12 ++++++++++ .../templates/apm_service_template/index.tsx | 11 +++++++++ .../dependencies_table_service_map_link.tsx | 19 +++++++++++++++ .../shared/dependencies_table/index.tsx | 20 ++++------------ 8 files changed, 104 insertions(+), 17 deletions(-) create mode 100644 x-pack/plugins/apm/public/components/app/service_dependencies/index.tsx create mode 100644 x-pack/plugins/apm/public/components/shared/dependencies_table/dependencies_table_service_map_link.tsx diff --git a/x-pack/plugins/apm/public/components/app/backend_detail_overview/backend_detail_dependencies_table.tsx b/x-pack/plugins/apm/public/components/app/backend_detail_overview/backend_detail_dependencies_table.tsx index 1b696b847f75b..425506a3e035a 100644 --- a/x-pack/plugins/apm/public/components/app/backend_detail_overview/backend_detail_dependencies_table.tsx +++ b/x-pack/plugins/apm/public/components/app/backend_detail_overview/backend_detail_dependencies_table.tsx @@ -15,6 +15,8 @@ import { getTimeRangeComparison } from '../../shared/time_comparison/get_time_ra import { DependenciesTable } from '../../shared/dependencies_table'; import { useApmBackendContext } from '../../../context/apm_backend/use_apm_backend_context'; import { ServiceLink } from '../../shared/service_link'; +import { useApmRouter } from '../../../hooks/use_apm_router'; +import { DependenciesTableServiceMapLink } from '../../shared/dependencies_table/dependencies_table_service_map_link'; export function BackendDetailDependenciesTable() { const { @@ -25,6 +27,16 @@ export function BackendDetailDependenciesTable() { query: { rangeFrom, rangeTo, kuery }, } = useApmParams('/backends/:backendName/overview'); + const router = useApmRouter(); + + const serviceMapLink = router.link('/service-map', { + query: { + rangeFrom, + rangeTo, + environment, + }, + }); + const { offset } = getTimeRangeComparison({ start, end, @@ -99,6 +111,7 @@ export function BackendDetailDependenciesTable() { )} status={status} compact={false} + link={} /> ); } diff --git a/x-pack/plugins/apm/public/components/app/backend_inventory/backend_inventory_dependencies_table/index.tsx b/x-pack/plugins/apm/public/components/app/backend_inventory/backend_inventory_dependencies_table/index.tsx index 513daa9289c8f..e4b3d48992efa 100644 --- a/x-pack/plugins/apm/public/components/app/backend_inventory/backend_inventory_dependencies_table/index.tsx +++ b/x-pack/plugins/apm/public/components/app/backend_inventory/backend_inventory_dependencies_table/index.tsx @@ -7,6 +7,7 @@ import { i18n } from '@kbn/i18n'; import React from 'react'; +import { useApmRouter } from '../../../../hooks/use_apm_router'; import { getNodeName, NodeType } from '../../../../../common/connections'; import { useApmParams } from '../../../../hooks/use_apm_params'; import { useUrlParams } from '../../../../context/url_params_context/use_url_params'; @@ -14,6 +15,7 @@ import { useFetcher } from '../../../../hooks/use_fetcher'; import { getTimeRangeComparison } from '../../../shared/time_comparison/get_time_range_comparison'; import { DependenciesTable } from '../../../shared/dependencies_table'; import { BackendLink } from '../../../shared/backend_link'; +import { DependenciesTableServiceMapLink } from '../../../shared/dependencies_table/dependencies_table_service_map_link'; export function BackendInventoryDependenciesTable() { const { @@ -24,6 +26,15 @@ export function BackendInventoryDependenciesTable() { query: { rangeFrom, rangeTo, kuery }, } = useApmParams('/backends'); + const router = useApmRouter(); + const serviceMapLink = router.link('/service-map', { + query: { + rangeFrom, + rangeTo, + environment, + }, + }); + const { offset } = getTimeRangeComparison({ start, end, @@ -96,6 +107,7 @@ export function BackendInventoryDependenciesTable() { )} status={status} compact={false} + link={} /> ); } diff --git a/x-pack/plugins/apm/public/components/app/service_dependencies/index.tsx b/x-pack/plugins/apm/public/components/app/service_dependencies/index.tsx new file mode 100644 index 0000000000000..b89586b42fd6b --- /dev/null +++ b/x-pack/plugins/apm/public/components/app/service_dependencies/index.tsx @@ -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 React from 'react'; + +export function ServiceDependencies() { + return <>; +} diff --git a/x-pack/plugins/apm/public/components/app/service_overview/service_overview_dependencies_table/index.tsx b/x-pack/plugins/apm/public/components/app/service_overview/service_overview_dependencies_table/index.tsx index c3d74ec4baeaf..08d554b9a54e8 100644 --- a/x-pack/plugins/apm/public/components/app/service_overview/service_overview_dependencies_table/index.tsx +++ b/x-pack/plugins/apm/public/components/app/service_overview/service_overview_dependencies_table/index.tsx @@ -5,8 +5,10 @@ * 2.0. */ +import { EuiLink } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; import React from 'react'; +import { useApmRouter } from '../../../../hooks/use_apm_router'; import { getNodeName, NodeType } from '../../../../../common/connections'; import { useApmServiceContext } from '../../../../context/apm_service/use_apm_service_context'; import { useUrlParams } from '../../../../context/url_params_context/use_url_params'; @@ -30,6 +32,7 @@ export function ServiceOverviewDependenciesTable() { } = useUrlParams(); const { + query, query: { kuery, rangeFrom, rangeTo }, } = useApmParams('/services/:serviceName/overview'); @@ -42,6 +45,15 @@ export function ServiceOverviewDependenciesTable() { const { serviceName, transactionType } = useApmServiceContext(); + const router = useApmRouter(); + + const dependenciesLink = router.link('/services/:serviceName/dependencies', { + path: { + serviceName, + }, + query, + }); + const { data, status } = useFetcher( (callApmApi) => { if (!start || !end) { @@ -109,7 +121,7 @@ export function ServiceOverviewDependenciesTable() { title={i18n.translate( 'xpack.apm.serviceOverview.dependenciesTableTitle', { - defaultMessage: 'Dependencies', + defaultMessage: 'Downstream services and backends', } )} nameColumnTitle={i18n.translate( @@ -118,8 +130,15 @@ export function ServiceOverviewDependenciesTable() { defaultMessage: 'Backend', } )} - serviceName={serviceName} status={status} + link={ + + {i18n.translate( + 'xpack.apm.serviceOverview.dependenciesTableTabLink', + { defaultMessage: 'View dependencies' } + )} + + } /> ); } diff --git a/x-pack/plugins/apm/public/components/routing/service_detail/index.tsx b/x-pack/plugins/apm/public/components/routing/service_detail/index.tsx index 19db296c428c8..f3764df5ade51 100644 --- a/x-pack/plugins/apm/public/components/routing/service_detail/index.tsx +++ b/x-pack/plugins/apm/public/components/routing/service_detail/index.tsx @@ -21,6 +21,7 @@ import { ServiceNodeMetrics } from '../../app/service_node_metrics'; import { ServiceMap } from '../../app/service_map'; import { TransactionDetails } from '../../app/transaction_details'; import { ServiceProfiling } from '../../app/service_profiling'; +import { ServiceDependencies } from '../../app/service_dependencies'; function page({ path, @@ -125,6 +126,17 @@ export const serviceDetail = { }, ], }, + page({ + path: '/dependencies', + element: , + tab: 'dependencies', + title: i18n.translate('xpack.apm.views.dependencies.title', { + defaultMessage: 'Dependencies', + }), + searchBarOptions: { + showTimeComparison: true, + }, + }), { ...page({ path: '/errors', diff --git a/x-pack/plugins/apm/public/components/routing/templates/apm_service_template/index.tsx b/x-pack/plugins/apm/public/components/routing/templates/apm_service_template/index.tsx index ee5ed91dfb463..c5171a012dc63 100644 --- a/x-pack/plugins/apm/public/components/routing/templates/apm_service_template/index.tsx +++ b/x-pack/plugins/apm/public/components/routing/templates/apm_service_template/index.tsx @@ -37,6 +37,7 @@ type Tab = NonNullable[0] & { key: | 'overview' | 'transactions' + | 'dependencies' | 'errors' | 'metrics' | 'nodes' @@ -163,6 +164,16 @@ function useTabs({ selectedTab }: { selectedTab: Tab['key'] }) { defaultMessage: 'Transactions', }), }, + { + key: 'dependencies', + href: router.link('/services/:serviceName/dependencies', { + path: { serviceName }, + query, + }), + label: i18n.translate('xpack.apm.serviceDetails.dependenciesTabLabel', { + defaultMessage: 'Dependencies', + }), + }, { key: 'errors', href: router.link('/services/:serviceName/errors', { diff --git a/x-pack/plugins/apm/public/components/shared/dependencies_table/dependencies_table_service_map_link.tsx b/x-pack/plugins/apm/public/components/shared/dependencies_table/dependencies_table_service_map_link.tsx new file mode 100644 index 0000000000000..4086551611433 --- /dev/null +++ b/x-pack/plugins/apm/public/components/shared/dependencies_table/dependencies_table_service_map_link.tsx @@ -0,0 +1,19 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ +import React from 'react'; +import { i18n } from '@kbn/i18n'; +import { EuiLink } from '@elastic/eui'; + +export function DependenciesTableServiceMapLink({ href }: { href: string }) { + return ( + + {i18n.translate('xpack.apm.dependenciesTable.serviceMapLinkText', { + defaultMessage: 'View service map', + })} + + ); +} diff --git a/x-pack/plugins/apm/public/components/shared/dependencies_table/index.tsx b/x-pack/plugins/apm/public/components/shared/dependencies_table/index.tsx index 5aeb9549fb3a2..a599a3bd0aa62 100644 --- a/x-pack/plugins/apm/public/components/shared/dependencies_table/index.tsx +++ b/x-pack/plugins/apm/public/components/shared/dependencies_table/index.tsx @@ -24,7 +24,6 @@ import { FETCH_STATUS } from '../../../hooks/use_fetcher'; import { unit } from '../../../utils/style'; import { SparkPlot } from '../charts/spark_plot'; import { ImpactBar } from '../ImpactBar'; -import { ServiceMapLink } from '../Links/apm/ServiceMapLink'; import { TableFetchWrapper } from '../table_fetch_wrapper'; import { TruncateWithTooltip } from '../truncate_with_tooltip'; import { OverviewTableContainer } from '../overview_table_container'; @@ -39,7 +38,7 @@ export type DependenciesItem = Omit< interface Props { dependencies: DependenciesItem[]; - serviceName?: string; + link: React.ReactNode; title: React.ReactNode; nameColumnTitle: React.ReactNode; status: FETCH_STATUS; @@ -49,7 +48,7 @@ interface Props { export function DependenciesTable(props: Props) { const { dependencies, - serviceName, + link, title, nameColumnTitle, status, @@ -69,8 +68,8 @@ export function DependenciesTable(props: Props) { field: 'name', name: nameColumnTitle, render: (_, item) => { - const { name, link } = item; - return ; + const { name, link: itemLink } = item; + return ; }, sortable: true, }, @@ -177,16 +176,7 @@ export function DependenciesTable(props: Props) {

{title}

- - - {i18n.translate( - 'xpack.apm.dependenciesTable.serviceMapLinkText', - { - defaultMessage: 'View service map', - } - )} - - + {link} From b5e8db2443fc882a83ca6a5297e9ed55d0116efa Mon Sep 17 00:00:00 2001 From: Sergi Massaneda Date: Tue, 3 Aug 2021 20:02:44 +0200 Subject: [PATCH 14/63] [RAC] [TGrid] Bulk actions to EuiDataGrid toolbar (#107141) * tGrid EuiDataGrid toolbar replace utilityBar * tgrid new prop in observability * types and translations fixes * bulkActions props and encapsulation * update limits * code cleaning * load lazy and remove export from public * add memoization to bulk_actions * icon change and test fixed Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> --- packages/kbn-optimizer/limits.yml | 2 +- .../pages/alerts/alerts_table_t_grid.tsx | 8 +- .../common/components/events_viewer/index.tsx | 6 +- .../components/alerts_table/index.tsx | 1 + x-pack/plugins/timelines/common/constants.ts | 7 + .../common/types/timeline/actions/index.ts | 11 + .../components/t_grid/body/index.test.tsx | 3 + .../public/components/t_grid/body/index.tsx | 150 ++++++++++--- .../components/t_grid/body/translations.ts | 6 + .../components/t_grid/integrated/index.tsx | 32 ++- .../t_grid/integrated/translations.ts | 42 ---- .../components/t_grid/standalone/index.tsx | 34 ++- .../t_grid/standalone/translations.ts | 36 ---- .../public/components/t_grid/styles.tsx | 5 +- .../alert_status_bulk_actions.tsx | 198 ++++++++++++++++++ .../t_grid/toolbar/bulk_actions/index.tsx | 131 ++++++++++++ .../toolbar/bulk_actions/translations.ts | 29 +++ .../t_grid/toolbar/fields_browser/index.tsx | 2 +- .../public/components/t_grid/translations.ts | 96 +++++++++ .../public/container/use_update_alerts.ts | 38 ++++ .../hooks/use_status_bulk_action_items.tsx | 109 ++++++++++ .../timelines/public/store/t_grid/model.ts | 2 +- .../translations/translations/ja-JP.json | 4 - .../translations/translations/zh-CN.json | 5 - .../applications/timelines_test/index.tsx | 1 + 25 files changed, 799 insertions(+), 159 deletions(-) delete mode 100644 x-pack/plugins/timelines/public/components/t_grid/integrated/translations.ts delete mode 100644 x-pack/plugins/timelines/public/components/t_grid/standalone/translations.ts create mode 100644 x-pack/plugins/timelines/public/components/t_grid/toolbar/bulk_actions/alert_status_bulk_actions.tsx create mode 100644 x-pack/plugins/timelines/public/components/t_grid/toolbar/bulk_actions/index.tsx create mode 100644 x-pack/plugins/timelines/public/components/t_grid/toolbar/bulk_actions/translations.ts create mode 100644 x-pack/plugins/timelines/public/container/use_update_alerts.ts create mode 100644 x-pack/plugins/timelines/public/hooks/use_status_bulk_action_items.tsx diff --git a/packages/kbn-optimizer/limits.yml b/packages/kbn-optimizer/limits.yml index d8a964decb87b..0b90aaaf6f11a 100644 --- a/packages/kbn-optimizer/limits.yml +++ b/packages/kbn-optimizer/limits.yml @@ -107,7 +107,7 @@ pageLoadAssetSize: dataVisualizer: 27530 banners: 17946 mapsEms: 26072 - timelines: 330000 + timelines: 327300 screenshotMode: 17856 visTypePie: 35583 expressionRevealImage: 25675 diff --git a/x-pack/plugins/observability/public/pages/alerts/alerts_table_t_grid.tsx b/x-pack/plugins/observability/public/pages/alerts/alerts_table_t_grid.tsx index 77c2b5cbca0cf..cd8965de36f1c 100644 --- a/x-pack/plugins/observability/public/pages/alerts/alerts_table_t_grid.tsx +++ b/x-pack/plugins/observability/public/pages/alerts/alerts_table_t_grid.tsx @@ -21,7 +21,12 @@ import { import type { TimelinesUIStart } from '../../../../timelines/public'; import type { TopAlert } from './'; import { useKibana } from '../../../../../../src/plugins/kibana_react/public'; -import type { ActionProps, ColumnHeaderOptions, RowRenderer } from '../../../../timelines/common'; +import type { + ActionProps, + AlertStatus, + ColumnHeaderOptions, + RowRenderer, +} from '../../../../timelines/common'; import { getRenderCellValue } from './render_cell_value'; import { usePluginContext } from '../../hooks/use_plugin_context'; @@ -213,6 +218,7 @@ export function AlertsTableTGrid(props: AlertsTableTGridProps) { sortDirection: 'desc', }, ], + filterStatus: status as AlertStatus, leadingControlColumns, trailingControlColumns, unit: (totalAlerts: number) => diff --git a/x-pack/plugins/security_solution/public/common/components/events_viewer/index.tsx b/x-pack/plugins/security_solution/public/common/components/events_viewer/index.tsx index c4da4e8d4506a..4b91122103d16 100644 --- a/x-pack/plugins/security_solution/public/common/components/events_viewer/index.tsx +++ b/x-pack/plugins/security_solution/public/common/components/events_viewer/index.tsx @@ -15,7 +15,8 @@ import { inputsModel, inputsSelectors, State } from '../../store'; import { inputsActions } from '../../store/actions'; import { ControlColumnProps, RowRenderer, TimelineId } from '../../../../common/types/timeline'; import { timelineSelectors, timelineActions } from '../../../timelines/store/timeline'; -import { SubsetTimelineModel, TimelineModel } from '../../../timelines/store/timeline/model'; +import type { SubsetTimelineModel, TimelineModel } from '../../../timelines/store/timeline/model'; +import { Status } from '../../../../common/detection_engine/schemas/common/schemas'; import { Filter } from '../../../../../../../src/plugins/data/public'; import { InspectButtonContainer } from '../inspect'; import { useGlobalFullScreen } from '../../containers/use_full_screen'; @@ -54,6 +55,7 @@ export interface OwnProps { showTotalCount?: boolean; headerFilterGroup?: React.ReactNode; pageFilters?: Filter[]; + currentFilter?: Status; onRuleChange?: () => void; renderCellValue: (props: CellValueElementProps) => React.ReactNode; rowRenderers: RowRenderer[]; @@ -83,6 +85,7 @@ const StatefulEventsViewerComponent: React.FC = ({ itemsPerPageOptions, kqlMode, pageFilters, + currentFilter, onRuleChange, query, renderCellValue, @@ -160,6 +163,7 @@ const StatefulEventsViewerComponent: React.FC = ({ sort, utilityBar, graphEventId, + filterStatus: currentFilter, leadingControlColumns, trailingControlColumns, }) diff --git a/x-pack/plugins/security_solution/public/detections/components/alerts_table/index.tsx b/x-pack/plugins/security_solution/public/detections/components/alerts_table/index.tsx index b67fd9aeb81b9..4b91e3b1e35fc 100644 --- a/x-pack/plugins/security_solution/public/detections/components/alerts_table/index.tsx +++ b/x-pack/plugins/security_solution/public/detections/components/alerts_table/index.tsx @@ -390,6 +390,7 @@ export const AlertsTableComponent: React.FC = ({ pageFilters={defaultFiltersMemo} defaultModel={defaultTimelineModel} end={to} + currentFilter={filterGroup} headerFilterGroup={headerFilterGroup} id={timelineId} onRuleChange={onRuleChange} diff --git a/x-pack/plugins/timelines/common/constants.ts b/x-pack/plugins/timelines/common/constants.ts index 86ff9d501f148..8c4e1700a54dd 100644 --- a/x-pack/plugins/timelines/common/constants.ts +++ b/x-pack/plugins/timelines/common/constants.ts @@ -5,4 +5,11 @@ * 2.0. */ +import { AlertStatus } from './types/timeline/actions'; + export const DEFAULT_MAX_TABLE_QUERY_SIZE = 10000; +export const DEFAULT_NUMBER_FORMAT = 'format:number:defaultPattern'; + +export const FILTER_OPEN: AlertStatus = 'open'; +export const FILTER_CLOSED: AlertStatus = 'closed'; +export const FILTER_IN_PROGRESS: AlertStatus = 'in-progress'; diff --git a/x-pack/plugins/timelines/common/types/timeline/actions/index.ts b/x-pack/plugins/timelines/common/types/timeline/actions/index.ts index 8d3f212fd6bcc..e61361233cda6 100644 --- a/x-pack/plugins/timelines/common/types/timeline/actions/index.ts +++ b/x-pack/plugins/timelines/common/types/timeline/actions/index.ts @@ -90,3 +90,14 @@ export type ControlColumnProps = Omit< keyof AdditionalControlColumnProps > & Partial; + +export type OnAlertStatusActionSuccess = (status: AlertStatus) => void; +export type OnAlertStatusActionFailure = (status: AlertStatus, error: string) => void; +export interface BulkActionsObjectProp { + alertStatusActions?: boolean; + onAlertStatusActionSuccess?: OnAlertStatusActionSuccess; + onAlertStatusActionFailure?: OnAlertStatusActionFailure; +} +export type BulkActionsProp = boolean | BulkActionsObjectProp; + +export type AlertStatus = 'open' | 'closed' | 'in-progress'; diff --git a/x-pack/plugins/timelines/public/components/t_grid/body/index.test.tsx b/x-pack/plugins/timelines/public/components/t_grid/body/index.test.tsx index a3de8654ec1c5..81fe117e08ccd 100644 --- a/x-pack/plugins/timelines/public/components/t_grid/body/index.test.tsx +++ b/x-pack/plugins/timelines/public/components/t_grid/body/index.test.tsx @@ -75,8 +75,11 @@ describe('Body', () => { showCheckboxes: false, tabType: TimelineTabs.query, totalPages: 1, + totalItems: 1, leadingControlColumns: [], trailingControlColumns: [], + filterStatus: 'open', + refetch: jest.fn(), }; describe('rendering', () => { diff --git a/x-pack/plugins/timelines/public/components/t_grid/body/index.tsx b/x-pack/plugins/timelines/public/components/t_grid/body/index.tsx index 1efee943c6456..91667e74ae158 100644 --- a/x-pack/plugins/timelines/public/components/t_grid/body/index.tsx +++ b/x-pack/plugins/timelines/public/components/t_grid/body/index.tsx @@ -11,19 +11,34 @@ import { EuiDataGridControlColumn, EuiDataGridStyle, EuiDataGridToolBarVisibilityOptions, + EuiLoadingSpinner, } from '@elastic/eui'; import { getOr } from 'lodash/fp'; import memoizeOne from 'memoize-one'; -import React, { ComponentType, useCallback, useEffect, useMemo, useState } from 'react'; +import React, { + ComponentType, + lazy, + Suspense, + useCallback, + useEffect, + useMemo, + useState, +} from 'react'; import { connect, ConnectedProps } from 'react-redux'; -import { SortColumnTimeline, TimelineId, TimelineTabs } from '../../../../common/types/timeline'; +import { + TimelineId, + TimelineTabs, + BulkActionsProp, + SortColumnTimeline, +} from '../../../../common/types/timeline'; import type { CellValueElementProps, ColumnHeaderOptions, ControlColumnProps, RowRenderer, + AlertStatus, } from '../../../../common/types/timeline'; import type { TimelineItem, TimelineNonEcsData } from '../../../../common/search_strategy/timeline'; @@ -32,15 +47,21 @@ import { getEventIdToDataMapping } from './helpers'; import { Sort } from './sort'; import { DEFAULT_ICON_BUTTON_WIDTH } from '../helpers'; -import { BrowserFields } from '../../../../common/search_strategy/index_fields'; -import { OnRowSelected, OnSelectAll } from '../types'; -import { StatefulFieldsBrowser, tGridActions } from '../../../'; -import { TGridModel, tGridSelectors, TimelineState } from '../../../store/t_grid'; +import type { BrowserFields } from '../../../../common/search_strategy/index_fields'; +import type { OnRowSelected, OnSelectAll } from '../types'; +import type { Refetch } from '../../../store/t_grid/inputs'; +import { StatefulFieldsBrowser } from '../../../'; +import { tGridActions, TGridModel, tGridSelectors, TimelineState } from '../../../store/t_grid'; import { useDeepEqualSelector } from '../../../hooks/use_selector'; import { RowAction } from './row_action'; import * as i18n from './translations'; +import { AlertCount } from '../styles'; import { checkBoxControlColumn } from './control_columns'; +const StatefulAlertStatusBulkActions = lazy( + () => import('../toolbar/bulk_actions/alert_status_bulk_actions') +); + interface OwnProps { activePage: number; additionalControls?: React.ReactNode; @@ -48,16 +69,22 @@ interface OwnProps { data: TimelineItem[]; id: string; isEventViewer?: boolean; - leadingControlColumns: ControlColumnProps[]; renderCellValue: (props: CellValueElementProps) => React.ReactNode; rowRenderers: RowRenderer[]; sort: Sort[]; tabType: TimelineTabs; - trailingControlColumns: ControlColumnProps[]; + leadingControlColumns?: ControlColumnProps[]; + trailingControlColumns?: ControlColumnProps[]; totalPages: number; + totalItems: number; + bulkActions?: BulkActionsProp; + filterStatus?: AlertStatus; + unit?: (total: number) => React.ReactNode; onRuleChange?: () => void; + refetch: Refetch; } +const basicUnit = (n: number) => i18n.UNIT(n); const NUM_OF_ICON_IN_TIMELINE_ROW = 2; export const hasAdditionalActions = (id: TimelineId): boolean => @@ -200,31 +227,42 @@ export const BodyComponent = React.memo( sort, tabType, totalPages, + totalItems, + filterStatus, + bulkActions = true, + unit = basicUnit, leadingControlColumns = EMPTY_CONTROL_COLUMNS, trailingControlColumns = EMPTY_CONTROL_COLUMNS, + refetch, }) => { const getManageTimeline = useMemo(() => tGridSelectors.getManageTimelineById(), []); const { queryFields, selectAll } = useDeepEqualSelector((state) => getManageTimeline(state, id) ); + const alertCountText = useMemo(() => `${totalItems.toLocaleString()} ${unit(totalItems)}`, [ + totalItems, + unit, + ]); + + const selectedCount = useMemo(() => Object.keys(selectedEventIds).length, [selectedEventIds]); + const onRowSelected: OnRowSelected = useCallback( ({ eventIds, isSelected }: { eventIds: string[]; isSelected: boolean }) => { - setSelected!({ + setSelected({ id, eventIds: getEventIdToDataMapping(data, eventIds, queryFields), isSelected, - isSelectAllChecked: - isSelected && Object.keys(selectedEventIds).length + 1 === data.length, + isSelectAllChecked: isSelected && selectedCount + 1 === data.length, }); }, - [setSelected, id, data, selectedEventIds, queryFields] + [setSelected, id, data, selectedCount, queryFields] ); const onSelectPage: OnSelectAll = useCallback( ({ isSelected }: { isSelected: boolean }) => isSelected - ? setSelected!({ + ? setSelected({ id, eventIds: getEventIdToDataMapping( data, @@ -234,7 +272,7 @@ export const BodyComponent = React.memo( isSelected, isSelectAllChecked: isSelected, }) - : clearSelected!({ id }), + : clearSelected({ id }), [setSelected, clearSelected, id, data, queryFields] ); @@ -245,25 +283,87 @@ export const BodyComponent = React.memo( } }, [isSelectAllChecked, onSelectPage, selectAll]); + const onAlertStatusActionSuccess = useMemo(() => { + if (bulkActions && bulkActions !== true) { + return bulkActions.onAlertStatusActionSuccess; + } + }, [bulkActions]); + + const onAlertStatusActionFailure = useMemo(() => { + if (bulkActions && bulkActions !== true) { + return bulkActions.onAlertStatusActionFailure; + } + }, [bulkActions]); + + const showBulkActions = useMemo(() => { + if (selectedCount === 0 || !showCheckboxes) { + return false; + } + if (typeof bulkActions === 'boolean') { + return bulkActions; + } + return bulkActions.alertStatusActions ?? true; + }, [selectedCount, showCheckboxes, bulkActions]); + const toolbarVisibility: EuiDataGridToolBarVisibilityOptions = useMemo( () => ({ additionalControls: ( <> - {additionalControls ?? null} - { - - } + {alertCountText} + {showBulkActions ? ( + <> + }> + + + {additionalControls ?? null} + + ) : ( + <> + {additionalControls ?? null} + + + )} ), - showColumnSelector: { allowHide: false, allowReorder: true }, + ...(showBulkActions + ? { + showColumnSelector: false, + showSortSelector: false, + showFullScreenSelector: false, + } + : { + showColumnSelector: { allowHide: true, allowReorder: true }, + showSortSelector: true, + showFullScreenSelector: true, + }), showStyleSelector: false, }), - [additionalControls, browserFields, columnHeaders, id] + [ + id, + alertCountText, + totalItems, + filterStatus, + browserFields, + columnHeaders, + additionalControls, + showBulkActions, + onAlertStatusActionSuccess, + onAlertStatusActionFailure, + refetch, + ] ); const [sortingColumns, setSortingColumns] = useState([]); diff --git a/x-pack/plugins/timelines/public/components/t_grid/body/translations.ts b/x-pack/plugins/timelines/public/components/t_grid/body/translations.ts index e2d13fe49f2b6..4eb47afdc1923 100644 --- a/x-pack/plugins/timelines/public/components/t_grid/body/translations.ts +++ b/x-pack/plugins/timelines/public/components/t_grid/body/translations.ts @@ -216,3 +216,9 @@ export const INVESTIGATE_IN_RESOLVER_DISABLED = i18n.translate( defaultMessage: 'This event cannot be analyzed since it has incompatible field mappings', } ); + +export const UNIT = (totalCount: number) => + i18n.translate('xpack.timelines.timeline.body.unit', { + values: { totalCount }, + defaultMessage: `{totalCount, plural, =1 {event} other {events}}`, + }); diff --git a/x-pack/plugins/timelines/public/components/t_grid/integrated/index.tsx b/x-pack/plugins/timelines/public/components/t_grid/integrated/index.tsx index 3f987e1f75e6a..924b83ab6a9e2 100644 --- a/x-pack/plugins/timelines/public/components/t_grid/integrated/index.tsx +++ b/x-pack/plugins/timelines/public/components/t_grid/integrated/index.tsx @@ -22,6 +22,7 @@ import type { ControlColumnProps, DataProvider, RowRenderer, + AlertStatus, } from '../../../../common/types/timeline'; import { esQuery, @@ -40,20 +41,15 @@ import { HeaderSection } from '../header_section'; import { StatefulBody } from '../body'; import { Footer, footerHeight } from '../footer'; import { LastUpdatedAt } from '../..'; -import { AlertCount, SELECTOR_TIMELINE_GLOBAL_CONTAINER, UpdatedFlexItem } from '../styles'; -import * as i18n from './translations'; +import { SELECTOR_TIMELINE_GLOBAL_CONTAINER, UpdatedFlexItem } from '../styles'; +import * as i18n from '../translations'; import { ExitFullScreen } from '../../exit_full_screen'; import { Sort } from '../body/sort'; import { InspectButtonContainer } from '../../inspect'; export const EVENTS_VIEWER_HEADER_HEIGHT = 90; // px -const UTILITY_BAR_HEIGHT = 19; // px const COMPACT_HEADER_HEIGHT = 36; // px -const UtilityBar = styled.div` - height: ${UTILITY_BAR_HEIGHT}px; -`; - const TitleText = styled.span` margin-right: 12px; `; @@ -114,6 +110,7 @@ export interface TGridIntegratedProps { filters: Filter[]; globalFullScreen: boolean; headerFilterGroup?: React.ReactNode; + filterStatus?: AlertStatus; height?: number; id: TimelineId; indexNames: string[]; @@ -133,8 +130,8 @@ export interface TGridIntegratedProps { utilityBar?: (refetch: Refetch, totalCount: number) => React.ReactNode; // If truthy, the graph viewer (Resolver) is showing graphEventId: string | undefined; - leadingControlColumns: ControlColumnProps[]; - trailingControlColumns: ControlColumnProps[]; + leadingControlColumns?: ControlColumnProps[]; + trailingControlColumns?: ControlColumnProps[]; data?: DataPublicPluginStart; } @@ -148,6 +145,7 @@ const TGridIntegratedComponent: React.FC = ({ filters, globalFullScreen, headerFilterGroup, + filterStatus, id, indexNames, indexPattern, @@ -255,13 +253,6 @@ const TGridIntegratedComponent: React.FC = ({ [deletedEventIds.length, totalCount] ); - const subtitle = useMemo( - () => `${totalCountMinusDeleted.toLocaleString()} ${unit && unit(totalCountMinusDeleted)}`, - [totalCountMinusDeleted, unit] - ); - - const additionalControls = useMemo(() => {subtitle}, [subtitle]); - const nonDeletedEvents = useMemo(() => events.filter((e) => !deletedEventIds.includes(e._id)), [ deletedEventIds, events, @@ -301,9 +292,7 @@ const TGridIntegratedComponent: React.FC = ({ > {HeaderSectionContent} - {utilityBar && !resolverIsShowing(graphEventId) && ( - {utilityBar?.(refetch, totalCountMinusDeleted)} - )} + = ({ = ({ itemsCount: totalCountMinusDeleted, itemsPerPage, })} + totalItems={totalCountMinusDeleted} + unit={unit} + filterStatus={filterStatus} leadingControlColumns={leadingControlColumns} trailingControlColumns={trailingControlColumns} + refetch={refetch} />