Skip to content

Commit

Permalink
Merge branch 'main' into add-kibana-services-provider-for-embeddable
Browse files Browse the repository at this point in the history
  • Loading branch information
@kibanamachine
kibanamachine committed Dec 23, 2021
2 parents acfc703 + 0ad9abc commit 7445521
Show file tree
Hide file tree
Showing 1,391 changed files with 56,513 additions and 221,043 deletions.
4 changes: 0 additions & 4 deletions .eslintrc.js
View file
Expand Up @@ -850,10 +850,6 @@ module.exports = {
name: 'semver',
message: 'Please use "semver/*/{function}" instead',
},
{
name: '@kbn/rule-data-utils',
message: `Import directly from @kbn/rule-data-utils/* submodules in public/common code`,
},
],
},
],
Expand Down
88 changes: 66 additions & 22 deletions api_docs/actions.json
View file
Expand Up @@ -66,9 +66,9 @@
"label": "asSavedObjectExecutionSource",
"description": [],
"signature": [
"(source: Pick<",
"(source: Omit<",
"SavedObjectReference",
", \"type\" | \"id\">) => ",
", \"name\">) => ",
"SavedObjectExecutionSource"
],
"path": "x-pack/plugins/actions/server/lib/action_execution_source.ts",
Expand All @@ -82,9 +82,9 @@
"label": "source",
"description": [],
"signature": [
"Pick<",
"Omit<",
"SavedObjectReference",
", \"type\" | \"id\">"
", \"name\">"
],
"path": "x-pack/plugins/actions/server/lib/action_execution_source.ts",
"deprecated": false,
Expand Down Expand Up @@ -667,7 +667,7 @@
"label": "ActionParamsType",
"description": [],
"signature": [
"{ readonly to: string[]; readonly message: string; readonly subject: string; readonly cc: string[]; readonly bcc: string[]; readonly kibanaFooterLink: Readonly<{} & { path: string; text: string; }>; }"
"{ readonly message: string; readonly to: string[]; readonly subject: string; readonly cc: string[]; readonly bcc: string[]; readonly kibanaFooterLink: Readonly<{} & { path: string; text: string; }>; }"
],
"path": "x-pack/plugins/actions/server/builtin_action_types/email.ts",
"deprecated": false,
Expand Down Expand Up @@ -695,7 +695,7 @@
"label": "ActionParamsType",
"description": [],
"signature": [
"{ readonly source?: string | undefined; readonly group?: string | undefined; readonly summary?: string | undefined; readonly timestamp?: string | undefined; readonly eventAction?: \"resolve\" | \"trigger\" | \"acknowledge\" | undefined; readonly dedupKey?: string | undefined; readonly severity?: \"info\" | \"error\" | \"warning\" | \"critical\" | undefined; readonly component?: string | undefined; readonly class?: string | undefined; }"
"{ readonly source?: string | undefined; readonly group?: string | undefined; readonly summary?: string | undefined; readonly timestamp?: string | undefined; readonly eventAction?: \"resolve\" | \"trigger\" | \"acknowledge\" | undefined; readonly dedupKey?: string | undefined; readonly severity?: \"error\" | \"info\" | \"warning\" | \"critical\" | undefined; readonly component?: string | undefined; readonly class?: string | undefined; }"
],
"path": "x-pack/plugins/actions/server/builtin_action_types/pagerduty.ts",
"deprecated": false,
Expand All @@ -709,7 +709,7 @@
"label": "ActionParamsType",
"description": [],
"signature": [
"{ readonly message: string; readonly level: \"info\" | \"error\" | \"trace\" | \"debug\" | \"warn\" | \"fatal\"; }"
"{ readonly message: string; readonly level: \"error\" | \"info\" | \"trace\" | \"debug\" | \"warn\" | \"fatal\"; }"
],
"path": "x-pack/plugins/actions/server/builtin_action_types/server_log.ts",
"deprecated": false,
Expand Down Expand Up @@ -779,7 +779,7 @@
"label": "ActionParamsType",
"description": [],
"signature": [
"Readonly<{} & { subAction: \"getFields\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"getIncident\"; subActionParams: Readonly<{} & { externalId: string; }>; }> | Readonly<{} & { subAction: \"handshake\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"pushToService\"; subActionParams: Readonly<{} & { incident: Readonly<{} & { name: string; description: string | null; externalId: string | null; incidentTypes: number[] | null; severityCode: number | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"incidentTypes\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"severity\"; subActionParams: Readonly<{} & {}>; }>"
"Readonly<{} & { subAction: \"getFields\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"getIncident\"; subActionParams: Readonly<{} & { externalId: string; }>; }> | Readonly<{} & { subAction: \"handshake\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"pushToService\"; subActionParams: Readonly<{} & { incident: Readonly<{} & { description: string | null; name: string; externalId: string | null; incidentTypes: number[] | null; severityCode: number | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"incidentTypes\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"severity\"; subActionParams: Readonly<{} & {}>; }>"
],
"path": "x-pack/plugins/actions/server/builtin_action_types/resilient/index.ts",
"deprecated": false,
Expand Down Expand Up @@ -831,15 +831,19 @@
"section": "def-server.ActionResult",
"text": "ActionResult"
},
"<Record<string, unknown>>>; delete: ({ id }: { id: string; }) => Promise<{}>; get: ({ id }: { id: string; }) => Promise<",
"<",
"ActionTypeConfig",
">>; delete: ({ id }: { id: string; }) => Promise<{}>; get: ({ id }: { id: string; }) => Promise<",
{
"pluginId": "actions",
"scope": "server",
"docId": "kibActionsPluginApi",
"section": "def-server.ActionResult",
"text": "ActionResult"
},
"<Record<string, unknown>>>; update: ({ id, action }: ",
"<",
"ActionTypeConfig",
">>; update: ({ id, action }: ",
"UpdateOptions",
") => Promise<",
{
Expand All @@ -849,9 +853,11 @@
"section": "def-server.ActionResult",
"text": "ActionResult"
},
"<Record<string, unknown>>>; execute: ({ actionId, params, source, relatedSavedObjects, }: Pick<",
"<",
"ActionTypeConfig",
">>; execute: ({ actionId, params, source, relatedSavedObjects, }: Omit<",
"ExecuteOptions",
"<unknown>, \"source\" | \"params\" | \"actionId\" | \"isEphemeral\" | \"taskInfo\" | \"relatedSavedObjects\">) => Promise<",
"<unknown>, \"request\">) => Promise<",
{
"pluginId": "actions",
"scope": "common",
Expand All @@ -869,7 +875,9 @@
"section": "def-server.ActionResult",
"text": "ActionResult"
},
"<Record<string, unknown>>[]>; enqueueExecution: (options: ",
"<",
"ActionTypeConfig",
">[]>; enqueueExecution: (options: ",
"ExecuteOptions",
") => Promise<void>; ephemeralEnqueuedExecution: (options: ",
"ExecuteOptions",
Expand Down Expand Up @@ -1069,7 +1077,19 @@
"label": "registerType",
"description": [],
"signature": [
"<Config extends Record<string, unknown> = Record<string, unknown>, Secrets extends Record<string, unknown> = Record<string, unknown>, Params extends Record<string, unknown> = Record<string, unknown>, ExecutorResultData = void>(actionType: ",
"<Config extends ",
"ActionTypeConfig",
" = ",
"ActionTypeConfig",
", Secrets extends ",
"ActionTypeSecrets",
" = ",
"ActionTypeSecrets",
", Params extends ",
"ActionTypeParams",
" = ",
"ActionTypeParams",
", ExecutorResultData = void>(actionType: ",
{
"pluginId": "actions",
"scope": "server",
Expand Down Expand Up @@ -1284,15 +1304,23 @@
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>) => Promise<Pick<",
"<unknown, unknown, unknown, any>) => Promise<",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.PublicMethodsOf",
"text": "PublicMethodsOf"
},
"<",
{
"pluginId": "actions",
"scope": "server",
"docId": "kibActionsPluginApi",
"section": "def-server.ActionsClient",
"text": "ActionsClient"
},
", \"create\" | \"delete\" | \"get\" | \"update\" | \"execute\" | \"getAll\" | \"getBulk\" | \"enqueueExecution\" | \"ephemeralEnqueuedExecution\" | \"listTypes\" | \"isActionTypeEnabled\" | \"isPreconfigured\">>"
">>"
],
"path": "x-pack/plugins/actions/server/plugin.ts",
"deprecated": false,
Expand Down Expand Up @@ -1337,15 +1365,23 @@
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>) => Pick<",
"<unknown, unknown, unknown, any>) => ",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.PublicMethodsOf",
"text": "PublicMethodsOf"
},
"<",
{
"pluginId": "actions",
"scope": "server",
"docId": "kibActionsPluginApi",
"section": "def-server.ActionsAuthorization",
"text": "ActionsAuthorization"
},
", \"ensureAuthorized\">"
">"
],
"path": "x-pack/plugins/actions/server/plugin.ts",
"deprecated": false,
Expand Down Expand Up @@ -1389,7 +1425,11 @@
"section": "def-server.PreConfiguredAction",
"text": "PreConfiguredAction"
},
"<Record<string, unknown>, Record<string, unknown>>[]"
"<",
"ActionTypeConfig",
", ",
"ActionTypeSecrets",
">[]"
],
"path": "x-pack/plugins/actions/server/plugin.ts",
"deprecated": false
Expand All @@ -1402,7 +1442,11 @@
"label": "renderActionParameterTemplates",
"description": [],
"signature": [
"<Params extends Record<string, unknown> = Record<string, unknown>>(actionTypeId: string, actionId: string, params: Params, variables: Record<string, unknown>) => Params"
"<Params extends ",
"ActionTypeParams",
" = ",
"ActionTypeParams",
">(actionTypeId: string, actionId: string, params: Params, variables: Record<string, unknown>) => Params"
],
"path": "x-pack/plugins/actions/server/plugin.ts",
"deprecated": false,
Expand Down Expand Up @@ -1482,7 +1526,7 @@
"label": "buildAlertHistoryDocument",
"description": [],
"signature": [
"(variables: Record<string, unknown>) => { event: { kind: string; }; kibana?: { alert: { actionGroupName?: string; actionGroup?: string; context?: { [x: string]: Record<string, unknown>; }; id?: string; }; }; rule?: { type?: string; space?: string; params?: { [x: string]: Record<string, unknown>; }; name?: string; id?: string; }; message?: unknown; tags?: string[]; '@timestamp': string; } | null"
"(variables: Record<string, unknown>) => { event: { kind: string; }; kibana?: { alert: { actionGroupName?: string | undefined; actionGroup?: string | undefined; context?: { [x: string]: Record<string, unknown>; } | undefined; id?: string | undefined; }; } | undefined; rule?: { type?: string | undefined; space?: string | undefined; params?: { [x: string]: Record<string, unknown>; } | undefined; name?: string | undefined; id?: string | undefined; } | undefined; message?: unknown; tags?: string[] | undefined; '@timestamp': string; } | null"
],
"path": "x-pack/plugins/actions/common/alert_history_schema.ts",
"deprecated": false,
Expand Down Expand Up @@ -1840,7 +1884,7 @@
"label": "AlertHistoryDocumentTemplate",
"description": [],
"signature": [
"Readonly<{ event: { kind: string; }; kibana?: { alert: { actionGroupName?: string; actionGroup?: string; context?: { [x: string]: Record<string, unknown>; }; id?: string; }; }; rule?: { type?: string; space?: string; params?: { [x: string]: Record<string, unknown>; }; name?: string; id?: string; }; message?: unknown; tags?: string[]; '@timestamp': string; }> | null"
"Readonly<{ event: { kind: string; }; kibana?: { alert: { actionGroupName?: string | undefined; actionGroup?: string | undefined; context?: { [x: string]: Record<string, unknown>; } | undefined; id?: string | undefined; }; } | undefined; rule?: { type?: string | undefined; space?: string | undefined; params?: { [x: string]: Record<string, unknown>; } | undefined; name?: string | undefined; id?: string | undefined; } | undefined; message?: unknown; tags?: string[] | undefined; '@timestamp': string; }> | null"
],
"path": "x-pack/plugins/actions/common/alert_history_schema.ts",
"deprecated": false,
Expand Down
4 changes: 2 additions & 2 deletions api_docs/actions.mdx
View file
Expand Up @@ -16,9 +16,9 @@ Contact [Kibana Alerting](https://github.com/orgs/elastic/teams/kibana-alerting-

**Code health stats**

| Public API count | Any count | Items lacking comments | Missing exports |
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 125 | 0 | 125 | 8 |
| 125 | 0 | 125 | 11 |

## Server

Expand Down
10 changes: 5 additions & 5 deletions api_docs/advanced_settings.json
View file
Expand Up @@ -126,7 +126,7 @@
"/**\n * Attempts to register the provided component, with the ability to optionally allow\n * the component to override an existing one.\n *\n * If the intent is to override, then `allowOverride` must be set to true, otherwise an exception is thrown.\n *\n * @param id the id of the component to register\n * @param component the component\n * @param allowOverride (default: false) - optional flag to allow this component to override a previously registered component\n */"
],
"signature": [
"(id: Id, component: React.ComponentType<Record<string, any> | undefined>, allowOverride?: boolean) => void"
"(id: Id, component: RegistryComponent, allowOverride?: boolean) => void"
],
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"deprecated": false,
Expand All @@ -153,7 +153,7 @@
"label": "component",
"description": [],
"signature": [
"React.ComponentType<Record<string, any> | undefined>"
"RegistryComponent"
],
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"deprecated": false,
Expand Down Expand Up @@ -211,7 +211,7 @@
"/**\n * Retrieve a registered component by its ID.\n * If the component does not exist, then an exception is thrown.\n *\n * @param id the ID of the component to retrieve\n */"
],
"signature": [
"(id: Id) => React.ComponentType<Record<string, any> | undefined>"
"(id: Id) => RegistryComponent"
],
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"deprecated": false,
Expand Down Expand Up @@ -299,7 +299,7 @@
"label": "component",
"description": [],
"signature": [
"{ componentType: { [key: string]: Id; }; register: (id: Id, component: React.ComponentType<Record<string, any> | undefined>, allowOverride?: boolean) => void; }"
"{ componentType: { [key: string]: Id; }; register: (id: Id, component: RegistryComponent, allowOverride?: boolean) => void; }"
],
"path": "src/plugins/advanced_settings/public/types.ts",
"deprecated": false
Expand All @@ -326,7 +326,7 @@
"label": "component",
"description": [],
"signature": [
"{ componentType: { [key: string]: Id; }; get: (id: Id) => React.ComponentType<Record<string, any> | undefined>; }"
"{ componentType: { [key: string]: Id; }; get: (id: Id) => RegistryComponent; }"
],
"path": "src/plugins/advanced_settings/public/types.ts",
"deprecated": false
Expand Down
2 changes: 1 addition & 1 deletion api_docs/advanced_settings.mdx
View file
Expand Up @@ -16,7 +16,7 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors)

**Code health stats**

| Public API count | Any count | Items lacking comments | Missing exports |
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 23 | 0 | 20 | 1 |

Expand Down

0 comments on commit 7445521

Please sign in to comment.